stream_processors_list_only
Lists stream_processors
in a region or regions, for all properties use stream_processors
Overview
Name | stream_processors_list_only |
Type | Resource |
Description | The AWS::Rekognition::StreamProcessor type is used to create an Amazon Rekognition StreamProcessor that you can use to analyze streaming videos. |
Id | aws.rekognition.stream_processors_list_only |
Fields
Name | Datatype | Description |
---|---|---|
arn | string | The ARN of the stream processor |
name | string | Name of the stream processor. It's an identifier you assign to the stream processor. You can use it to manage the stream processor. |
kms_key_id | string | The KMS key that is used by Rekognition to encrypt any intermediate customer metadata and store in the customer's S3 bucket. |
role_arn | string | 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. |
kinesis_video_stream | object | The Kinesis Video Stream that streams the source video. |
face_search_settings | object | Face search settings to use on a streaming video. Note that either FaceSearchSettings or ConnectedHomeSettings should be set. Not both |
connected_home_settings | object | Connected home settings to use on a streaming video. Note that either ConnectedHomeSettings or FaceSearchSettings should be set. Not both |
kinesis_data_stream | object | The Amazon Kinesis Data Stream stream to which the Amazon Rekognition stream processor streams the analysis results, as part of face search feature. |
s3_destination | object | The S3 location in customer's account where inference output & artifacts are stored, as part of connected home feature. |
notification_channel | object | The ARN of the SNS notification channel where events of interests are published, as part of connected home feature. |
data_sharing_preference | object | Indicates whether Rekognition is allowed to store the video stream data for model-training. |
polygon_regions_of_interest | array | 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 |
bounding_box_regions_of_interest | array | 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%. |
status | string | Current status of the stream processor. |
status_message | string | Detailed status message about the stream processor. |
tags | array | An array of key-value pairs to apply to this resource. |
region | string | AWS region. |
Methods
Name | Accessible by | Required Params |
---|---|---|
list_resources | SELECT | region |
SELECT
examples
Lists all stream_processors
in a region.
SELECT
region,
name
FROM aws.rekognition.stream_processors_list_only
WHERE region = 'us-east-1';
Permissions
For permissions required to operate on the stream_processors_list_only
resource, see stream_processors