« blib/lib/Paws/ECR/DescribeImageScanFindingsResponse.pm
↑ Summary
blib/lib/Paws/ECR/DescribeImagesFilter.pm »
| 1 | |||
| 2 | package Paws::ECR::DescribeImages; | ||
| 3 | use Moose; | ||
| 4 | has Filter => (is => 'ro', isa => 'Paws::ECR::DescribeImagesFilter', traits => ['NameInRequest'], request_name => 'filter' ); | ||
| 5 | has ImageIds => (is => 'ro', isa => 'ArrayRef[Paws::ECR::ImageIdentifier]', traits => ['NameInRequest'], request_name => 'imageIds' ); | ||
| 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 | has RegistryId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'registryId' ); | ||
| 9 | has RepositoryName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'repositoryName' , required => 1); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeImages'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ECR::DescribeImagesResponse'); | ||
| 15 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::ECR::DescribeImages - Arguments for method DescribeImages on L<Paws::ECR> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method DescribeImages on the | ||
| 27 | L<Amazon EC2 Container Registry|Paws::ECR> service. Use the attributes of this class | ||
| 28 | as arguments to method DescribeImages. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeImages. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $api.ecr = Paws->service('ECR'); | ||
| 35 | my $DescribeImagesResponse = $api . ecr->DescribeImages( | ||
| 36 | RepositoryName => 'MyRepositoryName', | ||
| 37 | Filter => { | ||
| 38 | TagStatus => 'TAGGED', # values: TAGGED, UNTAGGED, ANY; OPTIONAL | ||
| 39 | }, # OPTIONAL | ||
| 40 | ImageIds => [ | ||
| 41 | { | ||
| 42 | ImageDigest => 'MyImageDigest', # OPTIONAL | ||
| 43 | ImageTag => 'MyImageTag', # min: 1, max: 300; OPTIONAL | ||
| 44 | }, | ||
| 45 | ... | ||
| 46 | ], # OPTIONAL | ||
| 47 | MaxResults => 1, # OPTIONAL | ||
| 48 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 49 | RegistryId => 'MyRegistryId', # OPTIONAL | ||
| 50 | ); | ||
| 51 | |||
| 52 | # Results: | ||
| 53 | my $ImageDetails = $DescribeImagesResponse->ImageDetails; | ||
| 54 | my $NextToken = $DescribeImagesResponse->NextToken; | ||
| 55 | |||
| 56 | # Returns a L<Paws::ECR::DescribeImagesResponse> object. | ||
| 57 | |||
| 58 | 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. | ||
| 59 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/api.ecr/DescribeImages> | ||
| 60 | |||
| 61 | =head1 ATTRIBUTES | ||
| 62 | |||
| 63 | |||
| 64 | =head2 Filter => L<Paws::ECR::DescribeImagesFilter> | ||
| 65 | |||
| 66 | The filter key and value with which to filter your C<DescribeImages> | ||
| 67 | results. | ||
| 68 | |||
| 69 | |||
| 70 | |||
| 71 | =head2 ImageIds => ArrayRef[L<Paws::ECR::ImageIdentifier>] | ||
| 72 | |||
| 73 | The list of image IDs for the requested repository. | ||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | =head2 MaxResults => Int | ||
| 78 | |||
| 79 | The maximum number of repository results returned by C<DescribeImages> | ||
| 80 | in paginated output. When this parameter is used, C<DescribeImages> | ||
| 81 | only 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<DescribeImages> request with | ||
| 84 | the returned C<nextToken> value. This value can be between 1 and 1000. | ||
| 85 | If this parameter is not used, then C<DescribeImages> returns up to 100 | ||
| 86 | results and a C<nextToken> value, if applicable. This option cannot be | ||
| 87 | used when you specify images with C<imageIds>. | ||
| 88 | |||
| 89 | |||
| 90 | |||
| 91 | =head2 NextToken => Str | ||
| 92 | |||
| 93 | The C<nextToken> value returned from a previous paginated | ||
| 94 | C<DescribeImages> request where C<maxResults> was used and the results | ||
| 95 | exceeded the value of that parameter. Pagination continues from the end | ||
| 96 | of the previous results that returned the C<nextToken> value. This | ||
| 97 | value is C<null> when there are no more results to return. This option | ||
| 98 | cannot be used when you specify images with C<imageIds>. | ||
| 99 | |||
| 100 | |||
| 101 | |||
| 102 | =head2 RegistryId => Str | ||
| 103 | |||
| 104 | The AWS account ID associated with the registry that contains the | ||
| 105 | repository in which to describe images. If you do not specify a | ||
| 106 | registry, the default registry is assumed. | ||
| 107 | |||
| 108 | |||
| 109 | |||
| 110 | =head2 B<REQUIRED> RepositoryName => Str | ||
| 111 | |||
| 112 | The repository that contains the images to describe. | ||
| 113 | |||
| 114 | |||
| 115 | |||
| 116 | |||
| 117 | =head1 SEE ALSO | ||
| 118 | |||
| 119 | This class forms part of L<Paws>, documenting arguments for method DescribeImages in L<Paws::ECR> | ||
| 120 | |||
| 121 | =head1 BUGS and CONTRIBUTIONS | ||
| 122 | |||
| 123 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 124 | |||
| 125 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 126 | |||
| 127 | =cut | ||
| 128 |