The Amazon Chime SDK Identity, Media Pipelines, Meetings, and Messaging APIs are now published on the new Amazon Chime SDK API Reference. For more information, see the Amazon Chime SDK API Reference.
ChannelSummary
Summary of the details of a Channel.
Contents
- ChannelArn
-
The ARN of the channel.
Type: String
Length Constraints: Minimum length of 5. Maximum length of 1600.
Pattern:
arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}Required: No
- LastMessageTimestamp
-
The time at which the last message in a channel was sent.
Type: Timestamp
Required: No
- Metadata
-
The metadata of the channel.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern:
.*Required: No
- Mode
-
The mode of the channel.
Type: String
Valid Values:
UNRESTRICTED | RESTRICTEDRequired: No
- Name
-
The name of the channel.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]*Required: No
- Privacy
-
The privacy setting of the channel.
Type: String
Valid Values:
PUBLIC | PRIVATERequired: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
