Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.CognitoSync.ListDatasets

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists datasets for an identity. 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.

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

Synopsis

data ListDatasets = ListDatasets' {
- maxResults :: Maybe Int
- nextToken :: Maybe Text
- identityId :: Text
- identityPoolId :: Text
}
newListDatasets :: Text -> Text -> ListDatasets
listDatasets_maxResults :: Lens' ListDatasets (Maybe Int)
listDatasets_nextToken :: Lens' ListDatasets (Maybe Text)
listDatasets_identityId :: Lens' ListDatasets Text
listDatasets_identityPoolId :: Lens' ListDatasets Text
data ListDatasetsResponse = ListDatasetsResponse' {
- count :: Maybe Int
- datasets :: Maybe [Dataset]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListDatasetsResponse :: Int -> ListDatasetsResponse
listDatasetsResponse_count :: Lens' ListDatasetsResponse (Maybe Int)
listDatasetsResponse_datasets :: Lens' ListDatasetsResponse (Maybe [Dataset])
listDatasetsResponse_nextToken :: Lens' ListDatasetsResponse (Maybe Text)
listDatasetsResponse_httpStatus :: Lens' ListDatasetsResponse Int

Creating a Request

data ListDatasets Source #

Request for a list of datasets for an identity.

See: newListDatasets smart constructor.

Constructors

ListDatasets'

Fields

maxResults :: Maybe Int
The maximum number of results to be returned.
nextToken :: Maybe Text
A pagination token for obtaining the next page of results.
identityId :: 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.
identityPoolId :: 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.

Instances

Instances details

ToHeaders ListDatasets Source #
Instance details Defined in Amazonka.CognitoSync.ListDatasets Methods toHeaders :: ListDatasets -> [Header] #
ToPath ListDatasets Source #
Instance details Defined in Amazonka.CognitoSync.ListDatasets Methods toPath :: ListDatasets -> ByteString #
ToQuery ListDatasets Source #
Instance details Defined in Amazonka.CognitoSync.ListDatasets Methods toQuery :: ListDatasets -> QueryString #
AWSRequest ListDatasets Source #
Instance details Defined in Amazonka.CognitoSync.ListDatasets Associated Types type AWSResponse ListDatasets # Methods request :: (Service -> Service) -> ListDatasets -> Request ListDatasets # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListDatasets -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListDatasets))) #
Generic ListDatasets Source #
Instance details Defined in Amazonka.CognitoSync.ListDatasets Associated Types type Rep ListDatasets :: Type -> Type # Methods from :: ListDatasets -> Rep ListDatasets x # to :: Rep ListDatasets x -> ListDatasets #
Read ListDatasets Source #
Instance details Defined in Amazonka.CognitoSync.ListDatasets Methods readsPrec :: Int -> ReadS ListDatasets # readList :: ReadS [ListDatasets] # readPrec :: ReadPrec ListDatasets # readListPrec :: ReadPrec [ListDatasets] #
Show ListDatasets Source #
Instance details Defined in Amazonka.CognitoSync.ListDatasets Methods showsPrec :: Int -> ListDatasets -> ShowS # show :: ListDatasets -> String # showList :: [ListDatasets] -> ShowS #
NFData ListDatasets Source #
Instance details Defined in Amazonka.CognitoSync.ListDatasets Methods rnf :: ListDatasets -> () #
Eq ListDatasets Source #
Instance details Defined in Amazonka.CognitoSync.ListDatasets Methods (==) :: ListDatasets -> ListDatasets -> Bool # (/=) :: ListDatasets -> ListDatasets -> Bool #
Hashable ListDatasets Source #
Instance details Defined in Amazonka.CognitoSync.ListDatasets Methods hashWithSalt :: Int -> ListDatasets -> Int # hash :: ListDatasets -> Int #
type AWSResponse ListDatasets Source #
Instance details Defined in Amazonka.CognitoSync.ListDatasets type AWSResponse ListDatasets = ListDatasetsResponse
type Rep ListDatasets Source #
Instance details Defined in Amazonka.CognitoSync.ListDatasets type Rep ListDatasets = D1 ('MetaData "ListDatasets" "Amazonka.CognitoSync.ListDatasets" "amazonka-cognito-sync-2.0-4eAo0O3jWiUGlkSwv2vKaB" 'False) (C1 ('MetaCons "ListDatasets'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "identityId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "identityPoolId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListDatasets Source #

Arguments

:: Text	`ListDatasets`
-> Text	`ListDatasets`
-> ListDatasets

Create a value of ListDatasets 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:maxResults:ListDatasets', listDatasets_maxResults - The maximum number of results to be returned.

ListDatasets, listDatasets_nextToken - A pagination token for obtaining the next page of results.

ListDatasets, listDatasets_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.

ListDatasets, listDatasets_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.

Request Lenses

listDatasets_maxResults :: Lens' ListDatasets (Maybe Int) Source #

The maximum number of results to be returned.

listDatasets_nextToken :: Lens' ListDatasets (Maybe Text) Source #

A pagination token for obtaining the next page of results.

listDatasets_identityId :: Lens' ListDatasets 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.

listDatasets_identityPoolId :: Lens' ListDatasets 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.

Destructuring the Response

data ListDatasetsResponse Source #

Returned for a successful ListDatasets request.

See: newListDatasetsResponse smart constructor.

Constructors

ListDatasetsResponse'
Fields count :: Maybe Int Number of datasets returned. datasets :: Maybe [Dataset] A set of datasets. nextToken :: Maybe Text A pagination token for obtaining the next page of results. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ListDatasetsResponse Source #
Instance details Defined in Amazonka.CognitoSync.ListDatasets Associated Types type Rep ListDatasetsResponse :: Type -> Type # Methods from :: ListDatasetsResponse -> Rep ListDatasetsResponse x # to :: Rep ListDatasetsResponse x -> ListDatasetsResponse #
Read ListDatasetsResponse Source #
Instance details Defined in Amazonka.CognitoSync.ListDatasets Methods readsPrec :: Int -> ReadS ListDatasetsResponse # readList :: ReadS [ListDatasetsResponse] # readPrec :: ReadPrec ListDatasetsResponse # readListPrec :: ReadPrec [ListDatasetsResponse] #
Show ListDatasetsResponse Source #
Instance details Defined in Amazonka.CognitoSync.ListDatasets Methods showsPrec :: Int -> ListDatasetsResponse -> ShowS # show :: ListDatasetsResponse -> String # showList :: [ListDatasetsResponse] -> ShowS #
NFData ListDatasetsResponse Source #
Instance details Defined in Amazonka.CognitoSync.ListDatasets Methods rnf :: ListDatasetsResponse -> () #
Eq ListDatasetsResponse Source #
Instance details Defined in Amazonka.CognitoSync.ListDatasets Methods (==) :: ListDatasetsResponse -> ListDatasetsResponse -> Bool # (/=) :: ListDatasetsResponse -> ListDatasetsResponse -> Bool #
type Rep ListDatasetsResponse Source #
Instance details Defined in Amazonka.CognitoSync.ListDatasets type Rep ListDatasetsResponse = D1 ('MetaData "ListDatasetsResponse" "Amazonka.CognitoSync.ListDatasets" "amazonka-cognito-sync-2.0-4eAo0O3jWiUGlkSwv2vKaB" 'False) (C1 ('MetaCons "ListDatasetsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "count") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "datasets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Dataset]))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))