CognitoSync / Client / delete_dataset

delete_dataset#

CognitoSync.Client.delete_dataset(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.delete_dataset(
    IdentityPoolId='string',
    IdentityId='string',
    DatasetName='string'
)
Parameters:

  • IdentityPoolId (string) – [REQUIRED] 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 (string) – [REQUIRED] 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 (string) – [REQUIRED] A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, ‘_’ (underscore), ‘-’ (dash), and ‘.’ (dot).

Return type:

dict

Returns:

Response Syntax

{
    'Dataset': {
        'IdentityId': 'string',
        'DatasetName': 'string',
        'CreationDate': datetime(2015, 1, 1),
        'LastModifiedDate': datetime(2015, 1, 1),
        'LastModifiedBy': 'string',
        'DataStorage': 123,
        'NumRecords': 123
    }
}

Response Structure

  • (dict) – Response to a successful DeleteDataset request.

    • Dataset (dict) – 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.

      • IdentityId (string) – 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 (string) – A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, ‘_’ (underscore), ‘-’ (dash), and ‘.’ (dot).

      • CreationDate (datetime) – Date on which the dataset was created.

      • LastModifiedDate (datetime) – Date when the dataset was last modified.

      • LastModifiedBy (string) – The device that made the last change to this dataset.

      • DataStorage (integer) – Total size in bytes of the records in this dataset.

      • NumRecords (integer) – Number of records in this dataset.

Exceptions

  • CognitoSync.Client.exceptions.NotAuthorizedException

  • CognitoSync.Client.exceptions.InvalidParameterException

  • CognitoSync.Client.exceptions.ResourceNotFoundException

  • CognitoSync.Client.exceptions.InternalErrorException

  • CognitoSync.Client.exceptions.TooManyRequestsException

  • CognitoSync.Client.exceptions.ResourceConflictException