rekognition_create_stream_processor: Creates an Amazon Rekognition stream processor that you can...

View source: R/rekognition_operations.R

rekognition_create_stream_processorR Documentation

Creates an Amazon Rekognition stream processor that you can use to detect and recognize faces or to detect labels in a streaming video

Description

Creates an Amazon Rekognition stream processor that you can use to detect and recognize faces or to detect labels in a streaming video.

See https://www.paws-r-sdk.com/docs/rekognition_create_stream_processor/ for full documentation.

Usage

rekognition_create_stream_processor(
  Input,
  Output,
  Name,
  Settings,
  RoleArn,
  Tags = NULL,
  NotificationChannel = NULL,
  KmsKeyId = NULL,
  RegionsOfInterest = NULL,
  DataSharingPreference = NULL
)

Arguments

Input

[required] 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.

Output

[required] 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.

Name

[required] 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 describe_stream_processor. Name is idempotent. This is required for both face search and label detection stream processors.

Settings

[required] 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.

RoleArn

[required] 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.

Tags

A set of tags (key-value pairs) that you want to attach to the stream processor.

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

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.

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.


paws.machine.learning documentation built on Sept. 12, 2024, 6:23 a.m.