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

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #faces ⇒ Array<Types::FaceDetection>

  An array of faces detected in the video.

• #job_id ⇒ String

  Job identifier for the face detection operation for which you want to obtain results.

• #job_status ⇒ String

  The current status of the face detection job.

• #job_tag ⇒ String

  A job identifier specified in the call to StartFaceDetection and returned in the job completion notification sent to your Amazon Simple Notification Service topic.

• #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 ⇒ Types::Video

  Video file stored in an Amazon S3 bucket.

• #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 3572

class GetFaceDetectionResponse < Struct.new(
  :job_status,
  :status_message,
  :video_metadata,
  :next_token,
  :faces,
  :job_id,
  :video,
  :job_tag)
  SENSITIVE = []
  include Aws::Structure
end

#job_id ⇒ String

Job identifier for the face detection operation for which you want to obtain results. The job identifer is returned by an initial call to StartFaceDetection.

Returns:

• (String)

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

class GetFaceDetectionResponse < Struct.new(
  :job_status,
  :status_message,
  :video_metadata,
  :next_token,
  :faces,
  :job_id,
  :video,
  :job_tag)
  SENSITIVE = []
  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 3572

class GetFaceDetectionResponse < Struct.new(
  :job_status,
  :status_message,
  :video_metadata,
  :next_token,
  :faces,
  :job_id,
  :video,
  :job_tag)
  SENSITIVE = []
  include Aws::Structure
end

#job_tag ⇒ String

A job identifier specified in the call to StartFaceDetection and returned in the job completion notification sent to your Amazon Simple Notification Service topic.

Returns:

• (String)

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

class GetFaceDetectionResponse < Struct.new(
  :job_status,
  :status_message,
  :video_metadata,
  :next_token,
  :faces,
  :job_id,
  :video,
  :job_tag)
  SENSITIVE = []
  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 3572

class GetFaceDetectionResponse < Struct.new(
  :job_status,
  :status_message,
  :video_metadata,
  :next_token,
  :faces,
  :job_id,
  :video,
  :job_tag)
  SENSITIVE = []
  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 3572

class GetFaceDetectionResponse < Struct.new(
  :job_status,
  :status_message,
  :video_metadata,
  :next_token,
  :faces,
  :job_id,
  :video,
  :job_tag)
  SENSITIVE = []
  include Aws::Structure
end

#video ⇒ Types::Video

Video file stored in an Amazon S3 bucket. Amazon Rekognition video start operations such as StartLabelDetection use Video to specify a video for analysis. The supported file formats are .mp4, .mov and .avi.

Returns:

• (Types::Video)

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

class GetFaceDetectionResponse < Struct.new(
  :job_status,
  :status_message,
  :video_metadata,
  :next_token,
  :faces,
  :job_id,
  :video,
  :job_tag)
  SENSITIVE = []
  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 3572

class GetFaceDetectionResponse < Struct.new(
  :job_status,
  :status_message,
  :video_metadata,
  :next_token,
  :faces,
  :job_id,
  :video,
  :job_tag)
  SENSITIVE = []
  include Aws::Structure
end