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