| 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.CreateStreamProcessor
Description
Creates an Amazon Rekognition stream processor that you can use to detect and recognize faces or to detect labels in a streaming video.
Amazon Rekognition Video is a consumer of live video from Amazon Kinesis Video Streams. There are two different settings for stream processors in Amazon Rekognition: detecting faces and detecting labels.
- If you are creating a stream processor for detecting faces, you
provide as input a Kinesis video stream (
Input) and a Kinesis data stream (Output) stream. You also specify the face recognition criteria inSettings. For example, the collection containing faces that you want to recognize. After you have finished analyzing a streaming video, use StopStreamProcessor to stop processing. - If you are creating a stream processor to detect labels, you provide
as input a Kinesis video stream (
Input), Amazon S3 bucket information (Output), and an Amazon SNS topic ARN (NotificationChannel). You can also provide a KMS key ID to encrypt the data sent to your Amazon S3 bucket. You specify what you want to detect inConnectedHomeSettings, such as people, packages and people, or pets, people, and packages. You can also specify where in the frame you want Amazon Rekognition to monitor withRegionsOfInterest. When you run the StartStreamProcessor operation on a label detection stream processor, you input start and stop information to determine the length of the processing time.
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.
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' {
- dataSharingPreference :: Maybe StreamProcessorDataSharingPreference
- kmsKeyId :: Maybe Text
- notificationChannel :: Maybe StreamProcessorNotificationChannel
- regionsOfInterest :: Maybe [RegionOfInterest]
- tags :: Maybe (HashMap Text Text)
- input :: StreamProcessorInput
- output :: StreamProcessorOutput
- name :: Text
- settings :: StreamProcessorSettings
- roleArn :: Text
- newCreateStreamProcessor :: StreamProcessorInput -> StreamProcessorOutput -> Text -> StreamProcessorSettings -> Text -> CreateStreamProcessor
- createStreamProcessor_dataSharingPreference :: Lens' CreateStreamProcessor (Maybe StreamProcessorDataSharingPreference)
- createStreamProcessor_kmsKeyId :: Lens' CreateStreamProcessor (Maybe Text)
- createStreamProcessor_notificationChannel :: Lens' CreateStreamProcessor (Maybe StreamProcessorNotificationChannel)
- createStreamProcessor_regionsOfInterest :: Lens' CreateStreamProcessor (Maybe [RegionOfInterest])
- 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:dataSharingPreference:CreateStreamProcessor', createStreamProcessor_dataSharingPreference - Shows whether you are sharing data with Rekognition to improve model
performance. You can choose this option at the account level or on a
per-stream basis. Note that if you opt out at the account level this
setting is ignored on individual streams.
CreateStreamProcessor, createStreamProcessor_kmsKeyId - The identifier for your AWS Key Management Service key (AWS KMS key).
This is an optional parameter for label detection stream processors and
should not be used to create a face search stream processor. You can
supply the Amazon Resource Name (ARN) of your KMS key, the ID of your
KMS key, an alias for your KMS key, or an alias ARN. The key is used to
encrypt results and data published to your Amazon S3 bucket, which
includes image frames and hero images. Your source images are
unaffected.
$sel:notificationChannel:CreateStreamProcessor', createStreamProcessor_notificationChannel - Undocumented member.
CreateStreamProcessor, createStreamProcessor_regionsOfInterest - Specifies locations in the frames where Amazon Rekognition checks for
objects or people. You can specify up to 10 regions of interest, and
each region has either a polygon or a bounding box. This is an optional
parameter for label detection stream processors and should not be used
to create a face search stream processor.
$sel:tags:CreateStreamProcessor', createStreamProcessor_tags - A set of tags (key-value pairs) that you want to attach to the stream
processor.
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.
This is required for both face search and label detection stream
processors.
CreateStreamProcessor, createStreamProcessor_output - Kinesis data stream stream or Amazon S3 bucket location to which Amazon
Rekognition Video puts the analysis results. If you are using the AWS
CLI, the parameter name is StreamProcessorOutput. This must be a
S3Destination of an Amazon S3 bucket that you own for a label detection
stream processor or a Kinesis data stream ARN for a face search stream
processor.
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. This is required for both face search and label detection
stream processors.
$sel:settings:CreateStreamProcessor', createStreamProcessor_settings - Input parameters used in a streaming video analyzed by a stream
processor. You can use FaceSearch to recognize faces in a streaming
video, or you can use ConnectedHome to detect labels.
CreateStreamProcessor, createStreamProcessor_roleArn - The Amazon Resource Number (ARN) of the IAM role that allows access to
the stream processor. The IAM role provides Rekognition read permissions
for a Kinesis stream. It also provides write permissions to an Amazon S3
bucket and Amazon Simple Notification Service topic for a label
detection stream processor. This is required for both face search and
label detection stream processors.
Request Lenses
createStreamProcessor_dataSharingPreference :: Lens' CreateStreamProcessor (Maybe StreamProcessorDataSharingPreference) Source #
Shows whether you are sharing data with Rekognition to improve model performance. You can choose this option at the account level or on a per-stream basis. Note that if you opt out at the account level this setting is ignored on individual streams.
createStreamProcessor_kmsKeyId :: Lens' CreateStreamProcessor (Maybe Text) Source #
The identifier for your AWS Key Management Service key (AWS KMS key). This is an optional parameter for label detection stream processors and should not be used to create a face search stream processor. You can supply the Amazon Resource Name (ARN) of your KMS key, the ID of your KMS key, an alias for your KMS key, or an alias ARN. The key is used to encrypt results and data published to your Amazon S3 bucket, which includes image frames and hero images. Your source images are unaffected.
createStreamProcessor_notificationChannel :: Lens' CreateStreamProcessor (Maybe StreamProcessorNotificationChannel) Source #
Undocumented member.
createStreamProcessor_regionsOfInterest :: Lens' CreateStreamProcessor (Maybe [RegionOfInterest]) Source #
Specifies locations in the frames where Amazon Rekognition checks for objects or people. You can specify up to 10 regions of interest, and each region has either a polygon or a bounding box. This is an optional parameter for label detection stream processors and should not be used to create a face search stream processor.
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.
This is required for both face search and label detection stream
processors.
createStreamProcessor_output :: Lens' CreateStreamProcessor StreamProcessorOutput Source #
Kinesis data stream stream or Amazon S3 bucket location to which Amazon
Rekognition Video puts the analysis results. If you are using the AWS
CLI, the parameter name is StreamProcessorOutput. This must be a
S3Destination of an Amazon S3 bucket that you own for a label detection
stream processor or a Kinesis data stream ARN for a face search stream
processor.
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. This is required for both face search and label detection
stream processors.
createStreamProcessor_settings :: Lens' CreateStreamProcessor StreamProcessorSettings Source #
Input parameters used in a streaming video analyzed by a stream
processor. You can use FaceSearch to recognize faces in a streaming
video, or you can use ConnectedHome to detect labels.
createStreamProcessor_roleArn :: Lens' CreateStreamProcessor Text Source #
The Amazon Resource Number (ARN) of the IAM role that allows access to the stream processor. The IAM role provides Rekognition read permissions for a Kinesis stream. It also provides write permissions to an Amazon S3 bucket and Amazon Simple Notification Service topic for a label detection stream processor. This is required for both face search and label detection stream processors.
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 - Amazon Resource Number for the newly created stream processor.
$sel:httpStatus:CreateStreamProcessorResponse', createStreamProcessorResponse_httpStatus - The response's http status code.
Response Lenses
createStreamProcessorResponse_streamProcessorArn :: Lens' CreateStreamProcessorResponse (Maybe Text) Source #
Amazon Resource Number for the newly created stream processor.
createStreamProcessorResponse_httpStatus :: Lens' CreateStreamProcessorResponse Int Source #
The response's http status code.