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

Class: Aws::Chime::Types::ListChannelsRequest

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

Overview

Note:

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

{
  app_instance_arn: "ChimeArn", # required
  privacy: "PUBLIC", # accepts PUBLIC, PRIVATE
  max_results: 1,
  next_token: "NextToken",
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#app_instance_arn ⇒ String

The ARN of the app instance.

Returns:

  • (String) —

    The ARN of the app instance.

#max_results ⇒ Integer

The maximum number of channels that you want to return.

Returns:

  • (Integer) —

    The maximum number of channels that you want to return.

#next_token ⇒ String

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

Returns:

  • (String) —

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

#privacy ⇒ String

The privacy setting. PUBLIC retrieves all the public channels. PRIVATE retrieves private channels. Only an app instance administrator can retrieve private channels.

Possible values:

  • PUBLIC
  • PRIVATE

Returns:

  • (String) —

    The privacy setting.