AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

GetDeploymentInput

import "github.com/aws/aws-sdk-go/service/apigateway"

type GetDeploymentInput struct { DeploymentId *string `location:"uri" locationName:"deployment_id" type:"string" required:"true"` Embed []*string `location:"querystring" locationName:"embed" type:"list"` RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` }

Requests API Gateway to get information about a Deployment resource.

DeploymentId

Type: *string

[Required] The identifier of the Deployment resource to get information about.

DeploymentId is a required field

Embed

Type: []*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.

RestApiId

Type: *string

[Required] The string identifier of the associated RestApi.

RestApiId is a required field

Method

GoString

func (s GetDeploymentInput) GoString() string

GoString returns the string representation

SetDeploymentId

func (s *GetDeploymentInput) SetDeploymentId(v string) *GetDeploymentInput

SetDeploymentId sets the DeploymentId field's value.

SetEmbed

func (s *GetDeploymentInput) SetEmbed(v []*string) *GetDeploymentInput

SetEmbed sets the Embed field's value.

SetRestApiId

func (s *GetDeploymentInput) SetRestApiId(v string) *GetDeploymentInput

SetRestApiId sets the RestApiId field's value.

String

func (s GetDeploymentInput) String() string

String returns the string representation

Validate

func (s *GetDeploymentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: