EndUserMessagingSocial / Client / list_linked_whatsapp_business_accounts

list_linked_whatsapp_business_accounts#

EndUserMessagingSocial.Client.list_linked_whatsapp_business_accounts(**kwargs)#

List all WhatsApp Business Accounts linked to your Amazon Web Services account.

See also: AWS API Documentation

Request Syntax

response = client.list_linked_whatsapp_business_accounts(
    nextToken='string',
    maxResults=123
)
Parameters:
  • nextToken (string) – The next token for pagination.

  • maxResults (integer) – The maximum number of results to return.

Return type:

dict

Returns:

Response Syntax

{
    'linkedAccounts': [
        {
            'arn': 'string',
            'id': 'string',
            'wabaId': 'string',
            'registrationStatus': 'COMPLETE'|'INCOMPLETE',
            'linkDate': datetime(2015, 1, 1),
            'wabaName': 'string',
            'eventDestinations': [
                {
                    'eventDestinationArn': 'string',
                    'roleArn': 'string'
                },
            ]
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • linkedAccounts (list) –

      A list of WhatsApp Business Accounts linked to your Amazon Web Services account.

      • (dict) –

        The details of a linked WhatsApp Business Account.

        • arn (string) –

          The ARN of the linked WhatsApp Business Account.

        • id (string) –

          The ID of the linked WhatsApp Business Account, formatted as waba-01234567890123456789012345678901.

        • wabaId (string) –

          The WhatsApp Business Account ID provided by Meta.

        • registrationStatus (string) –

          The registration status of the linked WhatsApp Business Account.

        • linkDate (datetime) –

          The date the WhatsApp Business Account was linked.

        • wabaName (string) –

          The name of the linked WhatsApp Business Account.

        • eventDestinations (list) –

          The event destinations for the linked WhatsApp Business Account.

          • (dict) –

            Contains information on the event destination.

            • eventDestinationArn (string) –

              The ARN of the event destination.

            • roleArn (string) –

              The Amazon Resource Name (ARN) of an Identity and Access Management role that is able to import phone numbers and write events.

    • nextToken (string) –

      The next token for pagination.

Exceptions