You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ListChannelMembershipsRequest as input to an Aws::Client method, you can use a vanilla Hash:

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

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#channel_arn ⇒ String

The maximum number of channel memberships that you want returned.

Returns:

  • (String) —

    The maximum number of channel memberships that you want returned.

#max_results ⇒ Integer

The maximum number of channel memberships that you want returned.

Returns:

  • (Integer) —

    The maximum number of channel memberships that you want returned.

#next_token ⇒ String

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

Returns:

  • (String) —

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

#type ⇒ String

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.

Possible values:

  • DEFAULT
  • HIDDEN

Returns:

  • (String) —

    The membership type of a user, DEFAULT or HIDDEN.