@aws-sdk/client-chime-sdk-messaging

ListChannelsCommandInput Interface

The input for ListChannelsCommand.

Members

Name
Type
Details
AppInstanceArn Requiredstring | undefined

The ARN of the AppInstance.

ChimeBearer Requiredstring | undefined

The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

MaxResults number | undefined

The maximum number of channels that you want to return.

NextToken string | undefined

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

Privacy ChannelPrivacy | undefined

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

Full Signature

export interface ListChannelsCommandInput extends ListChannelsRequest