« blib/lib/Paws/ApiGateway/GetClientCertificates.pm
↑ Summary
blib/lib/Paws/ApiGateway/GetDeployments.pm »
| 1 | |||
| 2 | package Paws::ApiGateway::GetDeployment; | ||
| 3 | use Moose; | ||
| 4 | has DeploymentId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'deployment_id', required => 1); | ||
| 5 | has Embed => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['ParamInQuery'], query_name => 'embed'); | ||
| 6 | has RestApiId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'restapi_id', required => 1); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetDeployment'); | ||
| 11 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/restapis/{restapi_id}/deployments/{deployment_id}'); | ||
| 12 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ApiGateway::Deployment'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::ApiGateway::GetDeployment - Arguments for method GetDeployment on L<Paws::ApiGateway> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method GetDeployment on the | ||
| 25 | L<Amazon API Gateway|Paws::ApiGateway> service. Use the attributes of this class | ||
| 26 | as arguments to method GetDeployment. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetDeployment. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $apigateway = Paws->service('ApiGateway'); | ||
| 33 | my $Deployment = $apigateway->GetDeployment( | ||
| 34 | DeploymentId => 'MyString', | ||
| 35 | RestApiId => 'MyString', | ||
| 36 | Embed => [ 'MyString', ... ], # OPTIONAL | ||
| 37 | ); | ||
| 38 | |||
| 39 | # Results: | ||
| 40 | my $ApiSummary = $Deployment->ApiSummary; | ||
| 41 | my $CreatedDate = $Deployment->CreatedDate; | ||
| 42 | my $Description = $Deployment->Description; | ||
| 43 | my $Id = $Deployment->Id; | ||
| 44 | |||
| 45 | # Returns a L<Paws::ApiGateway::Deployment> object. | ||
| 46 | |||
| 47 | 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. | ||
| 48 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/apigateway/GetDeployment> | ||
| 49 | |||
| 50 | =head1 ATTRIBUTES | ||
| 51 | |||
| 52 | |||
| 53 | =head2 B<REQUIRED> DeploymentId => Str | ||
| 54 | |||
| 55 | [Required] The identifier of the Deployment resource to get information | ||
| 56 | about. | ||
| 57 | |||
| 58 | |||
| 59 | |||
| 60 | =head2 Embed => ArrayRef[Str|Undef] | ||
| 61 | |||
| 62 | A query parameter to retrieve the specified embedded resources of the | ||
| 63 | returned Deployment resource in the response. In a REST API call, this | ||
| 64 | C<embed> parameter value is a list of comma-separated strings, as in | ||
| 65 | C<GET | ||
| 66 | /restapis/{restapi_id}/deployments/{deployment_id}?embed=var1,var2>. | ||
| 67 | The SDK and other platform-dependent libraries might use a different | ||
| 68 | format for the list. Currently, this request supports only retrieval of | ||
| 69 | the embedded API summary this way. Hence, the parameter value must be a | ||
| 70 | single-valued list containing only the C<"apisummary"> string. For | ||
| 71 | example, C<GET | ||
| 72 | /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary>. | ||
| 73 | |||
| 74 | |||
| 75 | |||
| 76 | =head2 B<REQUIRED> RestApiId => Str | ||
| 77 | |||
| 78 | [Required] The string identifier of the associated RestApi. | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | =head1 SEE ALSO | ||
| 84 | |||
| 85 | This class forms part of L<Paws>, documenting arguments for method GetDeployment in L<Paws::ApiGateway> | ||
| 86 | |||
| 87 | =head1 BUGS and CONTRIBUTIONS | ||
| 88 | |||
| 89 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 90 | |||
| 91 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 92 | |||
| 93 | =cut | ||
| 94 |