NAME

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

SYNOPSIS

  use Paws;

  my $obj = Paws->service('CognitoIdentity');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => '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(AllowUnauthenticatedIdentities => Bool, IdentityPoolName => Str, [DeveloperProviderName => Str, OpenIdConnectProviderARNs => ArrayRef[Str], SupportedLoginProviders => Paws::CognitoIdentity::IdentityProviders])

Each argument is described in detail in: Paws::CognitoIdentity::CreateIdentityPool

Returns: a Paws::CognitoIdentity::IdentityPool instance

  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. The keys for
C<SupportedLoginProviders> are as follows:

• Facebook: graph.facebook.com

• Google: accounts.google.com

• Amazon: www.amazon.com

• Twitter: api.twitter.com

• Digits: www.digits.com

You must use AWS Developer credentials to call this API.

DeleteIdentities(IdentityIdsToDelete => ArrayRef[Str])

Each argument is described in detail in: Paws::CognitoIdentity::DeleteIdentities

Returns: a Paws::CognitoIdentity::DeleteIdentitiesResponse instance

  Deletes identities from an identity pool. You can specify a list of
1-60 identities that you want to delete.

You must use AWS Developer credentials to call this API.

DeleteIdentityPool(IdentityPoolId => Str)

Each argument is described in detail in: Paws::CognitoIdentity::DeleteIdentityPool

Returns: nothing

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

You must use AWS Developer credentials to call this API.

DescribeIdentity(IdentityId => Str)

Each argument is described in detail in: Paws::CognitoIdentity::DescribeIdentity

Returns: a Paws::CognitoIdentity::IdentityDescription instance

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

You must use AWS Developer credentials to call this API.

DescribeIdentityPool(IdentityPoolId => Str)

Each argument is described in detail in: Paws::CognitoIdentity::DescribeIdentityPool

Returns: a Paws::CognitoIdentity::IdentityPool instance

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

You must use AWS Developer credentials to call this API.

GetCredentialsForIdentity(IdentityId => Str, [Logins => Paws::CognitoIdentity::LoginsMap])

Each argument is described in detail in: Paws::CognitoIdentity::GetCredentialsForIdentity

Returns: a Paws::CognitoIdentity::GetCredentialsForIdentityResponse instance

  Returns credentials for 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.

This is a public API. You do not need any credentials to call this API.

GetId(IdentityPoolId => Str, [AccountId => Str, Logins => Paws::CognitoIdentity::LoginsMap])

Each argument is described in detail in: Paws::CognitoIdentity::GetId

Returns: a Paws::CognitoIdentity::GetIdResponse instance

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

This is a public API. You do not need any credentials to call this API.

GetIdentityPoolRoles(IdentityPoolId => Str)

Each argument is described in detail in: Paws::CognitoIdentity::GetIdentityPoolRoles

Returns: a Paws::CognitoIdentity::GetIdentityPoolRolesResponse instance

  Gets the roles for an identity pool.

You must use AWS Developer credentials to call this API.

GetOpenIdToken(IdentityId => Str, [Logins => Paws::CognitoIdentity::LoginsMap])

Each argument is described in detail in: Paws::CognitoIdentity::GetOpenIdToken

Returns: a Paws::CognitoIdentity::GetOpenIdTokenResponse instance

  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.

This is a public API. You do not need any credentials to call this API.

GetOpenIdTokenForDeveloperIdentity(IdentityPoolId => Str, Logins => Paws::CognitoIdentity::LoginsMap, [IdentityId => Str, TokenDuration => Int])

Each argument is described in detail in: Paws::CognitoIdentity::GetOpenIdTokenForDeveloperIdentity

Returns: a Paws::CognitoIdentity::GetOpenIdTokenForDeveloperIdentityResponse instance

  Registers (or retrieves) a Cognito C<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 C<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.

You must use AWS Developer credentials to call this API.

ListIdentities(IdentityPoolId => Str, MaxResults => Int, [HideDisabled => Bool, NextToken => Str])

Each argument is described in detail in: Paws::CognitoIdentity::ListIdentities

Returns: a Paws::CognitoIdentity::ListIdentitiesResponse instance

  Lists the identities in a pool.

You must use AWS Developer credentials to call this API.

ListIdentityPools(MaxResults => Int, [NextToken => Str])

Each argument is described in detail in: Paws::CognitoIdentity::ListIdentityPools

Returns: a Paws::CognitoIdentity::ListIdentityPoolsResponse instance

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

You must use AWS Developer credentials to call this API.

LookupDeveloperIdentity(IdentityPoolId => Str, [DeveloperUserIdentifier => Str, IdentityId => Str, MaxResults => Int, NextToken => Str])

Each argument is described in detail in: Paws::CognitoIdentity::LookupDeveloperIdentity

Returns: a Paws::CognitoIdentity::LookupDeveloperIdentityResponse instance

  Retrieves the C<IdentityID> associated with a
C<DeveloperUserIdentifier> or the list of C<DeveloperUserIdentifier>s
associated with an C<IdentityId> for an existing identity. Either
C<IdentityID> or C<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, C<DeveloperUserIdentifier> will be matched against C<IdentityID>.
If the values are verified against the database, the response returns
both values and is the same as the request. Otherwise a
C<ResourceConflictException> is thrown.

You must use AWS Developer credentials to call this API.

MergeDeveloperIdentities(DestinationUserIdentifier => Str, DeveloperProviderName => Str, IdentityPoolId => Str, SourceUserIdentifier => Str)

Each argument is described in detail in: Paws::CognitoIdentity::MergeDeveloperIdentities

Returns: a Paws::CognitoIdentity::MergeDeveloperIdentitiesResponse instance

  Merges two users having different C<IdentityId>s, 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 (C<SourceUserIdentifier>) with the C<IdentityId> of
the C<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.

You must use AWS Developer credentials to call this API.

SetIdentityPoolRoles(IdentityPoolId => Str, Roles => Paws::CognitoIdentity::RolesMap)

Each argument is described in detail in: Paws::CognitoIdentity::SetIdentityPoolRoles

Returns: nothing

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

You must use AWS Developer credentials to call this API.

UnlinkDeveloperIdentity(DeveloperProviderName => Str, DeveloperUserIdentifier => Str, IdentityId => Str, IdentityPoolId => Str)

Each argument is described in detail in: Paws::CognitoIdentity::UnlinkDeveloperIdentity

Returns: nothing

  Unlinks a C<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.

You must use AWS Developer credentials to call this API.

UnlinkIdentity(IdentityId => Str, Logins => Paws::CognitoIdentity::LoginsMap, LoginsToRemove => ArrayRef[Str])

Each argument is described in detail in: 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.

This is a public API. You do not need any credentials to call this API.

UpdateIdentityPool(AllowUnauthenticatedIdentities => Bool, IdentityPoolId => Str, IdentityPoolName => Str, [DeveloperProviderName => Str, OpenIdConnectProviderARNs => ArrayRef[Str], SupportedLoginProviders => Paws::CognitoIdentity::IdentityProviders])

Each argument is described in detail in: Paws::CognitoIdentity::UpdateIdentityPool

Returns: a Paws::CognitoIdentity::IdentityPool instance

  Updates a user pool.

You must use AWS Developer credentials to call this API.

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

cpanm Paws::SDK::Config

perl -MCPAN -e shell
install Paws::SDK::Config