Class: Aws::ChimeSDKMessaging::Types::ListChannelsRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-chimesdkmessaging/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[:next_token]

Instance Attribute Summary collapse

Instance Attribute Details

#app_instance_arnString

The ARN of the ‘AppInstance`.

Returns:

  • (String)


2412
2413
2414
2415
2416
2417
2418
2419
2420
# File 'lib/aws-sdk-chimesdkmessaging/types.rb', line 2412

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

#chime_bearerString

The ARN of the ‘AppInstanceUser` or `AppInstanceBot` that makes the API call.

Returns:

  • (String)


2412
2413
2414
2415
2416
2417
2418
2419
2420
# File 'lib/aws-sdk-chimesdkmessaging/types.rb', line 2412

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

#max_resultsInteger

The maximum number of channels that you want to return.

Returns:

  • (Integer)


2412
2413
2414
2415
2416
2417
2418
2419
2420
# File 'lib/aws-sdk-chimesdkmessaging/types.rb', line 2412

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

#next_tokenString

The token passed by previous API calls until all requested channels are returned.

Returns:

  • (String)


2412
2413
2414
2415
2416
2417
2418
2419
2420
# File 'lib/aws-sdk-chimesdkmessaging/types.rb', line 2412

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

#privacyString

The privacy setting. ‘PUBLIC` retrieves all the public channels. `PRIVATE` retrieves private channels. Only an `AppInstanceAdmin` can retrieve private channels.

Returns:

  • (String)


2412
2413
2414
2415
2416
2417
2418
2419
2420
# File 'lib/aws-sdk-chimesdkmessaging/types.rb', line 2412

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