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.IoT.ListThingPrincipals

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the principals associated with the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.

Requires permission to access the ListThingPrincipals action.

This operation returns paginated results.

Synopsis

Creating a Request

data ListThingPrincipals Source #

The input for the ListThingPrincipal operation.

See: newListThingPrincipals smart constructor.

Constructors

ListThingPrincipals'
Fields maxResults :: Maybe Natural The maximum number of results to return in this operation. nextToken :: Maybe Text To retrieve the next set of results, the `nextToken` value from a previous response; otherwise null to receive the first set of results. thingName :: Text The name of the thing.

Instances

Instances details

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

newListThingPrincipals Source #

Arguments

:: Text	`ListThingPrincipals`
-> ListThingPrincipals

Create a value of ListThingPrincipals 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:ListThingPrincipals', listThingPrincipals_maxResults - The maximum number of results to return in this operation.

ListThingPrincipals, listThingPrincipals_nextToken - To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

ListThingPrincipals, listThingPrincipals_thingName - The name of the thing.

Request Lenses

listThingPrincipals_maxResults :: Lens' ListThingPrincipals (Maybe Natural) Source #

The maximum number of results to return in this operation.

listThingPrincipals_nextToken :: Lens' ListThingPrincipals (Maybe Text) Source #

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

listThingPrincipals_thingName :: Lens' ListThingPrincipals Text Source #

The name of the thing.

Destructuring the Response

data ListThingPrincipalsResponse Source #

The output from the ListThingPrincipals operation.

See: newListThingPrincipalsResponse smart constructor.

Constructors

ListThingPrincipalsResponse'
Fields nextToken :: Maybe Text The token to use to get the next set of results, or null if there are no additional results. principals :: Maybe [Text] The principals associated with the thing. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ListThingPrincipalsResponse Source #
Instance details Defined in Amazonka.IoT.ListThingPrincipals Associated Types type Rep ListThingPrincipalsResponse :: Type -> Type # Methods from :: ListThingPrincipalsResponse -> Rep ListThingPrincipalsResponse x # to :: Rep ListThingPrincipalsResponse x -> ListThingPrincipalsResponse #
Read ListThingPrincipalsResponse Source #
Instance details Defined in Amazonka.IoT.ListThingPrincipals Methods readsPrec :: Int -> ReadS ListThingPrincipalsResponse # readList :: ReadS [ListThingPrincipalsResponse] # readPrec :: ReadPrec ListThingPrincipalsResponse # readListPrec :: ReadPrec [ListThingPrincipalsResponse] #
Show ListThingPrincipalsResponse Source #
Instance details Defined in Amazonka.IoT.ListThingPrincipals Methods showsPrec :: Int -> ListThingPrincipalsResponse -> ShowS # show :: ListThingPrincipalsResponse -> String # showList :: [ListThingPrincipalsResponse] -> ShowS #
NFData ListThingPrincipalsResponse Source #
Instance details Defined in Amazonka.IoT.ListThingPrincipals Methods rnf :: ListThingPrincipalsResponse -> () #
Eq ListThingPrincipalsResponse Source #
Instance details Defined in Amazonka.IoT.ListThingPrincipals Methods (==) :: ListThingPrincipalsResponse -> ListThingPrincipalsResponse -> Bool # (/=) :: ListThingPrincipalsResponse -> ListThingPrincipalsResponse -> Bool #
type Rep ListThingPrincipalsResponse Source #
Instance details Defined in Amazonka.IoT.ListThingPrincipals type Rep ListThingPrincipalsResponse = D1 ('MetaData "ListThingPrincipalsResponse" "Amazonka.IoT.ListThingPrincipals" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "ListThingPrincipalsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "principals") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListThingPrincipalsResponse Source #

Arguments

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

Create a value of ListThingPrincipalsResponse 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:

ListThingPrincipals, listThingPrincipalsResponse_nextToken - The token to use to get the next set of results, or null if there are no additional results.

$sel:principals:ListThingPrincipalsResponse', listThingPrincipalsResponse_principals - The principals associated with the thing.

$sel:httpStatus:ListThingPrincipalsResponse', listThingPrincipalsResponse_httpStatus - The response's http status code.

Response Lenses

listThingPrincipalsResponse_nextToken :: Lens' ListThingPrincipalsResponse (Maybe Text) Source #

The token to use to get the next set of results, or null if there are no additional results.

listThingPrincipalsResponse_principals :: Lens' ListThingPrincipalsResponse (Maybe [Text]) Source #

The principals associated with the thing.

listThingPrincipalsResponse_httpStatus :: Lens' ListThingPrincipalsResponse Int Source #

The response's http status code.