NAME

Paws::ApiGateway::GetDeployment - Arguments for method GetDeployment on Paws::ApiGateway

DESCRIPTION

This class represents the parameters used for calling the method GetDeployment on the Amazon API Gateway service. Use the attributes of this class as arguments to method GetDeployment.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetDeployment.

SYNOPSIS

my $apigateway = Paws->service('ApiGateway');
my $Deployment = $apigateway->GetDeployment(
  DeploymentId => 'MyString',
  RestApiId    => 'MyString',
  Embed        => [ 'MyString', ... ],    # OPTIONAL
);

# Results:
my $ApiSummary  = $Deployment->ApiSummary;
my $CreatedDate = $Deployment->CreatedDate;
my $Description = $Deployment->Description;
my $Id          = $Deployment->Id;

# Returns a L<Paws::ApiGateway::Deployment> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/apigateway/GetDeployment

ATTRIBUTES

REQUIRED DeploymentId => Str

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

Embed => ArrayRef[Str|Undef]

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.

REQUIRED RestApiId => Str

[Required] The string identifier of the associated RestApi.

SEE ALSO

This class forms part of Paws, documenting arguments for method GetDeployment in Paws::ApiGateway

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues