EndUserMessagingSocial / Paginator / ListWhatsAppFlows

ListWhatsAppFlows

class EndUserMessagingSocial.Paginator.ListWhatsAppFlows

paginator = client.get_paginator('list_whatsapp_flows')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• id (string) –

  [REQUIRED]

  The ID of the WhatsApp Business Account to list Flows for.

• 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

{
    'flows': [
        {
            'flowId': 'string',
            'flowName': 'string',
            'flowStatus': 'string',
            'flowCategories': [
                'SIGN_UP'|'SIGN_IN'|'APPOINTMENT_BOOKING'|'LEAD_GENERATION'|'SHOPPING'|'CONTACT_US'|'CUSTOMER_SUPPORT'|'SURVEY'|'OTHER',
            ],
            'validationErrors': [
                'string',
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • flows (list) –

    A list of Flow summaries.

    • (dict) –

      Contains summary information about a WhatsApp Flow, including its ID, name, status, and categories.

      • flowId (string) –

        The unique identifier of the Flow assigned by Meta.

      • flowName (string) –

        The name of the Flow.

      • flowStatus (string) –

        The lifecycle status of the Flow (DRAFT, PUBLISHED, DEPRECATED, BLOCKED, or THROTTLED).

      • flowCategories (list) –

        The categories that classify the business purpose of the Flow.

        • (string) –

          The category that classifies the business purpose of a WhatsApp Flow.

      • validationErrors (list) –

        A list of validation errors from Meta, if any.

        • (string) –

  • NextToken (string) –

    A token to resume pagination.