Network.AWS.CognitoSync.DeleteDataset

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: AWS API Reference for DeleteDataset.

Creating a Request

deleteDataset

Arguments

:: Text

delIdentityPoolId

-> Text

delIdentityId

-> Text

delDatasetName

-> DeleteDataset

Creates a value of DeleteDataset with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• delIdentityPoolId
• delIdentityId
• delDatasetName

data DeleteDataset

A request to delete the specific dataset.

See: deleteDataset smart constructor.

Instances

Eq DeleteDataset

Data DeleteDataset

Read DeleteDataset

Show DeleteDataset

Generic DeleteDataset

AWSRequest DeleteDataset

ToPath DeleteDataset

ToHeaders DeleteDataset

ToQuery DeleteDataset

Typeable * DeleteDataset

type Rep DeleteDataset

type Sv DeleteDataset = CognitoSync

type Rs DeleteDataset = DeleteDatasetResponse

Request Lenses

delIdentityPoolId :: Lens' DeleteDataset Text

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.

delIdentityId :: Lens' DeleteDataset Text

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.

delDatasetName :: Lens' DeleteDataset Text

A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot).

Destructuring the Response

deleteDatasetResponse

Arguments

:: Int

drsStatus

-> DeleteDatasetResponse

Creates a value of DeleteDatasetResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• drsDataset
• drsStatus

data DeleteDatasetResponse

Response to a successful DeleteDataset request.

See: deleteDatasetResponse smart constructor.

Instances

Eq DeleteDatasetResponse

Data DeleteDatasetResponse

Read DeleteDatasetResponse

Show DeleteDatasetResponse

Generic DeleteDatasetResponse

Typeable * DeleteDatasetResponse

type Rep DeleteDatasetResponse

Response Lenses

drsDataset :: Lens' DeleteDatasetResponse (Maybe Dataset)

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.

drsStatus :: Lens' DeleteDatasetResponse Int

The response status code.