Skip to content

DescribeStreamProcessorResponse

Source code in docs_src/capo_rekognition/types/describe_stream_processor_response.py
class DescribeStreamProcessorResponse(TypedDict, closed=True):
    name: NotRequired[
        "capo_rekognition.types.stream_processor_name.StreamProcessorName"
    ]
    """<p>Name of the stream processor. </p>"""
    stream_processor_arn: NotRequired[
        "capo_rekognition.types.stream_processor_arn.StreamProcessorArn"
    ]
    """<p>ARN of the stream processor.</p>"""
    status: NotRequired[
        "capo_rekognition.types.stream_processor_status.StreamProcessorStatus"
    ]
    """<p>Current status of the stream processor.</p>"""
    status_message: NotRequired["capo_rekognition.types.string.String"]
    """<p>Detailed status message about the stream processor.</p>"""
    creation_timestamp: NotRequired["capo_rekognition.types.date_time.DateTime"]
    """<p>Date and time the stream processor was created</p>"""
    last_update_timestamp: NotRequired["capo_rekognition.types.date_time.DateTime"]
    """<p>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.</p>"""
    input: NotRequired[
        "capo_rekognition.types.stream_processor_input.StreamProcessorInput"
    ]
    """<p>Kinesis video stream that provides the source streaming video.</p>"""
    output: NotRequired[
        "capo_rekognition.types.stream_processor_output.StreamProcessorOutput"
    ]
    """<p>Kinesis data stream to which Amazon Rekognition Video puts the analysis results.</p>"""
    role_arn: NotRequired["capo_rekognition.types.role_arn.RoleArn"]
    """<p>ARN of the IAM role that allows access to the stream processor.</p>"""
    settings: NotRequired[
        "capo_rekognition.types.stream_processor_settings.StreamProcessorSettings"
    ]
    """<p>Input parameters used in a streaming video analyzed by a stream processor. You can use <code>FaceSearch</code> to recognize faces in a streaming video, or you can use <code>ConnectedHome</code> to detect labels.</p>"""
    notification_channel: NotRequired[
        "capo_rekognition.types.stream_processor_notification_channel.StreamProcessorNotificationChannel"
    ]
    kms_key_id: NotRequired["capo_rekognition.types.kms_key_id.KmsKeyId"]
    """<p> The identifier for your AWS Key Management Service key (AWS KMS key). This is an optional parameter for label detection stream processors. </p>"""
    regions_of_interest: NotRequired[
        "capo_rekognition.types.regions_of_interest.RegionsOfInterest"
    ]
    """<p> Specifies locations in the frames where Amazon Rekognition checks for objects or people. This is an optional parameter for label detection stream processors. </p>"""
    data_sharing_preference: NotRequired[
        "capo_rekognition.types.stream_processor_data_sharing_preference.StreamProcessorDataSharingPreference"
    ]
    """<p> 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. </p>"""

creation_timestamp instance-attribute

creation_timestamp: NotRequired[DateTime]

Date and time the stream processor was created

data_sharing_preference instance-attribute

data_sharing_preference: NotRequired[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.

input instance-attribute

input: NotRequired[StreamProcessorInput]

Kinesis video stream that provides the source streaming video.

kms_key_id instance-attribute

kms_key_id: NotRequired[KmsKeyId]

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

last_update_timestamp instance-attribute

last_update_timestamp: NotRequired[DateTime]

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 instance-attribute

name: NotRequired[StreamProcessorName]

Name of the stream processor.

notification_channel instance-attribute

notification_channel: NotRequired[StreamProcessorNotificationChannel]

output instance-attribute

output: NotRequired[StreamProcessorOutput]

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

regions_of_interest instance-attribute

regions_of_interest: NotRequired[RegionsOfInterest]

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

role_arn instance-attribute

role_arn: NotRequired[RoleArn]

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

settings instance-attribute

settings: NotRequired[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.

status instance-attribute

status: NotRequired[StreamProcessorStatus]

Current status of the stream processor.

status_message instance-attribute

status_message: NotRequired[String]

Detailed status message about the stream processor.

stream_processor_arn instance-attribute

stream_processor_arn: NotRequired[StreamProcessorArn]

ARN of the stream processor.