IoTFleetWise / Client / delete_campaign

delete_campaign

IoTFleetWise.Client.delete_campaign(**kwargs)

Deletes a data collection campaign. Deleting a campaign suspends all data collection and removes it from any vehicles.

See also: AWS API Documentation

Request Syntax

response = client.delete_campaign(
    name='string'
)

Parameters:

name (string) –

[REQUIRED]

The name of the campaign to delete.

Return type:

dict

Returns:

Response Syntax

{
    'name': 'string',
    'arn': 'string'
}

Response Structure

• (dict) –

  • name (string) –

    The name of the deleted campaign.

  • arn (string) –

    The Amazon Resource Name (ARN) of the deleted campaign.

    Note

    The ARN isn’t returned if a campaign doesn’t exist.

Exceptions

• IoTFleetWise.Client.exceptions.ResourceNotFoundException

• IoTFleetWise.Client.exceptions.InternalServerException

• IoTFleetWise.Client.exceptions.ThrottlingException

• IoTFleetWise.Client.exceptions.ValidationException

• IoTFleetWise.Client.exceptions.AccessDeniedException