Skip to content

create_campaign 

create_campaign(
    application_id: __string,
    *,
    config_overrides: Optional[PinpointClientConfig] = None,
    write_campaign_request: Optional[WriteCampaignRequest] = None,
) -> CreateCampaignResponse

Creates a new campaign for an application or updates the settings of an existing campaign for an application.

Parameters:

  • application_id (__string) –

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

Raises:

Source code in docs_src/capo_pinpoint/_services/pinpoint.py 
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
def create_campaign(
    self,
    application_id: "capo_pinpoint.types.__string.__string",
    *,
    config_overrides: Optional[PinpointClientConfig] = None,
    write_campaign_request: Optional[
        "capo_pinpoint.types.write_campaign_request.WriteCampaignRequest"
    ] = None,
) -> "capo_pinpoint.types.create_campaign_response.CreateCampaignResponse":
    """<p>Creates a new campaign for an application or updates the settings of an existing campaign for an application.</p>

    Args:
        application_id: <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>

    Raises:
        capo_pinpoint.errors.bad_request_exception.BadRequestException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.forbidden_exception.ForbiddenException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.internal_server_error_exception.InternalServerErrorException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.method_not_allowed_exception.MethodNotAllowedException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.not_found_exception.NotFoundException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.payload_too_large_exception.PayloadTooLargeException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.too_many_requests_exception.TooManyRequestsException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

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

        output, http_response = (
            capo_pinpoint._operations.pinpoint.create_campaign.create_campaign(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateCampaign")
    )
    input_: capo_pinpoint.types.create_campaign_request.CreateCampaignRequest = {
        "application_id": application_id
    }
    if write_campaign_request is not None:
        input_["write_campaign_request"] = write_campaign_request

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