Deletes a data collection campaign. Deleting a campaign suspends all data collection and removes it from any vehicles.
Parameters:
Raises:
Source code in docs_src/capo_iotfleetwise/_services/io_t_fleet_wise.py
| def delete_campaign(
self,
name: "capo_iotfleetwise.types.campaign_name.campaignName",
*,
config_overrides: Optional[IoTFleetWiseClientConfig] = None,
) -> "capo_iotfleetwise.types.delete_campaign_response.DeleteCampaignResponse":
"""<p> Deletes a data collection campaign. Deleting a campaign suspends all data collection and removes it from any vehicles. </p>
Args:
name: <p> The name of the campaign to delete. </p>
Raises:
capo_iotfleetwise.errors.internal_server_exception.InternalServerException: <p>The request couldn't be completed because the server temporarily failed.</p>
capo_iotfleetwise.errors.access_denied_exception.AccessDeniedException: <p>You don't have sufficient permission to perform this action.</p>
capo_iotfleetwise.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource wasn't found.</p>
capo_iotfleetwise.errors.throttling_exception.ThrottlingException: <p>The request couldn't be completed due to throttling.</p>
capo_iotfleetwise.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
capo_iotfleetwise.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_iotfleetwise.types.delete_campaign_request.DeleteCampaignRequest]",
) -> OperationResponse[
"capo_iotfleetwise.types.delete_campaign_response.DeleteCampaignResponse"
]:
import capo_iotfleetwise._operations.io_t_autobahn_control_plane.delete_campaign
output, http_response = (
capo_iotfleetwise._operations.io_t_autobahn_control_plane.delete_campaign.delete_campaign(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DeleteCampaign")
)
input_: capo_iotfleetwise.types.delete_campaign_request.DeleteCampaignRequest = {
"name": name
}
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|