Note

You are viewing the documentation for an older version of boto (boto2).

Boto3, the next version of Boto, is now stable and recommended for general use. It can be used side-by-side with Boto in the same project, so it is easy to start using Boto3 in your existing projects as well as new projects. Going forward, API updates and all new feature work will be focused on Boto3.

For more information, see the documentation for boto3.

Cognito Identity

boto.cognito.identity

boto.cognito.identity.connect_to_region(region_name, **kw_params)
boto.cognito.identity.regions()

Get all available regions for the Amazon Cognito Identity service.

Return type:list
Returns:A list of boto.regioninfo.RegionInfo

boto.cognito.identity.layer1

class boto.cognito.identity.layer1.CognitoIdentityConnection(**kwargs)

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 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.

APIVersion = '2014-06-30'
DefaultRegionEndpoint = 'cognito-identity.us-east-1.amazonaws.com'
DefaultRegionName = 'us-east-1'
ResponseError

alias of JSONResponseError

ServiceName = 'CognitoIdentity'
TargetPrefix = 'AWSCognitoIdentityService'
create_identity_pool(identity_pool_name, allow_unauthenticated_identities, supported_login_providers=None, developer_provider_name=None, open_id_connect_provider_ar_ns=None)

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.

Parameters:
  • identity_pool_name (string) – A string that you provide.
  • allow_unauthenticated_identities (boolean) – TRUE if the identity pool supports unauthenticated logins.
  • supported_login_providers (map) – Optional key:value pairs mapping provider names to provider app IDs.
  • developer_provider_name (string) – The “domain” by which Cognito will refer to your users. This name acts as a placeholder that allows your backend and the Cognito service to communicate about the developer provider. For the DeveloperProviderName, you can use letters as well as period ( .), underscore ( _), and dash ( -).
Once you have set a developer provider name, you cannot change it.
Please take care in setting this parameter.
Parameters:open_id_connect_provider_ar_ns (list) –
delete_identity_pool(identity_pool_id)

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

Parameters:identity_pool_id (string) – An identity pool ID in the format REGION:GUID.
describe_identity_pool(identity_pool_id)

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

Parameters:identity_pool_id (string) – An identity pool ID in the format REGION:GUID.
get_id(account_id, identity_pool_id, logins=None)

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

Parameters:
  • account_id (string) – A standard AWS account ID (9+ digits).
  • identity_pool_id (string) – An identity pool ID in the format REGION:GUID.
  • logins (map) – A set of optional name-value pairs that map provider names to provider tokens.

The available provider names for Logins are as follows:

  • Facebook: graph.facebook.com
  • Google: accounts.google.com
  • Amazon: www.amazon.com
get_open_id_token(identity_id, logins=None)

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.

Parameters:
  • identity_id (string) – A unique identifier in the format REGION:GUID.
  • logins (map) – A set of optional name-value pairs that map provider names to provider tokens.
get_open_id_token_for_developer_identity(identity_pool_id, logins, identity_id=None, token_duration=None)

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.

Parameters:
  • identity_pool_id (string) – An identity pool ID in the format REGION:GUID.
  • identity_id (string) – A unique identifier in the format REGION:GUID.
  • logins (map) – 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.
  • token_duration (long) – 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.
list_identities(identity_pool_id, max_results, next_token=None)

Lists the identities in a pool.

Parameters:
  • identity_pool_id (string) – An identity pool ID in the format REGION:GUID.
  • max_results (integer) – The maximum number of identities to return.
  • next_token (string) – A pagination token.
list_identity_pools(max_results, next_token=None)

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

Parameters:
  • max_results (integer) – The maximum number of identities to return.
  • next_token (string) – A pagination token.
lookup_developer_identity(identity_pool_id, identity_id=None, developer_user_identifier=None, max_results=None, next_token=None)

Retrieves the IdentityID associated with a DeveloperUserIdentifier or the list of DeveloperUserIdentifier`s 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.

Parameters:
  • identity_pool_id (string) – An identity pool ID in the format REGION:GUID.
  • identity_id (string) – A unique identifier in the format REGION:GUID.
  • developer_user_identifier (string) – A unique ID used by your backend authentication process to identify a user. Typically, a developer identity provider would issue many developer user identifiers, in keeping with the number of users.
  • max_results (integer) – The maximum number of identities to return.
  • next_token (string) – A pagination token. The first call you make will have NextToken set to null. After that the service will return NextToken values as needed. For example, let’s say you make a request with MaxResults set to 10, and there are 20 matches in the database. The service will return a pagination token as a part of the response. This token can be used to call the API again and get results starting from the 11th match.
make_request(action, body)
merge_developer_identities(source_user_identifier, destination_user_identifier, developer_provider_name, identity_pool_id)

Merges two users having different 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 ( `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.

Parameters:
  • source_user_identifier (string) – User identifier for the source user. The value should be a DeveloperUserIdentifier.
  • destination_user_identifier (string) – User identifier for the destination user. The value should be a DeveloperUserIdentifier.
  • developer_provider_name (string) – The “domain” by which Cognito will refer to your users. This is a (pseudo) domain name that you provide while creating an identity pool. This name acts as a placeholder that allows your backend and the Cognito service to communicate about the developer provider. For the DeveloperProviderName, you can use letters as well as period (.), underscore (_), and dash (-).
  • identity_pool_id (string) – An identity pool ID in the format REGION:GUID.

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.

Parameters:
  • identity_id (string) – A unique identifier in the format REGION:GUID.
  • identity_pool_id (string) – An identity pool ID in the format REGION:GUID.
  • developer_provider_name (string) – The “domain” by which Cognito will refer to your users.
  • developer_user_identifier (string) – A unique ID used by your backend authentication process to identify a user.

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.

Parameters:
  • identity_id (string) – A unique identifier in the format REGION:GUID.
  • logins (map) – A set of optional name-value pairs that map provider names to provider tokens.
  • logins_to_remove (list) – Provider names to unlink from this identity.
update_identity_pool(identity_pool_id, identity_pool_name, allow_unauthenticated_identities, supported_login_providers=None, developer_provider_name=None, open_id_connect_provider_ar_ns=None)

Updates a user pool.

Parameters:
  • identity_pool_id (string) – An identity pool ID in the format REGION:GUID.
  • identity_pool_name (string) – A string that you provide.
  • allow_unauthenticated_identities (boolean) – TRUE if the identity pool supports unauthenticated logins.
  • supported_login_providers (map) – Optional key:value pairs mapping provider names to provider app IDs.
  • developer_provider_name (string) – The “domain” by which Cognito will refer to your users.
  • open_id_connect_provider_ar_ns (list) –

boto.cognito.identity.exceptions

exception boto.cognito.identity.exceptions.DeveloperUserAlreadyRegisteredException(status, reason, body=None, *args)
exception boto.cognito.identity.exceptions.InternalErrorException(status, reason, body=None, *args)
exception boto.cognito.identity.exceptions.InvalidParameterException(status, reason, body=None, *args)
exception boto.cognito.identity.exceptions.LimitExceededException(status, reason, body=None, *args)
exception boto.cognito.identity.exceptions.NotAuthorizedException(status, reason, body=None, *args)
exception boto.cognito.identity.exceptions.ResourceConflictException(status, reason, body=None, *args)
exception boto.cognito.identity.exceptions.ResourceNotFoundException(status, reason, body=None, *args)
exception boto.cognito.identity.exceptions.TooManyRequestsException(status, reason, body=None, *args)