amazonka-cognito-sync-1.6.1: Amazon Cognito Sync SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.CognitoSync.DeleteDataset

Contents

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

Creating a Request

deleteDataset Source #

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

data DeleteDataset Source #

A request to delete the specific dataset.

See: deleteDataset smart constructor.

Instances
Eq DeleteDataset Source # 
Instance details

Defined in Network.AWS.CognitoSync.DeleteDataset

Data DeleteDataset Source # 
Instance details

Defined in Network.AWS.CognitoSync.DeleteDataset

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DeleteDataset -> c DeleteDataset #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DeleteDataset #

toConstr :: DeleteDataset -> Constr #

dataTypeOf :: DeleteDataset -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DeleteDataset) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DeleteDataset) #

gmapT :: (forall b. Data b => b -> b) -> DeleteDataset -> DeleteDataset #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DeleteDataset -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DeleteDataset -> r #

gmapQ :: (forall d. Data d => d -> u) -> DeleteDataset -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DeleteDataset -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DeleteDataset -> m DeleteDataset #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteDataset -> m DeleteDataset #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteDataset -> m DeleteDataset #

Read DeleteDataset Source # 
Instance details

Defined in Network.AWS.CognitoSync.DeleteDataset

Show DeleteDataset Source # 
Instance details

Defined in Network.AWS.CognitoSync.DeleteDataset

Generic DeleteDataset Source # 
Instance details

Defined in Network.AWS.CognitoSync.DeleteDataset

Associated Types

type Rep DeleteDataset :: Type -> Type #

Hashable DeleteDataset Source # 
Instance details

Defined in Network.AWS.CognitoSync.DeleteDataset

AWSRequest DeleteDataset Source # 
Instance details

Defined in Network.AWS.CognitoSync.DeleteDataset

Associated Types

type Rs DeleteDataset :: Type #

ToHeaders DeleteDataset Source # 
Instance details

Defined in Network.AWS.CognitoSync.DeleteDataset

ToPath DeleteDataset Source # 
Instance details

Defined in Network.AWS.CognitoSync.DeleteDataset

ToQuery DeleteDataset Source # 
Instance details

Defined in Network.AWS.CognitoSync.DeleteDataset

NFData DeleteDataset Source # 
Instance details

Defined in Network.AWS.CognitoSync.DeleteDataset

Methods

rnf :: DeleteDataset -> () #

type Rep DeleteDataset Source # 
Instance details

Defined in Network.AWS.CognitoSync.DeleteDataset

type Rep DeleteDataset = D1 (MetaData "DeleteDataset" "Network.AWS.CognitoSync.DeleteDataset" "amazonka-cognito-sync-1.6.1-ha9SVGJqZqDpQMx6bgfWw" False) (C1 (MetaCons "DeleteDataset'" PrefixI True) (S1 (MetaSel (Just "_delIdentityPoolId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: (S1 (MetaSel (Just "_delIdentityId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_delDatasetName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))
type Rs DeleteDataset Source # 
Instance details

Defined in Network.AWS.CognitoSync.DeleteDataset

Request Lenses

delIdentityPoolId :: 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.

delIdentityId :: 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.

delDatasetName :: 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

deleteDatasetResponse Source #

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 - 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.
  • drsResponseStatus - -- | The response status code.

data DeleteDatasetResponse Source #

Response to a successful DeleteDataset request.

See: deleteDatasetResponse smart constructor.

Instances
Eq DeleteDatasetResponse Source # 
Instance details

Defined in Network.AWS.CognitoSync.DeleteDataset

Data DeleteDatasetResponse Source # 
Instance details

Defined in Network.AWS.CognitoSync.DeleteDataset

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DeleteDatasetResponse -> c DeleteDatasetResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DeleteDatasetResponse #

toConstr :: DeleteDatasetResponse -> Constr #

dataTypeOf :: DeleteDatasetResponse -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DeleteDatasetResponse) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DeleteDatasetResponse) #

gmapT :: (forall b. Data b => b -> b) -> DeleteDatasetResponse -> DeleteDatasetResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DeleteDatasetResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DeleteDatasetResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> DeleteDatasetResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DeleteDatasetResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DeleteDatasetResponse -> m DeleteDatasetResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteDatasetResponse -> m DeleteDatasetResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteDatasetResponse -> m DeleteDatasetResponse #

Read DeleteDatasetResponse Source # 
Instance details

Defined in Network.AWS.CognitoSync.DeleteDataset

Show DeleteDatasetResponse Source # 
Instance details

Defined in Network.AWS.CognitoSync.DeleteDataset

Generic DeleteDatasetResponse Source # 
Instance details

Defined in Network.AWS.CognitoSync.DeleteDataset

Associated Types

type Rep DeleteDatasetResponse :: Type -> Type #

NFData DeleteDatasetResponse Source # 
Instance details

Defined in Network.AWS.CognitoSync.DeleteDataset

Methods

rnf :: DeleteDatasetResponse -> () #

type Rep DeleteDatasetResponse Source # 
Instance details

Defined in Network.AWS.CognitoSync.DeleteDataset

type Rep DeleteDatasetResponse = D1 (MetaData "DeleteDatasetResponse" "Network.AWS.CognitoSync.DeleteDataset" "amazonka-cognito-sync-1.6.1-ha9SVGJqZqDpQMx6bgfWw" False) (C1 (MetaCons "DeleteDatasetResponse'" PrefixI True) (S1 (MetaSel (Just "_drsDataset") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Dataset)) :*: S1 (MetaSel (Just "_drsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))

Response Lenses

drsDataset :: 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.

drsResponseStatus :: Lens' DeleteDatasetResponse Int Source #

  • - | The response status code.