Class: Aws::Rekognition::Types::CreateStreamProcessorRequest

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

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



1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
 
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1208

class CreateStreamProcessorRequest < Struct.new(
  :input,
  :output,
  :name,
  :settings,
  :role_arn,
  :tags,
  :notification_channel,
  :kms_key_id,
  :regions_of_interest,
  :data_sharing_preference)
  SENSITIVE = []
  include Aws::Structure
end

#input ⇒ Types::StreamProcessorInput

Kinesis video stream stream that provides the source streaming video. If you are using the AWS CLI, the parameter name is StreamProcessorInput. This is required for both face search and label detection stream processors.

Returns:



1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
 
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1208

class CreateStreamProcessorRequest < Struct.new(
  :input,
  :output,
  :name,
  :settings,
  :role_arn,
  :tags,
  :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 and should not be used to create a face search stream processor. You can supply the Amazon Resource Name (ARN) of your KMS key, the ID of your KMS key, an alias for your KMS key, or an alias ARN. The key is used to encrypt results and data published to your Amazon S3 bucket, which includes image frames and hero images. Your source images are unaffected.

Returns:

  • (String) 


1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
 
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1208

class CreateStreamProcessorRequest < Struct.new(
  :input,
  :output,
  :name,
  :settings,
  :role_arn,
  :tags,
  :notification_channel,
  :kms_key_id,
  :regions_of_interest,
  :data_sharing_preference)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

An identifier you assign to the stream processor. You can use Name to manage the stream processor. For example, you can get the current status of the stream processor by calling DescribeStreamProcessor. Name is idempotent. This is required for both face search and label detection stream processors.

Returns:

  • (String) 


1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
 
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1208

class CreateStreamProcessorRequest < Struct.new(
  :input,
  :output,
  :name,
  :settings,
  :role_arn,
  :tags,
  :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:



1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
 
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1208

class CreateStreamProcessorRequest < Struct.new(
  :input,
  :output,
  :name,
  :settings,
  :role_arn,
  :tags,
  :notification_channel,
  :kms_key_id,
  :regions_of_interest,
  :data_sharing_preference)
  SENSITIVE = []
  include Aws::Structure
end

#output ⇒ Types::StreamProcessorOutput

Kinesis data stream stream or Amazon S3 bucket location to which Amazon Rekognition Video puts the analysis results. If you are using the AWS CLI, the parameter name is StreamProcessorOutput. This must be a S3Destination of an Amazon S3 bucket that you own for a label detection stream processor or a Kinesis data stream ARN for a face search stream processor.

Returns:



1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
 
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1208

class CreateStreamProcessorRequest < Struct.new(
  :input,
  :output,
  :name,
  :settings,
  :role_arn,
  :tags,
  :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. You can specify up to 10 regions of interest, and each region has either a polygon or a bounding box. This is an optional parameter for label detection stream processors and should not be used to create a face search stream processor.

Returns:



1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
 
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1208

class CreateStreamProcessorRequest < Struct.new(
  :input,
  :output,
  :name,
  :settings,
  :role_arn,
  :tags,
  :notification_channel,
  :kms_key_id,
  :regions_of_interest,
  :data_sharing_preference)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

The Amazon Resource Number (ARN) of the IAM role that allows access to the stream processor. The IAM role provides Rekognition read permissions for a Kinesis stream. It also provides write permissions to an Amazon S3 bucket and Amazon Simple Notification Service topic for a label detection stream processor. This is required for both face search and label detection stream processors.

Returns:

  • (String) 


1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
 
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1208

class CreateStreamProcessorRequest < Struct.new(
  :input,
  :output,
  :name,
  :settings,
  :role_arn,
  :tags,
  :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:



1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
 
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1208

class CreateStreamProcessorRequest < Struct.new(
  :input,
  :output,
  :name,
  :settings,
  :role_arn,
  :tags,
  :notification_channel,
  :kms_key_id,
  :regions_of_interest,
  :data_sharing_preference)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

A set of tags (key-value pairs) that you want to attach to the stream processor.

Returns:

  • (Hash<String,String>) 


1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
 
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1208

class CreateStreamProcessorRequest < Struct.new(
  :input,
  :output,
  :name,
  :settings,
  :role_arn,
  :tags,
  :notification_channel,
  :kms_key_id,
  :regions_of_interest,
  :data_sharing_preference)
  SENSITIVE = []
  include Aws::Structure
end