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

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

{
  filter_by_name: "ChannelName",
  filter_by_recording_configuration_arn: "ChannelRecordingConfigurationArn",
  max_results: 1,
  next_token: "PaginationToken",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#filter_by_nameString

Filters the channel list to match the specified name.

Returns:

  • (String)


889
890
891
892
893
894
895
896
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/types.rb', line 889

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

#filter_by_recording_configuration_arnString

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

Returns:

  • (String)


889
890
891
892
893
894
895
896
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/types.rb', line 889

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

#max_resultsInteger

Maximum number of channels to return. Default: 50.

Returns:

  • (Integer)


889
890
891
892
893
894
895
896
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/types.rb', line 889

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

#next_tokenString

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

Returns:

  • (String)


889
890
891
892
893
894
895
896
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/types.rb', line 889

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