DescribeStreamProcessorCommand

Suggest an Edit

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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { RekognitionClient, DescribeStreamProcessorCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
// const { RekognitionClient, DescribeStreamProcessorCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
const client = new RekognitionClient(config);
const input = { // DescribeStreamProcessorRequest
  Name: "STRING_VALUE", // required
};
const command = new DescribeStreamProcessorCommand(input);
const response = await client.send(command);
// { // DescribeStreamProcessorResponse
//   Name: "STRING_VALUE",
//   StreamProcessorArn: "STRING_VALUE",
//   Status: "STOPPED" || "STARTING" || "RUNNING" || "FAILED" || "STOPPING" || "UPDATING",
//   StatusMessage: "STRING_VALUE",
//   CreationTimestamp: new Date("TIMESTAMP"),
//   LastUpdateTimestamp: new Date("TIMESTAMP"),
//   Input: { // StreamProcessorInput
//     KinesisVideoStream: { // KinesisVideoStream
//       Arn: "STRING_VALUE",
//     },
//   },
//   Output: { // StreamProcessorOutput
//     KinesisDataStream: { // KinesisDataStream
//       Arn: "STRING_VALUE",
//     },
//     S3Destination: { // S3Destination
//       Bucket: "STRING_VALUE",
//       KeyPrefix: "STRING_VALUE",
//     },
//   },
//   RoleArn: "STRING_VALUE",
//   Settings: { // StreamProcessorSettings
//     FaceSearch: { // FaceSearchSettings
//       CollectionId: "STRING_VALUE",
//       FaceMatchThreshold: Number("float"),
//     },
//     ConnectedHome: { // ConnectedHomeSettings
//       Labels: [ // ConnectedHomeLabels // required
//         "STRING_VALUE",
//       ],
//       MinConfidence: Number("float"),
//     },
//   },
//   NotificationChannel: { // StreamProcessorNotificationChannel
//     SNSTopicArn: "STRING_VALUE", // required
//   },
//   KmsKeyId: "STRING_VALUE",
//   RegionsOfInterest: [ // RegionsOfInterest
//     { // RegionOfInterest
//       BoundingBox: { // BoundingBox
//         Width: Number("float"),
//         Height: Number("float"),
//         Left: Number("float"),
//         Top: Number("float"),
//       },
//       Polygon: [ // Polygon
//         { // Point
//           X: Number("float"),
//           Y: Number("float"),
//         },
//       ],
//     },
//   ],
//   DataSharingPreference: { // StreamProcessorDataSharingPreference
//     OptIn: true || false, // required
//   },
// };

DescribeStreamProcessorCommand Input

See DescribeStreamProcessorCommandInput for more details

Parameter
Type
Description
Name
Required
string | undefined

Name of the stream processor for which you want information.

DescribeStreamProcessorCommand Output

See DescribeStreamProcessorCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
CreationTimestamp
Date | undefined

Date and time the stream processor was created

DataSharingPreference
StreamProcessorDataSharingPreference | undefined

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.

Input
StreamProcessorInput | undefined

Kinesis video stream that provides the source streaming video.

KmsKeyId
string | undefined

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

LastUpdateTimestamp
Date | undefined

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.

Name
string | undefined

Name of the stream processor.

NotificationChannel
StreamProcessorNotificationChannel | undefined

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.

Output
StreamProcessorOutput | undefined

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

RegionsOfInterest
RegionOfInterest[] | undefined

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

RoleArn
string | undefined

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

Settings
StreamProcessorSettings | undefined

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.

Status
StreamProcessorStatus | undefined

Current status of the stream processor.

StatusMessage
string | undefined

Detailed status message about the stream processor.

StreamProcessorArn
string | undefined

ARN of the stream processor.

Throws

Name
Fault
Details
AccessDeniedException
client

You are not authorized to perform the action.

InternalServerError
server

Amazon Rekognition experienced a service issue. Try your call again.

InvalidParameterException
client

Input parameter violated a constraint. Validate your parameter before calling the API operation again.

ProvisionedThroughputExceededException
client

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

ResourceNotFoundException
client

The resource specified in the request cannot be found.

ThrottlingException
server

Amazon Rekognition is temporarily unable to process the request. Try your call again.

RekognitionServiceException
Base exception class for all service exceptions from Rekognition service.