Sample Response
X- AMZ-DATE: 20140805T164904Z
{ "IdentityId": "us-east-1:6820d0d3-3c95-4d9f-8813-c4448fca995f", "Logins":
{
"accounts.google.com": "<PROVIDER_TOKEN>"
},
"LoginsToRemove": ["accounts.google.com"]
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
UntagResource
UntagResource
Removes the specified tags from the specified Amazon Cognito identity pool. You can use this action up to 5 times per second, per account
Request Syntax
{
"ResourceArn": "string", "TagKeys": [ "string" ] }
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 93).
The request accepts the following data in JSON format.
ResourceArn (p. 75)
The Amazon Resource Name (ARN) of the identity pool.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Required: Yes TagKeys (p. 75)
The keys of the tags to remove from the user pool.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 95).
InternalErrorException
Thrown when the service encounters an error during processing the request.
HTTP Status Code: 500 InvalidParameterException
Thrown for missing or bad input parameter(s).
See Also
HTTP Status Code: 400 NotAuthorizedException
Thrown when a user is not authorized to access the requested resource.
HTTP Status Code: 400 ResourceNotFoundException
Thrown when the requested resource (for example, a dataset or record) does not exist.
HTTP Status Code: 400 TooManyRequestsException
Thrown when a request is throttled.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
UpdateIdentityPool
UpdateIdentityPool
Updates an identity pool.
You must use AWS developer credentials to call this operation.
Request Syntax
{
"AllowClassicFlow": boolean,
"AllowUnauthenticatedIdentities": boolean, "CognitoIdentityProviders": [
{
"DeveloperProviderName": "string", "IdentityPoolId": "string",
"IdentityPoolName": "string", "IdentityPoolTags": { "string" : "string"
},
"OpenIdConnectProviderARNs": [ "string" ], "SamlProviderARNs": [ "string" ],
"SupportedLoginProviders": { "string" : "string"
} }
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 93).
The request accepts the following data in JSON format.
AllowClassicFlow (p. 77)
Enables or disables the Basic (Classic) authentication flow. For more information, see Identity Pools (Federated Identities) Authentication Flow in the Amazon Cognito Developer Guide.
Type: Boolean Required: No
AllowUnauthenticatedIdentities (p. 77)
TRUE if the identity pool supports unauthenticated logins.
Type: Boolean Required: Yes
CognitoIdentityProviders (p. 77)
A list representing an Amazon Cognito user pool and its client ID.
Type: Array of CognitoIdentityProvider (p. 85) objects
Request Parameters
Required: No
DeveloperProviderName (p. 77)
The "domain" by which Cognito will refer to your users.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: [\w._-]+
Required: No IdentityPoolId (p. 77)
An identity pool ID in the format REGION:GUID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 55.
Pattern: [\w-]+:[0-9a-f-]+
Required: Yes
IdentityPoolName (p. 77) A string that you provide.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: [\w\s+=,.@-]+
Required: Yes IdentityPoolTags (p. 77)
The tags that are assigned to the identity pool. A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Value Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No
OpenIdConnectProviderARNs (p. 77)
The ARNs of the OpenID Connect providers.
Type: Array of strings
Length Constraints: Minimum length of 20. Maximum length of 2048.
Required: No
SamlProviderARNs (p. 77)
An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.
Type: Array of strings
Response Syntax
Length Constraints: Minimum length of 20. Maximum length of 2048.
Required: No
SupportedLoginProviders (p. 77)
Optional key:value pairs mapping provider names to provider app IDs.
Type: String to string map
Map Entries: Maximum number of 10 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Value Length Constraints: Minimum length of 1. Maximum length of 128.
Value Pattern: [\w.;_/-]+
Required: No
Response Syntax
{ "AllowClassicFlow": boolean,
"AllowUnauthenticatedIdentities": boolean, "CognitoIdentityProviders": [
{
"DeveloperProviderName": "string", "IdentityPoolId": "string",
"IdentityPoolName": "string", "IdentityPoolTags": { "string" : "string"
},
"OpenIdConnectProviderARNs": [ "string" ], "SamlProviderARNs": [ "string" ],
"SupportedLoginProviders": { "string" : "string"
}}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
AllowClassicFlow (p. 79)
Enables or disables the Basic (Classic) authentication flow. For more information, see Identity Pools (Federated Identities) Authentication Flow in the Amazon Cognito Developer Guide.
Type: Boolean
AllowUnauthenticatedIdentities (p. 79)
TRUE if the identity pool supports unauthenticated logins.
Response Elements
Type: Boolean
CognitoIdentityProviders (p. 79)
A list representing an Amazon Cognito user pool and its client ID.
Type: Array of CognitoIdentityProvider (p. 85) objects DeveloperProviderName (p. 79)
The "domain" by which Cognito will refer to your users.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: [\w._-]+
IdentityPoolId (p. 79)
An identity pool ID in the format REGION:GUID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 55.
Pattern: [\w-]+:[0-9a-f-]+
IdentityPoolName (p. 79) A string that you provide.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: [\w\s+=,.@-]+
IdentityPoolTags (p. 79)
The tags that are assigned to the identity pool. A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Value Length Constraints: Minimum length of 0. Maximum length of 256.
OpenIdConnectProviderARNs (p. 79)
The ARNs of the OpenID Connect providers.
Type: Array of strings
Length Constraints: Minimum length of 20. Maximum length of 2048.
SamlProviderARNs (p. 79)
An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.
Type: Array of strings
Length Constraints: Minimum length of 20. Maximum length of 2048.
Errors
SupportedLoginProviders (p. 79)
Optional key:value pairs mapping provider names to provider app IDs.
Type: String to string map
Map Entries: Maximum number of 10 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Value Length Constraints: Minimum length of 1. Maximum length of 128.
Value Pattern: [\w.;_/-]+
Errors
For information about the errors that are common to all actions, see Common Errors (p. 95).
ConcurrentModificationException
Thrown if there are parallel requests to modify a resource.
HTTP Status Code: 400 InternalErrorException
Thrown when the service encounters an error during processing the request.
HTTP Status Code: 500 InvalidParameterException
Thrown for missing or bad input parameter(s).
HTTP Status Code: 400 LimitExceededException
Thrown when the total number of user pools has exceeded a preset limit.
HTTP Status Code: 400 NotAuthorizedException
Thrown when a user is not authorized to access the requested resource.
HTTP Status Code: 400 ResourceConflictException
Thrown when a user tries to use a login which is already linked to another account.
HTTP Status Code: 400 ResourceNotFoundException
Thrown when the requested resource (for example, a dataset or record) does not exist.
HTTP Status Code: 400 TooManyRequestsException
Thrown when a request is throttled.
HTTP Status Code: 400
Examples
Examples
UpdateIdentityPool
The following examples show a request and response for the UpdateIdentityPool action. The request and response bodies have been formatted for readability and may not match the content-length value. Note: For the key "api.twitter.com" and "www.digits.com" the value to be set in the dictionary is a concatenation of the consumer key and consumer secret strings separated by a semicolon.
Sample Request
POST / HTTP/1.1
CONTENT-TYPE: application/json
AUTHORIZATION: AWS4-HMAC-SHA256 Credential=<credential>, SignedHeaders=content-type;content-length;host;x-amz-date;x-amz-target, Signature=<signature>
{
"IdentityPoolId": "us-east-1:c1731993-c776-4ae2-86c6-554aeEXAMPLE", "IdentityPoolName": "MyIdentityPool",
"AllowUnauthenticatedIdentities": true, "SupportedLoginProviders":
{
"www.amazon.com": "amzn1.application-oa2-client.188a56d827a7d6555a8b67a5d", "graph.facebook.com": "7346241598935555",
"accounts.google.com": "123456789012.apps.googleusercontent.com", "api.twitter.com": date: Mon, 04 Aug 2014 23:30:00 GMT
content-type: application/json content-length: 356
{
"AllowUnauthenticatedIdentities": true,
"IdentityPoolId": "us-east-1:c1731993-c776-4ae2-86c6-554aeEXAMPLE", "IdentityPoolName": "MyIdentityPool",
"SupportedLoginProviders":
{
"www.amazon.com": "amzn1.application-oa2-client.188a56d827a7d6555a8b67a5d", "graph.facebook.com": "7346241598935555",
"accounts.google.com": "123456789012.apps.googleusercontent.com", "api.twitter.com":
"xvz1evFS4wEEPTGEFPHBog;kAcSOqF21Fu85e7zjz7ZN2U4ZRhfV3WpwPAoE3Z7kBw", "www.digits.com":
"xvz1evFS4wEEPTGEFPHBog;kAcSOqF21Fu85e7zjz7ZN2U4ZRhfV3WpwPAoE3Z7kBw"