Skip to content

update_campaign 

update_campaign(
    application_id: __string,
    campaign_id: __string,
    *,
    config_overrides: Optional[PinpointClientConfig] = None,
    write_campaign_request: Optional[WriteCampaignRequest] = None,
) -> UpdateCampaignResponse

Updates the configuration and other settings for a campaign.

Parameters:

  • application_id (__string) –

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

  • campaign_id (__string) –

    The unique identifier for the campaign.

Raises:

Source code in docs_src/capo_pinpoint/_services/pinpoint.py 
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
def update_campaign(
    self,
    application_id: "capo_pinpoint.types.__string.__string",
    campaign_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.update_campaign_response.UpdateCampaignResponse":
    """<p>Updates the configuration and other settings for a campaign.</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>
        campaign_id: <p>The unique identifier for the campaign.</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.update_campaign_request.UpdateCampaignRequest]",
    ) -> OperationResponse[
        "capo_pinpoint.types.update_campaign_response.UpdateCampaignResponse"
    ]:
        import capo_pinpoint._operations.pinpoint.update_campaign

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateCampaign")
    )
    input_: capo_pinpoint.types.update_campaign_request.UpdateCampaignRequest = {
        "application_id": application_id,
        "campaign_id": campaign_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