Class: Aws::IVS::Types::ListChannelsRequest

Inherits:

Struct

• Object
• Struct
• Aws::IVS::Types::ListChannelsRequest

Includes:

Structure

Defined in:

lib/aws-sdk-ivs/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #filter_by_name ⇒ String

  Filters the channel list to match the specified name.

• #filter_by_playback_restriction_policy_arn ⇒ String

  Filters the channel list to match the specified policy.

• #filter_by_recording_configuration_arn ⇒ String

  Filters the channel list to match the specified recording-configuration ARN.

• #max_results ⇒ Integer

  Maximum number of channels to return.

• #next_token ⇒ String

  The first channel to retrieve.

Instance Attribute Details

#filter_by_name ⇒ String

Filters the channel list to match the specified name.

Returns:

• (String)

# File 'lib/aws-sdk-ivs/types.rb', line 1058

class ListChannelsRequest < Struct.new(
  :filter_by_name,
  :filter_by_recording_configuration_arn,
  :filter_by_playback_restriction_policy_arn,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#filter_by_playback_restriction_policy_arn ⇒ String

Filters the channel list to match the specified policy.

Returns:

• (String)

# File 'lib/aws-sdk-ivs/types.rb', line 1058

class ListChannelsRequest < Struct.new(
  :filter_by_name,
  :filter_by_recording_configuration_arn,
  :filter_by_playback_restriction_policy_arn,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#filter_by_recording_configuration_arn ⇒ String

Filters the channel list to match the specified recording-configuration ARN.

Returns:

• (String)

# File 'lib/aws-sdk-ivs/types.rb', line 1058

class ListChannelsRequest < Struct.new(
  :filter_by_name,
  :filter_by_recording_configuration_arn,
  :filter_by_playback_restriction_policy_arn,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

Maximum number of channels to return. Default: 100.

Returns:

• (Integer)

# File 'lib/aws-sdk-ivs/types.rb', line 1058

class ListChannelsRequest < Struct.new(
  :filter_by_name,
  :filter_by_recording_configuration_arn,
  :filter_by_playback_restriction_policy_arn,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-ivs/types.rb', line 1058

class ListChannelsRequest < Struct.new(
  :filter_by_name,
  :filter_by_recording_configuration_arn,
  :filter_by_playback_restriction_policy_arn,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end