Skip to content

list_campaigns async

list_campaigns(
    *,
    config_overrides: Optional[AsyncConnectCampaignsV2ClientConfig] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[NextToken] = None,
    filters: Optional[CampaignFilters] = None,
) -> ListCampaignsResponse

Provides summary information about the campaigns under the specified Amazon Connect account.

Raises:

Source code in docs_src/capo_connectcampaignsv2/_services/async_connect_campaigns_v2.py
async def list_campaigns(
    self,
    *,
    config_overrides: Optional[AsyncConnectCampaignsV2ClientConfig] = None,
    max_results: Optional[
        "capo_connectcampaignsv2.types.max_results.MaxResults"
    ] = None,
    next_token: Optional[
        "capo_connectcampaignsv2.types.next_token.NextToken"
    ] = None,
    filters: Optional[
        "capo_connectcampaignsv2.types.campaign_filters.CampaignFilters"
    ] = None,
) -> "capo_connectcampaignsv2.types.list_campaigns_response.ListCampaignsResponse":
    """Provides summary information about the campaigns under the specified Amazon Connect account.

    Raises:
        capo_connectcampaignsv2.errors.access_denied_exception.AccessDeniedException: You do not have sufficient access to perform this action.
        capo_connectcampaignsv2.errors.internal_server_exception.InternalServerException: Request processing failed because of an error or failure with the service.
        capo_connectcampaignsv2.errors.validation_exception.ValidationException: The input fails to satisfy the constraints specified by an AWS service.
        capo_connectcampaignsv2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_connectcampaignsv2.types.list_campaigns_request.ListCampaignsRequest]",
    ) -> AsyncOperationResponse[
        "capo_connectcampaignsv2.types.list_campaigns_response.ListCampaignsResponse"
    ]:
        import capo_connectcampaignsv2._operations.amazon_connect_campaign_service_v2.list_campaigns

        (
            output,
            http_response,
        ) = await capo_connectcampaignsv2._operations.amazon_connect_campaign_service_v2.list_campaigns.async_list_campaigns(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListCampaigns")
    )
    input_: capo_connectcampaignsv2.types.list_campaigns_request.ListCampaignsRequest = {}
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if filters is not None:
        input_["filters"] = filters

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