types

package
v1.30.4 Latest Latest
Warning

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

 Go to latest Published: Mar 29, 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 permissions to perform the requested operation.

func (*AccessDeniedException) Error 

func (e *AccessDeniedException) Error() string

func (*AccessDeniedException) ErrorCode 

func (e *AccessDeniedException) ErrorCode() string

func (*AccessDeniedException) ErrorFault 

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

func (*AccessDeniedException) ErrorMessage 

func (e *AccessDeniedException) ErrorMessage() string

type Account 

type Account struct {

	// The Amazon Chime account ID.
	//
	// This member is required.
	AccountId *string

	// The AWS account ID.
	//
	// This member is required.
	AwsAccountId *string

	// The Amazon Chime account name.
	//
	// This member is required.
	Name *string

	// The status of the account.
	AccountStatus AccountStatus

	// The Amazon Chime account type. For more information about different account
	// types, see Managing Your Amazon Chime Accounts (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
	// contains filtered or unexported fields
}

The Amazon Chime account details. An AWS account can have multiple Amazon Chime accounts.

type AccountSettings 

type AccountSettings struct {

	// Setting that stops or starts remote control of shared screens during meetings.
	DisableRemoteControl *bool

	// Setting that allows meeting participants to choose the Call me at a phone
	// number option. For more information, see Join a Meeting without the Amazon
	// Chime App (https://docs.aws.amazon.com/chime/latest/ug/chime-join-meeting.html) .
	EnableDialOut *bool
	// contains filtered or unexported fields
}

Settings related to the Amazon Chime account. This includes settings that start or stop remote control of shared screens, or start or stop the dial-out option in the Amazon Chime web application. For more information about these settings, see Use the Policies Page (https://docs.aws.amazon.com/chime/latest/ag/policies.html) in the Amazon Chime Administration Guide.

type AccountStatus added in v1.8.0 

type AccountStatus string
const (
	AccountStatusSuspended AccountStatus = "Suspended"
	AccountStatusActive    AccountStatus = "Active"
)

Enum values for AccountStatus

func (AccountStatus) Values added in v1.8.0 

func (AccountStatus) Values() []AccountStatus

Values returns all known values for AccountStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type AccountType 

type AccountType string
const (
	AccountTypeTeam                AccountType = "Team"
	AccountTypeEnterpriseDirectory AccountType = "EnterpriseDirectory"
	AccountTypeEnterpriseLWA       AccountType = "EnterpriseLWA"
	AccountTypeEnterpriseOIDC      AccountType = "EnterpriseOIDC"
)

Enum values for AccountType

func (AccountType) Values 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 Address added in v1.21.0 

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 AlexaForBusinessMetadata 

type AlexaForBusinessMetadata struct {

	// The ARN of the room resource.
	AlexaForBusinessRoomArn *string

	// Starts or stops Alexa for Business.
	IsAlexaForBusinessEnabled *bool
	// contains filtered or unexported fields
}

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

type AppInstance added in v0.30.0 

type AppInstance struct {

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

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

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

	// The metadata of an AppInstance .
	Metadata *string

	// The name of an AppInstance .
	Name *string
	// contains filtered or unexported fields
}

The details of an AppInstance , an instance of an Amazon Chime SDK messaging application.

type AppInstanceAdmin added in v0.30.0 

type AppInstanceAdmin struct {

	// The AppInstanceAdmin data.
	Admin *Identity

	// The ARN of the AppInstance for which the user is an administrator.
	AppInstanceArn *string

	// The time at which an administrator was created.
	CreatedTimestamp *time.Time
	// contains filtered or unexported fields
}

The details of an AppInstanceAdmin .

type AppInstanceAdminSummary added in v0.30.0 

type AppInstanceAdminSummary struct {

	// The details of the AppInstanceAdmin .
	Admin *Identity
	// contains filtered or unexported fields
}

Summary of the details of an AppInstanceAdmin .

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 the messages in a channel.
	ChannelRetentionSettings *ChannelRetentionSettings
	// contains filtered or unexported fields
}

The details of the data-retention settings for an AppInstance .

type AppInstanceStreamingConfiguration added in v0.30.0 

type AppInstanceStreamingConfiguration struct {

	// The type of data to be streamed.
	//
	// This member is required.
	AppInstanceDataType AppInstanceDataType

	// The resource ARN.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

The details of the streaming configuration of an AppInstance .

type AppInstanceSummary added in v0.30.0 

type AppInstanceSummary struct {

	// The AppInstance ARN.
	AppInstanceArn *string

	// The metadata of the AppInstance .
	Metadata *string

	// The name of the AppInstance .
	Name *string
	// contains filtered or unexported fields
}

Summary of the data for an AppInstance .

type AppInstanceUser added in v0.30.0 

type AppInstanceUser struct {

	// The ARN of the AppInstanceUser .
	AppInstanceUserArn *string

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

	// The time at which the AppInstanceUser was last updated.
	LastUpdatedTimestamp *time.Time

	// The metadata of the AppInstanceUser .
	Metadata *string

	// The name of the AppInstanceUser .
	Name *string
	// contains filtered or unexported fields
}

The details of an AppInstanceUser .

type AppInstanceUserMembershipSummary added in v0.30.0 

type AppInstanceUserMembershipSummary struct {

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

	// The type of ChannelMembership .
	Type ChannelMembershipType
	// contains filtered or unexported fields
}

Summary of the membership details of an AppInstanceUser .

type AppInstanceUserSummary added in v0.30.0 

type AppInstanceUserSummary struct {

	// The ARN of the AppInstanceUser .
	AppInstanceUserArn *string

	// The metadata of the AppInstanceUser .
	Metadata *string

	// The name of an AppInstanceUser .
	Name *string
	// contains filtered or unexported fields
}

Summary of the details of an AppInstanceUser .

type ArtifactsConfiguration added in v1.11.0 

type ArtifactsConfiguration struct {

	// The configuration for the audio artifacts.
	//
	// This member is required.
	Audio *AudioArtifactsConfiguration

	// The configuration for the content artifacts.
	//
	// This member is required.
	Content *ContentArtifactsConfiguration

	// The configuration for the video artifacts.
	//
	// This member is required.
	Video *VideoArtifactsConfiguration
	// contains filtered or unexported fields
}

The configuration for the artifacts.

type ArtifactsState added in v1.11.0 

type ArtifactsState string
const (
	ArtifactsStateEnabled  ArtifactsState = "Enabled"
	ArtifactsStateDisabled ArtifactsState = "Disabled"
)

Enum values for ArtifactsState

func (ArtifactsState) Values added in v1.11.0 

func (ArtifactsState) Values() []ArtifactsState

Values returns all known values for ArtifactsState. 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 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.
	ExternalUserId *string

	// The join token used by the Amazon Chime SDK attendee.
	JoinToken *string
	// contains filtered or unexported fields
}

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 AudioArtifactsConfiguration added in v1.11.0 

type AudioArtifactsConfiguration struct {

	// The MUX type of the audio artifact configuration object.
	//
	// This member is required.
	MuxType AudioMuxType
	// contains filtered or unexported fields
}

The audio artifact configuration object.

type AudioMuxType added in v1.11.0 

type AudioMuxType string
const (
	AudioMuxTypeAudioOnly                   AudioMuxType = "AudioOnly"
	AudioMuxTypeAudioWithActiveSpeakerVideo AudioMuxType = "AudioWithActiveSpeakerVideo"
)

Enum values for AudioMuxType

func (AudioMuxType) Values added in v1.11.0 

func (AudioMuxType) Values() []AudioMuxType

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

type BatchChannelMemberships struct {

	// The ARN of the channel to which you're adding users.
	ChannelArn *string

	// The identifier of the member who invited another member.
	InvitedBy *Identity

	// The users successfully added to the request.
	Members []Identity

	// The membership types set for the channel users.
	Type ChannelMembershipType
	// contains filtered or unexported fields
}

The membership information, including member ARNs, the channel ARN, and membership types.

type BatchCreateChannelMembershipError added in v1.3.0 

type BatchCreateChannelMembershipError struct {

	// The error code.
	ErrorCode ErrorCode

	// The error message.
	ErrorMessage *string

	// The ARN of the member that the service couldn't add.
	MemberArn *string
	// contains filtered or unexported fields
}

A list of failed member ARNs, error codes, and error messages.

type Bot 

type Bot struct {

	// The bot email address.
	BotEmail *string

	// The bot ID.
	BotId *string

	// The bot type.
	BotType BotType

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

	// When true, the bot is stopped from running in your account.
	Disabled *bool

	// The bot display name.
	DisplayName *string

	// The security token used to authenticate Amazon Chime with the outgoing event
	// endpoint.
	SecurityToken *string

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

	// The unique ID for the bot user.
	UserId *string
	// contains filtered or unexported fields
}

A resource that allows Enterprise account administrators to configure an interface to receive events from Amazon Chime.

type BotType 

type BotType string
const (
	BotTypeChatBot BotType = "ChatBot"
)

Enum values for BotType

func (BotType) Values 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
	// contains filtered or unexported fields
}

The Amazon Chime Business Calling settings for the administrator's AWS account. Includes any Amazon S3 buckets designated for storing call detail records.

type CallingNameStatus 

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

Enum values for CallingNameStatus

func (CallingNameStatus) Values 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 CandidateAddress added in v1.21.0 

type CandidateAddress struct {

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

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

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

	// The Zip + 4 or postal code + 4 of a candidate address.
	PostalCodePlus4 *string

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

	// The street information of a candidate address
	StreetInfo *string

	// The numeric portion of a 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 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 AppInstanceUser who created the channel.
	CreatedBy *Identity

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

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

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

	// The channel's metadata.
	Metadata *string

	// The mode of the channel.
	Mode ChannelMode

	// The name of the channel.
	Name *string

	// The channel's privacy setting.
	Privacy ChannelPrivacy
	// contains filtered or unexported fields
}

The details of 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 AppInstanceUser who created the ban.
	CreatedBy *Identity

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

	// The member being banned from the channel.
	Member *Identity
	// contains filtered or unexported fields
}

The details of a channel ban.

type ChannelBanSummary added in v0.30.0 

type ChannelBanSummary struct {

	// The member being banned from a channel.
	Member *Identity
	// contains filtered or unexported fields
}

Summary of the details of a ChannelBan .

type ChannelMembership 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.
	InvitedBy *Identity

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

	// The data of the channel member.
	Member *Identity

	// The membership type set for the channel member.
	Type ChannelMembershipType
	// contains filtered or unexported fields
}

The details of a channel member.

type ChannelMembershipForAppInstanceUserSummary added in v0.30.0 

type ChannelMembershipForAppInstanceUserSummary struct {

	// Summary of the membership details of an AppInstanceUser .
	AppInstanceUserMembershipSummary *AppInstanceUserMembershipSummary

	// Summary of the details of a Channel .
	ChannelSummary *ChannelSummary
	// contains filtered or unexported fields
}

Summary of the channel membership details of an AppInstanceUser .

type ChannelMembershipSummary added in v0.30.0 

type ChannelMembershipSummary struct {

	// A member's summary data.
	Member *Identity
	// contains filtered or unexported fields
}

Summary of the details of a ChannelMembership .

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

	// The persistence setting for a channel message.
	Persistence ChannelMessagePersistenceType

	// Hides the content of a message.
	Redacted bool

	// The message sender.
	Sender *Identity

	// The message type.
	Type ChannelMessageType
	// contains filtered or unexported fields
}

The details of a message in a channel.

type ChannelMessagePersistenceType 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.
	Content *string

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

	// The time at which a message was last edited.
	LastEditedTimestamp *time.Time

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

	// The ID of the message.
	MessageId *string

	// The metadata of the message.
	Metadata *string

	// Indicates whether a message was redacted.
	Redacted bool

	// The message sender.
	Sender *Identity

	// The type of message.
	Type ChannelMessageType
	// contains filtered or unexported fields
}

Summary of the messages in a Channel .

type ChannelMessageType 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 {

	// Summary of the details of a Channel .
	ChannelSummary *ChannelSummary
	// contains filtered or unexported fields
}

Summary of the details of a moderated channel.

type ChannelModerator added in v0.30.0 

type ChannelModerator struct {

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

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

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

	// The moderator's data.
	Moderator *Identity
	// contains filtered or unexported fields
}

The details of a channel moderator.

type ChannelModeratorSummary added in v0.30.0 

type ChannelModeratorSummary struct {

	// The data for a moderator.
	Moderator *Identity
	// contains filtered or unexported fields
}

Summary of the details of a ChannelModerator .

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 the messages in a channel.
	RetentionDays *int32
	// contains filtered or unexported fields
}

The details of the retention settings for a channel.

type ChannelSummary added in v0.30.0 

type ChannelSummary struct {

	// The ARN of the channel.
	ChannelArn *string

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

	// The metadata of the channel.
	Metadata *string

	// The mode of the channel.
	Mode ChannelMode

	// The name of the channel.
	Name *string

	// The privacy setting of the channel.
	Privacy ChannelPrivacy
	// contains filtered or unexported fields
}

Summary of the details of a Channel .

type ChimeSdkMeetingConfiguration added in v1.11.0 

type ChimeSdkMeetingConfiguration struct {

	// The configuration for the artifacts in an Amazon Chime SDK meeting.
	ArtifactsConfiguration *ArtifactsConfiguration

	// The source configuration for a specified media capture pipeline.
	SourceConfiguration *SourceConfiguration
	// contains filtered or unexported fields
}

The configuration object of the Amazon Chime SDK meeting for a specified media capture pipeline. SourceType must be ChimeSdkMeeting .

type ConflictException 

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string

	Code ErrorCode
	// contains filtered or unexported fields
}

The request could not be processed because of conflict in the current state of the resource.

func (*ConflictException) Error 

func (e *ConflictException) Error() string

func (*ConflictException) ErrorCode 

func (e *ConflictException) ErrorCode() string

func (*ConflictException) ErrorFault 

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

func (*ConflictException) ErrorMessage 

func (e *ConflictException) ErrorMessage() string

type ContentArtifactsConfiguration added in v1.11.0 

type ContentArtifactsConfiguration struct {

	// Indicates whether the content artifact is enabled or disabled.
	//
	// This member is required.
	State ArtifactsState

	// The MUX type of the artifact configuration.
	MuxType ContentMuxType
	// contains filtered or unexported fields
}

The content artifact object.

type ContentMuxType added in v1.11.0 

type ContentMuxType string
const (
	ContentMuxTypeContentOnly ContentMuxType = "ContentOnly"
)

Enum values for ContentMuxType

func (ContentMuxType) Values added in v1.11.0 

func (ContentMuxType) Values() []ContentMuxType

Values returns all known values for ContentMuxType. 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 ConversationRetentionSettings 

type ConversationRetentionSettings struct {

	// The number of days for which to retain conversation messages.
	RetentionDays *int32
	// contains filtered or unexported fields
}

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

type 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.
	ExternalUserId *string
	// contains filtered or unexported fields
}

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.
	//
	// This member is required.
	ExternalUserId *string

	// The tag key-value pairs.
	Tags []Tag
	// contains filtered or unexported fields
}

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

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

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

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

type EngineTranscribeMedicalSettings added in v1.8.0 

type EngineTranscribeMedicalSettings struct {

	// The language code specified for the Amazon Transcribe Medical engine.
	//
	// This member is required.
	LanguageCode TranscribeMedicalLanguageCode

	// The specialty specified for the Amazon Transcribe Medical engine.
	//
	// This member is required.
	Specialty TranscribeMedicalSpecialty

	// The type of transcription.
	//
	// This member is required.
	Type TranscribeMedicalType

	// Labels all personally identifiable information (PII) identified in your
	// transcript. If you don't include PiiEntityTypes , all PII is identified. You
	// can’t set ContentIdentificationType and ContentRedactionType .
	ContentIdentificationType TranscribeMedicalContentIdentificationType

	// The AWS Region passed to Amazon Transcribe Medical. If you don't specify a
	// Region, Amazon Chime uses the meeting's Region.
	Region TranscribeMedicalRegion

	// The name of the vocabulary passed to Amazon Transcribe Medical.
	VocabularyName *string
	// contains filtered or unexported fields
}

Settings specific to the Amazon Transcribe Medical engine.

type EngineTranscribeSettings added in v1.8.0 

type EngineTranscribeSettings struct {

	// Labels all personally identifiable information (PII) identified in your
	// transcript. If you don't include PiiEntityTypes , all PII is identified. You
	// can’t set ContentIdentificationType and ContentRedactionType .
	ContentIdentificationType TranscribeContentIdentificationType

	// Content redaction is performed at the segment level. If you don't include
	// PiiEntityTypes , all PII is redacted. You can’t set ContentIdentificationType
	// and ContentRedactionType .
	ContentRedactionType TranscribeContentRedactionType

	// Enables partial result stabilization for your transcription. Partial result
	// stabilization can reduce latency in your output, but may impact accuracy.
	EnablePartialResultsStabilization *bool

	// Enables automatic language identification for your transcription. If you
	// include IdentifyLanguage , you can optionally use LanguageOptions to include a
	// list of language codes that you think may be present in your audio stream.
	// Including language options can improve transcription accuracy. You can also use
	// PreferredLanguage to include a preferred language. Doing so can help Amazon
	// Transcribe identify the language faster. You must include either LanguageCode
	// or IdentifyLanguage . Language identification can't be combined with custom
	// language models or redaction.
	IdentifyLanguage *bool

	// Specify the language code that represents the language spoken. If you're unsure
	// of the language spoken in your audio, consider using IdentifyLanguage to enable
	// automatic language identification.
	LanguageCode TranscribeLanguageCode

	// Specify the name of the custom language model that you want to use when
	// processing your transcription. Note that language model names are case
	// sensitive. The language of the specified language model must match the language
	// code. If the languages don't match, the custom language model isn't applied.
	// There are no errors or warnings associated with a language mismatch. If you use
	// Amazon Transcribe in multiple Regions, the custom language model must be
	// available in Amazon Transcribe in each Region.
	LanguageModelName *string

	// Specify two or more language codes that represent the languages you think may
	// be present in your media; including more than five is not recommended. If you're
	// unsure what languages are present, do not include this parameter. Including
	// language options can improve the accuracy of language identification. If you
	// include LanguageOptions , you must also include IdentifyLanguage . You can only
	// include one language dialect per language. For example, you cannot include en-US
	// and en-AU .
	LanguageOptions *string

	// Specify the level of stability to use when you enable partial results
	// stabilization ( EnablePartialResultsStabilization ). Low stability provides the
	// highest accuracy. High stability transcribes faster, but with slightly lower
	// accuracy.
	PartialResultsStability TranscribePartialResultsStability

	// Specify which types of personally identifiable information (PII) you want to
	// redact in your transcript. You can include as many types as you'd like, or you
	// can select ALL . Values must be comma-separated and can include: ADDRESS ,
	// BANK_ACCOUNT_NUMBER , BANK_ROUTING , CREDIT_DEBIT_CVV , CREDIT_DEBIT_EXPIRY
	// CREDIT_DEBIT_NUMBER , EMAIL , NAME , PHONE , PIN , SSN , or ALL . Note that if
	// you include PiiEntityTypes , you must also include ContentIdentificationType or
	// ContentRedactionType . If you include ContentRedactionType or
	// ContentIdentificationType , but do not include PiiEntityTypes , all PII is
	// redacted or identified.
	PiiEntityTypes *string

	// Specify a preferred language from the subset of languages codes you specified
	// in LanguageOptions . You can only use this parameter if you include
	// IdentifyLanguage and LanguageOptions .
	PreferredLanguage TranscribeLanguageCode

	// The AWS Region in which to use Amazon Transcribe. If you don't specify a
	// Region, then the MediaRegion parameter of the CreateMeeting.html (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_CreateMeeting.html)
	// API will be used. However, if Amazon Transcribe is not available in the
	// MediaRegion , then a TranscriptFailed event is sent. Use auto to use Amazon
	// Transcribe in a Region near the meeting’s MediaRegion . For more information,
	// refer to Choosing a transcription Region (https://docs.aws.amazon.com/chime-sdk/latest/dg/transcription-options.html#choose-region)
	// in the Amazon Chime SDK Developer Guide.
	Region TranscribeRegion

	// Specify how you want your vocabulary filter applied to your transcript. To
	// replace words with *** , choose mask . To delete words, choose remove . To flag
	// words without changing them, choose tag .
	VocabularyFilterMethod TranscribeVocabularyFilterMethod

	// Specify the name of the custom vocabulary filter that you want to use when
	// processing your transcription. Note that vocabulary filter names are case
	// sensitive. If you use Amazon Transcribe in multiple Regions, the vocabulary
	// filter must be available in Amazon Transcribe in each Region. If you include
	// IdentifyLanguage and want to use one or more vocabulary filters with your
	// transcription, use the VocabularyFilterNames parameter instead.
	VocabularyFilterName *string

	// Specify the names of the custom vocabulary filters that you want to use when
	// processing your transcription. Note that vocabulary filter names are case
	// sensitive. If you use Amazon Transcribe in multiple Regions, the vocabulary
	// filter must be available in Amazon Transcribe in each Region. If you're not
	// including IdentifyLanguage and want to use a custom vocabulary filter with your
	// transcription, use the VocabularyFilterName parameter instead.
	VocabularyFilterNames *string

	// Specify the name of the custom vocabulary that you want to use when processing
	// your transcription. Note that vocabulary names are case sensitive. If you use
	// Amazon Transcribe multiple Regions, the vocabulary must be available in Amazon
	// Transcribe in each Region. If you include IdentifyLanguage and want to use one
	// or more custom vocabularies with your transcription, use the VocabularyNames
	// parameter instead.
	VocabularyName *string

	// Specify the names of the custom vocabularies that you want to use when
	// processing your transcription. Note that vocabulary names are case sensitive. If
	// you use Amazon Transcribe in multiple Regions, the vocabulary must be available
	// in Amazon Transcribe in each Region. If you don't include IdentifyLanguage and
	// want to use a custom vocabulary with your transcription, use the VocabularyName
	// parameter instead.
	VocabularyNames *string
	// contains filtered or unexported fields
}

Settings specific for Amazon Transcribe as the live transcription engine. If you specify an invalid combination of parameters, a TranscriptFailed event will be sent with the contents of the BadRequestException generated by Amazon Transcribe. For more information on each parameter and which combinations are valid, refer to the StartStreamTranscription (https://docs.aws.amazon.com/transcribe/latest/APIReference/API_streaming_StartStreamTranscription.html) API in the Amazon Transcribe Developer Guide.

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

The configuration that allows a bot to receive outgoing events. Can be either an HTTPS endpoint or a Lambda function ARN.

type ForbiddenException 

type ForbiddenException struct {
	Message *string

	ErrorCodeOverride *string

	Code ErrorCode
	// contains filtered or unexported fields
}

The client is permanently forbidden from making the request.

func (*ForbiddenException) Error 

func (e *ForbiddenException) Error() string

func (*ForbiddenException) ErrorCode 

func (e *ForbiddenException) ErrorCode() string

func (*ForbiddenException) ErrorFault 

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

func (*ForbiddenException) ErrorMessage 

func (e *ForbiddenException) ErrorMessage() string

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

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

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

Invitation object returned after emailing users to invite them to join the Amazon Chime Team account.

type InviteStatus 

type InviteStatus string
const (
	InviteStatusPending  InviteStatus = "Pending"
	InviteStatusAccepted InviteStatus = "Accepted"
	InviteStatusFailed   InviteStatus = "Failed"
)

Enum values for InviteStatus

func (InviteStatus) Values 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 {

	// Boolean that enables logging of detailed media metrics for Voice Connectors to
	// Amazon CloudWatch logs.
	EnableMediaMetricLogs *bool

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

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

type MediaCapturePipeline added in v1.6.0 

type MediaCapturePipeline struct {

	// The configuration for a specified media capture pipeline. SourceType must be
	// ChimeSdkMeeting .
	ChimeSdkMeetingConfiguration *ChimeSdkMeetingConfiguration

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

	// The ID of a media capture pipeline.
	MediaPipelineId *string

	// ARN of the destination to which the media artifacts are saved.
	SinkArn *string

	// Destination type to which the media artifacts are saved. You must use an S3
	// Bucket.
	SinkType MediaPipelineSinkType

	// ARN of the source from which the media artifacts will be saved.
	SourceArn *string

	// Source type from which media artifacts are saved. You must use ChimeMeeting .
	SourceType MediaPipelineSourceType

	// The status of the media capture pipeline.
	Status MediaPipelineStatus

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

A media capture pipeline object consisting of an ID, source type, source ARN, a sink type, a sink ARN, and a configuration object.

type MediaPipelineSinkType added in v1.6.0 

type MediaPipelineSinkType string
const (
	MediaPipelineSinkTypeS3Bucket MediaPipelineSinkType = "S3Bucket"
)

Enum values for MediaPipelineSinkType

func (MediaPipelineSinkType) Values added in v1.6.0 

func (MediaPipelineSinkType) Values() []MediaPipelineSinkType

Values returns all known values for MediaPipelineSinkType. 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 MediaPipelineSourceType added in v1.6.0 

type MediaPipelineSourceType string
const (
	MediaPipelineSourceTypeChimeSdkMeeting MediaPipelineSourceType = "ChimeSdkMeeting"
)

Enum values for MediaPipelineSourceType

func (MediaPipelineSourceType) Values added in v1.6.0 

func (MediaPipelineSourceType) Values() []MediaPipelineSourceType

Values returns all known values for MediaPipelineSourceType. 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 MediaPipelineStatus added in v1.6.0 

type MediaPipelineStatus string
const (
	MediaPipelineStatusInitializing MediaPipelineStatus = "Initializing"
	MediaPipelineStatusInProgress   MediaPipelineStatus = "InProgress"
	MediaPipelineStatusFailed       MediaPipelineStatus = "Failed"
	MediaPipelineStatusStopping     MediaPipelineStatus = "Stopping"
	MediaPipelineStatusStopped      MediaPipelineStatus = "Stopped"
)

Enum values for MediaPipelineStatus

func (MediaPipelineStatus) Values added in v1.6.0 

func (MediaPipelineStatus) Values() []MediaPipelineStatus

Values returns all known values for MediaPipelineStatus. 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 MediaPlacement 

type MediaPlacement struct {

	// The audio fallback URL.
	AudioFallbackUrl *string

	// The audio host URL.
	AudioHostUrl *string

	// The event ingestion URL to which you send client meeting events.
	EventIngestionUrl *string

	// The screen data URL. This parameter is is no longer supported and no longer
	// used by the Amazon Chime SDK.
	ScreenDataUrl *string

	// The screen sharing URL. This parameter is is no longer supported and no longer
	// used by the Amazon Chime SDK..
	ScreenSharingUrl *string

	// The screen viewing URL. This parameter is is no longer supported and no longer
	// used by the Amazon Chime SDK.
	ScreenViewingUrl *string

	// The signaling URL.
	SignalingUrl *string

	// The turn control URL. This parameter is is no longer supported and no longer
	// used by the Amazon Chime SDK.
	TurnControlUrl *string
	// contains filtered or unexported fields
}

A set of endpoints used by clients to connect to the media service group for an 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 you 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
	// contains filtered or unexported fields
}

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

The resource target configurations for receiving Amazon Chime SDK meeting and attendee event notifications. 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
	// contains filtered or unexported fields
}

The member details, such as email address, name, member ID, and member type.

type MemberError 

type MemberError struct {

	// The error code.
	ErrorCode ErrorCode

	// The error message.
	ErrorMessage *string

	// The member ID.
	MemberId *string
	// contains filtered or unexported fields
}

The list of errors returned when a member action results in an error.

type MemberType 

type MemberType string
const (
	MemberTypeUser    MemberType = "User"
	MemberTypeBot     MemberType = "Bot"
	MemberTypeWebhook MemberType = "Webhook"
)

Enum values for MemberType

func (MemberType) Values 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
	// contains filtered or unexported fields
}

Membership details, such as member ID and member role.

type MessagingSessionEndpoint added in v0.30.0 

type MessagingSessionEndpoint struct {

	// The endpoint to which you establish a websocket connection.
	Url *string
	// contains filtered or unexported fields
}

The websocket endpoint used to connect to Amazon Chime SDK messaging.

type NotFoundException 

type NotFoundException struct {
	Message *string

	ErrorCodeOverride *string

	Code ErrorCode
	// contains filtered or unexported fields
}

One or more of the resources in the request does not exist in the system.

func (*NotFoundException) Error 

func (e *NotFoundException) Error() string

func (*NotFoundException) ErrorCode 

func (e *NotFoundException) ErrorCode() string

func (*NotFoundException) ErrorFault 

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

func (*NotFoundException) ErrorMessage 

func (e *NotFoundException) ErrorMessage() string

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

	// The weight associated with the host. If hosts are equal in priority, calls are
	// redistributed among them based on their relative weight.
	Weight *int32
	// contains filtered or unexported fields
}

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

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 country. Format: ISO 3166-1 alpha-2.
	Country *string

	// The phone number creation timestamp, in ISO 8601 format.
	CreatedTimestamp *time.Time

	// The deleted phone number timestamp, in ISO 8601 format.
	DeletionTimestamp *time.Time

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

	// The phone number ID.
	PhoneNumberId *string

	// The phone number product type.
	ProductType PhoneNumberProductType

	// The phone number status.
	Status PhoneNumberStatus

	// The phone number type.
	Type PhoneNumberType

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

A phone number used for Amazon Chime Business Calling or an Amazon Chime Voice Connector.

type PhoneNumberAssociation 

type PhoneNumberAssociation struct {

	// The timestamp of the phone number association, in ISO 8601 format.
	AssociatedTimestamp *time.Time

	// Defines the association with an Amazon Chime account ID, user ID, Amazon Chime
	// Voice Connector ID, or Amazon Chime Voice Connector group ID.
	Name PhoneNumberAssociationName

	// Contains the ID for the entity specified in Name.
	Value *string
	// contains filtered or unexported fields
}

The phone number associations, such as Amazon Chime account ID, Amazon Chime user ID, Amazon Chime Voice Connector ID, or Amazon Chime Voice Connector group ID.

type PhoneNumberAssociationName 

type PhoneNumberAssociationName string
const (
	PhoneNumberAssociationNameAccountId             PhoneNumberAssociationName = "AccountId"
	PhoneNumberAssociationNameUserId                PhoneNumberAssociationName = "UserId"
	PhoneNumberAssociationNameVoiceConnectorId      PhoneNumberAssociationName = "VoiceConnectorId"
	PhoneNumberAssociationNameVoiceConnectorGroupId PhoneNumberAssociationName = "VoiceConnectorGroupId"
	PhoneNumberAssociationNameSipRuleId             PhoneNumberAssociationName = "SipRuleId"
)

Enum values for PhoneNumberAssociationName

func (PhoneNumberAssociationName) Values 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
	// contains filtered or unexported fields
}

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

type PhoneNumberCountry added in v1.3.0 

type PhoneNumberCountry struct {

	// The phone number country code. Format: ISO 3166-1 alpha-2.
	CountryCode *string

	// The supported phone number types.
	SupportedPhoneNumberTypes []PhoneNumberType
	// contains filtered or unexported fields
}

The phone number country.

type PhoneNumberError 

type PhoneNumberError struct {

	// The error code.
	ErrorCode ErrorCode

	// The error message.
	ErrorMessage *string

	// The phone number ID for which the action failed.
	PhoneNumberId *string
	// contains filtered or unexported fields
}

If the phone number action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

type PhoneNumberOrder 

type PhoneNumberOrder struct {

	// The phone number order creation time stamp, in ISO 8601 format.
	CreatedTimestamp *time.Time

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

	// The phone number order ID.
	PhoneNumberOrderId *string

	// The phone number order product type.
	ProductType PhoneNumberProductType

	// The status of the phone number order.
	Status PhoneNumberOrderStatus

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

The details of a phone number order created for Amazon Chime.

type PhoneNumberOrderStatus 

type PhoneNumberOrderStatus string
const (
	PhoneNumberOrderStatusProcessing PhoneNumberOrderStatus = "Processing"
	PhoneNumberOrderStatusSuccessful PhoneNumberOrderStatus = "Successful"
	PhoneNumberOrderStatusFailed     PhoneNumberOrderStatus = "Failed"
	PhoneNumberOrderStatusPartial    PhoneNumberOrderStatus = "Partial"
)

Enum values for PhoneNumberOrderStatus

func (PhoneNumberOrderStatus) Values 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"
	PhoneNumberProductTypeSipMediaApplicationDialIn PhoneNumberProductType = "SipMediaApplicationDialIn"
)

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

The proxy configuration for an Amazon Chime 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 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 time stamp, in ISO 8601 format.
	UpdatedTimestamp *time.Time

	// The Amazon Chime voice connector ID.
	VoiceConnectorId *string
	// contains filtered or unexported fields
}

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

	ErrorCodeOverride *string

	Code ErrorCode
	// contains filtered or unexported fields
}

The request exceeds the resource limit.

func (*ResourceLimitExceededException) Error 

func (e *ResourceLimitExceededException) Error() string

func (*ResourceLimitExceededException) ErrorCode 

func (e *ResourceLimitExceededException) ErrorCode() string

func (*ResourceLimitExceededException) ErrorFault 

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

func (*ResourceLimitExceededException) ErrorMessage 

func (e *ResourceLimitExceededException) ErrorMessage() string

type RetentionSettings 

type RetentionSettings struct {

	// The chat conversation retention settings.
	ConversationRetentionSettings *ConversationRetentionSettings

	// The chat room retention settings.
	RoomRetentionSettings *RoomRetentionSettings
	// contains filtered or unexported fields
}

The retention settings for an Amazon Chime Enterprise account that determine how long to retain items such as chat-room messages and chat-conversation messages.

type Room 

type Room struct {

	// The Amazon Chime account ID.
	AccountId *string

	// The identifier of the room creator.
	CreatedBy *string

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

	// The room name.
	Name *string

	// The room ID.
	RoomId *string

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

The Amazon Chime chat room details.

type RoomMembership 

type RoomMembership struct {

	// The identifier of the user that invited the room member.
	InvitedBy *string

	// The member details, such as email address, name, member ID, and member type.
	Member *Member

	// The membership role.
	Role RoomMembershipRole

	// The room ID.
	RoomId *string

	// The room membership update timestamp, in ISO 8601 format.
	UpdatedTimestamp *time.Time
	// contains filtered or unexported fields
}

The room membership details.

type RoomMembershipRole 

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

Enum values for RoomMembershipRole

func (RoomMembershipRole) Values 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
	// contains filtered or unexported fields
}

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

type SelectedVideoStreams added in v1.11.0 

type SelectedVideoStreams struct {

	// The attendee IDs of the streams selected for a media capture pipeline.
	AttendeeIds []string

	// The external user IDs of the streams selected for a media capture pipeline.
	ExternalUserIds []string
	// contains filtered or unexported fields
}

The video streams to capture for a specified media capture pipeline. The total number of video streams can't exceed 25.

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 (e *ServiceUnavailableException) Error() string

func (*ServiceUnavailableException) ErrorCode 

func (e *ServiceUnavailableException) ErrorCode() string

func (*ServiceUnavailableException) ErrorFault 

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

func (*ServiceUnavailableException) ErrorMessage 

func (e *ServiceUnavailableException) ErrorMessage() string

type SigninDelegateGroup 

type SigninDelegateGroup struct {

	// The group name.
	GroupName *string
	// contains filtered or unexported fields
}

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

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

type SipMediaApplicationCall struct {

	// The transaction ID of a call.
	TransactionId *string
	// contains filtered or unexported fields
}

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, 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 the SIP media application.

type SipMediaApplicationLoggingConfiguration added in v0.30.0 

type SipMediaApplicationLoggingConfiguration struct {

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

Logging configuration of the SIP media application.

type SipRule added in v0.30.0 

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

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

	// The SIP rule ID.
	SipRuleId *string

	// 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 assigned to the SIP rule in TriggerValue , currently
	// RequestUriHostname or ToPhoneNumber .
	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 time at which the SIP rule was last updated, in ISO 8601 format.
	UpdatedTimestamp *time.Time
	// contains filtered or unexported fields
}

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 {

	// The AWS Region of the target application.
	AwsRegion *string

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

	// The SIP media application ID.
	SipMediaApplicationId *string
	// contains filtered or unexported fields
}

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 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 SourceConfiguration added in v1.11.0 

type SourceConfiguration struct {

	// The selected video streams to capture for a specified media capture pipeline.
	// The number of video streams can't exceed 25.
	SelectedVideoStreams *SelectedVideoStreams
	// contains filtered or unexported fields
}

Source configuration for a specified media capture pipeline.

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

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

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

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

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

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

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
	// 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 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 TranscribeContentIdentificationType added in v1.14.0 

type TranscribeContentIdentificationType string
const (
	TranscribeContentIdentificationTypePii TranscribeContentIdentificationType = "PII"
)

Enum values for TranscribeContentIdentificationType

func (TranscribeContentIdentificationType) Values added in v1.14.0 

func (TranscribeContentIdentificationType) Values() []TranscribeContentIdentificationType

Values returns all known values for TranscribeContentIdentificationType. 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 TranscribeContentRedactionType added in v1.14.0 

type TranscribeContentRedactionType string
const (
	TranscribeContentRedactionTypePii TranscribeContentRedactionType = "PII"
)

Enum values for TranscribeContentRedactionType

func (TranscribeContentRedactionType) Values added in v1.14.0 

func (TranscribeContentRedactionType) Values() []TranscribeContentRedactionType

Values returns all known values for TranscribeContentRedactionType. 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 TranscribeLanguageCode added in v1.8.0 

type TranscribeLanguageCode string
const (
	TranscribeLanguageCodeEnUs TranscribeLanguageCode = "en-US"
	TranscribeLanguageCodeEnGb TranscribeLanguageCode = "en-GB"
	TranscribeLanguageCodeEsUs TranscribeLanguageCode = "es-US"
	TranscribeLanguageCodeFrCa TranscribeLanguageCode = "fr-CA"
	TranscribeLanguageCodeFrFr TranscribeLanguageCode = "fr-FR"
	TranscribeLanguageCodeEnAu TranscribeLanguageCode = "en-AU"
	TranscribeLanguageCodeItIt TranscribeLanguageCode = "it-IT"
	TranscribeLanguageCodeDeDe TranscribeLanguageCode = "de-DE"
	TranscribeLanguageCodePtBr TranscribeLanguageCode = "pt-BR"
	TranscribeLanguageCodeJaJp TranscribeLanguageCode = "ja-JP"
	TranscribeLanguageCodeKoKr TranscribeLanguageCode = "ko-KR"
	TranscribeLanguageCodeZhCn TranscribeLanguageCode = "zh-CN"
	TranscribeLanguageCodeThTh TranscribeLanguageCode = "th-TH"
	TranscribeLanguageCodeHiIn TranscribeLanguageCode = "hi-IN"
)

Enum values for TranscribeLanguageCode

func (TranscribeLanguageCode) Values added in v1.8.0 

func (TranscribeLanguageCode) Values() []TranscribeLanguageCode

Values returns all known values for TranscribeLanguageCode. 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 TranscribeMedicalContentIdentificationType added in v1.14.0 

type TranscribeMedicalContentIdentificationType string
const (
	TranscribeMedicalContentIdentificationTypePhi TranscribeMedicalContentIdentificationType = "PHI"
)

Enum values for TranscribeMedicalContentIdentificationType

func (TranscribeMedicalContentIdentificationType) Values added in v1.14.0 

func (TranscribeMedicalContentIdentificationType) Values() []TranscribeMedicalContentIdentificationType

Values returns all known values for TranscribeMedicalContentIdentificationType. 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 TranscribeMedicalLanguageCode added in v1.8.0 

type TranscribeMedicalLanguageCode string
const (
	TranscribeMedicalLanguageCodeEnUs TranscribeMedicalLanguageCode = "en-US"
)

Enum values for TranscribeMedicalLanguageCode

func (TranscribeMedicalLanguageCode) Values added in v1.8.0 

func (TranscribeMedicalLanguageCode) Values() []TranscribeMedicalLanguageCode

Values returns all known values for TranscribeMedicalLanguageCode. 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 TranscribeMedicalRegion added in v1.8.0 

type TranscribeMedicalRegion string
const (
	TranscribeMedicalRegionUsEast1      TranscribeMedicalRegion = "us-east-1"
	TranscribeMedicalRegionUsEast2      TranscribeMedicalRegion = "us-east-2"
	TranscribeMedicalRegionUsWest2      TranscribeMedicalRegion = "us-west-2"
	TranscribeMedicalRegionApSoutheast2 TranscribeMedicalRegion = "ap-southeast-2"
	TranscribeMedicalRegionCaCentral1   TranscribeMedicalRegion = "ca-central-1"
	TranscribeMedicalRegionEuWest1      TranscribeMedicalRegion = "eu-west-1"
	TranscribeMedicalRegionAuto         TranscribeMedicalRegion = "auto"
)

Enum values for TranscribeMedicalRegion

func (TranscribeMedicalRegion) Values added in v1.8.0 

func (TranscribeMedicalRegion) Values() []TranscribeMedicalRegion

Values returns all known values for TranscribeMedicalRegion. 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 TranscribeMedicalSpecialty added in v1.8.0 

type TranscribeMedicalSpecialty string
const (
	TranscribeMedicalSpecialtyPrimaryCare TranscribeMedicalSpecialty = "PRIMARYCARE"
	TranscribeMedicalSpecialtyCardiology  TranscribeMedicalSpecialty = "CARDIOLOGY"
	TranscribeMedicalSpecialtyNeurology   TranscribeMedicalSpecialty = "NEUROLOGY"
	TranscribeMedicalSpecialtyOncology    TranscribeMedicalSpecialty = "ONCOLOGY"
	TranscribeMedicalSpecialtyRadiology   TranscribeMedicalSpecialty = "RADIOLOGY"
	TranscribeMedicalSpecialtyUrology     TranscribeMedicalSpecialty = "UROLOGY"
)

Enum values for TranscribeMedicalSpecialty

func (TranscribeMedicalSpecialty) Values added in v1.8.0 

func (TranscribeMedicalSpecialty) Values() []TranscribeMedicalSpecialty

Values returns all known values for TranscribeMedicalSpecialty. 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 TranscribeMedicalType added in v1.8.0 

type TranscribeMedicalType string
const (
	TranscribeMedicalTypeConversation TranscribeMedicalType = "CONVERSATION"
	TranscribeMedicalTypeDictation    TranscribeMedicalType = "DICTATION"
)

Enum values for TranscribeMedicalType

func (TranscribeMedicalType) Values added in v1.8.0 

func (TranscribeMedicalType) Values() []TranscribeMedicalType

Values returns all known values for TranscribeMedicalType. 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 TranscribePartialResultsStability added in v1.14.0 

type TranscribePartialResultsStability string
const (
	TranscribePartialResultsStabilityLow    TranscribePartialResultsStability = "low"
	TranscribePartialResultsStabilityMedium TranscribePartialResultsStability = "medium"
	TranscribePartialResultsStabilityHigh   TranscribePartialResultsStability = "high"
)

Enum values for TranscribePartialResultsStability

func (TranscribePartialResultsStability) Values added in v1.14.0 

func (TranscribePartialResultsStability) Values() []TranscribePartialResultsStability

Values returns all known values for TranscribePartialResultsStability. 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 TranscribeRegion added in v1.8.0 

type TranscribeRegion string
const (
	TranscribeRegionUsEast2      TranscribeRegion = "us-east-2"
	TranscribeRegionUsEast1      TranscribeRegion = "us-east-1"
	TranscribeRegionUsWest2      TranscribeRegion = "us-west-2"
	TranscribeRegionApNortheast2 TranscribeRegion = "ap-northeast-2"
	TranscribeRegionApSoutheast2 TranscribeRegion = "ap-southeast-2"
	TranscribeRegionApNortheast1 TranscribeRegion = "ap-northeast-1"
	TranscribeRegionCaCentral1   TranscribeRegion = "ca-central-1"
	TranscribeRegionEuCentral1   TranscribeRegion = "eu-central-1"
	TranscribeRegionEuWest1      TranscribeRegion = "eu-west-1"
	TranscribeRegionEuWest2      TranscribeRegion = "eu-west-2"
	TranscribeRegionSaEast1      TranscribeRegion = "sa-east-1"
	TranscribeRegionAuto         TranscribeRegion = "auto"
)

Enum values for TranscribeRegion

func (TranscribeRegion) Values added in v1.8.0 

func (TranscribeRegion) Values() []TranscribeRegion

Values returns all known values for TranscribeRegion. 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 TranscribeVocabularyFilterMethod added in v1.8.0 

type TranscribeVocabularyFilterMethod string
const (
	TranscribeVocabularyFilterMethodRemove TranscribeVocabularyFilterMethod = "remove"
	TranscribeVocabularyFilterMethodMask   TranscribeVocabularyFilterMethod = "mask"
	TranscribeVocabularyFilterMethodTag    TranscribeVocabularyFilterMethod = "tag"
)

Enum values for TranscribeVocabularyFilterMethod

func (TranscribeVocabularyFilterMethod) Values added in v1.8.0 

func (TranscribeVocabularyFilterMethod) Values() []TranscribeVocabularyFilterMethod

Values returns all known values for TranscribeVocabularyFilterMethod. 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 TranscriptionConfiguration added in v1.8.0 

type TranscriptionConfiguration struct {

	// The transcription configuration settings passed to Amazon Transcribe Medical.
	EngineTranscribeMedicalSettings *EngineTranscribeMedicalSettings

	// The transcription configuration settings passed to Amazon Transcribe.
	EngineTranscribeSettings *EngineTranscribeSettings
	// contains filtered or unexported fields
}

The configuration for the current transcription operation. Must contain EngineTranscribeSettings or EngineTranscribeMedicalSettings .

type UnauthorizedClientException 

type UnauthorizedClientException struct {
	Message *string

	ErrorCodeOverride *string

	Code ErrorCode
	// contains filtered or unexported fields
}

The client is not currently authorized to make the request.

func (*UnauthorizedClientException) Error 

func (e *UnauthorizedClientException) Error() string

func (*UnauthorizedClientException) ErrorCode 

func (e *UnauthorizedClientException) ErrorCode() string

func (*UnauthorizedClientException) ErrorFault 

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

func (*UnauthorizedClientException) ErrorMessage 

func (e *UnauthorizedClientException) ErrorMessage() string

type UnprocessableEntityException 

type UnprocessableEntityException struct {
	Message *string

	ErrorCodeOverride *string

	Code ErrorCode
	// contains filtered or unexported fields
}

The request was well-formed but was unable to be followed due to semantic errors.

func (*UnprocessableEntityException) Error 

func (e *UnprocessableEntityException) Error() string

func (*UnprocessableEntityException) ErrorCode 

func (e *UnprocessableEntityException) ErrorCode() string

func (*UnprocessableEntityException) ErrorFault 

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

func (*UnprocessableEntityException) ErrorMessage 

func (e *UnprocessableEntityException) ErrorMessage() string

type UpdatePhoneNumberRequestItem 

type UpdatePhoneNumberRequestItem struct {

	// The phone number ID to update.
	//
	// This member is required.
	PhoneNumberId *string

	// The outbound calling name to update.
	CallingName *string

	// The product type to update.
	ProductType PhoneNumberProductType
	// contains filtered or unexported fields
}

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

The user ID and user fields to update, used with the BatchUpdateUser action.

type User 

type User struct {

	// The user ID.
	//
	// This member is required.
	UserId *string

	// The Amazon Chime account ID.
	AccountId *string

	// The Alexa for Business metadata.
	AlexaForBusinessMetadata *AlexaForBusinessMetadata

	// The display name of the user.
	DisplayName *string

	// Date and time when the user is invited to the Amazon Chime account, in ISO 8601
	// format.
	InvitedOn *time.Time

	// The license type for the user.
	LicenseType License

	// The user's personal meeting PIN.
	PersonalPIN *string

	// The primary email address of the user.
	PrimaryEmail *string

	// The primary phone number associated with the user.
	PrimaryProvisionedNumber *string

	// Date and time when the user is registered, in ISO 8601 format.
	RegisteredOn *time.Time

	// The user invite status.
	UserInvitationStatus InviteStatus

	// The user registration status.
	UserRegistrationStatus RegistrationStatus

	// The user type.
	UserType UserType
	// contains filtered or unexported fields
}

The user on the Amazon Chime account.

type UserError 

type UserError struct {

	// The error code.
	ErrorCode ErrorCode

	// The error message.
	ErrorMessage *string

	// The user ID for which the action failed.
	UserId *string
	// contains filtered or unexported fields
}

The list of errors returned when errors are encountered during the BatchSuspendUser , BatchUnsuspendUser , or BatchUpdateUser actions. This includes user IDs, error codes, and error messages.

type UserSettings 

type UserSettings struct {

	// The telephony settings associated with the user.
	//
	// This member is required.
	Telephony *TelephonySettings
	// contains filtered or unexported fields
}

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

type UserType 

type UserType string
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 VideoArtifactsConfiguration added in v1.11.0 

type VideoArtifactsConfiguration struct {

	// Indicates whether the video artifact is enabled or disabled.
	//
	// This member is required.
	State ArtifactsState

	// The MUX type of the video artifact configuration object.
	MuxType VideoMuxType
	// contains filtered or unexported fields
}

The video artifact configuration object.

type VideoMuxType added in v1.11.0 

type VideoMuxType string
const (
	VideoMuxTypeVideoOnly VideoMuxType = "VideoOnly"
)

Enum values for VideoMuxType

func (VideoMuxType) Values added in v1.11.0 

func (VideoMuxType) Values() []VideoMuxType

Values returns all known values for VideoMuxType. 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 ARN of the specified Amazon Chime Voice Connector.
	VoiceConnectorArn *string

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

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

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

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

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

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

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

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.