com.amazonaws.services.cognitosync

Interface AmazonCognitoSync

All Known Subinterfaces:

AmazonCognitoSyncAsync

All Known Implementing Classes:

AbstractAmazonCognitoSync, AbstractAmazonCognitoSyncAsync, AmazonCognitoSyncAsyncClient, AmazonCognitoSyncClient

public interface AmazonCognitoSync

Interface for accessing Amazon Cognito Sync.

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.

Method Summary

Methods

Modifier and Type	Method and Description
BulkPublishResult	bulkPublish(BulkPublishRequest bulkPublishRequest) Initiates a bulk publish of all existing datasets for an Identity Pool to the configured stream.
DeleteDatasetResult	deleteDataset(DeleteDatasetRequest deleteDatasetRequest) Deletes the specific dataset.
DescribeDatasetResult	describeDataset(DescribeDatasetRequest describeDatasetRequest) Gets meta data 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.
GetBulkPublishDetailsResult	getBulkPublishDetails(GetBulkPublishDetailsRequest getBulkPublishDetailsRequest) Get the status of the last BulkPublish operation for an identity pool.
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.
GetCognitoEventsResult	getCognitoEvents(GetCognitoEventsRequest getCognitoEventsRequest) Gets the events and the corresponding Lambda functions associated with an identity pool.
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	setCognitoEvents(SetCognitoEventsRequest setCognitoEventsRequest) Sets the AWS Lambda function for a given event type for an identity pool.
void	setEndpoint(String endpoint) Overrides the default endpoint for this client ("https://cognito-sync.us-east-1.amazonaws.com/").
SetIdentityPoolConfigurationResult	setIdentityPoolConfiguration(SetIdentityPoolConfigurationRequest setIdentityPoolConfigurationRequest) Sets the necessary configuration for push sync.
void	setRegion(Region region) An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
SubscribeToDatasetResult	subscribeToDataset(SubscribeToDatasetRequest subscribeToDatasetRequest) Subscribes to receive notifications when a dataset is modified by another device.
UnsubscribeFromDatasetResult	unsubscribeFromDataset(UnsubscribeFromDatasetRequest unsubscribeFromDatasetRequest) Unsubscribes from receiving notifications when a dataset is modified by another device.
UpdateRecordsResult	updateRecords(UpdateRecordsRequest updateRecordsRequest) Posts updates to records and adds and deletes records for a dataset and user.

Method Detail

setEndpoint

void setEndpoint(String endpoint)

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.

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.

setRegion

void setRegion(Region region)

An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.

By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.

This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.

See Also:

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

bulkPublish

BulkPublishResult bulkPublish(BulkPublishRequest bulkPublishRequest)

Initiates a bulk publish of all existing datasets for an Identity Pool to the configured stream. Customers are limited to one successful bulk publish per 24 hours. Bulk publish is an asynchronous request, customers can see the status of the request via the GetBulkPublishDetails operation.

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

Parameters:

bulkPublishRequest - The input for the BulkPublish operation.

Returns:

Result of the BulkPublish operation returned by the service.

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.

DuplicateRequestException - An exception thrown when there is an IN_PROGRESS bulk publish operation for the given identity pool.

AlreadyStreamedException - An exception thrown when a bulk publish operation is requested less than 24 hours after a previous bulk publish operation completed successfully.

deleteDataset

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

Parameters:

deleteDatasetRequest - A request to delete the specific dataset.

Returns:

Result of the DeleteDataset operation returned by the service.

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.

describeDataset

DescribeDatasetResult describeDataset(DescribeDatasetRequest describeDatasetRequest)

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.

Parameters:

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

Returns:

Result of the DescribeDataset operation returned by the service.

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.

describeIdentityPoolUsage

DescribeIdentityPoolUsageResult describeIdentityPoolUsage(DescribeIdentityPoolUsageRequest describeIdentityPoolUsageRequest)

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

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

Parameters:

describeIdentityPoolUsageRequest - A request for usage information about the identity pool.

Returns:

Result of the DescribeIdentityPoolUsage operation returned by the service.

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.

describeIdentityUsage

DescribeIdentityUsageResult describeIdentityUsage(DescribeIdentityUsageRequest describeIdentityUsageRequest)

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

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

Parameters:

describeIdentityUsageRequest - A request for information about the usage of an identity pool.

Returns:

Result of the DescribeIdentityUsage operation returned by the service.

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.

getBulkPublishDetails

GetBulkPublishDetailsResult getBulkPublishDetails(GetBulkPublishDetailsRequest getBulkPublishDetailsRequest)

Get the status of the last BulkPublish operation for an identity pool.

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

Parameters:

getBulkPublishDetailsRequest - The input for the GetBulkPublishDetails operation.

Returns:

Result of the GetBulkPublishDetails operation returned by the service.

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.

getCognitoEvents

GetCognitoEventsResult getCognitoEvents(GetCognitoEventsRequest getCognitoEventsRequest)

Gets the events and the corresponding Lambda functions associated with an identity pool.

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

Parameters:

getCognitoEventsRequest - A request for a list of the configured Cognito Events

Returns:

Result of the GetCognitoEvents operation returned by the service.

Throws:

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

ResourceNotFoundException - Thrown if the resource doesn't exist.

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

InternalErrorException - Indicates an internal service error.

TooManyRequestsException - Thrown if the request is throttled.

getIdentityPoolConfiguration

GetIdentityPoolConfigurationResult getIdentityPoolConfiguration(GetIdentityPoolConfigurationRequest getIdentityPoolConfigurationRequest)

Gets the configuration settings of an identity pool.

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

Parameters:

getIdentityPoolConfigurationRequest - The input for the GetIdentityPoolConfiguration operation.

Returns:

Result of the GetIdentityPoolConfiguration operation returned by the service.

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.

listDatasets

ListDatasetsResult listDatasets(ListDatasetsRequest listDatasetsRequest)

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.

Parameters:

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

Returns:

Result of the ListDatasets operation returned by the service.

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.

listIdentityPoolUsage

ListIdentityPoolUsageResult listIdentityPoolUsage(ListIdentityPoolUsageRequest listIdentityPoolUsageRequest)

Gets a list of identity pools registered with Cognito.

ListIdentityPoolUsage can only be called with developer credentials. You cannot make this API call with the temporary user credentials provided by Cognito Identity.

Parameters:

listIdentityPoolUsageRequest - A request for usage information on an identity pool.

Returns:

Result of the ListIdentityPoolUsage operation returned by the service.

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.

listRecords

ListRecordsResult listRecords(ListRecordsRequest listRecordsRequest)

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.

Parameters:

listRecordsRequest - A request for a list of records.

Returns:

Result of the ListRecords operation returned by the service.

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.

registerDevice

RegisterDeviceResult registerDevice(RegisterDeviceRequest registerDeviceRequest)

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.

Parameters:

registerDeviceRequest - A request to RegisterDevice.

Returns:

Result of the RegisterDevice operation returned by the service.

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.

setCognitoEvents

void setCognitoEvents(SetCognitoEventsRequest setCognitoEventsRequest)

Sets the AWS Lambda function for a given event type for an identity pool. This request only updates the key/value pair specified. Other key/values pairs are not updated. To remove a key value pair, pass a empty value for the particular key.

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

Parameters:

setCognitoEventsRequest - A request to configure Cognito Events"

Throws:

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

ResourceNotFoundException - Thrown if the resource doesn't exist.

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

InternalErrorException - Indicates an internal service error.

TooManyRequestsException - Thrown if the request is throttled.

setIdentityPoolConfiguration

SetIdentityPoolConfigurationResult setIdentityPoolConfiguration(SetIdentityPoolConfigurationRequest setIdentityPoolConfigurationRequest)

Sets the necessary configuration for push sync.

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

Parameters:

setIdentityPoolConfigurationRequest - The input for the SetIdentityPoolConfiguration operation.

Returns:

Result of the SetIdentityPoolConfiguration operation returned by the service.

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.

ConcurrentModificationException - Thrown if there are parallel requests to modify a resource.

subscribeToDataset

SubscribeToDatasetResult subscribeToDataset(SubscribeToDatasetRequest subscribeToDatasetRequest)

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.

Parameters:

subscribeToDatasetRequest - A request to SubscribeToDatasetRequest.

Returns:

Result of the SubscribeToDataset operation returned by the service.

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.

unsubscribeFromDataset

UnsubscribeFromDatasetResult unsubscribeFromDataset(UnsubscribeFromDatasetRequest unsubscribeFromDatasetRequest)

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.

Parameters:

unsubscribeFromDatasetRequest - A request to UnsubscribeFromDataset.

Returns:

Result of the UnsubscribeFromDataset operation returned by the service.

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.

updateRecords

UpdateRecordsResult updateRecords(UpdateRecordsRequest updateRecordsRequest)

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.

Parameters:

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

Returns:

Result of the UpdateRecords operation returned by the service.

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.

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

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