Network.AWS.CognitoSync.DescribeDataset

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.

Creating a Request

describeDataset

Arguments

:: Text

ddIdentityPoolId

-> Text

ddIdentityId

-> Text

ddDatasetName

-> 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
• ddIdentityId
• ddDatasetName

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

Methods

(==) :: DescribeDataset -> DescribeDataset -> Bool

(/=) :: DescribeDataset -> DescribeDataset -> Bool

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

Methods

readsPrec :: Int -> ReadS DescribeDataset

readList :: ReadS [DescribeDataset]

readPrec :: ReadPrec DescribeDataset

readListPrec :: ReadPrec [DescribeDataset]

Show DescribeDataset

Methods

showsPrec :: Int -> DescribeDataset -> ShowS

show :: DescribeDataset -> String

showList :: [DescribeDataset] -> ShowS

Generic DescribeDataset

Associated Types

type Rep DescribeDataset :: * -> *

Methods

from :: DescribeDataset -> Rep DescribeDataset x

to :: Rep DescribeDataset x -> DescribeDataset

Hashable DescribeDataset

Methods

hashWithSalt :: Int -> DescribeDataset -> Int

hash :: DescribeDataset -> Int

NFData DescribeDataset

Methods

rnf :: DescribeDataset -> ()

AWSRequest DescribeDataset

Associated Types

type Rs DescribeDataset :: *

Methods

request :: DescribeDataset -> Request DescribeDataset

response :: MonadResource m => Logger -> Service -> Proxy * DescribeDataset -> ClientResponse -> m (Response DescribeDataset)

ToQuery DescribeDataset

Methods

toQuery :: DescribeDataset -> QueryString

ToPath DescribeDataset

Methods

toPath :: DescribeDataset -> ByteString

ToHeaders DescribeDataset

Methods

toHeaders :: DescribeDataset -> [Header]

type Rep DescribeDataset

type Rep DescribeDataset = D1 (MetaData "DescribeDataset" "Network.AWS.CognitoSync.DescribeDataset" "amazonka-cognito-sync-1.4.3-BdrRxVNpUjC2WRfH1iebqZ" 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

type Rs DescribeDataset = DescribeDatasetResponse

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

Arguments

:: Int

ddrsResponseStatus

-> 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
• ddrsResponseStatus

data DescribeDatasetResponse

Response to a successful DescribeDataset request.

See: describeDatasetResponse smart constructor.

Instances

Eq DescribeDatasetResponse

Methods

(==) :: DescribeDatasetResponse -> DescribeDatasetResponse -> Bool

(/=) :: DescribeDatasetResponse -> DescribeDatasetResponse -> Bool

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

Methods

readsPrec :: Int -> ReadS DescribeDatasetResponse

readList :: ReadS [DescribeDatasetResponse]

readPrec :: ReadPrec DescribeDatasetResponse

readListPrec :: ReadPrec [DescribeDatasetResponse]

Show DescribeDatasetResponse

Methods

showsPrec :: Int -> DescribeDatasetResponse -> ShowS

show :: DescribeDatasetResponse -> String

showList :: [DescribeDatasetResponse] -> ShowS

Generic DescribeDatasetResponse

Associated Types

type Rep DescribeDatasetResponse :: * -> *

Methods

from :: DescribeDatasetResponse -> Rep DescribeDatasetResponse x

to :: Rep DescribeDatasetResponse x -> DescribeDatasetResponse

NFData DescribeDatasetResponse

Methods

rnf :: DescribeDatasetResponse -> ()

type Rep DescribeDatasetResponse

type Rep DescribeDatasetResponse = D1 (MetaData "DescribeDatasetResponse" "Network.AWS.CognitoSync.DescribeDataset" "amazonka-cognito-sync-1.4.3-BdrRxVNpUjC2WRfH1iebqZ" False) (C1 (MetaCons "DescribeDatasetResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_ddrsDataset") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Dataset))) (S1 (MetaSel (Just Symbol "_ddrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (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.