« blib/lib/Paws/ECS/ListTaskDefinitionFamiliesResponse.pm
↑ Summary
blib/lib/Paws/ECS/ListTaskDefinitionsResponse.pm »
| 1 | |||
| 2 | package Paws::ECS::ListTaskDefinitions; | ||
| 3 | use Moose; | ||
| 4 | has FamilyPrefix => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'familyPrefix' ); | ||
| 5 | has MaxResults => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'maxResults' ); | ||
| 6 | has NextToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'nextToken' ); | ||
| 7 | has Sort => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'sort' ); | ||
| 8 | has Status => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'status' ); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListTaskDefinitions'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ECS::ListTaskDefinitionsResponse'); | ||
| 14 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::ECS::ListTaskDefinitions - Arguments for method ListTaskDefinitions on L<Paws::ECS> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method ListTaskDefinitions on the | ||
| 26 | L<Amazon EC2 Container Service|Paws::ECS> service. Use the attributes of this class | ||
| 27 | as arguments to method ListTaskDefinitions. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListTaskDefinitions. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $ecs = Paws->service('ECS'); | ||
| 34 | # To list your registered task definitions | ||
| 35 | # This example lists all of your registered task definitions. | ||
| 36 | my $ListTaskDefinitionsResponse = $ecs->ListTaskDefinitions(); | ||
| 37 | |||
| 38 | # Results: | ||
| 39 | my $taskDefinitionArns = $ListTaskDefinitionsResponse->taskDefinitionArns; | ||
| 40 | |||
| 41 | # Returns a L<Paws::ECS::ListTaskDefinitionsResponse> object. | ||
| 42 | # To list the registered task definitions in a family | ||
| 43 | # This example lists the task definition revisions of a specified family. | ||
| 44 | my $ListTaskDefinitionsResponse = | ||
| 45 | $ecs->ListTaskDefinitions( 'FamilyPrefix' => 'wordpress' ); | ||
| 46 | |||
| 47 | # Results: | ||
| 48 | my $taskDefinitionArns = $ListTaskDefinitionsResponse->taskDefinitionArns; | ||
| 49 | |||
| 50 | # Returns a L<Paws::ECS::ListTaskDefinitionsResponse> object. | ||
| 51 | |||
| 52 | 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. | ||
| 53 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ecs/ListTaskDefinitions> | ||
| 54 | |||
| 55 | =head1 ATTRIBUTES | ||
| 56 | |||
| 57 | |||
| 58 | =head2 FamilyPrefix => Str | ||
| 59 | |||
| 60 | The full family name with which to filter the C<ListTaskDefinitions> | ||
| 61 | results. Specifying a C<familyPrefix> limits the listed task | ||
| 62 | definitions to task definition revisions that belong to that family. | ||
| 63 | |||
| 64 | |||
| 65 | |||
| 66 | =head2 MaxResults => Int | ||
| 67 | |||
| 68 | The maximum number of task definition results returned by | ||
| 69 | C<ListTaskDefinitions> in paginated output. When this parameter is | ||
| 70 | used, C<ListTaskDefinitions> only returns C<maxResults> results in a | ||
| 71 | single page along with a C<nextToken> response element. The remaining | ||
| 72 | results of the initial request can be seen by sending another | ||
| 73 | C<ListTaskDefinitions> request with the returned C<nextToken> value. | ||
| 74 | This value can be between 1 and 100. If this parameter is not used, | ||
| 75 | then C<ListTaskDefinitions> returns up to 100 results and a | ||
| 76 | C<nextToken> value if applicable. | ||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | =head2 NextToken => Str | ||
| 81 | |||
| 82 | The C<nextToken> value returned from a C<ListTaskDefinitions> request | ||
| 83 | indicating that more results are available to fulfill the request and | ||
| 84 | further calls will be needed. If C<maxResults> was provided, it is | ||
| 85 | possible the number of results to be fewer than C<maxResults>. | ||
| 86 | |||
| 87 | This token should be treated as an opaque identifier that is only used | ||
| 88 | to retrieve the next items in a list and not for other programmatic | ||
| 89 | purposes. | ||
| 90 | |||
| 91 | |||
| 92 | |||
| 93 | =head2 Sort => Str | ||
| 94 | |||
| 95 | The order in which to sort the results. Valid values are C<ASC> and | ||
| 96 | C<DESC>. By default (C<ASC>), task definitions are listed | ||
| 97 | lexicographically by family name and in ascending numerical order by | ||
| 98 | revision so that the newest task definitions in a family are listed | ||
| 99 | last. Setting this parameter to C<DESC> reverses the sort order on | ||
| 100 | family name and revision so that the newest task definitions in a | ||
| 101 | family are listed first. | ||
| 102 | |||
| 103 | Valid values are: C<"ASC">, C<"DESC"> | ||
| 104 | |||
| 105 | =head2 Status => Str | ||
| 106 | |||
| 107 | The task definition status with which to filter the | ||
| 108 | C<ListTaskDefinitions> results. By default, only C<ACTIVE> task | ||
| 109 | definitions are listed. By setting this parameter to C<INACTIVE>, you | ||
| 110 | can view task definitions that are C<INACTIVE> as long as an active | ||
| 111 | task or service still references them. If you paginate the resulting | ||
| 112 | output, be sure to keep the C<status> value constant in each subsequent | ||
| 113 | request. | ||
| 114 | |||
| 115 | Valid values are: C<"ACTIVE">, C<"INACTIVE"> | ||
| 116 | |||
| 117 | |||
| 118 | =head1 SEE ALSO | ||
| 119 | |||
| 120 | This class forms part of L<Paws>, documenting arguments for method ListTaskDefinitions in L<Paws::ECS> | ||
| 121 | |||
| 122 | =head1 BUGS and CONTRIBUTIONS | ||
| 123 | |||
| 124 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 125 | |||
| 126 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 127 | |||
| 128 | =cut | ||
| 129 |