NAME

Paws::CognitoIdentity::GetCredentialsForIdentity - Arguments for method GetCredentialsForIdentity on Paws::CognitoIdentity

DESCRIPTION

This class represents the parameters used for calling the method GetCredentialsForIdentity on the Amazon Cognito Identity service. Use the attributes of this class as arguments to method GetCredentialsForIdentity.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetCredentialsForIdentity.

SYNOPSIS

    my $cognito-identity = Paws->service('CognitoIdentity');
    my $GetCredentialsForIdentityResponse =
      $cognito -identity->GetCredentialsForIdentity(
      IdentityId    => 'MyIdentityId',
      CustomRoleArn => 'MyARNString',    # OPTIONAL
      Logins        => {
        'MyIdentityProviderName' => 'MyIdentityProviderToken'
        ,    # key: min: 1, max: 128, value: min: 1, max: 50000
      },    # OPTIONAL
      );

    # Results:
    my $Credentials = $GetCredentialsForIdentityResponse->Credentials;
    my $IdentityId  = $GetCredentialsForIdentityResponse->IdentityId;

 # Returns a L<Paws::CognitoIdentity::GetCredentialsForIdentityResponse> object.

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. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/cognito-identity/GetCredentialsForIdentity

ATTRIBUTES

CustomRoleArn => Str

The Amazon Resource Name (ARN) of the role to be assumed when multiple roles were received in the token from the identity provider. For example, a SAML-based identity provider. This parameter is optional for identity providers that do not support role customization.

REQUIRED IdentityId => Str

A unique identifier in the format REGION:GUID.

Logins => Paws::CognitoIdentity::LoginsMap

A set of optional name-value pairs that map provider names to provider tokens. The name-value pair will follow the syntax "provider_name": "provider_user_identifier".

Logins should not be specified when trying to get credentials for an unauthenticated identity.

The Logins parameter is required when using identities associated with external identity providers such as Facebook. For examples of Logins maps, see the code examples in the External Identity Providers (https://docs.aws.amazon.com/cognito/latest/developerguide/external-identity-providers.html) section of the Amazon Cognito Developer Guide.

SEE ALSO

This class forms part of Paws, documenting arguments for method GetCredentialsForIdentity in Paws::CognitoIdentity

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues