« blib/lib/Paws/ECRPublic/DescribeRegistriesResponse.pm
↑ Summary
blib/lib/Paws/ECRPublic/DescribeRepositoriesResponse.pm »
| 1 | |||
| 2 | package Paws::ECRPublic::DescribeRepositories; | ||
| 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 RepositoryNames => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'repositoryNames' ); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeRepositories'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ECRPublic::DescribeRepositoriesResponse'); | ||
| 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::DescribeRepositories - Arguments for method DescribeRepositories on L<Paws::ECRPublic> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method DescribeRepositories on the | ||
| 25 | L<Amazon Elastic Container Registry Public|Paws::ECRPublic> service. Use the attributes of this class | ||
| 26 | as arguments to method DescribeRepositories. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeRepositories. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $api.ecr-public = Paws->service('ECRPublic'); | ||
| 33 | my $DescribeRepositoriesResponse = $api . ecr-public->DescribeRepositories( | ||
| 34 | MaxResults => 1, # OPTIONAL | ||
| 35 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 36 | RegistryId => 'MyRegistryId', # OPTIONAL | ||
| 37 | RepositoryNames => [ | ||
| 38 | 'MyRepositoryName', ... # min: 2, max: 205 | ||
| 39 | ], # OPTIONAL | ||
| 40 | ); | ||
| 41 | |||
| 42 | # Results: | ||
| 43 | my $NextToken = $DescribeRepositoriesResponse->NextToken; | ||
| 44 | my $Repositories = $DescribeRepositoriesResponse->Repositories; | ||
| 45 | |||
| 46 | # Returns a L<Paws::ECRPublic::DescribeRepositoriesResponse> object. | ||
| 47 | |||
| 48 | 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. | ||
| 49 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/api.ecr-public/DescribeRepositories> | ||
| 50 | |||
| 51 | =head1 ATTRIBUTES | ||
| 52 | |||
| 53 | |||
| 54 | =head2 MaxResults => Int | ||
| 55 | |||
| 56 | The maximum number of repository results returned by | ||
| 57 | C<DescribeRepositories> in paginated output. When this parameter is | ||
| 58 | used, C<DescribeRepositories> only returns C<maxResults> results in a | ||
| 59 | single page along with a C<nextToken> response element. The remaining | ||
| 60 | results of the initial request can be seen by sending another | ||
| 61 | C<DescribeRepositories> request with the returned C<nextToken> value. | ||
| 62 | This value can be between 1 and 1000. If this parameter is not used, | ||
| 63 | then C<DescribeRepositories> returns up to 100 results and a | ||
| 64 | C<nextToken> value, if applicable. This option cannot be used when you | ||
| 65 | specify repositories with C<repositoryNames>. | ||
| 66 | |||
| 67 | |||
| 68 | |||
| 69 | =head2 NextToken => Str | ||
| 70 | |||
| 71 | The C<nextToken> value returned from a previous paginated | ||
| 72 | C<DescribeRepositories> request where C<maxResults> was used and the | ||
| 73 | results exceeded the value of that parameter. Pagination continues from | ||
| 74 | the end of the previous results that returned the C<nextToken> value. | ||
| 75 | This value is C<null> when there are no more results to return. This | ||
| 76 | option cannot be used when you specify repositories with | ||
| 77 | C<repositoryNames>. | ||
| 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 | repositories to be described. If you do not specify a registry, the | ||
| 89 | default public registry is assumed. | ||
| 90 | |||
| 91 | |||
| 92 | |||
| 93 | =head2 RepositoryNames => ArrayRef[Str|Undef] | ||
| 94 | |||
| 95 | A list of repositories to describe. If this parameter is omitted, then | ||
| 96 | all repositories in a registry are described. | ||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | |||
| 101 | =head1 SEE ALSO | ||
| 102 | |||
| 103 | This class forms part of L<Paws>, documenting arguments for method DescribeRepositories in L<Paws::ECRPublic> | ||
| 104 | |||
| 105 | =head1 BUGS and CONTRIBUTIONS | ||
| 106 | |||
| 107 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 108 | |||
| 109 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 110 | |||
| 111 | =cut | ||
| 112 |