class Aws::APIGateway::Types::GetDeploymentRequest
Requests API Gateway to get information about a Deployment
resource.
@note When making an API call, you may pass GetDeploymentRequest
data as a hash: { rest_api_id: "String", # required deployment_id: "String", # required embed: ["String"], }
@!attribute [rw] rest_api_id
\[Required\] The string identifier of the associated RestApi. @return [String]
@!attribute [rw] deployment_id
\[Required\] The identifier of the Deployment resource to get information about. @return [String]
@!attribute [rw] 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`. @return [Array<String>]
Constants
- SENSITIVE