Class: Aws::Chime::Types::ListChannelMembershipsRequest

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

Overview

Note:

When making an API call, you may pass ListChannelMembershipsRequest data as a hash:

{
  channel_arn: "ChimeArn", # required
  type: "DEFAULT", # accepts DEFAULT, HIDDEN
  max_results: 1,
  next_token: "NextToken",
  chime_bearer: "ChimeArn",
}

Constant Summary collapse

SENSITIVE =
[:next_token]

Instance Attribute Summary collapse

Instance Attribute Details

#channel_arnString

The maximum number of channel memberships that you want returned.

Returns:

  • (String)


6280
6281
6282
6283
6284
6285
6286
6287
6288
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 6280

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

#chime_bearerString

The AppInstanceUserArn of the user that makes the API call.

Returns:

  • (String)


6280
6281
6282
6283
6284
6285
6286
6287
6288
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 6280

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

#max_resultsInteger

The maximum number of channel memberships that you want returned.

Returns:

  • (Integer)


6280
6281
6282
6283
6284
6285
6286
6287
6288
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 6280

class ListChannelMembershipsRequest < Struct.new(
  :channel_arn,
  :type,
  :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 channel memberships are returned.

Returns:

  • (String)


6280
6281
6282
6283
6284
6285
6286
6287
6288
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 6280

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

#typeString

The membership type of a user, DEFAULT or HIDDEN. Default members are always returned as part of ListChannelMemberships. Hidden members are only returned if the type filter in ListChannelMemberships equals HIDDEN. Otherwise hidden members are not returned.

Returns:

  • (String)


6280
6281
6282
6283
6284
6285
6286
6287
6288
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 6280

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