/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::CognitoIdentity::GetOpenIdTokenForDeveloperIdentity

NAME

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

DESCRIPTION

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

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

SYNOPSIS

my $cognito-identity = Paws->service('CognitoIdentity');
my $GetOpenIdTokenForDeveloperIdentityResponse =
  $cognito -identity->GetOpenIdTokenForDeveloperIdentity(
  IdentityPoolId => 'MyIdentityPoolId',
  Logins         => {
    'MyIdentityProviderName' => 'MyIdentityProviderToken'
    ,    # key: min: 1, max: 128, value: min: 1, max: 50000
  },
  IdentityId    => 'MyIdentityId',    # OPTIONAL
  PrincipalTags => {
    'MyPrincipalTagID' => 'MyPrincipalTagValue'
    ,    # key: min: 1, max: 128, value: min: 1, max: 256
  },    # OPTIONAL
  TokenDuration => 1,    # OPTIONAL
  );

# Results:
my $IdentityId = $GetOpenIdTokenForDeveloperIdentityResponse->IdentityId;
my $Token      = $GetOpenIdTokenForDeveloperIdentityResponse->Token;

# Returns a Paws::CognitoIdentity::GetOpenIdTokenForDeveloperIdentityResponse 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/GetOpenIdTokenForDeveloperIdentity

ATTRIBUTES

IdentityId => Str

A unique identifier in the format REGION:GUID.

REQUIRED IdentityPoolId => Str

An identity pool ID in the format REGION:GUID.

REQUIRED Logins => Paws::CognitoIdentity::LoginsMap

A set of optional name-value pairs that map provider names to provider tokens. Each name-value pair represents a user from a public provider or developer provider. If the user is from a developer provider, the name-value pair will follow the syntax "developer_provider_name": "developer_user_identifier". The developer provider is the "domain" by which Cognito will refer to your users; you provided this domain while creating/updating the identity pool. The developer user identifier is an identifier from your backend that uniquely identifies a user. When you create an identity pool, you can specify the supported logins.

PrincipalTags => Paws::CognitoIdentity::PrincipalTags

Use this operation to configure attribute mappings for custom providers.

TokenDuration => Int

The expiration time of the token, in seconds. You can specify a custom expiration time for the token so that you can cache it. If you don't provide an expiration time, the token is valid for 15 minutes. You can exchange the token with Amazon STS for temporary AWS credentials, which are valid for a maximum of one hour. The maximum token duration you can set is 24 hours. You should take care in setting the expiration time for a token, as there are significant security implications: an attacker could use a leaked token to access your AWS resources for the token's duration.

Please provide for a small grace period, usually no more than 5 minutes, to account for clock skew.

SEE ALSO

This class forms part of Paws, documenting arguments for method GetOpenIdTokenForDeveloperIdentity 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