DescribeStreamProcessor
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.
Request Syntax
{ "Name": "string" }
Request Parameters
The request accepts the following data in JSON format.
- Name
-
Name of the stream processor for which you want information.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[a-zA-Z0-9_.\-]+Required: Yes
Response Syntax
{ "CreationTimestamp": number, "Input": { "KinesisVideoStream": { "Arn": "string" } }, "LastUpdateTimestamp": number, "Name": "string", "Output": { "KinesisDataStream": { "Arn": "string" } }, "RoleArn": "string", "Settings": { "FaceSearch": { "CollectionId": "string", "FaceMatchThreshold": number } }, "Status": "string", "StatusMessage": "string", "StreamProcessorArn": "string" }
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- CreationTimestamp
-
Date and time the stream processor was created
Type: Timestamp
- Input
-
Kinesis video stream that provides the source streaming video.
Type: StreamProcessorInput object
- LastUpdateTimestamp
-
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.
Type: Timestamp
- Name
-
Name of the stream processor.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[a-zA-Z0-9_.\-]+ - Output
-
Kinesis data stream to which Amazon Rekognition Video puts the analysis results.
Type: StreamProcessorOutput object
- RoleArn
-
ARN of the IAM role that allows access to the stream processor.
Type: String
Pattern:
arn:aws:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+ - Settings
-
Face recognition input parameters that are being used by the stream processor. Includes the collection to use for face recognition and the face attributes to detect.
Type: StreamProcessorSettings object
- Status
-
Current status of the stream processor.
Type: String
Valid Values:
STOPPED | STARTING | RUNNING | FAILED | STOPPING - StatusMessage
-
Detailed status message about the stream processor.
Type: String
- StreamProcessorArn
-
ARN of the stream processor.
Type: String
Pattern:
(^arn:[a-z\d-]+:rekognition:[a-z\d-]+:\d{12}:streamprocessor\/.+$)
Errors
- AccessDeniedException
-
You are not authorized to perform the action.
HTTP Status Code: 400
- InternalServerError
-
Amazon Rekognition experienced a service issue. Try your call again.
HTTP Status Code: 500
- InvalidParameterException
-
Input parameter violated a constraint. Validate your parameter before calling the API operation again.
HTTP Status Code: 400
- ProvisionedThroughputExceededException
-
The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.
HTTP Status Code: 400
- ResourceNotFoundException
-
The collection specified in the request cannot be found.
HTTP Status Code: 400
- ThrottlingException
-
Amazon Rekognition is temporarily unable to process the request. Try your call again.
HTTP Status Code: 500
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
