Class: Aws::Rekognition::Types::GetLabelDetectionResponse

Inherits:

Struct

• Object
• Struct
• Aws::Rekognition::Types::GetLabelDetectionResponse

Defined in:

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

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #get_request_metadata ⇒ Types::GetLabelDetectionRequestMetadata

  Information about the paramters used when getting a response.

• #job_id ⇒ String

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

• #job_status ⇒ String

  The current status of the label detection job.

• #job_tag ⇒ String

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

• #label_model_version ⇒ String

  Version number of the label detection model that was used to detect labels.

• #labels ⇒ Array<Types::LabelDetection>

  An array of labels detected in the video.

• #next_token ⇒ String

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

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

#get_request_metadata ⇒ Types::GetLabelDetectionRequestMetadata

Information about the paramters used when getting a response. Includes information on aggregation and sorting methods.

Returns:

• (Types::GetLabelDetectionRequestMetadata)

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

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

#job_id ⇒ String

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

Returns:

• (String)

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

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

#job_status ⇒ String

The current status of the label detection job.

Returns:

• (String)

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

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

#job_tag ⇒ String

A job identifier specified in the call to StartLabelDetection 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 3844

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

#label_model_version ⇒ String

Version number of the label detection model that was used to detect labels.

Returns:

• (String)

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

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

#labels ⇒ Array<Types::LabelDetection>

An array of labels detected in the video. Each element contains the detected label and the time, in milliseconds from the start of the video, that the label was detected.

Returns:

• (Array<Types::LabelDetection>)

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

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

#next_token ⇒ String

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

Returns:

• (String)

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

class GetLabelDetectionResponse < Struct.new(
  :job_status,
  :status_message,
  :video_metadata,
  :next_token,
  :labels,
  :label_model_version,
  :job_id,
  :video,
  :job_tag,
  :get_request_metadata)
  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 3844

class GetLabelDetectionResponse < Struct.new(
  :job_status,
  :status_message,
  :video_metadata,
  :next_token,
  :labels,
  :label_model_version,
  :job_id,
  :video,
  :job_tag,
  :get_request_metadata)
  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 3844

class GetLabelDetectionResponse < Struct.new(
  :job_status,
  :status_message,
  :video_metadata,
  :next_token,
  :labels,
  :label_model_version,
  :job_id,
  :video,
  :job_tag,
  :get_request_metadata)
  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 3844

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