Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
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.
Synopsis
- data DescribeStreamProcessor = DescribeStreamProcessor' {}
- newDescribeStreamProcessor :: Text -> DescribeStreamProcessor
- describeStreamProcessor_name :: Lens' DescribeStreamProcessor Text
- data DescribeStreamProcessorResponse = DescribeStreamProcessorResponse' {
- creationTimestamp :: Maybe POSIX
- dataSharingPreference :: Maybe StreamProcessorDataSharingPreference
- input :: Maybe StreamProcessorInput
- kmsKeyId :: Maybe Text
- lastUpdateTimestamp :: Maybe POSIX
- name :: Maybe Text
- notificationChannel :: Maybe StreamProcessorNotificationChannel
- output :: Maybe StreamProcessorOutput
- regionsOfInterest :: Maybe [RegionOfInterest]
- roleArn :: Maybe Text
- settings :: Maybe StreamProcessorSettings
- status :: Maybe StreamProcessorStatus
- statusMessage :: Maybe Text
- streamProcessorArn :: Maybe Text
- httpStatus :: Int
- newDescribeStreamProcessorResponse :: Int -> DescribeStreamProcessorResponse
- describeStreamProcessorResponse_creationTimestamp :: Lens' DescribeStreamProcessorResponse (Maybe UTCTime)
- describeStreamProcessorResponse_dataSharingPreference :: Lens' DescribeStreamProcessorResponse (Maybe StreamProcessorDataSharingPreference)
- describeStreamProcessorResponse_input :: Lens' DescribeStreamProcessorResponse (Maybe StreamProcessorInput)
- describeStreamProcessorResponse_kmsKeyId :: Lens' DescribeStreamProcessorResponse (Maybe Text)
- describeStreamProcessorResponse_lastUpdateTimestamp :: Lens' DescribeStreamProcessorResponse (Maybe UTCTime)
- describeStreamProcessorResponse_name :: Lens' DescribeStreamProcessorResponse (Maybe Text)
- describeStreamProcessorResponse_notificationChannel :: Lens' DescribeStreamProcessorResponse (Maybe StreamProcessorNotificationChannel)
- describeStreamProcessorResponse_output :: Lens' DescribeStreamProcessorResponse (Maybe StreamProcessorOutput)
- describeStreamProcessorResponse_regionsOfInterest :: Lens' DescribeStreamProcessorResponse (Maybe [RegionOfInterest])
- describeStreamProcessorResponse_roleArn :: Lens' DescribeStreamProcessorResponse (Maybe Text)
- describeStreamProcessorResponse_settings :: Lens' DescribeStreamProcessorResponse (Maybe StreamProcessorSettings)
- describeStreamProcessorResponse_status :: Lens' DescribeStreamProcessorResponse (Maybe StreamProcessorStatus)
- describeStreamProcessorResponse_statusMessage :: Lens' DescribeStreamProcessorResponse (Maybe Text)
- describeStreamProcessorResponse_streamProcessorArn :: Lens' DescribeStreamProcessorResponse (Maybe Text)
- describeStreamProcessorResponse_httpStatus :: Lens' DescribeStreamProcessorResponse Int
Creating a Request
data DescribeStreamProcessor Source #
See: newDescribeStreamProcessor
smart constructor.
Instances
newDescribeStreamProcessor Source #
Create a value of DescribeStreamProcessor
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeStreamProcessor
, describeStreamProcessor_name
- Name of the stream processor for which you want information.
Request Lenses
describeStreamProcessor_name :: Lens' DescribeStreamProcessor Text Source #
Name of the stream processor for which you want information.
Destructuring the Response
data DescribeStreamProcessorResponse Source #
See: newDescribeStreamProcessorResponse
smart constructor.
DescribeStreamProcessorResponse' | |
|
Instances
newDescribeStreamProcessorResponse Source #
Create a value of DescribeStreamProcessorResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeStreamProcessorResponse
, describeStreamProcessorResponse_creationTimestamp
- Date and time the stream processor was created
$sel:dataSharingPreference:DescribeStreamProcessorResponse'
, describeStreamProcessorResponse_dataSharingPreference
- 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.
DescribeStreamProcessorResponse
, describeStreamProcessorResponse_input
- Kinesis video stream that provides the source streaming video.
DescribeStreamProcessorResponse
, describeStreamProcessorResponse_kmsKeyId
- The identifier for your AWS Key Management Service key (AWS KMS key).
This is an optional parameter for label detection stream processors.
$sel:lastUpdateTimestamp:DescribeStreamProcessorResponse'
, describeStreamProcessorResponse_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.
DescribeStreamProcessor
, describeStreamProcessorResponse_name
- Name of the stream processor.
$sel:notificationChannel:DescribeStreamProcessorResponse'
, describeStreamProcessorResponse_notificationChannel
- Undocumented member.
DescribeStreamProcessorResponse
, describeStreamProcessorResponse_output
- Kinesis data stream to which Amazon Rekognition Video puts the analysis
results.
DescribeStreamProcessorResponse
, describeStreamProcessorResponse_regionsOfInterest
- Specifies locations in the frames where Amazon Rekognition checks for
objects or people. This is an optional parameter for label detection
stream processors.
DescribeStreamProcessorResponse
, describeStreamProcessorResponse_roleArn
- ARN of the IAM role that allows access to the stream processor.
$sel:settings:DescribeStreamProcessorResponse'
, describeStreamProcessorResponse_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.
DescribeStreamProcessorResponse
, describeStreamProcessorResponse_status
- Current status of the stream processor.
DescribeStreamProcessorResponse
, describeStreamProcessorResponse_statusMessage
- Detailed status message about the stream processor.
$sel:streamProcessorArn:DescribeStreamProcessorResponse'
, describeStreamProcessorResponse_streamProcessorArn
- ARN of the stream processor.
$sel:httpStatus:DescribeStreamProcessorResponse'
, describeStreamProcessorResponse_httpStatus
- The response's http status code.
Response Lenses
describeStreamProcessorResponse_creationTimestamp :: Lens' DescribeStreamProcessorResponse (Maybe UTCTime) Source #
Date and time the stream processor was created
describeStreamProcessorResponse_dataSharingPreference :: Lens' DescribeStreamProcessorResponse (Maybe StreamProcessorDataSharingPreference) Source #
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.
describeStreamProcessorResponse_input :: Lens' DescribeStreamProcessorResponse (Maybe StreamProcessorInput) Source #
Kinesis video stream that provides the source streaming video.
describeStreamProcessorResponse_kmsKeyId :: Lens' DescribeStreamProcessorResponse (Maybe Text) Source #
The identifier for your AWS Key Management Service key (AWS KMS key). This is an optional parameter for label detection stream processors.
describeStreamProcessorResponse_lastUpdateTimestamp :: Lens' DescribeStreamProcessorResponse (Maybe UTCTime) Source #
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.
describeStreamProcessorResponse_name :: Lens' DescribeStreamProcessorResponse (Maybe Text) Source #
Name of the stream processor.
describeStreamProcessorResponse_notificationChannel :: Lens' DescribeStreamProcessorResponse (Maybe StreamProcessorNotificationChannel) Source #
Undocumented member.
describeStreamProcessorResponse_output :: Lens' DescribeStreamProcessorResponse (Maybe StreamProcessorOutput) Source #
Kinesis data stream to which Amazon Rekognition Video puts the analysis results.
describeStreamProcessorResponse_regionsOfInterest :: Lens' DescribeStreamProcessorResponse (Maybe [RegionOfInterest]) Source #
Specifies locations in the frames where Amazon Rekognition checks for objects or people. This is an optional parameter for label detection stream processors.
describeStreamProcessorResponse_roleArn :: Lens' DescribeStreamProcessorResponse (Maybe Text) Source #
ARN of the IAM role that allows access to the stream processor.
describeStreamProcessorResponse_settings :: Lens' DescribeStreamProcessorResponse (Maybe StreamProcessorSettings) Source #
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.
describeStreamProcessorResponse_status :: Lens' DescribeStreamProcessorResponse (Maybe StreamProcessorStatus) Source #
Current status of the stream processor.
describeStreamProcessorResponse_statusMessage :: Lens' DescribeStreamProcessorResponse (Maybe Text) Source #
Detailed status message about the stream processor.
describeStreamProcessorResponse_streamProcessorArn :: Lens' DescribeStreamProcessorResponse (Maybe Text) Source #
ARN of the stream processor.
describeStreamProcessorResponse_httpStatus :: Lens' DescribeStreamProcessorResponse Int Source #
The response's http status code.