« blib/lib/Paws/EC2/DescribeInternetGatewaysResult.pm
↑ Summary
blib/lib/Paws/EC2/DescribeKeyPairsResult.pm »
| 1 | |||
| 2 | package Paws::EC2::DescribeKeyPairs; | ||
| 3 | 1 | ▶ | use Moose; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 4 | 1 | has DryRun => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'dryRun' ); | |
| 5 | 1 | has Filters => (is => 'ro', isa => 'ArrayRef[Paws::EC2::Filter]', traits => ['NameInRequest'], request_name => 'Filter' ); | |
| 6 | 1 | has KeyNames => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'KeyName' ); | |
| 7 | 1 | has KeyPairIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'KeyPairId' ); | |
| 8 | |||
| 9 | 1 | ▶ | use MooseX::ClassAttribute; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 10 | |||
| 11 | 1 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeKeyPairs'); | |
| 12 | 1 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EC2::DescribeKeyPairsResult'); | |
| 13 | 1 | class_has _result_key => (isa => 'Str', is => 'ro'); | |
| 14 | 1 | 1; | |
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::EC2::DescribeKeyPairs - Arguments for method DescribeKeyPairs on L<Paws::EC2> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method DescribeKeyPairs on the | ||
| 25 | L<Amazon Elastic Compute Cloud|Paws::EC2> service. Use the attributes of this class | ||
| 26 | as arguments to method DescribeKeyPairs. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeKeyPairs. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $ec2 = Paws->service('EC2'); | ||
| 33 | # To display a key pair | ||
| 34 | # This example displays the fingerprint for the specified key. | ||
| 35 | my $DescribeKeyPairsResult = | ||
| 36 | $ec2->DescribeKeyPairs( 'KeyNames' => ['my-key-pair'] ); | ||
| 37 | |||
| 38 | # Results: | ||
| 39 | my $KeyPairs = $DescribeKeyPairsResult->KeyPairs; | ||
| 40 | |||
| 41 | # Returns a L<Paws::EC2::DescribeKeyPairsResult> object. | ||
| 42 | |||
| 43 | 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. | ||
| 44 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ec2/DescribeKeyPairs> | ||
| 45 | |||
| 46 | =head1 ATTRIBUTES | ||
| 47 | |||
| 48 | |||
| 49 | =head2 DryRun => Bool | ||
| 50 | |||
| 51 | Checks whether you have the required permissions for the action, | ||
| 52 | without actually making the request, and provides an error response. If | ||
| 53 | you have the required permissions, the error response is | ||
| 54 | C<DryRunOperation>. Otherwise, it is C<UnauthorizedOperation>. | ||
| 55 | |||
| 56 | |||
| 57 | |||
| 58 | =head2 Filters => ArrayRef[L<Paws::EC2::Filter>] | ||
| 59 | |||
| 60 | The filters. | ||
| 61 | |||
| 62 | =over | ||
| 63 | |||
| 64 | =item * | ||
| 65 | |||
| 66 | C<key-pair-id> - The ID of the key pair. | ||
| 67 | |||
| 68 | =item * | ||
| 69 | |||
| 70 | C<fingerprint> - The fingerprint of the key pair. | ||
| 71 | |||
| 72 | =item * | ||
| 73 | |||
| 74 | C<key-name> - The name of the key pair. | ||
| 75 | |||
| 76 | =item * | ||
| 77 | |||
| 78 | C<tag-key> - The key of a tag assigned to the resource. Use this filter | ||
| 79 | to find all resources assigned a tag with a specific key, regardless of | ||
| 80 | the tag value. | ||
| 81 | |||
| 82 | =item * | ||
| 83 | |||
| 84 | C<tag>:E<lt>keyE<gt> - The key/value combination of a tag assigned to | ||
| 85 | the resource. Use the tag key in the filter name and the tag value as | ||
| 86 | the filter value. For example, to find all resources that have a tag | ||
| 87 | with the key C<Owner> and the value C<TeamA>, specify C<tag:Owner> for | ||
| 88 | the filter name and C<TeamA> for the filter value. | ||
| 89 | |||
| 90 | =back | ||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | |||
| 95 | =head2 KeyNames => ArrayRef[Str|Undef] | ||
| 96 | |||
| 97 | The key pair names. | ||
| 98 | |||
| 99 | Default: Describes all your key pairs. | ||
| 100 | |||
| 101 | |||
| 102 | |||
| 103 | =head2 KeyPairIds => ArrayRef[Str|Undef] | ||
| 104 | |||
| 105 | The IDs of the key pairs. | ||
| 106 | |||
| 107 | |||
| 108 | |||
| 109 | |||
| 110 | =head1 SEE ALSO | ||
| 111 | |||
| 112 | This class forms part of L<Paws>, documenting arguments for method DescribeKeyPairs in L<Paws::EC2> | ||
| 113 | |||
| 114 | =head1 BUGS and CONTRIBUTIONS | ||
| 115 | |||
| 116 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 117 | |||
| 118 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 119 | |||
| 120 | =cut | ||
| 121 | |||