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.AdminListDevices

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists devices, as an administrator.

Calling this action requires developer credentials.

Synopsis

data AdminListDevices = AdminListDevices' {
- limit :: Maybe Natural
- paginationToken :: Maybe Text
- userPoolId :: Text
- username :: Sensitive Text
}
newAdminListDevices :: Text -> Text -> AdminListDevices
adminListDevices_limit :: Lens' AdminListDevices (Maybe Natural)
adminListDevices_paginationToken :: Lens' AdminListDevices (Maybe Text)
adminListDevices_userPoolId :: Lens' AdminListDevices Text
adminListDevices_username :: Lens' AdminListDevices Text
data AdminListDevicesResponse = AdminListDevicesResponse' {
- devices :: Maybe [DeviceType]
- paginationToken :: Maybe Text
- httpStatus :: Int
}
newAdminListDevicesResponse :: Int -> AdminListDevicesResponse
adminListDevicesResponse_devices :: Lens' AdminListDevicesResponse (Maybe [DeviceType])
adminListDevicesResponse_paginationToken :: Lens' AdminListDevicesResponse (Maybe Text)
adminListDevicesResponse_httpStatus :: Lens' AdminListDevicesResponse Int

Creating a Request

data AdminListDevices Source #

Represents the request to list devices, as an administrator.

See: newAdminListDevices smart constructor.

Constructors

AdminListDevices'
Fields limit :: Maybe Natural The limit of the devices request. paginationToken :: Maybe Text The pagination token. userPoolId :: Text The user pool ID. username :: Sensitive Text The user name.

Instances

Instances details

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

newAdminListDevices Source #

Arguments

:: Text	`AdminListDevices`
-> Text	`AdminListDevices`
-> AdminListDevices

Create a value of AdminListDevices 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:AdminListDevices', adminListDevices_limit - The limit of the devices request.

AdminListDevices, adminListDevices_paginationToken - The pagination token.

AdminListDevices, adminListDevices_userPoolId - The user pool ID.

AdminListDevices, adminListDevices_username - The user name.

Request Lenses

adminListDevices_limit :: Lens' AdminListDevices (Maybe Natural) Source #

The limit of the devices request.

adminListDevices_paginationToken :: Lens' AdminListDevices (Maybe Text) Source #

The pagination token.

adminListDevices_userPoolId :: Lens' AdminListDevices Text Source #

The user pool ID.

adminListDevices_username :: Lens' AdminListDevices Text Source #

The user name.

Destructuring the Response

data AdminListDevicesResponse Source #

Lists the device's response, as an administrator.

See: newAdminListDevicesResponse smart constructor.

Constructors

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

Instances

Instances details

Generic AdminListDevicesResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminListDevices Associated Types type Rep AdminListDevicesResponse :: Type -> Type # Methods from :: AdminListDevicesResponse -> Rep AdminListDevicesResponse x # to :: Rep AdminListDevicesResponse x -> AdminListDevicesResponse #
Show AdminListDevicesResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminListDevices Methods showsPrec :: Int -> AdminListDevicesResponse -> ShowS # show :: AdminListDevicesResponse -> String # showList :: [AdminListDevicesResponse] -> ShowS #
NFData AdminListDevicesResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminListDevices Methods rnf :: AdminListDevicesResponse -> () #
Eq AdminListDevicesResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminListDevices Methods (==) :: AdminListDevicesResponse -> AdminListDevicesResponse -> Bool # (/=) :: AdminListDevicesResponse -> AdminListDevicesResponse -> Bool #
type Rep AdminListDevicesResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminListDevices type Rep AdminListDevicesResponse = D1 ('MetaData "AdminListDevicesResponse" "Amazonka.CognitoIdentityProvider.AdminListDevices" "amazonka-cognito-idp-2.0-D1ERgMvEVPG9z8cOLXdU2" 'False) (C1 ('MetaCons "AdminListDevicesResponse'" '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))))

newAdminListDevicesResponse Source #

Arguments

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

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

AdminListDevices, adminListDevicesResponse_paginationToken - The pagination token.

$sel:httpStatus:AdminListDevicesResponse', adminListDevicesResponse_httpStatus - The response's http status code.

Response Lenses

adminListDevicesResponse_devices :: Lens' AdminListDevicesResponse (Maybe [DeviceType]) Source #

The devices in the list of devices response.

adminListDevicesResponse_paginationToken :: Lens' AdminListDevicesResponse (Maybe Text) Source #

The pagination token.

adminListDevicesResponse_httpStatus :: Lens' AdminListDevicesResponse Int Source #

The response's http status code.