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

Class: Aws::Rekognition::Types::StartFaceSearchRequest

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 StartFaceSearchRequest data as a hash:

{
  video: { # required
    s3_object: {
      bucket: "S3Bucket",
      name: "S3ObjectName",
      version: "S3ObjectVersion",
    },
  },
  client_request_token: "ClientRequestToken",
  face_match_threshold: 1.0,
  collection_id: "CollectionId", # required
  notification_channel: {
    sns_topic_arn: "SNSTopicArn", # required
    role_arn: "RoleArn", # required
  },
  job_tag: "JobTag",
}

Instance Attribute Summary collapse

Instance Attribute Details

#client_request_tokenString

Idempotent token used to identify the start request. If you use the same token with multiple StartFaceSearch requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once.

Returns:

  • (String)


2762
2763
2764
2765
2766
2767
2768
2769
2770
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 2762

class StartFaceSearchRequest < Struct.new(
  :video,
  :client_request_token,
  :face_match_threshold,
  :collection_id,
  :notification_channel,
  :job_tag)
  include Aws::Structure
end

#collection_idString

ID of the collection that contains the faces you want to search for.

Returns:

  • (String)


2762
2763
2764
2765
2766
2767
2768
2769
2770
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 2762

class StartFaceSearchRequest < Struct.new(
  :video,
  :client_request_token,
  :face_match_threshold,
  :collection_id,
  :notification_channel,
  :job_tag)
  include Aws::Structure
end

#face_match_thresholdFloat

The minimum confidence in the person match to return. For example, don't return any matches where confidence in matches is less than 70%.

Returns:

  • (Float)


2762
2763
2764
2765
2766
2767
2768
2769
2770
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 2762

class StartFaceSearchRequest < Struct.new(
  :video,
  :client_request_token,
  :face_match_threshold,
  :collection_id,
  :notification_channel,
  :job_tag)
  include Aws::Structure
end

#job_tagString

Unique identifier you specify to identify the job in the completion status published to the Amazon Simple Notification Service topic.

Returns:

  • (String)


2762
2763
2764
2765
2766
2767
2768
2769
2770
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 2762

class StartFaceSearchRequest < Struct.new(
  :video,
  :client_request_token,
  :face_match_threshold,
  :collection_id,
  :notification_channel,
  :job_tag)
  include Aws::Structure
end

#notification_channelTypes::NotificationChannel

The ARN of the Amazon SNS topic to which you want Rekognition Video to publish the completion status of the search.



2762
2763
2764
2765
2766
2767
2768
2769
2770
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 2762

class StartFaceSearchRequest < Struct.new(
  :video,
  :client_request_token,
  :face_match_threshold,
  :collection_id,
  :notification_channel,
  :job_tag)
  include Aws::Structure
end

#videoTypes::Video

The video you want to search. The video must be stored in an Amazon S3 bucket.

Returns:



2762
2763
2764
2765
2766
2767
2768
2769
2770
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 2762

class StartFaceSearchRequest < Struct.new(
  :video,
  :client_request_token,
  :face_match_threshold,
  :collection_id,
  :notification_channel,
  :job_tag)
  include Aws::Structure
end