Amazon.CognitoSync.Model

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

Container for the parameters to the BulkPublish operation. 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.

The output for the BulkPublish operation.

Configuration options for configure Cognito streams.

Thrown if there are parallel requests to modify a resource.

A collection of data for an identity pool. An identity pool can have multiple datasets. A dataset is per identity and can be general or associated with a particular entity in an application (like a saved game). Datasets are automatically created if they don't exist. Data is synced by dataset, and a dataset can hold up to 1MB of key-value pairs.

Container for the parameters to the DeleteDataset operation. 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.

Response to a successful DeleteDataset request.

Container for the parameters to the DescribeDataset operation. 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.

Response to a successful DescribeDataset request.

Container for the parameters to the DescribeIdentityPoolUsage operation. 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.

Response to a successful DescribeIdentityPoolUsage request.

Container for the parameters to the DescribeIdentityUsage operation. 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.

The response to a successful DescribeIdentityUsage request.

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

Container for the parameters to the GetBulkPublishDetails operation. 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.

The output for the GetBulkPublishDetails operation.

Container for the parameters to the GetCognitoEvents operation. 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.

The response from the GetCognitoEvents request

Container for the parameters to the GetIdentityPoolConfiguration operation. 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.

The output for the GetIdentityPoolConfiguration operation.

Usage information for the identity pool.

Usage information for the identity.

Indicates an internal service error.

The AWS Lambda function returned invalid output or an exception.

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

AWS Lambda throttled your account, please contact AWS Support

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

Container for the parameters to the ListDatasets operation. 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.

Returned for a successful ListDatasets request.

Container for the parameters to the ListIdentityPoolUsage operation. 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.

Returned for a successful ListIdentityPoolUsage request.

Container for the parameters to the ListRecords operation. 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.

Returned for a successful ListRecordsRequest.

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

Configuration options to be applied to the identity pool.

The basic data structure of a dataset.

An update operation for a record.

Container for the parameters to the RegisterDevice operation. 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.

Response to a RegisterDevice request.

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

Thrown if the resource doesn't exist.

Container for the parameters to the SetCognitoEvents operation. 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.

This is the response object from the SetCognitoEvents operation.

Container for the parameters to the SetIdentityPoolConfiguration operation. 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.

The output for the SetIdentityPoolConfiguration operation

Container for the parameters to the SubscribeToDataset operation. 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.

Response to a SubscribeToDataset request.

Thrown if the request is throttled.

Container for the parameters to the UnsubscribeFromDataset operation. 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.

Response to an UnsubscribeFromDataset request.

Container for the parameters to the UpdateRecords operation. 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.

Returned for a successful UpdateRecordsRequest.