Class AmazonCognitoIdentityClient

  • All Implemented Interfaces:
    AmazonCognitoIdentity
    Direct Known Subclasses:
    AmazonCognitoIdentityAsyncClient

    @ThreadSafe
    public class AmazonCognitoIdentityClient
    extends AmazonWebServiceClient
    implements AmazonCognitoIdentity
    Client for accessing Amazon Cognito Identity. All service calls made using this client are blocking, and will not return until the service call completes.

    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.

    • Field Detail

      • configFactory

        protected static final ClientConfigurationFactory configFactory
        Client configuration factory providing ClientConfigurations tailored to this client
    • Constructor Detail

      • AmazonCognitoIdentityClient

        public AmazonCognitoIdentityClient()
        Constructs a new client to invoke service methods on Amazon Cognito Identity. A credentials provider chain will be used that searches for credentials in this order:
        • Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
        • Java System Properties - aws.accessKeyId and aws.secretKey
        • Instance profile credentials delivered through the Amazon EC2 metadata service

        All service calls made using this new client object are blocking, and will not return until the service call completes.

        See Also:
        DefaultAWSCredentialsProviderChain
      • AmazonCognitoIdentityClient

        public AmazonCognitoIdentityClient​(ClientConfiguration clientConfiguration)
        Constructs a new client to invoke service methods on Amazon Cognito Identity. A credentials provider chain will be used that searches for credentials in this order:
        • Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
        • Java System Properties - aws.accessKeyId and aws.secretKey
        • Instance profile credentials delivered through the Amazon EC2 metadata service

        All service calls made using this new client object are blocking, and will not return until the service call completes.

        Parameters:
        clientConfiguration - The client configuration options controlling how this client connects to Amazon Cognito Identity (ex: proxy settings, retry counts, etc.).
        See Also:
        DefaultAWSCredentialsProviderChain
      • AmazonCognitoIdentityClient

        public AmazonCognitoIdentityClient​(AWSCredentials awsCredentials)
        Constructs a new client to invoke service methods on Amazon Cognito Identity using the specified AWS account credentials.

        All service calls made using this new client object are blocking, and will not return until the service call completes.

        Parameters:
        awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
      • AmazonCognitoIdentityClient

        public AmazonCognitoIdentityClient​(AWSCredentials awsCredentials,
                                           ClientConfiguration clientConfiguration)
        Constructs a new client to invoke service methods on Amazon Cognito Identity using the specified AWS account credentials and client configuration options.

        All service calls made using this new client object are blocking, and will not return until the service call completes.

        Parameters:
        awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
        clientConfiguration - The client configuration options controlling how this client connects to Amazon Cognito Identity (ex: proxy settings, retry counts, etc.).
      • AmazonCognitoIdentityClient

        public AmazonCognitoIdentityClient​(AWSCredentialsProvider awsCredentialsProvider)
        Constructs a new client to invoke service methods on Amazon Cognito Identity using the specified AWS account credentials provider.

        All service calls made using this new client object are blocking, and will not return until the service call completes.

        Parameters:
        awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
      • AmazonCognitoIdentityClient

        public AmazonCognitoIdentityClient​(AWSCredentialsProvider awsCredentialsProvider,
                                           ClientConfiguration clientConfiguration)
        Constructs a new client to invoke service methods on Amazon Cognito Identity using the specified AWS account credentials provider and client configuration options.

        All service calls made using this new client object are blocking, and will not return until the service call completes.

        Parameters:
        awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
        clientConfiguration - The client configuration options controlling how this client connects to Amazon Cognito Identity (ex: proxy settings, retry counts, etc.).
      • AmazonCognitoIdentityClient

        public AmazonCognitoIdentityClient​(AWSCredentialsProvider awsCredentialsProvider,
                                           ClientConfiguration clientConfiguration,
                                           RequestMetricCollector requestMetricCollector)
        Constructs a new client to invoke service methods on Amazon Cognito Identity using the specified AWS account credentials provider, client configuration options, and request metric collector.

        All service calls made using this new client object are blocking, and will not return until the service call completes.

        Parameters:
        awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
        clientConfiguration - The client configuration options controlling how this client connects to Amazon Cognito Identity (ex: proxy settings, retry counts, etc.).
        requestMetricCollector - optional request metric collector
    • Method Detail

      • createIdentityPool

        public CreateIdentityPoolResult createIdentityPool​(CreateIdentityPoolRequest createIdentityPoolRequest)

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

        Specified by:
        createIdentityPool in interface AmazonCognitoIdentity
        Parameters:
        createIdentityPoolRequest - Input to the CreateIdentityPool action.
        Returns:
        Result of the CreateIdentityPool operation returned by the service.
        Throws:
        InvalidParameterException - Thrown for missing or bad input parameter(s).
        NotAuthorizedException - Thrown when a user is not authorized to access the requested resource.
        ResourceConflictException - Thrown when a user tries to use a login which is already linked to another account.
        TooManyRequestsException - Thrown when a request is throttled.
        InternalErrorException - Thrown when the service encounters an error during processing the request.
        LimitExceededException - Thrown when the total number of user pools has exceeded a preset limit.
      • getCredentialsForIdentity

        public GetCredentialsForIdentityResult getCredentialsForIdentity​(GetCredentialsForIdentityRequest getCredentialsForIdentityRequest)

        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.

        Specified by:
        getCredentialsForIdentity in interface AmazonCognitoIdentity
        Parameters:
        getCredentialsForIdentityRequest - Input to the GetCredentialsForIdentity action.
        Returns:
        Result of the GetCredentialsForIdentity operation returned by the service.
        Throws:
        InvalidParameterException - Thrown for missing or bad input parameter(s).
        ResourceNotFoundException - Thrown when the requested resource (for example, a dataset or record) does not exist.
        NotAuthorizedException - Thrown when a user is not authorized to access the requested resource.
        ResourceConflictException - Thrown when a user tries to use a login which is already linked to another account.
        TooManyRequestsException - Thrown when a request is throttled.
        InvalidIdentityPoolConfigurationException - Thrown if the identity pool has no role associated for the given auth type (auth/unauth) or if the AssumeRole fails.
        InternalErrorException - Thrown when the service encounters an error during processing the request.
        ExternalServiceException - An exception thrown when a dependent service such as Facebook or Twitter is not responding
      • getId

        public GetIdResult getId​(GetIdRequest getIdRequest)

        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.

        Specified by:
        getId in interface AmazonCognitoIdentity
        Parameters:
        getIdRequest - Input to the GetId action.
        Returns:
        Result of the GetId operation returned by the service.
        Throws:
        InvalidParameterException - Thrown for missing or bad input parameter(s).
        ResourceNotFoundException - Thrown when the requested resource (for example, a dataset or record) does not exist.
        NotAuthorizedException - Thrown when a user is not authorized to access the requested resource.
        ResourceConflictException - Thrown when a user tries to use a login which is already linked to another account.
        TooManyRequestsException - Thrown when a request is throttled.
        InternalErrorException - Thrown when the service encounters an error during processing the request.
        LimitExceededException - Thrown when the total number of user pools has exceeded a preset limit.
        ExternalServiceException - An exception thrown when a dependent service such as Facebook or Twitter is not responding
      • getOpenIdToken

        public GetOpenIdTokenResult getOpenIdToken​(GetOpenIdTokenRequest getOpenIdTokenRequest)

        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.

        Specified by:
        getOpenIdToken in interface AmazonCognitoIdentity
        Parameters:
        getOpenIdTokenRequest - Input to the GetOpenIdToken action.
        Returns:
        Result of the GetOpenIdToken operation returned by the service.
        Throws:
        InvalidParameterException - Thrown for missing or bad input parameter(s).
        ResourceNotFoundException - Thrown when the requested resource (for example, a dataset or record) does not exist.
        NotAuthorizedException - Thrown when a user is not authorized to access the requested resource.
        ResourceConflictException - Thrown when a user tries to use a login which is already linked to another account.
        TooManyRequestsException - Thrown when a request is throttled.
        InternalErrorException - Thrown when the service encounters an error during processing the request.
        ExternalServiceException - An exception thrown when a dependent service such as Facebook or Twitter is not responding
      • getOpenIdTokenForDeveloperIdentity

        public GetOpenIdTokenForDeveloperIdentityResult getOpenIdTokenForDeveloperIdentity​(GetOpenIdTokenForDeveloperIdentityRequest getOpenIdTokenForDeveloperIdentityRequest)

        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.

        You must use AWS Developer credentials to call this API.

        Specified by:
        getOpenIdTokenForDeveloperIdentity in interface AmazonCognitoIdentity
        Parameters:
        getOpenIdTokenForDeveloperIdentityRequest - Input to the GetOpenIdTokenForDeveloperIdentity action.
        Returns:
        Result of the GetOpenIdTokenForDeveloperIdentity operation returned by the service.
        Throws:
        InvalidParameterException - Thrown for missing or bad input parameter(s).
        ResourceNotFoundException - Thrown when the requested resource (for example, a dataset or record) does not exist.
        NotAuthorizedException - Thrown when a user is not authorized to access the requested resource.
        ResourceConflictException - Thrown when a user tries to use a login which is already linked to another account.
        TooManyRequestsException - Thrown when a request is throttled.
        InternalErrorException - Thrown when the service encounters an error during processing the request.
        DeveloperUserAlreadyRegisteredException - The provided developer user identifier is already registered with Cognito under a different identity ID.
      • lookupDeveloperIdentity

        public LookupDeveloperIdentityResult lookupDeveloperIdentity​(LookupDeveloperIdentityRequest lookupDeveloperIdentityRequest)

        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.

        You must use AWS Developer credentials to call this API.

        Specified by:
        lookupDeveloperIdentity in interface AmazonCognitoIdentity
        Parameters:
        lookupDeveloperIdentityRequest - Input to the LookupDeveloperIdentityInput action.
        Returns:
        Result of the LookupDeveloperIdentity operation returned by the service.
        Throws:
        InvalidParameterException - Thrown for missing or bad input parameter(s).
        ResourceNotFoundException - Thrown when the requested resource (for example, a dataset or record) does not exist.
        NotAuthorizedException - Thrown when a user is not authorized to access the requested resource.
        ResourceConflictException - Thrown when a user tries to use a login which is already linked to another account.
        TooManyRequestsException - Thrown when a request is throttled.
        InternalErrorException - Thrown when the service encounters an error during processing the request.
      • mergeDeveloperIdentities

        public MergeDeveloperIdentitiesResult mergeDeveloperIdentities​(MergeDeveloperIdentitiesRequest mergeDeveloperIdentitiesRequest)

        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.

        You must use AWS Developer credentials to call this API.

        Specified by:
        mergeDeveloperIdentities in interface AmazonCognitoIdentity
        Parameters:
        mergeDeveloperIdentitiesRequest - Input to the MergeDeveloperIdentities action.
        Returns:
        Result of the MergeDeveloperIdentities operation returned by the service.
        Throws:
        InvalidParameterException - Thrown for missing or bad input parameter(s).
        ResourceNotFoundException - Thrown when the requested resource (for example, a dataset or record) does not exist.
        NotAuthorizedException - Thrown when a user is not authorized to access the requested resource.
        ResourceConflictException - Thrown when a user tries to use a login which is already linked to another account.
        TooManyRequestsException - Thrown when a request is throttled.
        InternalErrorException - Thrown when the service encounters an error during processing the request.
      • setIdentityPoolRoles

        public SetIdentityPoolRolesResult setIdentityPoolRoles​(SetIdentityPoolRolesRequest setIdentityPoolRolesRequest)

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

        You must use AWS Developer credentials to call this API.

        Specified by:
        setIdentityPoolRoles in interface AmazonCognitoIdentity
        Parameters:
        setIdentityPoolRolesRequest - Input to the SetIdentityPoolRoles action.
        Returns:
        Result of the SetIdentityPoolRoles operation returned by the service.
        Throws:
        InvalidParameterException - Thrown for missing or bad input parameter(s).
        ResourceNotFoundException - Thrown when the requested resource (for example, a dataset or record) does not exist.
        NotAuthorizedException - Thrown when a user is not authorized to access the requested resource.
        ResourceConflictException - Thrown when a user tries to use a login which is already linked to another account.
        TooManyRequestsException - Thrown when a request is throttled.
        InternalErrorException - Thrown when the service encounters an error during processing the request.
        ConcurrentModificationException - Thrown if there are parallel requests to modify a resource.
      • unlinkDeveloperIdentity

        public UnlinkDeveloperIdentityResult unlinkDeveloperIdentity​(UnlinkDeveloperIdentityRequest unlinkDeveloperIdentityRequest)

        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.

        You must use AWS Developer credentials to call this API.

        Specified by:
        unlinkDeveloperIdentity in interface AmazonCognitoIdentity
        Parameters:
        unlinkDeveloperIdentityRequest - Input to the UnlinkDeveloperIdentity action.
        Returns:
        Result of the UnlinkDeveloperIdentity operation returned by the service.
        Throws:
        InvalidParameterException - Thrown for missing or bad input parameter(s).
        ResourceNotFoundException - Thrown when the requested resource (for example, a dataset or record) does not exist.
        NotAuthorizedException - Thrown when a user is not authorized to access the requested resource.
        ResourceConflictException - Thrown when a user tries to use a login which is already linked to another account.
        TooManyRequestsException - Thrown when a request is throttled.
        InternalErrorException - Thrown when the service encounters an error during processing the request.
      • unlinkIdentity

        public UnlinkIdentityResult unlinkIdentity​(UnlinkIdentityRequest unlinkIdentityRequest)

        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.

        Specified by:
        unlinkIdentity in interface AmazonCognitoIdentity
        Parameters:
        unlinkIdentityRequest - Input to the UnlinkIdentity action.
        Returns:
        Result of the UnlinkIdentity operation returned by the service.
        Throws:
        InvalidParameterException - Thrown for missing or bad input parameter(s).
        ResourceNotFoundException - Thrown when the requested resource (for example, a dataset or record) does not exist.
        NotAuthorizedException - Thrown when a user is not authorized to access the requested resource.
        ResourceConflictException - Thrown when a user tries to use a login which is already linked to another account.
        TooManyRequestsException - Thrown when a request is throttled.
        InternalErrorException - Thrown when the service encounters an error during processing the request.
        ExternalServiceException - An exception thrown when a dependent service such as Facebook or Twitter is not responding
      • getCachedResponseMetadata

        public ResponseMetadata getCachedResponseMetadata​(AmazonWebServiceRequest request)
        Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

        Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

        Specified by:
        getCachedResponseMetadata in interface AmazonCognitoIdentity
        Parameters:
        request - The originally executed request
        Returns:
        The response metadata for the specified request, or null if none is available.