Channel

The details of a channel.

ChannelArn

The ARN of a 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

ChannelFlowArn

The ARN of the channel flow.

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

CreatedBy

The AppInstanceUser who created the channel.

Type: Identity object

Required: No

CreatedTimestamp

The time at which the AppInstanceUser created the channel.

Type: Timestamp

Required: No

ElasticChannelConfiguration

The attributes required to configure and create an elastic channel. An elastic channel can support a maximum of 1-million members.

Type: ElasticChannelConfiguration object

Required: No

ExpirationSettings

Settings that control when a channel expires.

Type: ExpirationSettings object

Required: No

LastMessageTimestamp

The time at which a member sent the last message in the channel.

Type: Timestamp

Required: No

LastUpdatedTimestamp

The time at which a channel was last updated.

Type: Timestamp

Required: No

Metadata

The channel's metadata.

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 | RESTRICTED

Required: No

Name

The name of a 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 channel's privacy setting.

Type: String

Valid Values: PUBLIC | PRIVATE

Required: No

Channel

Contents

See Also