ManagedintegrationsforIoTDeviceManagement / Client / list_destinations

list_destinations#

ManagedintegrationsforIoTDeviceManagement.Client.list_destinations(**kwargs)#

List all destination names under one Amazon Web Services account.

See also: AWS API Documentation

Request Syntax

response = client.list_destinations(
    NextToken='string',
    MaxResults=123
)
Parameters:

  • NextToken (string) – A token that can be used to retrieve the next set of results.

  • MaxResults (integer) – The maximum number of results to return at one time.

Return type:

dict

Returns:

Response Syntax

{
    'DestinationList': [
        {
            'Description': 'string',
            'DeliveryDestinationArn': 'string',
            'DeliveryDestinationType': 'KINESIS',
            'Name': 'string',
            'RoleArn': 'string'
        },
    ],
    'NextToken': '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.

    • NextToken (string) –

      A token that can be used to retrieve the next set of results.

Exceptions