Class: Aws::KinesisVideo::Types::ListSignalingChannelsInput

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 ListSignalingChannelsInput data as a hash:

{
  max_results: 1,
  next_token: "NextToken",
  channel_name_condition: {
    comparison_operator: "BEGINS_WITH", # accepts BEGINS_WITH
    comparison_value: "ChannelName",
  },
}

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#channel_name_condition ⇒ Types::ChannelNameCondition

Optional: Returns only the channels that satisfy a specific condition.

Returns:



629
630
631
632
633
634
635
 
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/types.rb', line 629

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

#max_results ⇒ Integer

The maximum number of channels to return in the response. The default is 500.

Returns:

  • (Integer) 


629
630
631
632
633
634
635
 
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/types.rb', line 629

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

#next_token ⇒ String

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

Returns:

  • (String) 


629
630
631
632
633
634
635
 
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/types.rb', line 629

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