| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.Rekognition.StartStreamProcessor
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.
Synopsis
- data StartStreamProcessor = StartStreamProcessor' {}
- newStartStreamProcessor :: Text -> StartStreamProcessor
- startStreamProcessor_startSelector :: Lens' StartStreamProcessor (Maybe StreamProcessingStartSelector)
- startStreamProcessor_stopSelector :: Lens' StartStreamProcessor (Maybe StreamProcessingStopSelector)
- startStreamProcessor_name :: Lens' StartStreamProcessor Text
- data StartStreamProcessorResponse = StartStreamProcessorResponse' {
- sessionId :: Maybe Text
- httpStatus :: Int
- newStartStreamProcessorResponse :: Int -> StartStreamProcessorResponse
- startStreamProcessorResponse_sessionId :: Lens' StartStreamProcessorResponse (Maybe Text)
- startStreamProcessorResponse_httpStatus :: Lens' StartStreamProcessorResponse Int
Creating a Request
data StartStreamProcessor Source #
See: newStartStreamProcessor smart constructor.
Constructors
| StartStreamProcessor' | |
Fields
| |
Instances
newStartStreamProcessor Source #
Arguments
| :: Text | |
| -> StartStreamProcessor |
Create a value of StartStreamProcessor with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:startSelector:StartStreamProcessor', startStreamProcessor_startSelector - Specifies the starting point in the Kinesis stream to start processing.
You can use the producer timestamp or the fragment number. If you use
the producer timestamp, you must put the time in milliseconds. For more
information about fragment numbers, see
Fragment.
This is a required parameter for label detection stream processors and should not be used to start a face search stream processor.
$sel:stopSelector:StartStreamProcessor', startStreamProcessor_stopSelector - 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.
StartStreamProcessor, startStreamProcessor_name - The name of the stream processor to start processing.
Request Lenses
startStreamProcessor_startSelector :: Lens' StartStreamProcessor (Maybe StreamProcessingStartSelector) Source #
Specifies the starting point in the Kinesis stream to start processing. You can use the producer timestamp or the fragment number. If you use the producer timestamp, you must put the time in milliseconds. For more information about fragment numbers, see Fragment.
This is a required parameter for label detection stream processors and should not be used to start a face search stream processor.
startStreamProcessor_stopSelector :: Lens' StartStreamProcessor (Maybe StreamProcessingStopSelector) Source #
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.
startStreamProcessor_name :: Lens' StartStreamProcessor Text Source #
The name of the stream processor to start processing.
Destructuring the Response
data StartStreamProcessorResponse Source #
See: newStartStreamProcessorResponse smart constructor.
Constructors
| StartStreamProcessorResponse' | |
Fields
| |
Instances
newStartStreamProcessorResponse Source #
Create a value of StartStreamProcessorResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sessionId:StartStreamProcessorResponse', startStreamProcessorResponse_sessionId - A unique identifier for the stream processing session.
$sel:httpStatus:StartStreamProcessorResponse', startStreamProcessorResponse_httpStatus - The response's http status code.
Response Lenses
startStreamProcessorResponse_sessionId :: Lens' StartStreamProcessorResponse (Maybe Text) Source #
A unique identifier for the stream processing session.
startStreamProcessorResponse_httpStatus :: Lens' StartStreamProcessorResponse Int Source #
The response's http status code.