AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Container for the parameters to the ListChannels operation. Lists all Channels created under a single Chime App as a paginated list. You can specify filters to narrow results.
Functionality & restrictions
Use privacy = PUBLIC
to retrieve all public channels in the account.
Only an AppInstanceAdmin
can set privacy = PRIVATE
to list the private
channels in an account.
The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the user that makes the API call as the value in the header.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListChannels, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Namespace: Amazon.Chime.Model
Assembly: AWSSDK.Chime.dll
Version: 3.x.y.z
public class ListChannelsRequest : AmazonChimeRequest IAmazonWebServiceRequest
The ListChannelsRequest type exposes the following members
Name | Description | |
---|---|---|
ListChannelsRequest() |
Name | Type | Description | |
---|---|---|---|
AppInstanceArn | System.String |
Gets and sets the property AppInstanceArn.
The ARN of the |
|
ChimeBearer | System.String |
Gets and sets the property ChimeBearer.
The |
|
MaxResults | System.Int32 |
Gets and sets the property MaxResults. The maximum number of channels that you want to return. |
|
NextToken | System.String |
Gets and sets the property NextToken. The token passed by previous API calls until all requested channels are returned. |
|
Privacy | Amazon.Chime.ChannelPrivacy |
Gets and sets the property Privacy.
The privacy setting. |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5