Class: Aws::APIGateway::Types::GetDeploymentRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::APIGateway::Types::GetDeploymentRequest
- Defined in:
- gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb
Overview
Requests API Gateway to get information about a Deployment resource.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#deployment_id ⇒ String
The identifier of the Deployment resource to get information about.
-
#embed ⇒ Array<String>
A query parameter to retrieve the specified embedded resources of the returned Deployment resource in the response.
-
#rest_api_id ⇒ String
The string identifier of the associated RestApi.
Instance Attribute Details
#deployment_id ⇒ String
The identifier of the Deployment resource to get information about.
2327 2328 2329 2330 2331 2332 2333 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 2327 class GetDeploymentRequest < Struct.new( :rest_api_id, :deployment_id, :embed) SENSITIVE = [] include Aws::Structure end |
#embed ⇒ Array<String>
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
.
2327 2328 2329 2330 2331 2332 2333 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 2327 class GetDeploymentRequest < Struct.new( :rest_api_id, :deployment_id, :embed) SENSITIVE = [] include Aws::Structure end |
#rest_api_id ⇒ String
The string identifier of the associated RestApi.
2327 2328 2329 2330 2331 2332 2333 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 2327 class GetDeploymentRequest < Struct.new( :rest_api_id, :deployment_id, :embed) SENSITIVE = [] include Aws::Structure end |