Skip to content

list_linked_whats_app_business_accounts

list_linked_whats_app_business_accounts(
    *,
    config_overrides: Optional[SocialMessagingClientConfig] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResults] = None,
) -> ListLinkedWhatsAppBusinessAccountsOutput

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

Parameters:

  • next_token (Optional[NextToken], default: None ) –

    The next token for pagination.

  • max_results (Optional[MaxResults], default: None ) –

    The maximum number of results to return.

Raises:

Source code in docs_src/capo_socialmessaging/_services/social_messaging.py
def list_linked_whats_app_business_accounts(
    self,
    *,
    config_overrides: Optional[SocialMessagingClientConfig] = None,
    next_token: Optional["capo_socialmessaging.types.next_token.NextToken"] = None,
    max_results: Optional[
        "capo_socialmessaging.types.max_results.MaxResults"
    ] = None,
) -> "capo_socialmessaging.types.list_linked_whats_app_business_accounts_output.ListLinkedWhatsAppBusinessAccountsOutput":
    """<p>List all WhatsApp Business Accounts linked to your Amazon Web Services account.</p>

    Args:
        next_token: <p>The next token for pagination.</p>
        max_results: <p>The maximum number of results to return.</p>

    Raises:
        capo_socialmessaging.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_socialmessaging.errors.validation_exception.ValidationException: <p>The request contains an invalid parameter value. </p>
        capo_socialmessaging.errors.internal_service_exception.InternalServiceException: <p>The request processing has failed because of an unknown error, exception, or failure.</p>
        capo_socialmessaging.errors.invalid_parameters_exception.InvalidParametersException: <p>One or more parameters provided to the action are not valid.</p>
        capo_socialmessaging.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource was not found.</p>
        capo_socialmessaging.errors.throttled_request_exception.ThrottledRequestException: <p>The request was denied due to request throttling.</p>
        capo_socialmessaging.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_socialmessaging.types.list_linked_whats_app_business_accounts_input.ListLinkedWhatsAppBusinessAccountsInput]",
    ) -> OperationResponse[
        "capo_socialmessaging.types.list_linked_whats_app_business_accounts_output.ListLinkedWhatsAppBusinessAccountsOutput"
    ]:
        import capo_socialmessaging._operations.social_messaging.list_linked_whats_app_business_accounts

        output, http_response = (
            capo_socialmessaging._operations.social_messaging.list_linked_whats_app_business_accounts.list_linked_whats_app_business_accounts(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListLinkedWhatsAppBusinessAccounts")
    )
    input_: capo_socialmessaging.types.list_linked_whats_app_business_accounts_input.ListLinkedWhatsAppBusinessAccountsInput = {}
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output