Class: Aws::Rekognition::Types::IndexFacesRequest

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

Overview

Note:

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

{
  collection_id: "CollectionId", # required
  image: { # required
    bytes: "data",
    s3_object: {
      bucket: "S3Bucket",
      name: "S3ObjectName",
      version: "S3ObjectVersion",
    },
  },
  external_image_id: "ExternalImageId",
  detection_attributes: ["DEFAULT"], # accepts DEFAULT, ALL
}

Instance Attribute Summary collapse

Instance Attribute Details

#collection_id ⇒ String

The ID of an existing collection to which you want to add the faces that are detected in the input images.

Returns:

  • (String) 


963
964
965
966
967
968
969
 
# File 'lib/aws-sdk-rekognition/types.rb', line 963

class IndexFacesRequest < Struct.new(
  :collection_id,
  :image,
  :external_image_id,
  :detection_attributes)
  include Aws::Structure
end

#detection_attributes ⇒ Array<String>

An array of facial attributes that you want to be returned. This can be the default list of attributes or all attributes. If you don’t specify a value for ‘Attributes` or if you specify `[“DEFAULT”]`, the API returns the following subset of facial attributes: `BoundingBox`, `Confidence`, `Pose`, `Quality` and `Landmarks`. If you provide `[“ALL”]`, all facial attributes are returned but the operation will take longer to complete.

If you provide both, ‘[“ALL”, “DEFAULT”]`, the service uses a logical AND operator to determine which attributes to return (in this case, all attributes).

Returns:

  • (Array<String>) 


963
964
965
966
967
968
969
 
# File 'lib/aws-sdk-rekognition/types.rb', line 963

class IndexFacesRequest < Struct.new(
  :collection_id,
  :image,
  :external_image_id,
  :detection_attributes)
  include Aws::Structure
end

#external_image_id ⇒ String

ID you want to assign to all the faces detected in the image.

Returns:

  • (String) 


963
964
965
966
967
968
969
 
# File 'lib/aws-sdk-rekognition/types.rb', line 963

class IndexFacesRequest < Struct.new(
  :collection_id,
  :image,
  :external_image_id,
  :detection_attributes)
  include Aws::Structure
end

#image ⇒ Types::Image

The input image as bytes or an S3 object.

Returns:



963
964
965
966
967
968
969
 
# File 'lib/aws-sdk-rekognition/types.rb', line 963

class IndexFacesRequest < Struct.new(
  :collection_id,
  :image,
  :external_image_id,
  :detection_attributes)
  include Aws::Structure
end