| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.CognitoSync.DeleteDataset
Description
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.
Synopsis
- data DeleteDataset = DeleteDataset' {
- identityPoolId :: Text
- identityId :: Text
- datasetName :: Text
- newDeleteDataset :: Text -> Text -> Text -> DeleteDataset
- deleteDataset_identityPoolId :: Lens' DeleteDataset Text
- deleteDataset_identityId :: Lens' DeleteDataset Text
- deleteDataset_datasetName :: Lens' DeleteDataset Text
- data DeleteDatasetResponse = DeleteDatasetResponse' {
- dataset :: Maybe Dataset
- httpStatus :: Int
- newDeleteDatasetResponse :: Int -> DeleteDatasetResponse
- deleteDatasetResponse_dataset :: Lens' DeleteDatasetResponse (Maybe Dataset)
- deleteDatasetResponse_httpStatus :: Lens' DeleteDatasetResponse Int
Creating a Request
data DeleteDataset Source #
A request to delete the specific dataset.
See: newDeleteDataset smart constructor.
Constructors
| DeleteDataset' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> DeleteDataset |
Create a value of DeleteDataset with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:identityPoolId:DeleteDataset', deleteDataset_identityPoolId - 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.
$sel:identityId:DeleteDataset', deleteDataset_identityId - 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.
$sel:datasetName:DeleteDataset', deleteDataset_datasetName - A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9,
'_' (underscore), '-' (dash), and '.' (dot).
Request Lenses
deleteDataset_identityPoolId :: Lens' DeleteDataset Text Source #
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.
deleteDataset_identityId :: Lens' DeleteDataset Text Source #
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.
deleteDataset_datasetName :: Lens' DeleteDataset Text Source #
A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot).
Destructuring the Response
data DeleteDatasetResponse Source #
Response to a successful DeleteDataset request.
See: newDeleteDatasetResponse smart constructor.
Constructors
| DeleteDatasetResponse' | |
Fields
| |
Instances
newDeleteDatasetResponse Source #
Create a value of DeleteDatasetResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dataset:DeleteDatasetResponse', deleteDatasetResponse_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.
$sel:httpStatus:DeleteDatasetResponse', deleteDatasetResponse_httpStatus - The response's http status code.
Response Lenses
deleteDatasetResponse_dataset :: Lens' DeleteDatasetResponse (Maybe Dataset) Source #
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.
deleteDatasetResponse_httpStatus :: Lens' DeleteDatasetResponse Int Source #
The response's http status code.