ManagedintegrationsforIoTDeviceManagement / Paginator / ListDestinations

ListDestinations#

class ManagedintegrationsforIoTDeviceManagement.Paginator.ListDestinations#
paginator = client.get_paginator('list_destinations')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from ManagedintegrationsforIoTDeviceManagement.Client.list_destinations().

See also: AWS API Documentation

Request Syntax

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

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

{
    'DestinationList': [
        {
            'Description': 'string',
            'DeliveryDestinationArn': 'string',
            'DeliveryDestinationType': 'KINESIS',
            'Name': 'string',
            'RoleArn': 'string'
        },
    ],

}

Response Structure

  • (dict) –

    • DestinationList (list) –

      The list of destinations.

      • (dict) –

        Structure describing a destination for IoT managed integrations to deliver notifications for a device.

        • Description (string) –

          The description of the customer-managed destination.

        • DeliveryDestinationArn (string) –

          The Amazon Resource Name (ARN) of the customer-managed destination.

        • DeliveryDestinationType (string) –

          The destination type for the customer-managed destination.

        • Name (string) –

          The name of the customer-managed destination.

        • RoleArn (string) –

          The Amazon Resource Name (ARN) of the delivery destination.