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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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 API Gateway to get information about a Deployment resource.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#deployment_idString

The identifier of the Deployment resource to get information about.

Returns:

  • (String)

2896
2897
2898
2899
2900
2901
2902
# File 'lib/aws-sdk-apigateway/types.rb', line 2896

class GetDeploymentRequest < Struct.new(
  :rest_api_id,
  :deployment_id,
  :embed)
  SENSITIVE = []
  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>)

2896
2897
2898
2899
2900
2901
2902
# File 'lib/aws-sdk-apigateway/types.rb', line 2896

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

#rest_api_idString

The string identifier of the associated RestApi.

Returns:

  • (String)

2896
2897
2898
2899
2900
2901
2902
# File 'lib/aws-sdk-apigateway/types.rb', line 2896

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