{
  "version":"2.0",
  "metadata":{
    "apiVersion":"2014-06-30",
    "endpointPrefix":"cognito-sync",
    "jsonVersion":"1.1",
    "serviceFullName":"Amazon Cognito Sync",
    "signatureVersion":"v4",
    "protocol":"rest-json",
    "uid":"cognito-sync-2014-06-30"
  },
  "documentation":"<fullname>Amazon Cognito Sync</fullname> <p>Amazon Cognito Sync provides an AWS service and client library that enable cross-device syncing of application-related user data. High-level client libraries are available for both iOS and Android. You can use these libraries to persist data locally so that it's available even if the device is offline. Developer credentials don't need to be stored on the mobile device to access the service. You can use Amazon Cognito to obtain a normalized user ID and credentials. User data is persisted in a dataset that can store up to 1 MB of key-value pairs, and you can have up to 20 datasets per user identity.</p> <p>With Amazon Cognito Sync, the data stored for each identity is accessible only to credentials assigned to that identity. In order to use the Cognito Sync service, you need to make API calls using credentials retrieved with <a href=\"http://docs.aws.amazon.com/cognitoidentity/latest/APIReference/Welcome.html\">Amazon Cognito Identity service</a>.</p> <p>If you want to use Cognito Sync in an Android or iOS application, you will probably want to make API calls via the AWS Mobile SDK. To learn more, see the <a href=\"http://docs.aws.amazon.com/mobile/sdkforandroid/developerguide/cognito-sync.html\">Developer Guide for Android</a> and the <a href=\"http://docs.aws.amazon.com/mobile/sdkforios/developerguide/cognito-sync.html\">Developer Guide for iOS</a>.</p>",
  "operations":{
    "BulkPublish":{
      "name":"BulkPublish",
      "http":{
        "method":"POST",
        "requestUri":"/identitypools/{IdentityPoolId}/bulkpublish",
        "responseCode":200
      },
      "input":{
        "shape":"BulkPublishRequest",
        "documentation":"The input for the BulkPublish operation."
      },
      "output":{
        "shape":"BulkPublishResponse",
        "documentation":"The output for the BulkPublish operation."
      },
      "errors":[
        {
          "shape":"NotAuthorizedException",
          "error":{
            "code":"NotAuthorizedError",
            "httpStatusCode":403,
            "senderFault":true
          },
          "exception":true,
          "documentation":"Thrown when a user is not authorized to access the requested resource."
        },
        {
          "shape":"InvalidParameterException",
          "error":{
            "code":"InvalidParameter",
            "httpStatusCode":400,
            "senderFault":true
          },
          "exception":true,
          "documentation":"Thrown when a request parameter does not comply with the associated constraints."
        },
        {
          "shape":"ResourceNotFoundException",
          "error":{
            "code":"ResourceNotFound",
            "httpStatusCode":404,
            "senderFault":true
          },
          "exception":true,
          "documentation":"Thrown if the resource doesn't exist."
        },
        {
          "shape":"InternalErrorException",
          "error":{
            "code":"InternalError",
            "httpStatusCode":500
          },
          "exception":true,
          "fault":true,
          "documentation":"Indicates an internal service error."
        },
        {
          "shape":"DuplicateRequestException",
          "error":{
            "code":"DuplicateRequest",
            "httpStatusCode":400,
            "senderFault":true
          },
          "exception":true,
          "documentation":"An exception thrown when there is an IN_PROGRESS bulk publish operation for the given identity pool."
        },
        {
          "shape":"AlreadyStreamedException",
          "error":{
            "code":"AlreadyStreamed",
            "httpStatusCode":400,
            "senderFault":true
          },
          "exception":true,
          "documentation":"An exception thrown when a bulk publish operation is requested less than 24 hours after a previous bulk publish operation completed successfully."
        }
      ],
      "documentation":"<p>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.</p> <p>This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.</p>"
    },
    "DeleteDataset":{
      "name":"DeleteDataset",
      "http":{
        "method":"DELETE",
        "requestUri":"/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}",
        "responseCode":200
      },
      "input":{
        "shape":"DeleteDatasetRequest",
        "documentation":"A request to delete the specific dataset."
      },
      "output":{
        "shape":"DeleteDatasetResponse",
        "documentation":"Response to a successful DeleteDataset request."
      },
      "errors":[
        {
          "shape":"NotAuthorizedException",
          "error":{
            "code":"NotAuthorizedError",
            "httpStatusCode":403,
            "senderFault":true
          },
          "exception":true,
          "documentation":"Thrown when a user is not authorized to access the requested resource."
        },
        {
          "shape":"InvalidParameterException",
          "error":{
            "code":"InvalidParameter",
            "httpStatusCode":400,
            "senderFault":true
          },
          "exception":true,
          "documentation":"Thrown when a request parameter does not comply with the associated constraints."
        },
        {
          "shape":"ResourceNotFoundException",
          "error":{
            "code":"ResourceNotFound",
            "httpStatusCode":404,
            "senderFault":true
          },
          "exception":true,
          "documentation":"Thrown if the resource doesn't exist."
        },
        {
          "shape":"InternalErrorException",
          "error":{
            "code":"InternalError",
            "httpStatusCode":500
          },
          "exception":true,
          "fault":true,
          "documentation":"Indicates an internal service error."
        },
        {
          "shape":"TooManyRequestsException",
          "error":{
            "code":"TooManyRequests",
            "httpStatusCode":429,
            "senderFault":true
          },
          "exception":true,
          "documentation":"Thrown if the request is throttled."
        },
        {
          "shape":"ResourceConflictException",
          "error":{
            "code":"ResourceConflict",
            "httpStatusCode":409,
            "senderFault":true
          },
          "exception":true,
          "documentation":"Thrown if an update can't be applied because the resource was changed by another call and this would result in a conflict."
        }
      ],
      "documentation":"<p>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.</p> <p>This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials.</p>"
    },
    "DescribeDataset":{
      "name":"DescribeDataset",
      "http":{
        "method":"GET",
        "requestUri":"/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}",
        "responseCode":200
      },
      "input":{
        "shape":"DescribeDatasetRequest",
        "documentation":"A request for meta data about a dataset (creation date, number of records, size) by owner and dataset name."
      },
      "output":{
        "shape":"DescribeDatasetResponse",
        "documentation":"Response to a successful DescribeDataset request."
      },
      "errors":[
        {
          "shape":"NotAuthorizedException",
          "error":{
            "code":"NotAuthorizedError",
            "httpStatusCode":403,
            "senderFault":true
          },
          "exception":true,
          "documentation":"Thrown when a user is not authorized to access the requested resource."
        },
        {
          "shape":"InvalidParameterException",
          "error":{
            "code":"InvalidParameter",
            "httpStatusCode":400,
            "senderFault":true
          },
          "exception":true,
          "documentation":"Thrown when a request parameter does not comply with the associated constraints."
        },
        {
          "shape":"ResourceNotFoundException",
          "error":{
            "code":"ResourceNotFound",
            "httpStatusCode":404,
            "senderFault":true
          },
          "exception":true,
          "documentation":"Thrown if the resource doesn't exist."
        },
        {
          "shape":"InternalErrorException",
          "error":{
            "code":"InternalError",
            "httpStatusCode":500
          },
          "exception":true,
          "fault":true,
          "documentation":"Indicates an internal service error."
        },
        {
          "shape":"TooManyRequestsException",
          "error":{
            "code":"TooManyRequests",
            "httpStatusCode":429,
            "senderFault":true
          },
          "exception":true,
          "documentation":"Thrown if the request is throttled."
        }
      ],
      "documentation":"<p>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.</p> <p>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.</p>"
    },
    "DescribeIdentityPoolUsage":{
      "name":"DescribeIdentityPoolUsage",
      "http":{
        "method":"GET",
        "requestUri":"/identitypools/{IdentityPoolId}",
        "responseCode":200
      },
      "input":{
        "shape":"DescribeIdentityPoolUsageRequest",
        "documentation":"A request for usage information about the identity pool."
      },
      "output":{
        "shape":"DescribeIdentityPoolUsageResponse",
        "documentation":"Response to a successful DescribeIdentityPoolUsage request."
      },
      "errors":[
        {
          "shape":"NotAuthorizedException",
          "error":{
            "code":"NotAuthorizedError",
            "httpStatusCode":403,
            "senderFault":true
          },
          "exception":true,
          "documentation":"Thrown when a user is not authorized to access the requested resource."
        },
        {
          "shape":"InvalidParameterException",
          "error":{
            "code":"InvalidParameter",
            "httpStatusCode":400,
            "senderFault":true
          },
          "exception":true,
          "documentation":"Thrown when a request parameter does not comply with the associated constraints."
        },
        {
          "shape":"ResourceNotFoundException",
          "error":{
            "code":"ResourceNotFound",
            "httpStatusCode":404,
            "senderFault":true
          },
          "exception":true,
          "documentation":"Thrown if the resource doesn't exist."
        },
        {
          "shape":"InternalErrorException",
          "error":{
            "code":"InternalError",
            "httpStatusCode":500
          },
          "exception":true,
          "fault":true,
          "documentation":"Indicates an internal service error."
        },
        {
          "shape":"TooManyRequestsException",
          "error":{
            "code":"TooManyRequests",
            "httpStatusCode":429,
            "senderFault":true
          },
          "exception":true,
          "documentation":"Thrown if the request is throttled."
        }
      ],
      "documentation":"<p>Gets usage details (for example, data storage) about a particular identity pool.</p> <p>This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.</p>"
    },
    "DescribeIdentityUsage":{
      "name":"DescribeIdentityUsage",
      "http":{
        "method":"GET",
        "requestUri":"/identitypools/{IdentityPoolId}/identities/{IdentityId}",
        "responseCode":200
      },
      "input":{
        "shape":"DescribeIdentityUsageRequest",
        "documentation":"A request for information about the usage of an identity pool."
      },
      "output":{
        "shape":"DescribeIdentityUsageResponse",
        "documentation":"The response to a successful DescribeIdentityUsage request."
      },
      "errors":[
        {
          "shape":"NotAuthorizedException",
          "error":{
            "code":"NotAuthorizedError",
            "httpStatusCode":403,
            "senderFault":true
          },
          "exception":true,
          "documentation":"Thrown when a user is not authorized to access the requested resource."
        },
        {
          "shape":"InvalidParameterException",
          "error":{
            "code":"InvalidParameter",
            "httpStatusCode":400,
            "senderFault":true
          },
          "exception":true,
          "documentation":"Thrown when a request parameter does not comply with the associated constraints."
        },