Class: Aws::IVS::Types::ListStreamsRequest

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

Overview

Note:

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

{
  filter_by: {
    health: "HEALTHY", # accepts HEALTHY, STARVING, UNKNOWN
  },
  max_results: 1,
  next_token: "PaginationToken",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#filter_byTypes::StreamFilters

Filters the stream list to match the specified criterion.



1181
1182
1183
1184
1185
1186
1187
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/types.rb', line 1181

class ListStreamsRequest < Struct.new(
  :filter_by,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

Maximum number of streams to return. Default: 100.

Returns:

  • (Integer)


1181
1182
1183
1184
1185
1186
1187
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/types.rb', line 1181

class ListStreamsRequest < Struct.new(
  :filter_by,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

The first stream to retrieve. This is used for pagination; see the nextToken response field.

Returns:

  • (String)


1181
1182
1183
1184
1185
1186
1187
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/types.rb', line 1181

class ListStreamsRequest < Struct.new(
  :filter_by,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end