com.amazonaws.services.cognitosync

Class AmazonCognitoSyncClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.cognitosync.AmazonCognitoSyncClient

All Implemented Interfaces:

AmazonCognitoSync

Deprecated.

The Amazon Cognito Sync SDK for Android is deprecated as of release 2.9.0. Please use the AWS AppSync SDK for Android along with AWS AppSync service instead.

@Deprecated
public class AmazonCognitoSyncClient
extends AmazonWebServiceClient
implements AmazonCognitoSync

Client for accessing Amazon Cognito Sync. 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.

If you want to use Cognito Sync in an Android or iOS application, you will probably want to make API calls via the AWS Mobile SDK. To learn more, see the Developer Guide for Android and the Developer Guide for iOS.

Field Summary

Fields

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

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, endpointPrefix, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Constructor Summary

Constructors

Constructor and Description
AmazonCognitoSyncClient() Deprecated.
AmazonCognitoSyncClient(AWSCredentials awsCredentials) Deprecated. Constructs a new client to invoke service methods on AmazonCognitoSync using the specified AWS account credentials.
AmazonCognitoSyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Deprecated. Constructs a new client to invoke service methods on AmazonCognitoSync using the specified AWS account credentials and client configuration options.
AmazonCognitoSyncClient(AWSCredentialsProvider awsCredentialsProvider) Deprecated. Constructs a new client to invoke service methods on AmazonCognitoSync using the specified AWS account credentials provider.
AmazonCognitoSyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Deprecated. 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, HttpClient httpClient) Deprecated. 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(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Deprecated.
AmazonCognitoSyncClient(ClientConfiguration clientConfiguration) Deprecated.

Method Summary

Modifier and Type	Method and Description
DeleteDatasetResult	deleteDataset(DeleteDatasetRequest deleteDatasetRequest) Deprecated. Deletes the specific dataset.
DescribeDatasetResult	describeDataset(DescribeDatasetRequest describeDatasetRequest) Deprecated. Gets meta data about a dataset by identity and dataset name.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Deprecated. ResponseMetadata cache can hold up to 50 requests and responses in memory and will cause memory issue. This method now always returns null.
ListDatasetsResult	listDatasets(ListDatasetsRequest listDatasetsRequest) Deprecated. Lists datasets for an identity.
ListRecordsResult	listRecords(ListRecordsRequest listRecordsRequest) Deprecated. Gets paginated records, optionally changed after a particular sync count for a dataset and identity.
RegisterDeviceResult	registerDevice(RegisterDeviceRequest registerDeviceRequest) Deprecated. Registers a device to receive push sync notifications.
SubscribeToDatasetResult	subscribeToDataset(SubscribeToDatasetRequest subscribeToDatasetRequest) Deprecated. Subscribes to receive notifications when a dataset is modified by another device.
UnsubscribeFromDatasetResult	unsubscribeFromDataset(UnsubscribeFromDatasetRequest unsubscribeFromDatasetRequest) Deprecated. Unsubscribes from receiving notifications when a dataset is modified by another device.
UpdateRecordsResult	updateRecords(UpdateRecordsRequest updateRecordsRequest) Deprecated. Posts updates to records and adds and deletes records for a dataset and user.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configSigner, configSigner, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getEndpoint, getEndpointPrefix, getRegions, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setConfiguration, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, 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

setEndpoint, setRegion, shutdown

Field Detail

jsonErrorUnmarshallers

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

Deprecated.

List of exception unmarshallers for all Amazon Cognito Sync exceptions.

Constructor Detail

AmazonCognitoSyncClient

@Deprecated
public AmazonCognitoSyncClient()

Deprecated.

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

@Deprecated
public AmazonCognitoSyncClient(ClientConfiguration clientConfiguration)

Deprecated.

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)

Deprecated.

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

If AWS session credentials are passed in, then those credentials will be used to authenticate requests. Otherwise, if AWS long-term credentials are passed in, then session management will be handled automatically by the SDK. Callers are encouraged to use long-term credentials and let the SDK handle starting and renewing sessions.

Automatically managed sessions will be shared among all clients that use the same credentials and service endpoint. To opt out of this behavior, explicitly provide an instance of AWSCredentialsProvider that returns AWSSessionCredentials.

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)

Deprecated.

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

If AWS session credentials are passed in, then those credentials will be used to authenticate requests. Otherwise, if AWS long-term credentials are passed in, then session management will be handled automatically by the SDK. Callers are encouraged to use long-term credentials and let the SDK handle starting and renewing sessions.

Automatically managed sessions will be shared among all clients that use the same credentials and service endpoint. To opt out of this behavior, explicitly provide an instance of AWSCredentialsProvider that returns AWSSessionCredentials.

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)

Deprecated.

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

If AWS session credentials are passed in, then those credentials will be used to authenticate requests. Otherwise, if AWS long-term credentials are passed in, then session management will be handled automatically by the SDK. Callers are encouraged to use long-term credentials and let the SDK handle starting and renewing sessions.

Automatically managed sessions will be shared among all clients that use the same credentials and service endpoint. To opt out of this behavior, explicitly provide an instance of AWSCredentialsProvider that returns AWSSessionCredentials.

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)

Deprecated.

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

If AWS session credentials are passed in, then those credentials will be used to authenticate requests. Otherwise, if AWS long-term credentials are passed in, then session management will be handled automatically by the SDK. Callers are encouraged to use long-term credentials and let the SDK handle starting and renewing sessions.

Automatically managed sessions will be shared among all clients that use the same credentials and service endpoint. To opt out of this behavior, explicitly provide an instance of AWSCredentialsProvider that returns AWSSessionCredentials.

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

@Deprecated
public AmazonCognitoSyncClient(AWSCredentialsProvider awsCredentialsProvider,
                                           ClientConfiguration clientConfiguration,
                                           RequestMetricCollector requestMetricCollector)

Deprecated.

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

AmazonCognitoSyncClient

public AmazonCognitoSyncClient(AWSCredentialsProvider awsCredentialsProvider,
                               ClientConfiguration clientConfiguration,
                               HttpClient httpClient)

Deprecated.

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

httpClient - A http client

Method Detail

deleteDataset

public DeleteDatasetResult deleteDataset(DeleteDatasetRequest deleteDatasetRequest)
                                  throws AmazonServiceException,
                                         AmazonClientException

Deprecated.

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 subsequent operation on this dataset will result in a ResourceNotFoundException.

This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials.

Specified by:

deleteDataset in interface AmazonCognitoSync

Parameters:

deleteDatasetRequest - A request to delete the specific dataset.

Returns:

deleteDatasetResult The response from the DeleteDataset service method, as returned by Amazon Cognito Sync.

Throws:

NotAuthorizedException - Thrown when a user is not authorized to access the requested resource.

InvalidParameterException - Thrown when a request parameter does not comply with the associated constraints.

ResourceNotFoundException - Thrown if the resource doesn't exist.

InternalErrorException - Indicates an internal service error.

TooManyRequestsException - Thrown if the request is throttled.

ResourceConflictException - Thrown if an update can't be applied because the resource was changed by another call and this would result in a conflict.

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 Amazon Cognito Sync indicating either a problem with the data in the request, or a server side issue.

describeDataset

public DescribeDatasetResult describeDataset(DescribeDatasetRequest describeDatasetRequest)
                                      throws AmazonServiceException,
                                             AmazonClientException

Deprecated.

Gets meta data about a dataset by identity and dataset name. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data.

This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use Cognito Identity credentials to make this API call.

Specified by:

describeDataset in interface AmazonCognitoSync

Parameters:

describeDatasetRequest - A request for meta data about a dataset (creation date, number of records, size) by owner and dataset name.

Returns:

describeDatasetResult The response from the DescribeDataset service method, as returned by Amazon Cognito Sync.

Throws:

NotAuthorizedException - Thrown when a user is not authorized to access the requested resource.

InvalidParameterException - Thrown when a request parameter does not comply with the associated constraints.

ResourceNotFoundException - Thrown if the resource doesn't exist.

InternalErrorException - Indicates an internal service error.

TooManyRequestsException - Thrown if the request is throttled.

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 Amazon Cognito Sync indicating either a problem with the data in the request, or a server side issue.

listDatasets

public ListDatasetsResult listDatasets(ListDatasetsRequest listDatasetsRequest)
                                throws AmazonServiceException,
                                       AmazonClientException

Deprecated.

Lists datasets for an identity. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data.

ListDatasets can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use the Cognito Identity credentials to make this API call.

Specified by:

listDatasets in interface AmazonCognitoSync

Parameters:

listDatasetsRequest - Request for a list of datasets for an identity.

Returns:

listDatasetsResult The response from the ListDatasets service method, as returned by Amazon Cognito Sync.

Throws:

NotAuthorizedException - Thrown when a user is not authorized to access the requested resource.

InvalidParameterException - Thrown when a request parameter does not comply with the associated constraints.

InternalErrorException - Indicates an internal service error.

TooManyRequestsException - Thrown if the request is throttled.

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 Amazon Cognito Sync indicating either a problem with the data in the request, or a server side issue.

listRecords

public ListRecordsResult listRecords(ListRecordsRequest listRecordsRequest)
                              throws AmazonServiceException,
                                     AmazonClientException

Deprecated.

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

ListRecords can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use Cognito Identity credentials to make this API call.

Specified by:

listRecords in interface AmazonCognitoSync

Parameters:

listRecordsRequest - A request for a list of records.

Returns:

listRecordsResult The response from the ListRecords service method, as returned by Amazon Cognito Sync.

Throws:

InvalidParameterException - Thrown when a request parameter does not comply with the associated constraints.

NotAuthorizedException - Thrown when a user is not authorized to access the requested resource.

TooManyRequestsException - Thrown if the request is throttled.

InternalErrorException - Indicates an internal service error.

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 Amazon Cognito Sync indicating either a problem with the data in the request, or a server side issue.

registerDevice

public RegisterDeviceResult registerDevice(RegisterDeviceRequest registerDeviceRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException

Deprecated.

Registers a device to receive push sync notifications.

This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials.

Specified by:

registerDevice in interface AmazonCognitoSync

Parameters:

registerDeviceRequest -

A request to RegisterDevice.

Returns:

registerDeviceResult The response from the RegisterDevice service method, as returned by Amazon Cognito Sync.

Throws:

NotAuthorizedException - Thrown when a user is not authorized to access the requested resource.

InvalidParameterException - Thrown when a request parameter does not comply with the associated constraints.

ResourceNotFoundException - Thrown if the resource doesn't exist.

InternalErrorException - Indicates an internal service error.

InvalidConfigurationException

TooManyRequestsException - Thrown if the request is throttled.

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 Amazon Cognito Sync indicating either a problem with the data in the request, or a server side issue.

subscribeToDataset

public SubscribeToDatasetResult subscribeToDataset(SubscribeToDatasetRequest subscribeToDatasetRequest)
                                            throws AmazonServiceException,
                                                   AmazonClientException

Deprecated.

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

This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials.

Specified by:

subscribeToDataset in interface AmazonCognitoSync

Parameters:

subscribeToDatasetRequest -

A request to SubscribeToDatasetRequest.

Returns:

subscribeToDatasetResult The response from the SubscribeToDataset service method, as returned by Amazon Cognito Sync.

Throws:

NotAuthorizedException - Thrown when a user is not authorized to access the requested resource.

InvalidParameterException - Thrown when a request parameter does not comply with the associated constraints.

ResourceNotFoundException - Thrown if the resource doesn't exist.

InternalErrorException - Indicates an internal service error.

InvalidConfigurationException

TooManyRequestsException - Thrown if the request is throttled.

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 Amazon Cognito Sync indicating either a problem with the data in the request, or a server side issue.

unsubscribeFromDataset

public UnsubscribeFromDatasetResult unsubscribeFromDataset(UnsubscribeFromDatasetRequest unsubscribeFromDatasetRequest)
                                                    throws AmazonServiceException,
                                                           AmazonClientException

Deprecated.

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

This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials.

Specified by:

unsubscribeFromDataset in interface AmazonCognitoSync

Parameters:

unsubscribeFromDatasetRequest -

A request to UnsubscribeFromDataset.

Returns:

unsubscribeFromDatasetResult The response from the UnsubscribeFromDataset service method, as returned by Amazon Cognito Sync.

Throws:

NotAuthorizedException - Thrown when a user is not authorized to access the requested resource.

InvalidParameterException - Thrown when a request parameter does not comply with the associated constraints.

ResourceNotFoundException - Thrown if the resource doesn't exist.

InternalErrorException - Indicates an internal service error.

InvalidConfigurationException

TooManyRequestsException - Thrown if the request is throttled.

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 Amazon Cognito Sync indicating either a problem with the data in the request, or a server side issue.

updateRecords

public UpdateRecordsResult updateRecords(UpdateRecordsRequest updateRecordsRequest)
                                  throws AmazonServiceException,
                                         AmazonClientException

Deprecated.

Posts updates to records and adds and deletes records for a dataset and user.

The sync count in the record patch is your last known sync count for that record. The server will reject an UpdateRecords request with a ResourceConflictException if you try to patch a record with a new value but a stale sync count.

For example, if the sync count on the server is 5 for a key called highScore and you try and submit a new highScore with sync count of 4, the request will be rejected. To obtain the current sync count for a record, call ListRecords. On a successful update of the record, the response returns the new sync count for that record. You should present that sync count the next time you try to update that same record. When the record does not exist, specify the sync count as 0.

This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials.

Specified by:

updateRecords in interface AmazonCognitoSync

Parameters:

updateRecordsRequest - A request to post updates to records or add and delete records for a dataset and user.

Returns:

updateRecordsResult The response from the UpdateRecords service method, as returned by Amazon Cognito Sync.

Throws:

InvalidParameterException - Thrown when a request parameter does not comply with the associated constraints.

LimitExceededException - Thrown when the limit on the number of objects or operations has been exceeded.

NotAuthorizedException - Thrown when a user is not authorized to access the requested resource.

ResourceNotFoundException - Thrown if the resource doesn't exist.

ResourceConflictException - Thrown if an update can't be applied because the resource was changed by another call and this would result in a conflict.

InvalidLambdaFunctionOutputException -

The AWS Lambda function returned invalid output or an exception.

LambdaThrottledException -

AWS Lambda throttled your account, please contact AWS Support

TooManyRequestsException - Thrown if the request is throttled.

InternalErrorException - Indicates an internal service error.

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 Amazon Cognito Sync indicating either a problem with the data in the request, or a server side issue.

getCachedResponseMetadata

@Deprecated
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Deprecated. ResponseMetadata cache can hold up to 50 requests and responses in memory and will cause memory issue. This method now always returns null.

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.