The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Paws-0.01
River stage two • 9 direct dependents • 11 total dependents
57 ++
/ Paws::CognitoIdentity

NAME

Paws::CognitoIdentity - Perl Interface to AWS Amazon Cognito Identity

SYNOPSIS

  use Paws;

  my $obj = Paws->service('...')->new;
  my $res = $obj->Method(Arg1 => $val1, Arg2 => $val2);

DESCRIPTION

Amazon Cognito

Amazon Cognito is a web service that delivers scoped temporary credentials to mobile devices and other untrusted environments. Amazon Cognito uniquely identifies a device and supplies the user with a consistent identity over the lifetime of an application.

Using Amazon Cognito, you can enable authentication with one or more third-party identity providers (Facebook, Google, or Login with Amazon), and you can also choose to support unauthenticated access from your app. Cognito delivers a unique identifier for each user and acts as an OpenID token provider trusted by AWS Security Token Service (STS) to access temporary, limited-privilege AWS credentials.

To provide end-user credentials, first make an unsigned call to GetId. If the end user is authenticated with one of the supported identity providers, set the Logins map with the identity provider token. GetId returns a unique identifier for the user.

Next, make an unsigned call to GetCredentialsForIdentity. This call expects the same Logins map as the GetId call, as well as the IdentityID originally returned by GetId. Assuming your identity pool has been configured via the SetIdentityPoolRoles operation, GetCredentialsForIdentity will return AWS credentials for your use. If your pool has not been configured with SetIdentityPoolRoles, or if you want to follow legacy flow, make an unsigned call to GetOpenIdToken, which returns the OpenID token necessary to call STS and retrieve AWS credentials. This call expects the same Logins map as the GetId call, as well as the IdentityID originally returned by GetId. The token returned by GetOpenIdToken can be passed to the STS operation AssumeRoleWithWebIdentity to retrieve AWS credentials.

If you want to use Amazon Cognito in an Android, iOS, or Unity application, you will probably want to make API calls via the AWS Mobile SDK. To learn more, see the AWS Mobile SDK Developer Guide.

METHODS

CreateIdentityPool()

  Arguments described in: L<Paws::CognitoIdentity::CreateIdentityPool>

  Returns: L<Paws::CognitoIdentity::IdentityPool>

Creates a new identity pool. The identity pool is a store of user identity information that is specific to your AWS account. The limit on identity pools is 60 per account.

DeleteIdentityPool()

  Arguments described in: L<Paws::CognitoIdentity::DeleteIdentityPool>

  Returns: nothing

Deletes a user pool. Once a pool is deleted, users will not be able to authenticate with the pool.

DescribeIdentity()

  Arguments described in: L<Paws::CognitoIdentity::DescribeIdentity>

  Returns: L<Paws::CognitoIdentity::IdentityDescription>

Returns metadata related to the given identity, including when the identity was created and any associated linked logins.

DescribeIdentityPool()

  Arguments described in: L<Paws::CognitoIdentity::DescribeIdentityPool>

  Returns: L<Paws::CognitoIdentity::IdentityPool>

Gets details about a particular identity pool, including the pool name, ID description, creation date, and current number of users.

GetCredentialsForIdentity()

  Arguments described in: L<Paws::CognitoIdentity::GetCredentialsForIdentity>

  Returns: L<Paws::CognitoIdentity::GetCredentialsForIdentityResponse>

Returns credentials for the the provided identity ID. Any provided logins will be validated against supported login providers. If the token is for cognito-identity.amazonaws.com, it will be passed through to AWS Security Token Service with the appropriate role for the token.

GetId()

  Arguments described in: L<Paws::CognitoIdentity::GetId>

  Returns: L<Paws::CognitoIdentity::GetIdResponse>

Generates (or retrieves) a Cognito ID. Supplying multiple logins will create an implicit linked account.

GetIdentityPoolRoles()

  Arguments described in: L<Paws::CognitoIdentity::GetIdentityPoolRoles>

  Returns: L<Paws::CognitoIdentity::GetIdentityPoolRolesResponse>

Gets the roles for an identity pool.

GetOpenIdToken()

  Arguments described in: L<Paws::CognitoIdentity::GetOpenIdToken>

  Returns: L<Paws::CognitoIdentity::GetOpenIdTokenResponse>

Gets an OpenID token, using a known Cognito ID. This known Cognito ID is returned by GetId. You can optionally add additional logins for the identity. Supplying multiple logins creates an implicit link.

The OpenId token is valid for 15 minutes.

GetOpenIdTokenForDeveloperIdentity()

  Arguments described in: L<Paws::CognitoIdentity::GetOpenIdTokenForDeveloperIdentity>

  Returns: L<Paws::CognitoIdentity::GetOpenIdTokenForDeveloperIdentityResponse>

Registers (or retrieves) a Cognito IdentityId and an OpenID Connect token for a user authenticated by your backend authentication process. Supplying multiple logins will create an implicit linked account. You can only specify one developer provider as part of the Logins map, which is linked to the identity pool. The developer provider is the "domain" by which Cognito will refer to your users.

You can use GetOpenIdTokenForDeveloperIdentity to create a new identity and to link new logins (that is, user credentials issued by a public provider or developer provider) to an existing identity. When you want to create a new identity, the IdentityId should be null. When you want to associate a new login with an existing authenticated/unauthenticated identity, you can do so by providing the existing IdentityId. This API will create the identity in the specified IdentityPoolId.

ListIdentities()

  Arguments described in: L<Paws::CognitoIdentity::ListIdentities>

  Returns: L<Paws::CognitoIdentity::ListIdentitiesResponse>

Lists the identities in a pool.

ListIdentityPools()

  Arguments described in: L<Paws::CognitoIdentity::ListIdentityPools>

  Returns: L<Paws::CognitoIdentity::ListIdentityPoolsResponse>

Lists all of the Cognito identity pools registered for your account.

LookupDeveloperIdentity()

  Arguments described in: L<Paws::CognitoIdentity::LookupDeveloperIdentity>

  Returns: L<Paws::CognitoIdentity::LookupDeveloperIdentityResponse>

Retrieves the IdentityID associated with a DeveloperUserIdentifier or the list of DeveloperUserIdentifiers associated with an IdentityId for an existing identity. Either IdentityID or DeveloperUserIdentifier must not be null. If you supply only one of these values, the other value will be searched in the database and returned as a part of the response. If you supply both, DeveloperUserIdentifier will be matched against IdentityID. If the values are verified against the database, the response returns both values and is the same as the request. Otherwise a ResourceConflictException is thrown.

MergeDeveloperIdentities()

  Arguments described in: L<Paws::CognitoIdentity::MergeDeveloperIdentities>

  Returns: L<Paws::CognitoIdentity::MergeDeveloperIdentitiesResponse>

Merges two users having different IdentityIds, existing in the same identity pool, and identified by the same developer provider. You can use this action to request that discrete users be merged and identified as a single user in the Cognito environment. Cognito associates the given source user (SourceUserIdentifier) with the IdentityId of the DestinationUserIdentifier. Only developer-authenticated users can be merged. If the users to be merged are associated with the same public provider, but as two different users, an exception will be thrown.

SetIdentityPoolRoles()

  Arguments described in: L<Paws::CognitoIdentity::SetIdentityPoolRoles>

  Returns: nothing

Sets the roles for an identity pool. These roles are used when making calls to GetCredentialsForIdentity action.

UnlinkDeveloperIdentity()

  Arguments described in: L<Paws::CognitoIdentity::UnlinkDeveloperIdentity>

  Returns: nothing

Unlinks a DeveloperUserIdentifier from an existing identity. Unlinked developer users will be considered new identities next time they are seen. If, for a given Cognito identity, you remove all federated identities as well as the developer user identifier, the Cognito identity becomes inaccessible.

UnlinkIdentity()

  Arguments described in: L<Paws::CognitoIdentity::UnlinkIdentity>

  Returns: nothing

Unlinks a federated identity from an existing account. Unlinked logins will be considered new identities next time they are seen. Removing the last linked login will make this identity inaccessible.

UpdateIdentityPool()

  Arguments described in: L<Paws::CognitoIdentity::UpdateIdentityPool>

  Returns: L<Paws::CognitoIdentity::IdentityPool>

Updates a user pool.

SEE ALSO

This service class forms part of Paws

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