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.CognitoIdentityProvider.ListDevices

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the sign-in devices that Amazon Cognito has registered to the current user.

Creating a Request

data ListDevices Source #

Represents the request to list the devices.

See: newListDevices smart constructor.

Constructors

ListDevices'
Fields limit :: Maybe Natural The limit of the device request. paginationToken :: Maybe Text The pagination token for the list request. accessToken :: Sensitive Text A valid access token that Amazon Cognito issued to the user whose list of devices you want to view.

Instances

Instances details

ToJSON ListDevices Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListDevices Methods toJSON :: ListDevices -> Value # toEncoding :: ListDevices -> Encoding # toJSONList :: [ListDevices] -> Value # toEncodingList :: [ListDevices] -> Encoding #
ToHeaders ListDevices Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListDevices Methods toHeaders :: ListDevices -> [Header] #
ToPath ListDevices Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListDevices Methods toPath :: ListDevices -> ByteString #
ToQuery ListDevices Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListDevices Methods toQuery :: ListDevices -> QueryString #
AWSRequest ListDevices Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListDevices Associated Types type AWSResponse ListDevices # Methods request :: (Service -> Service) -> ListDevices -> Request ListDevices # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListDevices -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListDevices))) #
Generic ListDevices Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListDevices Associated Types type Rep ListDevices :: Type -> Type # Methods from :: ListDevices -> Rep ListDevices x # to :: Rep ListDevices x -> ListDevices #
Show ListDevices Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListDevices Methods showsPrec :: Int -> ListDevices -> ShowS # show :: ListDevices -> String # showList :: [ListDevices] -> ShowS #
NFData ListDevices Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListDevices Methods rnf :: ListDevices -> () #
Eq ListDevices Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListDevices Methods (==) :: ListDevices -> ListDevices -> Bool # (/=) :: ListDevices -> ListDevices -> Bool #
Hashable ListDevices Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListDevices Methods hashWithSalt :: Int -> ListDevices -> Int # hash :: ListDevices -> Int #
type AWSResponse ListDevices Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListDevices type AWSResponse ListDevices = ListDevicesResponse
type Rep ListDevices Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListDevices type Rep ListDevices = D1 ('MetaData "ListDevices" "Amazonka.CognitoIdentityProvider.ListDevices" "amazonka-cognito-idp-2.0-D1ERgMvEVPG9z8cOLXdU2" 'False) (C1 ('MetaCons "ListDevices'" 'PrefixI 'True) (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "paginationToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "accessToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)))))

newListDevices Source #

Arguments

:: Text	`ListDevices`
-> ListDevices

Create a value of ListDevices 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:limit:ListDevices', listDevices_limit - The limit of the device request.

ListDevices, listDevices_paginationToken - The pagination token for the list request.

ListDevices, listDevices_accessToken - A valid access token that Amazon Cognito issued to the user whose list of devices you want to view.

Request Lenses

listDevices_limit :: Lens' ListDevices (Maybe Natural) Source #

The limit of the device request.

listDevices_paginationToken :: Lens' ListDevices (Maybe Text) Source #

The pagination token for the list request.

listDevices_accessToken :: Lens' ListDevices Text Source #

A valid access token that Amazon Cognito issued to the user whose list of devices you want to view.

Destructuring the Response

data ListDevicesResponse Source #

Represents the response to list devices.

See: newListDevicesResponse smart constructor.

Constructors

ListDevicesResponse'
Fields devices :: Maybe [DeviceType] The devices returned in the list devices response. paginationToken :: Maybe Text The pagination token for the list device response. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ListDevicesResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListDevices Associated Types type Rep ListDevicesResponse :: Type -> Type # Methods from :: ListDevicesResponse -> Rep ListDevicesResponse x # to :: Rep ListDevicesResponse x -> ListDevicesResponse #
Show ListDevicesResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListDevices Methods showsPrec :: Int -> ListDevicesResponse -> ShowS # show :: ListDevicesResponse -> String # showList :: [ListDevicesResponse] -> ShowS #
NFData ListDevicesResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListDevices Methods rnf :: ListDevicesResponse -> () #
Eq ListDevicesResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListDevices Methods (==) :: ListDevicesResponse -> ListDevicesResponse -> Bool # (/=) :: ListDevicesResponse -> ListDevicesResponse -> Bool #
type Rep ListDevicesResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListDevices type Rep ListDevicesResponse = D1 ('MetaData "ListDevicesResponse" "Amazonka.CognitoIdentityProvider.ListDevices" "amazonka-cognito-idp-2.0-D1ERgMvEVPG9z8cOLXdU2" 'False) (C1 ('MetaCons "ListDevicesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "devices") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DeviceType])) :: (S1 ('MetaSel ('Just "paginationToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListDevicesResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListDevicesResponse'`
-> ListDevicesResponse

Create a value of ListDevicesResponse 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:devices:ListDevicesResponse', listDevicesResponse_devices - The devices returned in the list devices response.

ListDevices, listDevicesResponse_paginationToken - The pagination token for the list device response.

$sel:httpStatus:ListDevicesResponse', listDevicesResponse_httpStatus - The response's http status code.

Response Lenses

listDevicesResponse_devices :: Lens' ListDevicesResponse (Maybe [DeviceType]) Source #

The devices returned in the list devices response.

listDevicesResponse_paginationToken :: Lens' ListDevicesResponse (Maybe Text) Source #

The pagination token for the list device response.

listDevicesResponse_httpStatus :: Lens' ListDevicesResponse Int Source #

The response's http status code.