Skip to content

delete_campaign async 

delete_campaign(
    application_id: __string,
    campaign_id: __string,
    *,
    config_overrides: Optional[AsyncPinpointClientConfig] = None,
) -> DeleteCampaignResponse

Deletes a campaign from 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.

  • campaign_id (__string) –

    The unique identifier for the campaign.

Raises:

Source code in docs_src/capo_pinpoint/_services/async_pinpoint.py 
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
async def delete_campaign(
    self,
    application_id: "capo_pinpoint.types.__string.__string",
    campaign_id: "capo_pinpoint.types.__string.__string",
    *,
    config_overrides: Optional[AsyncPinpointClientConfig] = None,
) -> "capo_pinpoint.types.delete_campaign_response.DeleteCampaignResponse":
    """<p>Deletes a campaign from 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>
        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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_pinpoint.types.delete_campaign_request.DeleteCampaignRequest]",
    ) -> AsyncOperationResponse[
        "capo_pinpoint.types.delete_campaign_response.DeleteCampaignResponse"
    ]:
        import capo_pinpoint._operations.pinpoint.delete_campaign

        (
            output,
            http_response,
        ) = await capo_pinpoint._operations.pinpoint.delete_campaign.async_delete_campaign(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteCampaign")
    )
    input_: capo_pinpoint.types.delete_campaign_request.DeleteCampaignRequest = {
        "application_id": application_id,
        "campaign_id": campaign_id,
    }

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