Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . rekognition ]

start-stream-processor

Description

Starts processing a stream processor. You create a stream processor by calling CreateStreamProcessor . To tell StartStreamProcessor which stream processor to start, use the value of the Name field specified in the call to CreateStreamProcessor .

If you are using a label detection stream processor to detect labels, you need to provide a Start selector and a Stop selector to determine the length of the stream processing time.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  start-stream-processor
--name <value>
[--start-selector <value>]
[--stop-selector <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--name (string)

The name of the stream processor to start processing.

--start-selector (structure)

Specifies the starting point in the Kinesis stream to start processing. You can use the producer timestamp or the fragment number. For more information, see Fragment .

This is a required parameter for label detection stream processors and should not be used to start a face search stream processor.

KVSStreamStartSelector -> (structure)

Specifies the starting point in the stream to start processing. This can be done with a timestamp or a fragment number in a Kinesis stream.

ProducerTimestamp -> (long)

The timestamp from the producer corresponding to the fragment.

FragmentNumber -> (string)

The unique identifier of the fragment. This value monotonically increases based on the ingestion order.

Shorthand Syntax:

KVSStreamStartSelector={ProducerTimestamp=long,FragmentNumber=string}

JSON Syntax:

{
  "KVSStreamStartSelector": {
    "ProducerTimestamp": long,
    "FragmentNumber": "string"
  }
}

--stop-selector (structure)

Specifies when to stop processing the stream. You can specify a maximum amount of time to process the video.

This is a required parameter for label detection stream processors and should not be used to start a face search stream processor.

MaxDurationInSeconds -> (long)

Specifies the maximum amount of time in seconds that you want the stream to be processed. The largest amount of time is 2 minutes. The default is 10 seconds.

Shorthand Syntax:

MaxDurationInSeconds=long

JSON Syntax:

{
  "MaxDurationInSeconds": long
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. 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

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To start a stream processor

The following start-stream-processor command starts the specified video stream processor.

aws rekognition start-stream-processor \
    --name my-stream-processor

This command produces no output.

For more information, see Working with Streaming Videos in the Amazon Rekognition Developer Guide.

Output

SessionId -> (string)

A unique identifier for the stream processing session.