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

Class: Aws::KinesisVideo::Types::ListStreamsInput

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

Overview

Note:

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

{
  max_results: 1,
  next_token: "NextToken",
  stream_name_condition: {
    comparison_operator: "BEGINS_WITH", # accepts BEGINS_WITH
    comparison_value: "StreamName",
  },
}

Instance Attribute Summary collapse

Instance Attribute Details

#max_resultsInteger

The maximum number of streams to return in the response. The default is 10,000.

Returns:

  • (Integer)


250
251
252
253
254
255
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/types.rb', line 250

class ListStreamsInput < Struct.new(
  :max_results,
  :next_token,
  :stream_name_condition)
  include Aws::Structure
end

#next_tokenString

If you specify this parameter, when the result of a ListStreams operation is truncated, the call returns the NextToken in the response. To get another batch of streams, provide this token in your next request.

Returns:

  • (String)


250
251
252
253
254
255
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/types.rb', line 250

class ListStreamsInput < Struct.new(
  :max_results,
  :next_token,
  :stream_name_condition)
  include Aws::Structure
end

#stream_name_conditionTypes::StreamNameCondition

Optional: Returns only streams that satisfy a specific condition. Currently, you can specify only the prefix of a stream name as a condition.



250
251
252
253
254
255
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/types.rb', line 250

class ListStreamsInput < Struct.new(
  :max_results,
  :next_token,
  :stream_name_condition)
  include Aws::Structure
end