StartPipelineReprocessing - AWS IoT Analytics

StartPipelineReprocessing

Starts the reprocessing of raw message data through the pipeline.

Important

The StartPipelineReprocessing operation in AWS IoT Analytics is no longer available to new customers. Existing customers of AWS IoT Analytics can continue to use the service as normal. Learn more

Request Syntax

POST /pipelines/pipelineName/reprocessing HTTP/1.1 Content-type: application/json { "channelMessages": { "s3Paths": [ "string" ] }, "endTime": number, "startTime": number }

URI Request Parameters

The request uses the following URI parameters.

pipelineName

The name of the pipeline on which to start reprocessing.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: (^(?!_{2}))(^[a-zA-Z0-9_]+$)

Required: Yes

Request Body

The request accepts the following data in JSON format.

channelMessages

Specifies one or more sets of channel messages that you want to reprocess.

If you use the channelMessages object, you must not specify a value for startTime and endTime.

Type: ChannelMessages object

Required: No

endTime

The end time (exclusive) of raw message data that is reprocessed.

If you specify a value for the endTime parameter, you must not use the channelMessages object.

Type: Timestamp

Required: No

startTime

The start time (inclusive) of raw message data that is reprocessed.

If you specify a value for the startTime parameter, you must not use the channelMessages object.

Type: Timestamp

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "reprocessingId": "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.

reprocessingId

The ID of the pipeline reprocessing activity that was started.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalFailureException

There was an internal failure.

HTTP Status Code: 500

InvalidRequestException

The request was not valid.

HTTP Status Code: 400

ResourceAlreadyExistsException

A resource with the same name already exists.

HTTP Status Code: 409

ResourceNotFoundException

A resource with the specified name could not be found.

HTTP Status Code: 404

ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 503

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: