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

Inherits:

Struct

Object
Struct
Aws::Rekognition::Types::DetectFacesRequest

show all

Defined in:: gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#attributes ⇒ Array<String>
An array of facial attributes you want to be returned.
#image ⇒ Types::Image
The input image as base64-encoded bytes or an S3 object.

Instance Attribute Details

#attributes ⇒ `Array<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 takes 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>)

# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1698

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

#image ⇒ `Types::Image`

The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.

If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.