1197 lines
42 KiB
JSON
1197 lines
42 KiB
JSON
|
{
|
||
|
|
"metadata":{
|
||
|
|
"apiVersion":"2014-06-30",
|
||
|
|
"endpointPrefix":"cognito-sync",
|
||
|
|
"jsonVersion":"1.1",
|
||
|
|
"serviceFullName":"Amazon Cognito Sync",
|
||
|
|
"signatureVersion":"v4",
|
||
|
|
"protocol":"rest-json"
|
||
|
|
},
|
||
|
|
"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>",
|
||
|
|
"operations":{
|
||
|
|
"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."
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"documentation":"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 consequent operation on this dataset will result in a ResourceNotFoundException."
|
||
|
|
},
|
||
|
|
"DescribeDataset":{
|
||
|
|
"name":"DescribeDataset",
|
||
|
|
"http":{
|
||
|
|
"method":"GET",
|
||
|
|
"requestUri":"/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}",
|
||
|
|
"responseCode":200
|
||
|
|
},
|
||
|
|
"input":{
|
||
|
|
"shape":"DescribeDatasetRequest",
|
||
|
|
"documentation":"A request for metadata 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."
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"documentation":"Gets metadata about a dataset by identity and dataset name. The credentials used to make this API call need to have access to the identity data. With Amazon Cognito Sync, each identity has access only to its own data. You should use Amazon Cognito Identity service to retrieve the credentials necessary to make this API call."
|
||
|
|
},
|
||
|
|
"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."
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"documentation":"Gets usage details (for example, data storage) about a particular identity pool."
|
||
|
|
},
|
||
|
|
"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."
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"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."
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"documentation":"Gets usage information for an identity, including number of datasets and data usage."
|
||
|
|
},
|
||
|
|
"ListDatasets":{
|
||
|
|
"name":"ListDatasets",
|
||
|
|
"http":{
|
||
|
|
"method":"GET",
|
||
|
|
"requestUri":"/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets",
|
||
|
|
"responseCode":200
|
||
|
|
},
|
||
|
|
"input":{
|
||
|
|
"shape":"ListDatasetsRequest",
|
||
|
|
"documentation":"Request for a list of datasets for an identity."
|
||
|
|
},
|
||
|
|
"output":{
|
||
|
|
"shape":"ListDatasetsResponse",
|
||
|
|
"documentation":"Returned for a successful ListDatasets 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":"InternalErrorException",
|
||
|
|
"error":{
|
||
|
|
"code":"InternalError",
|
||
|
|
"httpStatusCode":500
|
||
|
|
},
|
||
|
|
"exception":true,
|
||
|
|
"fault":true,
|
||
|
|
"documentation":"Indicates an internal service error."
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"documentation":"Lists datasets for an identity. The credentials used to make this API call need to have access to the identity data. With Amazon Cognito Sync, each identity has access only to its own data. You should use Amazon Cognito Identity service to retrieve the credentials necessary to make this API call."
|
||
|
|
},
|
||
|
|
"ListIdentityPoolUsage":{
|
||
|
|
"name":"ListIdentityPoolUsage",
|
||
|
|
"http":{
|
||
|
|
"method":"GET",
|
||
|
|
"requestUri":"/identitypools",
|
||
|
|
"responseCode":200
|
||
|
|
},
|
||
|
|
"input":{
|
||
|
|
"shape":"ListIdentityPoolUsageRequest",
|
||
|
|
"documentation":"A request for usage information on an identity pool."
|
||
|
|
},
|
||
|
|
"output":{
|
||
|
|
"shape":"ListIdentityPoolUsageResponse",
|
||
|
|
"documentation":"Returned for a successful ListIdentityPoolUsage 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":"InternalErrorException",
|
||
|
|
"error":{
|
||
|
|
"code":"InternalError",
|
||
|
|
"httpStatusCode":500
|
||
|
|
},
|
||
|
|
"exception":true,
|
||
|
|
"fault":true,
|
||
|
|
"documentation":"Indicates an internal service error."
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"documentation":"Gets a list of identity pools registered with Cognito."
|
||
|
|
},
|
||
|
|
"ListRecords":{
|
||
|
|
"name":"ListRecords",
|
||
|
|
"http":{
|
||
|
|
"method":"GET",
|
||
|
|
"requestUri":"/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}/records",
|
||
|
|
"responseCode":200
|
||
|
|
},
|
||
|
|
"input":{
|
||
|
|
"shape":"ListRecordsRequest",
|
||
|
|
"documentation":"A request for a list of records."
|
||
|
|
},
|
||
|
|
"output":{
|
||
|
|
"shape":"ListRecordsResponse",
|
||
|
|
"documentation":"Returned for a successful ListRecordsRequest."
|
||
|
|
},
|
||
|
|
"errors":[
|
||
|
|
{
|
||
|
|
"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":"NotAuthorizedException",
|
||
|
|
"error":{
|
||
|
|
"code":"NotAuthorizedError",
|
||
|
|
"httpStatusCode":403,
|
||
|
|
"senderFault":true
|
||
|
|
},
|
||
|
|
"exception":true,
|
||
|
|
"documentation":"Thrown when a user is not authorized to access the requested resource."
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"shape":"TooManyRequestsException",
|
||
|
|
"error":{
|
||
|
|
"code":"TooManyRequests",
|
||
|
|
"httpStatusCode":429,
|
||
|
|
"senderFault":true
|
||
|
|
},
|
||
|
|
"exception":true,
|
||
|
|
"documentation":"Thrown if the request is throttled."
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"shape":"InternalErrorException",
|
||
|
|
"error":{
|
||
|
|
"code":"InternalError",
|
||
|
|
"httpStatusCode":500
|
||
|
|
},
|
||
|
|
"exception":true,
|
||
|
|
"fault":true,
|
||
|
|
"documentation":"Indicates an internal service error."
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"documentation":"Gets paginated records, optionally changed after a particular sync count for a dataset and identity. The credentials used to make this API call need to have access to the identity data. With Amazon Cognito Sync, each identity has access only to its own data. You should use Amazon Cognito Identity service to retrieve the credentials necessary to make this API call."
|
||
|
|
},
|
||
|
|
"UpdateRecords":{
|
||
|
|
"name":"UpdateRecords",
|
||
|
|
"http":{
|
||
|
|
"method":"POST",
|
||
|
|
"requestUri":"/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}",
|
||
|
|
"responseCode":200
|
||
|
|
},
|
||
|
|
"input":{
|
||
|
|
"shape":"UpdateRecordsRequest",
|
||
|
|
"documentation":"A request to post updates to records or add and delete records for a dataset and user."
|
||
|
|
},
|
||
|
|
"output":{
|
||
|
|
"shape":"UpdateRecordsResponse",
|
||
|
|
"documentation":"Returned for a successful UpdateRecordsRequest."
|
||
|
|
},
|
||
|
|
"errors":[
|
||
|
|
{
|
||
|
|
"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":"LimitExceededException",
|
||
|
|
"error":{
|
||
|
|
"code":"LimitExceeded",
|
||
|
|
"httpStatusCode":400,
|
||
|
|
"senderFault":true
|
||
|
|
},
|
||
|
|
"exception":true,
|
||
|
|
"documentation":"Thrown when the limit on the number of objects or operations has been exceeded."
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"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":"ResourceNotFoundException",
|
||
|
|
"error":{
|
||
|
|
"code":"ResourceNotFound",
|
||
|
|
"httpStatusCode":404,
|
||
|
|
"senderFault":true
|
||
|
|
},
|
||
|
|
"exception":true,
|
||
|
|
"documentation":"Thrown if the resource doesn't exist."
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"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."
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"shape":"TooManyRequestsException",
|
||
|
|
"error":{
|
||
|
|
"code":"TooManyRequests",
|
||
|
|
"httpStatusCode":429,
|
||
|
|
"senderFault":true
|
||
|
|
},
|
||
|
|
"exception":true,
|
||
|
|
"documentation":"Thrown if the request is throttled."
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"shape":"InternalErrorException",
|
||
|
|
"error":{
|
||
|
|
"code":"InternalError",
|
||
|
|
"httpStatusCode":500
|
||
|
|
},
|
||
|
|
"exception":true,
|
||
|
|
"fault":true,
|
||
|
|
"documentation":"Indicates an internal service error."
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"documentation":"Posts updates to records and add and delete records for a dataset and user. The credentials used to make this API call need to have access to the identity data. With Amazon Cognito Sync, each identity has access only to its own data. You should use Amazon Cognito Identity service to retrieve the credentials necessary to make this API call."
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"shapes":{
|
||
|
|
"Boolean":{"type":"boolean"},
|
||
|
|
"ClientContext":{"type":"string"},
|
||
|
|
"Dataset":{
|
||
|
|
"type":"structure",
|
||
|
|
"members":{
|
||
|
|
"IdentityId":{
|
||
|
|
"shape":"IdentityId",
|
||
|
|
"documentation":"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."
|
||
|
|
},
|
||
|
|
"DatasetName":{
|
||
|
|
"shape":"DatasetName",
|
||
|
|
"documentation":"A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot)."
|
||
|
|
},
|
||
|
|
"CreationDate":{
|
||
|
|
"shape":"Date",
|
||
|
|
"documentation":"Date on which the dataset was created."
|
||
|
|
},
|
||
|
|
"LastModifiedDate":{
|
||
|
|
"shape":"Date",
|
||
|
|
"documentation":"Date when the dataset was last modified."
|
||
|
|
},
|
||
|
|
"LastModifiedBy":{
|
||
|
|
"shape":"String",
|
||
|
|
"documentation":"The device that made the last change to this dataset."
|
||
|
|
},
|
||
|
|
"DataStorage":{
|
||
|
|
"shape":"Long",
|
||
|
|
"documentation":"Total size in bytes of the records in this dataset."
|
||
|
|
},
|
||
|
|
"NumRecords":{
|
||
|
|
"shape":"Long",
|
||
|
|
"documentation":"Number of records in this dataset."
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"documentation":"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."
|
||
|
|
},
|
||
|
|
"DatasetList":{
|
||
|
|
"type":"list",
|
||
|
|
"member":{"shape":"Dataset"}
|
||
|
|
},
|
||
|
|
"DatasetName":{
|
||
|
|
"type":"string",
|
||
|
|
"min":1,
|
||
|
|
"max":128,
|
||
|
|
"pattern":"[a-zA-Z0-9_.:-]+"
|
||
|
|
},
|
||
|
|
"Date":{"type":"timestamp"},
|
||
|
|
"DeleteDatasetRequest":{
|
||
|
|
"type":"structure",
|
||
|
|
"required":[
|
||
|
|
"IdentityPoolId",
|
||
|
|
"IdentityId",
|
||
|
|
"DatasetName"
|
||
|
|
],
|
||
|
|
"members":{
|
||
|
|
"IdentityPoolId":{
|
||
|
|
"shape":"IdentityPoolId",
|
||
|
|
"location":"uri",
|
||
|
|
"locationName":"IdentityPoolId",
|
||
|
|
"documentation":"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."
|
||
|
|
},
|
||
|
|
"IdentityId":{
|
||
|
|
"shape":"IdentityId",
|
||
|
|
"location":"uri",
|
||
|
|
"locationName":"IdentityId",
|
||
|
|
"documentation":"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."
|
||
|
|
},
|
||
|
|
"DatasetName":{
|
||
|
|
"shape":"DatasetName",
|
||
|
|
"location":"uri",
|
||
|
|
"locationName":"DatasetName",
|
||
|
|
"documentation":"A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot)."
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"documentation":"A request to delete the specific dataset."
|
||
|
|
},
|
||
|
|
"DeleteDatasetResponse":{
|
||
|
|
"type":"structure",
|
||
|
|
"members":{
|
||
|
|
"Dataset":{
|
||
|
|
"shape":"Dataset",
|
||
|
|
"documentation":"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."
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"documentation":"Response to a successful DeleteDataset request."
|
||
|
|
},
|
||
|
|
"DescribeDatasetRequest":{
|
||
|
|
"type":"structure",
|
||
|
|
"required":[
|
||
|
|
"IdentityPoolId",
|
||
|
|
"IdentityId",
|
||
|
|
"DatasetName"
|
||
|
|
],
|
||
|
|
"members":{
|
||
|
|
"IdentityPoolId":{
|
||
|
|
"shape":"IdentityPoolId",
|
||
|
|
"location":"uri",
|
||
|
|
"locationName":"IdentityPoolId",
|
||
|
|
"documentation":"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."
|
||
|
|
},
|
||
|
|
"IdentityId":{
|
||
|
|
"shape":"IdentityId",
|
||
|
|
"location":"uri",
|
||
|
|
"locationName":"IdentityId",
|
||
|
|
"documentation":"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."
|
||
|
|
},
|
||
|
|
"DatasetName":{
|
||
|
|
"shape":"DatasetName",
|
||
|
|
"location":"uri",
|
||
|
|
"locationName":"DatasetName",
|
||
|
|
"documentation":"A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot)."
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"documentation":"A request for metadata about a dataset (creation date, number of records, size) by owner and dataset name."
|
||
|
|
},
|
||
|
|
"DescribeDatasetResponse":{
|
||
|
|
"type":"structure",
|
||
|
|
"members":{
|
||
|
|
"Dataset":{
|
||
|
|
"shape":"Dataset",
|
||
|
|
"documentation":"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."
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"documentation":"Response to a successful DescribeDataset request."
|
||
|
|
},
|
||
|
|
"DescribeIdentityPoolUsageRequest":{
|
||
|
|
"type":"structure",
|
||
|
|
"required":["IdentityPoolId"],
|
||
|
|
"members":{
|
||
|
|
"IdentityPoolId":{
|
||
|
|
"shape":"IdentityPoolId",
|
||
|
|
"location":"uri",
|
||
|
|
"locationName":"IdentityPoolId",
|
||
|
|
"documentation":"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."
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"documentation":"A request for usage information about the identity pool."
|
||
|
|
},
|
||
|
|
"DescribeIdentityPoolUsageResponse":{
|
||
|
|
"type":"structure",
|
||
|
|
"members":{
|
||
|
|
"IdentityPoolUsage":{
|
||
|
|
"shape":"IdentityPoolUsage",
|
||
|
|
"documentation":"Information about the usage of the identity pool."
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"documentation":"Response to a successful DescribeIdentityPoolUsage request."
|
||
|
|
},
|
||
|
|
"DescribeIdentityUsageRequest":{
|
||
|
|
"type":"structure",
|
||
|
|
"required":[
|
||
|
|
"IdentityPoolId",
|
||
|
|
"IdentityId"
|
||
|
|
],
|
||
|
|
"members":{
|
||
|
|
"IdentityPoolId":{
|
||
|
|
"shape":"IdentityPoolId",
|
||
|
|
"location":"uri",
|
||
|
|
"locationName":"IdentityPoolId",
|
||
|
|
"documentation":"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."
|
||
|
|
},
|
||
|
|
"IdentityId":{
|
||
|
|
"shape":"IdentityId",
|
||
|
|
"location":"uri",
|
||
|
|
"locationName":"IdentityId",
|
||
|
|
"documentation":"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."
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"documentation":"A request for information about the usage of an identity pool."
|
||
|
|
},
|
||
|
|
"DescribeIdentityUsageResponse":{
|
||
|
|
"type":"structure",
|
||
|
|
"members":{
|
||
|
|
"IdentityUsage":{
|
||
|
|
"shape":"IdentityUsage",
|
||
|
|
"documentation":"Usage information for the identity."
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"documentation":"The response to a successful DescribeIdentityUsage request."
|
||
|
|
},
|
||
|
|
"ExceptionMessage":{"type":"string"},
|
||
|
|
"IdentityId":{
|
||
|
|
"type":"string",
|
||
|
|
"min":1,
|
||
|
|
"max":50,
|
||
|
|
"pattern":"[\\w-]+:[0-9a-f-]+"
|
||
|
|
},
|
||
|
|
"IdentityPoolId":{
|
||
|
|
"type":"string",
|
||
|
|
"min":1,
|
||
|
|
"max":50,
|
||
|
|
"pattern":"[\\w-]+:[0-9a-f-]+"
|
||
|
|
},
|
||
|
|
"IdentityPoolUsage":{
|
||
|
|
"type":"structure",
|
||
|
|
"members":{
|
||
|
|
"IdentityPoolId":{
|
||
|
|
"shape":"IdentityPoolId",
|
||
|
|
"documentation":"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."
|
||
|
|
},
|
||
|
|
"SyncSessionsCount":{
|
||
|
|
"shape":"Long",
|
||
|
|
"documentation":"Number of sync sessions for the identity pool."
|
||
|
|
},
|
||
|
|
"DataStorage":{
|
||
|
|
"shape":"Long",
|
||
|
|
"documentation":"Data storage information for the identity pool."
|
||
|
|
},
|
||
|
|
"LastModifiedDate":{
|
||
|
|
"shape":"Date",
|
||
|
|
"documentation":"Date on which the identity pool was last modified."
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"documentation":"Usage information for the identity pool."
|
||
|
|
},
|
||
|
|
"IdentityPoolUsageList":{
|
||
|
|
"type":"list",
|
||
|
|
"member":{"shape":"IdentityPoolUsage"}
|
||
|
|
},
|
||
|
|
"IdentityUsage":{
|
||
|
|
"type":"structure",
|
||
|
|
"members":{
|
||
|
|
"IdentityId":{
|
||
|
|
"shape":"IdentityId",
|
||
|
|
"documentation":"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."
|
||
|
|
},
|
||
|
|
"IdentityPoolId":{
|
||
|
|
"shape":"IdentityPoolId",
|
||
|
|
"documentation":"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."
|
||
|
|
},
|
||
|
|
"LastModifiedDate":{
|
||
|
|
"shape":"Date",
|
||
|
|
"documentation":"Date on which the identity was last modified."
|
||
|
|
},
|
||
|
|
"DatasetCount":{
|
||
|
|
"shape":"Integer",
|
||
|
|
"documentation":"Number of datasets for the identity."
|
||
|
|
},
|
||
|
|
"DataStorage":{
|
||
|
|
"shape":"Long",
|
||
|
|
"documentation":"Total data storage for this identity."
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"documentation":"Usage information for the identity."
|
||
|
|
},
|
||
|
|
"Integer":{"type":"integer"},
|
||
|
|
"IntegerString":{"type":"integer"},
|
||
|
|
"InternalErrorException":{
|
||
|
|
"type":"structure",
|
||
|
|
"required":["message"],
|
||
|
|
"members":{
|
||
|
|
"message":{
|
||
|
|
"shape":"ExceptionMessage",
|
||
|
|
"documentation":"Message returned by InternalErrorException."
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"error":{
|
||
|
|
"code":"InternalError",
|
||
|
|
"httpStatusCode":500
|
||
|
|
},
|
||
|
|
"exception":true,
|
||
|
|
"fault":true,
|
||
|
|
"documentation":"Indicates an internal service error."
|
||
|
|
},
|
||
|
|
"InvalidParameterException":{
|
||
|
|
"type":"structure",
|
||
|
|
"required":["message"],
|
||
|
|
"members":{
|
||
|
|
"message":{
|
||
|
|
"shape":"ExceptionMessage",
|
||
|
|
"documentation":"Message returned by InvalidParameterException."
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"error":{
|
||
|
|
"code":"InvalidParameter",
|
||
|
|
"httpStatusCode":400,
|
||
|
|
"senderFault":true
|
||
|
|
},
|
||
|
|
"exception":true,
|
||
|
|
"documentation":"Thrown when a request parameter does not comply with the associated constraints."
|
||
|
|
},
|
||
|
|
"LimitExceededException":{
|
||
|
|
"type":"structure",
|
||
|
|
"required":["message"],
|
||
|
|
"members":{
|
||
|
|
"message":{
|
||
|
|
"shape":"ExceptionMessage",
|
||
|
|
"documentation":"Message returned by LimitExceededException."
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"error":{
|
||
|
|
"code":"LimitExceeded",
|
||
|
|
"httpStatusCode":400,
|
||
|
|
"senderFault":true
|
||
|
|
},
|
||
|
|
"exception":true,
|
||
|
|
"documentation":"Thrown when the limit on the number of objects or operations has been exceeded."
|
||
|
|
},
|
||
|
|
"ListDatasetsRequest":{
|
||
|
|
"type":"structure",
|
||
|
|
"required":[
|
||
|
|
"IdentityId",
|
||
|
|
"IdentityPoolId"
|
||
|
|
],
|
||
|
|
"members":{
|
||
|
|
"IdentityPoolId":{
|
||
|
|
"shape":"IdentityPoolId",
|
||
|
|
"location":"uri",
|
||
|
|
"locationName":"IdentityPoolId",
|
||
|
|
"documentation":"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."
|
||
|
|
},
|
||
|
|
"IdentityId":{
|
||
|
|
"shape":"IdentityId",
|
||
|
|
"location":"uri",
|
||
|
|
"locationName":"IdentityId",
|
||
|
|
"documentation":"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."
|
||
|
|
},
|
||
|
|
"NextToken":{
|
||
|
|
"shape":"String",
|
||
|
|
"location":"querystring",
|
||
|
|
"locationName":"nextToken",
|
||
|
|
"documentation":"A pagination token for obtaining the next page of results."
|
||
|
|
},
|
||
|
|
"MaxResults":{
|
||
|
|
"shape":"IntegerString",
|
||
|
|
"location":"querystring",
|
||
|
|
"locationName":"maxResults",
|
||
|
|
"documentation":"The maximum number of results to be returned."
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"documentation":"Request for a list of datasets for an identity."
|
||
|
|
},
|
||
|
|
"ListDatasetsResponse":{
|
||
|
|
"type":"structure",
|
||
|
|
"members":{
|
||
|
|
"Datasets":{
|
||
|
|
"shape":"DatasetList",
|
||
|
|
"documentation":"A set of datasets."
|
||
|
|
},
|
||
|
|
"Count":{
|
||
|
|
"shape":"Integer",
|
||
|
|
"documentation":"Number of datasets returned."
|
||
|
|
},
|
||
|
|
"NextToken":{
|
||
|
|
"shape":"String",
|
||
|
|
"documentation":"A pagination token for obtaining the next page of results."
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"documentation":"Returned for a successful ListDatasets request."
|
||
|
|
},
|
||
|
|
"ListIdentityPoolUsageRequest":{
|
||
|
|
"type":"structure",
|
||
|
|
"members":{
|
||
|
|
"NextToken":{
|
||
|
|
"shape":"String",
|
||
|
|
"location":"querystring",
|
||
|
|
"locationName":"nextToken",
|
||
|
|
"documentation":"A pagination token for obtaining the next page of results."
|
||
|
|
},
|
||
|
|
"MaxResults":{
|
||
|
|
"shape":"IntegerString",
|
||
|
|
"location":"querystring",
|
||
|
|
"locationName":"maxResults",
|
||
|
|
"documentation":"The maximum number of results to be returned."
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"documentation":"A request for usage information on an identity pool."
|
||
|
|
},
|
||
|
|
"ListIdentityPoolUsageResponse":{
|
||
|
|
"type":"structure",
|
||
|
|
"members":{
|
||
|
|
"IdentityPoolUsages":{
|
||
|
|
"shape":"IdentityPoolUsageList",
|
||
|
|
"documentation":"Usage information for the identity pools."
|
||
|
|
},
|
||
|
|
"MaxResults":{
|
||
|
|
"shape":"Integer",
|
||
|
|
"documentation":"The maximum number of results to be returned."
|
||
|
|
},
|
||
|
|
"Count":{
|
||
|
|
"shape":"Integer",
|
||
|
|
"documentation":"Total number of identities for the identity pool."
|
||
|
|
},
|
||
|
|
"NextToken":{
|
||
|
|
"shape":"String",
|
||
|
|
"documentation":"A pagination token for obtaining the next page of results."
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"documentation":"Returned for a successful ListIdentityPoolUsage request."
|
||
|
|
},
|
||
|
|
"ListRecordsRequest":{
|
||
|
|
"type":"structure",
|
||
|
|
"required":[
|
||
|
|
"IdentityPoolId",
|
||
|
|
"IdentityId",
|
||
|
|
"DatasetName"
|
||
|
|
],
|
||
|
|
"members":{
|
||
|
|
"IdentityPoolId":{
|
||
|
|
"shape":"IdentityPoolId",
|
||
|
|
"location":"uri",
|
||
|
|
"locationName":"IdentityPoolId",
|
||
|
|
"documentation":"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."
|
||
|
|
},
|
||
|
|
"IdentityId":{
|
||
|
|
"shape":"IdentityId",
|
||
|
|
"location":"uri",
|
||
|
|
"locationName":"IdentityId",
|
||
|
|
"documentation":"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."
|
||
|
|
},
|
||
|
|
"DatasetName":{
|
||
|
|
"shape":"DatasetName",
|
||
|
|
"location":"uri",
|
||
|
|
"locationName":"DatasetName",
|
||
|
|
"documentation":"A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot)."
|
||
|
|
},
|
||
|
|
"LastSyncCount":{
|
||
|
|
"shape":"Long",
|
||
|
|
"location":"querystring",
|
||
|
|
"locationName":"lastSyncCount",
|
||
|
|
"documentation":"The last server sync count for this record."
|
||
|
|
},
|
||
|
|
"NextToken":{
|
||
|
|
"shape":"String",
|
||
|
|
"location":"querystring",
|
||
|
|
"locationName":"nextToken",
|
||
|
|
"documentation":"A pagination token for obtaining the next page of results."
|
||
|
|
},
|
||
|
|
"MaxResults":{
|
||
|
|
"shape":"IntegerString",
|
||
|
|
"location":"querystring",
|
||
|
|
"locationName":"maxResults",
|
||
|
|
"documentation":"The maximum number of results to be returned."
|
||
|
|
},
|
||
|
|
"SyncSessionToken":{
|
||
|
|
"shape":"SyncSessionToken",
|
||
|
|
"location":"querystring",
|
||
|
|
"locationName":"syncSessionToken",
|
||
|
|
"documentation":"A token containing a session ID, identity ID, and expiration."
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"documentation":"A request for a list of records."
|
||
|
|
},
|
||
|
|
"ListRecordsResponse":{
|
||
|
|
"type":"structure",
|
||
|
|
"members":{
|
||
|
|
"Records":{
|
||
|
|
"shape":"RecordList",
|
||
|
|
"documentation":"A list of all records."
|
||
|
|
},
|
||
|
|
"NextToken":{
|
||
|
|
"shape":"String",
|
||
|
|
"documentation":"A pagination token for obtaining the next page of results."
|
||
|
|
},
|
||
|
|
"Count":{
|
||
|
|
"shape":"Integer",
|
||
|
|
"documentation":"Total number of records."
|
||
|
|
},
|
||
|
|
"DatasetSyncCount":{
|
||
|
|
"shape":"Long",
|
||
|
|
"documentation":"Server sync count for this dataset."
|
||
|
|
},
|
||
|
|
"LastModifiedBy":{
|
||
|
|
"shape":"String",
|
||
|
|
"documentation":"The user/device that made the last change to this record."
|
||
|
|
},
|
||
|
|
"MergedDatasetNames":{
|
||
|
|
"shape":"MergedDatasetNameList",
|
||
|
|
"documentation":"Names of merged datasets."
|
||
|
|
},
|
||
|
|
"DatasetExists":{
|
||
|
|
"shape":"Boolean",
|
||
|
|
"documentation":"Indicates whether the dataset exists."
|
||
|
|
},
|
||
|
|
"DatasetDeletedAfterRequestedSyncCount":{
|
||
|
|
"shape":"Boolean",
|
||
|
|
"documentation":"A boolean value specifying whether to delete the dataset locally."
|
||
|
|
},
|
||
|
|
"SyncSessionToken":{
|
||
|
|
"shape":"String",
|
||
|
|
"documentation":"A token containing a session ID, identity ID, and expiration."
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"documentation":"Returned for a successful ListRecordsRequest."
|
||
|
|
},
|
||
|
|
"Long":{"type":"long"},
|
||
|
|
"MergedDatasetNameList":{
|
||
|
|
"type":"list",
|
||
|
|
"member":{"shape":"String"}
|
||
|
|
},
|
||
|
|
"NotAuthorizedException":{
|
||
|
|
"type":"structure",
|
||
|
|
"required":["message"],
|
||
|
|
"members":{
|
||
|
|
"message":{
|
||
|
|
"shape":"ExceptionMessage",
|
||
|
|
"documentation":"The message returned by a NotAuthorizedException."
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"error":{
|
||
|
|
"code":"NotAuthorizedError",
|
||
|
|
"httpStatusCode":403,
|
||
|
|
"senderFault":true
|
||
|
|
},
|
||
|
|
"exception":true,
|
||
|
|
"documentation":"Thrown when a user is not authorized to access the requested resource."
|
||
|
|
},
|
||
|
|
"Operation":{
|
||
|
|
"type":"string",
|
||
|
|
"enum":[
|
||
|
|
"replace",
|
||
|
|
"remove"
|
||
|
|
]
|
||
|
|
},
|
||
|
|
"Record":{
|
||
|
|
"type":"structure",
|
||
|
|
"members":{
|
||
|
|
"Key":{
|
||
|
|
"shape":"RecordKey",
|
||
|
|
"documentation":"The key for the record."
|
||
|
|
},
|
||
|
|
"Value":{
|
||
|
|
"shape":"RecordValue",
|
||
|
|
"documentation":"The value for the record."
|
||
|
|
},
|
||
|
|
"SyncCount":{
|
||
|
|
"shape":"Long",
|
||
|
|
"documentation":"The server sync count for this record."
|
||
|
|
},
|
||
|
|
"LastModifiedDate":{
|
||
|
|
"shape":"Date",
|
||
|
|
"documentation":"The date on which the record was last modified."
|
||
|
|
},
|
||
|
|
"LastModifiedBy":{
|
||
|
|
"shape":"String",
|
||
|
|
"documentation":"The user/device that made the last change to this record."
|
||
|
|
},
|
||
|
|
"DeviceLastModifiedDate":{
|
||
|
|
"shape":"Date",
|
||
|
|
"documentation":"The last modified date of the client device."
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"documentation":"The basic data structure of a dataset."
|
||
|
|
},
|
||
|
|
"RecordKey":{
|
||
|
|
"type":"string",
|
||
|
|
"min":1,
|
||
|
|
"max":1024
|
||
|
|
},
|
||
|
|
"RecordList":{
|
||
|
|
"type":"list",
|
||
|
|
"member":{"shape":"Record"}
|
||
|
|
},
|
||
|
|
"RecordPatch":{
|
||
|
|
"type":"structure",
|
||
|
|
"required":[
|
||
|
|
"Op",
|
||
|
|
"Key",
|
||
|
|
"SyncCount"
|
||
|
|
],
|
||
|
|
"members":{
|
||
|
|
"Op":{
|
||
|
|
"shape":"Operation",
|
||
|
|
"documentation":"An operation, either replace or remove."
|
||
|
|
},
|
||
|
|
"Key":{
|
||
|
|
"shape":"RecordKey",
|
||
|
|
"documentation":"The key associated with the record patch."
|
||
|
|
},
|
||
|
|
"Value":{
|
||
|
|
"shape":"RecordValue",
|
||
|
|
"documentation":"The value associated with the record patch."
|
||
|
|
},
|
||
|
|
"SyncCount":{
|
||
|
|
"shape":"Long",
|
||
|
|
"documentation":"Last known server sync count for this record. Set to 0 if unknown."
|
||
|
|
},
|
||
|
|
"DeviceLastModifiedDate":{
|
||
|
|
"shape":"Date",
|
||
|
|
"documentation":"The last modified date of the client device."
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"documentation":"An update operation for a record."
|
||
|
|
},
|
||
|
|
"RecordPatchList":{
|
||
|
|
"type":"list",
|
||
|
|
"member":{"shape":"RecordPatch"}
|
||
|
|
},
|
||
|
|
"RecordValue":{
|
||
|
|
"type":"string",
|
||
|
|
"max":1048575
|
||
|
|
},
|
||
|
|
"ResourceConflictException":{
|
||
|
|
"type":"structure",
|
||
|
|
"required":["message"],
|
||
|
|
"members":{
|
||
|
|
"message":{
|
||
|
|
"shape":"ExceptionMessage",
|
||
|
|
"documentation":"The message returned by a 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."
|
||
|
|
},
|
||
|
|
"ResourceNotFoundException":{
|
||
|
|
"type":"structure",
|
||
|
|
"required":["message"],
|
||
|
|
"members":{
|
||
|
|
"message":{
|
||
|
|
"shape":"ExceptionMessage",
|
||
|
|
"documentation":"Message returned by a ResourceNotFoundException."
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"error":{
|
||
|
|
"code":"ResourceNotFound",
|
||
|
|
"httpStatusCode":404,
|
||
|
|
"senderFault":true
|
||
|
|
},
|
||
|
|
"exception":true,
|
||
|
|
"documentation":"Thrown if the resource doesn't exist."
|
||
|
|
},
|
||
|
|
"String":{"type":"string"},
|
||
|
|
"SyncSessionToken":{"type":"string"},
|
||
|
|
"TooManyRequestsException":{
|
||
|
|
"type":"structure",
|
||
|
|
"required":["message"],
|
||
|
|
"members":{
|
||
|
|
"message":{
|
||
|
|
"shape":"ExceptionMessage",
|
||
|
|
"documentation":"Message returned by a TooManyRequestsException."
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"error":{
|
||
|
|
"code":"TooManyRequests",
|
||
|
|
"httpStatusCode":429,
|
||
|
|
"senderFault":true
|
||
|
|
},
|
||
|
|
"exception":true,
|
||
|
|
"documentation":"Thrown if the request is throttled."
|
||
|
|
},
|
||
|
|
"UpdateRecordsRequest":{
|
||
|
|
"type":"structure",
|
||
|
|
"required":[
|
||
|
|
"IdentityPoolId",
|
||
|
|
"IdentityId",
|
||
|
|
"DatasetName",
|
||
|
|
"SyncSessionToken"
|
||
|
|
],
|
||
|
|
"members":{
|
||
|
|
"IdentityPoolId":{
|
||
|
|
"shape":"IdentityPoolId",
|
||
|
|
"location":"uri",
|
||
|
|
"locationName":"IdentityPoolId",
|
||
|
|
"documentation":"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."
|
||
|
|
},
|
||
|
|
"IdentityId":{
|
||
|
|
"shape":"IdentityId",
|
||
|
|
"location":"uri",
|
||
|
|
"locationName":"IdentityId",
|
||
|
|
"documentation":"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."
|
||
|
|
},
|
||
|
|
"DatasetName":{
|
||
|
|
"shape":"DatasetName",
|
||
|
|
"location":"uri",
|
||
|
|
"locationName":"DatasetName",
|
||
|
|
"documentation":"A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot)."
|
||
|
|
},
|
||
|
|
"RecordPatches":{
|
||
|
|
"shape":"RecordPatchList",
|
||
|
|
"documentation":"A list of patch operations."
|
||
|
|
},
|
||
|
|
"SyncSessionToken":{
|
||
|
|
"shape":"SyncSessionToken",
|
||
|
|
"documentation":"The SyncSessionToken returned by a previous call to ListRecords for this dataset and identity."
|
||
|
|
},
|
||
|
|
"ClientContext":{
|
||
|
|
"shape":"ClientContext",
|
||
|
|
"location":"header",
|
||
|
|
"locationName":"x-amz-Client-Context",
|
||
|
|
"documentation":"Intended to supply a device ID that will populate the <code>lastModifiedBy</code> field referenced in other methods. The <code>ClientContext</code> field is not yet implemented."
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"documentation":"A request to post updates to records or add and delete records for a dataset and user."
|
||
|
|
},
|
||
|
|
"UpdateRecordsResponse":{
|
||
|
|
"type":"structure",
|
||
|
|
"members":{
|
||
|
|
"Records":{
|
||
|
|
"shape":"RecordList",
|
||
|
|
"documentation":"A list of records that have been updated."
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"documentation":"Returned for a successful UpdateRecordsRequest."
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|