Class AbstractAmazonCognitoIdentity

java.lang.Object
com.amazonaws.services.cognitoidentity.AbstractAmazonCognitoIdentity
All Implemented Interfaces:
AmazonCognitoIdentity
Direct Known Subclasses:
AbstractAmazonCognitoIdentityAsync
public class AbstractAmazonCognitoIdentity extends Object implements AmazonCognitoIdentity
Abstract implementation of AmazonCognitoIdentity. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

  • Constructor Details

    • AbstractAmazonCognitoIdentity

      protected AbstractAmazonCognitoIdentity()

  • Method Details

    • setEndpoint

      public void setEndpoint(String endpoint)
      Description copied from interface: AmazonCognitoIdentity
      Overrides the default endpoint for this client ("https://cognito-identity.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.

      Callers can pass in just the endpoint (ex: "cognito-identity.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://cognito-identity.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

      For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912

      This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

      Specified by:
      setEndpoint in interface AmazonCognitoIdentity
      Parameters:
      endpoint - The endpoint (ex: "cognito-identity.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://cognito-identity.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.

    • setRegion

      public void setRegion(Region region)
      Description copied from interface: AmazonCognitoIdentity
      An alternative to AmazonCognitoIdentity.setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.

      By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.

      This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

      Specified by:
      setRegion in interface AmazonCognitoIdentity
      Parameters:
      region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.
      See Also:

    • createIdentityPool

      public CreateIdentityPoolResult createIdentityPool(CreateIdentityPoolRequest request)
      Description copied from interface: AmazonCognitoIdentity

      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:
      request - Input to the CreateIdentityPool action.
      Returns:
      Result of the CreateIdentityPool operation returned by the service.

    • deleteIdentities

      public DeleteIdentitiesResult deleteIdentities(DeleteIdentitiesRequest request)
      Description copied from interface: AmazonCognitoIdentity

      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:
      deleteIdentities in interface AmazonCognitoIdentity
      Parameters:
      request - Input to the DeleteIdentities action.
      Returns:
      Result of the DeleteIdentities operation returned by the service.

    • deleteIdentityPool

      public DeleteIdentityPoolResult deleteIdentityPool(DeleteIdentityPoolRequest request)
      Description copied from interface: AmazonCognitoIdentity

      Deletes a user pool. Once a pool is deleted, users will not be able to authenticate with the pool.

      You must use AWS Developer credentials to call this API.

      Specified by:
      deleteIdentityPool in interface AmazonCognitoIdentity
      Parameters:
      request - Input to the DeleteIdentityPool action.
      Returns:
      Result of the DeleteIdentityPool operation returned by the service.

    • describeIdentity

      public DescribeIdentityResult describeIdentity(DescribeIdentityRequest request)
      Description copied from interface: AmazonCognitoIdentity

      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:
      describeIdentity in interface AmazonCognitoIdentity
      Parameters:
      request - Input to the DescribeIdentity action.
      Returns:
      Result of the DescribeIdentity operation returned by the service.

    • describeIdentityPool

      public DescribeIdentityPoolResult describeIdentityPool(DescribeIdentityPoolRequest request)
      Description copied from interface: AmazonCognitoIdentity

      Gets details about a particular identity pool, including the pool name, ID description, creation date, and current number of users.

      You must use AWS Developer credentials to call this API.

      Specified by:
      describeIdentityPool in interface AmazonCognitoIdentity
      Parameters:
      request - Input to the DescribeIdentityPool action.
      Returns:
      Result of the DescribeIdentityPool operation returned by the service.

    • getCredentialsForIdentity

      public GetCredentialsForIdentityResult getCredentialsForIdentity(GetCredentialsForIdentityRequest request)
      Description copied from interface: AmazonCognitoIdentity

      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:
      request - Input to the GetCredentialsForIdentity action.
      Returns:
      Result of the GetCredentialsForIdentity operation returned by the service.

    • getId

      public GetIdResult getId(GetIdRequest request)
      Description copied from interface: AmazonCognitoIdentity

      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:
      request - Input to the GetId action.
      Returns:
      Result of the GetId operation returned by the service.

    • getIdentityPoolRoles

      public GetIdentityPoolRolesResult getIdentityPoolRoles(GetIdentityPoolRolesRequest request)
      Description copied from interface: AmazonCognitoIdentity

      Gets the roles for an identity pool.

      You must use AWS Developer credentials to call this API.

      Specified by:
      getIdentityPoolRoles in interface AmazonCognitoIdentity
      Parameters:
      request - Input to the GetIdentityPoolRoles action.
      Returns:
      Result of the GetIdentityPoolRoles operation returned by the service.

    • getOpenIdToken

      public GetOpenIdTokenResult getOpenIdToken(GetOpenIdTokenRequest request)
      Description copied from interface: AmazonCognitoIdentity

      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:
      request - Input to the GetOpenIdToken action.
      Returns:
      Result of the GetOpenIdToken operation returned by the service.

    • getOpenIdTokenForDeveloperIdentity

      public GetOpenIdTokenForDeveloperIdentityResult getOpenIdTokenForDeveloperIdentity(GetOpenIdTokenForDeveloperIdentityRequest request)
      Description copied from interface: AmazonCognitoIdentity

      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:
      request - Input to the GetOpenIdTokenForDeveloperIdentity action.
      Returns:
      Result of the GetOpenIdTokenForDeveloperIdentity operation returned by the service.

    • listIdentities

      public ListIdentitiesResult listIdentities(ListIdentitiesRequest request)
      Description copied from interface: AmazonCognitoIdentity

      Lists the identities in a pool.

      You must use AWS Developer credentials to call this API.

      Specified by:
      listIdentities in interface AmazonCognitoIdentity
      Parameters:
      request - Input to the ListIdentities action.
      Returns:
      Result of the ListIdentities operation returned by the service.

    • listIdentityPools

      public ListIdentityPoolsResult listIdentityPools(ListIdentityPoolsRequest request)
      Description copied from interface: AmazonCognitoIdentity

      Lists all of the Cognito identity pools registered for your account.

      You must use AWS Developer credentials to call this API.

      Specified by:
      listIdentityPools in interface AmazonCognitoIdentity
      Parameters:
      request - Input to the ListIdentityPools action.
      Returns:
      Result of the ListIdentityPools operation returned by the service.

    • lookupDeveloperIdentity

      public LookupDeveloperIdentityResult lookupDeveloperIdentity(LookupDeveloperIdentityRequest request)
      Description copied from interface: AmazonCognitoIdentity

      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:
      request - Input to the LookupDeveloperIdentityInput action.
      Returns:
      Result of the LookupDeveloperIdentity operation returned by the service.

    • mergeDeveloperIdentities

      public MergeDeveloperIdentitiesResult mergeDeveloperIdentities(MergeDeveloperIdentitiesRequest request)
      Description copied from interface: AmazonCognitoIdentity

      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:
      request - Input to the MergeDeveloperIdentities action.
      Returns:
      Result of the MergeDeveloperIdentities operation returned by the service.

    • setIdentityPoolRoles

      public SetIdentityPoolRolesResult setIdentityPoolRoles(SetIdentityPoolRolesRequest request)
      Description copied from interface: AmazonCognitoIdentity

      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:
      request - Input to the SetIdentityPoolRoles action.
      Returns:
      Result of the SetIdentityPoolRoles operation returned by the service.

    • unlinkDeveloperIdentity

      public UnlinkDeveloperIdentityResult unlinkDeveloperIdentity(UnlinkDeveloperIdentityRequest request)
      Description copied from interface: AmazonCognitoIdentity

      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:
      request - Input to the UnlinkDeveloperIdentity action.
      Returns:
      Result of the UnlinkDeveloperIdentity operation returned by the service.

    • unlinkIdentity

      public UnlinkIdentityResult unlinkIdentity(UnlinkIdentityRequest request)
      Description copied from interface: AmazonCognitoIdentity

      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:
      request - Input to the UnlinkIdentity action.
      Returns:
      Result of the UnlinkIdentity operation returned by the service.

    • updateIdentityPool

      public UpdateIdentityPoolResult updateIdentityPool(UpdateIdentityPoolRequest request)
      Description copied from interface: AmazonCognitoIdentity

      Updates a user pool.

      You must use AWS Developer credentials to call this API.

      Specified by:
      updateIdentityPool in interface AmazonCognitoIdentity
      Parameters:
      request - An object representing a Cognito identity pool.
      Returns:
      Result of the UpdateIdentityPool operation returned by the service.

    • shutdown

      public void shutdown()
      Description copied from interface: AmazonCognitoIdentity
      Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
      Specified by:
      shutdown in interface AmazonCognitoIdentity

    • getCachedResponseMetadata

      public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
      Description copied from interface: AmazonCognitoIdentity
      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 a 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.