Method: Aws::APIGateway::Types::GetDeploymentRequest#embed

Defined in:
lib/aws-sdk-apigateway/types.rb

#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>)

3301
3302
3303
3304
3305
3306
3307
# File 'lib/aws-sdk-apigateway/types.rb', line 3301

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