DeleteCampaign
Deletes a data collection campaign. Deleting a campaign suspends all data collection and removes it from any vehicles.
Request Syntax
{
"name": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- name
-
The name of the campaign to delete.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
[a-zA-Z\d\-_:]+Required: Yes
Response Syntax
{
"arn": "string",
"name": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- arn
-
The Amazon Resource Name (ARN) of the deleted campaign.
Note
The ARN isn’t returned if a campaign doesn’t exist.
Type: String
Pattern:
arn:aws:iotfleetwise:[a-z0-9-]+:[0-9]{12}:campaign/[a-zA-Z\d\-_:]{1,100} - name
-
The name of the deleted campaign.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
[a-zA-Z\d\-_:]+
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You don't have sufficient permission to perform this action.
HTTP Status Code: 400
- InternalServerException
-
The request couldn't be completed because the server temporarily failed.
HTTP Status Code: 500
- ResourceNotFoundException
-
The resource wasn't found.
HTTP Status Code: 400
- ThrottlingException
-
The request couldn't be completed due to throttling.
HTTP Status Code: 400
- ValidationException
-
The input fails to satisfy the constraints specified by an AWS service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
