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