PartnerCentralMarketing / Client / delete_campaign
delete_campaign¶
- PartnerCentralMarketing.Client.delete_campaign(**kwargs)¶
Permanently deletes a campaign, its assets and their stored files.
A hard delete with no undo: the campaign leaves ListCampaigns and every read of it returns ResourceNotFoundException. Its tags are removed with it.
Refused with ConflictException while the campaign has a live asset (
CAMPAIGN_HAS_ACTIVE_ASSETS), because deleting the record would orphan what the delivery platform still serves or sends: deactivate those assets first. Also refused while an activation task is running (CAMPAIGN_ACTIVATION_IN_PROGRESS). A completed campaign can be deleted.Idempotent in effect: deleting a campaign that is already gone returns ResourceNotFoundException, and nothing is left behind by a retry.
See also: AWS API Documentation
Request Syntax
response = client.delete_campaign( Catalog='AWS'|'Sandbox', CampaignIdentifier='string' )
- Parameters:
Catalog (string) –
[REQUIRED]
The catalog (AWS or Sandbox).
CampaignIdentifier (string) –
[REQUIRED]
The campaign to delete.
- Returns:
None
Exceptions
PartnerCentralMarketing.Client.exceptions.AccessDeniedExceptionPartnerCentralMarketing.Client.exceptions.InternalServerExceptionPartnerCentralMarketing.Client.exceptions.ValidationExceptionPartnerCentralMarketing.Client.exceptions.ResourceNotFoundExceptionPartnerCentralMarketing.Client.exceptions.ThrottlingException