[ aws . iotanalytics ]

start-pipeline-reprocessing

Description

Starts the reprocessing of raw message data through the pipeline.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  start-pipeline-reprocessing
--pipeline-name <value>
[--start-time <value>]
[--end-time <value>]
[--channel-messages <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--pipeline-name (string)

The name of the pipeline on which to start reprocessing.

--start-time (timestamp)

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.

--end-time (timestamp)

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.

--channel-messages (structure)

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 .

s3Paths -> (list)

Specifies one or more keys that identify the Amazon Simple Storage Service (Amazon S3) objects that save your channel messages.

(string)

Shorthand Syntax:

s3Paths=string,string

JSON Syntax:

{
  "s3Paths": ["string", ...]
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

To start pipeline reprocessing

The following start-pipeline-reprocessing example starts the reprocessing of raw message data through the specified pipeline.

aws iotanalytics start-pipeline-reprocessing \
    --pipeline-name mypipeline

Output:

{
    "reprocessingId": "6ad2764f-fb13-4de3-b101-4e74af03b043"
}

For more information, see StartPipelineReprocessing in the AWS IoT Analytics API Reference.

Output

reprocessingId -> (string)

The ID of the pipeline reprocessing activity that was started.