Class: Aws::ChimeSDKMessaging::Types::ListChannelBansRequest

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

Overview

Constant Summary collapse

SENSITIVE =
[:next_token]

Instance Attribute Summary collapse

Instance Attribute Details

#channel_arnString

The ARN of the channel.

Returns:

  • (String)


1973
1974
1975
1976
1977
1978
1979
1980
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/types.rb', line 1973

class ListChannelBansRequest < Struct.new(
  :channel_arn,
  :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)


1973
1974
1975
1976
1977
1978
1979
1980
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/types.rb', line 1973

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

#max_resultsInteger

The maximum number of bans that you want returned.

Returns:

  • (Integer)


1973
1974
1975
1976
1977
1978
1979
1980
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/types.rb', line 1973

class ListChannelBansRequest < Struct.new(
  :channel_arn,
  :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 bans are returned.

Returns:

  • (String)


1973
1974
1975
1976
1977
1978
1979
1980
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/types.rb', line 1973

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