Skip to content

aws.rekognition.describe_stream_processor

Example SQL Queries

SELECT * FROM
aws.rekognition.describe_stream_processor
WHERE
"name" = 'VALUE';

Description

Provides information about a stream processor created by CreateStreamProcessor. You can get information about the input and output streams, the input parameters for the face recognition being performed, and the current status of the stream processor.

Table Definition

Column NameColumn Data Type
name Required Input Column

Name of the stream processor.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
creation_timestamp

Date and time the stream processor was created

TIMESTAMP_S
data_sharing_preference

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.

STRUCT(
"opt_in" BOOLEAN
)
Show child fields
data_sharing_preference.opt_in

If this option is set to true, you choose to share data with Rekognition to improve model performance.

input

Kinesis video stream that provides the source streaming video.

STRUCT(
"kinesis_video_stream" STRUCT(
"arn" VARCHAR
)
)
Show child fields
input.kinesis_video_stream

The Kinesis video stream input stream for the source streaming video.

Show child fields
input.kinesis_video_stream.arn

ARN of the Kinesis video stream stream that streams the source video.

kms_key_id

The identifier for your AWS Key Management Service key (AWS KMS key). This is an optional parameter for label detection stream processors.

VARCHAR
last_update_timestamp

The time, in Unix format, the stream processor was last updated. For example, when the stream processor moves from a running state to a failed state, or when the user starts or stops the stream processor.

TIMESTAMP_S
notification_channel

The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the object detection results and completion status of a video analysis operation.

Amazon Rekognition publishes a notification the first time an object of interest or a person is detected in the video stream. For example, if Amazon Rekognition detects a person at second 2, a pet at second 4, and a person again at second 5, Amazon Rekognition sends 2 object class detected notifications, one for a person at second 2 and one for a pet at second 4.

Amazon Rekognition also publishes an an end-of-session notification with a summary when the stream processing session is complete.

STRUCT(
"sns_topic_arn" VARCHAR
)
Show child fields
notification_channel.sns_topic_arn

The Amazon Resource Number (ARN) of the Amazon Amazon Simple Notification Service topic to which Amazon Rekognition posts the completion status.

output

Kinesis data stream to which Amazon Rekognition Video puts the analysis results.

STRUCT(
"kinesis_data_stream" STRUCT(
"arn" VARCHAR
),
"s3_destination" STRUCT(
"bucket" VARCHAR,
"key_prefix" VARCHAR
)
)
Show child fields
output.kinesis_data_stream

The Amazon Kinesis Data Streams stream to which the Amazon Rekognition stream processor streams the analysis results.

Show child fields
output.kinesis_data_stream.arn

ARN of the output Amazon Kinesis Data Streams stream.

output.s3_destination

The Amazon S3 bucket location to which Amazon Rekognition publishes the detailed inference results of a video analysis operation.

Show child fields
output.s3_destination.bucket

The name of the Amazon S3 bucket you want to associate with the streaming video project. You must be the owner of the Amazon S3 bucket.

output.s3_destination.key_prefix

The prefix value of the location within the bucket that you want the information to be published to. For more information, see Using prefixes.

regions_of_interest

Specifies locations in the frames where Amazon Rekognition checks for objects or people. This is an optional parameter for label detection stream processors.

STRUCT(
"bounding_box" STRUCT(
"width" DOUBLE,
"height" DOUBLE,
"left" DOUBLE,
"top" DOUBLE
),
"polygon" STRUCT(
"x" DOUBLE,
"y" DOUBLE
)[]
)[]
Show child fields
regions_of_interest[]
Show child fields
regions_of_interest[].bounding_box

The box representing a region of interest on screen.

Show child fields
regions_of_interest[].bounding_box.height

Height of the bounding box as a ratio of the overall image height.

regions_of_interest[].bounding_box.left

Left coordinate of the bounding box as a ratio of overall image width.

regions_of_interest[].bounding_box.top

Top coordinate of the bounding box as a ratio of overall image height.

regions_of_interest[].bounding_box.width

Width of the bounding box as a ratio of the overall image width.

regions_of_interest[].polygon[]
Show child fields
regions_of_interest[].polygon[].x

The value of the X coordinate for a point on a Polygon.

regions_of_interest[].polygon[].y

The value of the Y coordinate for a point on a Polygon.

role_arn

ARN of the IAM role that allows access to the stream processor.

VARCHAR
settings

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.

STRUCT(
"face_search" STRUCT(
"collection_id" VARCHAR,
"face_match_threshold" DOUBLE
),
"connected_home" STRUCT(
"labels" VARCHAR[],
"min_confidence" DOUBLE
)
)
Show child fields
settings.connected_home

Label detection settings to use on a streaming video. Defining the settings is required in the request parameter for CreateStreamProcessor. Including this setting in the CreateStreamProcessor request enables you to use the stream processor for label detection. You can then select what you want the stream processor to detect, such as people or pets. When the stream processor has started, one notification is sent for each object class specified. For example, if packages and pets are selected, one SNS notification is published the first time a package is detected and one SNS notification is published the first time a pet is detected, as well as an end-of-session summary.

Show child fields
settings.connected_home.labels[]
settings.connected_home.min_confidence

The minimum confidence required to label an object in the video.

settings.face_search

Face search settings to use on a streaming video.

Show child fields
settings.face_search.collection_id

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

settings.face_search.face_match_threshold

Minimum face match confidence score 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, and values lower than 80 are set to 80.

status

Current status of the stream processor.

VARCHAR
status_message

Detailed status message about the stream processor.

VARCHAR
stream_processor_arn

ARN of the stream processor.

VARCHAR