« blib/lib/Paws/ECR/GetLifecyclePolicy.pm
↑ Summary
blib/lib/Paws/ECR/GetLifecyclePolicyPreviewResponse.pm »
| 1 | |||
| 2 | package Paws::ECR::GetLifecyclePolicyPreview; | ||
| 3 | use Moose; | ||
| 4 | has Filter => (is => 'ro', isa => 'Paws::ECR::LifecyclePolicyPreviewFilter', 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 => 'GetLifecyclePolicyPreview'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ECR::GetLifecyclePolicyPreviewResponse'); | ||
| 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::GetLifecyclePolicyPreview - Arguments for method GetLifecyclePolicyPreview on L<Paws::ECR> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method GetLifecyclePolicyPreview on the | ||
| 27 | L<Amazon EC2 Container Registry|Paws::ECR> service. Use the attributes of this class | ||
| 28 | as arguments to method GetLifecyclePolicyPreview. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetLifecyclePolicyPreview. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $api.ecr = Paws->service('ECR'); | ||
| 35 | my $GetLifecyclePolicyPreviewResponse = | ||
| 36 | $api . ecr->GetLifecyclePolicyPreview( | ||
| 37 | RepositoryName => 'MyRepositoryName', | ||
| 38 | Filter => { | ||
| 39 | TagStatus => 'TAGGED', # values: TAGGED, UNTAGGED, ANY; OPTIONAL | ||
| 40 | }, # OPTIONAL | ||
| 41 | ImageIds => [ | ||
| 42 | { | ||
| 43 | ImageDigest => 'MyImageDigest', # OPTIONAL | ||
| 44 | ImageTag => 'MyImageTag', # min: 1, max: 300; OPTIONAL | ||
| 45 | }, | ||
| 46 | ... | ||
| 47 | ], # OPTIONAL | ||
| 48 | MaxResults => 1, # OPTIONAL | ||
| 49 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 50 | RegistryId => 'MyRegistryId', # OPTIONAL | ||
| 51 | ); | ||
| 52 | |||
| 53 | # Results: | ||
| 54 | my $LifecyclePolicyText = | ||
| 55 | $GetLifecyclePolicyPreviewResponse->LifecyclePolicyText; | ||
| 56 | my $NextToken = $GetLifecyclePolicyPreviewResponse->NextToken; | ||
| 57 | my $PreviewResults = $GetLifecyclePolicyPreviewResponse->PreviewResults; | ||
| 58 | my $RegistryId = $GetLifecyclePolicyPreviewResponse->RegistryId; | ||
| 59 | my $RepositoryName = $GetLifecyclePolicyPreviewResponse->RepositoryName; | ||
| 60 | my $Status = $GetLifecyclePolicyPreviewResponse->Status; | ||
| 61 | my $Summary = $GetLifecyclePolicyPreviewResponse->Summary; | ||
| 62 | |||
| 63 | # Returns a L<Paws::ECR::GetLifecyclePolicyPreviewResponse> object. | ||
| 64 | |||
| 65 | 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. | ||
| 66 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/api.ecr/GetLifecyclePolicyPreview> | ||
| 67 | |||
| 68 | =head1 ATTRIBUTES | ||
| 69 | |||
| 70 | |||
| 71 | =head2 Filter => L<Paws::ECR::LifecyclePolicyPreviewFilter> | ||
| 72 | |||
| 73 | An optional parameter that filters results based on image tag status | ||
| 74 | and all tags, if tagged. | ||
| 75 | |||
| 76 | |||
| 77 | |||
| 78 | =head2 ImageIds => ArrayRef[L<Paws::ECR::ImageIdentifier>] | ||
| 79 | |||
| 80 | The list of imageIDs to be included. | ||
| 81 | |||
| 82 | |||
| 83 | |||
| 84 | =head2 MaxResults => Int | ||
| 85 | |||
| 86 | The maximum number of repository results returned by | ||
| 87 | C<GetLifecyclePolicyPreviewRequest> in paginated output. When this | ||
| 88 | parameter is used, C<GetLifecyclePolicyPreviewRequest> only returns | ||
| 89 | C<maxResults> results in a single page along with a C<nextToken> | ||
| 90 | response element. The remaining results of the initial request can be | ||
| 91 | seen by sending another C<GetLifecyclePolicyPreviewRequest> request | ||
| 92 | with the returned C<nextToken> value. This value can be between 1 and | ||
| 93 | 1000. If this parameter is not used, then | ||
| 94 | C<GetLifecyclePolicyPreviewRequest> returns up to 100 results and a | ||
| 95 | C<nextToken> value, if applicable. This option cannot be used when you | ||
| 96 | specify images with C<imageIds>. | ||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | =head2 NextToken => Str | ||
| 101 | |||
| 102 | The C<nextToken> value returned from a previous paginated | ||
| 103 | C<GetLifecyclePolicyPreviewRequest> request where C<maxResults> was | ||
| 104 | used and the results exceeded the value of that parameter. Pagination | ||
| 105 | continues from the end of the previous results that returned the | ||
| 106 | C<nextToken> value. This value is C<null> when there are no more | ||
| 107 | results to return. This option cannot be used when you specify images | ||
| 108 | with C<imageIds>. | ||
| 109 | |||
| 110 | |||
| 111 | |||
| 112 | =head2 RegistryId => Str | ||
| 113 | |||
| 114 | The AWS account ID associated with the registry that contains the | ||
| 115 | repository. If you do not specify a registry, the default registry is | ||
| 116 | assumed. | ||
| 117 | |||
| 118 | |||
| 119 | |||
| 120 | =head2 B<REQUIRED> RepositoryName => Str | ||
| 121 | |||
| 122 | The name of the repository. | ||
| 123 | |||
| 124 | |||
| 125 | |||
| 126 | |||
| 127 | =head1 SEE ALSO | ||
| 128 | |||
| 129 | This class forms part of L<Paws>, documenting arguments for method GetLifecyclePolicyPreview in L<Paws::ECR> | ||
| 130 | |||
| 131 | =head1 BUGS and CONTRIBUTIONS | ||
| 132 | |||
| 133 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 134 | |||
| 135 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 136 | |||
| 137 | =cut | ||
| 138 |