Class: Aws::Rekognition::Types::GetSegmentDetectionResponse

Inherits:

Struct

• Object
• Struct
• Aws::Rekognition::Types::GetSegmentDetectionResponse

Includes:

Structure

Defined in:

lib/aws-sdk-rekognition/types.rb

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #audio_metadata ⇒ Array<Types::AudioMetadata>

  An array of objects.

• #job_id ⇒ String

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

• #job_status ⇒ String

  Current status of the segment detection job.

• #job_tag ⇒ String

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

• #next_token ⇒ String

  If the previous response was incomplete (because there are more labels to retrieve), Amazon Rekognition Video returns a pagination token in the response.

• #segments ⇒ Array<Types::SegmentDetection>

  An array of segments detected in a video.

• #selected_segment_types ⇒ Array<Types::SegmentTypeInfo>

  An array containing the segment types requested in the call to ‘StartSegmentDetection`.

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

  Currently, Amazon Rekognition Video returns a single object in the ‘VideoMetadata` array.

Instance Attribute Details

#audio_metadata ⇒ Array<Types::AudioMetadata>

An array of objects. There can be multiple audio streams. Each ‘AudioMetadata` object contains metadata for a single audio stream. Audio information in an `AudioMetadata` objects includes the audio codec, the number of audio channels, the duration of the audio stream, and the sample rate. Audio metadata is returned in each page of information returned by `GetSegmentDetection`.

Returns:

• (Array<Types::AudioMetadata>)

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

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

#job_id ⇒ String

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

Returns:

• (String)

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

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

#job_status ⇒ String

Current status of the segment detection job.

Returns:

• (String)

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

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

#job_tag ⇒ String

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

Returns:

• (String)

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

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

#next_token ⇒ String

If the previous response was incomplete (because there are more labels to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of text.

Returns:

• (String)

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

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

#segments ⇒ Array<Types::SegmentDetection>

An array of segments detected in a video. The array is sorted by the segment types (TECHNICAL_CUE or SHOT) specified in the ‘SegmentTypes` input parameter of `StartSegmentDetection`. Within each segment type the array is sorted by timestamp values.

Returns:

• (Array<Types::SegmentDetection>)

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

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

#selected_segment_types ⇒ Array<Types::SegmentTypeInfo>

An array containing the segment types requested in the call to ‘StartSegmentDetection`.

Returns:

• (Array<Types::SegmentTypeInfo>)

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

class GetSegmentDetectionResponse < Struct.new(
  :job_status,
  :status_message,
  :video_metadata,
  :audio_metadata,
  :next_token,
  :segments,
  :selected_segment_types,
  :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 'lib/aws-sdk-rekognition/types.rb', line 4187

class GetSegmentDetectionResponse < Struct.new(
  :job_status,
  :status_message,
  :video_metadata,
  :audio_metadata,
  :next_token,
  :segments,
  :selected_segment_types,
  :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 'lib/aws-sdk-rekognition/types.rb', line 4187

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

#video_metadata ⇒ Array<Types::VideoMetadata>

Currently, Amazon Rekognition Video returns a single object in the ‘VideoMetadata` array. The object contains information about the video stream in the input file that Amazon Rekognition Video chose to analyze. The `VideoMetadata` object includes the video codec, video format and other information. Video metadata is returned in each page of information returned by `GetSegmentDetection`.

Returns:

• (Array<Types::VideoMetadata>)

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

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