IoT / Client / list_thing_principals

list_thing_principals#

IoT.Client.list_thing_principals(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.list_thing_principals(
    nextToken='string',
    maxResults=123,
    thingName='string'
)
Parameters:

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

  • maxResults (integer) – The maximum number of results to return in this operation.

  • thingName (string) –

    [REQUIRED]

    The name of the thing.

Return type:

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.

Exceptions

  • IoT.Client.exceptions.InvalidRequestException

  • IoT.Client.exceptions.ThrottlingException

  • IoT.Client.exceptions.UnauthorizedException

  • IoT.Client.exceptions.ServiceUnavailableException

  • IoT.Client.exceptions.InternalFailureException

  • IoT.Client.exceptions.ResourceNotFoundException