stream_processors

Creates, updates, deletes or gets a stream_processor resource or lists stream_processors in a region

Overview

Name	stream_processors
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	awscc.rekognition.stream_processors

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
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.
region	string	AWS region.

For more information, see AWS::Rekognition::StreamProcessor.

Methods

Name	Resource	Accessible by	Required Params
create_resource	stream_processors	INSERT	RoleArn, KinesisVideoStream, region
delete_resource	stream_processors	DELETE	Identifier, region
update_resource	stream_processors	UPDATE	Identifier, PatchDocument, region
list_resources	stream_processors_list_only	SELECT	region
get_resource	stream_processors	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual stream_processor.

SELECT
  region,
  arn,
  name,
  kms_key_id,
  role_arn,
  kinesis_video_stream,
  face_search_settings,
  connected_home_settings,
  kinesis_data_stream,
  s3_destination,
  notification_channel,
  data_sharing_preference,
  polygon_regions_of_interest,
  bounding_box_regions_of_interest,
  status,
  status_message,
  tags
FROM awscc.rekognition.stream_processors
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ name }}';

list (identifiers only)

Lists all stream_processors in a region.

SELECT
  region,
  name
FROM awscc.rekognition.stream_processors_list_only
WHERE
  region = '{{ region }}';

INSERT example

Use the following StackQL query and manifest file to create a new stream_processor resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.rekognition.stream_processors (
  RoleArn,
  KinesisVideoStream,
  region
)
SELECT
  '{{ role_arn }}',
  '{{ kinesis_video_stream }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.rekognition.stream_processors (
  Name,
  KmsKeyId,
  RoleArn,
  KinesisVideoStream,
  FaceSearchSettings,
  ConnectedHomeSettings,
  KinesisDataStream,
  S3Destination,
  NotificationChannel,
  DataSharingPreference,
  PolygonRegionsOfInterest,
  BoundingBoxRegionsOfInterest,
  Tags,
  region
)
SELECT
  '{{ name }}',
  '{{ kms_key_id }}',
  '{{ role_arn }}',
  '{{ kinesis_video_stream }}',
  '{{ face_search_settings }}',
  '{{ connected_home_settings }}',
  '{{ kinesis_data_stream }}',
  '{{ s3_destination }}',
  '{{ notification_channel }}',
  '{{ data_sharing_preference }}',
  '{{ polygon_regions_of_interest }}',
  '{{ bounding_box_regions_of_interest }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: stream_processor
  props:
    - name: name
      value: '{{ name }}'
    - name: kms_key_id
      value: '{{ kms_key_id }}'
    - name: role_arn
      value: '{{ role_arn }}'
    - name: kinesis_video_stream
      value:
        arn: '{{ arn }}'
    - name: face_search_settings
      value:
        collection_id: '{{ collection_id }}'
        face_match_threshold: null
    - name: connected_home_settings
      value:
        labels:
          - '{{ labels[0] }}'
        min_confidence: null
    - name: kinesis_data_stream
      value:
        arn: '{{ arn }}'
    - name: s3_destination
      value:
        bucket_name: '{{ bucket_name }}'
        object_key_prefix: '{{ object_key_prefix }}'
    - name: notification_channel
      value:
        arn: '{{ arn }}'
    - name: data_sharing_preference
      value:
        opt_in: '{{ opt_in }}'
    - name: polygon_regions_of_interest
      value:
        - - x: null
            'y': null
    - name: bounding_box_regions_of_interest
      value:
        - height: null
          width: null
          left: null
          top: null
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

Use the following StackQL query and manifest file to update a stream_processor resource, using stack-deploy.

/*+ update */
UPDATE awscc.rekognition.stream_processors
SET PatchDocument = string('{{ {
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ name }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.rekognition.stream_processors
WHERE
  Identifier = '{{ name }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

To operate on the stream_processors resource, the following permissions are required:

Create

rekognition:CreateStreamProcessor,
iam:PassRole,
rekognition:DescribeStreamProcessor,
rekognition:ListTagsForResource,
rekognition:TagResource

Read

rekognition:DescribeStreamProcessor,
rekognition:ListTagsForResource

Update

rekognition:TagResource,
rekognition:UntagResource,
rekognition:ListTagsForResource,
rekognition:DescribeStreamProcessor

Delete

rekognition:DeleteStreamProcessor

List

rekognition:ListStreamProcessors