You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::APIGateway::Types::GetDeploymentRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb

Overview

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"],
}

Requests Amazon API Gateway to get information about a Deployment resource.

Instance Attribute Summary collapse

Instance Attribute Details

#deployment_idString

The identifier of the Deployment resource to get information about.

Returns:

  • (String)


2638
2639
2640
2641
2642
2643
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 2638

class GetDeploymentRequest < Struct.new(
  :rest_api_id,
  :deployment_id,
  :embed)
  include Aws::Structure
end

#embedArray<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.

Returns:

  • (Array<String>)


2638
2639
2640
2641
2642
2643
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 2638

class GetDeploymentRequest < Struct.new(
  :rest_api_id,
  :deployment_id,
  :embed)
  include Aws::Structure
end

#rest_api_idString

The string identifier of the associated RestApi.

Returns:

  • (String)


2638
2639
2640
2641
2642
2643
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 2638

class GetDeploymentRequest < Struct.new(
  :rest_api_id,
  :deployment_id,
  :embed)
  include Aws::Structure
end