« blib/lib/Paws/ImageBuilder/ListImageRecipesResponse.pm
↑ Summary
blib/lib/Paws/ImageBuilder/ListImagesResponse.pm »
| 1 | |||
| 2 | package Paws::ImageBuilder::ListImages; | ||
| 3 | use Moose; | ||
| 4 | has ByName => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'byName'); | ||
| 5 | has Filters => (is => 'ro', isa => 'ArrayRef[Paws::ImageBuilder::Filter]', traits => ['NameInRequest'], request_name => 'filters'); | ||
| 6 | has IncludeDeprecated => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'includeDeprecated'); | ||
| 7 | has MaxResults => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'maxResults'); | ||
| 8 | has NextToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'nextToken'); | ||
| 9 | has Owner => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'owner'); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListImages'); | ||
| 14 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/ListImages'); | ||
| 15 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 16 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ImageBuilder::ListImagesResponse'); | ||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::ImageBuilder::ListImages - Arguments for method ListImages on L<Paws::ImageBuilder> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method ListImages on the | ||
| 28 | L<EC2 Image Builder|Paws::ImageBuilder> service. Use the attributes of this class | ||
| 29 | as arguments to method ListImages. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListImages. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $imagebuilder = Paws->service('ImageBuilder'); | ||
| 36 | my $ListImagesResponse = $imagebuilder->ListImages( | ||
| 37 | ByName => 1, # OPTIONAL | ||
| 38 | Filters => [ | ||
| 39 | { | ||
| 40 | Name => 'MyFilterName', # OPTIONAL | ||
| 41 | Values => [ 'MyFilterValue', ... ], # min: 1, max: 10; OPTIONAL | ||
| 42 | }, | ||
| 43 | ... | ||
| 44 | ], # OPTIONAL | ||
| 45 | IncludeDeprecated => 1, # OPTIONAL | ||
| 46 | MaxResults => 1, # OPTIONAL | ||
| 47 | NextToken => 'MyPaginationToken', # OPTIONAL | ||
| 48 | Owner => 'Self', # OPTIONAL | ||
| 49 | ); | ||
| 50 | |||
| 51 | # Results: | ||
| 52 | my $ImageVersionList = $ListImagesResponse->ImageVersionList; | ||
| 53 | my $NextToken = $ListImagesResponse->NextToken; | ||
| 54 | my $RequestId = $ListImagesResponse->RequestId; | ||
| 55 | |||
| 56 | # Returns a L<Paws::ImageBuilder::ListImagesResponse> 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/imagebuilder/ListImages> | ||
| 60 | |||
| 61 | =head1 ATTRIBUTES | ||
| 62 | |||
| 63 | |||
| 64 | =head2 ByName => Bool | ||
| 65 | |||
| 66 | Requests a list of images with a specific recipe name. | ||
| 67 | |||
| 68 | |||
| 69 | |||
| 70 | =head2 Filters => ArrayRef[L<Paws::ImageBuilder::Filter>] | ||
| 71 | |||
| 72 | The filters. | ||
| 73 | |||
| 74 | |||
| 75 | |||
| 76 | =head2 IncludeDeprecated => Bool | ||
| 77 | |||
| 78 | Includes deprecated images in the response list. | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head2 MaxResults => Int | ||
| 83 | |||
| 84 | The maximum items to return in a request. | ||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | =head2 NextToken => Str | ||
| 89 | |||
| 90 | A token to specify where to start paginating. This is the NextToken | ||
| 91 | from a previously truncated response. | ||
| 92 | |||
| 93 | |||
| 94 | |||
| 95 | =head2 Owner => Str | ||
| 96 | |||
| 97 | The owner defines which images you want to list. By default, this | ||
| 98 | request will only show images owned by your account. You can use this | ||
| 99 | field to specify if you want to view images owned by yourself, by | ||
| 100 | Amazon, or those images that have been shared with you by other | ||
| 101 | customers. | ||
| 102 | |||
| 103 | Valid values are: C<"Self">, C<"Shared">, C<"Amazon"> | ||
| 104 | |||
| 105 | |||
| 106 | =head1 SEE ALSO | ||
| 107 | |||
| 108 | This class forms part of L<Paws>, documenting arguments for method ListImages in L<Paws::ImageBuilder> | ||
| 109 | |||
| 110 | =head1 BUGS and CONTRIBUTIONS | ||
| 111 | |||
| 112 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 113 | |||
| 114 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 115 | |||
| 116 | =cut | ||
| 117 |