public class AmazonCognitoIdentityClient extends AmazonWebServiceClient implements AmazonCognitoIdentity
| Modifier and Type | Field and Description |
|---|---|
protected java.util.List<JsonErrorUnmarshaller> |
jsonErrorUnmarshallers
List of exception unmarshallers for all AmazonCognitoIdentity exceptions.
|
client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset| Constructor and Description |
|---|
AmazonCognitoIdentityClient()
Constructs a new client to invoke service methods on
AmazonCognitoIdentity.
|
AmazonCognitoIdentityClient(AWSCredentials awsCredentials)
Constructs a new client to invoke service methods on
AmazonCognitoIdentity using the specified AWS account credentials.
|
AmazonCognitoIdentityClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on
AmazonCognitoIdentity using the specified AWS account credentials
and client configuration options.
|
AmazonCognitoIdentityClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new client to invoke service methods on
AmazonCognitoIdentity using the specified AWS account credentials provider.
|
AmazonCognitoIdentityClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on
AmazonCognitoIdentity using the specified AWS account credentials
provider and client configuration options.
|
AmazonCognitoIdentityClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
Constructs a new client to invoke service methods on
AmazonCognitoIdentity using the specified AWS account credentials
provider, client configuration options and request metric collector.
|
AmazonCognitoIdentityClient(ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on
AmazonCognitoIdentity.
|
addRequestHandler, addRequestHandler, configSigner, configSigner, convertToHttpRequest, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setConfiguration, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withTimeOffsetclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitsetRegion, shutdownprotected java.util.List<JsonErrorUnmarshaller> jsonErrorUnmarshallers
public AmazonCognitoIdentityClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChainpublic AmazonCognitoIdentityClient(ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration - The client configuration options controlling how this
client connects to AmazonCognitoIdentity
(ex: proxy settings, retry counts, etc.).DefaultAWSCredentialsProviderChainpublic AmazonCognitoIdentityClient(AWSCredentials awsCredentials)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use
when authenticating with AWS services.public AmazonCognitoIdentityClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
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 AmazonCognitoIdentity
(ex: proxy settings, retry counts, etc.).public AmazonCognitoIdentityClient(AWSCredentialsProvider awsCredentialsProvider)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials
to authenticate requests with AWS services.public AmazonCognitoIdentityClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
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 AmazonCognitoIdentity
(ex: proxy settings, retry counts, etc.).public AmazonCognitoIdentityClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
All service calls made using this new client object are blocking, and will not return until the service call completes.
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 AmazonCognitoIdentity
(ex: proxy settings, retry counts, etc.).requestMetricCollector - optional request metric collectorpublic void unlinkDeveloperIdentity(UnlinkDeveloperIdentityRequest unlinkDeveloperIdentityRequest)
unlinkDeveloperIdentity in interface AmazonCognitoIdentityunlinkDeveloperIdentityRequest - Container for the necessary
parameters to execute the UnlinkDeveloperIdentity service method on
AmazonCognitoIdentity.ResourceConflictExceptionInternalErrorExceptionNotAuthorizedExceptionInvalidParameterExceptionTooManyRequestsExceptionResourceNotFoundExceptionAmazonClientException - 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.public DescribeIdentityPoolResult describeIdentityPool(DescribeIdentityPoolRequest describeIdentityPoolRequest)
describeIdentityPool in interface AmazonCognitoIdentitydescribeIdentityPoolRequest - Container for the necessary
parameters to execute the DescribeIdentityPool service method on
AmazonCognitoIdentity.InternalErrorExceptionNotAuthorizedExceptionInvalidParameterExceptionTooManyRequestsExceptionResourceNotFoundExceptionAmazonClientException - 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.public GetIdResult getId(GetIdRequest getIdRequest)
getId in interface AmazonCognitoIdentitygetIdRequest - Container for the necessary parameters to execute
the GetId service method on AmazonCognitoIdentity.ResourceConflictExceptionInternalErrorExceptionLimitExceededExceptionNotAuthorizedExceptionInvalidParameterExceptionTooManyRequestsExceptionResourceNotFoundExceptionAmazonClientException - 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.public void deleteIdentityPool(DeleteIdentityPoolRequest deleteIdentityPoolRequest)
deleteIdentityPool in interface AmazonCognitoIdentitydeleteIdentityPoolRequest - Container for the necessary
parameters to execute the DeleteIdentityPool service method on
AmazonCognitoIdentity.InternalErrorExceptionNotAuthorizedExceptionInvalidParameterExceptionTooManyRequestsExceptionResourceNotFoundExceptionAmazonClientException - 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.public UpdateIdentityPoolResult updateIdentityPool(UpdateIdentityPoolRequest updateIdentityPoolRequest)
updateIdentityPool in interface AmazonCognitoIdentityupdateIdentityPoolRequest - Container for the necessary
parameters to execute the UpdateIdentityPool service method on
AmazonCognitoIdentity.ResourceConflictExceptionInternalErrorExceptionNotAuthorizedExceptionInvalidParameterExceptionTooManyRequestsExceptionResourceNotFoundExceptionAmazonClientException - 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.public GetCredentialsForIdentityResult getCredentialsForIdentity(GetCredentialsForIdentityRequest getCredentialsForIdentityRequest)
getCredentialsForIdentity in interface AmazonCognitoIdentitygetCredentialsForIdentityRequest - Container for the necessary
parameters to execute the GetCredentialsForIdentity service method on
AmazonCognitoIdentity.ResourceConflictExceptionInternalErrorExceptionInvalidIdentityPoolConfigurationExceptionNotAuthorizedExceptionInvalidParameterExceptionTooManyRequestsExceptionResourceNotFoundExceptionAmazonClientException - 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.public MergeDeveloperIdentitiesResult mergeDeveloperIdentities(MergeDeveloperIdentitiesRequest mergeDeveloperIdentitiesRequest)
mergeDeveloperIdentities in interface AmazonCognitoIdentitymergeDeveloperIdentitiesRequest - Container for the necessary
parameters to execute the MergeDeveloperIdentities service method on
AmazonCognitoIdentity.ResourceConflictExceptionInternalErrorExceptionNotAuthorizedExceptionInvalidParameterExceptionTooManyRequestsExceptionResourceNotFoundExceptionAmazonClientException - 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.public ListIdentityPoolsResult listIdentityPools(ListIdentityPoolsRequest listIdentityPoolsRequest)
listIdentityPools in interface AmazonCognitoIdentitylistIdentityPoolsRequest - Container for the necessary parameters
to execute the ListIdentityPools service method on
AmazonCognitoIdentity.InternalErrorExceptionNotAuthorizedExceptionInvalidParameterExceptionTooManyRequestsExceptionAmazonClientException - 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.public GetOpenIdTokenResult getOpenIdToken(GetOpenIdTokenRequest getOpenIdTokenRequest)
getOpenIdToken in interface AmazonCognitoIdentitygetOpenIdTokenRequest - Container for the necessary parameters to
execute the GetOpenIdToken service method on AmazonCognitoIdentity.ResourceConflictExceptionInternalErrorExceptionNotAuthorizedExceptionInvalidParameterExceptionTooManyRequestsExceptionResourceNotFoundExceptionAmazonClientException - 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.public DescribeIdentityResult describeIdentity(DescribeIdentityRequest describeIdentityRequest)
describeIdentity in interface AmazonCognitoIdentitydescribeIdentityRequest - Container for the necessary parameters
to execute the DescribeIdentity service method on
AmazonCognitoIdentity.InternalErrorExceptionNotAuthorizedExceptionInvalidParameterExceptionTooManyRequestsExceptionResourceNotFoundExceptionAmazonClientException - 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.public LookupDeveloperIdentityResult lookupDeveloperIdentity(LookupDeveloperIdentityRequest lookupDeveloperIdentityRequest)
lookupDeveloperIdentity in interface AmazonCognitoIdentitylookupDeveloperIdentityRequest - Container for the necessary
parameters to execute the LookupDeveloperIdentity service method on
AmazonCognitoIdentity.ResourceConflictExceptionInternalErrorExceptionNotAuthorizedExceptionInvalidParameterExceptionTooManyRequestsExceptionResourceNotFoundExceptionAmazonClientException - 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.public void setIdentityPoolRoles(SetIdentityPoolRolesRequest setIdentityPoolRolesRequest)
setIdentityPoolRoles in interface AmazonCognitoIdentitysetIdentityPoolRolesRequest - Container for the necessary
parameters to execute the SetIdentityPoolRoles service method on
AmazonCognitoIdentity.ResourceConflictExceptionInternalErrorExceptionNotAuthorizedExceptionInvalidParameterExceptionTooManyRequestsExceptionResourceNotFoundExceptionAmazonClientException - 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.public void unlinkIdentity(UnlinkIdentityRequest unlinkIdentityRequest)
unlinkIdentity in interface AmazonCognitoIdentityunlinkIdentityRequest - Container for the necessary parameters to
execute the UnlinkIdentity service method on AmazonCognitoIdentity.ResourceConflictExceptionInternalErrorExceptionNotAuthorizedExceptionInvalidParameterExceptionTooManyRequestsExceptionResourceNotFoundExceptionAmazonClientException - 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.public ListIdentitiesResult listIdentities(ListIdentitiesRequest listIdentitiesRequest)
listIdentities in interface AmazonCognitoIdentitylistIdentitiesRequest - Container for the necessary parameters to
execute the ListIdentities service method on AmazonCognitoIdentity.InternalErrorExceptionNotAuthorizedExceptionInvalidParameterExceptionTooManyRequestsExceptionResourceNotFoundExceptionAmazonClientException - 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.public GetIdentityPoolRolesResult getIdentityPoolRoles(GetIdentityPoolRolesRequest getIdentityPoolRolesRequest)
getIdentityPoolRoles in interface AmazonCognitoIdentitygetIdentityPoolRolesRequest - Container for the necessary
parameters to execute the GetIdentityPoolRoles service method on
AmazonCognitoIdentity.ResourceConflictExceptionInternalErrorExceptionNotAuthorizedExceptionInvalidParameterExceptionTooManyRequestsExceptionResourceNotFoundExceptionAmazonClientException - 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.public GetOpenIdTokenForDeveloperIdentityResult getOpenIdTokenForDeveloperIdentity(GetOpenIdTokenForDeveloperIdentityRequest getOpenIdTokenForDeveloperIdentityRequest)
getOpenIdTokenForDeveloperIdentity in interface AmazonCognitoIdentitygetOpenIdTokenForDeveloperIdentityRequest - Container for the
necessary parameters to execute the GetOpenIdTokenForDeveloperIdentity
service method on AmazonCognitoIdentity.ResourceConflictExceptionInternalErrorExceptionNotAuthorizedExceptionInvalidParameterExceptionTooManyRequestsExceptionDeveloperUserAlreadyRegisteredExceptionResourceNotFoundExceptionAmazonClientException - 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.public CreateIdentityPoolResult createIdentityPool(CreateIdentityPoolRequest createIdentityPoolRequest)
createIdentityPool in interface AmazonCognitoIdentitycreateIdentityPoolRequest - Container for the necessary
parameters to execute the CreateIdentityPool service method on
AmazonCognitoIdentity.ResourceConflictExceptionInternalErrorExceptionLimitExceededExceptionNotAuthorizedExceptionInvalidParameterExceptionTooManyRequestsExceptionAmazonClientException - 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.public void setEndpoint(java.lang.String endpoint)
AmazonWebServiceClientThis method is not threadsafe. Endpoints 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.
Callers can pass in just the endpoint (ex: "ec2.amazonaws.com") or a full
URL, including the protocol (ex: "https://ec2.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
setEndpoint in interface AmazonCognitoIdentitysetEndpoint in class AmazonWebServiceClientendpoint - The endpoint (ex: "ec2.amazonaws.com") or a full URL,
including the protocol (ex: "https://ec2.amazonaws.com") of
the region specific AWS endpoint this client will communicate
with.public void setEndpoint(java.lang.String endpoint,
java.lang.String serviceName,
java.lang.String regionId)
throws java.lang.IllegalArgumentException
AmazonWebServiceClientOverrides the default endpoint for this client ("http://dynamodb.us-east-1.amazonaws.com/") and explicitly provides an AWS region ID and AWS service name to use when the client calculates a signature for requests. In almost all cases, this region ID and service name are automatically determined from the endpoint, and callers should use the simpler one-argument form of setEndpoint instead of this method.
Callers can pass in just the endpoint (ex:
"dynamodb.us-east-1.amazonaws.com/") or a full URL, including the
protocol (ex: "http://dynamodb.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
setEndpoint in class AmazonWebServiceClientendpoint - The endpoint (ex: "dynamodb.us-east-1.amazonaws.com/") or a
full URL, including the protocol (ex:
"http://dynamodb.us-east-1.amazonaws.com/") of the region
specific AWS endpoint this client will communicate with.serviceName - This parameter is ignored.regionId - The ID of the region in which this service resides AND the
overriding region for signing purposes.java.lang.IllegalArgumentException - If any problems are detected with the specified endpoint.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
getCachedResponseMetadata in interface AmazonCognitoIdentityrequest - The originally executed request