package types

import "github.com/aws/aws-sdk-go-v2/service/alexaforbusiness/types"

Index

Types

type AddressBook

type AddressBook struct {

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

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

	// The name of the address book.
	Name *string
}

An address book with attributes.

type AddressBookData

type AddressBookData struct {

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

	// The name of the address book.
	Name *string

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

Information related to an address book.

type AlreadyExistsException

type AlreadyExistsException struct {
	Message *string
}

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
}

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 failure code.
	FailureCode BusinessReportFailureCode

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

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

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

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

Usage report with specified parameters.

type BusinessReportContentRange

type BusinessReportContentRange struct {

	// The interval of the content range.
	//
	// This member is required.
	Interval BusinessReportInterval
}

The content range of the report.

type BusinessReportFailureCode

type BusinessReportFailureCode string
const (
	BusinessReportFailureCodeAccess_denied    BusinessReportFailureCode = "ACCESS_DENIED"
	BusinessReportFailureCodeNo_such_bucket   BusinessReportFailureCode = "NO_SUCH_BUCKET"
	BusinessReportFailureCodeInternal_failure BusinessReportFailureCode = "INTERNAL_FAILURE"
)

Enum values for BusinessReportFailureCode

type BusinessReportFormat

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

Enum values for BusinessReportFormat

type BusinessReportInterval

type BusinessReportInterval string
const (
	BusinessReportIntervalOne_day     BusinessReportInterval = "ONE_DAY"
	BusinessReportIntervalOne_week    BusinessReportInterval = "ONE_WEEK"
	BusinessReportIntervalThirty_days BusinessReportInterval = "THIRTY_DAYS"
)

Enum values for BusinessReportInterval

type BusinessReportRecurrence

type BusinessReportRecurrence struct {

	// The start date.
	StartDate *string
}

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
}

The S3 location of the output reports.

type BusinessReportSchedule

type BusinessReportSchedule struct {

	// The name identifier of the schedule.
	ScheduleName *string

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

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

	// The recurrence of the reports.
	Recurrence *BusinessReportRecurrence

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

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

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

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

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

type Category

type Category struct {

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

	// The name of the skill store category.
	CategoryName *string
}

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

type ConcurrentModificationException

type ConcurrentModificationException struct {
	Message *string
}

There is a concurrent modification of resources.

func (*ConcurrentModificationException) Error

func (*ConcurrentModificationException) ErrorCode

func (e *ConcurrentModificationException) ErrorCode() string

func (*ConcurrentModificationException) ErrorFault

func (*ConcurrentModificationException) ErrorMessage

func (e *ConcurrentModificationException) ErrorMessage() string

type ConferencePreference

type ConferencePreference struct {

	// The ARN of the default conference provider.
	DefaultConferenceProviderArn *string
}

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

type ConferenceProvider

type ConferenceProvider struct {

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

	// The type of conference providers.
	Type ConferenceProviderType

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

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

	// The information for PSTN conferencing.
	PSTNDialIn *PSTNDialIn

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

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"
	ConferenceProviderTypeGoogle_hangouts    ConferenceProviderType = "GOOGLE_HANGOUTS"
	ConferenceProviderTypePolycom            ConferenceProviderType = "POLYCOM"
	ConferenceProviderTypeRingcentral        ConferenceProviderType = "RINGCENTRAL"
	ConferenceProviderTypeSkype_for_business ConferenceProviderType = "SKYPE_FOR_BUSINESS"
	ConferenceProviderTypeWebex              ConferenceProviderType = "WEBEX"
	ConferenceProviderTypeZoom               ConferenceProviderType = "ZOOM"
	ConferenceProviderTypeCustom             ConferenceProviderType = "CUSTOM"
)

Enum values for ConferenceProviderType

type ConnectionStatus

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

Enum values for ConnectionStatus

type Contact

type Contact struct {

	// 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 SIP addresses for the contact.
	SipAddresses []*SipAddress

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

	// The ARN of the contact.
	ContactArn *string

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

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

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

A contact with attributes.

type ContactData

type ContactData struct {

	// 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 name of the contact to display on the console.
	DisplayName *string

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

	// The list of SIP addresses for the contact.
	SipAddresses []*SipAddress

	// The ARN of the contact.
	ContactArn *string

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

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

Information related to a contact.

type Content

type Content struct {

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

	// The list of text messages.
	TextList []*Text

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

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

type CreateEndOfMeetingReminder

type CreateEndOfMeetingReminder struct {

	// The type of sound that users hear during the end of meeting reminder.
	//
	// This member is required.
	ReminderType EndOfMeetingReminderType

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

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

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
}

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 {

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

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

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

Creates meeting room settings of a room profile.

type CreateRequireCheckIn

type CreateRequireCheckIn struct {

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

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

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 email of the developer.
	Email *string

	// The name of the developer.
	DeveloperName *string

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

	// The website of the developer.
	Url *string
}

The details about the developer that published the skill.

type Device

type Device struct {

	// The ARN of a device.
	DeviceArn *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

	// The name of a device.
	DeviceName *string

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

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

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

	// The type of a device.
	DeviceType *string

	// The software version of a device.
	SoftwareVersion *string

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

A device with attributes.

type DeviceData

type DeviceData struct {

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

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

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

	// The name of a device.
	DeviceName *string

	// The status of a device.
	DeviceStatus DeviceStatus

	// The ARN of a device.
	DeviceArn *string

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

	// The type of a device.
	DeviceType *string

	// The software version of a device.
	SoftwareVersion *string

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

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

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

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

Device attributes.

type DeviceEvent

type DeviceEvent struct {

	// The type of device event.
	Type DeviceEventType

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

	// The value of the event.
	Value *string
}

The list of device events.

type DeviceEventType

type DeviceEventType string
const (
	DeviceEventTypeConnection_status DeviceEventType = "CONNECTION_STATUS"
	DeviceEventTypeDevice_status     DeviceEventType = "DEVICE_STATUS"
)

Enum values for DeviceEventType

type DeviceNetworkProfileInfo

type DeviceNetworkProfileInfo struct {

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

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

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

Detailed information about a device's network profile.

type DeviceNotRegisteredException

type DeviceNotRegisteredException struct {
	Message *string
}

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

func (*DeviceNotRegisteredException) Error

func (*DeviceNotRegisteredException) ErrorCode

func (e *DeviceNotRegisteredException) ErrorCode() string

func (*DeviceNotRegisteredException) ErrorFault

func (*DeviceNotRegisteredException) ErrorMessage

func (e *DeviceNotRegisteredException) ErrorMessage() string

type DeviceStatus

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

Enum values for DeviceStatus

type DeviceStatusDetail

type DeviceStatusDetail struct {

	// The list of available features on the device.
	Feature Feature

	// The device status detail code.
	Code DeviceStatusDetailCode
}

Details of a device’s status.

type DeviceStatusDetailCode

type DeviceStatusDetailCode string
const (
	DeviceStatusDetailCodeDevice_software_update_needed       DeviceStatusDetailCode = "DEVICE_SOFTWARE_UPDATE_NEEDED"
	DeviceStatusDetailCodeDevice_was_offline                  DeviceStatusDetailCode = "DEVICE_WAS_OFFLINE"
	DeviceStatusDetailCodeCredentials_access_failure          DeviceStatusDetailCode = "CREDENTIALS_ACCESS_FAILURE"
	DeviceStatusDetailCodeTls_version_mismatch                DeviceStatusDetailCode = "TLS_VERSION_MISMATCH"
	DeviceStatusDetailCodeAssociation_rejection               DeviceStatusDetailCode = "ASSOCIATION_REJECTION"
	DeviceStatusDetailCodeAuthentication_failure              DeviceStatusDetailCode = "AUTHENTICATION_FAILURE"
	DeviceStatusDetailCodeDhcp_failure                        DeviceStatusDetailCode = "DHCP_FAILURE"
	DeviceStatusDetailCodeInternet_unavailable                DeviceStatusDetailCode = "INTERNET_UNAVAILABLE"
	DeviceStatusDetailCodeDns_failure                         DeviceStatusDetailCode = "DNS_FAILURE"
	DeviceStatusDetailCodeUnknown_failure                     DeviceStatusDetailCode = "UNKNOWN_FAILURE"
	DeviceStatusDetailCodeCertificate_issuing_limit_exceeded  DeviceStatusDetailCode = "CERTIFICATE_ISSUING_LIMIT_EXCEEDED"
	DeviceStatusDetailCodeInvalid_certificate_authority       DeviceStatusDetailCode = "INVALID_CERTIFICATE_AUTHORITY"
	DeviceStatusDetailCodeNetwork_profile_not_found           DeviceStatusDetailCode = "NETWORK_PROFILE_NOT_FOUND"
	DeviceStatusDetailCodeInvalid_password_state              DeviceStatusDetailCode = "INVALID_PASSWORD_STATE"
	DeviceStatusDetailCodePassword_not_found                  DeviceStatusDetailCode = "PASSWORD_NOT_FOUND"
	DeviceStatusDetailCodePassword_manager_access_denied      DeviceStatusDetailCode = "PASSWORD_MANAGER_ACCESS_DENIED"
	DeviceStatusDetailCodeCertificate_authority_access_denied DeviceStatusDetailCode = "CERTIFICATE_AUTHORITY_ACCESS_DENIED"
)

Enum values for DeviceStatusDetailCode

type DeviceStatusInfo

type DeviceStatusInfo struct {

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

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

	// One or more device status detail descriptions.
	DeviceStatusDetails []*DeviceStatusDetail
}

Detailed information about a device's status.

type DeviceUsageType

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

Enum values for DeviceUsageType

type DistanceUnit

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

Enum values for DistanceUnit

type EnablementType

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

Enum values for EnablementType

type EnablementTypeFilter

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

Enum values for EnablementTypeFilter

type EndOfMeetingReminder

type EndOfMeetingReminder struct {

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

	// The type of sound that users hear during the end of meeting reminder.
	ReminderType EndOfMeetingReminderType

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

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 (
	EndOfMeetingReminderTypeAnnouncement_time_check         EndOfMeetingReminderType = "ANNOUNCEMENT_TIME_CHECK"
	EndOfMeetingReminderTypeAnnouncement_variable_time_left EndOfMeetingReminderType = "ANNOUNCEMENT_VARIABLE_TIME_LEFT"
	EndOfMeetingReminderTypeChime                           EndOfMeetingReminderType = "CHIME"
	EndOfMeetingReminderTypeKnock                           EndOfMeetingReminderType = "KNOCK"
)

Enum values for EndOfMeetingReminderType

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

type Feature

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

Enum values for Feature

type Filter

type Filter struct {

	// The values of a filter.
	//
	// This member is required.
	Values []*string

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

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 software version of the gateway. The gateway automatically updates its
	// software version during normal operation.
	SoftwareVersion *string

	// The name of the gateway.
	Name *string
}

The details of the gateway.

type GatewayGroup

type GatewayGroup struct {

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

	// The name of the gateway group.
	Name *string

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

The details of the gateway group.

type GatewayGroupSummary

type GatewayGroupSummary struct {

	// The name of the gateway group.
	Name *string

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

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

The summary of a gateway group.

type GatewaySummary

type GatewaySummary struct {

	// The description of the gateway.
	Description *string

	// The ARN of the gateway.
	Arn *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
}

The summary of a gateway.

type IPDialIn

type IPDialIn struct {

	// The IP address.
	//
	// This member is required.
	Endpoint *string

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

The IP endpoint and protocol for calling.

type InstantBooking

type InstantBooking struct {

	// Whether instant booking is enabled or not.
	Enabled *bool

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

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
}

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

func (*InvalidCertificateAuthorityException) Error

func (*InvalidCertificateAuthorityException) ErrorCode

func (*InvalidCertificateAuthorityException) ErrorFault

func (*InvalidCertificateAuthorityException) ErrorMessage

func (e *InvalidCertificateAuthorityException) ErrorMessage() string

type InvalidDeviceException

type InvalidDeviceException struct {
	Message *string
}

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
}

A password in SecretsManager is in an invalid state.

func (*InvalidSecretsManagerResourceException) Error

func (*InvalidSecretsManagerResourceException) ErrorCode

func (*InvalidSecretsManagerResourceException) ErrorFault

func (*InvalidSecretsManagerResourceException) ErrorMessage

type InvalidServiceLinkedRoleStateException

type InvalidServiceLinkedRoleStateException struct {
	Message *string
}

The service linked role is locked for deletion.

func (*InvalidServiceLinkedRoleStateException) Error

func (*InvalidServiceLinkedRoleStateException) ErrorCode

func (*InvalidServiceLinkedRoleStateException) ErrorFault

func (*InvalidServiceLinkedRoleStateException) ErrorMessage

type InvalidUserStatusException

type InvalidUserStatusException struct {
	Message *string
}

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

func (*InvalidUserStatusException) Error

func (*InvalidUserStatusException) ErrorCode

func (e *InvalidUserStatusException) ErrorCode() string

func (*InvalidUserStatusException) ErrorFault

func (*InvalidUserStatusException) ErrorMessage

func (e *InvalidUserStatusException) ErrorMessage() string

type LimitExceededException

type LimitExceededException struct {
	Message *string
}

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 (
	LocaleEn_us Locale = "en-US"
)

Enum values for Locale

type MeetingRoomConfiguration

type MeetingRoomConfiguration struct {

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

	// Whether room utilization metrics are enabled or not.
	RoomUtilizationMetricsEnabled *bool

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

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

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
}

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

* If NO, Alexa will never ask for a meeting pin.

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
}

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 (
	NetworkEapMethodEap_tls NetworkEapMethod = "EAP_TLS"
)

Enum values for NetworkEapMethod

type NetworkProfile

type NetworkProfile struct {

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

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

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

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

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

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

	// The ARN of the network profile associated with a device.
	NetworkProfileArn *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 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 network profile associated with a device.

type NetworkProfileData

type NetworkProfileData struct {

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

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

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

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

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

	// 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 name of the network profile associated with a device.
	NetworkProfileName *string
}

The data associated with a network profile.

type NetworkSecurityType

type NetworkSecurityType string
const (
	NetworkSecurityTypeOpen            NetworkSecurityType = "OPEN"
	NetworkSecurityTypeWep             NetworkSecurityType = "WEP"
	NetworkSecurityTypeWpa_psk         NetworkSecurityType = "WPA_PSK"
	NetworkSecurityTypeWpa2_psk        NetworkSecurityType = "WPA2_PSK"
	NetworkSecurityTypeWpa2_enterprise NetworkSecurityType = "WPA2_ENTERPRISE"
)

Enum values for NetworkSecurityType

type NotFoundException

type NotFoundException struct {
	Message *string
}

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

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

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

type Profile

type Profile struct {

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

	// 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 wake word of a room profile.
	WakeWord WakeWord

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

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

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

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

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

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

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

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

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

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

A room profile with attributes.

type ProfileData

type ProfileData struct {

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

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

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

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

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

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

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

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

	// The wake word of a room profile.
	WakeWord WakeWord
}

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
}

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

type ResourceAssociatedException

type ResourceAssociatedException struct {
	Message *string
}

Another resource is associated with the resource in the request.

func (*ResourceAssociatedException) Error

func (*ResourceAssociatedException) ErrorCode

func (e *ResourceAssociatedException) ErrorCode() string

func (*ResourceAssociatedException) ErrorFault

func (*ResourceAssociatedException) ErrorMessage

func (e *ResourceAssociatedException) ErrorMessage() string

type ResourceInUseException

type ResourceInUseException struct {
	Message *string

	ClientRequestToken *string
}

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 ARN of a room.
	RoomArn *string

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

	// The description of a room.
	Description *string

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

	// The name of a room.
	RoomName *string
}

A room with attributes.

type RoomData

type RoomData struct {

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

	// The name of a room.
	RoomName *string

	// The ARN of a room.
	RoomArn *string

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

	// The description of a room.
	Description *string

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

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
}

A skill parameter associated with a room.

type SipAddress

type SipAddress struct {

	// The URI for the SIP address.
	//
	// This member is required.
	Uri *string

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

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

type SkillDetails

type SkillDetails struct {

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

	// The types of skills.
	SkillTypes []*string

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

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

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

	// The description of the product.
	ProductDescription *string

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

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

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

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

Granular information about the skill.

type SkillGroup

type SkillGroup struct {

	// The name of a skill group.
	SkillGroupName *string

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

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

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
}

The attributes of a skill group.

type SkillNotLinkedException

type SkillNotLinkedException struct {
	Message *string
}

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 {

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

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

	// Linking support for a skill.
	SupportsLinking *bool

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

	// The name of the skill.
	SkillName *string
}

The summary of skills.

type SkillType

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

Enum values for SkillType

type SkillTypeFilter

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

Enum values for SkillTypeFilter

type SkillsStoreSkill

type SkillsStoreSkill struct {

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

	// The name of the skill.
	SkillName *string

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

	// Linking support for a skill.
	SupportsLinking *bool

	// The ARN of the skill.
	SkillId *string

	// Short description about the skill.
	ShortDescription *string

	// Information about the skill.
	SkillDetails *SkillDetails
}

The detailed information about an Alexa skill.

type SmartHomeAppliance

type SmartHomeAppliance struct {

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

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

	// The name of the manufacturer of the smart home appliance.
	ManufacturerName *string
}

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
}

An object representing a sort criteria.

type SortValue

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

Enum values for SortValue

type Ssml

type Ssml struct {

	// The value of the SSML message in the correct SSML format. The audio tag is not
	// supported.
	//
	// This member is required.
	Value *string

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

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 value of a tag. Tag values are case sensitive and can be null.
	//
	// This member is required.
	Value *string

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

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

type Text

type Text struct {

	// The value of the text message.
	//
	// This member is required.
	Value *string

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

The text message.

type UnauthorizedException

type UnauthorizedException struct {
	Message *string
}

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 {

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

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

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 {

	// Whether instant booking is enabled or not.
	Enabled *bool

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

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

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

Updates meeting room settings of a room profile.

type UpdateRequireCheckIn

type UpdateRequireCheckIn struct {

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

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

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 first name of a user.
	FirstName *string

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

	// The enrollment status of a user.
	EnrollmentStatus EnrollmentStatus

	// The ARN of a user.
	UserArn *string
}

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

Source Files

enums.go errors.go types.go

Version
v0.26.0
Published
Oct 1, 2020
Platform
linux/amd64
Imports
3 packages
Last checked
1 week ago

Tools for package owners.