Struct aws_sdk_rekognition::operation::describe_stream_processor::DescribeStreamProcessorOutput

#[non_exhaustive]
pub struct DescribeStreamProcessorOutput {

    pub name: Option<String>,
    pub stream_processor_arn: Option<String>,
    pub status: Option<StreamProcessorStatus>,
    pub status_message: Option<String>,
    pub creation_timestamp: Option<DateTime>,
    pub last_update_timestamp: Option<DateTime>,
    pub input: Option<StreamProcessorInput>,
    pub output: Option<StreamProcessorOutput>,
    pub role_arn: Option<String>,
    pub settings: Option<StreamProcessorSettings>,
    pub notification_channel: Option<StreamProcessorNotificationChannel>,
    pub kms_key_id: Option<String>,
    pub regions_of_interest: Option<Vec<RegionOfInterest>>,
    pub data_sharing_preference: Option<StreamProcessorDataSharingPreference>,
    /* private fields */
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: Option<String>

Name of the stream processor.

stream_processor_arn: Option<String>

ARN of the stream processor.

status: Option<StreamProcessorStatus>

Current status of the stream processor.

status_message: Option<String>

Detailed status message about the stream processor.

creation_timestamp: Option<DateTime>

Date and time the stream processor was created

last_update_timestamp: Option<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.

input: Option<StreamProcessorInput>

Kinesis video stream that provides the source streaming video.

output: Option<StreamProcessorOutput>

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

role_arn: Option<String>

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

settings: Option<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.

notification_channel: Option<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.

kms_key_id: Option<String>

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

regions_of_interest: Option<Vec<RegionOfInterest>>

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

data_sharing_preference: Option<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.

Implementations

impl DescribeStreamProcessorOutput

pub fn name(&self) -> Option<&str>

Name of the stream processor.

pub fn stream_processor_arn(&self) -> Option<&str>

ARN of the stream processor.

pub fn status(&self) -> Option<&StreamProcessorStatus>

Current status of the stream processor.

pub fn status_message(&self) -> Option<&str>

Detailed status message about the stream processor.

pub fn creation_timestamp(&self) -> Option<&DateTime>

Date and time the stream processor was created

pub fn last_update_timestamp(&self) -> Option<&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.

pub fn input(&self) -> Option<&StreamProcessorInput>

Kinesis video stream that provides the source streaming video.

pub fn output(&self) -> Option<&StreamProcessorOutput>

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

pub fn role_arn(&self) -> Option<&str>

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

pub fn settings(&self) -> Option<&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.

pub fn notification_channel( &self ) -> Option<&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.

pub fn kms_key_id(&self) -> Option<&str>

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

pub fn regions_of_interest(&self) -> &[RegionOfInterest]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .regions_of_interest.is_none().

pub fn data_sharing_preference( &self ) -> Option<&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.

impl DescribeStreamProcessorOutput

pub fn builder() -> DescribeStreamProcessorOutputBuilder

Creates a new builder-style object to manufacture DescribeStreamProcessorOutput.

Trait Implementations

impl Clone for DescribeStreamProcessorOutput

fn clone(&self) -> DescribeStreamProcessorOutput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DescribeStreamProcessorOutput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for DescribeStreamProcessorOutput

fn eq(&self, other: &DescribeStreamProcessorOutput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RequestId for DescribeStreamProcessorOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for DescribeStreamProcessorOutput