package types
import "github.com/aws/aws-sdk-go-v2/service/chime/types"
Index ¶
- type AccessDeniedException
- func (e *AccessDeniedException) Error() string
- func (e *AccessDeniedException) ErrorCode() string
- func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault
- func (e *AccessDeniedException) ErrorMessage() string
- type Account
- type AccountSettings
- type AccountStatus
- type AccountType
- type AlexaForBusinessMetadata
- type BadRequestException
- func (e *BadRequestException) Error() string
- func (e *BadRequestException) ErrorCode() string
- func (e *BadRequestException) ErrorFault() smithy.ErrorFault
- func (e *BadRequestException) ErrorMessage() string
- type Bot
- type BotType
- type BusinessCallingSettings
- type CallingNameStatus
- type ConflictException
- func (e *ConflictException) Error() string
- func (e *ConflictException) ErrorCode() string
- func (e *ConflictException) ErrorFault() smithy.ErrorFault
- func (e *ConflictException) ErrorMessage() string
- type ConversationRetentionSettings
- type EmailStatus
- type ErrorCode
- type EventsConfiguration
- type ForbiddenException
- func (e *ForbiddenException) Error() string
- func (e *ForbiddenException) ErrorCode() string
- func (e *ForbiddenException) ErrorFault() smithy.ErrorFault
- func (e *ForbiddenException) ErrorMessage() string
- type Invite
- type InviteStatus
- type License
- type Member
- type MemberError
- type MemberType
- type MembershipItem
- type NotFoundException
- func (e *NotFoundException) Error() string
- func (e *NotFoundException) ErrorCode() string
- func (e *NotFoundException) ErrorFault() smithy.ErrorFault
- func (e *NotFoundException) ErrorMessage() string
- type OrderedPhoneNumber
- type OrderedPhoneNumberStatus
- type PhoneNumber
- type PhoneNumberAssociation
- type PhoneNumberAssociationName
- type PhoneNumberCapabilities
- type PhoneNumberCountry
- type PhoneNumberError
- type PhoneNumberOrder
- type PhoneNumberOrderStatus
- type PhoneNumberProductType
- type PhoneNumberStatus
- type PhoneNumberType
- type RegistrationStatus
- type ResourceLimitExceededException
- func (e *ResourceLimitExceededException) Error() string
- func (e *ResourceLimitExceededException) ErrorCode() string
- func (e *ResourceLimitExceededException) ErrorFault() smithy.ErrorFault
- func (e *ResourceLimitExceededException) ErrorMessage() string
- type RetentionSettings
- type Room
- type RoomMembership
- type RoomMembershipRole
- type RoomRetentionSettings
- type ServiceFailureException
- func (e *ServiceFailureException) Error() string
- func (e *ServiceFailureException) ErrorCode() string
- func (e *ServiceFailureException) ErrorFault() smithy.ErrorFault
- func (e *ServiceFailureException) ErrorMessage() string
- type ServiceUnavailableException
- func (e *ServiceUnavailableException) Error() string
- func (e *ServiceUnavailableException) ErrorCode() string
- func (e *ServiceUnavailableException) ErrorFault() smithy.ErrorFault
- func (e *ServiceUnavailableException) ErrorMessage() string
- type SigninDelegateGroup
- type TelephonySettings
- type ThrottledClientException
- func (e *ThrottledClientException) Error() string
- func (e *ThrottledClientException) ErrorCode() string
- func (e *ThrottledClientException) ErrorFault() smithy.ErrorFault
- func (e *ThrottledClientException) ErrorMessage() string
- type UnauthorizedClientException
- func (e *UnauthorizedClientException) Error() string
- func (e *UnauthorizedClientException) ErrorCode() string
- func (e *UnauthorizedClientException) ErrorFault() smithy.ErrorFault
- func (e *UnauthorizedClientException) ErrorMessage() string
- type UnprocessableEntityException
- func (e *UnprocessableEntityException) Error() string
- func (e *UnprocessableEntityException) ErrorCode() string
- func (e *UnprocessableEntityException) ErrorFault() smithy.ErrorFault
- func (e *UnprocessableEntityException) ErrorMessage() string
- type UpdatePhoneNumberRequestItem
- type UpdateUserRequestItem
- type User
- type UserError
- type UserSettings
- type UserType
- type VoiceConnectorSettings
Types ¶
type AccessDeniedException ¶
type AccessDeniedException struct { Message *string ErrorCodeOverride *string Code ErrorCode // contains filtered or unexported fields }
You don't have permissions to perform the requested operation.
func (*AccessDeniedException) Error ¶
func (e *AccessDeniedException) Error() string
func (*AccessDeniedException) ErrorCode ¶
func (e *AccessDeniedException) ErrorCode() string
func (*AccessDeniedException) ErrorFault ¶
func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault
func (*AccessDeniedException) ErrorMessage ¶
func (e *AccessDeniedException) ErrorMessage() string
type Account ¶
type Account struct { // The Amazon Chime account ID. // // This member is required. AccountId *string // The AWS account ID. // // This member is required. AwsAccountId *string // The Amazon Chime account name. // // This member is required. Name *string // The status of the account. AccountStatus AccountStatus // The Amazon Chime account type. For more information about different account // types, see [Managing Your Amazon Chime Accounts]in the Amazon Chime Administration Guide. // // [Managing Your Amazon Chime Accounts]: https://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html AccountType AccountType // The Amazon Chime account creation timestamp, in ISO 8601 format. CreatedTimestamp *time.Time // The default license for the Amazon Chime account. DefaultLicense License // The sign-in delegate groups associated with the account. SigninDelegateGroups []SigninDelegateGroup // Supported licenses for the Amazon Chime account. SupportedLicenses []License // contains filtered or unexported fields }
The Amazon Chime account details. An AWS account can have multiple Amazon Chime accounts.
type AccountSettings ¶
type AccountSettings struct { // Setting that stops or starts remote control of shared screens during meetings. DisableRemoteControl *bool // Setting that allows meeting participants to choose the Call me at a phone // number option. For more information, see [Join a Meeting without the Amazon Chime App]. // // [Join a Meeting without the Amazon Chime App]: https://docs.aws.amazon.com/chime/latest/ug/chime-join-meeting.html EnableDialOut *bool // contains filtered or unexported fields }
Settings related to the Amazon Chime account. This includes settings that start or stop remote control of shared screens, or start or stop the dial-out option in the Amazon Chime web application. For more information about these settings, see Use the Policies Pagein the Amazon Chime Administration Guide.
type AccountStatus ¶
type AccountStatus string
const ( AccountStatusSuspended AccountStatus = "Suspended" AccountStatusActive AccountStatus = "Active" )
Enum values for AccountStatus
func (AccountStatus) Values ¶
func (AccountStatus) Values() []AccountStatus
Values returns all known values for AccountStatus. 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 AccountType ¶
type AccountType string
const ( AccountTypeTeam AccountType = "Team" AccountTypeEnterpriseDirectory AccountType = "EnterpriseDirectory" AccountTypeEnterpriseLWA AccountType = "EnterpriseLWA" AccountTypeEnterpriseOIDC AccountType = "EnterpriseOIDC" )
Enum values for AccountType
func (AccountType) Values ¶
func (AccountType) Values() []AccountType
Values returns all known values for AccountType. 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 AlexaForBusinessMetadata ¶
type AlexaForBusinessMetadata struct { // The ARN of the room resource. AlexaForBusinessRoomArn *string // Starts or stops Alexa for Business. IsAlexaForBusinessEnabled *bool // contains filtered or unexported fields }
The Alexa for Business metadata associated with an Amazon Chime user, used to integrate Alexa for Business with a device.
type BadRequestException ¶
type BadRequestException struct { Message *string ErrorCodeOverride *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 Bot ¶
type Bot struct { // The bot email address. BotEmail *string // The bot ID. BotId *string // The bot type. BotType BotType // The bot creation timestamp, in ISO 8601 format. CreatedTimestamp *time.Time // When true, the bot is stopped from running in your account. Disabled *bool // The bot display name. DisplayName *string // The security token used to authenticate Amazon Chime with the outgoing event // endpoint. SecurityToken *string // The updated bot timestamp, in ISO 8601 format. UpdatedTimestamp *time.Time // The unique ID for the bot user. UserId *string // contains filtered or unexported fields }
A resource that allows Enterprise account administrators to configure an interface to receive events from Amazon Chime.
type BotType ¶
type BotType string
const ( BotTypeChatBot BotType = "ChatBot" )
Enum values for BotType
func (BotType) Values ¶
Values returns all known values for BotType. 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 BusinessCallingSettings ¶
type BusinessCallingSettings struct { // The Amazon S3 bucket designated for call detail record storage. CdrBucket *string // contains filtered or unexported fields }
The Amazon Chime Business Calling settings for the administrator's AWS account. Includes any Amazon S3 buckets designated for storing call detail records.
type CallingNameStatus ¶
type CallingNameStatus string
const ( CallingNameStatusUnassigned CallingNameStatus = "Unassigned" CallingNameStatusUpdateInProgress CallingNameStatus = "UpdateInProgress" CallingNameStatusUpdateSucceeded CallingNameStatus = "UpdateSucceeded" CallingNameStatusUpdateFailed CallingNameStatus = "UpdateFailed" )
Enum values for CallingNameStatus
func (CallingNameStatus) Values ¶
func (CallingNameStatus) Values() []CallingNameStatus
Values returns all known values for CallingNameStatus. 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 ConflictException ¶
type ConflictException struct { Message *string ErrorCodeOverride *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 ConversationRetentionSettings ¶
type ConversationRetentionSettings struct { // The number of days for which to retain conversation messages. RetentionDays *int32 // contains filtered or unexported fields }
The retention settings that determine how long to retain conversation messages for an Amazon Chime Enterprise account.
type EmailStatus ¶
type EmailStatus string
const ( EmailStatusNotSent EmailStatus = "NotSent" EmailStatusSent EmailStatus = "Sent" EmailStatusFailed EmailStatus = "Failed" )
Enum values for EmailStatus
func (EmailStatus) Values ¶
func (EmailStatus) Values() []EmailStatus
Values returns all known values for EmailStatus. 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 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" ErrorCode = "ServiceUnavailable" ErrorCodeThrottled ErrorCode = "Throttled" ErrorCodeThrottling ErrorCode = "Throttling" ErrorCode = "Unauthorized" ErrorCodeUnprocessable ErrorCode = "Unprocessable" ErrorCodeVoiceConnectorGroupAssociationsExist ErrorCode = "VoiceConnectorGroupAssociationsExist" ErrorCodePhoneNumberAssociationsExist ErrorCode = "PhoneNumberAssociationsExist" )
Enum values for ErrorCode
func (ErrorCode) Values ¶
Values returns all known values for ErrorCode. 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 EventsConfiguration ¶
type EventsConfiguration struct { // The bot ID. BotId *string // Lambda function ARN that allows a bot to receive outgoing events. LambdaFunctionArn *string // HTTPS endpoint that allows a bot to receive outgoing events. OutboundEventsHTTPSEndpoint *string // contains filtered or unexported fields }
The configuration that allows a bot to receive outgoing events. Can be either an HTTPS endpoint or a Lambda function ARN.
type ForbiddenException ¶
type ForbiddenException struct { Message *string ErrorCodeOverride *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 Invite ¶
type Invite struct { // The email address to which the invite is sent. EmailAddress *string // The status of the invite email. EmailStatus EmailStatus // The invite ID. InviteId *string // The status of the invite. Status InviteStatus // contains filtered or unexported fields }
Invitation object returned after emailing users to invite them to join the Amazon Chime Team account.
type InviteStatus ¶
type InviteStatus string
const ( InviteStatusPending InviteStatus = "Pending" InviteStatusAccepted InviteStatus = "Accepted" InviteStatusFailed InviteStatus = "Failed" )
Enum values for InviteStatus
func (InviteStatus) Values ¶
func (InviteStatus) Values() []InviteStatus
Values returns all known values for InviteStatus. 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 License ¶
type License string
const ( LicenseBasic License = "Basic" LicensePlus License = "Plus" LicensePro License = "Pro" LicenseProTrial License = "ProTrial" )
Enum values for License
func (License) Values ¶
Values returns all known values for License. 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 Member ¶
type Member struct { // The Amazon Chime account ID. AccountId *string // The member email address. Email *string // The member name. FullName *string // The member ID (user ID or bot ID). MemberId *string // The member type. MemberType MemberType // contains filtered or unexported fields }
The member details, such as email address, name, member ID, and member type.
type MemberError ¶
type MemberError struct { // The error code. ErrorCode ErrorCode // The error message. ErrorMessage *string // The member ID. MemberId *string // contains filtered or unexported fields }
The list of errors returned when a member action results in an error.
type MemberType ¶
type MemberType string
const ( MemberTypeUser MemberType = "User" MemberTypeBot MemberType = "Bot" MemberTypeWebhook MemberType = "Webhook" )
Enum values for MemberType
func (MemberType) Values ¶
func (MemberType) Values() []MemberType
Values returns all known values for MemberType. 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 MembershipItem ¶
type MembershipItem struct { // The member ID. MemberId *string // The member role. Role RoomMembershipRole // contains filtered or unexported fields }
Membership details, such as member ID and member role.
type NotFoundException ¶
type NotFoundException struct { Message *string ErrorCodeOverride *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 OrderedPhoneNumber ¶
type OrderedPhoneNumber struct { // The phone number, in E.164 format. E164PhoneNumber *string // The phone number status. Status OrderedPhoneNumberStatus // contains filtered or unexported fields }
A phone number for which an order has been placed.
type OrderedPhoneNumberStatus ¶
type OrderedPhoneNumberStatus string
const ( OrderedPhoneNumberStatusProcessing OrderedPhoneNumberStatus = "Processing" OrderedPhoneNumberStatusAcquired OrderedPhoneNumberStatus = "Acquired" OrderedPhoneNumberStatusFailed OrderedPhoneNumberStatus = "Failed" )
Enum values for OrderedPhoneNumberStatus
func (OrderedPhoneNumberStatus) Values ¶
func (OrderedPhoneNumberStatus) Values() []OrderedPhoneNumberStatus
Values returns all known values for OrderedPhoneNumberStatus. 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 PhoneNumber ¶
type PhoneNumber struct { // The phone number associations. Associations []PhoneNumberAssociation // The outbound calling name associated with the phone number. CallingName *string // The outbound calling name status. CallingNameStatus CallingNameStatus // The phone number capabilities. Capabilities *PhoneNumberCapabilities // The phone number country. Format: ISO 3166-1 alpha-2. Country *string // The phone number creation timestamp, in ISO 8601 format. CreatedTimestamp *time.Time // The deleted phone number timestamp, in ISO 8601 format. DeletionTimestamp *time.Time // The phone number, in E.164 format. E164PhoneNumber *string // The phone number ID. PhoneNumberId *string // The phone number product type. ProductType PhoneNumberProductType // The phone number status. Status PhoneNumberStatus // The phone number type. Type PhoneNumberType // The updated phone number timestamp, in ISO 8601 format. UpdatedTimestamp *time.Time // contains filtered or unexported fields }
A phone number used for Amazon Chime Business Calling or an Amazon Chime Voice Connector.
type PhoneNumberAssociation ¶
type PhoneNumberAssociation struct { // The timestamp of the phone number association, in ISO 8601 format. AssociatedTimestamp *time.Time // Defines the association with an Amazon Chime account ID, user ID, Amazon Chime // Voice Connector ID, or Amazon Chime Voice Connector group ID. Name PhoneNumberAssociationName // Contains the ID for the entity specified in Name. Value *string // contains filtered or unexported fields }
The phone number associations, such as Amazon Chime account ID, Amazon Chime user ID, Amazon Chime Voice Connector ID, or Amazon Chime Voice Connector group ID.
type PhoneNumberAssociationName ¶
type PhoneNumberAssociationName string
const ( PhoneNumberAssociationNameAccountId PhoneNumberAssociationName = "AccountId" PhoneNumberAssociationNameUserId PhoneNumberAssociationName = "UserId" PhoneNumberAssociationNameVoiceConnectorId PhoneNumberAssociationName = "VoiceConnectorId" PhoneNumberAssociationNameVoiceConnectorGroupId PhoneNumberAssociationName = "VoiceConnectorGroupId" PhoneNumberAssociationNameSipRuleId PhoneNumberAssociationName = "SipRuleId" )
Enum values for PhoneNumberAssociationName
func (PhoneNumberAssociationName) Values ¶
func (PhoneNumberAssociationName) Values() []PhoneNumberAssociationName
Values returns all known values for PhoneNumberAssociationName. 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 PhoneNumberCapabilities ¶
type PhoneNumberCapabilities struct { // Allows or denies inbound calling for the specified phone number. InboundCall *bool // Allows or denies inbound MMS messaging for the specified phone number. InboundMMS *bool // Allows or denies inbound SMS messaging for the specified phone number. InboundSMS *bool // Allows or denies outbound calling for the specified phone number. OutboundCall *bool // Allows or denies outbound MMS messaging for the specified phone number. OutboundMMS *bool // Allows or denies outbound SMS messaging for the specified phone number. OutboundSMS *bool // contains filtered or unexported fields }
The phone number capabilities for Amazon Chime Business Calling phone numbers, such as enabled inbound and outbound calling and text messaging.
type PhoneNumberCountry ¶
type PhoneNumberCountry struct { // The phone number country code. Format: ISO 3166-1 alpha-2. CountryCode *string // The supported phone number types. SupportedPhoneNumberTypes []PhoneNumberType // contains filtered or unexported fields }
The phone number country.
type PhoneNumberError ¶
type PhoneNumberError struct { // The error code. ErrorCode ErrorCode // The error message. ErrorMessage *string // The phone number ID for which the action failed. PhoneNumberId *string // contains filtered or unexported fields }
If the phone number action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.
type PhoneNumberOrder ¶
type PhoneNumberOrder struct { // The phone number order creation time stamp, in ISO 8601 format. CreatedTimestamp *time.Time // The ordered phone number details, such as the phone number in E.164 format and // the phone number status. OrderedPhoneNumbers []OrderedPhoneNumber // The phone number order ID. PhoneNumberOrderId *string // The phone number order product type. ProductType PhoneNumberProductType // The status of the phone number order. Status PhoneNumberOrderStatus // The updated phone number order time stamp, in ISO 8601 format. UpdatedTimestamp *time.Time // contains filtered or unexported fields }
The details of a phone number order created for Amazon Chime.
type PhoneNumberOrderStatus ¶
type PhoneNumberOrderStatus string
const ( PhoneNumberOrderStatusProcessing PhoneNumberOrderStatus = "Processing" PhoneNumberOrderStatusSuccessful PhoneNumberOrderStatus = "Successful" PhoneNumberOrderStatusFailed PhoneNumberOrderStatus = "Failed" PhoneNumberOrderStatusPartial PhoneNumberOrderStatus = "Partial" )
Enum values for PhoneNumberOrderStatus
func (PhoneNumberOrderStatus) Values ¶
func (PhoneNumberOrderStatus) Values() []PhoneNumberOrderStatus
Values returns all known values for PhoneNumberOrderStatus. 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 PhoneNumberProductType ¶
type PhoneNumberProductType string
const ( PhoneNumberProductTypeBusinessCalling PhoneNumberProductType = "BusinessCalling" PhoneNumberProductTypeVoiceConnector PhoneNumberProductType = "VoiceConnector" PhoneNumberProductTypeSipMediaApplicationDialIn PhoneNumberProductType = "SipMediaApplicationDialIn" )
Enum values for PhoneNumberProductType
func (PhoneNumberProductType) Values ¶
func (PhoneNumberProductType) Values() []PhoneNumberProductType
Values returns all known values for PhoneNumberProductType. 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 PhoneNumberStatus ¶
type PhoneNumberStatus string
const ( PhoneNumberStatusAcquireInProgress PhoneNumberStatus = "AcquireInProgress" PhoneNumberStatusAcquireFailed PhoneNumberStatus = "AcquireFailed" PhoneNumberStatusUnassigned PhoneNumberStatus = "Unassigned" PhoneNumberStatusAssigned PhoneNumberStatus = "Assigned" PhoneNumberStatusReleaseInProgress PhoneNumberStatus = "ReleaseInProgress" PhoneNumberStatusDeleteInProgress PhoneNumberStatus = "DeleteInProgress" PhoneNumberStatusReleaseFailed PhoneNumberStatus = "ReleaseFailed" PhoneNumberStatusDeleteFailed PhoneNumberStatus = "DeleteFailed" )
Enum values for PhoneNumberStatus
func (PhoneNumberStatus) Values ¶
func (PhoneNumberStatus) Values() []PhoneNumberStatus
Values returns all known values for PhoneNumberStatus. 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 PhoneNumberType ¶
type PhoneNumberType string
const ( PhoneNumberTypeLocal PhoneNumberType = "Local" PhoneNumberTypeTollFree PhoneNumberType = "TollFree" )
Enum values for PhoneNumberType
func (PhoneNumberType) Values ¶
func (PhoneNumberType) Values() []PhoneNumberType
Values returns all known values for PhoneNumberType. 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 RegistrationStatus ¶
type RegistrationStatus string
const ( RegistrationStatusUnregistered RegistrationStatus = "Unregistered" RegistrationStatusRegistered RegistrationStatus = "Registered" RegistrationStatusSuspended RegistrationStatus = "Suspended" )
Enum values for RegistrationStatus
func (RegistrationStatus) Values ¶
func (RegistrationStatus) Values() []RegistrationStatus
Values returns all known values for RegistrationStatus. 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 ResourceLimitExceededException ¶
type ResourceLimitExceededException struct { Message *string ErrorCodeOverride *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 RetentionSettings ¶
type RetentionSettings struct { // The chat conversation retention settings. ConversationRetentionSettings *ConversationRetentionSettings // The chat room retention settings. RoomRetentionSettings *RoomRetentionSettings // contains filtered or unexported fields }
The retention settings for an Amazon Chime Enterprise account that determine how long to retain items such as chat-room messages and chat-conversation messages.
type Room ¶
type Room struct { // The Amazon Chime account ID. AccountId *string // The identifier of the room creator. CreatedBy *string // The room creation timestamp, in ISO 8601 format. CreatedTimestamp *time.Time // The room name. Name *string // The room ID. RoomId *string // The room update timestamp, in ISO 8601 format. UpdatedTimestamp *time.Time // contains filtered or unexported fields }
The Amazon Chime chat room details.
type RoomMembership ¶
type RoomMembership struct { // The identifier of the user that invited the room member. InvitedBy *string // The member details, such as email address, name, member ID, and member type. Member *Member // The membership role. Role RoomMembershipRole // The room ID. RoomId *string // The room membership update timestamp, in ISO 8601 format. UpdatedTimestamp *time.Time // contains filtered or unexported fields }
The room membership details.
type RoomMembershipRole ¶
type RoomMembershipRole string
const ( RoomMembershipRoleAdministrator RoomMembershipRole = "Administrator" RoomMembershipRoleMember RoomMembershipRole = "Member" )
Enum values for RoomMembershipRole
func (RoomMembershipRole) Values ¶
func (RoomMembershipRole) Values() []RoomMembershipRole
Values returns all known values for RoomMembershipRole. 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 RoomRetentionSettings ¶
type RoomRetentionSettings struct { // The number of days for which to retain chat-room messages. RetentionDays *int32 // contains filtered or unexported fields }
The retention settings that determine how long to retain chat-room messages for an Amazon Chime Enterprise account.
type ServiceFailureException ¶
type ServiceFailureException struct { Message *string ErrorCodeOverride *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 { string *string ErrorCode // 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 SigninDelegateGroup ¶
type SigninDelegateGroup struct { // The group name. GroupName *string // contains filtered or unexported fields }
An Active Directory (AD) group whose members are granted permission to act as delegates.
type TelephonySettings ¶
type TelephonySettings struct { // Allows or denies inbound calling. // // This member is required. InboundCalling *bool // Allows or denies outbound calling. // // This member is required. OutboundCalling *bool // Allows or denies SMS messaging. // // This member is required. SMS *bool // contains filtered or unexported fields }
Settings that allow management of telephony permissions for an Amazon Chime user, such as inbound and outbound calling and text messaging.
type ThrottledClientException ¶
type ThrottledClientException struct { Message *string ErrorCodeOverride *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 { string *string ErrorCode // 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
type UnprocessableEntityException ¶
type UnprocessableEntityException struct { Message *string ErrorCodeOverride *string Code ErrorCode // contains filtered or unexported fields }
The request was well-formed but was unable to be followed due to semantic errors.
func (*UnprocessableEntityException) Error ¶
func (e *UnprocessableEntityException) Error() string
func (*UnprocessableEntityException) ErrorCode ¶
func (e *UnprocessableEntityException) ErrorCode() string
func (*UnprocessableEntityException) ErrorFault ¶
func (e *UnprocessableEntityException) ErrorFault() smithy.ErrorFault
func (*UnprocessableEntityException) ErrorMessage ¶
func (e *UnprocessableEntityException) ErrorMessage() string
type UpdatePhoneNumberRequestItem ¶
type UpdatePhoneNumberRequestItem struct { // The phone number ID to update. // // This member is required. PhoneNumberId *string // The outbound calling name to update. CallingName *string // The product type to update. ProductType PhoneNumberProductType // contains filtered or unexported fields }
The phone number ID, product type, or calling name fields to update, used with the BatchUpdatePhoneNumberand UpdatePhoneNumber actions.
type UpdateUserRequestItem ¶
type UpdateUserRequestItem struct { // The user ID. // // This member is required. UserId *string // The Alexa for Business metadata. AlexaForBusinessMetadata *AlexaForBusinessMetadata // The user license type. LicenseType License // The user type. UserType UserType // contains filtered or unexported fields }
The user ID and user fields to update, used with the BatchUpdateUser action.
type User ¶
type User struct { // The user ID. // // This member is required. UserId *string // The Amazon Chime account ID. AccountId *string // The Alexa for Business metadata. AlexaForBusinessMetadata *AlexaForBusinessMetadata // The display name of the user. DisplayName *string // Date and time when the user is invited to the Amazon Chime account, in ISO 8601 // format. InvitedOn *time.Time // The license type for the user. LicenseType License // The user's personal meeting PIN. PersonalPIN *string // The primary email address of the user. PrimaryEmail *string // The primary phone number associated with the user. PrimaryProvisionedNumber *string // Date and time when the user is registered, in ISO 8601 format. RegisteredOn *time.Time // The user invite status. UserInvitationStatus InviteStatus // The user registration status. UserRegistrationStatus RegistrationStatus // The user type. UserType UserType // contains filtered or unexported fields }
The user on the Amazon Chime account.
type UserError ¶
type UserError struct { // The error code. ErrorCode ErrorCode // The error message. ErrorMessage *string // The user ID for which the action failed. UserId *string // contains filtered or unexported fields }
The list of errors returned when errors are encountered during the BatchSuspendUser, BatchUnsuspendUser, or BatchUpdateUser actions. This includes user IDs, error codes, and error messages.
type UserSettings ¶
type UserSettings struct { // The telephony settings associated with the user. // // This member is required. Telephony *TelephonySettings // contains filtered or unexported fields }
Settings associated with an Amazon Chime user, including inbound and outbound calling and text messaging.
type UserType ¶
type UserType string
Enum values for UserType
func (UserType) Values ¶
Values returns all known values for UserType. 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 VoiceConnectorSettings ¶
type VoiceConnectorSettings struct { // The Amazon S3 bucket designated for call detail record storage. CdrBucket *string // contains filtered or unexported fields }
The Amazon Chime Voice Connector settings. Includes any Amazon S3 buckets designated for storing call detail records.
Source Files ¶
- Version
- v1.36.2 (latest)
- Published
- Apr 3, 2025
- Platform
- linux/amd64
- Imports
- 4 packages
- Last checked
- 41 minutes ago –
Tools for package owners.