Skip to content

create_campaign

create_campaign(
    name: CampaignName,
    connect_instance_id: InstanceId,
    *,
    config_overrides: Optional[ConnectCampaignsV2ClientConfig] = None,
    channel_subtype_config: Optional[ChannelSubtypeConfig] = None,
    type: Optional[ExternalCampaignType] = None,
    source: Optional[Source] = None,
    connect_campaign_flow_arn: Optional[Arn] = None,
    schedule: Optional[Schedule] = None,
    entry_limits_config: Optional[EntryLimitsConfig] = None,
    communication_time_config: Optional[CommunicationTimeConfig] = None,
    communication_limits_override: Optional[CommunicationLimitsConfig] = None,
    tags: Optional[TagMap] = None,
) -> CreateCampaignResponse

Creates a campaign for the specified Amazon Connect account. This API is idempotent.

Raises:

Source code in docs_src/capo_connectcampaignsv2/_services/connect_campaigns_v2.py
def create_campaign(
    self,
    name: "capo_connectcampaignsv2.types.campaign_name.CampaignName",
    connect_instance_id: "capo_connectcampaignsv2.types.instance_id.InstanceId",
    *,
    config_overrides: Optional[ConnectCampaignsV2ClientConfig] = None,
    channel_subtype_config: Optional[
        "capo_connectcampaignsv2.types.channel_subtype_config.ChannelSubtypeConfig"
    ] = None,
    type: Optional[
        "capo_connectcampaignsv2.types.external_campaign_type.ExternalCampaignType"
    ] = None,
    source: Optional["capo_connectcampaignsv2.types.source.Source"] = None,
    connect_campaign_flow_arn: Optional[
        "capo_connectcampaignsv2.types.arn.Arn"
    ] = None,
    schedule: Optional["capo_connectcampaignsv2.types.schedule.Schedule"] = None,
    entry_limits_config: Optional[
        "capo_connectcampaignsv2.types.entry_limits_config.EntryLimitsConfig"
    ] = None,
    communication_time_config: Optional[
        "capo_connectcampaignsv2.types.communication_time_config.CommunicationTimeConfig"
    ] = None,
    communication_limits_override: Optional[
        "capo_connectcampaignsv2.types.communication_limits_config.CommunicationLimitsConfig"
    ] = None,
    tags: Optional["capo_connectcampaignsv2.types.tag_map.TagMap"] = None,
) -> (
    "capo_connectcampaignsv2.types.create_campaign_response.CreateCampaignResponse"
):
    """Creates a campaign for the specified Amazon Connect account. This API is idempotent.

    Raises:
        capo_connectcampaignsv2.errors.access_denied_exception.AccessDeniedException: You do not have sufficient access to perform this action.
        capo_connectcampaignsv2.errors.conflict_exception.ConflictException: The request could not be processed because of conflict in the current state of the resource.
        capo_connectcampaignsv2.errors.internal_server_exception.InternalServerException: Request processing failed because of an error or failure with the service.
        capo_connectcampaignsv2.errors.resource_not_found_exception.ResourceNotFoundException: The specified resource was not found.
        capo_connectcampaignsv2.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: Request would cause a service quota to be exceeded.
        capo_connectcampaignsv2.errors.throttling_exception.ThrottlingException: The request was denied due to request throttling.
        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.
    """

    def _handler(
        req: "OperationRequest[capo_connectcampaignsv2.types.create_campaign_request.CreateCampaignRequest]",
    ) -> OperationResponse[
        "capo_connectcampaignsv2.types.create_campaign_response.CreateCampaignResponse"
    ]:
        import capo_connectcampaignsv2._operations.amazon_connect_campaign_service_v2.create_campaign

        output, http_response = (
            capo_connectcampaignsv2._operations.amazon_connect_campaign_service_v2.create_campaign.create_campaign(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_connectcampaignsv2.types.create_campaign_request.CreateCampaignRequest",
    ) -> dict[str, Any]:
        import capo_connectcampaignsv2.types.create_campaign_request

        return (
            capo_connectcampaignsv2.types.create_campaign_request.redact_sensitive(
                input_
            )
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("CreateCampaign", redact_input=_redact_input),
    )
    input_: capo_connectcampaignsv2.types.create_campaign_request.CreateCampaignRequest = {
        "name": name,
        "connect_instance_id": connect_instance_id,
    }
    if channel_subtype_config is not None:
        input_["channel_subtype_config"] = channel_subtype_config
    if type is not None:
        input_["type"] = type
    if source is not None:
        input_["source"] = source
    if connect_campaign_flow_arn is not None:
        input_["connect_campaign_flow_arn"] = connect_campaign_flow_arn
    if schedule is not None:
        input_["schedule"] = schedule
    if entry_limits_config is not None:
        input_["entry_limits_config"] = entry_limits_config
    if communication_time_config is not None:
        input_["communication_time_config"] = communication_time_config
    if communication_limits_override is not None:
        input_["communication_limits_override"] = communication_limits_override
    if tags is not None:
        input_["tags"] = tags

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