types

package
v1.21.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 AddressBook 

type AddressBook struct {

	// The ARN of the address book.
	AddressBookArn *string

	// The description of the address book.
	Description *string

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

An address book with attributes.

type AddressBookData 

type AddressBookData struct {

	// The ARN of the address book.
	AddressBookArn *string

	// The description of the address book.
	Description *string

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

Information related to an address book.

type AlreadyExistsException 

type AlreadyExistsException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The resource being created already exists.

func (*AlreadyExistsException) Error 

func (e *AlreadyExistsException) Error() string

func (*AlreadyExistsException) ErrorCode 

func (e *AlreadyExistsException) ErrorCode() string

func (*AlreadyExistsException) ErrorFault 

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

func (*AlreadyExistsException) ErrorMessage 

func (e *AlreadyExistsException) ErrorMessage() string

type Audio 

type Audio struct {

	// The locale of the audio message. Currently, en-US is supported.
	//
	// This member is required.
	Locale Locale

	// The location of the audio file. Currently, S3 URLs are supported. Only S3
	// locations comprised of safe characters are valid. For more information, see
	// Safe Characters (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#Safe%20Characters)
	// .
	//
	// This member is required.
	Location *string
	// contains filtered or unexported fields
}

The audio message. There is a 1 MB limit on the audio file input and the only supported format is MP3. To convert your MP3 audio files to an Alexa-friendly, required codec version (MPEG version 2) and bit rate (48 kbps), you might use converter software. One option for this is a command-line tool, FFmpeg. For more information, see FFmpeg (https://www.ffmpeg.org/) . The following command converts the provided to an MP3 file that is played in the announcement: ffmpeg -i -ac 2 -codec:a libmp3lame -b:a 48k -ar 16000

type BusinessReport 

type BusinessReport struct {

	// The time of report delivery.
	DeliveryTime *time.Time

	// The download link where a user can download the report.
	DownloadUrl *string

	// The failure code.
	FailureCode BusinessReportFailureCode

	// The S3 location of the output reports.
	S3Location *BusinessReportS3Location

	// The status of the report generation execution (RUNNING, SUCCEEDED, or FAILED).
	Status BusinessReportStatus
	// contains filtered or unexported fields
}

Usage report with specified parameters.

type BusinessReportContentRange 

type BusinessReportContentRange struct {

	// The interval of the content range.
	//
	// This member is required.
	Interval BusinessReportInterval
	// contains filtered or unexported fields
}

The content range of the report.

type BusinessReportFailureCode 

type BusinessReportFailureCode string
const (
	BusinessReportFailureCodeAccessDenied    BusinessReportFailureCode = "ACCESS_DENIED"
	BusinessReportFailureCodeNoSuchBucket    BusinessReportFailureCode = "NO_SUCH_BUCKET"
	BusinessReportFailureCodeInternalFailure BusinessReportFailureCode = "INTERNAL_FAILURE"
)

Enum values for BusinessReportFailureCode

func (BusinessReportFailureCode) Values added in v0.29.0 

func (BusinessReportFailureCode) Values() []BusinessReportFailureCode

Values returns all known values for BusinessReportFailureCode. 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 BusinessReportFormat 

type BusinessReportFormat string
const (
	BusinessReportFormatCsv    BusinessReportFormat = "CSV"
	BusinessReportFormatCsvZip BusinessReportFormat = "CSV_ZIP"
)

Enum values for BusinessReportFormat

func (BusinessReportFormat) Values added in v0.29.0 

func (BusinessReportFormat) Values() []BusinessReportFormat

Values returns all known values for BusinessReportFormat. 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 BusinessReportInterval 

type BusinessReportInterval string
const (
	BusinessReportIntervalOneDay     BusinessReportInterval = "ONE_DAY"
	BusinessReportIntervalOneWeek    BusinessReportInterval = "ONE_WEEK"
	BusinessReportIntervalThirtyDays BusinessReportInterval = "THIRTY_DAYS"
)

Enum values for BusinessReportInterval

func (BusinessReportInterval) Values added in v0.29.0 

func (BusinessReportInterval) Values() []BusinessReportInterval

Values returns all known values for BusinessReportInterval. 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 BusinessReportRecurrence 

type BusinessReportRecurrence struct {

	// The start date.
	StartDate *string
	// contains filtered or unexported fields
}

The recurrence of the reports.

type BusinessReportS3Location 

type BusinessReportS3Location struct {

	// The S3 bucket name of the output reports.
	BucketName *string

	// The path of the business report.
	Path *string
	// contains filtered or unexported fields
}

The S3 location of the output reports.

type BusinessReportSchedule 

type BusinessReportSchedule struct {

	// The content range of the reports.
	ContentRange *BusinessReportContentRange

	// The format of the generated report (individual CSV files or zipped files of
	// individual files).
	Format BusinessReportFormat

	// The details of the last business report delivery for a specified time interval.
	LastBusinessReport *BusinessReport

	// The recurrence of the reports.
	Recurrence *BusinessReportRecurrence

	// The S3 bucket name of the output reports.
	S3BucketName *string

	// The S3 key where the report is delivered.
	S3KeyPrefix *string

	// The ARN of the business report schedule.
	ScheduleArn *string

	// The name identifier of the schedule.
	ScheduleName *string
	// contains filtered or unexported fields
}

The schedule of the usage report.

type BusinessReportStatus 

type BusinessReportStatus string
const (
	BusinessReportStatusRunning   BusinessReportStatus = "RUNNING"
	BusinessReportStatusSucceeded BusinessReportStatus = "SUCCEEDED"
	BusinessReportStatusFailed    BusinessReportStatus = "FAILED"
)

Enum values for BusinessReportStatus

func (BusinessReportStatus) Values added in v0.29.0 

func (BusinessReportStatus) Values() []BusinessReportStatus

Values returns all known values for BusinessReportStatus. 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 Category 

type Category struct {

	// The ID of the skill store category.
	CategoryId *int64

	// The name of the skill store category.
	CategoryName *string
	// contains filtered or unexported fields
}

The skill store category that is shown. Alexa skills are assigned a specific skill category during creation, such as News, Social, and Sports.

type CommsProtocol 

type CommsProtocol string
const (
	CommsProtocolSip  CommsProtocol = "SIP"
	CommsProtocolSips CommsProtocol = "SIPS"
	CommsProtocolH323 CommsProtocol = "H323"
)

Enum values for CommsProtocol

func (CommsProtocol) Values added in v0.29.0 

func (CommsProtocol) Values() []CommsProtocol

Values returns all known values for CommsProtocol. 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 ConcurrentModificationException 

type ConcurrentModificationException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

There is a concurrent modification of resources.

func (*ConcurrentModificationException) Error 

func (e *ConcurrentModificationException) Error() string

func (*ConcurrentModificationException) ErrorCode 

func (e *ConcurrentModificationException) ErrorCode() string

func (*ConcurrentModificationException) ErrorFault 

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

func (*ConcurrentModificationException) ErrorMessage 

func (e *ConcurrentModificationException) ErrorMessage() string

type ConferencePreference 

type ConferencePreference struct {

	// The ARN of the default conference provider.
	DefaultConferenceProviderArn *string
	// contains filtered or unexported fields
}

The default conference provider that is used if no other scheduled meetings are detected.

type ConferenceProvider 

type ConferenceProvider struct {

	// The ARN of the newly created conference provider.
	Arn *string

	// The IP endpoint and protocol for calling.
	IPDialIn *IPDialIn

	// The meeting settings for the conference provider.
	MeetingSetting *MeetingSetting

	// The name of the conference provider.
	Name *string

	// The information for PSTN conferencing.
	PSTNDialIn *PSTNDialIn

	// The type of conference providers.
	Type ConferenceProviderType
	// contains filtered or unexported fields
}

An entity that provides a conferencing solution. Alexa for Business acts as the voice interface and mediator that connects users to their preferred conference provider. Examples of conference providers include Amazon Chime, Zoom, Cisco, and Polycom.

type ConferenceProviderType 

type ConferenceProviderType string
const (
	ConferenceProviderTypeChime            ConferenceProviderType = "CHIME"
	ConferenceProviderTypeBluejeans        ConferenceProviderType = "BLUEJEANS"
	ConferenceProviderTypeFuze             ConferenceProviderType = "FUZE"
	ConferenceProviderTypeGoogleHangouts   ConferenceProviderType = "GOOGLE_HANGOUTS"
	ConferenceProviderTypePolycom          ConferenceProviderType = "POLYCOM"
	ConferenceProviderTypeRingcentral      ConferenceProviderType = "RINGCENTRAL"
	ConferenceProviderTypeSkypeForBusiness ConferenceProviderType = "SKYPE_FOR_BUSINESS"
	ConferenceProviderTypeWebex            ConferenceProviderType = "WEBEX"
	ConferenceProviderTypeZoom             ConferenceProviderType = "ZOOM"
	ConferenceProviderTypeCustom           ConferenceProviderType = "CUSTOM"
)

Enum values for ConferenceProviderType

func (ConferenceProviderType) Values added in v0.29.0 

func (ConferenceProviderType) Values() []ConferenceProviderType

Values returns all known values for ConferenceProviderType. 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 ConnectionStatus 

type ConnectionStatus string
const (
	ConnectionStatusOnline  ConnectionStatus = "ONLINE"
	ConnectionStatusOffline ConnectionStatus = "OFFLINE"
)

Enum values for ConnectionStatus

func (ConnectionStatus) Values added in v0.29.0 

func (ConnectionStatus) Values() []ConnectionStatus

Values returns all known values for ConnectionStatus. 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 Contact 

type Contact struct {

	// The ARN of the contact.
	ContactArn *string

	// The name of the contact to display on the console.
	DisplayName *string

	// The first name of the contact, used to call the contact on the device.
	FirstName *string

	// The last name of the contact, used to call the contact on the device.
	LastName *string

	// The phone number of the contact. The phone number type defaults to WORK. You
	// can either specify PhoneNumber or PhoneNumbers. We recommend that you use
	// PhoneNumbers, which lets you specify the phone number type and multiple numbers.
	PhoneNumber *string

	// The list of phone numbers for the contact.
	PhoneNumbers []PhoneNumber

	// The list of SIP addresses for the contact.
	SipAddresses []SipAddress
	// contains filtered or unexported fields
}

A contact with attributes.

type ContactData 

type ContactData struct {

	// The ARN of the contact.
	ContactArn *string

	// The name of the contact to display on the console.
	DisplayName *string

	// The first name of the contact, used to call the contact on the device.
	FirstName *string

	// The last name of the contact, used to call the contact on the device.
	LastName *string

	// The phone number of the contact. The phone number type defaults to WORK. You
	// can specify PhoneNumber or PhoneNumbers. We recommend that you use PhoneNumbers,
	// which lets you specify the phone number type and multiple numbers.
	PhoneNumber *string

	// The list of phone numbers for the contact.
	PhoneNumbers []PhoneNumber

	// The list of SIP addresses for the contact.
	SipAddresses []SipAddress
	// contains filtered or unexported fields
}

Information related to a contact.

type Content 

type Content struct {

	// The list of audio messages.
	AudioList []Audio

	// The list of SSML messages.
	SsmlList []Ssml

	// The list of text messages.
	TextList []Text
	// contains filtered or unexported fields
}

The content definition. This can contain only one text, SSML, or audio list object.

type CreateEndOfMeetingReminder 

type CreateEndOfMeetingReminder struct {

	// Whether an end of meeting reminder is enabled or not.
	//
	// This member is required.
	Enabled *bool

	// A range of 3 to 15 minutes that determines when the reminder begins.
	//
	// This member is required.
	ReminderAtMinutes []int32

	// The type of sound that users hear during the end of meeting reminder.
	//
	// This member is required.
	ReminderType EndOfMeetingReminderType
	// contains filtered or unexported fields
}

Creates settings for the end of meeting reminder feature that are applied to a room profile. The end of meeting reminder enables Alexa to remind users when a meeting is ending.

type CreateInstantBooking 

type CreateInstantBooking struct {

	// Duration between 15 and 240 minutes at increments of 15 that determines how
	// long to book an available room when a meeting is started with Alexa.
	//
	// This member is required.
	DurationInMinutes *int32

	// Whether instant booking is enabled or not.
	//
	// This member is required.
	Enabled *bool
	// contains filtered or unexported fields
}

Creates settings for the instant booking feature that are applied to a room profile. When users start their meeting with Alexa, Alexa automatically books the room for the configured duration if the room is available.

type CreateMeetingRoomConfiguration 

type CreateMeetingRoomConfiguration struct {

	// Creates settings for the end of meeting reminder feature that are applied to a
	// room profile. The end of meeting reminder enables Alexa to remind users when a
	// meeting is ending.
	EndOfMeetingReminder *CreateEndOfMeetingReminder

	// Settings to automatically book a room for a configured duration if it's free
	// when joining a meeting with Alexa.
	InstantBooking *CreateInstantBooking

	ProactiveJoin *CreateProactiveJoin

	// Settings for requiring a check in when a room is reserved. Alexa can cancel a
	// room reservation if it's not checked into to make the room available for others.
	// Users can check in by joining the meeting with Alexa or an AVS device, or by
	// saying “Alexa, check in.”
	RequireCheckIn *CreateRequireCheckIn

	// Whether room utilization metrics are enabled or not.
	RoomUtilizationMetricsEnabled *bool
	// contains filtered or unexported fields
}

Creates meeting room settings of a room profile.

type CreateProactiveJoin added in v1.15.11 

type CreateProactiveJoin struct {

	// This member is required.
	EnabledByMotion *bool
	// contains filtered or unexported fields
}

type CreateRequireCheckIn 

type CreateRequireCheckIn struct {

	// Whether require check in is enabled or not.
	//
	// This member is required.
	Enabled *bool

	// Duration between 5 and 20 minutes to determine when to release the room if it's
	// not checked into.
	//
	// This member is required.
	ReleaseAfterMinutes *int32
	// contains filtered or unexported fields
}

Creates settings for the require check in feature that are applied to a room profile. Require check in allows a meeting room’s Alexa or AVS device to prompt the user to check in; otherwise, the room will be released.

type DeveloperInfo 

type DeveloperInfo struct {

	// The name of the developer.
	DeveloperName *string

	// The email of the developer.
	Email *string

	// The URL of the privacy policy.
	PrivacyPolicy *string

	// The website of the developer.
	Url *string
	// contains filtered or unexported fields
}

The details about the developer that published the skill.

type Device 

type Device struct {

	// The ARN of a device.
	DeviceArn *string

	// The name of a device.
	DeviceName *string

	// The serial number of a device.
	DeviceSerialNumber *string

	// The status of a device. If the status is not READY, check the DeviceStatusInfo
	// value for details.
	DeviceStatus DeviceStatus

	// Detailed information about a device's status.
	DeviceStatusInfo *DeviceStatusInfo

	// The type of a device.
	DeviceType *string

	// The MAC address of a device.
	MacAddress *string

	// Detailed information about a device's network profile.
	NetworkProfileInfo *DeviceNetworkProfileInfo

	// The room ARN of a device.
	RoomArn *string

	// The software version of a device.
	SoftwareVersion *string
	// contains filtered or unexported fields
}

A device with attributes.

type DeviceData 

type DeviceData struct {

	// The time (in epoch) when the device data was created.
	CreatedTime *time.Time

	// The ARN of a device.
	DeviceArn *string

	// The name of a device.
	DeviceName *string

	// The serial number of a device.
	DeviceSerialNumber *string

	// The status of a device.
	DeviceStatus DeviceStatus

	// Detailed information about a device's status.
	DeviceStatusInfo *DeviceStatusInfo

	// The type of a device.
	DeviceType *string

	// The MAC address of a device.
	MacAddress *string

	// The ARN of the network profile associated with a device.
	NetworkProfileArn *string

	// The name of the network profile associated with a device.
	NetworkProfileName *string

	// The room ARN associated with a device.
	RoomArn *string

	// The name of the room associated with a device.
	RoomName *string

	// The software version of a device.
	SoftwareVersion *string
	// contains filtered or unexported fields
}

Device attributes.

type DeviceEvent 

type DeviceEvent struct {

	// The time (in epoch) when the event occurred.
	Timestamp *time.Time

	// The type of device event.
	Type DeviceEventType

	// The value of the event.
	Value *string
	// contains filtered or unexported fields
}

The list of device events.

type DeviceEventType 

type DeviceEventType string
const (
	DeviceEventTypeConnectionStatus DeviceEventType = "CONNECTION_STATUS"
	DeviceEventTypeDeviceStatus     DeviceEventType = "DEVICE_STATUS"
)

Enum values for DeviceEventType

func (DeviceEventType) Values added in v0.29.0 

func (DeviceEventType) Values() []DeviceEventType

Values returns all known values for DeviceEventType. 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 DeviceNetworkProfileInfo 

type DeviceNetworkProfileInfo struct {

	// The ARN of the certificate associated with a device.
	CertificateArn *string

	// The time (in epoch) when the certificate expires.
	CertificateExpirationTime *time.Time

	// The ARN of the network profile associated with a device.
	NetworkProfileArn *string
	// contains filtered or unexported fields
}

Detailed information about a device's network profile.

type DeviceNotRegisteredException 

type DeviceNotRegisteredException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The request failed because this device is no longer registered and therefore no longer managed by this account.

func (*DeviceNotRegisteredException) Error 

func (e *DeviceNotRegisteredException) Error() string

func (*DeviceNotRegisteredException) ErrorCode 

func (e *DeviceNotRegisteredException) ErrorCode() string

func (*DeviceNotRegisteredException) ErrorFault 

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

func (*DeviceNotRegisteredException) ErrorMessage 

func (e *DeviceNotRegisteredException) ErrorMessage() string

type DeviceStatus 

type DeviceStatus string
const (
	DeviceStatusReady        DeviceStatus = "READY"
	DeviceStatusPending      DeviceStatus = "PENDING"
	DeviceStatusWasOffline   DeviceStatus = "WAS_OFFLINE"
	DeviceStatusDeregistered DeviceStatus = "DEREGISTERED"
	DeviceStatusFailed       DeviceStatus = "FAILED"
)

Enum values for DeviceStatus

func (DeviceStatus) Values added in v0.29.0 

func (DeviceStatus) Values() []DeviceStatus

Values returns all known values for DeviceStatus. 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 DeviceStatusDetail 

type DeviceStatusDetail struct {

	// The device status detail code.
	Code DeviceStatusDetailCode

	// The list of available features on the device.
	Feature Feature
	// contains filtered or unexported fields
}

Details of a device’s status.

type DeviceStatusDetailCode 

type DeviceStatusDetailCode string
const (
	DeviceStatusDetailCodeDeviceSoftwareUpdateNeeded       DeviceStatusDetailCode = "DEVICE_SOFTWARE_UPDATE_NEEDED"
	DeviceStatusDetailCodeDeviceWasOffline                 DeviceStatusDetailCode = "DEVICE_WAS_OFFLINE"
	DeviceStatusDetailCodeCredentialsAccessFailure         DeviceStatusDetailCode = "CREDENTIALS_ACCESS_FAILURE"
	DeviceStatusDetailCodeTlsVersionMismatch               DeviceStatusDetailCode = "TLS_VERSION_MISMATCH"
	DeviceStatusDetailCodeAssociationRejection             DeviceStatusDetailCode = "ASSOCIATION_REJECTION"
	DeviceStatusDetailCodeAuthenticationFailure            DeviceStatusDetailCode = "AUTHENTICATION_FAILURE"
	DeviceStatusDetailCodeDhcpFailure                      DeviceStatusDetailCode = "DHCP_FAILURE"
	DeviceStatusDetailCodeInternetUnavailable              DeviceStatusDetailCode = "INTERNET_UNAVAILABLE"
	DeviceStatusDetailCodeDnsFailure                       DeviceStatusDetailCode = "DNS_FAILURE"
	DeviceStatusDetailCodeUnknownFailure                   DeviceStatusDetailCode = "UNKNOWN_FAILURE"
	DeviceStatusDetailCodeCertificateIssuingLimitExceeded  DeviceStatusDetailCode = "CERTIFICATE_ISSUING_LIMIT_EXCEEDED"
	DeviceStatusDetailCodeInvalidCertificateAuthority      DeviceStatusDetailCode = "INVALID_CERTIFICATE_AUTHORITY"
	DeviceStatusDetailCodeNetworkProfileNotFound           DeviceStatusDetailCode = "NETWORK_PROFILE_NOT_FOUND"
	DeviceStatusDetailCodeInvalidPasswordState             DeviceStatusDetailCode = "INVALID_PASSWORD_STATE"
	DeviceStatusDetailCodePasswordNotFound                 DeviceStatusDetailCode = "PASSWORD_NOT_FOUND"
	DeviceStatusDetailCodePasswordManagerAccessDenied      DeviceStatusDetailCode = "PASSWORD_MANAGER_ACCESS_DENIED"
	DeviceStatusDetailCodeCertificateAuthorityAccessDenied DeviceStatusDetailCode = "CERTIFICATE_AUTHORITY_ACCESS_DENIED"
)

Enum values for DeviceStatusDetailCode

func (DeviceStatusDetailCode) Values added in v0.29.0 

func (DeviceStatusDetailCode) Values() []DeviceStatusDetailCode

Values returns all known values for DeviceStatusDetailCode. 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 DeviceStatusInfo 

type DeviceStatusInfo struct {

	// The latest available information about the connection status of a device.
	ConnectionStatus ConnectionStatus

	// The time (in epoch) when the device connection status changed.
	ConnectionStatusUpdatedTime *time.Time

	// One or more device status detail descriptions.
	DeviceStatusDetails []DeviceStatusDetail
	// contains filtered or unexported fields
}

Detailed information about a device's status.

type DeviceUsageType 

type DeviceUsageType string
const (
	DeviceUsageTypeVoice DeviceUsageType = "VOICE"
)

Enum values for DeviceUsageType

func (DeviceUsageType) Values added in v0.29.0 

func (DeviceUsageType) Values() []DeviceUsageType

Values returns all known values for DeviceUsageType. 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 DistanceUnit 

type DistanceUnit string
const (
	DistanceUnitMetric   DistanceUnit = "METRIC"
	DistanceUnitImperial DistanceUnit = "IMPERIAL"
)

Enum values for DistanceUnit

func (DistanceUnit) Values added in v0.29.0 

func (DistanceUnit) Values() []DistanceUnit

Values returns all known values for DistanceUnit. 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 EnablementType 

type EnablementType string
const (
	EnablementTypeEnabled EnablementType = "ENABLED"
	EnablementTypePending EnablementType = "PENDING"
)

Enum values for EnablementType

func (EnablementType) Values added in v0.29.0 

func (EnablementType) Values() []EnablementType

Values returns all known values for EnablementType. 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 EnablementTypeFilter 

type EnablementTypeFilter string
const (
	EnablementTypeFilterEnabled EnablementTypeFilter = "ENABLED"
	EnablementTypeFilterPending EnablementTypeFilter = "PENDING"
)

Enum values for EnablementTypeFilter

func (EnablementTypeFilter) Values added in v0.29.0 

func (EnablementTypeFilter) Values() []EnablementTypeFilter

Values returns all known values for EnablementTypeFilter. 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 EndOfMeetingReminder 

type EndOfMeetingReminder struct {

	// Whether an end of meeting reminder is enabled or not.
	Enabled *bool

	// A range of 3 to 15 minutes that determines when the reminder begins.
	ReminderAtMinutes []int32

	// The type of sound that users hear during the end of meeting reminder.
	ReminderType EndOfMeetingReminderType
	// contains filtered or unexported fields
}

Settings for the end of meeting reminder feature that are applied to a room profile. The end of meeting reminder enables Alexa to remind users when a meeting is ending.

type EndOfMeetingReminderType 

type EndOfMeetingReminderType string
const (
	EndOfMeetingReminderTypeAnnouncementTimeCheck        EndOfMeetingReminderType = "ANNOUNCEMENT_TIME_CHECK"
	EndOfMeetingReminderTypeAnnouncementVariableTimeLeft EndOfMeetingReminderType = "ANNOUNCEMENT_VARIABLE_TIME_LEFT"
	EndOfMeetingReminderTypeChime                        EndOfMeetingReminderType = "CHIME"
	EndOfMeetingReminderTypeKnock                        EndOfMeetingReminderType = "KNOCK"
)

Enum values for EndOfMeetingReminderType

func (EndOfMeetingReminderType) Values added in v0.29.0 

func (EndOfMeetingReminderType) Values() []EndOfMeetingReminderType

Values returns all known values for EndOfMeetingReminderType. 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 EnrollmentStatus 

type EnrollmentStatus string
const (
	EnrollmentStatusInitialized    EnrollmentStatus = "INITIALIZED"
	EnrollmentStatusPending        EnrollmentStatus = "PENDING"
	EnrollmentStatusRegistered     EnrollmentStatus = "REGISTERED"
	EnrollmentStatusDisassociating EnrollmentStatus = "DISASSOCIATING"
	EnrollmentStatusDeregistering  EnrollmentStatus = "DEREGISTERING"
)

Enum values for EnrollmentStatus

func (EnrollmentStatus) Values added in v0.29.0 

func (EnrollmentStatus) Values() []EnrollmentStatus

Values returns all known values for EnrollmentStatus. 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 Feature 

type Feature string
const (
	FeatureBluetooth      Feature = "BLUETOOTH"
	FeatureVolume         Feature = "VOLUME"
	FeatureNotifications  Feature = "NOTIFICATIONS"
	FeatureLists          Feature = "LISTS"
	FeatureSkills         Feature = "SKILLS"
	FeatureNetworkProfile Feature = "NETWORK_PROFILE"
	FeatureSettings       Feature = "SETTINGS"
	FeatureAll            Feature = "ALL"
)

Enum values for Feature

func (Feature) Values added in v0.29.0 

func (Feature) Values() []Feature

Values returns all known values for Feature. 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 Filter 

type Filter struct {

	// The key of a filter.
	//
	// This member is required.
	Key *string

	// The values of a filter.
	//
	// This member is required.
	Values []string
	// contains filtered or unexported fields
}

A filter name and value pair that is used to return a more specific list of results. Filters can be used to match a set of resources by various criteria.

type Gateway 

type Gateway struct {

	// The ARN of the gateway.
	Arn *string

	// The description of the gateway.
	Description *string

	// The ARN of the gateway group that the gateway is associated to.
	GatewayGroupArn *string

	// The name of the gateway.
	Name *string

	// The software version of the gateway. The gateway automatically updates its
	// software version during normal operation.
	SoftwareVersion *string
	// contains filtered or unexported fields
}

The details of the gateway.

type GatewayGroup 

type GatewayGroup struct {

	// The ARN of the gateway group.
	Arn *string

	// The description of the gateway group.
	Description *string

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

The details of the gateway group.

type GatewayGroupSummary 

type GatewayGroupSummary struct {

	// The ARN of the gateway group.
	Arn *string

	// The description of the gateway group.
	Description *string

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

The summary of a gateway group.

type GatewaySummary 

type GatewaySummary struct {

	// The ARN of the gateway.
	Arn *string

	// The description of the gateway.
	Description *string

	// The ARN of the gateway group that the gateway is associated to.
	GatewayGroupArn *string

	// The name of the gateway.
	Name *string

	// The software version of the gateway. The gateway automatically updates its
	// software version during normal operation.
	SoftwareVersion *string
	// contains filtered or unexported fields
}

The summary of a gateway.

type IPDialIn 

type IPDialIn struct {

	// The protocol, including SIP, SIPS, and H323.
	//
	// This member is required.
	CommsProtocol CommsProtocol

	// The IP address.
	//
	// This member is required.
	Endpoint *string
	// contains filtered or unexported fields
}

The IP endpoint and protocol for calling.

type InstantBooking 

type InstantBooking struct {

	// Duration between 15 and 240 minutes at increments of 15 that determines how
	// long to book an available room when a meeting is started with Alexa.
	DurationInMinutes *int32

	// Whether instant booking is enabled or not.
	Enabled *bool
	// contains filtered or unexported fields
}

Settings for the instant booking feature that are applied to a room profile. When users start their meeting with Alexa, Alexa automatically books the room for the configured duration if the room is available.

type InvalidCertificateAuthorityException 

type InvalidCertificateAuthorityException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The Certificate Authority can't issue or revoke a certificate.

func (*InvalidCertificateAuthorityException) Error 

func (e *InvalidCertificateAuthorityException) Error() string

func (*InvalidCertificateAuthorityException) ErrorCode 

func (e *InvalidCertificateAuthorityException) ErrorCode() string

func (*InvalidCertificateAuthorityException) ErrorFault 

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

func (*InvalidCertificateAuthorityException) ErrorMessage 

func (e *InvalidCertificateAuthorityException) ErrorMessage() string

type InvalidDeviceException 

type InvalidDeviceException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The device is in an invalid state.

func (*InvalidDeviceException) Error 

func (e *InvalidDeviceException) Error() string

func (*InvalidDeviceException) ErrorCode 

func (e *InvalidDeviceException) ErrorCode() string

func (*InvalidDeviceException) ErrorFault 

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

func (*InvalidDeviceException) ErrorMessage 

func (e *InvalidDeviceException) ErrorMessage() string

type InvalidSecretsManagerResourceException 

type InvalidSecretsManagerResourceException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

A password in SecretsManager is in an invalid state.

func (*InvalidSecretsManagerResourceException) Error 

func (e *InvalidSecretsManagerResourceException) Error() string

func (*InvalidSecretsManagerResourceException) ErrorCode 

func (e *InvalidSecretsManagerResourceException) ErrorCode() string

func (*InvalidSecretsManagerResourceException) ErrorFault 

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

func (*InvalidSecretsManagerResourceException) ErrorMessage 

func (e *InvalidSecretsManagerResourceException) ErrorMessage() string

type InvalidServiceLinkedRoleStateException 

type InvalidServiceLinkedRoleStateException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The service linked role is locked for deletion.

func (*InvalidServiceLinkedRoleStateException) Error 

func (e *InvalidServiceLinkedRoleStateException) Error() string

func (*InvalidServiceLinkedRoleStateException) ErrorCode 

func (e *InvalidServiceLinkedRoleStateException) ErrorCode() string

func (*InvalidServiceLinkedRoleStateException) ErrorFault 

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

func (*InvalidServiceLinkedRoleStateException) ErrorMessage 

func (e *InvalidServiceLinkedRoleStateException) ErrorMessage() string

type InvalidUserStatusException 

type InvalidUserStatusException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The attempt to update a user is invalid due to the user's current status.

func (*InvalidUserStatusException) Error 

func (e *InvalidUserStatusException) Error() string

func (*InvalidUserStatusException) ErrorCode 

func (e *InvalidUserStatusException) ErrorCode() string

func (*InvalidUserStatusException) ErrorFault 

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

func (*InvalidUserStatusException) ErrorMessage 

func (e *InvalidUserStatusException) ErrorMessage() string

type LimitExceededException 

type LimitExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

You are performing an action that would put you beyond your account's limits.

func (*LimitExceededException) Error 

func (e *LimitExceededException) Error() string

func (*LimitExceededException) ErrorCode 

func (e *LimitExceededException) ErrorCode() string

func (*LimitExceededException) ErrorFault 

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

func (*LimitExceededException) ErrorMessage 

func (e *LimitExceededException) ErrorMessage() string

type Locale 

type Locale string
const (
	LocaleEnUs Locale = "en-US"
)

Enum values for Locale

func (Locale) Values added in v0.29.0 

func (Locale) Values() []Locale

Values returns all known values for Locale. 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 MeetingRoomConfiguration 

type MeetingRoomConfiguration struct {

	// Settings for the end of meeting reminder feature that are applied to a room
	// profile. The end of meeting reminder enables Alexa to remind users when a
	// meeting is ending.
	EndOfMeetingReminder *EndOfMeetingReminder

	// Settings to automatically book the room if available for a configured duration
	// when joining a meeting with Alexa.
	InstantBooking *InstantBooking

	ProactiveJoin *ProactiveJoin

	// Settings for requiring a check in when a room is reserved. Alexa can cancel a
	// room reservation if it's not checked into. This makes the room available for
	// others. Users can check in by joining the meeting with Alexa or an AVS device,
	// or by saying “Alexa, check in.”
	RequireCheckIn *RequireCheckIn

	// Whether room utilization metrics are enabled or not.
	RoomUtilizationMetricsEnabled *bool
	// contains filtered or unexported fields
}

Meeting room settings of a room profile.

type MeetingSetting 

type MeetingSetting struct {

	// The values that indicate whether the pin is always required.
	//
	// This member is required.
	RequirePin RequirePin
	// contains filtered or unexported fields
}

The values that indicate whether a pin is always required (YES), never required (NO), or OPTIONAL.

  • If YES, Alexa will always ask for a meeting pin.
  • If NO, Alexa will never ask for a meeting pin.
  • If OPTIONAL, Alexa will ask if you have a meeting pin and if the customer responds with yes, it will ask for the meeting pin.

type NameInUseException 

type NameInUseException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The name sent in the request is already in use.

func (*NameInUseException) Error 

func (e *NameInUseException) Error() string

func (*NameInUseException) ErrorCode 

func (e *NameInUseException) ErrorCode() string

func (*NameInUseException) ErrorFault 

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

func (*NameInUseException) ErrorMessage 

func (e *NameInUseException) ErrorMessage() string

type NetworkEapMethod 

type NetworkEapMethod string
const (
	NetworkEapMethodEapTls NetworkEapMethod = "EAP_TLS"
)

Enum values for NetworkEapMethod

func (NetworkEapMethod) Values added in v0.29.0 

func (NetworkEapMethod) Values() []NetworkEapMethod

Values returns all known values for NetworkEapMethod. 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 NetworkProfile 

type NetworkProfile struct {

	// The ARN of the Private Certificate Authority (PCA) created in AWS Certificate
	// Manager (ACM). This is used to issue certificates to the devices.
	CertificateAuthorityArn *string

	// The current password of the Wi-Fi network.
	CurrentPassword *string

	// Detailed information about a device's network profile.
	Description *string

	// The authentication standard that is used in the EAP framework. Currently,
	// EAP_TLS is supported.
	EapMethod NetworkEapMethod

	// The ARN of the network profile associated with a device.
	NetworkProfileArn *string

	// The name of the network profile associated with a device.
	NetworkProfileName *string

	// The next, or subsequent, password of the Wi-Fi network. This password is
	// asynchronously transmitted to the device and is used when the password of the
	// network changes to NextPassword.
	NextPassword *string

	// The security type of the Wi-Fi network. This can be WPA2_ENTERPRISE, WPA2_PSK,
	// WPA_PSK, WEP, or OPEN.
	SecurityType NetworkSecurityType

	// The SSID of the Wi-Fi network.
	Ssid *string

	// The root certificates of your authentication server, which is installed on your
	// devices and used to trust your authentication server during EAP negotiation.
	TrustAnchors []string
	// contains filtered or unexported fields
}

The network profile associated with a device.

type NetworkProfileData 

type NetworkProfileData struct {

	// The ARN of the Private Certificate Authority (PCA) created in AWS Certificate
	// Manager (ACM). This is used to issue certificates to the devices.
	CertificateAuthorityArn *string

	// Detailed information about a device's network profile.
	Description *string

	// The authentication standard that is used in the EAP framework. Currently,
	// EAP_TLS is supported.
	EapMethod NetworkEapMethod

	// The ARN of the network profile associated with a device.
	NetworkProfileArn *string

	// The name of the network profile associated with a device.
	NetworkProfileName *string

	// The security type of the Wi-Fi network. This can be WPA2_ENTERPRISE, WPA2_PSK,
	// WPA_PSK, WEP, or OPEN.
	SecurityType NetworkSecurityType

	// The SSID of the Wi-Fi network.
	Ssid *string
	// contains filtered or unexported fields
}

The data associated with a network profile.

type NetworkSecurityType 

type NetworkSecurityType string
const (
	NetworkSecurityTypeOpen           NetworkSecurityType = "OPEN"
	NetworkSecurityTypeWep            NetworkSecurityType = "WEP"
	NetworkSecurityTypeWpaPsk         NetworkSecurityType = "WPA_PSK"
	NetworkSecurityTypeWpa2Psk        NetworkSecurityType = "WPA2_PSK"
	NetworkSecurityTypeWpa2Enterprise NetworkSecurityType = "WPA2_ENTERPRISE"
)

Enum values for NetworkSecurityType

func (NetworkSecurityType) Values added in v0.29.0 

func (NetworkSecurityType) Values() []NetworkSecurityType

Values returns all known values for NetworkSecurityType. 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 NotFoundException 

type NotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The resource is not found.

func (*NotFoundException) Error 

func (e *NotFoundException) Error() string

func (*NotFoundException) ErrorCode 

func (e *NotFoundException) ErrorCode() string

func (*NotFoundException) ErrorFault 

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

func (*NotFoundException) ErrorMessage 

func (e *NotFoundException) ErrorMessage() string

type PSTNDialIn 

type PSTNDialIn struct {

	// The zip code.
	//
	// This member is required.
	CountryCode *string

	// The delay duration before Alexa enters the conference ID with dual-tone
	// multi-frequency (DTMF). Each number on the dial pad corresponds to a DTMF tone,
	// which is how we send data over the telephone network.
	//
	// This member is required.
	OneClickIdDelay *string

	// The delay duration before Alexa enters the conference pin with dual-tone
	// multi-frequency (DTMF). Each number on the dial pad corresponds to a DTMF tone,
	// which is how we send data over the telephone network.
	//
	// This member is required.
	OneClickPinDelay *string

	// The phone number to call to join the conference.
	//
	// This member is required.
	PhoneNumber *string
	// contains filtered or unexported fields
}

The information for public switched telephone network (PSTN) conferencing.

type PhoneNumber 

type PhoneNumber struct {

	// The raw value of the phone number.
	//
	// This member is required.
	Number *string

	// The type of the phone number.
	//
	// This member is required.
	Type PhoneNumberType
	// contains filtered or unexported fields
}

The phone number for the contact containing the raw number and phone number type.

type PhoneNumberType 

type PhoneNumberType string
const (
	PhoneNumberTypeMobile PhoneNumberType = "MOBILE"
	PhoneNumberTypeWork   PhoneNumberType = "WORK"
	PhoneNumberTypeHome   PhoneNumberType = "HOME"
)

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 ProactiveJoin added in v1.15.11 

type ProactiveJoin struct {
	EnabledByMotion *bool
	// contains filtered or unexported fields
}

type Profile 

type Profile struct {

	// The address of a room profile.
	Address *string

	// The ARN of the address book.
	AddressBookArn *string

	// Whether data retention of the profile is enabled.
	DataRetentionOptIn *bool

	// The distance unit of a room profile.
	DistanceUnit DistanceUnit

	// Retrieves if the profile is default or not.
	IsDefault *bool

	// The locale of a room profile. (This is currently available only to a limited
	// preview audience.)
	Locale *string

	// The max volume limit of a room profile.
	MaxVolumeLimit *int32

	// Meeting room settings of a room profile.
	MeetingRoomConfiguration *MeetingRoomConfiguration

	// The PSTN setting of a room profile.
	PSTNEnabled *bool

	// The ARN of a room profile.
	ProfileArn *string

	// The name of a room profile.
	ProfileName *string

	// The setup mode of a room profile.
	SetupModeDisabled *bool

	// The temperature unit of a room profile.
	TemperatureUnit TemperatureUnit

	// The time zone of a room profile.
	Timezone *string

	// The wake word of a room profile.
	WakeWord WakeWord
	// contains filtered or unexported fields
}

A room profile with attributes.

type ProfileData 

type ProfileData struct {

	// The address of a room profile.
	Address *string

	// The distance unit of a room profile.
	DistanceUnit DistanceUnit

	// Retrieves if the profile data is default or not.
	IsDefault *bool

	// The locale of a room profile. (This is currently available only to a limited
	// preview audience.)
	Locale *string

	// The ARN of a room profile.
	ProfileArn *string

	// The name of a room profile.
	ProfileName *string

	// The temperature unit of a room profile.
	TemperatureUnit TemperatureUnit

	// The time zone of a room profile.
	Timezone *string

	// The wake word of a room profile.
	WakeWord WakeWord
	// contains filtered or unexported fields
}

The data of a room profile.

type RequireCheckIn 

type RequireCheckIn struct {

	// Whether require check in is enabled or not.
	Enabled *bool

	// Duration between 5 and 20 minutes to determine when to release the room if it's
	// not checked into.
	ReleaseAfterMinutes *int32
	// contains filtered or unexported fields
}

Settings for the require check in feature that are applied to a room profile. Require check in allows a meeting room’s Alexa or AVS device to prompt the user to check in; otherwise, the room will be released.

type RequirePin 

type RequirePin string
const (
	RequirePinYes      RequirePin = "YES"
	RequirePinNo       RequirePin = "NO"
	RequirePinOptional RequirePin = "OPTIONAL"
)

Enum values for RequirePin

func (RequirePin) Values added in v0.29.0 

func (RequirePin) Values() []RequirePin

Values returns all known values for RequirePin. 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 ResourceAssociatedException 

type ResourceAssociatedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Another resource is associated with the resource in the request.

func (*ResourceAssociatedException) Error 

func (e *ResourceAssociatedException) Error() string

func (*ResourceAssociatedException) ErrorCode 

func (e *ResourceAssociatedException) ErrorCode() string

func (*ResourceAssociatedException) ErrorFault 

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

func (*ResourceAssociatedException) ErrorMessage 

func (e *ResourceAssociatedException) ErrorMessage() string

type ResourceInUseException 

type ResourceInUseException struct {
	Message *string

	ErrorCodeOverride *string

	ClientRequestToken *string
	// contains filtered or unexported fields
}

The resource in the request is already in use.

func (*ResourceInUseException) Error 

func (e *ResourceInUseException) Error() string

func (*ResourceInUseException) ErrorCode 

func (e *ResourceInUseException) ErrorCode() string

func (*ResourceInUseException) ErrorFault 

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

func (*ResourceInUseException) ErrorMessage 

func (e *ResourceInUseException) ErrorMessage() string

type Room 

type Room struct {

	// The description of a room.
	Description *string

	// The profile ARN of a room.
	ProfileArn *string

	// The provider calendar ARN of a room.
	ProviderCalendarId *string

	// The ARN of a room.
	RoomArn *string

	// The name of a room.
	RoomName *string
	// contains filtered or unexported fields
}

A room with attributes.

type RoomData 

type RoomData struct {

	// The description of a room.
	Description *string

	// The profile ARN of a room.
	ProfileArn *string

	// The profile name of a room.
	ProfileName *string

	// The provider calendar ARN of a room.
	ProviderCalendarId *string

	// The ARN of a room.
	RoomArn *string

	// The name of a room.
	RoomName *string
	// contains filtered or unexported fields
}

The data of a room.

type RoomSkillParameter 

type RoomSkillParameter struct {

	// The parameter key of a room skill parameter. ParameterKey is an enumerated type
	// that only takes “DEFAULT” or “SCOPE” as valid values.
	//
	// This member is required.
	ParameterKey *string

	// The parameter value of a room skill parameter.
	//
	// This member is required.
	ParameterValue *string
	// contains filtered or unexported fields
}

A skill parameter associated with a room.

type SipAddress 

type SipAddress struct {

	// The type of the SIP address.
	//
	// This member is required.
	Type SipType

	// The URI for the SIP address.
	//
	// This member is required.
	Uri *string
	// contains filtered or unexported fields
}

The SIP address for the contact containing the URI and SIP address type.

type SipType 

type SipType string
const (
	SipTypeWork SipType = "WORK"
)

Enum values for SipType

func (SipType) Values added in v0.29.0 

func (SipType) Values() []SipType

Values returns all known values for SipType. 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 SkillDetails 

type SkillDetails struct {

	// The details about what the skill supports organized as bullet points.
	BulletPoints []string

	// The details about the developer that published the skill.
	DeveloperInfo *DeveloperInfo

	// The URL of the end user license agreement.
	EndUserLicenseAgreement *string

	// The generic keywords associated with the skill that can be used to find a skill.
	GenericKeywords []string

	// The phrase used to trigger the skill.
	InvocationPhrase *string

	// The updates added in bullet points.
	NewInThisVersionBulletPoints []string

	// The description of the product.
	ProductDescription *string

	// The date when the skill was released.
	ReleaseDate *string

	// This member has been deprecated. The list of reviews for the skill, including
	// Key and Value pair.
	Reviews map[string]string

	// The types of skills.
	SkillTypes []string
	// contains filtered or unexported fields
}

Granular information about the skill.

type SkillGroup 

type SkillGroup struct {

	// The description of a skill group.
	Description *string

	// The ARN of a skill group.
	SkillGroupArn *string

	// The name of a skill group.
	SkillGroupName *string
	// contains filtered or unexported fields
}

A skill group with attributes.

type SkillGroupData 

type SkillGroupData struct {

	// The description of a skill group.
	Description *string

	// The skill group ARN of a skill group.
	SkillGroupArn *string

	// The skill group name of a skill group.
	SkillGroupName *string
	// contains filtered or unexported fields
}

The attributes of a skill group.

type SkillNotLinkedException 

type SkillNotLinkedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The skill must be linked to a third-party account.

func (*SkillNotLinkedException) Error 

func (e *SkillNotLinkedException) Error() string

func (*SkillNotLinkedException) ErrorCode 

func (e *SkillNotLinkedException) ErrorCode() string

func (*SkillNotLinkedException) ErrorFault 

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

func (*SkillNotLinkedException) ErrorMessage 

func (e *SkillNotLinkedException) ErrorMessage() string

type SkillSummary 

type SkillSummary struct {

	// Whether the skill is enabled under the user's account, or if it requires
	// linking to be used.
	EnablementType EnablementType

	// The ARN of the skill summary.
	SkillId *string

	// The name of the skill.
	SkillName *string

	// Whether the skill is publicly available or is a private skill.
	SkillType SkillType

	// Linking support for a skill.
	SupportsLinking bool
	// contains filtered or unexported fields
}

The summary of skills.

type SkillType 

type SkillType string
const (
	SkillTypePublic  SkillType = "PUBLIC"
	SkillTypePrivate SkillType = "PRIVATE"
)

Enum values for SkillType

func (SkillType) Values added in v0.29.0 

func (SkillType) Values() []SkillType

Values returns all known values for SkillType. 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 SkillTypeFilter 

type SkillTypeFilter string
const (
	SkillTypeFilterPublic  SkillTypeFilter = "PUBLIC"
	SkillTypeFilterPrivate SkillTypeFilter = "PRIVATE"
	SkillTypeFilterAll     SkillTypeFilter = "ALL"
)

Enum values for SkillTypeFilter

func (SkillTypeFilter) Values added in v0.29.0 

func (SkillTypeFilter) Values() []SkillTypeFilter

Values returns all known values for SkillTypeFilter. 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 SkillsStoreSkill 

type SkillsStoreSkill struct {

	// The URL where the skill icon resides.
	IconUrl *string

	// Sample utterances that interact with the skill.
	SampleUtterances []string

	// Short description about the skill.
	ShortDescription *string

	// Information about the skill.
	SkillDetails *SkillDetails

	// The ARN of the skill.
	SkillId *string

	// The name of the skill.
	SkillName *string

	// Linking support for a skill.
	SupportsLinking bool
	// contains filtered or unexported fields
}

The detailed information about an Alexa skill.

type SmartHomeAppliance 

type SmartHomeAppliance struct {

	// The description of the smart home appliance.
	Description *string

	// The friendly name of the smart home appliance.
	FriendlyName *string

	// The name of the manufacturer of the smart home appliance.
	ManufacturerName *string
	// contains filtered or unexported fields
}

A smart home appliance that can connect to a central system. Any domestic device can be a smart appliance.

type Sort 

type Sort struct {

	// The sort key of a sort object.
	//
	// This member is required.
	Key *string

	// The sort value of a sort object.
	//
	// This member is required.
	Value SortValue
	// contains filtered or unexported fields
}

An object representing a sort criteria.

type SortValue 

type SortValue string
const (
	SortValueAsc  SortValue = "ASC"
	SortValueDesc SortValue = "DESC"
)

Enum values for SortValue

func (SortValue) Values added in v0.29.0 

func (SortValue) Values() []SortValue

Values returns all known values for SortValue. 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 Ssml 

type Ssml struct {

	// The locale of the SSML message. Currently, en-US is supported.
	//
	// This member is required.
	Locale Locale

	// The value of the SSML message in the correct SSML format. The audio tag is not
	// supported.
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

The SSML message. For more information, see SSML Reference (https://developer.amazon.com/docs/custom-skills/speech-synthesis-markup-language-ssml-reference.html) .

type Tag 

type Tag struct {

	// The key of a tag. Tag keys are case-sensitive.
	//
	// This member is required.
	Key *string

	// The value of a tag. Tag values are case sensitive and can be null.
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

A key-value pair that can be associated with a resource.

type TemperatureUnit 

type TemperatureUnit string
const (
	TemperatureUnitFahrenheit TemperatureUnit = "FAHRENHEIT"
	TemperatureUnitCelsius    TemperatureUnit = "CELSIUS"
)

Enum values for TemperatureUnit

func (TemperatureUnit) Values added in v0.29.0 

func (TemperatureUnit) Values() []TemperatureUnit

Values returns all known values for TemperatureUnit. 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 Text 

type Text struct {

	// The locale of the text message. Currently, en-US is supported.
	//
	// This member is required.
	Locale Locale

	// The value of the text message.
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

The text message.

type UnauthorizedException 

type UnauthorizedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The caller has no permissions to operate on the resource involved in the API call.

func (*UnauthorizedException) Error 

func (e *UnauthorizedException) Error() string

func (*UnauthorizedException) ErrorCode 

func (e *UnauthorizedException) ErrorCode() string

func (*UnauthorizedException) ErrorFault 

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

func (*UnauthorizedException) ErrorMessage 

func (e *UnauthorizedException) ErrorMessage() string

type UpdateEndOfMeetingReminder 

type UpdateEndOfMeetingReminder struct {

	// Whether an end of meeting reminder is enabled or not.
	Enabled *bool

	// Updates settings for the end of meeting reminder feature that are applied to a
	// room profile. The end of meeting reminder enables Alexa to remind users when a
	// meeting is ending.
	ReminderAtMinutes []int32

	// The type of sound that users hear during the end of meeting reminder.
	ReminderType EndOfMeetingReminderType
	// contains filtered or unexported fields
}

Settings for the end of meeting reminder feature that are applied to a room profile. The end of meeting reminder enables Alexa to remind users when a meeting is ending.

type UpdateInstantBooking 

type UpdateInstantBooking struct {

	// Duration between 15 and 240 minutes at increments of 15 that determines how
	// long to book an available room when a meeting is started with Alexa.
	DurationInMinutes *int32

	// Whether instant booking is enabled or not.
	Enabled *bool
	// contains filtered or unexported fields
}

Updates settings for the instant booking feature that are applied to a room profile. If instant booking is enabled, Alexa automatically reserves a room if it is free when a user joins a meeting with Alexa.

type UpdateMeetingRoomConfiguration 

type UpdateMeetingRoomConfiguration struct {

	// Settings for the end of meeting reminder feature that are applied to a room
	// profile. The end of meeting reminder enables Alexa to remind users when a
	// meeting is ending.
	EndOfMeetingReminder *UpdateEndOfMeetingReminder

	// Settings to automatically book an available room available for a configured
	// duration when joining a meeting with Alexa.
	InstantBooking *UpdateInstantBooking

	ProactiveJoin *UpdateProactiveJoin

	// Settings for requiring a check in when a room is reserved. Alexa can cancel a
	// room reservation if it's not checked into to make the room available for others.
	// Users can check in by joining the meeting with Alexa or an AVS device, or by
	// saying “Alexa, check in.”
	RequireCheckIn *UpdateRequireCheckIn

	// Whether room utilization metrics are enabled or not.
	RoomUtilizationMetricsEnabled *bool
	// contains filtered or unexported fields
}

Updates meeting room settings of a room profile.

type UpdateProactiveJoin added in v1.15.11 

type UpdateProactiveJoin struct {

	// This member is required.
	EnabledByMotion *bool
	// contains filtered or unexported fields
}

type UpdateRequireCheckIn 

type UpdateRequireCheckIn struct {

	// Whether require check in is enabled or not.
	Enabled *bool

	// Duration between 5 and 20 minutes to determine when to release the room if it's
	// not checked into.
	ReleaseAfterMinutes *int32
	// contains filtered or unexported fields
}

Updates settings for the require check in feature that are applied to a room profile. Require check in allows a meeting room’s Alexa or AVS device to prompt the user to check in; otherwise, the room will be released.

type UserData 

type UserData struct {

	// The email of a user.
	Email *string

	// The enrollment ARN of a user.
	EnrollmentId *string

	// The enrollment status of a user.
	EnrollmentStatus EnrollmentStatus

	// The first name of a user.
	FirstName *string

	// The last name of a user.
	LastName *string

	// The ARN of a user.
	UserArn *string
	// contains filtered or unexported fields
}

Information related to a user.

type WakeWord 

type WakeWord string
const (
	WakeWordAlexa    WakeWord = "ALEXA"
	WakeWordAmazon   WakeWord = "AMAZON"
	WakeWordEcho     WakeWord = "ECHO"
	WakeWordComputer WakeWord = "COMPUTER"
)

Enum values for WakeWord

func (WakeWord) Values added in v0.29.0 

func (WakeWord) Values() []WakeWord

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

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.