public class AmazonCognitoSyncClient extends AmazonWebServiceClient implements AmazonCognitoSync
Amazon Cognito Sync
Amazon Cognito Sync provides an AWS service and client library that enable cross-device syncing of application-related user data. High-level client libraries are available for both iOS and Android. You can use these libraries to persist data locally so that it's available even if the device is offline. Developer credentials don't need to be stored on the mobile device to access the service. You can use Amazon Cognito to obtain a normalized user ID and credentials. User data is persisted in a dataset that can store up to 1 MB of key-value pairs, and you can have up to 20 datasets per user identity.
Modifier and Type | Field and Description |
---|---|
protected List<com.amazonaws.transform.JsonErrorUnmarshaller> |
jsonErrorUnmarshallers
List of exception unmarshallers for all AmazonCognitoSync exceptions.
|
client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
Constructor and Description |
---|
AmazonCognitoSyncClient()
Constructs a new client to invoke service methods on
AmazonCognitoSync.
|
AmazonCognitoSyncClient(AWSCredentials awsCredentials)
Constructs a new client to invoke service methods on
AmazonCognitoSync using the specified AWS account credentials.
|
AmazonCognitoSyncClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on
AmazonCognitoSync using the specified AWS account credentials
and client configuration options.
|
AmazonCognitoSyncClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new client to invoke service methods on
AmazonCognitoSync using the specified AWS account credentials provider.
|
AmazonCognitoSyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on
AmazonCognitoSync using the specified AWS account credentials
provider and client configuration options.
|
AmazonCognitoSyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
Constructs a new client to invoke service methods on
AmazonCognitoSync using the specified AWS account credentials
provider, client configuration options and request metric collector.
|
AmazonCognitoSyncClient(ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on
AmazonCognitoSync.
|
Modifier and Type | Method and Description |
---|---|
DeleteDatasetResult |
deleteDataset(DeleteDatasetRequest deleteDatasetRequest)
Deletes the specific dataset.
|
DescribeDatasetResult |
describeDataset(DescribeDatasetRequest describeDatasetRequest)
Gets metadata about a dataset by identity and dataset name.
|
DescribeIdentityPoolUsageResult |
describeIdentityPoolUsage(DescribeIdentityPoolUsageRequest describeIdentityPoolUsageRequest)
Gets usage details (for example, data storage) about a particular
identity pool.
|
DescribeIdentityUsageResult |
describeIdentityUsage(DescribeIdentityUsageRequest describeIdentityUsageRequest)
Gets usage information for an identity, including number of datasets
and data usage.
|
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.
|
ListDatasetsResult |
listDatasets(ListDatasetsRequest listDatasetsRequest)
Lists datasets for an identity.
|
ListIdentityPoolUsageResult |
listIdentityPoolUsage(ListIdentityPoolUsageRequest listIdentityPoolUsageRequest)
Gets a list of identity pools registered with Cognito.
|
ListRecordsResult |
listRecords(ListRecordsRequest listRecordsRequest)
Gets paginated records, optionally changed after a particular sync
count for a dataset and identity.
|
void |
setEndpoint(String endpoint)
Overrides the default endpoint for this client ("https://cognito-sync.us-east-1.amazonaws.com/").
|
void |
setEndpoint(String endpoint,
String serviceName,
String regionId) |
UpdateRecordsResult |
updateRecords(UpdateRecordsRequest updateRecordsRequest)
Posts updates to records and add and delete records for a dataset and
user.
|
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, withTimeOffset
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
setRegion, shutdown
protected List<com.amazonaws.transform.JsonErrorUnmarshaller> jsonErrorUnmarshallers
public AmazonCognitoSyncClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain
public AmazonCognitoSyncClient(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 AmazonCognitoSync
(ex: proxy settings, retry counts, etc.).DefaultAWSCredentialsProviderChain
public AmazonCognitoSyncClient(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 AmazonCognitoSyncClient(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 AmazonCognitoSync
(ex: proxy settings, retry counts, etc.).public AmazonCognitoSyncClient(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 AmazonCognitoSyncClient(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 AmazonCognitoSync
(ex: proxy settings, retry counts, etc.).public AmazonCognitoSyncClient(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 AmazonCognitoSync
(ex: proxy settings, retry counts, etc.).requestMetricCollector
- optional request metric collectorpublic UpdateRecordsResult updateRecords(UpdateRecordsRequest updateRecordsRequest)
Posts updates to records and add and delete records for a dataset and user.
updateRecords
in interface AmazonCognitoSync
updateRecordsRequest
- Container for the necessary parameters to
execute the UpdateRecords service method on AmazonCognitoSync.LimitExceededException
TooManyRequestsException
ResourceConflictException
InvalidParameterException
ResourceNotFoundException
NotAuthorizedException
InternalErrorException
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 AmazonCognitoSync indicating
either a problem with the data in the request, or a server side issue.public DescribeIdentityPoolUsageResult describeIdentityPoolUsage(DescribeIdentityPoolUsageRequest describeIdentityPoolUsageRequest)
Gets usage details (for example, data storage) about a particular identity pool.
describeIdentityPoolUsage
in interface AmazonCognitoSync
describeIdentityPoolUsageRequest
- Container for the necessary
parameters to execute the DescribeIdentityPoolUsage service method on
AmazonCognitoSync.InvalidParameterException
ResourceNotFoundException
NotAuthorizedException
InternalErrorException
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 AmazonCognitoSync indicating
either a problem with the data in the request, or a server side issue.public ListDatasetsResult listDatasets(ListDatasetsRequest listDatasetsRequest)
Lists datasets for an identity.
listDatasets
in interface AmazonCognitoSync
listDatasetsRequest
- Container for the necessary parameters to
execute the ListDatasets service method on AmazonCognitoSync.InvalidParameterException
NotAuthorizedException
InternalErrorException
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 AmazonCognitoSync indicating
either a problem with the data in the request, or a server side issue.public ListIdentityPoolUsageResult listIdentityPoolUsage(ListIdentityPoolUsageRequest listIdentityPoolUsageRequest)
Gets a list of identity pools registered with Cognito.
listIdentityPoolUsage
in interface AmazonCognitoSync
listIdentityPoolUsageRequest
- Container for the necessary
parameters to execute the ListIdentityPoolUsage service method on
AmazonCognitoSync.InvalidParameterException
NotAuthorizedException
InternalErrorException
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 AmazonCognitoSync indicating
either a problem with the data in the request, or a server side issue.public ListRecordsResult listRecords(ListRecordsRequest listRecordsRequest)
Gets paginated records, optionally changed after a particular sync count for a dataset and identity.
listRecords
in interface AmazonCognitoSync
listRecordsRequest
- Container for the necessary parameters to
execute the ListRecords service method on AmazonCognitoSync.TooManyRequestsException
InvalidParameterException
NotAuthorizedException
InternalErrorException
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 AmazonCognitoSync indicating
either a problem with the data in the request, or a server side issue.public DescribeDatasetResult describeDataset(DescribeDatasetRequest describeDatasetRequest)
Gets metadata about a dataset by identity and dataset name.
describeDataset
in interface AmazonCognitoSync
describeDatasetRequest
- Container for the necessary parameters
to execute the DescribeDataset service method on AmazonCognitoSync.InvalidParameterException
ResourceNotFoundException
NotAuthorizedException
InternalErrorException
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 AmazonCognitoSync indicating
either a problem with the data in the request, or a server side issue.public DeleteDatasetResult deleteDataset(DeleteDatasetRequest deleteDatasetRequest)
Deletes the specific dataset. The dataset will be deleted permanently, and the action can't be undone. Datasets that this dataset was merged with will no longer report the merge. Any consequent operation on this dataset will result in a ResourceNotFoundException.
deleteDataset
in interface AmazonCognitoSync
deleteDatasetRequest
- Container for the necessary parameters to
execute the DeleteDataset service method on AmazonCognitoSync.InvalidParameterException
ResourceNotFoundException
NotAuthorizedException
InternalErrorException
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 AmazonCognitoSync indicating
either a problem with the data in the request, or a server side issue.public DescribeIdentityUsageResult describeIdentityUsage(DescribeIdentityUsageRequest describeIdentityUsageRequest)
Gets usage information for an identity, including number of datasets and data usage.
describeIdentityUsage
in interface AmazonCognitoSync
describeIdentityUsageRequest
- Container for the necessary
parameters to execute the DescribeIdentityUsage service method on
AmazonCognitoSync.InvalidParameterException
ResourceNotFoundException
NotAuthorizedException
InternalErrorException
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 AmazonCognitoSync indicating
either a problem with the data in the request, or a server side issue.public void setEndpoint(String endpoint)
AmazonCognitoSync
Callers can pass in just the endpoint (ex: "cognito-sync.us-east-1.amazonaws.com/") or a full
URL, including the protocol (ex: "https://cognito-sync.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.
setEndpoint
in interface AmazonCognitoSync
setEndpoint
in class AmazonWebServiceClient
endpoint
- The endpoint (ex: "cognito-sync.us-east-1.amazonaws.com/") or a full URL,
including the protocol (ex: "https://cognito-sync.us-east-1.amazonaws.com/") of
the region specific AWS endpoint this client will communicate
with.public void setEndpoint(String endpoint, String serviceName, String regionId) throws IllegalArgumentException
setEndpoint
in class AmazonWebServiceClient
IllegalArgumentException
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 AmazonCognitoSync
request
- The originally executed requestCopyright © 2014. All rights reserved.