| 1 | |||
| 2 | package Paws::ECR::ListImages; | ||
| 3 | use Moose; | ||
| 4 | has Filter => (is => 'ro', isa => 'Paws::ECR::ListImagesFilter', traits => ['NameInRequest'], request_name => 'filter' ); | ||
| 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 RegistryId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'registryId' ); | ||
| 8 | has RepositoryName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'repositoryName' , required => 1); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListImages'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ECR::ListImagesResponse'); | ||
| 14 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::ECR::ListImages - Arguments for method ListImages on L<Paws::ECR> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method ListImages on the | ||
| 26 | L<Amazon EC2 Container Registry|Paws::ECR> service. Use the attributes of this class | ||
| 27 | as arguments to method ListImages. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListImages. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $api.ecr = Paws->service('ECR'); | ||
| 34 | # To list all images in a repository | ||
| 35 | # This example lists all of the images in the repository named ubuntu in the | ||
| 36 | # default registry in the current account. | ||
| 37 | my $ListImagesResponse = | ||
| 38 | $api . ecr->ListImages( 'RepositoryName' => 'ubuntu' ); | ||
| 39 | |||
| 40 | # Results: | ||
| 41 | my $imageIds = $ListImagesResponse->imageIds; | ||
| 42 | |||
| 43 | # Returns a L<Paws::ECR::ListImagesResponse> object. | ||
| 44 | |||
| 45 | 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. | ||
| 46 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/api.ecr/ListImages> | ||
| 47 | |||
| 48 | =head1 ATTRIBUTES | ||
| 49 | |||
| 50 | |||
| 51 | =head2 Filter => L<Paws::ECR::ListImagesFilter> | ||
| 52 | |||
| 53 | The filter key and value with which to filter your C<ListImages> | ||
| 54 | results. | ||
| 55 | |||
| 56 | |||
| 57 | |||
| 58 | =head2 MaxResults => Int | ||
| 59 | |||
| 60 | The maximum number of image results returned by C<ListImages> in | ||
| 61 | paginated output. When this parameter is used, C<ListImages> only | ||
| 62 | returns C<maxResults> results in a single page along with a | ||
| 63 | C<nextToken> response element. The remaining results of the initial | ||
| 64 | request can be seen by sending another C<ListImages> request with the | ||
| 65 | returned C<nextToken> value. This value can be between 1 and 1000. If | ||
| 66 | this parameter is not used, then C<ListImages> returns up to 100 | ||
| 67 | results and a C<nextToken> value, if applicable. | ||
| 68 | |||
| 69 | |||
| 70 | |||
| 71 | =head2 NextToken => Str | ||
| 72 | |||
| 73 | The C<nextToken> value returned from a previous paginated C<ListImages> | ||
| 74 | request where C<maxResults> was used and the results exceeded the value | ||
| 75 | of that parameter. Pagination continues from the end of the previous | ||
| 76 | results that returned the C<nextToken> value. This value is C<null> | ||
| 77 | when there are no more results to return. | ||
| 78 | |||
| 79 | This token should be treated as an opaque identifier that is only used | ||
| 80 | to retrieve the next items in a list and not for other programmatic | ||
| 81 | purposes. | ||
| 82 | |||
| 83 | |||
| 84 | |||
| 85 | =head2 RegistryId => Str | ||
| 86 | |||
| 87 | The AWS account ID associated with the registry that contains the | ||
| 88 | repository in which to list images. If you do not specify a registry, | ||
| 89 | the default registry is assumed. | ||
| 90 | |||
| 91 | |||
| 92 | |||
| 93 | =head2 B<REQUIRED> RepositoryName => Str | ||
| 94 | |||
| 95 | The repository with image IDs to be listed. | ||
| 96 | |||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | =head1 SEE ALSO | ||
| 101 | |||
| 102 | This class forms part of L<Paws>, documenting arguments for method ListImages in L<Paws::ECR> | ||
| 103 | |||
| 104 | =head1 BUGS and CONTRIBUTIONS | ||
| 105 | |||
| 106 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 107 | |||
| 108 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 109 | |||
| 110 | =cut | ||
| 111 |