CancelHarvestJob
Cancels an in-progress harvest job.
Request Syntax
PUT /channelGroup/ChannelGroupName/channel/ChannelName/originEndpoint/OriginEndpointName/harvestJob/HarvestJobName HTTP/1.1
x-amzn-update-if-match: ETag
URI Request Parameters
The request uses the following URI parameters.
- ChannelGroupName
-
The name of the channel group containing the channel from which the harvest job is running.
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[a-zA-Z0-9_-]+Required: Yes
- ChannelName
-
The name of the channel from which the harvest job is running.
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[a-zA-Z0-9_-]+Required: Yes
- ETag
-
The current Entity Tag (ETag) associated with the harvest job. Used for concurrency control.
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[\S]+ - HarvestJobName
-
The name of the harvest job to cancel. This name must be unique within the channel and cannot be changed after the harvest job is submitted.
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[a-zA-Z0-9_-]+Required: Yes
- OriginEndpointName
-
The name of the origin endpoint that the harvest job is harvesting from. This cannot be changed after the harvest job is submitted.
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[a-zA-Z0-9_-]+Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access Management in the IAM User Guide.
HTTP Status Code: 403
- ConflictException
-
Updating or deleting this resource can cause an inconsistent state.
HTTP Status Code: 409
- InternalServerException
-
Indicates that an error from the service occurred while trying to process a request.
HTTP Status Code: 500
- ResourceNotFoundException
-
The specified resource doesn't exist.
HTTP Status Code: 404
- ThrottlingException
-
The request throughput limit was exceeded.
HTTP Status Code: 429
- ValidationException
-
The input failed to meet the constraints specified by the 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:
