com.amazonaws.services.cognitoidentity.AmazonCognitoIdentity Maven / Gradle / Ivy
/*
* Copyright 2010-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package com.amazonaws.services.cognitoidentity;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.cognitoidentity.model.*;
/**
* Interface for accessing AmazonCognitoIdentity.
* Amazon Cognito
* Amazon Cognito is a web service that facilitates the delivery of
* scoped, temporary credentials to mobile devices or other untrusted
* environments. Amazon Cognito uniquely identifies a device or user and
* supplies the user with a consistent identity throughout the lifetime
* of an application.
*
*
* Amazon Cognito lets users authenticate with third-party identity
* providers (Facebook, Google, or Login with Amazon). As a developer,
* you decide which identity providers to trust. You can also choose to
* support unauthenticated access from your application. Your users are
* provided with Cognito tokens that uniquely identify their device and
* any information provided about third-party logins.
*
*/
public 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
* {@link 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.
*
* @param 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.
*
* @throws IllegalArgumentException
* If any problems are detected with the specified endpoint.
*/
public void setEndpoint(String endpoint) throws java.lang.IllegalArgumentException;
/**
* An alternative to {@link 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 {@link 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.
*
* @param region
* The region this client will communicate with. See
* {@link Region#getRegion(com.amazonaws.regions.Regions)} for
* accessing a given region.
* @throws java.lang.IllegalArgumentException
* If the given region is null, or if this service isn't
* available in the given region. See
* {@link Region#isServiceSupported(String)}
* @see Region#getRegion(com.amazonaws.regions.Regions)
* @see Region#createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
*/
public void setRegion(Region region) throws java.lang.IllegalArgumentException;
/**
*
* Lists all of the Cognito identity pools registered for your account.
*
*
* @param listIdentityPoolsRequest Container for the necessary parameters
* to execute the ListIdentityPools service method on
* AmazonCognitoIdentity.
*
* @return The response from the ListIdentityPools service method, as
* returned by AmazonCognitoIdentity.
*
* @throws InternalErrorException
* @throws NotAuthorizedException
* @throws InvalidParameterException
* @throws TooManyRequestsException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonCognitoIdentity indicating
* either a problem with the data in the request, or a server side issue.
*/
public ListIdentityPoolsResult listIdentityPools(ListIdentityPoolsRequest listIdentityPoolsRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* Gets an OpenID token, using a known Cognito ID. This known Cognito ID
* is returned from GetId. You can optionally add additional logins for
* the identity. Supplying multiple logins creates an implicit link.
*
*
* @param getOpenIdTokenRequest Container for the necessary parameters to
* execute the GetOpenIdToken service method on AmazonCognitoIdentity.
*
* @return The response from the GetOpenIdToken service method, as
* returned by AmazonCognitoIdentity.
*
* @throws ResourceConflictException
* @throws InternalErrorException
* @throws NotAuthorizedException
* @throws InvalidParameterException
* @throws TooManyRequestsException
* @throws ResourceNotFoundException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonCognitoIdentity indicating
* either a problem with the data in the request, or a server side issue.
*/
public GetOpenIdTokenResult getOpenIdToken(GetOpenIdTokenRequest getOpenIdTokenRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* 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.
*
*
* @param unlinkIdentityRequest Container for the necessary parameters to
* execute the UnlinkIdentity service method on AmazonCognitoIdentity.
*
*
* @throws ResourceConflictException
* @throws InternalErrorException
* @throws NotAuthorizedException
* @throws InvalidParameterException
* @throws TooManyRequestsException
* @throws ResourceNotFoundException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonCognitoIdentity indicating
* either a problem with the data in the request, or a server side issue.
*/
public void unlinkIdentity(UnlinkIdentityRequest unlinkIdentityRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* Gets details about a particular identity pool, including the pool
* name, ID description, creation date, and current number of users.
*
*
* @param describeIdentityPoolRequest Container for the necessary
* parameters to execute the DescribeIdentityPool service method on
* AmazonCognitoIdentity.
*
* @return The response from the DescribeIdentityPool service method, as
* returned by AmazonCognitoIdentity.
*
* @throws InternalErrorException
* @throws NotAuthorizedException
* @throws InvalidParameterException
* @throws TooManyRequestsException
* @throws ResourceNotFoundException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonCognitoIdentity indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeIdentityPoolResult describeIdentityPool(DescribeIdentityPoolRequest describeIdentityPoolRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* Generates (or retrieves) a Cognito ID. Supplying multiple logins will
* create an implicit linked account.
*
*
* @param getIdRequest Container for the necessary parameters to execute
* the GetId service method on AmazonCognitoIdentity.
*
* @return The response from the GetId service method, as returned by
* AmazonCognitoIdentity.
*
* @throws ResourceConflictException
* @throws InternalErrorException
* @throws LimitExceededException
* @throws NotAuthorizedException
* @throws InvalidParameterException
* @throws TooManyRequestsException
* @throws ResourceNotFoundException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonCognitoIdentity indicating
* either a problem with the data in the request, or a server side issue.
*/
public GetIdResult getId(GetIdRequest getIdRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* Deletes a user pool. Once a pool is deleted, users will not be able
* to authenticate with the pool.
*
*
* @param deleteIdentityPoolRequest Container for the necessary
* parameters to execute the DeleteIdentityPool service method on
* AmazonCognitoIdentity.
*
*
* @throws InternalErrorException
* @throws NotAuthorizedException
* @throws InvalidParameterException
* @throws TooManyRequestsException
* @throws ResourceNotFoundException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonCognitoIdentity indicating
* either a problem with the data in the request, or a server side issue.
*/
public void deleteIdentityPool(DeleteIdentityPoolRequest deleteIdentityPoolRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* Lists the identities in a pool.
*
*
* @param listIdentitiesRequest Container for the necessary parameters to
* execute the ListIdentities service method on AmazonCognitoIdentity.
*
* @return The response from the ListIdentities service method, as
* returned by AmazonCognitoIdentity.
*
* @throws InternalErrorException
* @throws NotAuthorizedException
* @throws InvalidParameterException
* @throws TooManyRequestsException
* @throws ResourceNotFoundException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonCognitoIdentity indicating
* either a problem with the data in the request, or a server side issue.
*/
public ListIdentitiesResult listIdentities(ListIdentitiesRequest listIdentitiesRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* Updates a user pool.
*
*
* @param updateIdentityPoolRequest Container for the necessary
* parameters to execute the UpdateIdentityPool service method on
* AmazonCognitoIdentity.
*
* @return The response from the UpdateIdentityPool service method, as
* returned by AmazonCognitoIdentity.
*
* @throws ResourceConflictException
* @throws InternalErrorException
* @throws NotAuthorizedException
* @throws InvalidParameterException
* @throws TooManyRequestsException
* @throws ResourceNotFoundException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonCognitoIdentity indicating
* either a problem with the data in the request, or a server side issue.
*/
public UpdateIdentityPoolResult updateIdentityPool(UpdateIdentityPoolRequest updateIdentityPoolRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* Creates a new identity pool. The identity pool is a store of user
* identity information that is specific to your AWS account.
*
*
* @param createIdentityPoolRequest Container for the necessary
* parameters to execute the CreateIdentityPool service method on
* AmazonCognitoIdentity.
*
* @return The response from the CreateIdentityPool service method, as
* returned by AmazonCognitoIdentity.
*
* @throws ResourceConflictException
* @throws InternalErrorException
* @throws LimitExceededException
* @throws NotAuthorizedException
* @throws InvalidParameterException
* @throws TooManyRequestsException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonCognitoIdentity indicating
* either a problem with the data in the request, or a server side issue.
*/
public CreateIdentityPoolResult createIdentityPool(CreateIdentityPoolRequest createIdentityPoolRequest)
throws AmazonServiceException, AmazonClientException;
/**
* 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.
*/
public void shutdown();
/**
* 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.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none
* is available.
*/
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}