com.amazonaws.services.cognitosync

Class AmazonCognitoSyncClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.cognitosync.AmazonCognitoSyncClient

All Implemented Interfaces:

AmazonCognitoSync

Direct Known Subclasses:

AmazonCognitoSyncAsyncClient

public class AmazonCognitoSyncClient
extends AmazonWebServiceClient
implements AmazonCognitoSync

Client for accessing AmazonCognitoSync. All service calls made using this client are blocking, and will not return until the service call completes.

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.

With Amazon Cognito Sync, the data stored for each identity is accessible only to credentials assigned to that identity. In order to use the Cognito Sync service, you need to make API calls using credentials retrieved with Amazon Cognito Identity service .

Field Summary

Fields

Modifier and Type	Field and Description
protected List<com.amazonaws.transform.JsonErrorUnmarshaller>	jsonErrorUnmarshallers List of exception unmarshallers for all AmazonCognitoSync exceptions.

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Constructor Summary

Constructors

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.

Method Summary

Methods

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.
GetIdentityPoolConfigurationResult	getIdentityPoolConfiguration(GetIdentityPoolConfigurationRequest getIdentityPoolConfigurationRequest) Gets the configuration settings of an identity pool.
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.
RegisterDeviceResult	registerDevice(RegisterDeviceRequest registerDeviceRequest) Registers a device to receive push sync notifications.
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)
SetIdentityPoolConfigurationResult	setIdentityPoolConfiguration(SetIdentityPoolConfigurationRequest setIdentityPoolConfigurationRequest) Sets the necessary configuration for push sync.
SubscribeToDatasetResult	subscribeToDataset(SubscribeToDatasetRequest subscribeToDatasetRequest) Subscribes to receive notifications when a dataset is modified by another device.
UnsubscribeFromDatasetResult	unsubscribeFromDataset(UnsubscribeFromDatasetRequest unsubscribeFromDatasetRequest) Unsubscribe from receiving notifications when a dataset is modified by another device.
UpdateRecordsResult	updateRecords(UpdateRecordsRequest updateRecordsRequest) Posts updates to records and add and delete records for a dataset and user.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

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, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.cognitosync.AmazonCognitoSync

setRegion, shutdown

Field Detail

jsonErrorUnmarshallers

protected List<com.amazonaws.transform.JsonErrorUnmarshaller> jsonErrorUnmarshallers

List of exception unmarshallers for all AmazonCognitoSync exceptions.

Constructor Detail

AmazonCognitoSyncClient

public AmazonCognitoSyncClient()

Constructs a new client to invoke service methods on AmazonCognitoSync. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:

DefaultAWSCredentialsProviderChain

AmazonCognitoSyncClient

public AmazonCognitoSyncClient(ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AmazonCognitoSync. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to AmazonCognitoSync (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AmazonCognitoSyncClient

public AmazonCognitoSyncClient(AWSCredentials awsCredentials)

Constructs a new client to invoke service methods on AmazonCognitoSync using the specified AWS account credentials.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AmazonCognitoSyncClient

public 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.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

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.).

AmazonCognitoSyncClient

public AmazonCognitoSyncClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new client to invoke service methods on AmazonCognitoSync using the specified AWS account credentials provider.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AmazonCognitoSyncClient

public 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.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

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.).

AmazonCognitoSyncClient

public 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.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

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 collector

Method Detail

updateRecords

public UpdateRecordsResult updateRecords(UpdateRecordsRequest updateRecordsRequest)

Posts updates to records and add and delete records for a dataset and user. The credentials used to make this API call need to have access to the identity data. With Amazon Cognito Sync, each identity has access only to its own data. You should use Amazon Cognito Identity service to retrieve the credentials necessary to make this API call.

Specified by:

updateRecords in interface AmazonCognitoSync

Parameters:

updateRecordsRequest - Container for the necessary parameters to execute the UpdateRecords service method on AmazonCognitoSync.

Returns:

The response from the UpdateRecords service method, as returned by AmazonCognitoSync.

Throws:

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.

describeIdentityUsage

public DescribeIdentityUsageResult describeIdentityUsage(DescribeIdentityUsageRequest describeIdentityUsageRequest)

Gets usage information for an identity, including number of datasets and data usage.

Specified by:

describeIdentityUsage in interface AmazonCognitoSync

Parameters:

describeIdentityUsageRequest - Container for the necessary parameters to execute the DescribeIdentityUsage service method on AmazonCognitoSync.

Returns:

The response from the DescribeIdentityUsage service method, as returned by AmazonCognitoSync.

Throws:

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.

unsubscribeFromDataset

public UnsubscribeFromDatasetResult unsubscribeFromDataset(UnsubscribeFromDatasetRequest unsubscribeFromDatasetRequest)

Unsubscribe from receiving notifications when a dataset is modified by another device.

Specified by:

unsubscribeFromDataset in interface AmazonCognitoSync

Parameters:

unsubscribeFromDatasetRequest - Container for the necessary parameters to execute the UnsubscribeFromDataset service method on AmazonCognitoSync.

Returns:

The response from the UnsubscribeFromDataset service method, as returned by AmazonCognitoSync.

Throws:

InvalidConfigurationException

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.

setIdentityPoolConfiguration

public SetIdentityPoolConfigurationResult setIdentityPoolConfiguration(SetIdentityPoolConfigurationRequest setIdentityPoolConfigurationRequest)

Sets the necessary configuration for push sync.

Specified by:

setIdentityPoolConfiguration in interface AmazonCognitoSync

Parameters:

setIdentityPoolConfigurationRequest - Container for the necessary parameters to execute the SetIdentityPoolConfiguration service method on AmazonCognitoSync.

Returns:

The response from the SetIdentityPoolConfiguration service method, as returned by AmazonCognitoSync.

Throws:

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.

getIdentityPoolConfiguration

public GetIdentityPoolConfigurationResult getIdentityPoolConfiguration(GetIdentityPoolConfigurationRequest getIdentityPoolConfigurationRequest)

Gets the configuration settings of an identity pool.

Specified by:

getIdentityPoolConfiguration in interface AmazonCognitoSync

Parameters:

getIdentityPoolConfigurationRequest - Container for the necessary parameters to execute the GetIdentityPoolConfiguration service method on AmazonCognitoSync.

Returns:

The response from the GetIdentityPoolConfiguration service method, as returned by AmazonCognitoSync.

Throws:

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.

subscribeToDataset

public SubscribeToDatasetResult subscribeToDataset(SubscribeToDatasetRequest subscribeToDatasetRequest)

Subscribes to receive notifications when a dataset is modified by another device.

Specified by:

subscribeToDataset in interface AmazonCognitoSync

Parameters:

subscribeToDatasetRequest - Container for the necessary parameters to execute the SubscribeToDataset service method on AmazonCognitoSync.

Returns:

The response from the SubscribeToDataset service method, as returned by AmazonCognitoSync.

Throws:

InvalidConfigurationException

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.

describeIdentityPoolUsage

public DescribeIdentityPoolUsageResult describeIdentityPoolUsage(DescribeIdentityPoolUsageRequest describeIdentityPoolUsageRequest)

Gets usage details (for example, data storage) about a particular identity pool.

Specified by:

describeIdentityPoolUsage in interface AmazonCognitoSync

Parameters:

describeIdentityPoolUsageRequest - Container for the necessary parameters to execute the DescribeIdentityPoolUsage service method on AmazonCognitoSync.

Returns:

The response from the DescribeIdentityPoolUsage service method, as returned by AmazonCognitoSync.

Throws:

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.

listDatasets

public ListDatasetsResult listDatasets(ListDatasetsRequest listDatasetsRequest)

Lists datasets for an identity. The credentials used to make this API call need to have access to the identity data. With Amazon Cognito Sync, each identity has access only to its own data. You should use Amazon Cognito Identity service to retrieve the credentials necessary to make this API call.

Specified by:

listDatasets in interface AmazonCognitoSync

Parameters:

listDatasetsRequest - Container for the necessary parameters to execute the ListDatasets service method on AmazonCognitoSync.

Returns:

The response from the ListDatasets service method, as returned by AmazonCognitoSync.

Throws:

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.

listIdentityPoolUsage

public ListIdentityPoolUsageResult listIdentityPoolUsage(ListIdentityPoolUsageRequest listIdentityPoolUsageRequest)

Gets a list of identity pools registered with Cognito.

Specified by:

listIdentityPoolUsage in interface AmazonCognitoSync

Parameters:

listIdentityPoolUsageRequest - Container for the necessary parameters to execute the ListIdentityPoolUsage service method on AmazonCognitoSync.

Returns:

The response from the ListIdentityPoolUsage service method, as returned by AmazonCognitoSync.

Throws:

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.

listRecords

public ListRecordsResult listRecords(ListRecordsRequest listRecordsRequest)

Gets paginated records, optionally changed after a particular sync count for a dataset and identity. The credentials used to make this API call need to have access to the identity data. With Amazon Cognito Sync, each identity has access only to its own data. You should use Amazon Cognito Identity service to retrieve the credentials necessary to make this API call.

Specified by:

listRecords in interface AmazonCognitoSync

Parameters:

listRecordsRequest - Container for the necessary parameters to execute the ListRecords service method on AmazonCognitoSync.

Returns:

The response from the ListRecords service method, as returned by AmazonCognitoSync.

Throws:

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.

describeDataset

public DescribeDatasetResult describeDataset(DescribeDatasetRequest describeDatasetRequest)

Gets metadata about a dataset by identity and dataset name. The credentials used to make this API call need to have access to the identity data. With Amazon Cognito Sync, each identity has access only to its own data. You should use Amazon Cognito Identity service to retrieve the credentials necessary to make this API call.

Specified by:

describeDataset in interface AmazonCognitoSync

Parameters:

describeDatasetRequest - Container for the necessary parameters to execute the DescribeDataset service method on AmazonCognitoSync.

Returns:

The response from the DescribeDataset service method, as returned by AmazonCognitoSync.

Throws:

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.

deleteDataset

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.

Specified by:

deleteDataset in interface AmazonCognitoSync

Parameters:

deleteDatasetRequest - Container for the necessary parameters to execute the DeleteDataset service method on AmazonCognitoSync.

Returns:

The response from the DeleteDataset service method, as returned by AmazonCognitoSync.

Throws:

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.

registerDevice

public RegisterDeviceResult registerDevice(RegisterDeviceRequest registerDeviceRequest)

Registers a device to receive push sync notifications.

Specified by:

registerDevice in interface AmazonCognitoSync

Parameters:

registerDeviceRequest - Container for the necessary parameters to execute the RegisterDevice service method on AmazonCognitoSync.

Returns:

The response from the RegisterDevice service method, as returned by AmazonCognitoSync.

Throws:

InvalidConfigurationException

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.

setEndpoint

public void setEndpoint(String endpoint)

Description copied from interface: AmazonCognitoSync

Overrides the default endpoint for this client ("https://cognito-sync.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-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.

Specified by:

setEndpoint in interface AmazonCognitoSync

Overrides:

setEndpoint in class AmazonWebServiceClient

Parameters:

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.

setEndpoint

public void setEndpoint(String endpoint,
               String serviceName,
               String regionId)
                 throws IllegalArgumentException

Overrides:

setEndpoint in class AmazonWebServiceClient

Throws:

IllegalArgumentException

getCachedResponseMetadata

public 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 the request.

Specified by:

getCachedResponseMetadata in interface AmazonCognitoSync

Parameters:

request - The originally executed request

Returns:

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