Class: Aws::Rekognition::Types::AuditImage

Inherits:

Struct

• Object
• Struct
• Aws::Rekognition::Types::AuditImage

Includes:

Structure

Defined in:

lib/aws-sdk-rekognition/types.rb

Overview

An image that is picked from the Face Liveness video and returned for audit trail purposes, returned as Base64-encoded bytes.

Constant Summary

SENSITIVE =

[:bytes]

Instance Attribute Summary

• #bounding_box ⇒ Types::BoundingBox

  Identifies the bounding box around the label, face, text, object of interest, or personal protective equipment.

• #bytes ⇒ String

  The Base64-encoded bytes representing an image selected from the Face Liveness video and returned for audit purposes.

• #s3_object ⇒ Types::S3Object

  Provides the S3 bucket name and object name.

Instance Attribute Details

#bounding_box ⇒ Types::BoundingBox

Identifies the bounding box around the label, face, text, object of interest, or personal protective equipment. The ‘left` (x-coordinate) and `top` (y-coordinate) are coordinates representing the top and left sides of the bounding box. Note that the upper-left corner of the image is the origin (0,0).

The ‘top` and `left` values returned are ratios of the overall image size. For example, if the input image is 700x200 pixels, and the top-left coordinate of the bounding box is 350x50 pixels, the API returns a `left` value of 0.5 (350/700) and a `top` value of 0.25 (50/200).

The ‘width` and `height` values represent the dimensions of the bounding box as a ratio of the overall image dimension. For example, if the input image is 700x200 pixels, and the bounding box width is 70 pixels, the width returned is 0.1.

<note markdown=“1”> The bounding box coordinates can have negative values. For example, if Amazon Rekognition is able to detect a face that is at the image edge and is only partially visible, the service can return coordinates that are outside the image bounds and, depending on the image edge, you might get negative values or values greater than 1 for the ‘left` or `top` values.

</note>

Returns:

• (Types::BoundingBox)

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

class AuditImage < Struct.new(
  :bytes,
  :s3_object,
  :bounding_box)
  SENSITIVE = [:bytes]
  include Aws::Structure
end

#bytes ⇒ String

The Base64-encoded bytes representing an image selected from the Face Liveness video and returned for audit purposes.

Returns:

• (String)

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

class AuditImage < Struct.new(
  :bytes,
  :s3_object,
  :bounding_box)
  SENSITIVE = [:bytes]
  include Aws::Structure
end

#s3_object ⇒ Types::S3Object

Provides the S3 bucket name and object name.

The region for the S3 bucket containing the S3 object must match the region you use for Amazon Rekognition operations.

For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see How Amazon Rekognition works with IAM in the Amazon Rekognition Developer Guide.

Returns:

• (Types::S3Object)

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

class AuditImage < Struct.new(
  :bytes,
  :s3_object,
  :bounding_box)
  SENSITIVE = [:bytes]
  include Aws::Structure
end