IoTDataPlane / Client / list_named_shadows_for_thing

list_named_shadows_for_thing#

IoTDataPlane.Client.list_named_shadows_for_thing(**kwargs)#

Lists the shadows for the specified thing.

Requires permission to access the ListNamedShadowsForThing action.

See also: AWS API Documentation

Request Syntax

response = client.list_named_shadows_for_thing(
    thingName='string',
    nextToken='string',
    pageSize=123
)
Parameters:

  • thingName (string) –

    [REQUIRED]

    The name of the thing.

  • nextToken (string) – The token to retrieve the next set of results.

  • pageSize (integer) – The result page size.

Return type:

dict

Returns:

Response Syntax

{
    'results': [
        'string',
    ],
    'nextToken': 'string',
    'timestamp': 123
}

Response Structure

  • (dict) –

    • results (list) –

      The list of shadows for the specified thing.

      • (string) –

    • nextToken (string) –

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

    • timestamp (integer) –

      The Epoch date and time the response was generated by IoT.

Exceptions

  • IoTDataPlane.Client.exceptions.ResourceNotFoundException

  • IoTDataPlane.Client.exceptions.InvalidRequestException

  • IoTDataPlane.Client.exceptions.ThrottlingException

  • IoTDataPlane.Client.exceptions.UnauthorizedException

  • IoTDataPlane.Client.exceptions.ServiceUnavailableException

  • IoTDataPlane.Client.exceptions.InternalFailureException

  • IoTDataPlane.Client.exceptions.MethodNotAllowedException