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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#facesArray<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:



3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 3547

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

#job_idString

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)


3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 3547

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

#job_statusString

The current status of the face detection job.

Returns:

  • (String)


3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 3547

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

#job_tagString

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)


3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 3547

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

#next_tokenString

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)


3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 3547

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

#status_messageString

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

Returns:

  • (String)


3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 3547

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

#videoTypes::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:



3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 3547

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

#video_metadataTypes::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.



3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 3547

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