com.amazonaws.services.cognitoidentity

Interface AmazonCognitoIdentity

All Known Implementing Classes:

AmazonCognitoIdentityClient

public interface AmazonCognitoIdentity

Interface for accessing AmazonCognitoIdentity.

Method Summary

Modifier and Type	Method and Description
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.
GetCredentialsForIdentityResult	getCredentialsForIdentity(GetCredentialsForIdentityRequest getCredentialsForIdentityRequest)
GetIdResult	getId(GetIdRequest getIdRequest)
GetOpenIdTokenResult	getOpenIdToken(GetOpenIdTokenRequest getOpenIdTokenRequest)
void	setEndpoint(String endpoint) Overrides the default endpoint for this client ("https://cognito-identity.us-east-1.amazonaws.com").
void	setRegion(Region region) An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

Method Detail

setEndpoint

void setEndpoint(String endpoint)
          throws IllegalArgumentException

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.

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.

Throws:

IllegalArgumentException - If any problems are detected with the specified endpoint.

setRegion

void setRegion(Region region)
        throws IllegalArgumentException

An alternative to 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.

Parameters:

region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region.

Throws:

IllegalArgumentException - If the given region is null, or if this service isn't available in the given region. See Region.isServiceSupported(String)

See Also:

Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)

getId

GetIdResult getId(GetIdRequest getIdRequest)
           throws AmazonServiceException,
                  AmazonClientException

Parameters:

getIdRequest - Container for the necessary parameters to execute the GetId service method on AmazonCognitoIdentity.

Returns:

The response from the GetId service method, as returned by AmazonCognitoIdentity.

Throws:

ResourceConflictException

InternalErrorException

LimitExceededException

NotAuthorizedException

InvalidParameterException

TooManyRequestsException

ResourceNotFoundException

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.

AmazonServiceException - If an error response is returned by AmazonCognitoIdentity indicating either a problem with the data in the request, or a server side issue.

getCredentialsForIdentity

GetCredentialsForIdentityResult getCredentialsForIdentity(GetCredentialsForIdentityRequest getCredentialsForIdentityRequest)
                                                   throws AmazonServiceException,
                                                          AmazonClientException

Parameters:

getCredentialsForIdentityRequest - Container for the necessary parameters to execute the GetCredentialsForIdentity service method on AmazonCognitoIdentity.

Returns:

The response from the GetCredentialsForIdentity service method, as returned by AmazonCognitoIdentity.

Throws:

ResourceConflictException

InternalErrorException

InvalidIdentityPoolConfigurationException

NotAuthorizedException

InvalidParameterException

TooManyRequestsException

ResourceNotFoundException

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.

AmazonServiceException - If an error response is returned by AmazonCognitoIdentity indicating either a problem with the data in the request, or a server side issue.

getOpenIdToken

GetOpenIdTokenResult getOpenIdToken(GetOpenIdTokenRequest getOpenIdTokenRequest)
                             throws AmazonServiceException,
                                    AmazonClientException

Parameters:

getOpenIdTokenRequest - Container for the necessary parameters to execute the GetOpenIdToken service method on AmazonCognitoIdentity.

Returns:

The response from the GetOpenIdToken service method, as returned by AmazonCognitoIdentity.

Throws:

ResourceConflictException

InternalErrorException

NotAuthorizedException

InvalidParameterException

TooManyRequestsException

ResourceNotFoundException

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.

AmazonServiceException - If an error response is returned by AmazonCognitoIdentity indicating either a problem with the data in the request, or a server side issue.

shutdown

void shutdown()

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.

getCachedResponseMetadata

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

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.