2014/10/23 - Amazon Cognito Identity - 3 updated api methods
{'OpenIdConnectProviderARNs': ['string']}
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.
Request Syntax
client.create_identity_pool( IdentityPoolName='string', AllowUnauthenticatedIdentities=True|False, SupportedLoginProviders={ 'string': 'string' }, DeveloperProviderName='string', OpenIdConnectProviderARNs=[ 'string', ] )
string
[REQUIRED]
A string that you provide.
boolean
[REQUIRED]
TRUE if the identity pool supports unauthenticated logins.
dict
Optional key:value pairs mapping provider names to provider app IDs.
(string) --
(string) --
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.
list
(string) --
dict
Response Syntax
{ 'IdentityPoolId': 'string', 'IdentityPoolName': 'string', 'AllowUnauthenticatedIdentities': True|False, 'SupportedLoginProviders': { 'string': 'string' }, 'DeveloperProviderName': 'string', 'OpenIdConnectProviderARNs': [ 'string', ] }
Response Structure
(dict) -- An object representing a Cognito identity pool.
IdentityPoolId (string) -- An identity pool ID in the format REGION:GUID.
IdentityPoolName (string) --
A string that you provide.
AllowUnauthenticatedIdentities (boolean) -- TRUE if the identity pool supports unauthenticated logins.
SupportedLoginProviders (dict) --
Optional key:value pairs mapping provider names to provider app IDs.
(string) --
(string) --
DeveloperProviderName (string) --
The "domain" by which Cognito will refer to your users.
OpenIdConnectProviderARNs (list) --
(string) --
{'OpenIdConnectProviderARNs': ['string']}
Gets details about a particular identity pool, including the pool name, ID description, creation date, and current number of users.
Request Syntax
client.describe_identity_pool( IdentityPoolId='string' )
string
[REQUIRED] An identity pool ID in the format REGION:GUID.
dict
Response Syntax
{ 'IdentityPoolId': 'string', 'IdentityPoolName': 'string', 'AllowUnauthenticatedIdentities': True|False, 'SupportedLoginProviders': { 'string': 'string' }, 'DeveloperProviderName': 'string', 'OpenIdConnectProviderARNs': [ 'string', ] }
Response Structure
(dict) -- An object representing a Cognito identity pool.
IdentityPoolId (string) -- An identity pool ID in the format REGION:GUID.
IdentityPoolName (string) --
A string that you provide.
AllowUnauthenticatedIdentities (boolean) -- TRUE if the identity pool supports unauthenticated logins.
SupportedLoginProviders (dict) --
Optional key:value pairs mapping provider names to provider app IDs.
(string) --
(string) --
DeveloperProviderName (string) --
The "domain" by which Cognito will refer to your users.
OpenIdConnectProviderARNs (list) --
(string) --
{'OpenIdConnectProviderARNs': ['string']}
Updates a user pool.
Request Syntax
client.update_identity_pool( IdentityPoolId='string', IdentityPoolName='string', AllowUnauthenticatedIdentities=True|False, SupportedLoginProviders={ 'string': 'string' }, DeveloperProviderName='string', OpenIdConnectProviderARNs=[ 'string', ] )
string
[REQUIRED] An identity pool ID in the format REGION:GUID.
string
[REQUIRED]
A string that you provide.
boolean
[REQUIRED] TRUE if the identity pool supports unauthenticated logins.
dict
Optional key:value pairs mapping provider names to provider app IDs.
(string) --
(string) --
string
The "domain" by which Cognito will refer to your users.
list
(string) --
dict
Response Syntax
{ 'IdentityPoolId': 'string', 'IdentityPoolName': 'string', 'AllowUnauthenticatedIdentities': True|False, 'SupportedLoginProviders': { 'string': 'string' }, 'DeveloperProviderName': 'string', 'OpenIdConnectProviderARNs': [ 'string', ] }
Response Structure
(dict) -- An object representing a Cognito identity pool.
IdentityPoolId (string) -- An identity pool ID in the format REGION:GUID.
IdentityPoolName (string) --
A string that you provide.
AllowUnauthenticatedIdentities (boolean) -- TRUE if the identity pool supports unauthenticated logins.
SupportedLoginProviders (dict) --
Optional key:value pairs mapping provider names to provider app IDs.
(string) --
(string) --
DeveloperProviderName (string) --
The "domain" by which Cognito will refer to your users.
OpenIdConnectProviderARNs (list) --
(string) --