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

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

Network.AWS.CognitoSync.DescribeDataset

Contents

Description

Gets meta data about a dataset by identity and dataset name. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data.

This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use Cognito Identity credentials to make this API call.

Synopsis

Creating a Request

describeDataset #

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

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

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

data DescribeDataset #

A request for meta data about a dataset (creation date, number of records, size) by owner and dataset name.

See: describeDataset smart constructor.

Instances

Eq DescribeDataset # 
Data DescribeDataset # 

Methods

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

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

toConstr :: DescribeDataset -> Constr #

dataTypeOf :: DescribeDataset -> DataType #

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

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

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

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

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

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

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

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

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

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

Read DescribeDataset # 
Show DescribeDataset # 
Generic DescribeDataset # 
Hashable DescribeDataset # 
NFData DescribeDataset # 

Methods

rnf :: DescribeDataset -> () #

AWSRequest DescribeDataset # 
ToQuery DescribeDataset # 
ToPath DescribeDataset # 
ToHeaders DescribeDataset # 
type Rep DescribeDataset # 
type Rep DescribeDataset = D1 (MetaData "DescribeDataset" "Network.AWS.CognitoSync.DescribeDataset" "amazonka-cognito-sync-1.4.5-6kgm8A380gaABwgTunDxt8" False) (C1 (MetaCons "DescribeDataset'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_ddIdentityPoolId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) ((:*:) (S1 (MetaSel (Just Symbol "_ddIdentityId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_ddDatasetName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))
type Rs DescribeDataset # 

Request Lenses

ddIdentityPoolId :: Lens' DescribeDataset 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.

ddIdentityId :: Lens' DescribeDataset 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.

ddDatasetName :: Lens' DescribeDataset Text #

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

Destructuring the Response

describeDatasetResponse #

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

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

  • ddrsDataset - Meta data 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.
  • ddrsResponseStatus - -- | The response status code.

data DescribeDatasetResponse #

Response to a successful DescribeDataset request.

See: describeDatasetResponse smart constructor.

Instances

Eq DescribeDatasetResponse # 
Data DescribeDatasetResponse # 

Methods

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

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

toConstr :: DescribeDatasetResponse -> Constr #

dataTypeOf :: DescribeDatasetResponse -> DataType #

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

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

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

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

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

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

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

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

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

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

Read DescribeDatasetResponse # 
Show DescribeDatasetResponse # 
Generic DescribeDatasetResponse # 
NFData DescribeDatasetResponse # 

Methods

rnf :: DescribeDatasetResponse -> () #

type Rep DescribeDatasetResponse # 
type Rep DescribeDatasetResponse = D1 (MetaData "DescribeDatasetResponse" "Network.AWS.CognitoSync.DescribeDataset" "amazonka-cognito-sync-1.4.5-6kgm8A380gaABwgTunDxt8" False) (C1 (MetaCons "DescribeDatasetResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_ddrsDataset") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Dataset))) (S1 (MetaSel (Just Symbol "_ddrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int))))

Response Lenses

ddrsDataset :: Lens' DescribeDatasetResponse (Maybe Dataset) #

Meta data 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.

ddrsResponseStatus :: Lens' DescribeDatasetResponse Int #

  • - | The response status code.