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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#creation_timestampTime

Date and time the stream processor was created

Returns:

  • (Time)


1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1795

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_preferenceTypes::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.



1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1795

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

#inputTypes::StreamProcessorInput

Kinesis video stream that provides the source streaming video.



1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1795

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_idString

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

Returns:

  • (String)


1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1795

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_timestampTime

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)


1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1795

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

#nameString

Name of the stream processor.

Returns:

  • (String)


1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1795

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_channelTypes::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.



1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1795

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

#outputTypes::StreamProcessorOutput

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



1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1795

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_interestArray<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:



1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1795

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_arnString

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

Returns:

  • (String)


1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1795

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

#settingsTypes::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.



1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1795

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

#statusString

Current status of the stream processor.

Returns:

  • (String)


1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1795

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_messageString

Detailed status message about the stream processor.

Returns:

  • (String)


1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1795

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_arnString

ARN of the stream processor.

Returns:

  • (String)


1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1795

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