EndUserMessagingSocial / Paginator / ListWhatsAppFlowAssets

ListWhatsAppFlowAssets

class EndUserMessagingSocial.Paginator.ListWhatsAppFlowAssets

paginator = client.get_paginator('list_whatsapp_flow_assets')

paginate(**kwargs)

Creates an iterator that will paginate through responses from EndUserMessagingSocial.Client.list_whatsapp_flow_assets().

See also: AWS API Documentation

Request Syntax

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

Parameters:

• id (string) –

  [REQUIRED]

  The ID of the WhatsApp Business Account associated with this Flow.

• flowId (string) –

  [REQUIRED]

  The unique identifier of the Flow whose assets to list.

• 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

{
    'flowAssets': [
        {
            'name': 'string',
            'assetType': 'string',
            'downloadUrl': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • flowAssets (list) –

    A list of Flow assets with download URLs.

    • (dict) –

      Represents a single asset file associated with a WhatsApp Flow, including a presigned download URL.

      • name (string) –

        The filename of the asset (for example, flow.json).

      • assetType (string) –

        The type of asset. Currently the only supported value is FLOW_JSON.

      • downloadUrl (string) –

        A presigned URL from Meta for downloading the asset. The URL expires after a short period.

  • NextToken (string) –

    A token to resume pagination.