public class AbstractAmazonCognitoSync extends Object implements AmazonCognitoSync
AmazonCognitoSync. Convenient method forms
pass through to the corresponding overload that takes a request object, which
throws an UnsupportedOperationException.| Modifier and Type | Method and Description |
|---|---|
BulkPublishResult |
bulkPublish(BulkPublishRequest request)
Initiates a bulk publish of all existing datasets for an Identity Pool to
the configured stream.
|
DeleteDatasetResult |
deleteDataset(DeleteDatasetRequest request)
Deletes the specific dataset.
|
DescribeDatasetResult |
describeDataset(DescribeDatasetRequest request)
Gets meta data about a dataset by identity and dataset name.
|
DescribeIdentityPoolUsageResult |
describeIdentityPoolUsage(DescribeIdentityPoolUsageRequest request)
Gets usage details (for example, data storage) about a particular
identity pool.
|
DescribeIdentityUsageResult |
describeIdentityUsage(DescribeIdentityUsageRequest request)
Gets usage information for an identity, including number of datasets and
data usage.
|
GetBulkPublishDetailsResult |
getBulkPublishDetails(GetBulkPublishDetailsRequest request)
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 request)
Gets the events and the corresponding Lambda functions associated with an
identity pool.
|
GetIdentityPoolConfigurationResult |
getIdentityPoolConfiguration(GetIdentityPoolConfigurationRequest request)
Gets the configuration settings of an identity pool.
|
ListDatasetsResult |
listDatasets(ListDatasetsRequest request)
Lists datasets for an identity.
|
ListIdentityPoolUsageResult |
listIdentityPoolUsage(ListIdentityPoolUsageRequest request)
Gets a list of identity pools registered with Cognito.
|
ListRecordsResult |
listRecords(ListRecordsRequest request)
Gets paginated records, optionally changed after a particular sync count
for a dataset and identity.
|
RegisterDeviceResult |
registerDevice(RegisterDeviceRequest request)
Registers a device to receive push sync notifications.
|
void |
setCognitoEvents(SetCognitoEventsRequest request)
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 request)
Sets the necessary configuration for push sync.
|
void |
setRegion(Region region)
An alternative to
AmazonCognitoSync.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 request)
Subscribes to receive notifications when a dataset is modified by another
device.
|
UnsubscribeFromDatasetResult |
unsubscribeFromDataset(UnsubscribeFromDatasetRequest request)
Unsubscribes from receiving notifications when a dataset is modified by
another device.
|
UpdateRecordsResult |
updateRecords(UpdateRecordsRequest request)
Posts updates to records and adds and deletes records for a dataset and
user.
|
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 AmazonCognitoSyncendpoint - 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 setRegion(Region region)
AmazonCognitoSyncAmazonCognitoSync.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.
setRegion in interface AmazonCognitoSyncregion - 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.Region.getRegion(com.amazonaws.regions.Regions),
Region.createClient(Class,
com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration),
Region.isServiceSupported(String)public BulkPublishResult bulkPublish(BulkPublishRequest request)
AmazonCognitoSyncInitiates 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.
bulkPublish in interface AmazonCognitoSyncrequest - The input for the BulkPublish operation.public DeleteDatasetResult deleteDataset(DeleteDatasetRequest request)
AmazonCognitoSyncDeletes 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.
deleteDataset in interface AmazonCognitoSyncrequest - A request to delete the specific dataset.public DescribeDatasetResult describeDataset(DescribeDatasetRequest request)
AmazonCognitoSyncGets 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.
describeDataset in interface AmazonCognitoSyncrequest - A request for meta data about a dataset (creation date, number of
records, size) by owner and dataset name.public DescribeIdentityPoolUsageResult describeIdentityPoolUsage(DescribeIdentityPoolUsageRequest request)
AmazonCognitoSyncGets 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.
describeIdentityPoolUsage in interface AmazonCognitoSyncrequest - A request for usage information about the identity pool.public DescribeIdentityUsageResult describeIdentityUsage(DescribeIdentityUsageRequest request)
AmazonCognitoSyncGets 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.
describeIdentityUsage in interface AmazonCognitoSyncrequest - A request for information about the usage of an identity pool.public GetBulkPublishDetailsResult getBulkPublishDetails(GetBulkPublishDetailsRequest request)
AmazonCognitoSyncGet 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.
getBulkPublishDetails in interface AmazonCognitoSyncrequest - The input for the GetBulkPublishDetails operation.public GetCognitoEventsResult getCognitoEvents(GetCognitoEventsRequest request)
AmazonCognitoSyncGets 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.
getCognitoEvents in interface AmazonCognitoSyncrequest - A request for a list of the configured Cognito Eventspublic GetIdentityPoolConfigurationResult getIdentityPoolConfiguration(GetIdentityPoolConfigurationRequest request)
AmazonCognitoSyncGets 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.
getIdentityPoolConfiguration in interface AmazonCognitoSyncrequest - The input for the GetIdentityPoolConfiguration operation.public ListDatasetsResult listDatasets(ListDatasetsRequest request)
AmazonCognitoSyncLists 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.
listDatasets in interface AmazonCognitoSyncrequest - Request for a list of datasets for an identity.public ListIdentityPoolUsageResult listIdentityPoolUsage(ListIdentityPoolUsageRequest request)
AmazonCognitoSyncGets 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.
listIdentityPoolUsage in interface AmazonCognitoSyncrequest - A request for usage information on an identity pool.public ListRecordsResult listRecords(ListRecordsRequest request)
AmazonCognitoSyncGets 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.
listRecords in interface AmazonCognitoSyncrequest - A request for a list of records.public RegisterDeviceResult registerDevice(RegisterDeviceRequest request)
AmazonCognitoSyncRegisters 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.
registerDevice in interface AmazonCognitoSyncrequest - A request to RegisterDevice.public void setCognitoEvents(SetCognitoEventsRequest request)
AmazonCognitoSyncSets 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.
setCognitoEvents in interface AmazonCognitoSyncrequest - A request to configure Cognito Events"public SetIdentityPoolConfigurationResult setIdentityPoolConfiguration(SetIdentityPoolConfigurationRequest request)
AmazonCognitoSyncSets 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.
setIdentityPoolConfiguration in interface AmazonCognitoSyncrequest - The input for the SetIdentityPoolConfiguration operation.public SubscribeToDatasetResult subscribeToDataset(SubscribeToDatasetRequest request)
AmazonCognitoSyncSubscribes 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.
subscribeToDataset in interface AmazonCognitoSyncrequest - A request to SubscribeToDatasetRequest.public UnsubscribeFromDatasetResult unsubscribeFromDataset(UnsubscribeFromDatasetRequest request)
AmazonCognitoSyncUnsubscribes 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.
unsubscribeFromDataset in interface AmazonCognitoSyncrequest - A request to UnsubscribeFromDataset.public UpdateRecordsResult updateRecords(UpdateRecordsRequest request)
AmazonCognitoSyncPosts 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.
updateRecords in interface AmazonCognitoSyncrequest - A request to post updates to records or add and delete records for
a dataset and user.public void shutdown()
AmazonCognitoSyncshutdown in interface AmazonCognitoSyncpublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonCognitoSyncResponse 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.
getCachedResponseMetadata in interface AmazonCognitoSyncrequest - The originally executed request.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.