# Actions
<a name="API_Operations"></a>

The following actions are supported:
+  [BulkPublish](API_BulkPublish.md) 
+  [DeleteDataset](API_DeleteDataset.md) 
+  [DescribeDataset](API_DescribeDataset.md) 
+  [DescribeIdentityPoolUsage](API_DescribeIdentityPoolUsage.md) 
+  [DescribeIdentityUsage](API_DescribeIdentityUsage.md) 
+  [GetBulkPublishDetails](API_GetBulkPublishDetails.md) 
+  [GetCognitoEvents](API_GetCognitoEvents.md) 
+  [GetIdentityPoolConfiguration](API_GetIdentityPoolConfiguration.md) 
+  [ListDatasets](API_ListDatasets.md) 
+  [ListIdentityPoolUsage](API_ListIdentityPoolUsage.md) 
+  [ListRecords](API_ListRecords.md) 
+  [RegisterDevice](API_RegisterDevice.md) 
+  [SetCognitoEvents](API_SetCognitoEvents.md) 
+  [SetIdentityPoolConfiguration](API_SetIdentityPoolConfiguration.md) 
+  [SubscribeToDataset](API_SubscribeToDataset.md) 
+  [UnsubscribeFromDataset](API_UnsubscribeFromDataset.md) 
+  [UpdateRecords](API_UpdateRecords.md) 

# BulkPublish
<a name="API_BulkPublish"></a>

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.

## Request Syntax
<a name="API_BulkPublish_RequestSyntax"></a>

```
POST /identitypools/IdentityPoolId/bulkpublish HTTP/1.1
```

## URI Request Parameters
<a name="API_BulkPublish_RequestParameters"></a>

The request uses the following URI parameters.

 ** [IdentityPoolId](#API_BulkPublish_RequestSyntax) **   <a name="Cognito-BulkPublish-request-uri-IdentityPoolId"></a>
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.  
Length Constraints: Minimum length of 1. Maximum length of 55.  
Pattern: `[\w-]+:[0-9a-f-]+`   
Required: Yes

## Request Body
<a name="API_BulkPublish_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_BulkPublish_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "IdentityPoolId": "string"
}
```

## Response Elements
<a name="API_BulkPublish_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [IdentityPoolId](#API_BulkPublish_ResponseSyntax) **   <a name="Cognito-BulkPublish-response-IdentityPoolId"></a>
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 55.  
Pattern: `[\w-]+:[0-9a-f-]+` 

## Errors
<a name="API_BulkPublish_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AlreadyStreamedException **   
An exception thrown when a bulk publish operation is requested less than 24 hours after a previous bulk publish operation completed successfully.    
 ** message **   
The message associated with the AlreadyStreamedException exception.
HTTP Status Code: 400

 ** DuplicateRequestException **   
An exception thrown when there is an IN\$1PROGRESS bulk publish operation for the given identity pool.    
 ** message **   
The message associated with the DuplicateRequestException exception.
HTTP Status Code: 400

 ** InternalErrorException **   
Indicates an internal service error.    
 ** message **   
Message returned by InternalErrorException.
HTTP Status Code: 500

 ** InvalidParameterException **   
Thrown when a request parameter does not comply with the associated constraints.    
 ** message **   
Message returned by InvalidParameterException.
HTTP Status Code: 400

 ** NotAuthorizedException **   
Thrown when a user is not authorized to access the requested resource.    
 ** message **   
The message returned by a NotAuthorizedException.
HTTP Status Code: 403

 ** ResourceNotFoundException **   
Thrown if the resource doesn't exist.    
 ** message **   
Message returned by a ResourceNotFoundException.
HTTP Status Code: 404

## See Also
<a name="API_BulkPublish_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cognito-sync-2014-06-30/BulkPublish) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cognito-sync-2014-06-30/BulkPublish) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cognito-sync-2014-06-30/BulkPublish) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cognito-sync-2014-06-30/BulkPublish) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cognito-sync-2014-06-30/BulkPublish) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cognito-sync-2014-06-30/BulkPublish) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cognito-sync-2014-06-30/BulkPublish) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cognito-sync-2014-06-30/BulkPublish) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cognito-sync-2014-06-30/BulkPublish) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cognito-sync-2014-06-30/BulkPublish) 

# DeleteDataset
<a name="API_DeleteDataset"></a>

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.

## Request Syntax
<a name="API_DeleteDataset_RequestSyntax"></a>

```
DELETE /identitypools/IdentityPoolId/identities/IdentityId/datasets/DatasetName HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteDataset_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DatasetName](#API_DeleteDataset_RequestSyntax) **   <a name="Cognito-DeleteDataset-request-uri-DatasetName"></a>
A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '\$1' (underscore), '-' (dash), and '.' (dot).   
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9_.:-]+`   
Required: Yes

 ** [IdentityId](#API_DeleteDataset_RequestSyntax) **   <a name="Cognito-DeleteDataset-request-uri-IdentityId"></a>
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.  
Length Constraints: Minimum length of 1. Maximum length of 55.  
Pattern: `[\w-]+:[0-9a-f-]+`   
Required: Yes

 ** [IdentityPoolId](#API_DeleteDataset_RequestSyntax) **   <a name="Cognito-DeleteDataset-request-uri-IdentityPoolId"></a>
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.  
Length Constraints: Minimum length of 1. Maximum length of 55.  
Pattern: `[\w-]+:[0-9a-f-]+`   
Required: Yes

## Request Body
<a name="API_DeleteDataset_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteDataset_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Dataset": { 
      "CreationDate": number,
      "DatasetName": "string",
      "DataStorage": number,
      "IdentityId": "string",
      "LastModifiedBy": "string",
      "LastModifiedDate": number,
      "NumRecords": number
   }
}
```

## Response Elements
<a name="API_DeleteDataset_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Dataset](#API_DeleteDataset_ResponseSyntax) **   <a name="Cognito-DeleteDataset-response-Dataset"></a>
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.  
Type: [Dataset](API_Dataset.md) object

## Errors
<a name="API_DeleteDataset_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalErrorException **   
Indicates an internal service error.    
 ** message **   
Message returned by InternalErrorException.
HTTP Status Code: 500

 ** InvalidParameterException **   
Thrown when a request parameter does not comply with the associated constraints.    
 ** message **   
Message returned by InvalidParameterException.
HTTP Status Code: 400

 ** NotAuthorizedException **   
Thrown when a user is not authorized to access the requested resource.    
 ** message **   
The message returned by a NotAuthorizedException.
HTTP Status Code: 403

 ** ResourceConflictException **   
Thrown if an update can't be applied because the resource was changed by another call and this would result in a conflict.    
 ** message **   
The message returned by a ResourceConflictException.
HTTP Status Code: 409

 ** ResourceNotFoundException **   
Thrown if the resource doesn't exist.    
 ** message **   
Message returned by a ResourceNotFoundException.
HTTP Status Code: 404

 ** TooManyRequestsException **   
Thrown if the request is throttled.    
 ** message **   
Message returned by a TooManyRequestsException.
HTTP Status Code: 429

## See Also
<a name="API_DeleteDataset_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cognito-sync-2014-06-30/DeleteDataset) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cognito-sync-2014-06-30/DeleteDataset) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cognito-sync-2014-06-30/DeleteDataset) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cognito-sync-2014-06-30/DeleteDataset) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cognito-sync-2014-06-30/DeleteDataset) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cognito-sync-2014-06-30/DeleteDataset) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cognito-sync-2014-06-30/DeleteDataset) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cognito-sync-2014-06-30/DeleteDataset) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cognito-sync-2014-06-30/DeleteDataset) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cognito-sync-2014-06-30/DeleteDataset) 

# DescribeDataset
<a name="API_DescribeDataset"></a>

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.

## Request Syntax
<a name="API_DescribeDataset_RequestSyntax"></a>

```
GET /identitypools/IdentityPoolId/identities/IdentityId/datasets/DatasetName HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeDataset_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DatasetName](#API_DescribeDataset_RequestSyntax) **   <a name="Cognito-DescribeDataset-request-uri-DatasetName"></a>
A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '\$1' (underscore), '-' (dash), and '.' (dot).  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9_.:-]+`   
Required: Yes

 ** [IdentityId](#API_DescribeDataset_RequestSyntax) **   <a name="Cognito-DescribeDataset-request-uri-IdentityId"></a>
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.  
Length Constraints: Minimum length of 1. Maximum length of 55.  
Pattern: `[\w-]+:[0-9a-f-]+`   
Required: Yes

 ** [IdentityPoolId](#API_DescribeDataset_RequestSyntax) **   <a name="Cognito-DescribeDataset-request-uri-IdentityPoolId"></a>
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.  
Length Constraints: Minimum length of 1. Maximum length of 55.  
Pattern: `[\w-]+:[0-9a-f-]+`   
Required: Yes

## Request Body
<a name="API_DescribeDataset_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeDataset_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Dataset": { 
      "CreationDate": number,
      "DatasetName": "string",
      "DataStorage": number,
      "IdentityId": "string",
      "LastModifiedBy": "string",
      "LastModifiedDate": number,
      "NumRecords": number
   }
}
```

## Response Elements
<a name="API_DescribeDataset_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Dataset](#API_DescribeDataset_ResponseSyntax) **   <a name="Cognito-DescribeDataset-response-Dataset"></a>
Metadata for a collection of data for an identity. An identity can have multiple datasets. A dataset 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  
Type: [Dataset](API_Dataset.md) object

## Errors
<a name="API_DescribeDataset_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalErrorException **   
Indicates an internal service error.    
 ** message **   
Message returned by InternalErrorException.
HTTP Status Code: 500

 ** InvalidParameterException **   
Thrown when a request parameter does not comply with the associated constraints.    
 ** message **   
Message returned by InvalidParameterException.
HTTP Status Code: 400

 ** NotAuthorizedException **   
Thrown when a user is not authorized to access the requested resource.    
 ** message **   
The message returned by a NotAuthorizedException.
HTTP Status Code: 403

 ** ResourceNotFoundException **   
Thrown if the resource doesn't exist.    
 ** message **   
Message returned by a ResourceNotFoundException.
HTTP Status Code: 404

 ** TooManyRequestsException **   
Thrown if the request is throttled.    
 ** message **   
Message returned by a TooManyRequestsException.
HTTP Status Code: 429

## See Also
<a name="API_DescribeDataset_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cognito-sync-2014-06-30/DescribeDataset) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cognito-sync-2014-06-30/DescribeDataset) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cognito-sync-2014-06-30/DescribeDataset) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cognito-sync-2014-06-30/DescribeDataset) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cognito-sync-2014-06-30/DescribeDataset) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cognito-sync-2014-06-30/DescribeDataset) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cognito-sync-2014-06-30/DescribeDataset) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cognito-sync-2014-06-30/DescribeDataset) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cognito-sync-2014-06-30/DescribeDataset) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cognito-sync-2014-06-30/DescribeDataset) 

# DescribeIdentityPoolUsage
<a name="API_DescribeIdentityPoolUsage"></a>

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.

## Request Syntax
<a name="API_DescribeIdentityPoolUsage_RequestSyntax"></a>

```
GET /identitypools/IdentityPoolId HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeIdentityPoolUsage_RequestParameters"></a>

The request uses the following URI parameters.

 ** [IdentityPoolId](#API_DescribeIdentityPoolUsage_RequestSyntax) **   <a name="Cognito-DescribeIdentityPoolUsage-request-uri-IdentityPoolId"></a>
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.  
Length Constraints: Minimum length of 1. Maximum length of 55.  
Pattern: `[\w-]+:[0-9a-f-]+`   
Required: Yes

## Request Body
<a name="API_DescribeIdentityPoolUsage_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeIdentityPoolUsage_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "IdentityPoolUsage": { 
      "DataStorage": number,
      "IdentityPoolId": "string",
      "LastModifiedDate": number,
      "SyncSessionsCount": number
   }
}
```

## Response Elements
<a name="API_DescribeIdentityPoolUsage_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [IdentityPoolUsage](#API_DescribeIdentityPoolUsage_ResponseSyntax) **   <a name="Cognito-DescribeIdentityPoolUsage-response-IdentityPoolUsage"></a>
Information about the usage of the identity pool.  
Type: [IdentityPoolUsage](API_IdentityPoolUsage.md) object

## Errors
<a name="API_DescribeIdentityPoolUsage_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalErrorException **   
Indicates an internal service error.    
 ** message **   
Message returned by InternalErrorException.
HTTP Status Code: 500

 ** InvalidParameterException **   
Thrown when a request parameter does not comply with the associated constraints.    
 ** message **   
Message returned by InvalidParameterException.
HTTP Status Code: 400

 ** NotAuthorizedException **   
Thrown when a user is not authorized to access the requested resource.    
 ** message **   
The message returned by a NotAuthorizedException.
HTTP Status Code: 403

 ** ResourceNotFoundException **   
Thrown if the resource doesn't exist.    
 ** message **   
Message returned by a ResourceNotFoundException.
HTTP Status Code: 404

 ** TooManyRequestsException **   
Thrown if the request is throttled.    
 ** message **   
Message returned by a TooManyRequestsException.
HTTP Status Code: 429

## Examples
<a name="API_DescribeIdentityPoolUsage_Examples"></a>

### DescribeIdentityPoolUsage
<a name="API_DescribeIdentityPoolUsage_Example_1"></a>

The following examples have been edited for readability.

#### Sample Request
<a name="API_DescribeIdentityPoolUsage_Example_1_Request"></a>

```
POST / HTTP/1.1
CONTENT-TYPE: application/json
X-AMZN-REQUESTID: 8dc0e749-c8cd-48bd-8520-da6be00d528b
X-AMZ-TARGET: com.amazonaws.cognito.sync.model.AWSCognitoSyncService.DescribeIdentityPoolUsage
HOST: cognito-sync.us-east-1.amazonaws.com:443
X-AMZ-DATE: 20141111T205737Z
AUTHORIZATION: AWS4-HMAC-SHA256 Credential=<credential>, SignedHeaders=content-type;host;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<signature>
 
{
    "IdentityPoolId": "IDENTITY_POOL_ID"
}
```

#### Sample Response
<a name="API_DescribeIdentityPoolUsage_Example_1_Response"></a>

```
1.1 200 OK
x-amzn-requestid: 8dc0e749-c8cd-48bd-8520-da6be00d528b
content-type: application/json
content-length: 271
date: Tue, 11 Nov 2014 20:57:37 GMT
 
{
    "IdentityPoolUsage":
    {
        "DataStorage": 0,
        "IdentityPoolId": "IDENTITY_POOL_ID",
        "LastModifiedDate": 1.413231134115E9,
        "SyncSessionsCount": null
    }
}
```

## See Also
<a name="API_DescribeIdentityPoolUsage_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cognito-sync-2014-06-30/DescribeIdentityPoolUsage) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cognito-sync-2014-06-30/DescribeIdentityPoolUsage) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cognito-sync-2014-06-30/DescribeIdentityPoolUsage) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cognito-sync-2014-06-30/DescribeIdentityPoolUsage) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cognito-sync-2014-06-30/DescribeIdentityPoolUsage) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cognito-sync-2014-06-30/DescribeIdentityPoolUsage) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cognito-sync-2014-06-30/DescribeIdentityPoolUsage) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cognito-sync-2014-06-30/DescribeIdentityPoolUsage) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cognito-sync-2014-06-30/DescribeIdentityPoolUsage) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cognito-sync-2014-06-30/DescribeIdentityPoolUsage) 

# DescribeIdentityUsage
<a name="API_DescribeIdentityUsage"></a>

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.

## Request Syntax
<a name="API_DescribeIdentityUsage_RequestSyntax"></a>

```
GET /identitypools/IdentityPoolId/identities/IdentityId HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeIdentityUsage_RequestParameters"></a>

The request uses the following URI parameters.

 ** [IdentityId](#API_DescribeIdentityUsage_RequestSyntax) **   <a name="Cognito-DescribeIdentityUsage-request-uri-IdentityId"></a>
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.  
Length Constraints: Minimum length of 1. Maximum length of 55.  
Pattern: `[\w-]+:[0-9a-f-]+`   
Required: Yes

 ** [IdentityPoolId](#API_DescribeIdentityUsage_RequestSyntax) **   <a name="Cognito-DescribeIdentityUsage-request-uri-IdentityPoolId"></a>
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.  
Length Constraints: Minimum length of 1. Maximum length of 55.  
Pattern: `[\w-]+:[0-9a-f-]+`   
Required: Yes

## Request Body
<a name="API_DescribeIdentityUsage_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeIdentityUsage_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "IdentityUsage": { 
      "DatasetCount": number,
      "DataStorage": number,
      "IdentityId": "string",
      "IdentityPoolId": "string",
      "LastModifiedDate": number
   }
}
```

## Response Elements
<a name="API_DescribeIdentityUsage_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [IdentityUsage](#API_DescribeIdentityUsage_ResponseSyntax) **   <a name="Cognito-DescribeIdentityUsage-response-IdentityUsage"></a>
Usage information for the identity.  
Type: [IdentityUsage](API_IdentityUsage.md) object

## Errors
<a name="API_DescribeIdentityUsage_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalErrorException **   
Indicates an internal service error.    
 ** message **   
Message returned by InternalErrorException.
HTTP Status Code: 500

 ** InvalidParameterException **   
Thrown when a request parameter does not comply with the associated constraints.    
 ** message **   
Message returned by InvalidParameterException.
HTTP Status Code: 400

 ** NotAuthorizedException **   
Thrown when a user is not authorized to access the requested resource.    
 ** message **   
The message returned by a NotAuthorizedException.
HTTP Status Code: 403

 ** ResourceNotFoundException **   
Thrown if the resource doesn't exist.    
 ** message **   
Message returned by a ResourceNotFoundException.
HTTP Status Code: 404

 ** TooManyRequestsException **   
Thrown if the request is throttled.    
 ** message **   
Message returned by a TooManyRequestsException.
HTTP Status Code: 429

## Examples
<a name="API_DescribeIdentityUsage_Examples"></a>

### DescribeIdentityUsage
<a name="API_DescribeIdentityUsage_Example_1"></a>

The following examples have been edited for readability.

#### Sample Request
<a name="API_DescribeIdentityUsage_Example_1_Request"></a>

```
POST / HTTP/1.1
CONTENT-TYPE: application/json
X-AMZN-REQUESTID: 33f9b4e4-a177-4aad-a3bb-6edb7980b283
X-AMZ-TARGET: com.amazonaws.cognito.sync.model.AWSCognitoSyncService.DescribeIdentityUsage
HOST: cognito-sync.us-east-1.amazonaws.com:443
X-AMZ-DATE: 20141111T215129Z
AUTHORIZATION: AWS4-HMAC-SHA256 Credential=<credential>, SignedHeaders=content-type;host;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<signature>
 
{
    "IdentityPoolId": "IDENTITY_POOL_ID",
    "IdentityId": "IDENTITY_ID"
}
```

#### Sample Response
<a name="API_DescribeIdentityUsage_Example_1_Response"></a>

```
               1.1 200 OK
x-amzn-requestid: 33f9b4e4-a177-4aad-a3bb-6edb7980b283
content-type: application/json
content-length: 318
date: Tue, 11 Nov 2014 21:51:29 GMT
 
{
    "IdentityUsage":
    {
        "DataStorage": 16,
        "DatasetCount": 1,
        "IdentityId": "IDENTITY_ID",
        "IdentityPoolId": "IDENTITY_POOL_ID",
        "LastModifiedDate": 1.412974081336E9
    }
}
```

## See Also
<a name="API_DescribeIdentityUsage_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cognito-sync-2014-06-30/DescribeIdentityUsage) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cognito-sync-2014-06-30/DescribeIdentityUsage) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cognito-sync-2014-06-30/DescribeIdentityUsage) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cognito-sync-2014-06-30/DescribeIdentityUsage) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cognito-sync-2014-06-30/DescribeIdentityUsage) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cognito-sync-2014-06-30/DescribeIdentityUsage) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cognito-sync-2014-06-30/DescribeIdentityUsage) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cognito-sync-2014-06-30/DescribeIdentityUsage) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cognito-sync-2014-06-30/DescribeIdentityUsage) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cognito-sync-2014-06-30/DescribeIdentityUsage) 

# GetBulkPublishDetails
<a name="API_GetBulkPublishDetails"></a>

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.

## Request Syntax
<a name="API_GetBulkPublishDetails_RequestSyntax"></a>

```
POST /identitypools/IdentityPoolId/getBulkPublishDetails HTTP/1.1
```

## URI Request Parameters
<a name="API_GetBulkPublishDetails_RequestParameters"></a>

The request uses the following URI parameters.

 ** [IdentityPoolId](#API_GetBulkPublishDetails_RequestSyntax) **   <a name="Cognito-GetBulkPublishDetails-request-uri-IdentityPoolId"></a>
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.  
Length Constraints: Minimum length of 1. Maximum length of 55.  
Pattern: `[\w-]+:[0-9a-f-]+`   
Required: Yes

## Request Body
<a name="API_GetBulkPublishDetails_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetBulkPublishDetails_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "BulkPublishCompleteTime": number,
   "BulkPublishStartTime": number,
   "BulkPublishStatus": "string",
   "FailureMessage": "string",
   "IdentityPoolId": "string"
}
```

## Response Elements
<a name="API_GetBulkPublishDetails_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [BulkPublishCompleteTime](#API_GetBulkPublishDetails_ResponseSyntax) **   <a name="Cognito-GetBulkPublishDetails-response-BulkPublishCompleteTime"></a>
If BulkPublishStatus is SUCCEEDED, the time the last bulk publish operation completed.  
Type: Timestamp

 ** [BulkPublishStartTime](#API_GetBulkPublishDetails_ResponseSyntax) **   <a name="Cognito-GetBulkPublishDetails-response-BulkPublishStartTime"></a>
The date/time at which the last bulk publish was initiated.  
Type: Timestamp

 ** [BulkPublishStatus](#API_GetBulkPublishDetails_ResponseSyntax) **   <a name="Cognito-GetBulkPublishDetails-response-BulkPublishStatus"></a>
Status of the last bulk publish operation, valid values are:   
+ NOT\$1STARTED - No bulk publish has been requested for this identity pool
+ IN\$1PROGRESS - Data is being published to the configured stream
+ SUCCEEDED - All data for the identity pool has been published to the configured stream
+ FAILED - Some portion of the data has failed to publish, check FailureMessage for the cause.
Type: String  
Valid Values: `NOT_STARTED | IN_PROGRESS | FAILED | SUCCEEDED` 

 ** [FailureMessage](#API_GetBulkPublishDetails_ResponseSyntax) **   <a name="Cognito-GetBulkPublishDetails-response-FailureMessage"></a>
If BulkPublishStatus is FAILED this field will contain the error message that caused the bulk publish to fail.  
Type: String

 ** [IdentityPoolId](#API_GetBulkPublishDetails_ResponseSyntax) **   <a name="Cognito-GetBulkPublishDetails-response-IdentityPoolId"></a>
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 55.  
Pattern: `[\w-]+:[0-9a-f-]+` 

## Errors
<a name="API_GetBulkPublishDetails_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalErrorException **   
Indicates an internal service error.    
 ** message **   
Message returned by InternalErrorException.
HTTP Status Code: 500

 ** InvalidParameterException **   
Thrown when a request parameter does not comply with the associated constraints.    
 ** message **   
Message returned by InvalidParameterException.
HTTP Status Code: 400

 ** NotAuthorizedException **   
Thrown when a user is not authorized to access the requested resource.    
 ** message **   
The message returned by a NotAuthorizedException.
HTTP Status Code: 403

 ** ResourceNotFoundException **   
Thrown if the resource doesn't exist.    
 ** message **   
Message returned by a ResourceNotFoundException.
HTTP Status Code: 404

## See Also
<a name="API_GetBulkPublishDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cognito-sync-2014-06-30/GetBulkPublishDetails) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cognito-sync-2014-06-30/GetBulkPublishDetails) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cognito-sync-2014-06-30/GetBulkPublishDetails) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cognito-sync-2014-06-30/GetBulkPublishDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cognito-sync-2014-06-30/GetBulkPublishDetails) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cognito-sync-2014-06-30/GetBulkPublishDetails) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cognito-sync-2014-06-30/GetBulkPublishDetails) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cognito-sync-2014-06-30/GetBulkPublishDetails) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cognito-sync-2014-06-30/GetBulkPublishDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cognito-sync-2014-06-30/GetBulkPublishDetails) 

# GetCognitoEvents
<a name="API_GetCognitoEvents"></a>

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.

## Request Syntax
<a name="API_GetCognitoEvents_RequestSyntax"></a>

```
GET /identitypools/IdentityPoolId/events HTTP/1.1
```

## URI Request Parameters
<a name="API_GetCognitoEvents_RequestParameters"></a>

The request uses the following URI parameters.

 ** [IdentityPoolId](#API_GetCognitoEvents_RequestSyntax) **   <a name="Cognito-GetCognitoEvents-request-uri-IdentityPoolId"></a>
The Cognito Identity Pool ID for the request  
Length Constraints: Minimum length of 1. Maximum length of 55.  
Pattern: `[\w-]+:[0-9a-f-]+`   
Required: Yes

## Request Body
<a name="API_GetCognitoEvents_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetCognitoEvents_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Events": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_GetCognitoEvents_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Events](#API_GetCognitoEvents_ResponseSyntax) **   <a name="Cognito-GetCognitoEvents-response-Events"></a>
The Cognito Events returned from the GetCognitoEvents request  
Type: String to string map  
Map Entries: Maximum number of 1 item.

## Errors
<a name="API_GetCognitoEvents_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalErrorException **   
Indicates an internal service error.    
 ** message **   
Message returned by InternalErrorException.
HTTP Status Code: 500

 ** InvalidParameterException **   
Thrown when a request parameter does not comply with the associated constraints.    
 ** message **   
Message returned by InvalidParameterException.
HTTP Status Code: 400

 ** NotAuthorizedException **   
Thrown when a user is not authorized to access the requested resource.    
 ** message **   
The message returned by a NotAuthorizedException.
HTTP Status Code: 403

 ** ResourceNotFoundException **   
Thrown if the resource doesn't exist.    
 ** message **   
Message returned by a ResourceNotFoundException.
HTTP Status Code: 404

 ** TooManyRequestsException **   
Thrown if the request is throttled.    
 ** message **   
Message returned by a TooManyRequestsException.
HTTP Status Code: 429

## See Also
<a name="API_GetCognitoEvents_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cognito-sync-2014-06-30/GetCognitoEvents) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cognito-sync-2014-06-30/GetCognitoEvents) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cognito-sync-2014-06-30/GetCognitoEvents) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cognito-sync-2014-06-30/GetCognitoEvents) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cognito-sync-2014-06-30/GetCognitoEvents) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cognito-sync-2014-06-30/GetCognitoEvents) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cognito-sync-2014-06-30/GetCognitoEvents) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cognito-sync-2014-06-30/GetCognitoEvents) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cognito-sync-2014-06-30/GetCognitoEvents) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cognito-sync-2014-06-30/GetCognitoEvents) 

# GetIdentityPoolConfiguration
<a name="API_GetIdentityPoolConfiguration"></a>

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.

## Request Syntax
<a name="API_GetIdentityPoolConfiguration_RequestSyntax"></a>

```
GET /identitypools/IdentityPoolId/configuration HTTP/1.1
```

## URI Request Parameters
<a name="API_GetIdentityPoolConfiguration_RequestParameters"></a>

The request uses the following URI parameters.

 ** [IdentityPoolId](#API_GetIdentityPoolConfiguration_RequestSyntax) **   <a name="Cognito-GetIdentityPoolConfiguration-request-uri-IdentityPoolId"></a>
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. This is the ID of the pool for which to return a configuration.  
Length Constraints: Minimum length of 1. Maximum length of 55.  
Pattern: `[\w-]+:[0-9a-f-]+`   
Required: Yes

## Request Body
<a name="API_GetIdentityPoolConfiguration_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetIdentityPoolConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "CognitoStreams": { 
      "DisabledReason": "string",
      "RoleArn": "string",
      "StreamingStatus": "string",
      "StreamName": "string"
   },
   "IdentityPoolId": "string",
   "PushSync": { 
      "ApplicationArns": [ "string" ],
      "RoleArn": "string"
   }
}
```

## Response Elements
<a name="API_GetIdentityPoolConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [CognitoStreams](#API_GetIdentityPoolConfiguration_ResponseSyntax) **   <a name="Cognito-GetIdentityPoolConfiguration-response-CognitoStreams"></a>
Options to apply to this identity pool for Amazon Cognito streams.  
Type: [CognitoStreams](API_CognitoStreams.md) object

 ** [IdentityPoolId](#API_GetIdentityPoolConfiguration_ResponseSyntax) **   <a name="Cognito-GetIdentityPoolConfiguration-response-IdentityPoolId"></a>
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 55.  
Pattern: `[\w-]+:[0-9a-f-]+` 

 ** [PushSync](#API_GetIdentityPoolConfiguration_ResponseSyntax) **   <a name="Cognito-GetIdentityPoolConfiguration-response-PushSync"></a>
Options to apply to this identity pool for push synchronization.  
Type: [PushSync](API_PushSync.md) object

## Errors
<a name="API_GetIdentityPoolConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalErrorException **   
Indicates an internal service error.    
 ** message **   
Message returned by InternalErrorException.
HTTP Status Code: 500

 ** InvalidParameterException **   
Thrown when a request parameter does not comply with the associated constraints.    
 ** message **   
Message returned by InvalidParameterException.
HTTP Status Code: 400

 ** NotAuthorizedException **   
Thrown when a user is not authorized to access the requested resource.    
 ** message **   
The message returned by a NotAuthorizedException.
HTTP Status Code: 403

 ** ResourceNotFoundException **   
Thrown if the resource doesn't exist.    
 ** message **   
Message returned by a ResourceNotFoundException.
HTTP Status Code: 404

 ** TooManyRequestsException **   
Thrown if the request is throttled.    
 ** message **   
Message returned by a TooManyRequestsException.
HTTP Status Code: 429

## Examples
<a name="API_GetIdentityPoolConfiguration_Examples"></a>

### GetIdentityPoolConfiguration
<a name="API_GetIdentityPoolConfiguration_Example_1"></a>

The following examples have been edited for readability.

#### Sample Request
<a name="API_GetIdentityPoolConfiguration_Example_1_Request"></a>

```
POST / HTTP/1.1
CONTENT-TYPE: application/json
X-AMZN-REQUESTID: b1cfdd4b-f620-4fe4-be0f-02024a1d33da
X-AMZ-TARGET: com.amazonaws.cognito.sync.model.AWSCognitoSyncService.GetIdentityPoolConfiguration
HOST: cognito-sync.us-east-1.amazonaws.com
X-AMZ-DATE: 20141004T195722Z
AUTHORIZATION: AWS4-HMAC-SHA256 Credential=<credential>, SignedHeaders=content-type;content-length;host;x-amz-date;x-amz-target, Signature=<signature>

{
    "IdentityPoolId": "ID_POOL_ID"
}
```

#### Sample Response
<a name="API_GetIdentityPoolConfiguration_Example_1_Response"></a>

```
1.1 200 OK
x-amzn-requestid: b1cfdd4b-f620-4fe4-be0f-02024a1d33da
date: Sat, 04 Oct 2014 19:57:22 GMT
content-type: application/json
content-length: 332

{
    "IdentityPoolId": "ID_POOL_ID",
    "PushSync":
    {
        "ApplicationArns": ["PLATFORMARN1", "PLATFORMARN2"],
        "RoleArn": "ROLEARN"
    }
}
```

## See Also
<a name="API_GetIdentityPoolConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cognito-sync-2014-06-30/GetIdentityPoolConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cognito-sync-2014-06-30/GetIdentityPoolConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cognito-sync-2014-06-30/GetIdentityPoolConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cognito-sync-2014-06-30/GetIdentityPoolConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cognito-sync-2014-06-30/GetIdentityPoolConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cognito-sync-2014-06-30/GetIdentityPoolConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cognito-sync-2014-06-30/GetIdentityPoolConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cognito-sync-2014-06-30/GetIdentityPoolConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cognito-sync-2014-06-30/GetIdentityPoolConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cognito-sync-2014-06-30/GetIdentityPoolConfiguration) 

# ListDatasets
<a name="API_ListDatasets"></a>

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.

## Request Syntax
<a name="API_ListDatasets_RequestSyntax"></a>

```
GET /identitypools/IdentityPoolId/identities/IdentityId/datasets?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListDatasets_RequestParameters"></a>

The request uses the following URI parameters.

 ** [IdentityId](#API_ListDatasets_RequestSyntax) **   <a name="Cognito-ListDatasets-request-uri-IdentityId"></a>
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.  
Length Constraints: Minimum length of 1. Maximum length of 55.  
Pattern: `[\w-]+:[0-9a-f-]+`   
Required: Yes

 ** [IdentityPoolId](#API_ListDatasets_RequestSyntax) **   <a name="Cognito-ListDatasets-request-uri-IdentityPoolId"></a>
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.  
Length Constraints: Minimum length of 1. Maximum length of 55.  
Pattern: `[\w-]+:[0-9a-f-]+`   
Required: Yes

 ** [MaxResults](#API_ListDatasets_RequestSyntax) **   <a name="Cognito-ListDatasets-request-uri-MaxResults"></a>
The maximum number of results to be returned.  
Length Constraints: Maximum length of 19.  
Pattern: `^[1-9]\d*` 

 ** [NextToken](#API_ListDatasets_RequestSyntax) **   <a name="Cognito-ListDatasets-request-uri-NextToken"></a>
A pagination token for obtaining the next page of results.

## Request Body
<a name="API_ListDatasets_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListDatasets_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Count": number,
   "Datasets": [ 
      { 
         "CreationDate": number,
         "DatasetName": "string",
         "DataStorage": number,
         "IdentityId": "string",
         "LastModifiedBy": "string",
         "LastModifiedDate": number,
         "NumRecords": number
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListDatasets_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Count](#API_ListDatasets_ResponseSyntax) **   <a name="Cognito-ListDatasets-response-Count"></a>
Number of datasets returned.  
Type: Integer

 ** [Datasets](#API_ListDatasets_ResponseSyntax) **   <a name="Cognito-ListDatasets-response-Datasets"></a>
A set of datasets.  
Type: Array of [Dataset](API_Dataset.md) objects

 ** [NextToken](#API_ListDatasets_ResponseSyntax) **   <a name="Cognito-ListDatasets-response-NextToken"></a>
A pagination token for obtaining the next page of results.  
Type: String

## Errors
<a name="API_ListDatasets_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalErrorException **   
Indicates an internal service error.    
 ** message **   
Message returned by InternalErrorException.
HTTP Status Code: 500

 ** InvalidParameterException **   
Thrown when a request parameter does not comply with the associated constraints.    
 ** message **   
Message returned by InvalidParameterException.
HTTP Status Code: 400

 ** NotAuthorizedException **   
Thrown when a user is not authorized to access the requested resource.    
 ** message **   
The message returned by a NotAuthorizedException.
HTTP Status Code: 403

 ** TooManyRequestsException **   
Thrown if the request is throttled.    
 ** message **   
Message returned by a TooManyRequestsException.
HTTP Status Code: 429

## Examples
<a name="API_ListDatasets_Examples"></a>

### ListDatasets
<a name="API_ListDatasets_Example_1"></a>

The following examples have been edited for readability.

#### Sample Request
<a name="API_ListDatasets_Example_1_Request"></a>

```
POST / HTTP/1.1
CONTENT-TYPE: application/json
X-AMZN-REQUESTID: 15225768-209f-4078-aaed-7494ace9f2db
X-AMZ-TARGET: com.amazonaws.cognito.sync.model.AWSCognitoSyncService.ListDatasets
HOST: cognito-sync.us-east-1.amazonaws.com:443
X-AMZ-DATE: 20141111T215640Z
AUTHORIZATION: AWS4-HMAC-SHA256 Credential=<credential>, SignedHeaders=content-type;host;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<signature>
 
{
    "IdentityPoolId": "IDENTITY_POOL_ID",
    "IdentityId": "IDENTITY_ID",
    "MaxResults": "3"
}
```

#### Sample Response
<a name="API_ListDatasets_Example_1_Response"></a>

```
1.1 200 OK
x-amzn-requestid: 15225768-209f-4078-aaed-7494ace9f2db, 15225768-209f-4078-aaed-7494ace9f2db
content-type: application/json
content-length: 355
date: Tue, 11 Nov 2014 21:56:40 GMT
 
{
    "Count": 1,
    "Datasets": [
    {
        "CreationDate": 1.412974057151E9,
        "DataStorage": 16,
        "DatasetName": "my_list",
        "IdentityId": "IDENTITY_ID",
        "LastModifiedBy": "123456789012",
        "LastModifiedDate": 1.412974057244E9,
        "NumRecords": 1
    }],
    "NextToken": null
}
```

## See Also
<a name="API_ListDatasets_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cognito-sync-2014-06-30/ListDatasets) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cognito-sync-2014-06-30/ListDatasets) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cognito-sync-2014-06-30/ListDatasets) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cognito-sync-2014-06-30/ListDatasets) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cognito-sync-2014-06-30/ListDatasets) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cognito-sync-2014-06-30/ListDatasets) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cognito-sync-2014-06-30/ListDatasets) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cognito-sync-2014-06-30/ListDatasets) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cognito-sync-2014-06-30/ListDatasets) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cognito-sync-2014-06-30/ListDatasets) 

# ListIdentityPoolUsage
<a name="API_ListIdentityPoolUsage"></a>

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.

## Request Syntax
<a name="API_ListIdentityPoolUsage_RequestSyntax"></a>

```
GET /identitypools?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListIdentityPoolUsage_RequestParameters"></a>

The request uses the following URI parameters.

 ** [MaxResults](#API_ListIdentityPoolUsage_RequestSyntax) **   <a name="Cognito-ListIdentityPoolUsage-request-uri-MaxResults"></a>
The maximum number of results to be returned.

 ** [NextToken](#API_ListIdentityPoolUsage_RequestSyntax) **   <a name="Cognito-ListIdentityPoolUsage-request-uri-NextToken"></a>
A pagination token for obtaining the next page of results.

## Request Body
<a name="API_ListIdentityPoolUsage_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListIdentityPoolUsage_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Count": number,
   "IdentityPoolUsages": [ 
      { 
         "DataStorage": number,
         "IdentityPoolId": "string",
         "LastModifiedDate": number,
         "SyncSessionsCount": number
      }
   ],
   "MaxResults": number,
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListIdentityPoolUsage_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Count](#API_ListIdentityPoolUsage_ResponseSyntax) **   <a name="Cognito-ListIdentityPoolUsage-response-Count"></a>
Total number of identities for the identity pool.  
Type: Integer

 ** [IdentityPoolUsages](#API_ListIdentityPoolUsage_ResponseSyntax) **   <a name="Cognito-ListIdentityPoolUsage-response-IdentityPoolUsages"></a>
Usage information for the identity pools.  
Type: Array of [IdentityPoolUsage](API_IdentityPoolUsage.md) objects

 ** [MaxResults](#API_ListIdentityPoolUsage_ResponseSyntax) **   <a name="Cognito-ListIdentityPoolUsage-response-MaxResults"></a>
The maximum number of results to be returned.  
Type: Integer

 ** [NextToken](#API_ListIdentityPoolUsage_ResponseSyntax) **   <a name="Cognito-ListIdentityPoolUsage-response-NextToken"></a>
A pagination token for obtaining the next page of results.  
Type: String

## Errors
<a name="API_ListIdentityPoolUsage_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalErrorException **   
Indicates an internal service error.    
 ** message **   
Message returned by InternalErrorException.
HTTP Status Code: 500

 ** InvalidParameterException **   
Thrown when a request parameter does not comply with the associated constraints.    
 ** message **   
Message returned by InvalidParameterException.
HTTP Status Code: 400

 ** NotAuthorizedException **   
Thrown when a user is not authorized to access the requested resource.    
 ** message **   
The message returned by a NotAuthorizedException.
HTTP Status Code: 403

 ** TooManyRequestsException **   
Thrown if the request is throttled.    
 ** message **   
Message returned by a TooManyRequestsException.
HTTP Status Code: 429

## Examples
<a name="API_ListIdentityPoolUsage_Examples"></a>

### ListIdentityPoolUsage
<a name="API_ListIdentityPoolUsage_Example_1"></a>

The following examples have been edited for readability.

#### Sample Request
<a name="API_ListIdentityPoolUsage_Example_1_Request"></a>

```
POST / HTTP/1.1
CONTENT-TYPE: application/json
X-AMZN-REQUESTID: 9be7c425-ef05-48c0-aef3-9f0ff2fe17d3
X-AMZ-TARGET: com.amazonaws.cognito.sync.model.AWSCognitoSyncService.ListIdentityPoolUsage
HOST: cognito-sync.us-east-1.amazonaws.com:443
X-AMZ-DATE: 20141111T211414Z
AUTHORIZATION: AWS4-HMAC-SHA256 Credential=<credential>, SignedHeaders=content-type;host;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<signature>
 
{
    "MaxResults": "2"
}
```

#### Sample Response
<a name="API_ListIdentityPoolUsage_Example_1_Response"></a>

```
1.1 200 OK
x-amzn-requestid: 9be7c425-ef05-48c0-aef3-9f0ff2fe17d3
content-type: application/json
content-length: 519
date: Tue, 11 Nov 2014 21:14:14 GMT
 
{
    "Count": 2,
    "IdentityPoolUsages": [
    {
        "DataStorage": 0,
        "IdentityPoolId": "IDENTITY_POOL_ID",
        "LastModifiedDate": 1.413836234607E9,
        "SyncSessionsCount": null
    },
    {
        "DataStorage": 0,
        "IdentityPoolId": "IDENTITY_POOL_ID",
        "LastModifiedDate": 1.410892165601E9,
        "SyncSessionsCount": null
    }],
    "MaxResults": 2,
    "NextToken": "dXMtZWFzdC0xOjBjMWJhMDUyLWUwOTgtNDFmYS1hNzZlLWVhYTJjMTI1Zjg2MQ=="
}
```

## See Also
<a name="API_ListIdentityPoolUsage_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cognito-sync-2014-06-30/ListIdentityPoolUsage) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cognito-sync-2014-06-30/ListIdentityPoolUsage) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cognito-sync-2014-06-30/ListIdentityPoolUsage) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cognito-sync-2014-06-30/ListIdentityPoolUsage) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cognito-sync-2014-06-30/ListIdentityPoolUsage) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cognito-sync-2014-06-30/ListIdentityPoolUsage) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cognito-sync-2014-06-30/ListIdentityPoolUsage) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cognito-sync-2014-06-30/ListIdentityPoolUsage) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cognito-sync-2014-06-30/ListIdentityPoolUsage) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cognito-sync-2014-06-30/ListIdentityPoolUsage) 

# ListRecords
<a name="API_ListRecords"></a>

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.

## Request Syntax
<a name="API_ListRecords_RequestSyntax"></a>

```
GET /identitypools/IdentityPoolId/identities/IdentityId/datasets/DatasetName/records?lastSyncCount=LastSyncCount&maxResults=MaxResults&nextToken=NextToken&syncSessionToken=SyncSessionToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListRecords_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DatasetName](#API_ListRecords_RequestSyntax) **   <a name="Cognito-ListRecords-request-uri-DatasetName"></a>
A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '\$1' (underscore), '-' (dash), and '.' (dot).  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9_.:-]+`   
Required: Yes

 ** [IdentityId](#API_ListRecords_RequestSyntax) **   <a name="Cognito-ListRecords-request-uri-IdentityId"></a>
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.  
Length Constraints: Minimum length of 1. Maximum length of 55.  
Pattern: `[\w-]+:[0-9a-f-]+`   
Required: Yes

 ** [IdentityPoolId](#API_ListRecords_RequestSyntax) **   <a name="Cognito-ListRecords-request-uri-IdentityPoolId"></a>
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.  
Length Constraints: Minimum length of 1. Maximum length of 55.  
Pattern: `[\w-]+:[0-9a-f-]+`   
Required: Yes

 ** [LastSyncCount](#API_ListRecords_RequestSyntax) **   <a name="Cognito-ListRecords-request-uri-LastSyncCount"></a>
The last server sync count for this record.

 ** [MaxResults](#API_ListRecords_RequestSyntax) **   <a name="Cognito-ListRecords-request-uri-MaxResults"></a>
The maximum number of results to be returned.

 ** [NextToken](#API_ListRecords_RequestSyntax) **   <a name="Cognito-ListRecords-request-uri-NextToken"></a>
A pagination token for obtaining the next page of results.

 ** [SyncSessionToken](#API_ListRecords_RequestSyntax) **   <a name="Cognito-ListRecords-request-uri-SyncSessionToken"></a>
A token containing a session ID, identity ID, and expiration.

## Request Body
<a name="API_ListRecords_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListRecords_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Count": number,
   "DatasetDeletedAfterRequestedSyncCount": boolean,
   "DatasetExists": boolean,
   "DatasetSyncCount": number,
   "LastModifiedBy": "string",
   "MergedDatasetNames": [ "string" ],
   "NextToken": "string",
   "Records": [ 
      { 
         "DeviceLastModifiedDate": number,
         "Key": "string",
         "LastModifiedBy": "string",
         "LastModifiedDate": number,
         "SyncCount": number,
         "Value": "string"
      }
   ],
   "SyncSessionToken": "string"
}
```

## Response Elements
<a name="API_ListRecords_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Count](#API_ListRecords_ResponseSyntax) **   <a name="Cognito-ListRecords-response-Count"></a>
Total number of records.  
Type: Integer

 ** [DatasetDeletedAfterRequestedSyncCount](#API_ListRecords_ResponseSyntax) **   <a name="Cognito-ListRecords-response-DatasetDeletedAfterRequestedSyncCount"></a>
A boolean value specifying whether to delete the dataset locally.  
Type: Boolean

 ** [DatasetExists](#API_ListRecords_ResponseSyntax) **   <a name="Cognito-ListRecords-response-DatasetExists"></a>
Indicates whether the dataset exists.  
Type: Boolean

 ** [DatasetSyncCount](#API_ListRecords_ResponseSyntax) **   <a name="Cognito-ListRecords-response-DatasetSyncCount"></a>
Server sync count for this dataset.  
Type: Long

 ** [LastModifiedBy](#API_ListRecords_ResponseSyntax) **   <a name="Cognito-ListRecords-response-LastModifiedBy"></a>
The user/device that made the last change to this record.  
Type: String

 ** [MergedDatasetNames](#API_ListRecords_ResponseSyntax) **   <a name="Cognito-ListRecords-response-MergedDatasetNames"></a>
Names of merged datasets.  
Type: Array of strings

 ** [NextToken](#API_ListRecords_ResponseSyntax) **   <a name="Cognito-ListRecords-response-NextToken"></a>
A pagination token for obtaining the next page of results.  
Type: String

 ** [Records](#API_ListRecords_ResponseSyntax) **   <a name="Cognito-ListRecords-response-Records"></a>
A list of all records.  
Type: Array of [Record](API_Record.md) objects

 ** [SyncSessionToken](#API_ListRecords_ResponseSyntax) **   <a name="Cognito-ListRecords-response-SyncSessionToken"></a>
A token containing a session ID, identity ID, and expiration.  
Type: String

## Errors
<a name="API_ListRecords_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalErrorException **   
Indicates an internal service error.    
 ** message **   
Message returned by InternalErrorException.
HTTP Status Code: 500

 ** InvalidParameterException **   
Thrown when a request parameter does not comply with the associated constraints.    
 ** message **   
Message returned by InvalidParameterException.
HTTP Status Code: 400

 ** NotAuthorizedException **   
Thrown when a user is not authorized to access the requested resource.    
 ** message **   
The message returned by a NotAuthorizedException.
HTTP Status Code: 403

 ** TooManyRequestsException **   
Thrown if the request is throttled.    
 ** message **   
Message returned by a TooManyRequestsException.
HTTP Status Code: 429

## Examples
<a name="API_ListRecords_Examples"></a>

### ListRecords
<a name="API_ListRecords_Example_1"></a>

The following examples have been edited for readability.

#### Sample Request
<a name="API_ListRecords_Example_1_Request"></a>

```
POST / HTTP/1.1
CONTENT-TYPE: application/json
X-AMZN-REQUESTID: b3d2e31e-d6b7-4612-8e84-c9ba288dab5d
X-AMZ-TARGET: com.amazonaws.cognito.sync.model.AWSCognitoSyncService.ListRecords
HOST: cognito-sync.us-east-1.amazonaws.com:443
X-AMZ-DATE: 20141111T183230Z
AUTHORIZATION: AWS4-HMAC-SHA256 Credential=<credential>, SignedHeaders=content-type;host;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<signature>
 
{
    "IdentityPoolId": "IDENTITY_POOL_ID",
    "IdentityId": "IDENTITY_ID",
    "DatasetName": "newDataSet"
}
```

#### Sample Response
<a name="API_ListRecords_Example_1_Response"></a>

```
1.1 200 OK
x-amzn-requestid: b3d2e31e-d6b7-4612-8e84-c9ba288dab5d
content-type: application/json
content-length: 623
date: Tue, 11 Nov 2014 18:32:30 GMT
 
{
    "Count": 0,
    "DatasetDeletedAfterRequestedSyncCount": false,
    "DatasetExists": false,
    "DatasetSyncCount": 0,
    "LastModifiedBy": null,
    "MergedDatasetNames": null,
    "NextToken": null,
    "Records": [],
    "SyncSessionToken": "SYNC_SESSION_TOKEN"
}
```

## See Also
<a name="API_ListRecords_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cognito-sync-2014-06-30/ListRecords) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cognito-sync-2014-06-30/ListRecords) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cognito-sync-2014-06-30/ListRecords) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cognito-sync-2014-06-30/ListRecords) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cognito-sync-2014-06-30/ListRecords) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cognito-sync-2014-06-30/ListRecords) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cognito-sync-2014-06-30/ListRecords) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cognito-sync-2014-06-30/ListRecords) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cognito-sync-2014-06-30/ListRecords) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cognito-sync-2014-06-30/ListRecords) 

# RegisterDevice
<a name="API_RegisterDevice"></a>

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.

## Request Syntax
<a name="API_RegisterDevice_RequestSyntax"></a>

```
POST /identitypools/IdentityPoolId/identity/IdentityId/device HTTP/1.1
Content-type: application/json

{
   "Platform": "string",
   "Token": "string"
}
```

## URI Request Parameters
<a name="API_RegisterDevice_RequestParameters"></a>

The request uses the following URI parameters.

 ** [IdentityId](#API_RegisterDevice_RequestSyntax) **   <a name="Cognito-RegisterDevice-request-uri-IdentityId"></a>
The unique ID for this identity.  
Length Constraints: Minimum length of 1. Maximum length of 55.  
Pattern: `[\w-]+:[0-9a-f-]+`   
Required: Yes

 ** [IdentityPoolId](#API_RegisterDevice_RequestSyntax) **   <a name="Cognito-RegisterDevice-request-uri-IdentityPoolId"></a>
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. Here, the ID of the pool that the identity belongs to.  
Length Constraints: Minimum length of 1. Maximum length of 55.  
Pattern: `[\w-]+:[0-9a-f-]+`   
Required: Yes

## Request Body
<a name="API_RegisterDevice_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Platform](#API_RegisterDevice_RequestSyntax) **   <a name="Cognito-RegisterDevice-request-Platform"></a>
The SNS platform type (e.g. GCM, SDM, APNS, APNS\$1SANDBOX).  
Type: String  
Valid Values: `APNS | APNS_SANDBOX | GCM | ADM`   
Required: Yes

 ** [Token](#API_RegisterDevice_RequestSyntax) **   <a name="Cognito-RegisterDevice-request-Token"></a>
The push token.  
Type: String  
Required: Yes

## Response Syntax
<a name="API_RegisterDevice_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "DeviceId": "string"
}
```

## Response Elements
<a name="API_RegisterDevice_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [DeviceId](#API_RegisterDevice_ResponseSyntax) **   <a name="Cognito-RegisterDevice-response-DeviceId"></a>
The unique ID generated for this device by Cognito.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.

## Errors
<a name="API_RegisterDevice_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalErrorException **   
Indicates an internal service error.    
 ** message **   
Message returned by InternalErrorException.
HTTP Status Code: 500

 ** InvalidConfigurationException **   
This exception is thrown when Amazon Cognito detects an invalid configuration.    
 ** message **   
Message returned by InvalidConfigurationException.
HTTP Status Code: 400

 ** InvalidParameterException **   
Thrown when a request parameter does not comply with the associated constraints.    
 ** message **   
Message returned by InvalidParameterException.
HTTP Status Code: 400

 ** NotAuthorizedException **   
Thrown when a user is not authorized to access the requested resource.    
 ** message **   
The message returned by a NotAuthorizedException.
HTTP Status Code: 403

 ** ResourceNotFoundException **   
Thrown if the resource doesn't exist.    
 ** message **   
Message returned by a ResourceNotFoundException.
HTTP Status Code: 404

 ** TooManyRequestsException **   
Thrown if the request is throttled.    
 ** message **   
Message returned by a TooManyRequestsException.
HTTP Status Code: 429

## Examples
<a name="API_RegisterDevice_Examples"></a>

### RegisterDevice
<a name="API_RegisterDevice_Example_1"></a>

The following examples have been edited for readability.

#### Sample Request
<a name="API_RegisterDevice_Example_1_Request"></a>

```
POST / HTTP/1.1
CONTENT-TYPE: application/json
X-AMZN-REQUESTID: 368f9200-3eca-449e-93b3-7b9c08d8e185
X-AMZ-TARGET: com.amazonaws.cognito.sync.model.AWSCognitoSyncService.RegisterDevice
HOST: cognito-sync.us-east-1.amazonaws.com
X-AMZ-DATE: 20141004T194643Z
X-AMZ-SECURITY-TOKEN: <securitytoken>
AUTHORIZATION: AWS4-HMAC-SHA256 Credential=<credential>, SignedHeaders=content-type;content-length;host;x-amz-date;x-amz-target, Signature=<signature>

{
    "IdentityPoolId": "ID_POOL_ID",
    "IdentityId": "IDENTITY_ID",
    "Platform": "GCM",
    "Token": "PUSH_TOKEN"
}
```

#### Sample Response
<a name="API_RegisterDevice_Example_1_Response"></a>

```
1.1 200 OK
x-amzn-requestid: 368f9200-3eca-449e-93b3-7b9c08d8e185
date: Sat, 04 Oct 2014 19:46:44 GMT
content-type: application/json
content-length: 145

{
    "DeviceId": "5cd28fbe-dd83-47ab-9f83-19093a5fb014"
}
```

## See Also
<a name="API_RegisterDevice_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cognito-sync-2014-06-30/RegisterDevice) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cognito-sync-2014-06-30/RegisterDevice) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cognito-sync-2014-06-30/RegisterDevice) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cognito-sync-2014-06-30/RegisterDevice) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cognito-sync-2014-06-30/RegisterDevice) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cognito-sync-2014-06-30/RegisterDevice) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cognito-sync-2014-06-30/RegisterDevice) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cognito-sync-2014-06-30/RegisterDevice) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cognito-sync-2014-06-30/RegisterDevice) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cognito-sync-2014-06-30/RegisterDevice) 

# SetCognitoEvents
<a name="API_SetCognitoEvents"></a>

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.

## Request Syntax
<a name="API_SetCognitoEvents_RequestSyntax"></a>

```
POST /identitypools/IdentityPoolId/events HTTP/1.1
Content-type: application/json

{
   "Events": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_SetCognitoEvents_RequestParameters"></a>

The request uses the following URI parameters.

 ** [IdentityPoolId](#API_SetCognitoEvents_RequestSyntax) **   <a name="Cognito-SetCognitoEvents-request-uri-IdentityPoolId"></a>
The Cognito Identity Pool to use when configuring Cognito Events  
Length Constraints: Minimum length of 1. Maximum length of 55.  
Pattern: `[\w-]+:[0-9a-f-]+`   
Required: Yes

## Request Body
<a name="API_SetCognitoEvents_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Events](#API_SetCognitoEvents_RequestSyntax) **   <a name="Cognito-SetCognitoEvents-request-Events"></a>
The AWS Lambda Amazon Resource Name (ARN) that you want to set as your Cognito Events trigger. For example, `"SyncTrigger" : "arn:aws:lambda:us-east-1:123456789012:function:my-function"`.  
Type: String to string map  
Map Entries: Maximum number of 1 item.  
Required: Yes

## Response Syntax
<a name="API_SetCognitoEvents_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_SetCognitoEvents_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_SetCognitoEvents_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalErrorException **   
Indicates an internal service error.    
 ** message **   
Message returned by InternalErrorException.
HTTP Status Code: 500

 ** InvalidParameterException **   
Thrown when a request parameter does not comply with the associated constraints.    
 ** message **   
Message returned by InvalidParameterException.
HTTP Status Code: 400

 ** NotAuthorizedException **   
Thrown when a user is not authorized to access the requested resource.    
 ** message **   
The message returned by a NotAuthorizedException.
HTTP Status Code: 403

 ** ResourceNotFoundException **   
Thrown if the resource doesn't exist.    
 ** message **   
Message returned by a ResourceNotFoundException.
HTTP Status Code: 404

 ** TooManyRequestsException **   
Thrown if the request is throttled.    
 ** message **   
Message returned by a TooManyRequestsException.
HTTP Status Code: 429

## See Also
<a name="API_SetCognitoEvents_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cognito-sync-2014-06-30/SetCognitoEvents) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cognito-sync-2014-06-30/SetCognitoEvents) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cognito-sync-2014-06-30/SetCognitoEvents) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cognito-sync-2014-06-30/SetCognitoEvents) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cognito-sync-2014-06-30/SetCognitoEvents) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cognito-sync-2014-06-30/SetCognitoEvents) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cognito-sync-2014-06-30/SetCognitoEvents) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cognito-sync-2014-06-30/SetCognitoEvents) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cognito-sync-2014-06-30/SetCognitoEvents) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cognito-sync-2014-06-30/SetCognitoEvents) 

# SetIdentityPoolConfiguration
<a name="API_SetIdentityPoolConfiguration"></a>

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.

## Request Syntax
<a name="API_SetIdentityPoolConfiguration_RequestSyntax"></a>

```
POST /identitypools/IdentityPoolId/configuration HTTP/1.1
Content-type: application/json

{
   "CognitoStreams": { 
      "DisabledReason": "string",
      "RoleArn": "string",
      "StreamingStatus": "string",
      "StreamName": "string"
   },
   "PushSync": { 
      "ApplicationArns": [ "string" ],
      "RoleArn": "string"
   }
}
```

## URI Request Parameters
<a name="API_SetIdentityPoolConfiguration_RequestParameters"></a>

The request uses the following URI parameters.

 ** [IdentityPoolId](#API_SetIdentityPoolConfiguration_RequestSyntax) **   <a name="Cognito-SetIdentityPoolConfiguration-request-uri-IdentityPoolId"></a>
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. This is the ID of the pool to modify.  
Length Constraints: Minimum length of 1. Maximum length of 55.  
Pattern: `[\w-]+:[0-9a-f-]+`   
Required: Yes

## Request Body
<a name="API_SetIdentityPoolConfiguration_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [CognitoStreams](#API_SetIdentityPoolConfiguration_RequestSyntax) **   <a name="Cognito-SetIdentityPoolConfiguration-request-CognitoStreams"></a>
Options to apply to this identity pool for Amazon Cognito streams.  
Type: [CognitoStreams](API_CognitoStreams.md) object  
Required: No

 ** [PushSync](#API_SetIdentityPoolConfiguration_RequestSyntax) **   <a name="Cognito-SetIdentityPoolConfiguration-request-PushSync"></a>
Options to apply to this identity pool for push synchronization.  
Type: [PushSync](API_PushSync.md) object  
Required: No

## Response Syntax
<a name="API_SetIdentityPoolConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "CognitoStreams": { 
      "DisabledReason": "string",
      "RoleArn": "string",
      "StreamingStatus": "string",
      "StreamName": "string"
   },
   "IdentityPoolId": "string",
   "PushSync": { 
      "ApplicationArns": [ "string" ],
      "RoleArn": "string"
   }
}
```

## Response Elements
<a name="API_SetIdentityPoolConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [CognitoStreams](#API_SetIdentityPoolConfiguration_ResponseSyntax) **   <a name="Cognito-SetIdentityPoolConfiguration-response-CognitoStreams"></a>
Options to apply to this identity pool for Amazon Cognito streams.  
Type: [CognitoStreams](API_CognitoStreams.md) object

 ** [IdentityPoolId](#API_SetIdentityPoolConfiguration_ResponseSyntax) **   <a name="Cognito-SetIdentityPoolConfiguration-response-IdentityPoolId"></a>
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 55.  
Pattern: `[\w-]+:[0-9a-f-]+` 

 ** [PushSync](#API_SetIdentityPoolConfiguration_ResponseSyntax) **   <a name="Cognito-SetIdentityPoolConfiguration-response-PushSync"></a>
Options to apply to this identity pool for push synchronization.  
Type: [PushSync](API_PushSync.md) object

## Errors
<a name="API_SetIdentityPoolConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConcurrentModificationException **   
Thrown if there are parallel requests to modify a resource.    
 ** message **   
The message returned by a ConcurrentModificationException.
HTTP Status Code: 400

 ** InternalErrorException **   
Indicates an internal service error.    
 ** message **   
Message returned by InternalErrorException.
HTTP Status Code: 500

 ** InvalidParameterException **   
Thrown when a request parameter does not comply with the associated constraints.    
 ** message **   
Message returned by InvalidParameterException.
HTTP Status Code: 400

 ** NotAuthorizedException **   
Thrown when a user is not authorized to access the requested resource.    
 ** message **   
The message returned by a NotAuthorizedException.
HTTP Status Code: 403

 ** ResourceNotFoundException **   
Thrown if the resource doesn't exist.    
 ** message **   
Message returned by a ResourceNotFoundException.
HTTP Status Code: 404

 ** TooManyRequestsException **   
Thrown if the request is throttled.    
 ** message **   
Message returned by a TooManyRequestsException.
HTTP Status Code: 429

## Examples
<a name="API_SetIdentityPoolConfiguration_Examples"></a>

### SetIdentityPoolConfiguration
<a name="API_SetIdentityPoolConfiguration_Example_1"></a>

The following examples have been edited for readability.

#### Sample Request
<a name="API_SetIdentityPoolConfiguration_Example_1_Request"></a>

```
POST / HTTP/1.1
CONTENT-TYPE: application/json
X-AMZN-REQUESTID: a46db021-f5dd-45d6-af5b-7069fa4a211b
X-AMZ-TARGET: com.amazonaws.cognito.sync.model.AWSCognitoSyncService.SetIdentityPoolConfiguration
HOST: cognito-sync.us-east-1.amazonaws.com
X-AMZ-DATE: 20141004T200006Z
AUTHORIZATION: AWS4-HMAC-SHA256 Credential=<credential>, SignedHeaders=content-type;content-length;host;x-amz-date;x-amz-target, Signature=<signature>

{
    "IdentityPoolId": "ID_POOL_ID",
    "PushSync":
    {
        "ApplicationArns": ["PLATFORMARN1", "PLATFORMARN2"],
        "RoleArn": "ROLEARN"
    }
}
```

#### Sample Response
<a name="API_SetIdentityPoolConfiguration_Example_1_Response"></a>

```
1.1 200 OK
x-amzn-requestid: a46db021-f5dd-45d6-af5b-7069fa4a211b
date: Sat, 04 Oct 2014 20:00:06 GMT
content-type: application/json
content-length: 332

{
    "IdentityPoolId": "ID_POOL_ID",
    "PushSync":
    {
        "ApplicationArns": ["PLATFORMARN1", "PLATFORMARN2"],
        "RoleArn": "ROLEARN"
    }
}
```

## See Also
<a name="API_SetIdentityPoolConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cognito-sync-2014-06-30/SetIdentityPoolConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cognito-sync-2014-06-30/SetIdentityPoolConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cognito-sync-2014-06-30/SetIdentityPoolConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cognito-sync-2014-06-30/SetIdentityPoolConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cognito-sync-2014-06-30/SetIdentityPoolConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cognito-sync-2014-06-30/SetIdentityPoolConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cognito-sync-2014-06-30/SetIdentityPoolConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cognito-sync-2014-06-30/SetIdentityPoolConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cognito-sync-2014-06-30/SetIdentityPoolConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cognito-sync-2014-06-30/SetIdentityPoolConfiguration) 

# SubscribeToDataset
<a name="API_SubscribeToDataset"></a>

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.

## Request Syntax
<a name="API_SubscribeToDataset_RequestSyntax"></a>

```
POST /identitypools/IdentityPoolId/identities/IdentityId/datasets/DatasetName/subscriptions/DeviceId HTTP/1.1
```

## URI Request Parameters
<a name="API_SubscribeToDataset_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DatasetName](#API_SubscribeToDataset_RequestSyntax) **   <a name="Cognito-SubscribeToDataset-request-uri-DatasetName"></a>
The name of the dataset to subcribe to.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9_.:-]+`   
Required: Yes

 ** [DeviceId](#API_SubscribeToDataset_RequestSyntax) **   <a name="Cognito-SubscribeToDataset-request-uri-DeviceId"></a>
The unique ID generated for this device by Cognito.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [IdentityId](#API_SubscribeToDataset_RequestSyntax) **   <a name="Cognito-SubscribeToDataset-request-uri-IdentityId"></a>
Unique ID for this identity.  
Length Constraints: Minimum length of 1. Maximum length of 55.  
Pattern: `[\w-]+:[0-9a-f-]+`   
Required: Yes

 ** [IdentityPoolId](#API_SubscribeToDataset_RequestSyntax) **   <a name="Cognito-SubscribeToDataset-request-uri-IdentityPoolId"></a>
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. The ID of the pool to which the identity belongs.  
Length Constraints: Minimum length of 1. Maximum length of 55.  
Pattern: `[\w-]+:[0-9a-f-]+`   
Required: Yes

## Request Body
<a name="API_SubscribeToDataset_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_SubscribeToDataset_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_SubscribeToDataset_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_SubscribeToDataset_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalErrorException **   
Indicates an internal service error.    
 ** message **   
Message returned by InternalErrorException.
HTTP Status Code: 500

 ** InvalidConfigurationException **   
This exception is thrown when Amazon Cognito detects an invalid configuration.    
 ** message **   
Message returned by InvalidConfigurationException.
HTTP Status Code: 400

 ** InvalidParameterException **   
Thrown when a request parameter does not comply with the associated constraints.    
 ** message **   
Message returned by InvalidParameterException.
HTTP Status Code: 400

 ** NotAuthorizedException **   
Thrown when a user is not authorized to access the requested resource.    
 ** message **   
The message returned by a NotAuthorizedException.
HTTP Status Code: 403

 ** ResourceNotFoundException **   
Thrown if the resource doesn't exist.    
 ** message **   
Message returned by a ResourceNotFoundException.
HTTP Status Code: 404

 ** TooManyRequestsException **   
Thrown if the request is throttled.    
 ** message **   
Message returned by a TooManyRequestsException.
HTTP Status Code: 429

## Examples
<a name="API_SubscribeToDataset_Examples"></a>

### SubscribeToDataset
<a name="API_SubscribeToDataset_Example_1"></a>

The following examples have been edited for readability.

#### Sample Request
<a name="API_SubscribeToDataset_Example_1_Request"></a>

```
POST / HTTP/1.1
CONTENT-TYPE: application/json
X-AMZN-REQUESTID: 8b9932b7-201d-4418-a960-0a470e11de9f
X-AMZ-TARGET: com.amazonaws.cognito.sync.model.AWSCognitoSyncService.SubscribeToDataset
HOST: cognito-sync.us-east-1.amazonaws.com
X-AMZ-DATE: 20141004T195350Z
X-AMZ-SECURITY-TOKEN: <securitytoken>
AUTHORIZATION: AWS4-HMAC-SHA256 Credential=<credential>, SignedHeaders=content-type;content-length;host;x-amz-date;x-amz-target, Signature=<signature>

{
    "IdentityPoolId": "ID_POOL_ID",
    "IdentityId": "IDENTITY_ID",
    "DatasetName": "Rufus",
    "DeviceId": "5cd28fbe-dd83-47ab-9f83-19093a5fb014
}
```

#### Sample Response
<a name="API_SubscribeToDataset_Example_1_Response"></a>

```
1.1 200 OK
x-amzn-requestid: 8b9932b7-201d-4418-a960-0a470e11de9f
date: Sat, 04 Oct 2014 19:53:50 GMT
content-type: application/json
content-length: 99

{
}
```

## See Also
<a name="API_SubscribeToDataset_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cognito-sync-2014-06-30/SubscribeToDataset) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cognito-sync-2014-06-30/SubscribeToDataset) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cognito-sync-2014-06-30/SubscribeToDataset) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cognito-sync-2014-06-30/SubscribeToDataset) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cognito-sync-2014-06-30/SubscribeToDataset) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cognito-sync-2014-06-30/SubscribeToDataset) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cognito-sync-2014-06-30/SubscribeToDataset) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cognito-sync-2014-06-30/SubscribeToDataset) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cognito-sync-2014-06-30/SubscribeToDataset) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cognito-sync-2014-06-30/SubscribeToDataset) 

# UnsubscribeFromDataset
<a name="API_UnsubscribeFromDataset"></a>

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.

## Request Syntax
<a name="API_UnsubscribeFromDataset_RequestSyntax"></a>

```
DELETE /identitypools/IdentityPoolId/identities/IdentityId/datasets/DatasetName/subscriptions/DeviceId HTTP/1.1
```

## URI Request Parameters
<a name="API_UnsubscribeFromDataset_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DatasetName](#API_UnsubscribeFromDataset_RequestSyntax) **   <a name="Cognito-UnsubscribeFromDataset-request-uri-DatasetName"></a>
The name of the dataset from which to unsubcribe.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9_.:-]+`   
Required: Yes

 ** [DeviceId](#API_UnsubscribeFromDataset_RequestSyntax) **   <a name="Cognito-UnsubscribeFromDataset-request-uri-DeviceId"></a>
The unique ID generated for this device by Cognito.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [IdentityId](#API_UnsubscribeFromDataset_RequestSyntax) **   <a name="Cognito-UnsubscribeFromDataset-request-uri-IdentityId"></a>
Unique ID for this identity.  
Length Constraints: Minimum length of 1. Maximum length of 55.  
Pattern: `[\w-]+:[0-9a-f-]+`   
Required: Yes

 ** [IdentityPoolId](#API_UnsubscribeFromDataset_RequestSyntax) **   <a name="Cognito-UnsubscribeFromDataset-request-uri-IdentityPoolId"></a>
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. The ID of the pool to which this identity belongs.  
Length Constraints: Minimum length of 1. Maximum length of 55.  
Pattern: `[\w-]+:[0-9a-f-]+`   
Required: Yes

## Request Body
<a name="API_UnsubscribeFromDataset_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_UnsubscribeFromDataset_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UnsubscribeFromDataset_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UnsubscribeFromDataset_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalErrorException **   
Indicates an internal service error.    
 ** message **   
Message returned by InternalErrorException.
HTTP Status Code: 500

 ** InvalidConfigurationException **   
This exception is thrown when Amazon Cognito detects an invalid configuration.    
 ** message **   
Message returned by InvalidConfigurationException.
HTTP Status Code: 400

 ** InvalidParameterException **   
Thrown when a request parameter does not comply with the associated constraints.    
 ** message **   
Message returned by InvalidParameterException.
HTTP Status Code: 400

 ** NotAuthorizedException **   
Thrown when a user is not authorized to access the requested resource.    
 ** message **   
The message returned by a NotAuthorizedException.
HTTP Status Code: 403

 ** ResourceNotFoundException **   
Thrown if the resource doesn't exist.    
 ** message **   
Message returned by a ResourceNotFoundException.
HTTP Status Code: 404

 ** TooManyRequestsException **   
Thrown if the request is throttled.    
 ** message **   
Message returned by a TooManyRequestsException.
HTTP Status Code: 429

## Examples
<a name="API_UnsubscribeFromDataset_Examples"></a>

### UnsubscribeFromDataset
<a name="API_UnsubscribeFromDataset_Example_1"></a>

The following examples have been edited for readability.

#### Sample Request
<a name="API_UnsubscribeFromDataset_Example_1_Request"></a>

```
POST / HTTP/1.1
CONTENT-TYPE: application/json
X-AMZ-REQUESTSUPERTRACE: true
X-AMZN-REQUESTID: 676896d6-14ca-45b1-8029-6d36b10a077e
X-AMZ-TARGET: com.amazonaws.cognito.sync.model.AWSCognitoSyncService.UnsubscribeFromDataset
HOST: cognito-sync.us-east-1.amazonaws.com
X-AMZ-DATE: 20141004T195446Z
X-AMZ-SECURITY-TOKEN: <securitytoken>
AUTHORIZATION: AWS4-HMAC-SHA256 Credential=<credential>, SignedHeaders=content-type;content-length;host;x-amz-date;x-amz-target, Signature=<signature>

{
    "IdentityPoolId": "ID_POOL_ID",
    "IdentityId": "IDENTITY_ID",
    "DatasetName": "Rufus",
    "DeviceId": "5cd28fbe-dd83-47ab-9f83-19093a5fb014"
}
```

#### Sample Response
<a name="API_UnsubscribeFromDataset_Example_1_Response"></a>

```
1.1 200 OK
x-amzn-requestid: 676896d6-14ca-45b1-8029-6d36b10a077e
date: Sat, 04 Oct 2014 19:54:46 GMT
content-type: application/json
content-length: 103

{
}
```

## See Also
<a name="API_UnsubscribeFromDataset_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cognito-sync-2014-06-30/UnsubscribeFromDataset) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cognito-sync-2014-06-30/UnsubscribeFromDataset) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cognito-sync-2014-06-30/UnsubscribeFromDataset) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cognito-sync-2014-06-30/UnsubscribeFromDataset) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cognito-sync-2014-06-30/UnsubscribeFromDataset) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cognito-sync-2014-06-30/UnsubscribeFromDataset) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cognito-sync-2014-06-30/UnsubscribeFromDataset) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cognito-sync-2014-06-30/UnsubscribeFromDataset) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cognito-sync-2014-06-30/UnsubscribeFromDataset) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cognito-sync-2014-06-30/UnsubscribeFromDataset) 

# UpdateRecords
<a name="API_UpdateRecords"></a>

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.

## Request Syntax
<a name="API_UpdateRecords_RequestSyntax"></a>

```
POST /identitypools/IdentityPoolId/identities/IdentityId/datasets/DatasetName HTTP/1.1
x-amz-Client-Context: ClientContext
Content-type: application/json

{
   "DeviceId": "string",
   "RecordPatches": [ 
      { 
         "DeviceLastModifiedDate": number,
         "Key": "string",
         "Op": "string",
         "SyncCount": number,
         "Value": "string"
      }
   ],
   "SyncSessionToken": "string"
}
```

## URI Request Parameters
<a name="API_UpdateRecords_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ClientContext](#API_UpdateRecords_RequestSyntax) **   <a name="Cognito-UpdateRecords-request-ClientContext"></a>
Intended to supply a device ID that will populate the lastModifiedBy field referenced in other methods. The ClientContext field is not yet implemented.

 ** [DatasetName](#API_UpdateRecords_RequestSyntax) **   <a name="Cognito-UpdateRecords-request-uri-DatasetName"></a>
A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '\$1' (underscore), '-' (dash), and '.' (dot).  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9_.:-]+`   
Required: Yes

 ** [IdentityId](#API_UpdateRecords_RequestSyntax) **   <a name="Cognito-UpdateRecords-request-uri-IdentityId"></a>
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.  
Length Constraints: Minimum length of 1. Maximum length of 55.  
Pattern: `[\w-]+:[0-9a-f-]+`   
Required: Yes

 ** [IdentityPoolId](#API_UpdateRecords_RequestSyntax) **   <a name="Cognito-UpdateRecords-request-uri-IdentityPoolId"></a>
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.  
Length Constraints: Minimum length of 1. Maximum length of 55.  
Pattern: `[\w-]+:[0-9a-f-]+`   
Required: Yes

## Request Body
<a name="API_UpdateRecords_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [DeviceId](#API_UpdateRecords_RequestSyntax) **   <a name="Cognito-UpdateRecords-request-DeviceId"></a>
The unique ID generated for this device by Cognito.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

 ** [RecordPatches](#API_UpdateRecords_RequestSyntax) **   <a name="Cognito-UpdateRecords-request-RecordPatches"></a>
A list of patch operations.  
Type: Array of [RecordPatch](API_RecordPatch.md) objects  
Required: No

 ** [SyncSessionToken](#API_UpdateRecords_RequestSyntax) **   <a name="Cognito-UpdateRecords-request-SyncSessionToken"></a>
The SyncSessionToken returned by a previous call to ListRecords for this dataset and identity.  
Type: String  
Required: Yes

## Response Syntax
<a name="API_UpdateRecords_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Records": [ 
      { 
         "DeviceLastModifiedDate": number,
         "Key": "string",
         "LastModifiedBy": "string",
         "LastModifiedDate": number,
         "SyncCount": number,
         "Value": "string"
      }
   ]
}
```

## Response Elements
<a name="API_UpdateRecords_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Records](#API_UpdateRecords_ResponseSyntax) **   <a name="Cognito-UpdateRecords-response-Records"></a>
A list of records that have been updated.  
Type: Array of [Record](API_Record.md) objects

## Errors
<a name="API_UpdateRecords_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalErrorException **   
Indicates an internal service error.    
 ** message **   
Message returned by InternalErrorException.
HTTP Status Code: 500

 ** InvalidLambdaFunctionOutputException **   
The AWS Lambda function returned invalid output or an exception.    
 ** message **   
A message returned when an InvalidLambdaFunctionOutputException occurs
HTTP Status Code: 400

 ** InvalidParameterException **   
Thrown when a request parameter does not comply with the associated constraints.    
 ** message **   
Message returned by InvalidParameterException.
HTTP Status Code: 400

 ** LambdaSocketTimeoutException **   
This exception is thrown when your Lambda function fails to respond within 5 seconds. For more information, see [Amazon Cognito Events](http://docs.aws.amazon.com/cognito/latest/developerguide/cognito-events.html).  
HTTP Status Code: 400

 ** LambdaThrottledException **   
AWS Lambda throttled your account, please contact AWS Support    
 ** message **   
A message returned when an LambdaThrottledException is thrown
HTTP Status Code: 429

 ** LimitExceededException **   
Thrown when the limit on the number of objects or operations has been exceeded.    
 ** message **   
Message returned by LimitExceededException.
HTTP Status Code: 400

 ** NotAuthorizedException **   
Thrown when a user is not authorized to access the requested resource.    
 ** message **   
The message returned by a NotAuthorizedException.
HTTP Status Code: 403

 ** ResourceConflictException **   
Thrown if an update can't be applied because the resource was changed by another call and this would result in a conflict.    
 ** message **   
The message returned by a ResourceConflictException.
HTTP Status Code: 409

 ** ResourceNotFoundException **   
Thrown if the resource doesn't exist.    
 ** message **   
Message returned by a ResourceNotFoundException.
HTTP Status Code: 404

 ** TooManyRequestsException **   
Thrown if the request is throttled.    
 ** message **   
Message returned by a TooManyRequestsException.
HTTP Status Code: 429

## See Also
<a name="API_UpdateRecords_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cognito-sync-2014-06-30/UpdateRecords) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cognito-sync-2014-06-30/UpdateRecords) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cognito-sync-2014-06-30/UpdateRecords) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cognito-sync-2014-06-30/UpdateRecords) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cognito-sync-2014-06-30/UpdateRecords) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cognito-sync-2014-06-30/UpdateRecords) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cognito-sync-2014-06-30/UpdateRecords) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cognito-sync-2014-06-30/UpdateRecords) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cognito-sync-2014-06-30/UpdateRecords) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cognito-sync-2014-06-30/UpdateRecords)