CognitoSyncClient Class

Member Function Documentation

CognitoSyncClient::CognitoSyncClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

Constructs a CognitoSyncClient object.

The new client object will region, credentials, and manager for network operations.

The new object will be owned by parent, if set.

CognitoSyncClient::CognitoSyncClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

This function overloads CognitoSyncClient().

This overload allows the caller to specify the specific endpoint to send requests to. Typically, it is easier to use the alternative constructor, which allows the caller to specify an AWS region instead, in which case this client will determine the correct endpoint for the given region automatically (via AwsEndpoint::getEndpoint).

See also QtAws::Core::AwsEndpoint::getEndpoint.

[slot] BulkPublishResponse *CognitoSyncClient::bulkPublish(const BulkPublishRequest &request)

Sends request to the CognitoSyncClient service, and returns a pointer to an BulkPublishResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] DeleteDatasetResponse *CognitoSyncClient::deleteDataset(const DeleteDatasetRequest &request)

Sends request to the CognitoSyncClient service, and returns a pointer to an DeleteDatasetResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] DescribeDatasetResponse *CognitoSyncClient::describeDataset(const DescribeDatasetRequest &request)

Sends request to the CognitoSyncClient service, and returns a pointer to an DescribeDatasetResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] DescribeIdentityPoolUsageResponse *CognitoSyncClient::describeIdentityPoolUsage(const DescribeIdentityPoolUsageRequest &request)

Sends request to the CognitoSyncClient service, and returns a pointer to an DescribeIdentityPoolUsageResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] DescribeIdentityUsageResponse *CognitoSyncClient::describeIdentityUsage(const DescribeIdentityUsageRequest &request)

Sends request to the CognitoSyncClient service, and returns a pointer to an DescribeIdentityUsageResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] GetBulkPublishDetailsResponse *CognitoSyncClient::getBulkPublishDetails(const GetBulkPublishDetailsRequest &request)

Sends request to the CognitoSyncClient service, and returns a pointer to an GetBulkPublishDetailsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] GetCognitoEventsResponse *CognitoSyncClient::getCognitoEvents(const GetCognitoEventsRequest &request)

Sends request to the CognitoSyncClient service, and returns a pointer to an GetCognitoEventsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] GetIdentityPoolConfigurationResponse *CognitoSyncClient::getIdentityPoolConfiguration(const GetIdentityPoolConfigurationRequest &request)

Sends request to the CognitoSyncClient service, and returns a pointer to an GetIdentityPoolConfigurationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] ListDatasetsResponse *CognitoSyncClient::listDatasets(const ListDatasetsRequest &request)

Sends request to the CognitoSyncClient service, and returns a pointer to an ListDatasetsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] ListIdentityPoolUsageResponse *CognitoSyncClient::listIdentityPoolUsage(const ListIdentityPoolUsageRequest &request)

Sends request to the CognitoSyncClient service, and returns a pointer to an ListIdentityPoolUsageResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] ListRecordsResponse *CognitoSyncClient::listRecords(const ListRecordsRequest &request)

Sends request to the CognitoSyncClient service, and returns a pointer to an ListRecordsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] RegisterDeviceResponse *CognitoSyncClient::registerDevice(const RegisterDeviceRequest &request)

Sends request to the CognitoSyncClient service, and returns a pointer to an RegisterDeviceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] SetCognitoEventsResponse *CognitoSyncClient::setCognitoEvents(const SetCognitoEventsRequest &request)

Sends request to the CognitoSyncClient service, and returns a pointer to an SetCognitoEventsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] SetIdentityPoolConfigurationResponse *CognitoSyncClient::setIdentityPoolConfiguration(const SetIdentityPoolConfigurationRequest &request)

Sends request to the CognitoSyncClient service, and returns a pointer to an SetIdentityPoolConfigurationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] SubscribeToDatasetResponse *CognitoSyncClient::subscribeToDataset(const SubscribeToDatasetRequest &request)

Sends request to the CognitoSyncClient service, and returns a pointer to an SubscribeToDatasetResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] UnsubscribeFromDatasetResponse *CognitoSyncClient::unsubscribeFromDataset(const UnsubscribeFromDatasetRequest &request)

Sends request to the CognitoSyncClient service, and returns a pointer to an UnsubscribeFromDatasetResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] UpdateRecordsResponse *CognitoSyncClient::updateRecords(const UpdateRecordsRequest &request)

Sends request to the CognitoSyncClient service, and returns a pointer to an UpdateRecordsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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