Skip to content

list_campaigns

list_campaigns(
    *,
    config_overrides: Optional[ConnectCampaignsClientConfig] = 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_connectcampaigns/_services/connect_campaigns.py
def list_campaigns(
    self,
    *,
    config_overrides: Optional[ConnectCampaignsClientConfig] = None,
    max_results: Optional[
        "capo_connectcampaigns.types.max_results.MaxResults"
    ] = None,
    next_token: Optional["capo_connectcampaigns.types.next_token.NextToken"] = None,
    filters: Optional[
        "capo_connectcampaigns.types.campaign_filters.CampaignFilters"
    ] = None,
) -> "capo_connectcampaigns.types.list_campaigns_response.ListCampaignsResponse":
    """Provides summary information about the campaigns under the specified Amazon Connect account.

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

    def _handler(
        req: "OperationRequest[capo_connectcampaigns.types.list_campaigns_request.ListCampaignsRequest]",
    ) -> OperationResponse[
        "capo_connectcampaigns.types.list_campaigns_response.ListCampaignsResponse"
    ]:
        import capo_connectcampaigns._operations.amazon_connect_campaign_service.list_campaigns

        output, http_response = (
            capo_connectcampaigns._operations.amazon_connect_campaign_service.list_campaigns.list_campaigns(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListCampaigns")
    )
    input_: capo_connectcampaigns.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 = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output