You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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

Overview

Note:

When making an API call, you may pass CreateStreamProcessorRequest data as a hash:

{
  input: { # required
    kinesis_video_stream: {
      arn: "KinesisVideoArn",
    },
  },
  output: { # required
    kinesis_data_stream: {
      arn: "KinesisDataArn",
    },
  },
  name: "StreamProcessorName", # required
  settings: { # required
    face_search: {
      collection_id: "CollectionId",
      face_match_threshold: 1.0,
    },
  },
  role_arn: "RoleArn", # required
}

Instance Attribute Summary collapse

Instance Attribute Details

#inputTypes::StreamProcessorInput

Kinesis video stream stream that provides the source streaming video. If you are using the AWS CLI, the parameter name is StreamProcessorInput.



480
481
482
483
484
485
486
487
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 480

class CreateStreamProcessorRequest < Struct.new(
  :input,
  :output,
  :name,
  :settings,
  :role_arn)
  include Aws::Structure
end

#nameString

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 . Name is idempotent.

Returns:

  • (String)


480
481
482
483
484
485
486
487
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 480

class CreateStreamProcessorRequest < Struct.new(
  :input,
  :output,
  :name,
  :settings,
  :role_arn)
  include Aws::Structure
end

#outputTypes::StreamProcessorOutput

Kinesis data stream stream to which Amazon Rekognition Video puts the analysis results. If you are using the AWS CLI, the parameter name is StreamProcessorOutput.



480
481
482
483
484
485
486
487
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 480

class CreateStreamProcessorRequest < Struct.new(
  :input,
  :output,
  :name,
  :settings,
  :role_arn)
  include Aws::Structure
end

#role_arnString

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

Returns:

  • (String)


480
481
482
483
484
485
486
487
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 480

class CreateStreamProcessorRequest < Struct.new(
  :input,
  :output,
  :name,
  :settings,
  :role_arn)
  include Aws::Structure
end

#settingsTypes::StreamProcessorSettings

Face recognition input parameters to be used by the stream processor. Includes the collection to use for face recognition and the face attributes to detect.



480
481
482
483
484
485
486
487
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 480

class CreateStreamProcessorRequest < Struct.new(
  :input,
  :output,
  :name,
  :settings,
  :role_arn)
  include Aws::Structure
end