Skip to main content

stream_processors_list_only

Lists stream_processors in a region or regions, for all properties use stream_processors

Overview

Namestream_processors_list_only
TypeResource
DescriptionThe AWS::Rekognition::StreamProcessor type is used to create an Amazon Rekognition StreamProcessor that you can use to analyze streaming videos.
Idaws.rekognition.stream_processors_list_only

Fields

NameDatatypeDescription
arnstringThe ARN of the stream processor
namestringName 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_idstringThe KMS key that is used by Rekognition to encrypt any intermediate customer metadata and store in the customer's S3 bucket.
role_arnstringARN 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_streamobjectThe Kinesis Video Stream that streams the source video.
face_search_settingsobjectFace search settings to use on a streaming video. Note that either FaceSearchSettings or ConnectedHomeSettings should be set. Not both
connected_home_settingsobjectConnected home settings to use on a streaming video. Note that either ConnectedHomeSettings or FaceSearchSettings should be set. Not both
kinesis_data_streamobjectThe Amazon Kinesis Data Stream stream to which the Amazon Rekognition stream processor streams the analysis results, as part of face search feature.
s3_destinationobjectThe S3 location in customer's account where inference output & artifacts are stored, as part of connected home feature.
notification_channelobjectThe ARN of the SNS notification channel where events of interests are published, as part of connected home feature.
data_sharing_preferenceobjectIndicates whether Rekognition is allowed to store the video stream data for model-training.
polygon_regions_of_interestarrayThe 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_interestarrayThe 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%.
statusstringCurrent status of the stream processor.
status_messagestringDetailed status message about the stream processor.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.

Methods

NameAccessible byRequired Params
list_resourcesSELECTregion

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