AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Classes

NameDescription
Class AlreadyStreamedException

CognitoSync exception

Class BulkPublishRequest

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.

Class BulkPublishResponse

The output for the BulkPublish operation.

Class CognitoStreams

Configuration options for configure Cognito streams.

Class ConcurrentModificationException

CognitoSync exception

Class Dataset

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.

Class DeleteDatasetRequest

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.

Class DeleteDatasetResponse

Response to a successful DeleteDataset request.

Class DescribeDatasetRequest

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.

Class DescribeDatasetResponse

Response to a successful DescribeDataset request.

Class DescribeIdentityPoolUsageRequest

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.

Class DescribeIdentityPoolUsageResponse

Response to a successful DescribeIdentityPoolUsage request.

Class DescribeIdentityUsageRequest

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.

Class DescribeIdentityUsageResponse

The response to a successful DescribeIdentityUsage request.

Class DuplicateRequestException

CognitoSync exception

Class GetBulkPublishDetailsRequest

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.

Class GetBulkPublishDetailsResponse

The output for the GetBulkPublishDetails operation.

Class GetCognitoEventsRequest

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.

Class GetCognitoEventsResponse

The response from the GetCognitoEvents request

Class GetIdentityPoolConfigurationRequest

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.

Class GetIdentityPoolConfigurationResponse

The output for the GetIdentityPoolConfiguration operation.

Class IdentityPoolUsage

Usage information for the identity pool.

Class IdentityUsage

Usage information for the identity.

Class InternalErrorException

CognitoSync exception

Class InvalidConfigurationException

CognitoSync exception

Class InvalidLambdaFunctionOutputException

CognitoSync exception

Class InvalidParameterException

CognitoSync exception

Class LambdaThrottledException

CognitoSync exception

Class LimitExceededException

CognitoSync exception

Class ListDatasetsRequest

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.

Class ListDatasetsResponse

Returned for a successful ListDatasets request.

Class ListIdentityPoolUsageRequest

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.

Class ListIdentityPoolUsageResponse

Returned for a successful ListIdentityPoolUsage request.

Class ListRecordsRequest

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.

Class ListRecordsResponse

Returned for a successful ListRecordsRequest.

Class NotAuthorizedException

CognitoSync exception

Class PushSync

Configuration options to be applied to the identity pool.

Class Record

The basic data structure of a dataset.

Class RecordPatch

An update operation for a record.

Class RegisterDeviceRequest

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.

Class RegisterDeviceResponse

Response to a RegisterDevice request.

Class ResourceConflictException

CognitoSync exception

Class ResourceNotFoundException

CognitoSync exception

Class SetCognitoEventsRequest

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.

Class SetCognitoEventsResponse

This is the response object from the SetCognitoEvents operation.

Class SetIdentityPoolConfigurationRequest

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.

Class SetIdentityPoolConfigurationResponse

The output for the SetIdentityPoolConfiguration operation

Class SubscribeToDatasetRequest

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.

Class SubscribeToDatasetResponse

Response to a SubscribeToDataset request.

Class TooManyRequestsException

CognitoSync exception

Class UnsubscribeFromDatasetRequest

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.

Class UnsubscribeFromDatasetResponse

Response to an UnsubscribeFromDataset request.

Class UpdateRecordsRequest

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.

Class UpdateRecordsResponse

Returned for a successful UpdateRecordsRequest.