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

Class: Aws::KinesisVideoArchivedMedia::Types::ListFragmentsInput

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

Overview

Note:

When making an API call, you may pass ListFragmentsInput data as a hash:

{
  stream_name: "StreamName", # required
  max_results: 1,
  next_token: "String",
  fragment_selector: {
    fragment_selector_type: "PRODUCER_TIMESTAMP", # required, accepts PRODUCER_TIMESTAMP, SERVER_TIMESTAMP
    timestamp_range: { # required
      start_timestamp: Time.now, # required
      end_timestamp: Time.now, # required
    },
  },
}

Instance Attribute Summary collapse

Instance Attribute Details

#fragment_selectorTypes::FragmentSelector

Describes the time stamp range and time stamp origin for the range of fragments to return.



182
183
184
185
186
187
188
# File 'gems/aws-sdk-kinesisvideoarchivedmedia/lib/aws-sdk-kinesisvideoarchivedmedia/types.rb', line 182

class ListFragmentsInput < Struct.new(
  :stream_name,
  :max_results,
  :next_token,
  :fragment_selector)
  include Aws::Structure
end

#max_resultsInteger

The total number of fragments to return. If the total number of fragments available is more than the value specified in max-results, then a ListFragmentsOutput$NextToken is provided in the output that you can use to resume pagination.

Returns:

  • (Integer)


182
183
184
185
186
187
188
# File 'gems/aws-sdk-kinesisvideoarchivedmedia/lib/aws-sdk-kinesisvideoarchivedmedia/types.rb', line 182

class ListFragmentsInput < Struct.new(
  :stream_name,
  :max_results,
  :next_token,
  :fragment_selector)
  include Aws::Structure
end

#next_tokenString

A token to specify where to start paginating. This is the ListFragmentsOutput$NextToken from a previously truncated response.

Returns:

  • (String)


182
183
184
185
186
187
188
# File 'gems/aws-sdk-kinesisvideoarchivedmedia/lib/aws-sdk-kinesisvideoarchivedmedia/types.rb', line 182

class ListFragmentsInput < Struct.new(
  :stream_name,
  :max_results,
  :next_token,
  :fragment_selector)
  include Aws::Structure
end

#stream_nameString

The name of the stream from which to retrieve a fragment list.

Returns:

  • (String)


182
183
184
185
186
187
188
# File 'gems/aws-sdk-kinesisvideoarchivedmedia/lib/aws-sdk-kinesisvideoarchivedmedia/types.rb', line 182

class ListFragmentsInput < Struct.new(
  :stream_name,
  :max_results,
  :next_token,
  :fragment_selector)
  include Aws::Structure
end