types

package
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 19, 2021 License: Apache-2.0 Imports: 3 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessDeniedException 

type AccessDeniedException struct {
	Message *string

	Code ErrorCode
}

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 Amazon Chime account type. For more information about different account
	// types, see Managing Your Amazon Chime Accounts
	// (https://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html) in the
	// Amazon Chime Administration Guide.
	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
}

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
	// (https://docs.aws.amazon.com/chime/latest/ug/chime-join-meeting.html).
	EnableDialOut *bool
}

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 Page (https://docs.aws.amazon.com/chime/latest/ag/policies.html) in the Amazon Chime Administration Guide.

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 added in v0.29.0 

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
}

The Alexa for Business metadata associated with an Amazon Chime user, used to integrate Alexa for Business with a device.

type AppInstance added in v0.30.0 

type AppInstance struct {

	// The ARN of the messaging instance.
	AppInstanceArn *string

	// The time at which an app instance was created. In epoch milliseconds.
	CreatedTimestamp *time.Time

	// The time an app instance was last updated. In epoch milliseconds.
	LastUpdatedTimestamp *time.Time

	// The metadata of an app instance.
	Metadata *string

	// The name of an app instance.
	Name *string
}

An instance of a Chime messaging application.

type AppInstanceAdmin added in v0.30.0 

type AppInstanceAdmin struct {

	// The name and metadata of the app instance administrator.
	Admin *Identity

	// The ARN of the app instance administrator.
	AppInstanceArn *string

	// The time at which an administrator was created.
	CreatedTimestamp *time.Time
}

Promotes a user to the administrator role for the duration of an app instance.

type AppInstanceAdminSummary added in v0.30.0 

type AppInstanceAdminSummary struct {

	// The name and metadata of the app instance administrator.
	Admin *Identity
}

The identity and metadata of an administrator.

type AppInstanceDataType added in v0.30.0 

type AppInstanceDataType string
const (
	AppInstanceDataTypeChannel        AppInstanceDataType = "Channel"
	AppInstanceDataTypeChannelMessage AppInstanceDataType = "ChannelMessage"
)

Enum values for AppInstanceDataType

func (AppInstanceDataType) Values added in v0.30.0 

func (AppInstanceDataType) Values() []AppInstanceDataType

Values returns all known values for AppInstanceDataType. 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 AppInstanceRetentionSettings added in v0.30.0 

type AppInstanceRetentionSettings struct {

	// The length of time in days to retain a channel.
	ChannelRetentionSettings *ChannelRetentionSettings
}

The length of time in days to retain messages.

type AppInstanceStreamingConfiguration added in v0.30.0 

type AppInstanceStreamingConfiguration struct {

	// The data type of the app instance.
	//
	// This member is required.
	AppInstanceDataType AppInstanceDataType

	// The resource ARN.
	//
	// This member is required.
	ResourceArn *string
}

The streaming configuration of an app instance.

type AppInstanceSummary added in v0.30.0 

type AppInstanceSummary struct {

	// The app instance ARN.
	AppInstanceArn *string

	// The metadata of the app instance summary.
	Metadata *string

	// The name of the app instance summary.
	Name *string
}

The summary data for an app instance.

type AppInstanceUser added in v0.30.0 

type AppInstanceUser struct {

	// The ARN of the app instance user.
	AppInstanceUserArn *string

	// The time at which the app instance user was created.
	CreatedTimestamp *time.Time

	// The time at which the app instance user was last updated.
	LastUpdatedTimestamp *time.Time

	// The metadata of the app instance user.
	Metadata *string

	// The name of the app instance user.
	Name *string
}

The app instance user.

type AppInstanceUserMembershipSummary added in v0.30.0 

type AppInstanceUserMembershipSummary struct {

	// The time at which a summary was last read.
	ReadMarkerTimestamp *time.Time

	// The type of channel summary,
	Type ChannelMembershipType
}

Lists the channels to which app instance users belong.

type AppInstanceUserSummary added in v0.30.0 

type AppInstanceUserSummary struct {

	// The ARN of the app instance user.
	AppInstanceUserArn *string

	// The metadata in an app instance user summary.
	Metadata *string

	// The name in an app instance user summary.
	Name *string
}

The app instance user summary data .

type Attendee 

type Attendee struct {

	// The Amazon Chime SDK attendee ID.
	AttendeeId *string

	// The Amazon Chime SDK external user ID. An idempotency token. Links the attendee
	// to an identity managed by a builder application. If you create an attendee with
	// the same external user id, the service returns the existing record.
	ExternalUserId *string

	// The join token used by the Amazon Chime SDK attendee.
	JoinToken *string
}

An Amazon Chime SDK meeting attendee. Includes a unique AttendeeId and JoinToken. The JoinToken allows a client to authenticate and join as the specified attendee. The JoinToken expires when the meeting ends or when DeleteAttendee is called. After that, the attendee is unable to join the meeting. We recommend securely transferring each JoinToken from your server application to the client so that no other client has access to the token except for the one authorized to represent the attendee.

type BadRequestException 

type BadRequestException struct {
	Message *string

	Code ErrorCode
}

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
}

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 added in v0.29.0 

func (BotType) Values() []BotType

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
}

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 added in v0.29.0 

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 Capability 

type Capability string
const (
	CapabilityVoice Capability = "Voice"
	CapabilitySms   Capability = "SMS"
)

Enum values for Capability

func (Capability) Values added in v0.29.0 

func (Capability) Values() []Capability

Values returns all known values for Capability. 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 Channel added in v0.30.0 

type Channel struct {

	// The ARN of the channel.
	ChannelArn *string

	// The administrator who created the channel.
	CreatedBy *Identity

	// The time at which the administrator created the channel.
	CreatedTimestamp *time.Time

	// The time at which a member sent the last message in a session.
	LastMessageTimestamp *time.Time

	// The time at which a channel was last updated.
	LastUpdatedTimestamp *time.Time

	// The metadata of the channel.
	Metadata *string

	// The mode of the channel.
	Mode ChannelMode

	// The name of the channel.
	Name *string

	// The channel's privacy setting, PUBLIC or HIDDEN.
	Privacy ChannelPrivacy
}

Creates a channel.

type ChannelBan added in v0.30.0 

type ChannelBan struct {

	// The ARN of the channel from which a member is being banned.
	ChannelArn *string

	// The parameter of the action.
	CreatedBy *Identity

	// The time at which the ban was created.
	CreatedTimestamp *time.Time

	// The member being banned from the channel.
	Member *Identity
}

Bans a user from a channel.

type ChannelBanSummary added in v0.30.0 

type ChannelBanSummary struct {

	// The member being banned from a channel.
	Member *Identity
}

The summary data for the channel ban.

type ChannelMembership added in v0.30.0 

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. Taken from the message
	// header.
	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
}

Creates a channel member.

type ChannelMembershipForAppInstanceUserSummary added in v0.30.0 

type ChannelMembershipForAppInstanceUserSummary struct {

	// Returns the channel membership data for an app instance.
	AppInstanceUserMembershipSummary *AppInstanceUserMembershipSummary

	// The summary data for a channel.
	ChannelSummary *ChannelSummary
}

Returns the channel membership summary data for an app instance.

type ChannelMembershipSummary added in v0.30.0 

type ChannelMembershipSummary struct {

	// A member's summary data.
	Member *Identity
}

The summary data of a channel membership.

type ChannelMembershipType added in v0.30.0 

type ChannelMembershipType string
const (
	ChannelMembershipTypeDefault ChannelMembershipType = "DEFAULT"
	ChannelMembershipTypeHidden  ChannelMembershipType = "HIDDEN"
)

Enum values for ChannelMembershipType

func (ChannelMembershipType) Values added in v0.30.0 

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 added in v0.30.0 

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

	Persistence ChannelMessagePersistenceType

	// Hides the content of a message. The message still exists on the back end, but
	// this action only returns metadata.
	Redacted bool

	// The message sender.
	Sender *Identity

	// The message type.
	Type ChannelMessageType
}

Creates a message in a channel.

type ChannelMessagePersistenceType added in v0.30.0 

type ChannelMessagePersistenceType string
const (
	ChannelMessagePersistenceTypePersistent    ChannelMessagePersistenceType = "PERSISTENT"
	ChannelMessagePersistenceTypeNonPersistent ChannelMessagePersistenceType = "NON_PERSISTENT"
)

Enum values for ChannelMessagePersistenceType

func (ChannelMessagePersistenceType) Values added in v0.30.0 

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 added in v0.30.0 

type ChannelMessageSummary struct {

	// The content of the message summary.
	Content *string

	// The time at which the message summary was created.
	CreatedTimestamp *time.Time

	LastEditedTimestamp *time.Time

	LastUpdatedTimestamp *time.Time

	// The ID of the message summary.
	MessageId *string

	// The metadata of the message summary.
	Metadata *string

	// Redacts the content of a message summary.
	Redacted bool

	// The sender of the message summary.
	Sender *Identity

	// The type of message summary.
	Type ChannelMessageType
}

A summary of the messages in a channel.

type ChannelMessageType added in v0.30.0 

type ChannelMessageType string
const (
	ChannelMessageTypeStandard ChannelMessageType = "STANDARD"
	ChannelMessageTypeControl  ChannelMessageType = "CONTROL"
)

Enum values for ChannelMessageType

func (ChannelMessageType) Values added in v0.30.0 

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 added in v0.30.0 

type ChannelMode string
const (
	ChannelModeUnrestricted ChannelMode = "UNRESTRICTED"
	ChannelModeRestricted   ChannelMode = "RESTRICTED"
)

Enum values for ChannelMode

func (ChannelMode) Values added in v0.30.0 

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 added in v0.30.0 

type ChannelModeratedByAppInstanceUserSummary struct {

	// The summary data for a channel.
	ChannelSummary *ChannelSummary
}

Returns the summary data for a moderated channel.

type ChannelModerator added in v0.30.0 

type ChannelModerator struct {

	// The ARN of the moderator's channel.
	ChannelArn *string

	// The member who created the moderator.
	CreatedBy *Identity

	// The time at which the moderator was created.
	CreatedTimestamp *time.Time

	// The moderator's data.
	Moderator *Identity
}

Creates a moderator on a channel.

type ChannelModeratorSummary added in v0.30.0 

type ChannelModeratorSummary struct {

	// The data for a moderator.
	Moderator *Identity
}

Summary data of the moderators in a channel.

type ChannelPrivacy added in v0.30.0 

type ChannelPrivacy string
const (
	ChannelPrivacyPublic  ChannelPrivacy = "PUBLIC"
	ChannelPrivacyPrivate ChannelPrivacy = "PRIVATE"
)

Enum values for ChannelPrivacy

func (ChannelPrivacy) Values added in v0.30.0 

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 ChannelRetentionSettings added in v0.30.0 

type ChannelRetentionSettings struct {

	// The time in days to retain a channel.
	RetentionDays *int32
}

The retention settings for a channel.

type ChannelSummary added in v0.30.0 

type ChannelSummary struct {

	// The ARN of the channel summary.
	ChannelArn *string

	// The time at which the last message in a channel was sent.
	LastMessageTimestamp *time.Time

	// The metadata of the channel summary.
	Metadata *string

	// The summary mode of the channel.
	Mode ChannelMode

	// The parameter of the action.
	Name *string

	// The privacy setting of the channel being summarized, PUBLIC or HIDDEN.
	Privacy ChannelPrivacy
}

The summary data for a channel.

type ConflictException 

type ConflictException struct {
	Message *string

	Code ErrorCode
}

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 chat conversation messages.
	RetentionDays *int32
}

The retention settings that determine how long to retain chat conversation messages for an Amazon Chime Enterprise account.

type CreateAttendeeError 

type CreateAttendeeError struct {

	// The error code.
	ErrorCode *string

	// The error message.
	ErrorMessage *string

	// The Amazon Chime SDK external user ID. An idempotency token. Links the attendee
	// to an identity managed by a builder application. If you create an attendee with
	// the same external user id, the service returns the existing record.
	ExternalUserId *string
}

The list of errors returned when errors are encountered during the BatchCreateAttendee and CreateAttendee actions. This includes external user IDs, error codes, and error messages.

type CreateAttendeeRequestItem 

type CreateAttendeeRequestItem struct {

	// The Amazon Chime SDK external user ID. An idempotency token. Links the attendee
	// to an identity managed by a builder application. If you create an attendee with
	// the same external user id, the service returns the existing record. The Amazon
	// Chime SDK external user ID. Links the attendee to an identity managed by a
	// builder application.
	//
	// This member is required.
	ExternalUserId *string

	// The tag key-value pairs.
	Tags []Tag
}

The Amazon Chime SDK attendee fields to create, used with the BatchCreateAttendee action.

type Credential 

type Credential struct {

	// The RFC2617 compliant password associated with the SIP credentials, in US-ASCII
	// format.
	Password *string

	// The RFC2617 compliant user name associated with the SIP credentials, in US-ASCII
	// format.
	Username *string
}

The SIP credentials used to authenticate requests to your Amazon Chime Voice Connector.

type DNISEmergencyCallingConfiguration 

type DNISEmergencyCallingConfiguration struct {

	// The country from which emergency calls are allowed, in ISO 3166-1 alpha-2
	// format.
	//
	// This member is required.
	CallingCountry *string

	// The DNIS phone number to route emergency calls to, in E.164 format.
	//
	// This member is required.
	EmergencyPhoneNumber *string

	// The DNIS phone number to route test emergency calls to, in E.164 format.
	TestPhoneNumber *string
}

The Dialed Number Identification Service (DNIS) emergency calling configuration details associated with an Amazon Chime Voice Connector's emergency calling configuration.

type EmailStatus 

type EmailStatus string
const (
	EmailStatusNotSent EmailStatus = "NotSent"
	EmailStatusSent    EmailStatus = "Sent"
	EmailStatusFailed  EmailStatus = "Failed"
)

Enum values for EmailStatus

func (EmailStatus) Values added in v0.29.0 

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 EmergencyCallingConfiguration 

type EmergencyCallingConfiguration struct {

	// The Dialed Number Identification Service (DNIS) emergency calling configuration
	// details.
	DNIS []DNISEmergencyCallingConfiguration
}

The emergency calling configuration details associated with an Amazon Chime Voice Connector.

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"
	ErrorCodeServiceUnavailable                   ErrorCode = "ServiceUnavailable"
	ErrorCodeThrottled                            ErrorCode = "Throttled"
	ErrorCodeThrottling                           ErrorCode = "Throttling"
	ErrorCodeUnauthorized                         ErrorCode = "Unauthorized"
	ErrorCodeUnprocessable                        ErrorCode = "Unprocessable"
	ErrorCodeVoiceConnectorGroupAssociationsExist ErrorCode = "VoiceConnectorGroupAssociationsExist"
	ErrorCodePhoneNumberAssociationsExist         ErrorCode = "PhoneNumberAssociationsExist"
)

Enum values for ErrorCode

func (ErrorCode) Values added in v0.29.0 

func (ErrorCode) Values() []ErrorCode

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
}

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

	Code ErrorCode
}

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 GeoMatchLevel 

type GeoMatchLevel string
const (
	GeoMatchLevelCountry  GeoMatchLevel = "Country"
	GeoMatchLevelAreaCode GeoMatchLevel = "AreaCode"
)

Enum values for GeoMatchLevel

func (GeoMatchLevel) Values added in v0.29.0 

func (GeoMatchLevel) Values() []GeoMatchLevel

Values returns all known values for GeoMatchLevel. 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 GeoMatchParams 

type GeoMatchParams struct {

	// The area code.
	//
	// This member is required.
	AreaCode *string

	// The country.
	//
	// This member is required.
	Country *string
}

The country and area code for a proxy phone number in a proxy phone session.

type Identity added in v0.30.0 

type Identity struct {

	// The ARN in an Identity.
	Arn *string

	// The name in an Identity.
	Name *string
}

The ARN and name of a user.

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
}

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 added in v0.29.0 

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 added in v0.29.0 

func (License) Values() []License

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 LoggingConfiguration 

type LoggingConfiguration struct {

	// When true, enables SIP message logs for sending to Amazon CloudWatch Logs.
	EnableSIPLogs *bool
}

The logging configuration associated with an Amazon Chime Voice Connector. Specifies whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.

type MediaPlacement 

type MediaPlacement struct {

	// The audio fallback URL.
	AudioFallbackUrl *string

	// The audio host URL.
	AudioHostUrl *string

	// The screen data URL.
	ScreenDataUrl *string

	// The screen sharing URL.
	ScreenSharingUrl *string

	// The screen viewing URL.
	ScreenViewingUrl *string

	// The signaling URL.
	SignalingUrl *string

	// The turn control URL.
	TurnControlUrl *string
}

A set of endpoints used by clients to connect to the media service group for a Amazon Chime SDK meeting.

type Meeting 

type Meeting struct {

	// The external meeting ID.
	ExternalMeetingId *string

	// The media placement for the meeting.
	MediaPlacement *MediaPlacement

	// The Region in which to create the meeting. Available values: af-south-1,
	// ap-northeast-1, ap-northeast-2, ap-south-1, ap-southeast-1, ap-southeast-2,
	// ca-central-1, eu-central-1, eu-north-1, eu-south-1, eu-west-1, eu-west-2,
	// eu-west-3, sa-east-1, us-east-1, us-east-2, us-west-1, us-west-2.
	MediaRegion *string

	// The Amazon Chime SDK meeting ID.
	MeetingId *string
}

A meeting created using the Amazon Chime SDK.

type MeetingNotificationConfiguration 

type MeetingNotificationConfiguration struct {

	// The SNS topic ARN.
	SnsTopicArn *string

	// The SQS queue ARN.
	SqsQueueArn *string
}

The configuration for resource targets to receive notifications when Amazon Chime SDK meeting and attendee events occur. The Amazon Chime SDK supports resource targets located in the US East (N. Virginia) AWS Region (us-east-1).

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
}

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
}

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 added in v0.29.0 

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
}

Membership details, such as member ID and member role.

type MessagingSessionEndpoint added in v0.30.0 

type MessagingSessionEndpoint struct {

	// The URL of a meeting session endpoint.
	Url *string
}

The endpoint of a meeting session.

type NotFoundException 

type NotFoundException struct {
	Message *string

	Code ErrorCode
}

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 NotificationTarget 

type NotificationTarget string
const (
	NotificationTargetEventBridge NotificationTarget = "EventBridge"
	NotificationTargetSns         NotificationTarget = "SNS"
	NotificationTargetSqs         NotificationTarget = "SQS"
)

Enum values for NotificationTarget

func (NotificationTarget) Values added in v0.29.0 

func (NotificationTarget) Values() []NotificationTarget

Values returns all known values for NotificationTarget. 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 NumberSelectionBehavior 

type NumberSelectionBehavior string
const (
	NumberSelectionBehaviorPreferSticky NumberSelectionBehavior = "PreferSticky"
	NumberSelectionBehaviorAvoidSticky  NumberSelectionBehavior = "AvoidSticky"
)

Enum values for NumberSelectionBehavior

func (NumberSelectionBehavior) Values added in v0.29.0 

func (NumberSelectionBehavior) Values() []NumberSelectionBehavior

Values returns all known values for NumberSelectionBehavior. 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 OrderedPhoneNumber 

type OrderedPhoneNumber struct {

	// The phone number, in E.164 format.
	E164PhoneNumber *string

	// The phone number status.
	Status OrderedPhoneNumberStatus
}

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 added in v0.29.0 

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 Origination 

type Origination struct {

	// When origination settings are disabled, inbound calls are not enabled for your
	// Amazon Chime Voice Connector.
	Disabled *bool

	// The call distribution properties defined for your SIP hosts. Valid range:
	// Minimum value of 1. Maximum value of 20.
	Routes []OriginationRoute
}

Origination settings enable your SIP hosts to receive inbound calls using your Amazon Chime Voice Connector.

type OriginationRoute 

type OriginationRoute struct {

	// The FQDN or IP address to contact for origination traffic.
	Host *string

	// The designated origination route port. Defaults to 5060.
	Port *int32

	// The priority associated with the host, with 1 being the highest priority. Higher
	// priority hosts are attempted first.
	Priority *int32

	// The protocol to use for the origination route. Encryption-enabled Amazon Chime
	// Voice Connectors use TCP protocol by default.
	Protocol OriginationRouteProtocol

	// The weight associated with the host. If hosts are equal in priority, calls are
	// distributed among them based on their relative weight.
	Weight *int32
}

Origination routes define call distribution properties for your SIP hosts to receive inbound calls using your Amazon Chime Voice Connector. Limit: Ten origination routes for each Amazon Chime Voice Connector.

type OriginationRouteProtocol 

type OriginationRouteProtocol string
const (
	OriginationRouteProtocolTcp OriginationRouteProtocol = "TCP"
	OriginationRouteProtocolUdp OriginationRouteProtocol = "UDP"
)

Enum values for OriginationRouteProtocol

func (OriginationRouteProtocol) Values added in v0.29.0 

func (OriginationRouteProtocol) Values() []OriginationRouteProtocol

Values returns all known values for OriginationRouteProtocol. 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 Participant 

type Participant struct {

	// The participant's phone number.
	PhoneNumber *string

	// The participant's proxy phone number.
	ProxyPhoneNumber *string
}

The phone number and proxy phone number for a participant in an Amazon Chime Voice Connector proxy session.

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

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
}

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 added in v0.29.0 

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
}

The phone number capabilities for Amazon Chime Business Calling phone numbers, such as enabled inbound and outbound calling and text messaging.

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
}

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 timestamp, 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 timestamp, in ISO 8601 format.
	UpdatedTimestamp *time.Time
}

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 added in v0.29.0 

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"
)

Enum values for PhoneNumberProductType

func (PhoneNumberProductType) Values added in v0.29.0 

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 added in v0.29.0 

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 added in v0.29.0 

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 Proxy 

type Proxy struct {

	// The default number of minutes allowed for proxy sessions.
	DefaultSessionExpiryMinutes *int32

	// When true, stops proxy sessions from being created on the specified Amazon Chime
	// Voice Connector.
	Disabled *bool

	// The phone number to route calls to after a proxy session expires.
	FallBackPhoneNumber *string

	// The countries for proxy phone numbers to be selected from.
	PhoneNumberCountries []string
}

The proxy configuration for an Amazon Chime Voice Connector.

type ProxySession 

type ProxySession struct {

	// The proxy session capabilities.
	Capabilities []Capability

	// The created timestamp, in ISO 8601 format.
	CreatedTimestamp *time.Time

	// The ended timestamp, in ISO 8601 format.
	EndedTimestamp *time.Time

	// The number of minutes allowed for the proxy session.
	ExpiryMinutes *int32

	// The preference for matching the country or area code of the proxy phone number
	// with that of the first participant.
	GeoMatchLevel GeoMatchLevel

	// The country and area code for the proxy phone number.
	GeoMatchParams *GeoMatchParams

	// The name of the proxy session.
	Name *string

	// The preference for proxy phone number reuse, or stickiness, between the same
	// participants across sessions.
	NumberSelectionBehavior NumberSelectionBehavior

	// The proxy session participants.
	Participants []Participant

	// The proxy session ID.
	ProxySessionId *string

	// The status of the proxy session.
	Status ProxySessionStatus

	// The updated timestamp, in ISO 8601 format.
	UpdatedTimestamp *time.Time

	// The Amazon Chime voice connector ID.
	VoiceConnectorId *string
}

The proxy session for an Amazon Chime Voice Connector.

type ProxySessionStatus 

type ProxySessionStatus string
const (
	ProxySessionStatusOpen       ProxySessionStatus = "Open"
	ProxySessionStatusInProgress ProxySessionStatus = "InProgress"
	ProxySessionStatusClosed     ProxySessionStatus = "Closed"
)

Enum values for ProxySessionStatus

func (ProxySessionStatus) Values added in v0.29.0 

func (ProxySessionStatus) Values() []ProxySessionStatus

Values returns all known values for ProxySessionStatus. 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 added in v0.29.0 

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

	Code ErrorCode
}

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
}

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
}

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
}

The room membership details.

type RoomMembershipRole 

type RoomMembershipRole string
const (
	RoomMembershipRoleAdministrator RoomMembershipRole = "Administrator"
	RoomMembershipRoleMember        RoomMembershipRole = "Member"
)

Enum values for RoomMembershipRole

func (RoomMembershipRole) Values added in v0.29.0 

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
}

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

	Code ErrorCode
}

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 {
	Message *string

	Code ErrorCode
}

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
}

An Active Directory (AD) group whose members are granted permission to act as delegates.

type SipMediaApplication added in v0.30.0 

type SipMediaApplication struct {

	// The AWS Region in which the SIP media application is created.
	AwsRegion *string

	// The SIP media application creation timestamp, in ISO 8601 format.
	CreatedTimestamp *time.Time

	// List of endpoints for SIP media application. Currently, only one endpoint per
	// SIP media application is permitted.
	Endpoints []SipMediaApplicationEndpoint

	// The name of the SIP media application.
	Name *string

	// The SIP media application ID.
	SipMediaApplicationId *string

	// The SIP media application updated timestamp, in ISO 8601 format.
	UpdatedTimestamp *time.Time
}

The SIP media application details, including name and endpoints. An AWS account can have multiple SIP media applications.

type SipMediaApplicationCall added in v0.30.0 

type SipMediaApplicationCall struct {

	// The transaction ID of a call.
	TransactionId *string
}

A Call instance for a SIP media application.

type SipMediaApplicationEndpoint added in v0.30.0 

type SipMediaApplicationEndpoint struct {

	// Valid Amazon Resource Name (ARN) of the Lambda function of the same AWS Region
	// where the SIP media application is created.
	LambdaArn *string
}

Endpoints to specify as part of a SIP media application.

type SipMediaApplicationLoggingConfiguration added in v0.30.0 

type SipMediaApplicationLoggingConfiguration struct {

	// Enables application message logs for the SIP media application.
	EnableSipMediaApplicationMessageLogs *bool
}

Logging configuration of the SIP media application.

type SipRule added in v0.30.0 

type SipRule struct {

	// The SIP rule created timestamp, in ISO 8601 format.
	CreatedTimestamp *time.Time

	// Indicates if the SIP rule is enabled or disabled. You must disable a rule before
	// you can delete it.
	Disabled *bool

	// The name of the SIP rule.
	Name *string

	// The SIP rule ID.
	SipRuleId *string

	// List of SIP media applications with priority and AWS Region. You can only use
	// one SIP application per AWS Region and priority combination.
	TargetApplications []SipRuleTargetApplication

	// The type of trigger whose value is assigned to the SIP rule in TriggerValue.
	TriggerType SipRuleTriggerType

	// If TriggerType is RequestUriHostname, then the value can be the outbound host
	// name of the Amazon Chime Voice Connector. If TriggerType is ToPhoneNumber, then
	// the value can be a customer-owned phone number in E164 format. SipRule is
	// triggered when a SIP rule requests host name or ToPhoneNumber matches in the
	// incoming SIP request.
	TriggerValue *string

	// The SIP rule updated timestamp, in ISO 8601 format.
	UpdatedTimestamp *time.Time
}

The SIP rule details, including name, triggers, and target applications. An AWS account can have multiple SIP rules.

type SipRuleTargetApplication added in v0.30.0 

type SipRuleTargetApplication struct {

	// AWS Region of target application.
	AwsRegion *string

	// Priority of the SIP media application in the target list.
	Priority *int32

	// The SIP media application ID.
	SipMediaApplicationId *string
}

Target SIP media application along with other details like priority and AWS Region to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.

type SipRuleTriggerType added in v0.30.0 

type SipRuleTriggerType string
const (
	SipRuleTriggerTypeToPhoneNumber      SipRuleTriggerType = "ToPhoneNumber"
	SipRuleTriggerTypeRequestUriHostname SipRuleTriggerType = "RequestUriHostname"
)

Enum values for SipRuleTriggerType

func (SipRuleTriggerType) Values added in v0.30.0 

func (SipRuleTriggerType) Values() []SipRuleTriggerType

Values returns all known values for SipRuleTriggerType. 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 SortOrder added in v0.30.0 

type SortOrder string
const (
	SortOrderAscending  SortOrder = "ASCENDING"
	SortOrderDescending SortOrder = "DESCENDING"
)

Enum values for SortOrder

func (SortOrder) Values added in v0.30.0 

func (SortOrder) Values() []SortOrder

Values returns all known values for SortOrder. 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 StreamingConfiguration 

type StreamingConfiguration struct {

	// The retention period, in hours, for the Amazon Kinesis data.
	//
	// This member is required.
	DataRetentionInHours *int32

	// When true, media streaming to Amazon Kinesis is turned off.
	Disabled *bool

	// The streaming notification targets.
	StreamingNotificationTargets []StreamingNotificationTarget
}

The streaming configuration associated with an Amazon Chime Voice Connector. Specifies whether media streaming is enabled for sending to Amazon Kinesis, and shows the retention period for the Amazon Kinesis data, in hours.

type StreamingNotificationTarget 

type StreamingNotificationTarget struct {

	// The streaming notification target.
	//
	// This member is required.
	NotificationTarget NotificationTarget
}

The targeted recipient for a streaming configuration notification.

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
}

Describes a tag applied to a resource.

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
}

Settings that allow management of telephony permissions for an Amazon Chime user, such as inbound and outbound calling and text messaging.

type Termination 

type Termination struct {

	// The countries to which calls are allowed, in ISO 3166-1 alpha-2 format.
	// Required.
	CallingRegions []string

	// The IP addresses allowed to make calls, in CIDR format. Required.
	CidrAllowedList []string

	// The limit on calls per second. Max value based on account service quota. Default
	// value of 1.
	CpsLimit *int32

	// The default caller ID phone number.
	DefaultPhoneNumber *string

	// When termination settings are disabled, outbound calls can not be made.
	Disabled *bool
}

Termination settings enable your SIP hosts to make outbound calls using your Amazon Chime Voice Connector.

type TerminationHealth 

type TerminationHealth struct {

	// The source IP address.
	Source *string

	// The timestamp, in ISO 8601 format.
	Timestamp *time.Time
}

The termination health details, including the source IP address and timestamp of the last successful SIP OPTIONS message from your SIP infrastructure.

type ThrottledClientException 

type ThrottledClientException struct {
	Message *string

	Code ErrorCode
}

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 {
	Message *string

	Code ErrorCode
}

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

	Code ErrorCode
}

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
}

The phone number ID, product type, or calling name fields to update, used with the BatchUpdatePhoneNumber and 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
}

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
}

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
}

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
}

Settings associated with an Amazon Chime user, including inbound and outbound calling and text messaging.

type UserType 

type UserType string
const (
	UserTypePrivateUser  UserType = "PrivateUser"
	UserTypeSharedDevice UserType = "SharedDevice"
)

Enum values for UserType

func (UserType) Values added in v0.29.0 

func (UserType) Values() []UserType

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 VoiceConnector 

type VoiceConnector struct {

	// The AWS Region in which the Amazon Chime Voice Connector is created. Default:
	// us-east-1.
	AwsRegion VoiceConnectorAwsRegion

	// The Amazon Chime Voice Connector creation timestamp, in ISO 8601 format.
	CreatedTimestamp *time.Time

	// The name of the Amazon Chime Voice Connector.
	Name *string

	// The outbound host name for the Amazon Chime Voice Connector.
	OutboundHostName *string

	// Designates whether encryption is required for the Amazon Chime Voice Connector.
	RequireEncryption *bool

	// The updated Amazon Chime Voice Connector timestamp, in ISO 8601 format.
	UpdatedTimestamp *time.Time

	// The Amazon Chime Voice Connector ID.
	VoiceConnectorId *string
}

The Amazon Chime Voice Connector configuration, including outbound host name and encryption settings.

type VoiceConnectorAwsRegion 

type VoiceConnectorAwsRegion string
const (
	VoiceConnectorAwsRegionUsEast1 VoiceConnectorAwsRegion = "us-east-1"
	VoiceConnectorAwsRegionUsWest2 VoiceConnectorAwsRegion = "us-west-2"
)

Enum values for VoiceConnectorAwsRegion

func (VoiceConnectorAwsRegion) Values added in v0.29.0 

func (VoiceConnectorAwsRegion) Values() []VoiceConnectorAwsRegion

Values returns all known values for VoiceConnectorAwsRegion. 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 VoiceConnectorGroup 

type VoiceConnectorGroup struct {

	// The Amazon Chime Voice Connector group creation timestamp, in ISO 8601 format.
	CreatedTimestamp *time.Time

	// The name of the Amazon Chime Voice Connector group.
	Name *string

	// The updated Amazon Chime Voice Connector group timestamp, in ISO 8601 format.
	UpdatedTimestamp *time.Time

	// The Amazon Chime Voice Connector group ID.
	VoiceConnectorGroupId *string

	// The Amazon Chime Voice Connectors to which to route inbound calls.
	VoiceConnectorItems []VoiceConnectorItem
}

The Amazon Chime Voice Connector group configuration, including associated Amazon Chime Voice Connectors. You can include Amazon Chime Voice Connectors from different AWS Regions in your group. This creates a fault tolerant mechanism for fallback in case of availability events.

type VoiceConnectorItem 

type VoiceConnectorItem struct {

	// The priority associated with the Amazon Chime Voice Connector, with 1 being the
	// highest priority. Higher priority Amazon Chime Voice Connectors are attempted
	// first.
	//
	// This member is required.
	Priority *int32

	// The Amazon Chime Voice Connector ID.
	//
	// This member is required.
	VoiceConnectorId *string
}

For Amazon Chime Voice Connector groups, the Amazon Chime Voice Connectors to which to route inbound calls. Includes priority configuration settings. Limit: 3 VoiceConnectorItems per Amazon Chime Voice Connector group.

type VoiceConnectorSettings 

type VoiceConnectorSettings struct {

	// The Amazon S3 bucket designated for call detail record storage.
	CdrBucket *string
}

The Amazon Chime Voice Connector settings. Includes any Amazon S3 buckets designated for storing call detail records.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.