Interface DescribeStreamProcessorCommandOutput

The output of DescribeStreamProcessorCommand.

interface DescribeStreamProcessorCommandOutput {
    $metadata: ResponseMetadata;
    CreationTimestamp?: Date;
    DataSharingPreference?: StreamProcessorDataSharingPreference;
    Input?: StreamProcessorInput;
    KmsKeyId?: string;
    LastUpdateTimestamp?: Date;
    Name?: string;
    NotificationChannel?: StreamProcessorNotificationChannel;
    Output?: StreamProcessorOutput;
    RegionsOfInterest?: RegionOfInterest[];
    RoleArn?: string;
    Settings?: StreamProcessorSettings;
    Status?: StreamProcessorStatus;
    StatusMessage?: string;
    StreamProcessorArn?: string;
}

Hierarchy (view full)

Properties

$metadata CreationTimestamp? DataSharingPreference? Input? KmsKeyId? LastUpdateTimestamp? Name? NotificationChannel? Output? RegionsOfInterest? RoleArn? Settings? Status? StatusMessage? StreamProcessorArn?

Properties

$metadata

$metadata: ResponseMetadata

Metadata pertaining to this request.

Optional CreationTimestamp

CreationTimestamp?: Date

Date and time the stream processor was created

Optional DataSharingPreference

DataSharingPreference?: StreamProcessorDataSharingPreference

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.

Optional Input

Input?: StreamProcessorInput

Kinesis video stream that provides the source streaming video.

Optional KmsKeyId

KmsKeyId?: string

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

Optional LastUpdateTimestamp

LastUpdateTimestamp?: Date

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.

Optional Name

Name?: string

Name of the stream processor.

Optional NotificationChannel

NotificationChannel?: StreamProcessorNotificationChannel

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.

Optional Output

Output?: StreamProcessorOutput

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

Optional RegionsOfInterest

RegionsOfInterest?: RegionOfInterest[]

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

Optional RoleArn

RoleArn?: string

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

Optional Settings

Settings?: StreamProcessorSettings

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.

Optional Status

Status?: StreamProcessorStatus

Current status of the stream processor.

Optional StatusMessage

StatusMessage?: string

Detailed status message about the stream processor.

Optional StreamProcessorArn

StreamProcessorArn?: string

ARN of the stream processor.

Settings

Member Visibility

Theme

On This Page