AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Container for the parameters to the CreateStreamProcessor operation. 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
for receiving the output. You must use the FaceSearch
option in Settings
,
specifying the collection that contains the faces 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 by using the ConnectedHome
option in settings, and selecting one of
the following: PERSON
, PET
, PACKAGE
, ALL
You can also
specify where in the frame you want Amazon Rekognition to monitor with RegionsOfInterest
.
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.
Namespace: Amazon.Rekognition.Model
Assembly: AWSSDK.Rekognition.dll
Version: 3.x.y.z
public class CreateStreamProcessorRequest : AmazonRekognitionRequest IAmazonWebServiceRequest
The CreateStreamProcessorRequest type exposes the following members
Name | Description | |
---|---|---|
CreateStreamProcessorRequest() |
Name | Type | Description | |
---|---|---|---|
DataSharingPreference | Amazon.Rekognition.Model.StreamProcessorDataSharingPreference |
Gets and sets the property 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. |
|
Input | Amazon.Rekognition.Model.StreamProcessorInput |
Gets and sets the property Input.
Kinesis video stream stream that provides the source streaming video. If you are using
the AWS CLI, the parameter name is |
|
KmsKeyId | System.String |
Gets and sets the property 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. |
|
Name | System.String |
Gets and sets the property Name.
An identifier you assign to the stream processor. You can use |
|
NotificationChannel | Amazon.Rekognition.Model.StreamProcessorNotificationChannel |
Gets and sets the property NotificationChannel. |
|
Output | Amazon.Rekognition.Model.StreamProcessorOutput |
Gets and sets the property 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 |
|
RegionsOfInterest | System.Collections.Generic.List<Amazon.Rekognition.Model.RegionOfInterest> |
Gets and sets the property 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. |
|
RoleArn | System.String |
Gets and sets the property 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. |
|
Settings | Amazon.Rekognition.Model.StreamProcessorSettings |
Gets and sets the property Settings.
Input parameters used in a streaming video analyzed by a stream processor. You can
use |
|
Tags | System.Collections.Generic.Dictionary<System.String, System.String> |
Gets and sets the property Tags. A set of tags (key-value pairs) that you want to attach to the stream processor. |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5