BulkPublish

$result = $client->bulkPublish([/* ... */]);
$promise = $client->bulkPublishAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->bulkPublish([
    'IdentityPoolId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'IdentityPoolId' => '<string>',
]

Result Details

Errors

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

$result = $client->deleteDataset([/* ... */]);
$promise = $client->deleteDatasetAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteDataset([
    'DatasetName' => '<string>', // REQUIRED
    'IdentityId' => '<string>', // REQUIRED
    'IdentityPoolId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Dataset' => [
        'CreationDate' => <DateTime>,
        'DataStorage' => <integer>,
        'DatasetName' => '<string>',
        'IdentityId' => '<string>',
        'LastModifiedBy' => '<string>',
        'LastModifiedDate' => <DateTime>,
        'NumRecords' => <integer>,
    ],
]

Result Details

Errors

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

$result = $client->describeDataset([/* ... */]);
$promise = $client->describeDatasetAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeDataset([
    'DatasetName' => '<string>', // REQUIRED
    'IdentityId' => '<string>', // REQUIRED
    'IdentityPoolId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Dataset' => [
        'CreationDate' => <DateTime>,
        'DataStorage' => <integer>,
        'DatasetName' => '<string>',
        'IdentityId' => '<string>',
        'LastModifiedBy' => '<string>',
        'LastModifiedDate' => <DateTime>,
        'NumRecords' => <integer>,
    ],
]

Result Details

Errors

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

$result = $client->describeIdentityPoolUsage([/* ... */]);
$promise = $client->describeIdentityPoolUsageAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeIdentityPoolUsage([
    'IdentityPoolId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'IdentityPoolUsage' => [
        'DataStorage' => <integer>,
        'IdentityPoolId' => '<string>',
        'LastModifiedDate' => <DateTime>,
        'SyncSessionsCount' => <integer>,
    ],
]

Result Details

Errors

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

$result = $client->describeIdentityUsage([/* ... */]);
$promise = $client->describeIdentityUsageAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeIdentityUsage([
    'IdentityId' => '<string>', // REQUIRED
    'IdentityPoolId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'IdentityUsage' => [
        'DataStorage' => <integer>,
        'DatasetCount' => <integer>,
        'IdentityId' => '<string>',
        'IdentityPoolId' => '<string>',
        'LastModifiedDate' => <DateTime>,
    ],
]

Result Details

Errors

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

$result = $client->getBulkPublishDetails([/* ... */]);
$promise = $client->getBulkPublishDetailsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getBulkPublishDetails([
    'IdentityPoolId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'BulkPublishCompleteTime' => <DateTime>,
    'BulkPublishStartTime' => <DateTime>,
    'BulkPublishStatus' => 'NOT_STARTED|IN_PROGRESS|FAILED|SUCCEEDED',
    'FailureMessage' => '<string>',
    'IdentityPoolId' => '<string>',
]

Result Details

Errors

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

$result = $client->getCognitoEvents([/* ... */]);
$promise = $client->getCognitoEventsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getCognitoEvents([
    'IdentityPoolId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Events' => ['<string>', ...],
]

Result Details

Errors

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

$result = $client->getIdentityPoolConfiguration([/* ... */]);
$promise = $client->getIdentityPoolConfigurationAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getIdentityPoolConfiguration([
    'IdentityPoolId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CognitoStreams' => [
        'RoleArn' => '<string>',
        'StreamName' => '<string>',
        'StreamingStatus' => 'ENABLED|DISABLED',
    ],
    'IdentityPoolId' => '<string>',
    'PushSync' => [
        'ApplicationArns' => ['<string>', ...],
        'RoleArn' => '<string>',
    ],
]

Result Details

Errors

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

$result = $client->listDatasets([/* ... */]);
$promise = $client->listDatasetsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listDatasets([
    'IdentityId' => '<string>', // REQUIRED
    'IdentityPoolId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Count' => <integer>,
    'Datasets' => [
        [
            'CreationDate' => <DateTime>,
            'DataStorage' => <integer>,
            'DatasetName' => '<string>',
            'IdentityId' => '<string>',
            'LastModifiedBy' => '<string>',
            'LastModifiedDate' => <DateTime>,
            'NumRecords' => <integer>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

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

$result = $client->listIdentityPoolUsage([/* ... */]);
$promise = $client->listIdentityPoolUsageAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listIdentityPoolUsage([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Count' => <integer>,
    'IdentityPoolUsages' => [
        [
            'DataStorage' => <integer>,
            'IdentityPoolId' => '<string>',
            'LastModifiedDate' => <DateTime>,
            'SyncSessionsCount' => <integer>,
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]

Result Details

Errors

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

$result = $client->listRecords([/* ... */]);
$promise = $client->listRecordsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listRecords([
    'DatasetName' => '<string>', // REQUIRED
    'IdentityId' => '<string>', // REQUIRED
    'IdentityPoolId' => '<string>', // REQUIRED
    'LastSyncCount' => <integer>,
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'SyncSessionToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Count' => <integer>,
    'DatasetDeletedAfterRequestedSyncCount' => true || false,
    'DatasetExists' => true || false,
    'DatasetSyncCount' => <integer>,
    'LastModifiedBy' => '<string>',
    'MergedDatasetNames' => ['<string>', ...],
    'NextToken' => '<string>',
    'Records' => [
        [
            'DeviceLastModifiedDate' => <DateTime>,
            'Key' => '<string>',
            'LastModifiedBy' => '<string>',
            'LastModifiedDate' => <DateTime>,
            'SyncCount' => <integer>,
            'Value' => '<string>',
        ],
        // ...
    ],
    'SyncSessionToken' => '<string>',
]

Result Details

Errors

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

$result = $client->registerDevice([/* ... */]);
$promise = $client->registerDeviceAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->registerDevice([
    'IdentityId' => '<string>', // REQUIRED
    'IdentityPoolId' => '<string>', // REQUIRED
    'Platform' => 'APNS|APNS_SANDBOX|GCM|ADM', // REQUIRED
    'Token' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'DeviceId' => '<string>',
]

Result Details

Errors

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:

This error does not currently have a description.

TooManyRequestsException:

Thrown if the request is throttled.

SetCognitoEvents

$result = $client->setCognitoEvents([/* ... */]);
$promise = $client->setCognitoEventsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->setCognitoEvents([
    'Events' => ['<string>', ...], // REQUIRED
    'IdentityPoolId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

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

$result = $client->setIdentityPoolConfiguration([/* ... */]);
$promise = $client->setIdentityPoolConfigurationAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->setIdentityPoolConfiguration([
    'CognitoStreams' => [
        'RoleArn' => '<string>',
        'StreamName' => '<string>',
        'StreamingStatus' => 'ENABLED|DISABLED',
    ],
    'IdentityPoolId' => '<string>', // REQUIRED
    'PushSync' => [
        'ApplicationArns' => ['<string>', ...],
        'RoleArn' => '<string>',
    ],
]);

Parameter Details

Result Syntax

[
    'CognitoStreams' => [
        'RoleArn' => '<string>',
        'StreamName' => '<string>',
        'StreamingStatus' => 'ENABLED|DISABLED',
    ],
    'IdentityPoolId' => '<string>',
    'PushSync' => [
        'ApplicationArns' => ['<string>', ...],
        'RoleArn' => '<string>',
    ],
]

Result Details

Errors

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

$result = $client->subscribeToDataset([/* ... */]);
$promise = $client->subscribeToDatasetAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->subscribeToDataset([
    'DatasetName' => '<string>', // REQUIRED
    'DeviceId' => '<string>', // REQUIRED
    'IdentityId' => '<string>', // REQUIRED
    'IdentityPoolId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

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:

This error does not currently have a description.

TooManyRequestsException:

Thrown if the request is throttled.

UnsubscribeFromDataset

$result = $client->unsubscribeFromDataset([/* ... */]);
$promise = $client->unsubscribeFromDatasetAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->unsubscribeFromDataset([
    'DatasetName' => '<string>', // REQUIRED
    'DeviceId' => '<string>', // REQUIRED
    'IdentityId' => '<string>', // REQUIRED
    'IdentityPoolId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

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:

This error does not currently have a description.

TooManyRequestsException:

Thrown if the request is throttled.

UpdateRecords

$result = $client->updateRecords([/* ... */]);
$promise = $client->updateRecordsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->updateRecords([
    'ClientContext' => '<string>',
    'DatasetName' => '<string>', // REQUIRED
    'DeviceId' => '<string>',
    'IdentityId' => '<string>', // REQUIRED
    'IdentityPoolId' => '<string>', // REQUIRED
    'RecordPatches' => [
        [
            'DeviceLastModifiedDate' => <integer || string || DateTime>,
            'Key' => '<string>', // REQUIRED
            'Op' => 'replace|remove', // REQUIRED
            'SyncCount' => <integer>, // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
    'SyncSessionToken' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Records' => [
        [
            'DeviceLastModifiedDate' => <DateTime>,
            'Key' => '<string>',
            'LastModifiedBy' => '<string>',
            'LastModifiedDate' => <DateTime>,
            'SyncCount' => <integer>,
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

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.