Skip to content

list_whats_app_flows async

list_whats_app_flows(
    id: LinkedWhatsAppBusinessAccountId,
    *,
    config_overrides: Optional[AsyncSocialMessagingClientConfig] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResults] = None,
) -> ListWhatsAppFlowsOutput

Lists all WhatsApp Flows for a WhatsApp Business Account. Returns summary information including Flow ID, name, status, and categories.

Parameters:

Raises:

Source code in docs_src/capo_socialmessaging/_services/async_social_messaging.py
async def list_whats_app_flows(
    self,
    id: "capo_socialmessaging.types.linked_whats_app_business_account_id.LinkedWhatsAppBusinessAccountId",
    *,
    config_overrides: Optional[AsyncSocialMessagingClientConfig] = 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_whats_app_flows_output.ListWhatsAppFlowsOutput"
):
    """<p>Lists all WhatsApp Flows for a WhatsApp Business Account. Returns summary information including Flow ID, name, status, and categories.</p>

    Args:
        id: <p>The ID of the WhatsApp Business Account to list Flows for.</p>
        next_token: <p>The token for the next page of results.</p>
        max_results: <p>The maximum number of results to return per page.</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.access_denied_by_meta_exception.AccessDeniedByMetaException: <p>You do not have sufficient access to perform this action.</p>
        capo_socialmessaging.errors.dependency_exception.DependencyException: <p>Thrown when performing an action because a dependency would be broken.</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_socialmessaging.types.list_whats_app_flows_input.ListWhatsAppFlowsInput]",
    ) -> AsyncOperationResponse[
        "capo_socialmessaging.types.list_whats_app_flows_output.ListWhatsAppFlowsOutput"
    ]:
        import capo_socialmessaging._operations.social_messaging.list_whats_app_flows

        (
            output,
            http_response,
        ) = await capo_socialmessaging._operations.social_messaging.list_whats_app_flows.async_list_whats_app_flows(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListWhatsAppFlows")
    )
    input_: capo_socialmessaging.types.list_whats_app_flows_input.ListWhatsAppFlowsInput = {
        "id": id
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output