Get Deployment

apigateway_get_deployment

R Documentation

Gets information about a Deployment resource¶

Description¶

Gets information about a Deployment resource.

Usage¶

apigateway_get_deployment(restApiId, deploymentId, embed)

Arguments¶

restApiId: [required] The string identifier of the associated RestApi.
deploymentId: [required] The identifier of the Deployment resource to get information about.
embed: A query parameter to retrieve the specified embedded resources of the returned Deployment resource in the response. In a REST API call, this embed parameter value is a list of comma-separated strings, as in ⁠GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=var1,var2⁠. The SDK and other platform-dependent libraries might use a different format for the list. Currently, this request supports only retrieval of the embedded API summary this way. Hence, the parameter value must be a single-valued list containing only the "apisummary" string. For example, GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary.

Value¶

A list with the following syntax:

list(
  id = "string",
  description = "string",
  createdDate = as.POSIXct(
    "2015-01-01"
  ),
  apiSummary = list(
    list(
      list(
        authorizationType = "string",
        apiKeyRequired = TRUE|FALSE
      )
    )
  )
)

Request syntax¶

svc$get_deployment(
  restApiId = "string",
  deploymentId = "string",
  embed = list(
    "string"
  )
)