Class: Aws::Rekognition::Types::DescribeStreamProcessorResponse

Inherits:

Struct

• Object
• Struct
• Aws::Rekognition::Types::DescribeStreamProcessorResponse

Includes:

Structure

Defined in:

lib/aws-sdk-rekognition/types.rb

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #creation_timestamp ⇒ Time

  Date and time the stream processor was created.

• #data_sharing_preference ⇒ Types::StreamProcessorDataSharingPreference

  Shows whether you are sharing data with Rekognition to improve model performance.

• #input ⇒ Types::StreamProcessorInput

  Kinesis video stream that provides the source streaming video.

• #kms_key_id ⇒ String

  The identifier for your AWS Key Management Service key (AWS KMS key).

• #last_update_timestamp ⇒ Time

  The time, in Unix format, the stream processor was last updated.

• #name ⇒ String

  Name of the stream processor.

• #notification_channel ⇒ Types::StreamProcessorNotificationChannel

  The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the object detection results and completion status of a video analysis operation.

• #output ⇒ Types::StreamProcessorOutput

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

• #regions_of_interest ⇒ Array<Types::RegionOfInterest>

  Specifies locations in the frames where Amazon Rekognition checks for objects or people.

• #role_arn ⇒ String

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

• #settings ⇒ Types::StreamProcessorSettings

  Input parameters used in a streaming video analyzed by a stream processor.

• #status ⇒ String

  Current status of the stream processor.

• #status_message ⇒ String

  Detailed status message about the stream processor.

• #stream_processor_arn ⇒ String

  ARN of the stream processor.

Instance Attribute Details

#creation_timestamp ⇒ Time

Date and time the stream processor was created

Returns:

• (Time)

# File 'lib/aws-sdk-rekognition/types.rb', line 1975

class DescribeStreamProcessorResponse < Struct.new(
  :name,
  :stream_processor_arn,
  :status,
  :status_message,
  :creation_timestamp,
  :last_update_timestamp,
  :input,
  :output,
  :role_arn,
  :settings,
  :notification_channel,
  :kms_key_id,
  :regions_of_interest,
  :data_sharing_preference)
  SENSITIVE = []
  include Aws::Structure
end

#data_sharing_preference ⇒ Types::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.

Returns:

• (Types::StreamProcessorDataSharingPreference)

# File 'lib/aws-sdk-rekognition/types.rb', line 1975

class DescribeStreamProcessorResponse < Struct.new(
  :name,
  :stream_processor_arn,
  :status,
  :status_message,
  :creation_timestamp,
  :last_update_timestamp,
  :input,
  :output,
  :role_arn,
  :settings,
  :notification_channel,
  :kms_key_id,
  :regions_of_interest,
  :data_sharing_preference)
  SENSITIVE = []
  include Aws::Structure
end

#input ⇒ Types::StreamProcessorInput

Kinesis video stream that provides the source streaming video.

Returns:

• (Types::StreamProcessorInput)

# File 'lib/aws-sdk-rekognition/types.rb', line 1975

class DescribeStreamProcessorResponse < Struct.new(
  :name,
  :stream_processor_arn,
  :status,
  :status_message,
  :creation_timestamp,
  :last_update_timestamp,
  :input,
  :output,
  :role_arn,
  :settings,
  :notification_channel,
  :kms_key_id,
  :regions_of_interest,
  :data_sharing_preference)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-rekognition/types.rb', line 1975

class DescribeStreamProcessorResponse < Struct.new(
  :name,
  :stream_processor_arn,
  :status,
  :status_message,
  :creation_timestamp,
  :last_update_timestamp,
  :input,
  :output,
  :role_arn,
  :settings,
  :notification_channel,
  :kms_key_id,
  :regions_of_interest,
  :data_sharing_preference)
  SENSITIVE = []
  include Aws::Structure
end

#last_update_timestamp ⇒ Time

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.

Returns:

• (Time)

# File 'lib/aws-sdk-rekognition/types.rb', line 1975

class DescribeStreamProcessorResponse < Struct.new(
  :name,
  :stream_processor_arn,
  :status,
  :status_message,
  :creation_timestamp,
  :last_update_timestamp,
  :input,
  :output,
  :role_arn,
  :settings,
  :notification_channel,
  :kms_key_id,
  :regions_of_interest,
  :data_sharing_preference)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

Name of the stream processor.

Returns:

• (String)

# File 'lib/aws-sdk-rekognition/types.rb', line 1975

class DescribeStreamProcessorResponse < Struct.new(
  :name,
  :stream_processor_arn,
  :status,
  :status_message,
  :creation_timestamp,
  :last_update_timestamp,
  :input,
  :output,
  :role_arn,
  :settings,
  :notification_channel,
  :kms_key_id,
  :regions_of_interest,
  :data_sharing_preference)
  SENSITIVE = []
  include Aws::Structure
end

#notification_channel ⇒ Types::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.

Returns:

• (Types::StreamProcessorNotificationChannel)

# File 'lib/aws-sdk-rekognition/types.rb', line 1975

class DescribeStreamProcessorResponse < Struct.new(
  :name,
  :stream_processor_arn,
  :status,
  :status_message,
  :creation_timestamp,
  :last_update_timestamp,
  :input,
  :output,
  :role_arn,
  :settings,
  :notification_channel,
  :kms_key_id,
  :regions_of_interest,
  :data_sharing_preference)
  SENSITIVE = []
  include Aws::Structure
end

#output ⇒ Types::StreamProcessorOutput

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

Returns:

• (Types::StreamProcessorOutput)

# File 'lib/aws-sdk-rekognition/types.rb', line 1975

class DescribeStreamProcessorResponse < Struct.new(
  :name,
  :stream_processor_arn,
  :status,
  :status_message,
  :creation_timestamp,
  :last_update_timestamp,
  :input,
  :output,
  :role_arn,
  :settings,
  :notification_channel,
  :kms_key_id,
  :regions_of_interest,
  :data_sharing_preference)
  SENSITIVE = []
  include Aws::Structure
end

#regions_of_interest ⇒ Array<Types::RegionOfInterest>

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

Returns:

• (Array<Types::RegionOfInterest>)

# File 'lib/aws-sdk-rekognition/types.rb', line 1975

class DescribeStreamProcessorResponse < Struct.new(
  :name,
  :stream_processor_arn,
  :status,
  :status_message,
  :creation_timestamp,
  :last_update_timestamp,
  :input,
  :output,
  :role_arn,
  :settings,
  :notification_channel,
  :kms_key_id,
  :regions_of_interest,
  :data_sharing_preference)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-rekognition/types.rb', line 1975

class DescribeStreamProcessorResponse < Struct.new(
  :name,
  :stream_processor_arn,
  :status,
  :status_message,
  :creation_timestamp,
  :last_update_timestamp,
  :input,
  :output,
  :role_arn,
  :settings,
  :notification_channel,
  :kms_key_id,
  :regions_of_interest,
  :data_sharing_preference)
  SENSITIVE = []
  include Aws::Structure
end

#settings ⇒ Types::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.

Returns:

• (Types::StreamProcessorSettings)

# File 'lib/aws-sdk-rekognition/types.rb', line 1975

class DescribeStreamProcessorResponse < Struct.new(
  :name,
  :stream_processor_arn,
  :status,
  :status_message,
  :creation_timestamp,
  :last_update_timestamp,
  :input,
  :output,
  :role_arn,
  :settings,
  :notification_channel,
  :kms_key_id,
  :regions_of_interest,
  :data_sharing_preference)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

Current status of the stream processor.

Returns:

• (String)

# File 'lib/aws-sdk-rekognition/types.rb', line 1975

class DescribeStreamProcessorResponse < Struct.new(
  :name,
  :stream_processor_arn,
  :status,
  :status_message,
  :creation_timestamp,
  :last_update_timestamp,
  :input,
  :output,
  :role_arn,
  :settings,
  :notification_channel,
  :kms_key_id,
  :regions_of_interest,
  :data_sharing_preference)
  SENSITIVE = []
  include Aws::Structure
end

#status_message ⇒ String

Detailed status message about the stream processor.

Returns:

• (String)

# File 'lib/aws-sdk-rekognition/types.rb', line 1975

class DescribeStreamProcessorResponse < Struct.new(
  :name,
  :stream_processor_arn,
  :status,
  :status_message,
  :creation_timestamp,
  :last_update_timestamp,
  :input,
  :output,
  :role_arn,
  :settings,
  :notification_channel,
  :kms_key_id,
  :regions_of_interest,
  :data_sharing_preference)
  SENSITIVE = []
  include Aws::Structure
end

#stream_processor_arn ⇒ String

ARN of the stream processor.

Returns:

• (String)

# File 'lib/aws-sdk-rekognition/types.rb', line 1975

class DescribeStreamProcessorResponse < Struct.new(
  :name,
  :stream_processor_arn,
  :status,
  :status_message,
  :creation_timestamp,
  :last_update_timestamp,
  :input,
  :output,
  :role_arn,
  :settings,
  :notification_channel,
  :kms_key_id,
  :regions_of_interest,
  :data_sharing_preference)
  SENSITIVE = []
  include Aws::Structure
end