| 1 | |||
| 2 | package Paws::SSO::GetRoleCredentials; | ||
| 3 | use Moose; | ||
| 4 | has AccessToken => (is => 'ro', isa => 'Str', traits => ['ParamInHeader'], header_name => 'x-amz-sso_bearer_token', required => 1); | ||
| 5 | has AccountId => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'account_id', required => 1); | ||
| 6 | has RoleName => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'role_name', required => 1); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetRoleCredentials'); | ||
| 11 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/federation/credentials'); | ||
| 12 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SSO::GetRoleCredentialsResponse'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::SSO::GetRoleCredentials - Arguments for method GetRoleCredentials on L<Paws::SSO> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method GetRoleCredentials on the | ||
| 25 | L<AWS Single Sign-On|Paws::SSO> service. Use the attributes of this class | ||
| 26 | as arguments to method GetRoleCredentials. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetRoleCredentials. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $portal.sso = Paws->service('SSO'); | ||
| 33 | my $GetRoleCredentialsResponse = $portal . sso->GetRoleCredentials( | ||
| 34 | AccessToken => 'MyAccessTokenType', | ||
| 35 | AccountId => 'MyAccountIdType', | ||
| 36 | RoleName => 'MyRoleNameType', | ||
| 37 | |||
| 38 | ); | ||
| 39 | |||
| 40 | # Results: | ||
| 41 | my $RoleCredentials = $GetRoleCredentialsResponse->RoleCredentials; | ||
| 42 | |||
| 43 | # Returns a L<Paws::SSO::GetRoleCredentialsResponse> object. | ||
| 44 | |||
| 45 | 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. | ||
| 46 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/portal.sso/GetRoleCredentials> | ||
| 47 | |||
| 48 | =head1 ATTRIBUTES | ||
| 49 | |||
| 50 | |||
| 51 | =head2 B<REQUIRED> AccessToken => Str | ||
| 52 | |||
| 53 | The token issued by the C<CreateToken> API call. For more information, | ||
| 54 | see CreateToken | ||
| 55 | (https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/API_CreateToken.html) | ||
| 56 | in the I<AWS SSO OIDC API Reference Guide>. | ||
| 57 | |||
| 58 | |||
| 59 | |||
| 60 | =head2 B<REQUIRED> AccountId => Str | ||
| 61 | |||
| 62 | The identifier for the AWS account that is assigned to the user. | ||
| 63 | |||
| 64 | |||
| 65 | |||
| 66 | =head2 B<REQUIRED> RoleName => Str | ||
| 67 | |||
| 68 | The friendly name of the role that is assigned to the user. | ||
| 69 | |||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | =head1 SEE ALSO | ||
| 74 | |||
| 75 | This class forms part of L<Paws>, documenting arguments for method GetRoleCredentials in L<Paws::SSO> | ||
| 76 | |||
| 77 | =head1 BUGS and CONTRIBUTIONS | ||
| 78 | |||
| 79 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 80 | |||
| 81 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 82 | |||
| 83 | =cut | ||
| 84 |