« blib/lib/Paws/ECR/BatchCheckLayerAvailabilityResponse.pm
↑ Summary
blib/lib/Paws/ECR/BatchDeleteImageResponse.pm »
| 1 | |||
| 2 | package Paws::ECR::BatchDeleteImage; | ||
| 3 | use Moose; | ||
| 4 | has ImageIds => (is => 'ro', isa => 'ArrayRef[Paws::ECR::ImageIdentifier]', traits => ['NameInRequest'], request_name => 'imageIds' , required => 1); | ||
| 5 | has RegistryId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'registryId' ); | ||
| 6 | has RepositoryName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'repositoryName' , required => 1); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'BatchDeleteImage'); | ||
| 11 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ECR::BatchDeleteImageResponse'); | ||
| 12 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::ECR::BatchDeleteImage - Arguments for method BatchDeleteImage on L<Paws::ECR> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method BatchDeleteImage on the | ||
| 24 | L<Amazon EC2 Container Registry|Paws::ECR> service. Use the attributes of this class | ||
| 25 | as arguments to method BatchDeleteImage. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to BatchDeleteImage. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $api.ecr = Paws->service('ECR'); | ||
| 32 | # To delete multiple images | ||
| 33 | # This example deletes images with the tags precise and trusty in a repository | ||
| 34 | # called ubuntu in the default registry for an account. | ||
| 35 | my $BatchDeleteImageResponse = $api . ecr->BatchDeleteImage( | ||
| 36 | 'ImageIds' => [ | ||
| 37 | |||
| 38 | { | ||
| 39 | 'ImageTag' => 'precise' | ||
| 40 | } | ||
| 41 | ], | ||
| 42 | 'RepositoryName' => 'ubuntu' | ||
| 43 | ); | ||
| 44 | |||
| 45 | # Results: | ||
| 46 | my $failures = $BatchDeleteImageResponse->failures; | ||
| 47 | my $imageIds = $BatchDeleteImageResponse->imageIds; | ||
| 48 | |||
| 49 | # Returns a L<Paws::ECR::BatchDeleteImageResponse> object. | ||
| 50 | |||
| 51 | 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. | ||
| 52 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/api.ecr/BatchDeleteImage> | ||
| 53 | |||
| 54 | =head1 ATTRIBUTES | ||
| 55 | |||
| 56 | |||
| 57 | =head2 B<REQUIRED> ImageIds => ArrayRef[L<Paws::ECR::ImageIdentifier>] | ||
| 58 | |||
| 59 | A list of image ID references that correspond to images to delete. The | ||
| 60 | format of the C<imageIds> reference is C<imageTag=tag> or | ||
| 61 | C<imageDigest=digest>. | ||
| 62 | |||
| 63 | |||
| 64 | |||
| 65 | =head2 RegistryId => Str | ||
| 66 | |||
| 67 | The AWS account ID associated with the registry that contains the image | ||
| 68 | to delete. If you do not specify a registry, the default registry is | ||
| 69 | assumed. | ||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | =head2 B<REQUIRED> RepositoryName => Str | ||
| 74 | |||
| 75 | The repository that contains the image to delete. | ||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | =head1 SEE ALSO | ||
| 81 | |||
| 82 | This class forms part of L<Paws>, documenting arguments for method BatchDeleteImage in L<Paws::ECR> | ||
| 83 | |||
| 84 | =head1 BUGS and CONTRIBUTIONS | ||
| 85 | |||
| 86 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 87 | |||
| 88 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 89 | |||
| 90 | =cut | ||
| 91 |