Documentation ¶
Index ¶
- type AppInstanceUserMembershipSummary
- type BadRequestException
- type BatchChannelMemberships
- type BatchCreateChannelMembershipError
- type Channel
- type ChannelBan
- type ChannelBanSummary
- type ChannelMembership
- type ChannelMembershipForAppInstanceUserSummary
- type ChannelMembershipSummary
- type ChannelMembershipType
- type ChannelMessage
- type ChannelMessagePersistenceType
- type ChannelMessageSummary
- type ChannelMessageType
- type ChannelMode
- type ChannelModeratedByAppInstanceUserSummary
- type ChannelModerator
- type ChannelModeratorSummary
- type ChannelPrivacy
- type ChannelSummary
- type ConflictException
- type ErrorCode
- type ForbiddenException
- type Identity
- type MessagingSessionEndpoint
- type NotFoundException
- type ResourceLimitExceededException
- type ServiceFailureException
- type ServiceUnavailableException
- type SortOrder
- type Tag
- type ThrottledClientException
- type UnauthorizedClientException
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AppInstanceUserMembershipSummary ¶
type AppInstanceUserMembershipSummary struct { // The time at which a message was last read. ReadMarkerTimestamp *time.Time // The type of ChannelMembership. Type ChannelMembershipType // contains filtered or unexported fields }
Summary of the membership details of an AppInstanceUser.
type BadRequestException ¶
type BadRequestException struct { Message *string Code ErrorCode // contains filtered or unexported fields }
The input parameters don't match the service's restrictions.
func (*BadRequestException) Error ¶
func (e *BadRequestException) Error() string
func (*BadRequestException) ErrorCode ¶
func (e *BadRequestException) ErrorCode() string
func (*BadRequestException) ErrorFault ¶
func (e *BadRequestException) ErrorFault() smithy.ErrorFault
func (*BadRequestException) ErrorMessage ¶
func (e *BadRequestException) ErrorMessage() string
type BatchChannelMemberships ¶
type BatchChannelMemberships struct { // The ARN of the channel to which you're adding users. ChannelArn *string // The identifier of the member who invited another member. InvitedBy *Identity // The users successfully added to the request. Members []Identity // The membership types set for the channel users. Type ChannelMembershipType // contains filtered or unexported fields }
The membership information, including member ARNs, the channel ARN, and membership types.
type BatchCreateChannelMembershipError ¶
type BatchCreateChannelMembershipError struct { // The error code. ErrorCode ErrorCode // The error message. ErrorMessage *string // The ARN of the member that the service couldn't add. MemberArn *string // contains filtered or unexported fields }
A list of failed member ARNs, error codes, and error messages.
type Channel ¶
type Channel struct { // The ARN of a channel. ChannelArn *string // The AppInstanceUser who created the channel. CreatedBy *Identity // The time at which the AppInstanceUser created the channel. CreatedTimestamp *time.Time // The time at which a member sent the last message in the channel. LastMessageTimestamp *time.Time // The time at which a channel was last updated. LastUpdatedTimestamp *time.Time // The channel's metadata. Metadata *string // The mode of the channel. Mode ChannelMode // The name of a channel. Name *string // The channel's privacy setting. Privacy ChannelPrivacy // contains filtered or unexported fields }
The details of a channel.
type ChannelBan ¶
type ChannelBan struct { // The ARN of the channel from which a member is being banned. ChannelArn *string // The AppInstanceUser who created the ban. CreatedBy *Identity // The time at which the ban was created. CreatedTimestamp *time.Time // The member being banned from the channel. Member *Identity // contains filtered or unexported fields }
The details of a channel ban.
type ChannelBanSummary ¶
type ChannelBanSummary struct { // The member being banned from a channel. Member *Identity // contains filtered or unexported fields }
Summary of the details of a ChannelBan.
type ChannelMembership ¶
type ChannelMembership struct { // The ARN of the member's channel. ChannelArn *string // The time at which the channel membership was created. CreatedTimestamp *time.Time // The identifier of the member who invited another member. InvitedBy *Identity // The time at which a channel membership was last updated. LastUpdatedTimestamp *time.Time // The data of the channel member. Member *Identity // The membership type set for the channel member. Type ChannelMembershipType // contains filtered or unexported fields }
The details of a channel member.
type ChannelMembershipForAppInstanceUserSummary ¶
type ChannelMembershipForAppInstanceUserSummary struct { // Returns the channel membership data for an AppInstance. AppInstanceUserMembershipSummary *AppInstanceUserMembershipSummary // Returns the channel data for an AppInstance. ChannelSummary *ChannelSummary // contains filtered or unexported fields }
Summary of the channel membership details of an AppInstanceUser.
type ChannelMembershipSummary ¶
type ChannelMembershipSummary struct { // A member's summary data. Member *Identity // contains filtered or unexported fields }
Summary of the details of a ChannelMembership.
type ChannelMembershipType ¶
type ChannelMembershipType string
const ( ChannelMembershipTypeDefault ChannelMembershipType = "DEFAULT" ChannelMembershipTypeHidden ChannelMembershipType = "HIDDEN" )
Enum values for ChannelMembershipType
func (ChannelMembershipType) Values ¶
func (ChannelMembershipType) Values() []ChannelMembershipType
Values returns all known values for ChannelMembershipType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type ChannelMessage ¶
type ChannelMessage struct { // The ARN of the channel. ChannelArn *string // The message content. Content *string // The time at which the message was created. CreatedTimestamp *time.Time // The time at which a message was edited. LastEditedTimestamp *time.Time // The time at which a message was updated. LastUpdatedTimestamp *time.Time // The ID of a message. MessageId *string // The message metadata. Metadata *string // The persistence setting for a channel message. Persistence ChannelMessagePersistenceType // Hides the content of a message. Redacted bool // The message sender. Sender *Identity // The message type. Type ChannelMessageType // contains filtered or unexported fields }
The details of a message in a channel.
type ChannelMessagePersistenceType ¶
type ChannelMessagePersistenceType string
const ( ChannelMessagePersistenceTypePersistent ChannelMessagePersistenceType = "PERSISTENT" ChannelMessagePersistenceTypeNonPersistent ChannelMessagePersistenceType = "NON_PERSISTENT" )
Enum values for ChannelMessagePersistenceType
func (ChannelMessagePersistenceType) Values ¶
func (ChannelMessagePersistenceType) Values() []ChannelMessagePersistenceType
Values returns all known values for ChannelMessagePersistenceType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type ChannelMessageSummary ¶
type ChannelMessageSummary struct { // The content of the message. Content *string // The time at which the message summary was created. CreatedTimestamp *time.Time // The time at which a message was last edited. LastEditedTimestamp *time.Time // The time at which a message was last updated. LastUpdatedTimestamp *time.Time // The ID of the message. MessageId *string // The metadata of the message. Metadata *string // Indicates whether a message was redacted. Redacted bool // The message sender. Sender *Identity // The type of message. Type ChannelMessageType // contains filtered or unexported fields }
Summary of the messages in a Channel.
type ChannelMessageType ¶
type ChannelMessageType string
const ( ChannelMessageTypeStandard ChannelMessageType = "STANDARD" ChannelMessageTypeControl ChannelMessageType = "CONTROL" )
Enum values for ChannelMessageType
func (ChannelMessageType) Values ¶
func (ChannelMessageType) Values() []ChannelMessageType
Values returns all known values for ChannelMessageType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type ChannelMode ¶
type ChannelMode string
const ( ChannelModeUnrestricted ChannelMode = "UNRESTRICTED" ChannelModeRestricted ChannelMode = "RESTRICTED" )
Enum values for ChannelMode
func (ChannelMode) Values ¶
func (ChannelMode) Values() []ChannelMode
Values returns all known values for ChannelMode. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type ChannelModeratedByAppInstanceUserSummary ¶
type ChannelModeratedByAppInstanceUserSummary struct { // Summary of the details of a Channel. ChannelSummary *ChannelSummary // contains filtered or unexported fields }
Summary of the details of a moderated channel.
type ChannelModerator ¶
type ChannelModerator struct { // The ARN of the moderator's channel. ChannelArn *string // The AppInstanceUser who created the moderator. CreatedBy *Identity // The time at which the moderator was created. CreatedTimestamp *time.Time // The moderator's data. Moderator *Identity // contains filtered or unexported fields }
The details of a channel moderator.
type ChannelModeratorSummary ¶
type ChannelModeratorSummary struct { // The data for a moderator. Moderator *Identity // contains filtered or unexported fields }
Summary of the details of a ChannelModerator.
type ChannelPrivacy ¶
type ChannelPrivacy string
const ( ChannelPrivacyPublic ChannelPrivacy = "PUBLIC" ChannelPrivacyPrivate ChannelPrivacy = "PRIVATE" )
Enum values for ChannelPrivacy
func (ChannelPrivacy) Values ¶
func (ChannelPrivacy) Values() []ChannelPrivacy
Values returns all known values for ChannelPrivacy. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type ChannelSummary ¶
type ChannelSummary struct { // The ARN of the channel. ChannelArn *string // The time at which the last message in a channel was sent. LastMessageTimestamp *time.Time // The metadata of the channel. Metadata *string // The mode of the channel. Mode ChannelMode // The name of the channel. Name *string // The privacy setting of the channel. Privacy ChannelPrivacy // contains filtered or unexported fields }
Summary of the details of a Channel.
type ConflictException ¶
type ConflictException struct { Message *string Code ErrorCode // contains filtered or unexported fields }
The request could not be processed because of conflict in the current state of the resource.
func (*ConflictException) Error ¶
func (e *ConflictException) Error() string
func (*ConflictException) ErrorCode ¶
func (e *ConflictException) ErrorCode() string
func (*ConflictException) ErrorFault ¶
func (e *ConflictException) ErrorFault() smithy.ErrorFault
func (*ConflictException) ErrorMessage ¶
func (e *ConflictException) ErrorMessage() string
type ErrorCode ¶
type ErrorCode string
const ( ErrorCodeBadRequest ErrorCode = "BadRequest" ErrorCodeConflict ErrorCode = "Conflict" ErrorCodeForbidden ErrorCode = "Forbidden" ErrorCodeNotFound ErrorCode = "NotFound" ErrorCodePreconditionFailed ErrorCode = "PreconditionFailed" ErrorCodeResourceLimitExceeded ErrorCode = "ResourceLimitExceeded" ErrorCodeServiceFailure ErrorCode = "ServiceFailure" ErrorCodeAccessDenied ErrorCode = "AccessDenied" ErrorCodeThrottled ErrorCode = "Throttled" ErrorCodeThrottling ErrorCode = "Throttling" ErrorCodeUnprocessable ErrorCode = "Unprocessable" ErrorCodeVoiceConnectorGroupAssociationsExist ErrorCode = "VoiceConnectorGroupAssociationsExist" ErrorCodePhoneNumberAssociationsExist ErrorCode = "PhoneNumberAssociationsExist" )
Enum values for ErrorCode
type ForbiddenException ¶
type ForbiddenException struct { Message *string Code ErrorCode // contains filtered or unexported fields }
The client is permanently forbidden from making the request.
func (*ForbiddenException) Error ¶
func (e *ForbiddenException) Error() string
func (*ForbiddenException) ErrorCode ¶
func (e *ForbiddenException) ErrorCode() string
func (*ForbiddenException) ErrorFault ¶
func (e *ForbiddenException) ErrorFault() smithy.ErrorFault
func (*ForbiddenException) ErrorMessage ¶
func (e *ForbiddenException) ErrorMessage() string
type Identity ¶
type Identity struct { // The ARN in an Identity. Arn *string // The name in an Identity. Name *string // contains filtered or unexported fields }
The details of a user.
type MessagingSessionEndpoint ¶
type MessagingSessionEndpoint struct { // The endpoint to which you establish a websocket connection. Url *string // contains filtered or unexported fields }
The websocket endpoint used to connect to Amazon Chime SDK messaging.
type NotFoundException ¶
type NotFoundException struct { Message *string Code ErrorCode // contains filtered or unexported fields }
One or more of the resources in the request does not exist in the system.
func (*NotFoundException) Error ¶
func (e *NotFoundException) Error() string
func (*NotFoundException) ErrorCode ¶
func (e *NotFoundException) ErrorCode() string
func (*NotFoundException) ErrorFault ¶
func (e *NotFoundException) ErrorFault() smithy.ErrorFault
func (*NotFoundException) ErrorMessage ¶
func (e *NotFoundException) ErrorMessage() string
type ResourceLimitExceededException ¶
type ResourceLimitExceededException struct { Message *string Code ErrorCode // contains filtered or unexported fields }
The request exceeds the resource limit.
func (*ResourceLimitExceededException) Error ¶
func (e *ResourceLimitExceededException) Error() string
func (*ResourceLimitExceededException) ErrorCode ¶
func (e *ResourceLimitExceededException) ErrorCode() string
func (*ResourceLimitExceededException) ErrorFault ¶
func (e *ResourceLimitExceededException) ErrorFault() smithy.ErrorFault
func (*ResourceLimitExceededException) ErrorMessage ¶
func (e *ResourceLimitExceededException) ErrorMessage() string
type ServiceFailureException ¶
type ServiceFailureException struct { Message *string Code ErrorCode // contains filtered or unexported fields }
The service encountered an unexpected error.
func (*ServiceFailureException) Error ¶
func (e *ServiceFailureException) Error() string
func (*ServiceFailureException) ErrorCode ¶
func (e *ServiceFailureException) ErrorCode() string
func (*ServiceFailureException) ErrorFault ¶
func (e *ServiceFailureException) ErrorFault() smithy.ErrorFault
func (*ServiceFailureException) ErrorMessage ¶
func (e *ServiceFailureException) ErrorMessage() string
type ServiceUnavailableException ¶
type ServiceUnavailableException struct { // contains filtered or unexported fields }
The service is currently unavailable.
func (*ServiceUnavailableException) Error ¶
func (e *ServiceUnavailableException) Error() string
func (*ServiceUnavailableException) ErrorCode ¶
func (e *ServiceUnavailableException) ErrorCode() string
func (*ServiceUnavailableException) ErrorFault ¶
func (e *ServiceUnavailableException) ErrorFault() smithy.ErrorFault
func (*ServiceUnavailableException) ErrorMessage ¶
func (e *ServiceUnavailableException) ErrorMessage() string
type Tag ¶
type Tag struct { // The key of the tag. // // This member is required. Key *string // The value of the tag. // // This member is required. Value *string // contains filtered or unexported fields }
Describes a tag applied to a resource.
type ThrottledClientException ¶
type ThrottledClientException struct { Message *string Code ErrorCode // contains filtered or unexported fields }
The client exceeded its request rate limit.
func (*ThrottledClientException) Error ¶
func (e *ThrottledClientException) Error() string
func (*ThrottledClientException) ErrorCode ¶
func (e *ThrottledClientException) ErrorCode() string
func (*ThrottledClientException) ErrorFault ¶
func (e *ThrottledClientException) ErrorFault() smithy.ErrorFault
func (*ThrottledClientException) ErrorMessage ¶
func (e *ThrottledClientException) ErrorMessage() string
type UnauthorizedClientException ¶
type UnauthorizedClientException struct { // contains filtered or unexported fields }
The client is not currently authorized to make the request.
func (*UnauthorizedClientException) Error ¶
func (e *UnauthorizedClientException) Error() string
func (*UnauthorizedClientException) ErrorCode ¶
func (e *UnauthorizedClientException) ErrorCode() string
func (*UnauthorizedClientException) ErrorFault ¶
func (e *UnauthorizedClientException) ErrorFault() smithy.ErrorFault
func (*UnauthorizedClientException) ErrorMessage ¶
func (e *UnauthorizedClientException) ErrorMessage() string