« blib/lib/Paws/ECS/DeregisterTaskDefinitionResponse.pm
↑ Summary
blib/lib/Paws/ECS/DescribeCapacityProvidersResponse.pm »
| 1 | |||
| 2 | package Paws::ECS::DescribeCapacityProviders; | ||
| 3 | use Moose; | ||
| 4 | has CapacityProviders => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'capacityProviders' ); | ||
| 5 | has Include => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'include' ); | ||
| 6 | has MaxResults => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'maxResults' ); | ||
| 7 | has NextToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'nextToken' ); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeCapacityProviders'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ECS::DescribeCapacityProvidersResponse'); | ||
| 13 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::ECS::DescribeCapacityProviders - Arguments for method DescribeCapacityProviders on L<Paws::ECS> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method DescribeCapacityProviders on the | ||
| 25 | L<Amazon EC2 Container Service|Paws::ECS> service. Use the attributes of this class | ||
| 26 | as arguments to method DescribeCapacityProviders. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeCapacityProviders. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $ecs = Paws->service('ECS'); | ||
| 33 | my $DescribeCapacityProvidersResponse = $ecs->DescribeCapacityProviders( | ||
| 34 | CapacityProviders => [ 'MyString', ... ], # OPTIONAL | ||
| 35 | Include => [ | ||
| 36 | 'TAGS', ... # values: TAGS | ||
| 37 | ], # OPTIONAL | ||
| 38 | MaxResults => 1, # OPTIONAL | ||
| 39 | NextToken => 'MyString', # OPTIONAL | ||
| 40 | ); | ||
| 41 | |||
| 42 | # Results: | ||
| 43 | my $CapacityProviders = | ||
| 44 | $DescribeCapacityProvidersResponse->CapacityProviders; | ||
| 45 | my $Failures = $DescribeCapacityProvidersResponse->Failures; | ||
| 46 | my $NextToken = $DescribeCapacityProvidersResponse->NextToken; | ||
| 47 | |||
| 48 | # Returns a L<Paws::ECS::DescribeCapacityProvidersResponse> object. | ||
| 49 | |||
| 50 | 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. | ||
| 51 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ecs/DescribeCapacityProviders> | ||
| 52 | |||
| 53 | =head1 ATTRIBUTES | ||
| 54 | |||
| 55 | |||
| 56 | =head2 CapacityProviders => ArrayRef[Str|Undef] | ||
| 57 | |||
| 58 | The short name or full Amazon Resource Name (ARN) of one or more | ||
| 59 | capacity providers. Up to C<100> capacity providers can be described in | ||
| 60 | an action. | ||
| 61 | |||
| 62 | |||
| 63 | |||
| 64 | =head2 Include => ArrayRef[Str|Undef] | ||
| 65 | |||
| 66 | Specifies whether or not you want to see the resource tags for the | ||
| 67 | capacity provider. If C<TAGS> is specified, the tags are included in | ||
| 68 | the response. If this field is omitted, tags are not included in the | ||
| 69 | response. | ||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | =head2 MaxResults => Int | ||
| 74 | |||
| 75 | The maximum number of account setting results returned by | ||
| 76 | C<DescribeCapacityProviders> in paginated output. When this parameter | ||
| 77 | is used, C<DescribeCapacityProviders> only returns C<maxResults> | ||
| 78 | results in a single page along with a C<nextToken> response element. | ||
| 79 | The remaining results of the initial request can be seen by sending | ||
| 80 | another C<DescribeCapacityProviders> request with the returned | ||
| 81 | C<nextToken> value. This value can be between 1 and 10. If this | ||
| 82 | parameter is not used, then C<DescribeCapacityProviders> returns up to | ||
| 83 | 10 results and a C<nextToken> value if applicable. | ||
| 84 | |||
| 85 | |||
| 86 | |||
| 87 | =head2 NextToken => Str | ||
| 88 | |||
| 89 | The C<nextToken> value returned from a previous paginated | ||
| 90 | C<DescribeCapacityProviders> request where C<maxResults> was used and | ||
| 91 | the results exceeded the value of that parameter. Pagination continues | ||
| 92 | from the end of the previous results that returned the C<nextToken> | ||
| 93 | value. | ||
| 94 | |||
| 95 | This token should be treated as an opaque identifier that is only used | ||
| 96 | to retrieve the next items in a list and not for other programmatic | ||
| 97 | purposes. | ||
| 98 | |||
| 99 | |||
| 100 | |||
| 101 | |||
| 102 | =head1 SEE ALSO | ||
| 103 | |||
| 104 | This class forms part of L<Paws>, documenting arguments for method DescribeCapacityProviders in L<Paws::ECS> | ||
| 105 | |||
| 106 | =head1 BUGS and CONTRIBUTIONS | ||
| 107 | |||
| 108 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 109 | |||
| 110 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 111 | |||
| 112 | =cut | ||
| 113 |