« blib/lib/Paws/ECS/ListAccountSettingsResponse.pm
↑ Summary
blib/lib/Paws/ECS/ListAttributesResponse.pm »
| 1 | |||
| 2 | package Paws::ECS::ListAttributes; | ||
| 3 | use Moose; | ||
| 4 | has AttributeName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'attributeName' ); | ||
| 5 | has AttributeValue => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'attributeValue' ); | ||
| 6 | has Cluster => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'cluster' ); | ||
| 7 | has MaxResults => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'maxResults' ); | ||
| 8 | has NextToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'nextToken' ); | ||
| 9 | has TargetType => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'targetType' , required => 1); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListAttributes'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ECS::ListAttributesResponse'); | ||
| 15 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::ECS::ListAttributes - Arguments for method ListAttributes on L<Paws::ECS> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method ListAttributes on the | ||
| 27 | L<Amazon EC2 Container Service|Paws::ECS> service. Use the attributes of this class | ||
| 28 | as arguments to method ListAttributes. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListAttributes. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $ecs = Paws->service('ECS'); | ||
| 35 | my $ListAttributesResponse = $ecs->ListAttributes( | ||
| 36 | TargetType => 'container-instance', | ||
| 37 | AttributeName => 'MyString', # OPTIONAL | ||
| 38 | AttributeValue => 'MyString', # OPTIONAL | ||
| 39 | Cluster => 'MyString', # OPTIONAL | ||
| 40 | MaxResults => 1, # OPTIONAL | ||
| 41 | NextToken => 'MyString', # OPTIONAL | ||
| 42 | ); | ||
| 43 | |||
| 44 | # Results: | ||
| 45 | my $Attributes = $ListAttributesResponse->Attributes; | ||
| 46 | my $NextToken = $ListAttributesResponse->NextToken; | ||
| 47 | |||
| 48 | # Returns a L<Paws::ECS::ListAttributesResponse> 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/ListAttributes> | ||
| 52 | |||
| 53 | =head1 ATTRIBUTES | ||
| 54 | |||
| 55 | |||
| 56 | =head2 AttributeName => Str | ||
| 57 | |||
| 58 | The name of the attribute with which to filter the results. | ||
| 59 | |||
| 60 | |||
| 61 | |||
| 62 | =head2 AttributeValue => Str | ||
| 63 | |||
| 64 | The value of the attribute with which to filter results. You must also | ||
| 65 | specify an attribute name to use this parameter. | ||
| 66 | |||
| 67 | |||
| 68 | |||
| 69 | =head2 Cluster => Str | ||
| 70 | |||
| 71 | The short name or full Amazon Resource Name (ARN) of the cluster to | ||
| 72 | list attributes. If you do not specify a cluster, the default cluster | ||
| 73 | is assumed. | ||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | =head2 MaxResults => Int | ||
| 78 | |||
| 79 | The maximum number of cluster results returned by C<ListAttributes> in | ||
| 80 | paginated output. When this parameter is used, C<ListAttributes> only | ||
| 81 | returns C<maxResults> results in a single page along with a | ||
| 82 | C<nextToken> response element. The remaining results of the initial | ||
| 83 | request can be seen by sending another C<ListAttributes> request with | ||
| 84 | the returned C<nextToken> value. This value can be between 1 and 100. | ||
| 85 | If this parameter is not used, then C<ListAttributes> returns up to 100 | ||
| 86 | results and a C<nextToken> value if applicable. | ||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | =head2 NextToken => Str | ||
| 91 | |||
| 92 | The C<nextToken> value returned from a C<ListAttributes> request | ||
| 93 | indicating that more results are available to fulfill the request and | ||
| 94 | further calls will be needed. If C<maxResults> was provided, it is | ||
| 95 | possible the number of results to be fewer than C<maxResults>. | ||
| 96 | |||
| 97 | This token should be treated as an opaque identifier that is only used | ||
| 98 | to retrieve the next items in a list and not for other programmatic | ||
| 99 | purposes. | ||
| 100 | |||
| 101 | |||
| 102 | |||
| 103 | =head2 B<REQUIRED> TargetType => Str | ||
| 104 | |||
| 105 | The type of the target with which to list attributes. | ||
| 106 | |||
| 107 | Valid values are: C<"container-instance"> | ||
| 108 | |||
| 109 | |||
| 110 | =head1 SEE ALSO | ||
| 111 | |||
| 112 | This class forms part of L<Paws>, documenting arguments for method ListAttributes in L<Paws::ECS> | ||
| 113 | |||
| 114 | =head1 BUGS and CONTRIBUTIONS | ||
| 115 | |||
| 116 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 117 | |||
| 118 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 119 | |||
| 120 | =cut | ||
| 121 |