« blib/lib/Paws/IAM/GetSAMLProviderResponse.pm
↑ Summary
blib/lib/Paws/IAM/GetSSHPublicKeyResponse.pm »
| 1 | |||
| 2 | package Paws::IAM::GetSSHPublicKey; | ||
| 3 | use Moose; | ||
| 4 | has Encoding => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has SSHPublicKeyId => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has UserName => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetSSHPublicKey'); | ||
| 11 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::IAM::GetSSHPublicKeyResponse'); | ||
| 12 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'GetSSHPublicKeyResult'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::IAM::GetSSHPublicKey - Arguments for method GetSSHPublicKey on L<Paws::IAM> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method GetSSHPublicKey on the | ||
| 24 | L<AWS Identity and Access Management|Paws::IAM> service. Use the attributes of this class | ||
| 25 | as arguments to method GetSSHPublicKey. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetSSHPublicKey. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $iam = Paws->service('IAM'); | ||
| 32 | my $GetSSHPublicKeyResponse = $iam->GetSSHPublicKey( | ||
| 33 | Encoding => 'SSH', | ||
| 34 | SSHPublicKeyId => 'MypublicKeyIdType', | ||
| 35 | UserName => 'MyuserNameType', | ||
| 36 | |||
| 37 | ); | ||
| 38 | |||
| 39 | # Results: | ||
| 40 | my $SSHPublicKey = $GetSSHPublicKeyResponse->SSHPublicKey; | ||
| 41 | |||
| 42 | # Returns a L<Paws::IAM::GetSSHPublicKeyResponse> object. | ||
| 43 | |||
| 44 | 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. | ||
| 45 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/iam/GetSSHPublicKey> | ||
| 46 | |||
| 47 | =head1 ATTRIBUTES | ||
| 48 | |||
| 49 | |||
| 50 | =head2 B<REQUIRED> Encoding => Str | ||
| 51 | |||
| 52 | Specifies the public key encoding format to use in the response. To | ||
| 53 | retrieve the public key in ssh-rsa format, use C<SSH>. To retrieve the | ||
| 54 | public key in PEM format, use C<PEM>. | ||
| 55 | |||
| 56 | Valid values are: C<"SSH">, C<"PEM"> | ||
| 57 | |||
| 58 | =head2 B<REQUIRED> SSHPublicKeyId => Str | ||
| 59 | |||
| 60 | The unique identifier for the SSH public key. | ||
| 61 | |||
| 62 | This parameter allows (through its regex pattern | ||
| 63 | (http://wikipedia.org/wiki/regex)) a string of characters that can | ||
| 64 | consist of any upper or lowercased letter or digit. | ||
| 65 | |||
| 66 | |||
| 67 | |||
| 68 | =head2 B<REQUIRED> UserName => Str | ||
| 69 | |||
| 70 | The name of the IAM user associated with the SSH public key. | ||
| 71 | |||
| 72 | This parameter allows (through its regex pattern | ||
| 73 | (http://wikipedia.org/wiki/regex)) a string of characters consisting of | ||
| 74 | upper and lowercase alphanumeric characters with no spaces. You can | ||
| 75 | also include any of the following characters: _+=,.@- | ||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | =head1 SEE ALSO | ||
| 81 | |||
| 82 | This class forms part of L<Paws>, documenting arguments for method GetSSHPublicKey in L<Paws::IAM> | ||
| 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 |