| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.Rekognition.CreateStreamProcessor
Description
Creates an Amazon Rekognition stream processor that you can use to detect and recognize faces in a streaming video.
Amazon Rekognition Video is a consumer of live video from Amazon Kinesis Video Streams. Amazon Rekognition Video sends analysis results to Amazon Kinesis Data Streams.
You provide as input a Kinesis video stream (Input) and a Kinesis data
stream (Output) stream. You also specify the face recognition criteria
in Settings. For example, the collection containing faces that you
want to recognize. Use Name to assign an identifier for the stream
processor. You use Name to manage the stream processor. For example,
you can start processing the source video by calling
StartStreamProcessor with the Name field.
After you have finished analyzing a streaming video, use StopStreamProcessor to stop processing. You can delete the stream processor by calling DeleteStreamProcessor.
This operation requires permissions to perform the
rekognition:CreateStreamProcessor action. If you want to tag your
stream processor, you also require permission to perform the
rekognition:TagResource operation.
Synopsis
- data CreateStreamProcessor = CreateStreamProcessor' {}
- newCreateStreamProcessor :: StreamProcessorInput -> StreamProcessorOutput -> Text -> StreamProcessorSettings -> Text -> CreateStreamProcessor
- createStreamProcessor_tags :: Lens' CreateStreamProcessor (Maybe (HashMap Text Text))
- createStreamProcessor_input :: Lens' CreateStreamProcessor StreamProcessorInput
- createStreamProcessor_output :: Lens' CreateStreamProcessor StreamProcessorOutput
- createStreamProcessor_name :: Lens' CreateStreamProcessor Text
- createStreamProcessor_settings :: Lens' CreateStreamProcessor StreamProcessorSettings
- createStreamProcessor_roleArn :: Lens' CreateStreamProcessor Text
- data CreateStreamProcessorResponse = CreateStreamProcessorResponse' {}
- newCreateStreamProcessorResponse :: Int -> CreateStreamProcessorResponse
- createStreamProcessorResponse_streamProcessorArn :: Lens' CreateStreamProcessorResponse (Maybe Text)
- createStreamProcessorResponse_httpStatus :: Lens' CreateStreamProcessorResponse Int
Creating a Request
data CreateStreamProcessor Source #
See: newCreateStreamProcessor smart constructor.
Constructors
| CreateStreamProcessor' | |
Fields
| |
Instances
newCreateStreamProcessor Source #
Arguments
| :: StreamProcessorInput | |
| -> StreamProcessorOutput | |
| -> Text | |
| -> StreamProcessorSettings | |
| -> Text | |
| -> CreateStreamProcessor |
Create a value of CreateStreamProcessor 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:tags:CreateStreamProcessor', createStreamProcessor_tags - A set of tags (key-value pairs) that you want to attach to the stream
processor.
$sel:input:CreateStreamProcessor', createStreamProcessor_input - Kinesis video stream stream that provides the source streaming video. If
you are using the AWS CLI, the parameter name is StreamProcessorInput.
$sel:output:CreateStreamProcessor', createStreamProcessor_output - Kinesis data stream stream to which Amazon Rekognition Video puts the
analysis results. If you are using the AWS CLI, the parameter name is
StreamProcessorOutput.
$sel:name:CreateStreamProcessor', createStreamProcessor_name - An identifier you assign to the stream processor. You can use Name to
manage the stream processor. For example, you can get the current status
of the stream processor by calling DescribeStreamProcessor. Name is
idempotent.
$sel:settings:CreateStreamProcessor', createStreamProcessor_settings - Face recognition input parameters to be used by the stream processor.
Includes the collection to use for face recognition and the face
attributes to detect.
$sel:roleArn:CreateStreamProcessor', createStreamProcessor_roleArn - ARN of the IAM role that allows access to the stream processor.
Request Lenses
createStreamProcessor_tags :: Lens' CreateStreamProcessor (Maybe (HashMap Text Text)) Source #
A set of tags (key-value pairs) that you want to attach to the stream processor.
createStreamProcessor_input :: Lens' CreateStreamProcessor StreamProcessorInput Source #
Kinesis video stream stream that provides the source streaming video. If
you are using the AWS CLI, the parameter name is StreamProcessorInput.
createStreamProcessor_output :: Lens' CreateStreamProcessor StreamProcessorOutput Source #
Kinesis data stream stream to which Amazon Rekognition Video puts the
analysis results. If you are using the AWS CLI, the parameter name is
StreamProcessorOutput.
createStreamProcessor_name :: Lens' CreateStreamProcessor Text Source #
An identifier you assign to the stream processor. You can use Name to
manage the stream processor. For example, you can get the current status
of the stream processor by calling DescribeStreamProcessor. Name is
idempotent.
createStreamProcessor_settings :: Lens' CreateStreamProcessor StreamProcessorSettings Source #
Face recognition input parameters to be used by the stream processor. Includes the collection to use for face recognition and the face attributes to detect.
createStreamProcessor_roleArn :: Lens' CreateStreamProcessor Text Source #
ARN of the IAM role that allows access to the stream processor.
Destructuring the Response
data CreateStreamProcessorResponse Source #
See: newCreateStreamProcessorResponse smart constructor.
Constructors
| CreateStreamProcessorResponse' | |
Fields
| |
Instances
newCreateStreamProcessorResponse Source #
Create a value of CreateStreamProcessorResponse 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:streamProcessorArn:CreateStreamProcessorResponse', createStreamProcessorResponse_streamProcessorArn - ARN for the newly create stream processor.
$sel:httpStatus:CreateStreamProcessorResponse', createStreamProcessorResponse_httpStatus - The response's http status code.
Response Lenses
createStreamProcessorResponse_streamProcessorArn :: Lens' CreateStreamProcessorResponse (Maybe Text) Source #
ARN for the newly create stream processor.
createStreamProcessorResponse_httpStatus :: Lens' CreateStreamProcessorResponse Int Source #
The response's http status code.