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

Class: Aws::Rekognition::Types::DetectFacesRequest

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

{
  image: { # required
    bytes: "data",
    s3_object: {
      bucket: "S3Bucket",
      name: "S3ObjectName",
      version: "S3ObjectVersion",
    },
  },
  attributes: ["DEFAULT"], # accepts DEFAULT, ALL
}

Instance Attribute Summary collapse

Instance Attribute Details

#attributesArray<String>

An array of facial attributes 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>)


435
436
437
438
439
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 435

class DetectFacesRequest < Struct.new(
  :image,
  :attributes)
  include Aws::Structure
end

#imageTypes::Image

The image in which you want to detect faces. You can specify a blob or an S3 object.

Returns:



435
436
437
438
439
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 435

class DetectFacesRequest < Struct.new(
  :image,
  :attributes)
  include Aws::Structure
end