« blib/lib/Paws/EC2/DescribeFpgaImageAttributeResult.pm
↑ Summary
blib/lib/Paws/EC2/DescribeFpgaImagesResult.pm »
| 1 | |||
| 2 | package Paws::EC2::DescribeFpgaImages; | ||
| 3 | use Moose; | ||
| 4 | has DryRun => (is => 'ro', isa => 'Bool'); | ||
| 5 | has Filters => (is => 'ro', isa => 'ArrayRef[Paws::EC2::Filter]', traits => ['NameInRequest'], request_name => 'Filter' ); | ||
| 6 | has FpgaImageIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'FpgaImageId' ); | ||
| 7 | has MaxResults => (is => 'ro', isa => 'Int'); | ||
| 8 | has NextToken => (is => 'ro', isa => 'Str'); | ||
| 9 | has Owners => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'Owner' ); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeFpgaImages'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EC2::DescribeFpgaImagesResult'); | ||
| 15 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::EC2::DescribeFpgaImages - Arguments for method DescribeFpgaImages on L<Paws::EC2> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method DescribeFpgaImages on the | ||
| 27 | L<Amazon Elastic Compute Cloud|Paws::EC2> service. Use the attributes of this class | ||
| 28 | as arguments to method DescribeFpgaImages. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeFpgaImages. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $ec2 = Paws->service('EC2'); | ||
| 35 | my $DescribeFpgaImagesResult = $ec2->DescribeFpgaImages( | ||
| 36 | DryRun => 1, # OPTIONAL | ||
| 37 | Filters => [ | ||
| 38 | { | ||
| 39 | Name => 'MyString', # OPTIONAL | ||
| 40 | Values => [ | ||
| 41 | 'MyString', ... # OPTIONAL | ||
| 42 | ], # OPTIONAL | ||
| 43 | }, | ||
| 44 | ... | ||
| 45 | ], # OPTIONAL | ||
| 46 | FpgaImageIds => [ 'MyFpgaImageId', ... ], # OPTIONAL | ||
| 47 | MaxResults => 1, # OPTIONAL | ||
| 48 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 49 | Owners => [ | ||
| 50 | 'MyString', ... # OPTIONAL | ||
| 51 | ], # OPTIONAL | ||
| 52 | ); | ||
| 53 | |||
| 54 | # Results: | ||
| 55 | my $FpgaImages = $DescribeFpgaImagesResult->FpgaImages; | ||
| 56 | my $NextToken = $DescribeFpgaImagesResult->NextToken; | ||
| 57 | |||
| 58 | # Returns a L<Paws::EC2::DescribeFpgaImagesResult> object. | ||
| 59 | |||
| 60 | 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. | ||
| 61 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ec2/DescribeFpgaImages> | ||
| 62 | |||
| 63 | =head1 ATTRIBUTES | ||
| 64 | |||
| 65 | |||
| 66 | =head2 DryRun => Bool | ||
| 67 | |||
| 68 | Checks whether you have the required permissions for the action, | ||
| 69 | without actually making the request, and provides an error response. If | ||
| 70 | you have the required permissions, the error response is | ||
| 71 | C<DryRunOperation>. Otherwise, it is C<UnauthorizedOperation>. | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head2 Filters => ArrayRef[L<Paws::EC2::Filter>] | ||
| 76 | |||
| 77 | The filters. | ||
| 78 | |||
| 79 | =over | ||
| 80 | |||
| 81 | =item * | ||
| 82 | |||
| 83 | C<create-time> - The creation time of the AFI. | ||
| 84 | |||
| 85 | =item * | ||
| 86 | |||
| 87 | C<fpga-image-id> - The FPGA image identifier (AFI ID). | ||
| 88 | |||
| 89 | =item * | ||
| 90 | |||
| 91 | C<fpga-image-global-id> - The global FPGA image identifier (AGFI ID). | ||
| 92 | |||
| 93 | =item * | ||
| 94 | |||
| 95 | C<name> - The name of the AFI. | ||
| 96 | |||
| 97 | =item * | ||
| 98 | |||
| 99 | C<owner-id> - The AWS account ID of the AFI owner. | ||
| 100 | |||
| 101 | =item * | ||
| 102 | |||
| 103 | C<product-code> - The product code. | ||
| 104 | |||
| 105 | =item * | ||
| 106 | |||
| 107 | C<shell-version> - The version of the AWS Shell that was used to create | ||
| 108 | the bitstream. | ||
| 109 | |||
| 110 | =item * | ||
| 111 | |||
| 112 | C<state> - The state of the AFI (C<pending> | C<failed> | C<available> | ||
| 113 | | C<unavailable>). | ||
| 114 | |||
| 115 | =item * | ||
| 116 | |||
| 117 | C<tag>:E<lt>keyE<gt> - The key/value combination of a tag assigned to | ||
| 118 | the resource. Use the tag key in the filter name and the tag value as | ||
| 119 | the filter value. For example, to find all resources that have a tag | ||
| 120 | with the key C<Owner> and the value C<TeamA>, specify C<tag:Owner> for | ||
| 121 | the filter name and C<TeamA> for the filter value. | ||
| 122 | |||
| 123 | =item * | ||
| 124 | |||
| 125 | C<tag-key> - The key of a tag assigned to the resource. Use this filter | ||
| 126 | to find all resources assigned a tag with a specific key, regardless of | ||
| 127 | the tag value. | ||
| 128 | |||
| 129 | =item * | ||
| 130 | |||
| 131 | C<update-time> - The time of the most recent update. | ||
| 132 | |||
| 133 | =back | ||
| 134 | |||
| 135 | |||
| 136 | |||
| 137 | |||
| 138 | =head2 FpgaImageIds => ArrayRef[Str|Undef] | ||
| 139 | |||
| 140 | The AFI IDs. | ||
| 141 | |||
| 142 | |||
| 143 | |||
| 144 | =head2 MaxResults => Int | ||
| 145 | |||
| 146 | The maximum number of results to return in a single call. | ||
| 147 | |||
| 148 | |||
| 149 | |||
| 150 | =head2 NextToken => Str | ||
| 151 | |||
| 152 | The token to retrieve the next page of results. | ||
| 153 | |||
| 154 | |||
| 155 | |||
| 156 | =head2 Owners => ArrayRef[Str|Undef] | ||
| 157 | |||
| 158 | Filters the AFI by owner. Specify an AWS account ID, C<self> (owner is | ||
| 159 | the sender of the request), or an AWS owner alias (valid values are | ||
| 160 | C<amazon> | C<aws-marketplace>). | ||
| 161 | |||
| 162 | |||
| 163 | |||
| 164 | |||
| 165 | =head1 SEE ALSO | ||
| 166 | |||
| 167 | This class forms part of L<Paws>, documenting arguments for method DescribeFpgaImages in L<Paws::EC2> | ||
| 168 | |||
| 169 | =head1 BUGS and CONTRIBUTIONS | ||
| 170 | |||
| 171 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 172 | |||
| 173 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 174 | |||
| 175 | =cut | ||
| 176 |