SnowDeviceManagement / Paginator / ListDeviceResources

ListDeviceResources#

class SnowDeviceManagement.Paginator.ListDeviceResources#
paginator = client.get_paginator('list_device_resources')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from SnowDeviceManagement.Client.list_device_resources().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    managedDeviceId='string',
    type='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • managedDeviceId (string) –

    [REQUIRED]

    The ID of the managed device that you are listing the resources of.

  • type (string) – A structure used to filter the results by type of resource.

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'resources': [
        {
            'arn': 'string',
            'id': 'string',
            'resourceType': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • resources (list) –

      A structure defining the resource’s type, Amazon Resource Name (ARN), and ID.

      • (dict) –

        A summary of a resource available on the device.

        • arn (string) –

          The Amazon Resource Name (ARN) of the resource.

        • id (string) –

          The ID of the resource.

        • resourceType (string) –

          The resource type.

    • NextToken (string) –

      A token to resume pagination.