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

Class: Aws::Rekognition::Types::GetFaceDetectionResponse

Inherits:

Struct

• Object
• Struct
• Aws::Rekognition::Types::GetFaceDetectionResponse

Defined in:

gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb

Instance Attribute Summary

• #faces ⇒ Array<Types::FaceDetection>

  An array of faces detected in the video.

• #job_status ⇒ String

  The current status of the face detection job.

• #next_token ⇒ String

  If the response is truncated, Amazon Rekognition returns this token that you can use in the subsequent request to retrieve the next set of faces.

• #status_message ⇒ String

  If the job fails, StatusMessage provides a descriptive error message.

• #video_metadata ⇒ Types::VideoMetadata

  Information about a video that Amazon Rekognition Video analyzed.

Instance Attribute Details

#faces ⇒ Array<Types::FaceDetection>

An array of faces detected in the video. Each element contains a detected face's details and the time, in milliseconds from the start of the video, the face was detected.

Returns:

• (Array<Types::FaceDetection>)

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

class GetFaceDetectionResponse < Struct.new(
  :job_status,
  :status_message,
  :video_metadata,
  :next_token,
  :faces)
  include Aws::Structure
end

#job_status ⇒ String

The current status of the face detection job.

Returns:

• (String)

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

class GetFaceDetectionResponse < Struct.new(
  :job_status,
  :status_message,
  :video_metadata,
  :next_token,
  :faces)
  include Aws::Structure
end

#next_token ⇒ String

If the response is truncated, Amazon Rekognition returns this token that you can use in the subsequent request to retrieve the next set of faces.

Returns:

• (String)

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

class GetFaceDetectionResponse < Struct.new(
  :job_status,
  :status_message,
  :video_metadata,
  :next_token,
  :faces)
  include Aws::Structure
end

#status_message ⇒ String

If the job fails, StatusMessage provides a descriptive error message.

Returns:

• (String)

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

class GetFaceDetectionResponse < Struct.new(
  :job_status,
  :status_message,
  :video_metadata,
  :next_token,
  :faces)
  include Aws::Structure
end

#video_metadata ⇒ Types::VideoMetadata

Information about a video that Amazon Rekognition Video analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition video operation.

Returns:

• (Types::VideoMetadata)

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

class GetFaceDetectionResponse < Struct.new(
  :job_status,
  :status_message,
  :video_metadata,
  :next_token,
  :faces)
  include Aws::Structure
end