Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-rekognition-streamprocessor.json
Parent schema serverless-framework-configuration
Type: object

The AWS::Rekognition::StreamProcessor type is used to create an Amazon Rekognition StreamProcessor that you can use to analyze streaming videos.

. Source:- https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git

Properties

RoleArn string | Aws_CF_FunctionString required

ARN of the IAM role that allows access to the stream processor, and provides Rekognition read permissions for KVS stream and write permissions to S3 bucket and SNS topic.

KinesisVideoStream object required

The Kinesis Video Stream that streams the source video.

1 nested properties
Arn string | Aws_CF_FunctionString required

ARN of the Kinesis Video Stream that streams the source video.

Name string | Aws_CF_FunctionString

Name of the stream processor. It's an identifier you assign to the stream processor. You can use it to manage the stream processor.

KmsKeyId string | Aws_CF_FunctionString

The KMS key that is used by Rekognition to encrypt any intermediate customer metadata and store in the customer's S3 bucket.

FaceSearchSettings object

Face search settings to use on a streaming video. Note that either FaceSearchSettings or ConnectedHomeSettings should be set. Not both

2 nested properties
CollectionId string | Aws_CF_FunctionString required

The ID of a collection that contains faces that you want to search for.

FaceMatchThreshold number

Minimum face match confidence score percentage that must be met to return a result for a recognized face. The default is 80. 0 is the lowest confidence. 100 is the highest confidence. Values between 0 and 100 are accepted.

min=0max=100
ConnectedHomeSettings object

Connected home settings to use on a streaming video. Note that either ConnectedHomeSettings or FaceSearchSettings should be set. Not both

2 nested properties
Labels string[] required

List of labels that need to be detected in the video stream. Current supported values are PERSON, PET, PACKAGE, ALL.

minItems=1uniqueItems=true
MinConfidence number

Minimum object class match confidence score that must be met to return a result for a recognized object.

min=0max=100
KinesisDataStream object

The Amazon Kinesis Data Stream stream to which the Amazon Rekognition stream processor streams the analysis results, as part of face search feature.

1 nested properties
Arn string | Aws_CF_FunctionString required

ARN of the Kinesis Data Stream stream.

S3Destination object

The S3 location in customer's account where inference output & artifacts are stored, as part of connected home feature.

2 nested properties
BucketName string | Aws_CF_FunctionString required

Name of the S3 bucket.

ObjectKeyPrefix string | Aws_CF_FunctionString

The object key prefix path where the results will be stored. Default is no prefix path

NotificationChannel object

The ARN of the SNS notification channel where events of interests are published, as part of connected home feature.

1 nested properties
Arn string | Aws_CF_FunctionString required

ARN of the SNS topic.

DataSharingPreference object

Indicates whether Rekognition is allowed to store the video stream data for model-training.

1 nested properties
OptIn boolean required

Flag to enable data-sharing

PolygonRegionsOfInterest Polygon[]

The PolygonRegionsOfInterest specifies a set of polygon areas of interest in the video frames to analyze, as part of connected home feature. Each polygon is in turn, an ordered list of Point

minItems=0uniqueItems=true
BoundingBoxRegionsOfInterest BoundingBox[]

The BoundingBoxRegionsOfInterest specifies an array of bounding boxes of interest in the video frames to analyze, as part of connected home feature. If an object is partially in a region of interest, Rekognition will tag it as detected if the overlap of the object with the region-of-interest is greater than 20%.

minItems=0uniqueItems=true
Tags Tag[]

An array of key-value pairs to apply to this resource.

minItems=0maxItems=200uniqueItems=true

One of

1. variant
2. variant

Definitions

Arn string | Aws_CF_FunctionString

The ARN of the stream processor

KinesisVideoStream object

The Kinesis Video Stream that streams the source video.

Arn string | Aws_CF_FunctionString required

ARN of the Kinesis Video Stream that streams the source video.

S3Destination object

The S3 location in customer's account where inference output & artifacts are stored, as part of connected home feature.

BucketName string | Aws_CF_FunctionString required

Name of the S3 bucket.

ObjectKeyPrefix string | Aws_CF_FunctionString

The object key prefix path where the results will be stored. Default is no prefix path

KinesisDataStream object

The Amazon Kinesis Data Stream stream to which the Amazon Rekognition stream processor streams the analysis results, as part of face search feature.

Arn string | Aws_CF_FunctionString required

ARN of the Kinesis Data Stream stream.

Labels string[]

List of labels that need to be detected in the video stream. Current supported values are PERSON, PET, PACKAGE, ALL.

ConnectedHomeSettings object

Connected home settings to use on a streaming video. Note that either ConnectedHomeSettings or FaceSearchSettings should be set. Not both

Labels string[] required

List of labels that need to be detected in the video stream. Current supported values are PERSON, PET, PACKAGE, ALL.

minItems=1uniqueItems=true
MinConfidence number

Minimum object class match confidence score that must be met to return a result for a recognized object.

min=0max=100
FaceSearchSettings object

Face search settings to use on a streaming video. Note that either FaceSearchSettings or ConnectedHomeSettings should be set. Not both

CollectionId string | Aws_CF_FunctionString required

The ID of a collection that contains faces that you want to search for.

FaceMatchThreshold number

Minimum face match confidence score percentage that must be met to return a result for a recognized face. The default is 80. 0 is the lowest confidence. 100 is the highest confidence. Values between 0 and 100 are accepted.

min=0max=100
NotificationChannel object

The ARN of the SNS notification channel where events of interests are published, as part of connected home feature.

Arn string | Aws_CF_FunctionString required

ARN of the SNS topic.

Point object

An (X, Y) cartesian coordinate denoting a point on the frame

X number required

The X coordinate of the point.

Y number required

The Y coordinate of the point.

Polygon Point[]

A polygon showing a region of interest. Note that the ordering of the Point entries matter in defining the polygon

BoundingBox object

A bounding box denoting a region of interest in the frame to be analyzed.

Height number required
min=0max=100
Width number required
min=0max=100
Left number required
min=0max=100
Top number required
min=0max=100
DataSharingPreference object

Indicates whether Rekognition is allowed to store the video stream data for model-training.

OptIn boolean required

Flag to enable data-sharing

Tag object

A key-value pair to associate with a resource.

Key string | Aws_CF_FunctionString required

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Value string | Aws_CF_FunctionString required

The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.