Class AbstractAmazonCognitoIdentityAsync

    • Constructor Detail

      • AbstractAmazonCognitoIdentityAsync

        protected AbstractAmazonCognitoIdentityAsync()
    • Method Detail

      • createIdentityPoolAsync

        public Future<CreateIdentityPoolResult> createIdentityPoolAsync​(CreateIdentityPoolRequest request)
        Description copied from interface: AmazonCognitoIdentityAsync

        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:
        createIdentityPoolAsync in interface AmazonCognitoIdentityAsync
        Parameters:
        request - Input to the CreateIdentityPool action.
        Returns:
        A Java Future containing the result of the CreateIdentityPool operation returned by the service.
      • createIdentityPoolAsync

        public Future<CreateIdentityPoolResult> createIdentityPoolAsync​(CreateIdentityPoolRequest request,
                                                                        AsyncHandler<CreateIdentityPoolRequest,​CreateIdentityPoolResult> asyncHandler)
        Description copied from interface: AmazonCognitoIdentityAsync

        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:
        createIdentityPoolAsync in interface AmazonCognitoIdentityAsync
        Parameters:
        request - Input to the CreateIdentityPool action.
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the CreateIdentityPool operation returned by the service.
      • deleteIdentitiesAsync

        public Future<DeleteIdentitiesResult> deleteIdentitiesAsync​(DeleteIdentitiesRequest request,
                                                                    AsyncHandler<DeleteIdentitiesRequest,​DeleteIdentitiesResult> asyncHandler)
        Description copied from interface: AmazonCognitoIdentityAsync

        Deletes identities from an identity pool. You can specify a list of 1-60 identities that you want to delete.

        You must use AWS Developer credentials to call this API.

        Specified by:
        deleteIdentitiesAsync in interface AmazonCognitoIdentityAsync
        Parameters:
        request - Input to the DeleteIdentities action.
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the DeleteIdentities operation returned by the service.
      • describeIdentityAsync

        public Future<DescribeIdentityResult> describeIdentityAsync​(DescribeIdentityRequest request,
                                                                    AsyncHandler<DescribeIdentityRequest,​DescribeIdentityResult> asyncHandler)
        Description copied from interface: AmazonCognitoIdentityAsync

        Returns metadata related to the given identity, including when the identity was created and any associated linked logins.

        You must use AWS Developer credentials to call this API.

        Specified by:
        describeIdentityAsync in interface AmazonCognitoIdentityAsync
        Parameters:
        request - Input to the DescribeIdentity action.
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the DescribeIdentity operation returned by the service.
      • getCredentialsForIdentityAsync

        public Future<GetCredentialsForIdentityResult> getCredentialsForIdentityAsync​(GetCredentialsForIdentityRequest request)
        Description copied from interface: AmazonCognitoIdentityAsync

        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:
        getCredentialsForIdentityAsync in interface AmazonCognitoIdentityAsync
        Parameters:
        request - Input to the GetCredentialsForIdentity action.
        Returns:
        A Java Future containing the result of the GetCredentialsForIdentity operation returned by the service.
      • getCredentialsForIdentityAsync

        public Future<GetCredentialsForIdentityResult> getCredentialsForIdentityAsync​(GetCredentialsForIdentityRequest request,
                                                                                      AsyncHandler<GetCredentialsForIdentityRequest,​GetCredentialsForIdentityResult> asyncHandler)
        Description copied from interface: AmazonCognitoIdentityAsync

        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:
        getCredentialsForIdentityAsync in interface AmazonCognitoIdentityAsync
        Parameters:
        request - Input to the GetCredentialsForIdentity action.
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the GetCredentialsForIdentity operation returned by the service.
      • getIdAsync

        public Future<GetIdResult> getIdAsync​(GetIdRequest request)
        Description copied from interface: AmazonCognitoIdentityAsync

        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:
        getIdAsync in interface AmazonCognitoIdentityAsync
        Parameters:
        request - Input to the GetId action.
        Returns:
        A Java Future containing the result of the GetId operation returned by the service.
      • getIdAsync

        public Future<GetIdResult> getIdAsync​(GetIdRequest request,
                                              AsyncHandler<GetIdRequest,​GetIdResult> asyncHandler)
        Description copied from interface: AmazonCognitoIdentityAsync

        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:
        getIdAsync in interface AmazonCognitoIdentityAsync
        Parameters:
        request - Input to the GetId action.
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the GetId operation returned by the service.
      • getOpenIdTokenAsync

        public Future<GetOpenIdTokenResult> getOpenIdTokenAsync​(GetOpenIdTokenRequest request)
        Description copied from interface: AmazonCognitoIdentityAsync

        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:
        getOpenIdTokenAsync in interface AmazonCognitoIdentityAsync
        Parameters:
        request - Input to the GetOpenIdToken action.
        Returns:
        A Java Future containing the result of the GetOpenIdToken operation returned by the service.
      • getOpenIdTokenAsync

        public Future<GetOpenIdTokenResult> getOpenIdTokenAsync​(GetOpenIdTokenRequest request,
                                                                AsyncHandler<GetOpenIdTokenRequest,​GetOpenIdTokenResult> asyncHandler)
        Description copied from interface: AmazonCognitoIdentityAsync

        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:
        getOpenIdTokenAsync in interface AmazonCognitoIdentityAsync
        Parameters:
        request - Input to the GetOpenIdToken action.
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the GetOpenIdToken operation returned by the service.
      • getOpenIdTokenForDeveloperIdentityAsync

        public Future<GetOpenIdTokenForDeveloperIdentityResult> getOpenIdTokenForDeveloperIdentityAsync​(GetOpenIdTokenForDeveloperIdentityRequest request)
        Description copied from interface: AmazonCognitoIdentityAsync

        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:
        getOpenIdTokenForDeveloperIdentityAsync in interface AmazonCognitoIdentityAsync
        Parameters:
        request - Input to the GetOpenIdTokenForDeveloperIdentity action.
        Returns:
        A Java Future containing the result of the GetOpenIdTokenForDeveloperIdentity operation returned by the service.
      • getOpenIdTokenForDeveloperIdentityAsync

        public Future<GetOpenIdTokenForDeveloperIdentityResult> getOpenIdTokenForDeveloperIdentityAsync​(GetOpenIdTokenForDeveloperIdentityRequest request,
                                                                                                        AsyncHandler<GetOpenIdTokenForDeveloperIdentityRequest,​GetOpenIdTokenForDeveloperIdentityResult> asyncHandler)
        Description copied from interface: AmazonCognitoIdentityAsync

        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:
        getOpenIdTokenForDeveloperIdentityAsync in interface AmazonCognitoIdentityAsync
        Parameters:
        request - Input to the GetOpenIdTokenForDeveloperIdentity action.
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the GetOpenIdTokenForDeveloperIdentity operation returned by the service.
      • lookupDeveloperIdentityAsync

        public Future<LookupDeveloperIdentityResult> lookupDeveloperIdentityAsync​(LookupDeveloperIdentityRequest request)
        Description copied from interface: AmazonCognitoIdentityAsync

        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:
        lookupDeveloperIdentityAsync in interface AmazonCognitoIdentityAsync
        Parameters:
        request - Input to the LookupDeveloperIdentityInput action.
        Returns:
        A Java Future containing the result of the LookupDeveloperIdentity operation returned by the service.
      • lookupDeveloperIdentityAsync

        public Future<LookupDeveloperIdentityResult> lookupDeveloperIdentityAsync​(LookupDeveloperIdentityRequest request,
                                                                                  AsyncHandler<LookupDeveloperIdentityRequest,​LookupDeveloperIdentityResult> asyncHandler)
        Description copied from interface: AmazonCognitoIdentityAsync

        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:
        lookupDeveloperIdentityAsync in interface AmazonCognitoIdentityAsync
        Parameters:
        request - Input to the LookupDeveloperIdentityInput action.
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the LookupDeveloperIdentity operation returned by the service.
      • mergeDeveloperIdentitiesAsync

        public Future<MergeDeveloperIdentitiesResult> mergeDeveloperIdentitiesAsync​(MergeDeveloperIdentitiesRequest request)
        Description copied from interface: AmazonCognitoIdentityAsync

        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:
        mergeDeveloperIdentitiesAsync in interface AmazonCognitoIdentityAsync
        Parameters:
        request - Input to the MergeDeveloperIdentities action.
        Returns:
        A Java Future containing the result of the MergeDeveloperIdentities operation returned by the service.
      • mergeDeveloperIdentitiesAsync

        public Future<MergeDeveloperIdentitiesResult> mergeDeveloperIdentitiesAsync​(MergeDeveloperIdentitiesRequest request,
                                                                                    AsyncHandler<MergeDeveloperIdentitiesRequest,​MergeDeveloperIdentitiesResult> asyncHandler)
        Description copied from interface: AmazonCognitoIdentityAsync

        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:
        mergeDeveloperIdentitiesAsync in interface AmazonCognitoIdentityAsync
        Parameters:
        request - Input to the MergeDeveloperIdentities action.
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the MergeDeveloperIdentities operation returned by the service.
      • unlinkDeveloperIdentityAsync

        public Future<UnlinkDeveloperIdentityResult> unlinkDeveloperIdentityAsync​(UnlinkDeveloperIdentityRequest request)
        Description copied from interface: AmazonCognitoIdentityAsync

        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:
        unlinkDeveloperIdentityAsync in interface AmazonCognitoIdentityAsync
        Parameters:
        request - Input to the UnlinkDeveloperIdentity action.
        Returns:
        A Java Future containing the result of the UnlinkDeveloperIdentity operation returned by the service.
      • unlinkDeveloperIdentityAsync

        public Future<UnlinkDeveloperIdentityResult> unlinkDeveloperIdentityAsync​(UnlinkDeveloperIdentityRequest request,
                                                                                  AsyncHandler<UnlinkDeveloperIdentityRequest,​UnlinkDeveloperIdentityResult> asyncHandler)
        Description copied from interface: AmazonCognitoIdentityAsync

        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:
        unlinkDeveloperIdentityAsync in interface AmazonCognitoIdentityAsync
        Parameters:
        request - Input to the UnlinkDeveloperIdentity action.
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the UnlinkDeveloperIdentity operation returned by the service.
      • unlinkIdentityAsync

        public Future<UnlinkIdentityResult> unlinkIdentityAsync​(UnlinkIdentityRequest request)
        Description copied from interface: AmazonCognitoIdentityAsync

        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:
        unlinkIdentityAsync in interface AmazonCognitoIdentityAsync
        Parameters:
        request - Input to the UnlinkIdentity action.
        Returns:
        A Java Future containing the result of the UnlinkIdentity operation returned by the service.
      • unlinkIdentityAsync

        public Future<UnlinkIdentityResult> unlinkIdentityAsync​(UnlinkIdentityRequest request,
                                                                AsyncHandler<UnlinkIdentityRequest,​UnlinkIdentityResult> asyncHandler)
        Description copied from interface: AmazonCognitoIdentityAsync

        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:
        unlinkIdentityAsync in interface AmazonCognitoIdentityAsync
        Parameters:
        request - Input to the UnlinkIdentity action.
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the UnlinkIdentity operation returned by the service.