AWS IoT

2020/11/04 - AWS IoT - 1 updated api methods

Changes  Updated API documentation and added paginator for AWS Iot Registry ListThingPrincipals API.

ListThingPrincipals (updated) Link ΒΆ
Changes (request, response)
Request
{'maxResults': 'integer', 'nextToken': 'string'}
Response
{'nextToken': 'string'}

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.

See also: AWS API Documentation

Request Syntax

client.list_thing_principals(
    nextToken='string',
    maxResults=123,
    thingName='string'
)
type nextToken

string

param nextToken

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

type maxResults

integer

param maxResults

The maximum number of results to return in this operation.

type thingName

string

param thingName

[REQUIRED]

The name of the thing.

rtype

dict

returns

Response Syntax

{
    'principals': [
        'string',
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    The output from the ListThingPrincipals operation.

    • principals (list) --

      The principals associated with the thing.

      • (string) --

    • nextToken (string) --

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