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": "Deletes a user pool. Once a pool is deleted, users will not be able to authenticate with the pool.
", "DescribeIdentity": "Returns metadata related to the given identity, including when the identity was created and any associated linked logins.
", "DescribeIdentityPool": "Gets details about a particular identity pool, including the pool name, ID description, creation date, and current number of users.
", "GetCredentialsForIdentity": "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": "Generates (or retrieves) a Cognito ID. Supplying multiple logins will create an implicit linked account.
", "GetIdentityPoolRoles": "Gets the roles for an identity pool.
", "GetOpenIdToken": "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": "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.
Lists the identities in a pool.
", "ListIdentityPools": "Lists all of the Cognito identity pools registered for your account.
", "LookupDeveloperIdentity": "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.
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.
Sets the roles for an identity pool. These roles are used when making calls to GetCredentialsForIdentity action.
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.
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": "Updates a user pool.
" }, "service": "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.
", "shapes": { "ARNString": { "base": null, "refs": { "OIDCProviderList$member": null, "RolesMap$value": null } }, "AccessKeyString": { "base": null, "refs": { "Credentials$AccessKeyId": "The Access Key portion of the credentials.
" } }, "AccountId": { "base": null, "refs": { "GetIdInput$AccountId": "A standard AWS account ID (9+ digits)." } }, "CreateIdentityPoolInput": { "base": "Input to the CreateIdentityPool action.
", "refs": { } }, "Credentials": { "base": "Credentials for the the provided identity ID.
", "refs": { "GetCredentialsForIdentityResponse$Credentials": "Credentials for the the provided identity ID.
" } }, "DateType": { "base": null, "refs": { "Credentials$Expiration": "The date at which these credentials will expire.
", "IdentityDescription$CreationDate": "Date on which the identity was created.
", "IdentityDescription$LastModifiedDate": "Date on which the identity was last modified.
" } }, "DeleteIdentityPoolInput": { "base": "Input to the DeleteIdentityPool action.
", "refs": { } }, "DescribeIdentityInput": { "base": "Input to the DescribeIdentity action.
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.
", "IdentityPool$DeveloperProviderName": "The \"domain\" by which Cognito will refer to your users.
", "MergeDeveloperIdentitiesInput$DeveloperProviderName": "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 (-).
The \"domain\" by which Cognito will refer to your users.
" } }, "DeveloperUserAlreadyRegisteredException": { "base": "The provided developer user identifier is already registered with Cognito under a different identity ID.
", "refs": { } }, "DeveloperUserIdentifier": { "base": null, "refs": { "DeveloperUserIdentifierList$member": null, "LookupDeveloperIdentityInput$DeveloperUserIdentifier": "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.
", "MergeDeveloperIdentitiesInput$SourceUserIdentifier": "User identifier for the source user. The value should be a DeveloperUserIdentifier.
User identifier for the destination user. The value should be a DeveloperUserIdentifier.
This is the list of developer user identifiers associated with an identity ID. Cognito supports the association of multiple developer user identifiers with an identity ID.
" } }, "GetCredentialsForIdentityInput": { "base": "Input to the GetCredentialsForIdentity action.
Returned in response to a successful GetCredentialsForIdentity operation.
Input to the GetIdentityPoolRoles action.
Returned in response to a successful GetIdentityPoolRoles operation.
Input to the GetOpenIdTokenForDeveloperIdentity action.
Returned in response to a successful GetOpenIdTokenForDeveloperIdentity request.
A unique identifier in the format REGION:GUID.
", "GetCredentialsForIdentityInput$IdentityId": "A unique identifier in the format REGION:GUID.
", "GetCredentialsForIdentityResponse$IdentityId": "A unique identifier in the format REGION:GUID.
", "GetIdResponse$IdentityId": "A unique identifier in the format REGION:GUID.", "GetOpenIdTokenForDeveloperIdentityInput$IdentityId": "A unique identifier in the format REGION:GUID.
", "GetOpenIdTokenForDeveloperIdentityResponse$IdentityId": "A unique identifier in the format REGION:GUID.
", "GetOpenIdTokenInput$IdentityId": "A unique identifier in the format REGION:GUID.", "GetOpenIdTokenResponse$IdentityId": "A unique identifier in the format REGION:GUID. Note that the IdentityId returned may not match the one passed on input.", "IdentityDescription$IdentityId": "A unique identifier in the format REGION:GUID.", "LookupDeveloperIdentityInput$IdentityId": "A unique identifier in the format REGION:GUID.
", "LookupDeveloperIdentityResponse$IdentityId": "A unique identifier in the format REGION:GUID.
", "MergeDeveloperIdentitiesResponse$IdentityId": "A unique identifier in the format REGION:GUID.
", "UnlinkDeveloperIdentityInput$IdentityId": "A unique identifier in the format REGION:GUID.
", "UnlinkIdentityInput$IdentityId": "A unique identifier in the format REGION:GUID." } }, "IdentityPool": { "base": "An object representing a Cognito identity pool.", "refs": { } }, "IdentityPoolId": { "base": null, "refs": { "DeleteIdentityPoolInput$IdentityPoolId": "An identity pool ID in the format REGION:GUID.", "DescribeIdentityPoolInput$IdentityPoolId": "An identity pool ID in the format REGION:GUID.", "GetIdInput$IdentityPoolId": "An identity pool ID in the format REGION:GUID.", "GetIdentityPoolRolesInput$IdentityPoolId": "An identity pool ID in the format REGION:GUID.
", "GetIdentityPoolRolesResponse$IdentityPoolId": "An identity pool ID in the format REGION:GUID.
", "GetOpenIdTokenForDeveloperIdentityInput$IdentityPoolId": "An identity pool ID in the format REGION:GUID.
", "IdentityPool$IdentityPoolId": "An identity pool ID in the format REGION:GUID.", "IdentityPoolShortDescription$IdentityPoolId": "An identity pool ID in the format REGION:GUID.", "ListIdentitiesInput$IdentityPoolId": "An identity pool ID in the format REGION:GUID.", "ListIdentitiesResponse$IdentityPoolId": "An identity pool ID in the format REGION:GUID.", "LookupDeveloperIdentityInput$IdentityPoolId": "An identity pool ID in the format REGION:GUID.
", "MergeDeveloperIdentitiesInput$IdentityPoolId": "An identity pool ID in the format REGION:GUID.
", "SetIdentityPoolRolesInput$IdentityPoolId": "An identity pool ID in the format REGION:GUID.
", "UnlinkDeveloperIdentityInput$IdentityPoolId": "An identity pool ID in the format REGION:GUID.
" } }, "IdentityPoolName": { "base": null, "refs": { "CreateIdentityPoolInput$IdentityPoolName": "A string that you provide.
", "IdentityPool$IdentityPoolName": "A string that you provide.
", "IdentityPoolShortDescription$IdentityPoolName": "A string that you provide." } }, "IdentityPoolShortDescription": { "base": "A description of the identity pool.", "refs": { "IdentityPoolsList$member": null } }, "IdentityPoolUnauthenticated": { "base": null, "refs": { "CreateIdentityPoolInput$AllowUnauthenticatedIdentities": "TRUE if the identity pool supports unauthenticated logins.
", "IdentityPool$AllowUnauthenticatedIdentities": "TRUE if the identity pool supports unauthenticated logins." } }, "IdentityPoolsList": { "base": null, "refs": { "ListIdentityPoolsResponse$IdentityPools": "The identity pools returned by the ListIdentityPools action." } }, "IdentityProviderId": { "base": null, "refs": { "IdentityProviders$value": null } }, "IdentityProviderName": { "base": null, "refs": { "IdentityProviders$key": null, "LoginsList$member": null, "LoginsMap$key": null } }, "IdentityProviderToken": { "base": null, "refs": { "LoginsMap$value": null } }, "IdentityProviders": { "base": null, "refs": { "CreateIdentityPoolInput$SupportedLoginProviders": "Optional key:value pairs mapping provider names to provider app IDs.
", "IdentityPool$SupportedLoginProviders": "Optional key:value pairs mapping provider names to provider app IDs.
" } }, "InternalErrorException": { "base": "Thrown when the service encounters an error during processing the request.", "refs": { } }, "InvalidIdentityPoolConfigurationException": { "base": "Thrown if the identity pool has no role associated for the given auth type (auth/unauth) or if the AssumeRole fails.
", "refs": { } }, "InvalidParameterException": { "base": "Thrown for missing or bad input parameter(s).", "refs": { } }, "LimitExceededException": { "base": "Thrown when the total number of user pools has exceeded a preset limit.", "refs": { } }, "ListIdentitiesInput": { "base": "Input to the ListIdentities action.", "refs": { } }, "ListIdentitiesResponse": { "base": "The response to a ListIdentities request.", "refs": { } }, "ListIdentityPoolsInput": { "base": "Input to the ListIdentityPools action.", "refs": { } }, "ListIdentityPoolsResponse": { "base": "The result of a successful ListIdentityPools action.", "refs": { } }, "LoginsList": { "base": null, "refs": { "IdentityDescription$Logins": "A set of optional name-value pairs that map provider names to provider tokens.", "UnlinkIdentityInput$LoginsToRemove": "Provider names to unlink from this identity." } }, "LoginsMap": { "base": null, "refs": { "GetCredentialsForIdentityInput$Logins": "A set of optional name-value pairs that map provider names to provider tokens.
", "GetIdInput$Logins": "A set of optional name-value pairs that map provider names to provider tokens.
The available provider names for Logins are as follows:
graph.facebook.com accounts.google.com www.amazon.com 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.
Input to the LookupDeveloperIdentityInput action.
Returned in response to a successful LookupDeveloperIdentity action.
Input to the MergeDeveloperIdentities action.
Returned in response to a successful MergeDeveloperIdentities action.
A list of OpendID Connect provider ARNs.
", "IdentityPool$OpenIdConnectProviderARNs": "A list of OpendID Connect provider ARNs.
" } }, "OIDCToken": { "base": null, "refs": { "GetOpenIdTokenForDeveloperIdentityResponse$Token": "An OpenID token.
", "GetOpenIdTokenResponse$Token": "An OpenID token, valid for 15 minutes." } }, "PaginationKey": { "base": null, "refs": { "ListIdentitiesInput$NextToken": "A pagination token.", "ListIdentitiesResponse$NextToken": "A pagination token.", "ListIdentityPoolsInput$NextToken": "A pagination token.", "ListIdentityPoolsResponse$NextToken": "A pagination token.", "LookupDeveloperIdentityInput$NextToken": "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.
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.
The maximum number of identities to return.
" } }, "ResourceConflictException": { "base": "Thrown when a user tries to use a login which is already linked to another account.", "refs": { } }, "ResourceNotFoundException": { "base": "Thrown when the requested resource (for example, a dataset or record) does not exist.", "refs": { } }, "RoleType": { "base": null, "refs": { "RolesMap$key": null } }, "RolesMap": { "base": null, "refs": { "GetIdentityPoolRolesResponse$Roles": "The map of roles associated with this pool. Currently only authenticated and unauthenticated roles are supported.
", "SetIdentityPoolRolesInput$Roles": "The map of roles associated with this pool. Currently only authenticated and unauthenticated roles are supported.
" } }, "SecretKeyString": { "base": null, "refs": { "Credentials$SecretKey": "The Secret Access Key portion of the credentials
" } }, "SessionTokenString": { "base": null, "refs": { "Credentials$SessionToken": "The Session Token portion of the credentials
" } }, "SetIdentityPoolRolesInput": { "base": "Input to the SetIdentityPoolRoles action.
This developer user identifier is already registered with Cognito.
", "InternalErrorException$message": "The message returned by an InternalErrorException.", "InvalidIdentityPoolConfigurationException$message": "The message returned for an InvalidIdentityPoolConfigurationException
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.
" } }, "TooManyRequestsException": { "base": "Thrown when a request is throttled.", "refs": { } }, "UnlinkDeveloperIdentityInput": { "base": "Input to the UnlinkDeveloperIdentity action.