types

package
v1.17.8 Latest Latest
Warning

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

Go to latest
Published: Sep 17, 2024 License: Apache-2.0 Imports: 4 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

	ErrorCodeOverride *string

	Code ErrorCode
	// contains filtered or unexported fields
}

You don't have the permissions needed to run this action.

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 Address

type Address struct {

	// The city of an address.
	City *string

	// The country of an address.
	Country *string

	// An address suffix location, such as the S. Unit A in Central Park S. Unit A .
	PostDirectional *string

	// The postal code of an address.
	PostalCode *string

	// The zip + 4 or postal code + 4 of an address.
	PostalCodePlus4 *string

	// An address prefix location, such as the N in N. Third St.
	PreDirectional *string

	// The state of an address.
	State *string

	// The address street, such as 8th Avenue .
	StreetName *string

	// The numeric portion of an address.
	StreetNumber *string

	// The address suffix, such as the N in 8th Avenue N .
	StreetSuffix *string
	// contains filtered or unexported fields
}

A validated address.

type AlexaSkillStatus

type AlexaSkillStatus string
const (
	AlexaSkillStatusActive   AlexaSkillStatus = "ACTIVE"
	AlexaSkillStatusInactive AlexaSkillStatus = "INACTIVE"
)

Enum values for AlexaSkillStatus

func (AlexaSkillStatus) Values

Values returns all known values for AlexaSkillStatus. 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 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 CallDetails added in v1.3.0

type CallDetails struct {

	// Identifies a person as the caller or the callee.
	IsCaller *bool

	// The transaction ID of a Voice Connector call.
	TransactionId *string

	// The Voice Connector ID.
	VoiceConnectorId *string
	// contains filtered or unexported fields
}

The details of an Amazon Chime SDK Voice Connector call.

type CallLegType added in v1.6.0

type CallLegType string
const (
	CallLegTypeCaller CallLegType = "Caller"
	CallLegTypeCallee CallLegType = "Callee"
)

Enum values for CallLegType

func (CallLegType) Values added in v1.6.0

func (CallLegType) Values() []CallLegType

Values returns all known values for CallLegType. 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 CallingNameStatus

type CallingNameStatus string
const (
	CallingNameStatusUnassigned       CallingNameStatus = "Unassigned"
	CallingNameStatusUpdateInProgress CallingNameStatus = "UpdateInProgress"
	CallingNameStatusUpdateSucceeded  CallingNameStatus = "UpdateSucceeded"
	CallingNameStatusUpdateFailed     CallingNameStatus = "UpdateFailed"
)

Enum values for CallingNameStatus

func (CallingNameStatus) Values

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 CandidateAddress

type CandidateAddress struct {

	// The city of the candidate address.
	City *string

	// The country of the candidate address.
	Country *string

	// The postal code of the candidate address.
	PostalCode *string

	// The zip + 4 or postal code +4 of the candidate address.
	PostalCodePlus4 *string

	// The state of the candidate address.
	State *string

	// The street information of the candidate address.
	StreetInfo *string

	// The numeric portion of the candidate address.
	StreetNumber *string
	// contains filtered or unexported fields
}

A suggested address.

type Capability

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

Enum values for Capability

func (Capability) Values

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 ConflictException

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string

	Code ErrorCode
	// contains filtered or unexported fields
}

Multiple instances of the same request were made simultaneously.

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 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
	// contains filtered or unexported fields
}

The SIP credentials used to authenticate requests to an Amazon Chime SDK 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 that you route emergency calls to, in E.164 format.
	//
	// This member is required.
	EmergencyPhoneNumber *string

	// The DNIS phone number for routing test emergency calls to, in E.164 format.
	TestPhoneNumber *string
	// contains filtered or unexported fields
}

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

type EmergencyCallingConfiguration

type EmergencyCallingConfiguration struct {

	// The Dialed Number Identification Service (DNIS) emergency calling configuration
	// details.
	DNIS []DNISEmergencyCallingConfiguration
	// contains filtered or unexported fields
}

The emergency calling configuration details associated with an Amazon Chime SDK 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"
	ErrorCodeGone                                 ErrorCode = "Gone"
)

Enum values for ErrorCode

func (ErrorCode) Values

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

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

Enum values for GeoMatchLevel

func (GeoMatchLevel) Values

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
	// contains filtered or unexported fields
}

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

type GoneException added in v1.3.0

type GoneException struct {
	Message *string

	ErrorCodeOverride *string

	Code ErrorCode
	// contains filtered or unexported fields
}

Access to the target resource is no longer available at the origin server. This condition is likely to be permanent.

func (*GoneException) Error added in v1.3.0

func (e *GoneException) Error() string

func (*GoneException) ErrorCode added in v1.3.0

func (e *GoneException) ErrorCode() string

func (*GoneException) ErrorFault added in v1.3.0

func (e *GoneException) ErrorFault() smithy.ErrorFault

func (*GoneException) ErrorMessage added in v1.3.0

func (e *GoneException) ErrorMessage() string

type LanguageCode added in v1.3.0

type LanguageCode string
const (
	LanguageCodeEnUs LanguageCode = "en-US"
)

Enum values for LanguageCode

func (LanguageCode) Values added in v1.3.0

func (LanguageCode) Values() []LanguageCode

Values returns all known values for LanguageCode. 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 {

	// Enables or disables media metrics logging.
	EnableMediaMetricLogs *bool

	// Boolean that enables sending SIP message logs to Amazon CloudWatch.
	EnableSIPLogs *bool
	// contains filtered or unexported fields
}

The logging configuration associated with an Amazon Chime SDK Voice Connector. Specifies whether SIP message logs can be sent to Amazon CloudWatch Logs.

type MediaInsightsConfiguration added in v1.3.0

type MediaInsightsConfiguration struct {

	// The configuration's ARN.
	ConfigurationArn *string

	// Denotes the configuration as enabled or disabled.
	Disabled *bool
	// contains filtered or unexported fields
}

The configuration for a call analytics task.

type NotFoundException

type NotFoundException struct {
	Message *string

	ErrorCodeOverride *string

	Code ErrorCode
	// contains filtered or unexported fields
}

The requested resource couldn't be found.

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

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

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

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 SDK Voice Connector. This parameter is not required, but you must
	// specify this parameter or Routes .
	Disabled *bool

	// The call distribution properties defined for your SIP hosts. Valid range:
	// Minimum value of 1. Maximum value of 20. This parameter is not required, but you
	// must specify this parameter or Disabled .
	Routes []OriginationRoute
	// contains filtered or unexported fields
}

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

The parameters listed below are not required, but you must use at least one.

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
	// SDK Voice Connectors use TCP protocol by default.
	Protocol OriginationRouteProtocol

	// The weight assigned to an origination route. When hosts have equal priority,
	// calls are distributed between them based on their relative weights.
	Weight *int32
	// contains filtered or unexported fields
}

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

The parameters listed below are not required, but you must use at least one.

type OriginationRouteProtocol

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

Enum values for OriginationRouteProtocol

func (OriginationRouteProtocol) Values

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
	// contains filtered or unexported fields
}

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

type PhoneNumber

type PhoneNumber struct {

	// The phone number's associations.
	Associations []PhoneNumberAssociation

	// The outbound calling name associated with the phone number.
	CallingName *string

	// The outbound calling name status.
	CallingNameStatus CallingNameStatus

	// The phone number's capabilities.
	Capabilities *PhoneNumberCapabilities

	// The phone number's 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 name of the phone number.
	Name *string

	// The phone number's order ID.
	OrderId *string

	// The phone number's ID.
	PhoneNumberId *string

	// The phone number's product type.
	ProductType PhoneNumberProductType

	// The phone number's status.
	Status PhoneNumberStatus

	// The phone number's type.
	Type PhoneNumberType

	// The updated phone number timestamp, in ISO 8601 format.
	UpdatedTimestamp *time.Time
	// contains filtered or unexported fields
}

A phone number used to call an Amazon Chime SDK 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 SDK account ID, user ID, Voice
	// Connector ID, or 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 an Amazon Chime SDK account ID, user ID, Voice Connector ID, or Voice Connector group ID.

type PhoneNumberAssociationName

type PhoneNumberAssociationName string
const (
	PhoneNumberAssociationNameVoiceConnectorId      PhoneNumberAssociationName = "VoiceConnectorId"
	PhoneNumberAssociationNameVoiceConnectorGroupId PhoneNumberAssociationName = "VoiceConnectorGroupId"
	PhoneNumberAssociationNameSipRuleId             PhoneNumberAssociationName = "SipRuleId"
)

Enum values for PhoneNumberAssociationName

func (PhoneNumberAssociationName) Values

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 inbound 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 SDK 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's 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 a phone number action fails for one or more of the phone numbers in a request, a list of the failed 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 type of phone number being ordered, local or toll-free.
	OrderType PhoneNumberOrderType

	// The ordered phone number details, such as the phone number in E.164 format and
	// the phone number status.
	OrderedPhoneNumbers []OrderedPhoneNumber

	// The ID of the phone order.
	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 an Amazon Chime SDK phone number order.

type PhoneNumberOrderStatus

type PhoneNumberOrderStatus string
const (
	PhoneNumberOrderStatusProcessing       PhoneNumberOrderStatus = "Processing"
	PhoneNumberOrderStatusSuccessful       PhoneNumberOrderStatus = "Successful"
	PhoneNumberOrderStatusFailed           PhoneNumberOrderStatus = "Failed"
	PhoneNumberOrderStatusPartial          PhoneNumberOrderStatus = "Partial"
	PhoneNumberOrderStatusPendingDocuments PhoneNumberOrderStatus = "PendingDocuments"
	PhoneNumberOrderStatusSubmitted        PhoneNumberOrderStatus = "Submitted"
	PhoneNumberOrderStatusFoc              PhoneNumberOrderStatus = "FOC"
	PhoneNumberOrderStatusChangeRequested  PhoneNumberOrderStatus = "ChangeRequested"
	PhoneNumberOrderStatusException        PhoneNumberOrderStatus = "Exception"
	PhoneNumberOrderStatusCancelRequested  PhoneNumberOrderStatus = "CancelRequested"
	PhoneNumberOrderStatusCancelled        PhoneNumberOrderStatus = "Cancelled"
)

Enum values for PhoneNumberOrderStatus

func (PhoneNumberOrderStatus) Values

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 PhoneNumberOrderType

type PhoneNumberOrderType string
const (
	PhoneNumberOrderTypeNew     PhoneNumberOrderType = "New"
	PhoneNumberOrderTypePorting PhoneNumberOrderType = "Porting"
)

Enum values for PhoneNumberOrderType

func (PhoneNumberOrderType) Values

Values returns all known values for PhoneNumberOrderType. 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 (
	PhoneNumberProductTypeVoiceConnector            PhoneNumberProductType = "VoiceConnector"
	PhoneNumberProductTypeSipMediaApplicationDialIn PhoneNumberProductType = "SipMediaApplicationDialIn"
)

Enum values for PhoneNumberProductType

func (PhoneNumberProductType) Values

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 (
	PhoneNumberStatusCancelled             PhoneNumberStatus = "Cancelled"
	PhoneNumberStatusPortinCancelRequested PhoneNumberStatus = "PortinCancelRequested"
	PhoneNumberStatusPortinInProgress      PhoneNumberStatus = "PortinInProgress"
	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

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 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 SDK 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
	// contains filtered or unexported fields
}

The proxy configuration for an Amazon Chime SDK Voice Connector.

type ProxySession

type ProxySession struct {

	// The proxy session capabilities.
	Capabilities []Capability

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

	// The ended time stamp, 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 proxy session name.
	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 proxy session status.
	Status ProxySessionStatus

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

	// The Voice Connector ID.
	VoiceConnectorId *string
	// contains filtered or unexported fields
}

The proxy session for an Amazon Chime SDK Voice Connector.

type ProxySessionStatus

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

Enum values for ProxySessionStatus

func (ProxySessionStatus) Values

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 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 (*ResourceLimitExceededException) ErrorCode

func (e *ResourceLimitExceededException) ErrorCode() string

func (*ResourceLimitExceededException) ErrorFault

func (*ResourceLimitExceededException) ErrorMessage

func (e *ResourceLimitExceededException) ErrorMessage() string

type ServerSideEncryptionConfiguration added in v1.3.0

type ServerSideEncryptionConfiguration struct {

	// The ARN of the KMS key used to encrypt the enrollment data in a voice profile
	// domain. Asymmetric customer managed keys are not supported.
	//
	// This member is required.
	KmsKeyArn *string
	// contains filtered or unexported fields
}

A structure that contains the configuration settings for server-side encryption.

We only support symmetric keys. Do not use asymmetric or HMAC keys, or KMS aliases.

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

	ErrorCodeOverride *string

	Code ErrorCode
	// contains filtered or unexported fields
}

The service is currently unavailable.

func (*ServiceUnavailableException) Error

func (*ServiceUnavailableException) ErrorCode

func (e *ServiceUnavailableException) ErrorCode() string

func (*ServiceUnavailableException) ErrorFault

func (*ServiceUnavailableException) ErrorMessage

func (e *ServiceUnavailableException) ErrorMessage() string

type SipMediaApplication

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 a SIP media application. Currently, only one endpoint per
	// SIP media application is permitted.
	Endpoints []SipMediaApplicationEndpoint

	// The SIP media application's name.
	Name *string

	// The ARN of the SIP media application.
	SipMediaApplicationArn *string

	// A SIP media application's ID.
	SipMediaApplicationId *string

	// The time at which the SIP media application was updated.
	UpdatedTimestamp *time.Time
	// contains filtered or unexported fields
}

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

type SipMediaApplicationAlexaSkillConfiguration

type SipMediaApplicationAlexaSkillConfiguration struct {

	// The ID of the Alexa Skill configuration.
	//
	// This member is required.
	AlexaSkillIds []string

	// The status of the Alexa Skill configuration.
	//
	// This member is required.
	AlexaSkillStatus AlexaSkillStatus
	// contains filtered or unexported fields
}

The Alexa Skill configuration of a SIP media application.

Due to changes made by the Amazon Alexa service, this data type is no longer available for use. For more information, refer to the Alexa Smart Propertiespage.

type SipMediaApplicationCall

type SipMediaApplicationCall struct {

	// The call's transaction ID.
	TransactionId *string
	// contains filtered or unexported fields
}

A Call instance for a SIP media application.

type SipMediaApplicationEndpoint

type SipMediaApplicationEndpoint struct {

	// Valid Amazon Resource Name (ARN) of the Lambda function, version, or alias. The
	// function must be created in the same AWS Region as the SIP media application.
	LambdaArn *string
	// contains filtered or unexported fields
}

The endpoint assigned to a SIP media application.

type SipMediaApplicationLoggingConfiguration

type SipMediaApplicationLoggingConfiguration struct {

	// Enables message logging for the specified SIP media application.
	EnableSipMediaApplicationMessageLogs *bool
	// contains filtered or unexported fields
}

The logging configuration of a SIP media application.

type SipRule

type SipRule struct {

	// The time at which the SIP rule was created, in ISO 8601 format.
	CreatedTimestamp *time.Time

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

	// A SIP rule's name.
	Name *string

	// A SIP rule's ID.
	SipRuleId *string

	// The target SIP media application and other details, such as priority and AWS
	// Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be
	// provided.
	TargetApplications []SipRuleTargetApplication

	// The type of trigger set for a SIP rule, either a phone number or a URI request
	// host name.
	TriggerType SipRuleTriggerType

	// The value set for a SIP rule's trigger type. Either a phone number or a URI
	// hostname.
	TriggerValue *string

	// The time at which the SIP rule was updated, in ISO 8601 format.
	UpdatedTimestamp *time.Time
	// contains filtered or unexported fields
}

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

type SipRuleTargetApplication

type SipRuleTargetApplication struct {

	// The AWS Region of a rule's target SIP media application.
	AwsRegion *string

	// The priority setting of a rule's target SIP media application.
	Priority *int32

	// The ID of a rule's target SIP media application.
	SipMediaApplicationId *string
	// contains filtered or unexported fields
}

A target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.

type SipRuleTriggerType

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

Enum values for SipRuleTriggerType

func (SipRuleTriggerType) Values

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 SpeakerSearchDetails added in v1.3.0

type SpeakerSearchDetails struct {

	// The result value in the speaker search details.
	Results []SpeakerSearchResult

	// The status of a voice print generation operation, VoiceprintGenerationSuccess
	// or VoiceprintGenerationFailure ..
	VoiceprintGenerationStatus *string
	// contains filtered or unexported fields
}

The details of a speaker search task.

type SpeakerSearchResult added in v1.3.0

type SpeakerSearchResult struct {

	// The confidence score in the speaker search analysis.
	ConfidenceScore float32

	// The voice profile ID.
	VoiceProfileId *string
	// contains filtered or unexported fields
}

The result of a speaker search analysis.

type SpeakerSearchTask added in v1.3.0

type SpeakerSearchTask struct {

	// The call details of a speaker search task.
	CallDetails *CallDetails

	// The time at which a speaker search task was created.
	CreatedTimestamp *time.Time

	// The details of a speaker search task.
	SpeakerSearchDetails *SpeakerSearchDetails

	// The speaker search task ID.
	SpeakerSearchTaskId *string

	// The status of the speaker search task, IN_QUEUE , IN_PROGRESS , PARTIAL_SUCCESS
	// , SUCCEEDED , FAILED , or STOPPED .
	SpeakerSearchTaskStatus *string

	// The time at which the speaker search task began.
	StartedTimestamp *time.Time

	// A detailed message about the status of a speaker search.
	StatusMessage *string

	// The time at which a speaker search task was updated.
	UpdatedTimestamp *time.Time
	// contains filtered or unexported fields
}

A representation of an asynchronous request to perform speaker search analysis on a Voice Connector call.

type StreamingConfiguration

type StreamingConfiguration struct {

	// The amount of time, in hours, to the Kinesis data.
	//
	// This member is required.
	DataRetentionInHours *int32

	// When true, streaming to Kinesis is off.
	//
	// This member is required.
	Disabled *bool

	// The call analytics configuration.
	MediaInsightsConfiguration *MediaInsightsConfiguration

	// The streaming notification targets.
	StreamingNotificationTargets []StreamingNotificationTarget
	// contains filtered or unexported fields
}

The streaming configuration associated with an Amazon Chime SDK 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.
	NotificationTarget NotificationTarget
	// contains filtered or unexported fields
}

The target recipient for a streaming configuration notification.

type Tag added in v1.3.0

type Tag struct {

	// The tag's key.
	//
	// This member is required.
	Key *string

	// The tag's value.
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

Describes a tag applied to a resource.

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.
	CidrAllowedList []string

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

	// The default outbound calling number.
	DefaultPhoneNumber *string

	// When termination is disabled, outbound calls cannot be made.
	Disabled *bool
	// contains filtered or unexported fields
}

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

type TerminationHealth

type TerminationHealth struct {

	// The source IP address.
	Source *string

	// The timestamp, in ISO 8601 format.
	Timestamp *time.Time
	// contains filtered or unexported fields
}

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

	ErrorCodeOverride *string

	Code ErrorCode
	// contains filtered or unexported fields
}

The number of customer requests exceeds the 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

	ErrorCodeOverride *string

	Code ErrorCode
	// contains filtered or unexported fields
}

The client isn't authorized to request a resource.

func (*UnauthorizedClientException) Error

func (*UnauthorizedClientException) ErrorCode

func (e *UnauthorizedClientException) ErrorCode() string

func (*UnauthorizedClientException) ErrorFault

func (*UnauthorizedClientException) ErrorMessage

func (e *UnauthorizedClientException) ErrorMessage() string

type UnprocessableEntityException added in v1.3.0

type UnprocessableEntityException struct {
	Message *string

	ErrorCodeOverride *string

	Code ErrorCode
	// contains filtered or unexported fields
}

A well-formed request couldn't be followed due to semantic errors.

func (*UnprocessableEntityException) Error added in v1.3.0

func (*UnprocessableEntityException) ErrorCode added in v1.3.0

func (e *UnprocessableEntityException) ErrorCode() string

func (*UnprocessableEntityException) ErrorFault added in v1.3.0

func (*UnprocessableEntityException) ErrorMessage added in v1.3.0

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 name of the phone number.
	Name *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 VoiceConnector

type VoiceConnector struct {

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

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

	// The Voice Connector's name.
	Name *string

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

	// Enables or disables encryption for the Voice Connector.
	RequireEncryption *bool

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

	// The ARN of the Voice Connector.
	VoiceConnectorArn *string

	// The Voice Connector's ID.
	VoiceConnectorId *string
	// contains filtered or unexported fields
}

The Amazon Chime SDK 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"
	VoiceConnectorAwsRegionCaCentral1   VoiceConnectorAwsRegion = "ca-central-1"
	VoiceConnectorAwsRegionEuCentral1   VoiceConnectorAwsRegion = "eu-central-1"
	VoiceConnectorAwsRegionEuWest1      VoiceConnectorAwsRegion = "eu-west-1"
	VoiceConnectorAwsRegionEuWest2      VoiceConnectorAwsRegion = "eu-west-2"
	VoiceConnectorAwsRegionApNortheast2 VoiceConnectorAwsRegion = "ap-northeast-2"
	VoiceConnectorAwsRegionApNortheast1 VoiceConnectorAwsRegion = "ap-northeast-1"
	VoiceConnectorAwsRegionApSoutheast1 VoiceConnectorAwsRegion = "ap-southeast-1"
	VoiceConnectorAwsRegionApSoutheast2 VoiceConnectorAwsRegion = "ap-southeast-2"
)

Enum values for VoiceConnectorAwsRegion

func (VoiceConnectorAwsRegion) Values

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 Voice Connector group's creation time stamp, in ISO 8601 format.
	CreatedTimestamp *time.Time

	// The name of a Voice Connector group.
	Name *string

	// The Voice Connector group's creation time stamp, in ISO 8601 format.
	UpdatedTimestamp *time.Time

	// The ARN of the Voice Connector group.
	VoiceConnectorGroupArn *string

	// The ID of a Voice Connector group.
	VoiceConnectorGroupId *string

	// The Voice Connectors to which you route inbound calls.
	VoiceConnectorItems []VoiceConnectorItem
	// contains filtered or unexported fields
}

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

type VoiceConnectorItem

type VoiceConnectorItem struct {

	// The priority setting of a Voice Connector item. Calls are routed to hosts in
	// priority order, with 1 as the highest priority. When hosts have equal priority,
	// the system distributes calls among them based on their relative weight.
	//
	// This member is required.
	Priority *int32

	// The Voice Connector ID.
	//
	// This member is required.
	VoiceConnectorId *string
	// contains filtered or unexported fields
}

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

type VoiceConnectorSettings

type VoiceConnectorSettings struct {

	// The S3 bucket that stores the Voice Connector's call detail records.
	CdrBucket *string
	// contains filtered or unexported fields
}

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

type VoiceProfile added in v1.3.0

type VoiceProfile struct {

	// The time at which the voice profile was created and enrolled.
	CreatedTimestamp *time.Time

	// The time at which a voice profile expires unless you re-enroll the caller via
	// the UpdateVoiceProfile API.
	ExpirationTimestamp *time.Time

	// The time at which the voice profile was last updated.
	UpdatedTimestamp *time.Time

	// The ARN of the voice profile.
	VoiceProfileArn *string

	// The ID of the domain that contains the voice profile.
	VoiceProfileDomainId *string

	// The ID of the voice profile.
	VoiceProfileId *string
	// contains filtered or unexported fields
}

The combination of a voice print and caller ID.

type VoiceProfileDomain added in v1.3.0

type VoiceProfileDomain struct {

	// The time at which the voice profile domain was created.
	CreatedTimestamp *time.Time

	// The description of the voice profile domain.
	Description *string

	// The name of the voice profile domain.
	Name *string

	// A structure that contains the configuration settings for server-side encryption.
	ServerSideEncryptionConfiguration *ServerSideEncryptionConfiguration

	// The time at which the voice profile was last updated.
	UpdatedTimestamp *time.Time

	// The voice profile domain's Amazon Resource Number (ARN).
	VoiceProfileDomainArn *string

	// The ID of the voice profile domain.
	VoiceProfileDomainId *string
	// contains filtered or unexported fields
}

A collection of voice profiles.

type VoiceProfileDomainSummary added in v1.3.0

type VoiceProfileDomainSummary struct {

	// The time at which the voice profile domain summary was created.
	CreatedTimestamp *time.Time

	// Describes the voice profile domain summary.
	Description *string

	// The name of the voice profile domain summary.
	Name *string

	// The time at which the voice profile domain summary was last updated.
	UpdatedTimestamp *time.Time

	// The ARN of a voice profile in a voice profile domain summary.
	VoiceProfileDomainArn *string

	// The ID of the voice profile domain summary.
	VoiceProfileDomainId *string
	// contains filtered or unexported fields
}

A high-level overview of a voice profile domain.

type VoiceProfileSummary added in v1.3.0

type VoiceProfileSummary struct {

	// The time at which a voice profile summary was created.
	CreatedTimestamp *time.Time

	// Extends the life of the voice profile. You can use UpdateVoiceProfile to
	// refresh an existing voice profile's voice print and extend the life of the
	// summary.
	ExpirationTimestamp *time.Time

	// The time at which a voice profile summary was last updated.
	UpdatedTimestamp *time.Time

	// The ARN of the voice profile in a voice profile summary.
	VoiceProfileArn *string

	// The ID of the voice profile domain in a voice profile summary.
	VoiceProfileDomainId *string

	// The ID of the voice profile in a voice profile summary.
	VoiceProfileId *string
	// contains filtered or unexported fields
}

A high-level summary of a voice profile.

type VoiceToneAnalysisTask added in v1.3.0

type VoiceToneAnalysisTask struct {

	// The call details of a voice tone analysis task.
	CallDetails *CallDetails

	// The time at which a voice tone analysis task was created.
	CreatedTimestamp *time.Time

	// The time at which a voice tone analysis task started.
	StartedTimestamp *time.Time

	// The status of a voice tone analysis task.
	StatusMessage *string

	// The time at which a voice tone analysis task was updated.
	UpdatedTimestamp *time.Time

	// The ID of the voice tone analysis task.
	VoiceToneAnalysisTaskId *string

	// The status of a voice tone analysis task, IN_QUEUE , IN_PROGRESS ,
	// PARTIAL_SUCCESS , SUCCEEDED , FAILED , or STOPPED .
	VoiceToneAnalysisTaskStatus *string
	// contains filtered or unexported fields
}

A representation of an asynchronous request to perform voice tone analysis on a Voice Connector call.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL