Options
All
  • Public
  • Public/Protected
  • All
Menu

Module Manifest

Index

Interfaces

Type aliases

Type aliases

DataProtectionProvider

DataProtectionProvider: "KEY_MASTER" | "AWS_KMS"

The data protection provider.

enum

DisplayInterfaceApmlVersion

DisplayInterfaceApmlVersion: "0.2"

The minimum version of the APML specification supported by the skill. If a device does not support a version greater than or equal to the version specified her then apmlVersion will not be passed inside the Display interface in the ASK request.

enum

DisplayInterfaceTemplateVersion

DisplayInterfaceTemplateVersion: "1"

The minimum version of pre-defined templates supported by the skill. If a device does not support a version greater than or equal to the version specified her then templateVersion will not be passed inside the Display interface in the ASK request.

enum

DistributionCountries

DistributionCountries: "AF" | "AX" | "AL" | "DZ" | "AS" | "AD" | "AO" | "AI" | "AQ" | "AG" | "AR" | "AM" | "AW" | "AU" | "AT" | "AZ" | "BS" | "BH" | "BD" | "BB" | "BY" | "BE" | "BZ" | "BJ" | "BM" | "BT" | "BO" | "BA" | "BW" | "BV" | "BR" | "IO" | "BN" | "BG" | "BF" | "BI" | "KH" | "CM" | "CA" | "CV" | "KY" | "CF" | "TD" | "CL" | "CN" | "CX" | "CC" | "CO" | "KM" | "CG" | "CD" | "CK" | "CR" | "HR" | "CY" | "CZ" | "DK" | "DJ" | "DM" | "DO" | "EC" | "EG" | "SV" | "GQ" | "ER" | "EE" | "ET" | "FK" | "FO" | "FJ" | "FI" | "FR" | "GF" | "PF" | "TF" | "GA" | "GM" | "GE" | "DE" | "GH" | "GI" | "GR" | "GL" | "GD" | "GP" | "GU" | "GT" | "GG" | "GN" | "GW" | "GY" | "HT" | "HM" | "VA" | "HN" | "HK" | "HU" | "IS" | "IN" | "ID" | "IQ" | "IE" | "IM" | "IL" | "IT" | "CI" | "JM" | "JP" | "JE" | "JO" | "KZ" | "KE" | "KI" | "KR" | "KW" | "KG" | "LA" | "LV" | "LB" | "LS" | "LR" | "LY" | "LI" | "LT" | "LU" | "MO" | "MK" | "MG" | "MW" | "MY" | "MV" | "ML" | "MT" | "MH" | "MQ" | "MR" | "MU" | "YT" | "MX" | "FM" | "MD" | "MC" | "MN" | "ME" | "MS" | "MA" | "MZ" | "MM" | "NA" | "NR" | "NP" | "NL" | "AN" | "NC" | "NZ" | "NI" | "NE" | "NG" | "NU" | "NF" | "MP" | "NO" | "OM" | "PK" | "PW" | "PS" | "PA" | "PG" | "PY" | "PE" | "PH" | "PN" | "PL" | "PT" | "PR" | "QA" | "RE" | "RO" | "RU" | "RW" | "BL" | "SH" | "KN" | "LC" | "MF" | "PM" | "VC" | "WS" | "SM" | "ST" | "SA" | "SN" | "RS" | "SC" | "SL" | "SG" | "SK" | "SI" | "SB" | "SO" | "ZA" | "GS" | "ES" | "LK" | "SR" | "SJ" | "SZ" | "SE" | "CH" | "TW" | "TJ" | "TZ" | "TH" | "TL" | "TG" | "TK" | "TO" | "TT" | "TN" | "TR" | "TM" | "TC" | "TV" | "UG" | "UA" | "AE" | "GB" | "US" | "UM" | "UY" | "UZ" | "VU" | "VE" | "VN" | "VG" | "VI" | "WF" | "EH" | "YE" | "ZM" | "ZW"
enum

DistributionMode

DistributionMode: "PRIVATE" | "PUBLIC" | "INTERNAL"

What audience the skill should be distributed to. "PUBLIC" - available to all users. Has ASIN and can be enabled. "PRIVATE" - available to entitled users. Has ASIN and can be enabled. "INTERNAL" - has no ASIN and cannot be enabled by users. Internally managed skills.

enum

EventNameType

EventNameType: "SKILL_ENABLED" | "SKILL_DISABLED" | "SKILL_PERMISSION_ACCEPTED" | "SKILL_PERMISSION_CHANGED" | "SKILL_ACCOUNT_LINKED" | "ITEMS_CREATED" | "ITEMS_UPDATED" | "ITEMS_DELETED" | "LIST_CREATED" | "LIST_UPDATED" | "LIST_DELETED" | "ALL_LISTS_CHANGED" | "REMINDER_STARTED" | "REMINDER_CREATED" | "REMINDER_UPDATED" | "REMINDER_DELETED" | "REMINDER_STATUS_CHANGED" | "AUDIO_ITEM_PLAYBACK_STARTED" | "AUDIO_ITEM_PLAYBACK_FINISHED" | "AUDIO_ITEM_PLAYBACK_STOPPED" | "AUDIO_ITEM_PLAYBACK_FAILED" | "SKILL_PROACTIVE_SUBSCRIPTION_CHANGED" | "IN_SKILL_PRODUCT_SUBSCRIPTION_STARTED" | "IN_SKILL_PRODUCT_SUBSCRIPTION_RENEWED" | "IN_SKILL_PRODUCT_SUBSCRIPTION_ENDED" | "Legacy.ActivityManager.ActivityContextRemovedEvent" | "Legacy.ActivityManager.ActivityInterrupted" | "Legacy.ActivityManager.FocusChanged" | "Legacy.AlertsController.DismissCommand" | "Legacy.AlertsController.SnoozeCommand" | "Legacy.AudioPlayer.AudioStutter" | "Legacy.AudioPlayer.InitialPlaybackProgressReport" | "Legacy.AudioPlayer.Metadata" | "Legacy.AudioPlayer.PeriodicPlaybackProgressReport" | "Legacy.AudioPlayer.PlaybackError" | "Legacy.AudioPlayer.PlaybackFinished" | "Legacy.AudioPlayer.PlaybackIdle" | "Legacy.AudioPlayer.PlaybackInterrupted" | "Legacy.AudioPlayer.PlaybackNearlyFinished" | "Legacy.AudioPlayer.PlaybackPaused" | "Legacy.AudioPlayer.PlaybackResumed" | "Legacy.AudioPlayer.PlaybackStarted" | "Legacy.AudioPlayer.PlaybackStutterFinished" | "Legacy.AudioPlayer.PlaybackStutterStarted" | "Legacy.AudioPlayerGui.ButtonClickedEvent" | "Legacy.AudioPlayerGui.LyricsViewedEvent" | "Legacy.AuxController.DirectionChanged" | "Legacy.AuxController.EnabledStateChanged" | "Legacy.AuxController.InputActivityStateChanged" | "Legacy.AuxController.PluggedStateChanged" | "Legacy.BluetoothNetwork.CancelPairingMode" | "Legacy.BluetoothNetwork.DeviceConnectedFailure" | "Legacy.BluetoothNetwork.DeviceConnectedSuccess" | "Legacy.BluetoothNetwork.DeviceDisconnectedFailure" | "Legacy.BluetoothNetwork.DeviceDisconnectedSuccess" | "Legacy.BluetoothNetwork.DevicePairFailure" | "Legacy.BluetoothNetwork.DevicePairSuccess" | "Legacy.BluetoothNetwork.DeviceUnpairFailure" | "Legacy.BluetoothNetwork.DeviceUnpairSuccess" | "Legacy.BluetoothNetwork.EnterPairingModeFailure" | "Legacy.BluetoothNetwork.EnterPairingModeSuccess" | "Legacy.BluetoothNetwork.MediaControlFailure" | "Legacy.BluetoothNetwork.MediaControlSuccess" | "Legacy.BluetoothNetwork.ScanDevicesReport" | "Legacy.BluetoothNetwork.SetDeviceCategoriesFailed" | "Legacy.BluetoothNetwork.SetDeviceCategoriesSucceeded" | "Legacy.ContentManager.ContentPlaybackTerminated" | "Legacy.DeviceNotification.DeleteNotificationFailed" | "Legacy.DeviceNotification.DeleteNotificationSucceeded" | "Legacy.DeviceNotification.NotificationEnteredBackground" | "Legacy.DeviceNotification.NotificationEnteredForground" | "Legacy.DeviceNotification.NotificationStarted" | "Legacy.DeviceNotification.NotificationStopped" | "Legacy.DeviceNotification.NotificationSync" | "Legacy.DeviceNotification.SetNotificationFailed" | "Legacy.DeviceNotification.SetNotificationSucceeded" | "Legacy.EqualizerController.EqualizerChanged" | "Legacy.ExternalMediaPlayer.AuthorizationComplete" | "Legacy.ExternalMediaPlayer.Error" | "Legacy.ExternalMediaPlayer.Event" | "Legacy.ExternalMediaPlayer.Login" | "Legacy.ExternalMediaPlayer.Logout" | "Legacy.ExternalMediaPlayer.ReportDiscoveredPlayers" | "Legacy.ExternalMediaPlayer.RequestToken" | "Legacy.FavoritesController.Error" | "Legacy.FavoritesController.Response" | "Legacy.GameEngine.GameInputEvent" | "Legacy.HomeAutoWifiController.DeviceReconnected" | "Legacy.HomeAutoWifiController.HttpNotified" | "Legacy.HomeAutoWifiController.SsdpDiscoveryFinished" | "Legacy.HomeAutoWifiController.SsdpServiceDiscovered" | "Legacy.HomeAutoWifiController.SsdpServiceTerminated" | "Legacy.ListModel.AddItemRequest" | "Legacy.ListModel.DeleteItemRequest" | "Legacy.ListModel.GetPageByOrdinalRequest" | "Legacy.ListModel.GetPageByTokenRequest" | "Legacy.ListModel.ListStateUpdateRequest" | "Legacy.ListModel.UpdateItemRequest" | "Legacy.ListRenderer.GetListPageByOrdinal" | "Legacy.ListRenderer.GetListPageByToken" | "Legacy.ListRenderer.ListItemEvent" | "Legacy.MediaGrouping.GroupChangeNotificationEvent" | "Legacy.MediaGrouping.GroupChangeResponseEvent" | "Legacy.MediaGrouping.GroupSyncEvent" | "Legacy.MediaPlayer.PlaybackError" | "Legacy.MediaPlayer.PlaybackFinished" | "Legacy.MediaPlayer.PlaybackIdle" | "Legacy.MediaPlayer.PlaybackNearlyFinished" | "Legacy.MediaPlayer.PlaybackPaused" | "Legacy.MediaPlayer.PlaybackResumed" | "Legacy.MediaPlayer.PlaybackStarted" | "Legacy.MediaPlayer.PlaybackStopped" | "Legacy.MediaPlayer.SequenceItemsRequested" | "Legacy.MediaPlayer.SequenceModified" | "Legacy.MeetingClientController.Event" | "Legacy.Microphone.AudioRecording" | "Legacy.PhoneCallController.Event" | "Legacy.PlaybackController.ButtonCommand" | "Legacy.PlaybackController.LyricsViewedEvent" | "Legacy.PlaybackController.NextCommand" | "Legacy.PlaybackController.PauseCommand" | "Legacy.PlaybackController.PlayCommand" | "Legacy.PlaybackController.PreviousCommand" | "Legacy.PlaybackController.ToggleCommand" | "Legacy.PlaylistController.ErrorResponse" | "Legacy.PlaylistController.Response" | "Legacy.Presentation.PresentationDismissedEvent" | "Legacy.Presentation.PresentationUserEvent" | "Legacy.SconeRemoteControl.Next" | "Legacy.SconeRemoteControl.PlayPause" | "Legacy.SconeRemoteControl.Previous" | "Legacy.SconeRemoteControl.VolumeDown" | "Legacy.SconeRemoteControl.VolumeUp" | "Legacy.SipClient.Event" | "Legacy.SoftwareUpdate.CheckSoftwareUpdateReport" | "Legacy.SoftwareUpdate.InitiateSoftwareUpdateReport" | "Legacy.Speaker.MuteChanged" | "Legacy.Speaker.VolumeChanged" | "Legacy.SpeechRecognizer.WakeWordChanged" | "Legacy.SpeechSynthesizer.SpeechFinished" | "Legacy.SpeechSynthesizer.SpeechInterrupted" | "Legacy.SpeechSynthesizer.SpeechStarted" | "Legacy.SpeechSynthesizer.SpeechSynthesizerError" | "Legacy.Spotify.Event" | "Legacy.System.UserInactivity" | "Legacy.UDPController.BroadcastResponse" | "LocalApplication.Alexa.Translation.LiveTranslation.Event" | "LocalApplication.AlexaNotifications.Event" | "LocalApplication.AlexaPlatformTestSpeechlet.Event" | "LocalApplication.AlexaVision.Event" | "LocalApplication.AlexaVoiceLayer.Event" | "LocalApplication.AvaPhysicalShopping.Event" | "LocalApplication.Calendar.Event" | "LocalApplication.Closet.Event" | "LocalApplication.Communications.Event" | "LocalApplication.DeviceMessaging.Event" | "LocalApplication.DigitalDash.Event" | "LocalApplication.FireflyShopping.Event" | "LocalApplication.Gallery.Event" | "LocalApplication.HHOPhotos.Event" | "LocalApplication.HomeAutomationMedia.Event" | "LocalApplication.KnightContacts.Event" | "LocalApplication.KnightHome.Event" | "LocalApplication.KnightHomeThingsToTry.Event" | "LocalApplication.LocalMediaPlayer.Event" | "LocalApplication.LocalVoiceUI.Event" | "LocalApplication.MShop.Event" | "LocalApplication.MShopPurchasing.Event" | "LocalApplication.NotificationsApp.Event" | "LocalApplication.Photos.Event" | "LocalApplication.Sentry.Event" | "LocalApplication.SipClient.Event" | "LocalApplication.SipUserAgent.Event" | "LocalApplication.todoRenderer.Event" | "LocalApplication.VideoExperienceService.Event" | "LocalApplication.WebVideoPlayer.Event" | "Alexa.Camera.PhotoCaptureController.CancelCaptureFailed" | "Alexa.Camera.PhotoCaptureController.CancelCaptureFinished" | "Alexa.Camera.PhotoCaptureController.CaptureFailed" | "Alexa.Camera.PhotoCaptureController.CaptureFinished" | "Alexa.Camera.VideoCaptureController.CancelCaptureFailed" | "Alexa.Camera.VideoCaptureController.CancelCaptureFinished" | "Alexa.Camera.VideoCaptureController.CaptureFailed" | "Alexa.Camera.VideoCaptureController.CaptureFinished" | "Alexa.Camera.VideoCaptureController.CaptureStarted" | "Alexa.FileManager.UploadController.CancelUploadFailed" | "Alexa.FileManager.UploadController.CancelUploadFinished" | "Alexa.FileManager.UploadController.UploadFailed" | "Alexa.FileManager.UploadController.UploadFinished" | "Alexa.FileManager.UploadController.UploadStarted" | "Alexa.Presentation.APL.UserEvent" | "Alexa.Presentation.HTML.Event" | "Alexa.Presentation.HTML.LifecycleStateChanged" | "Alexa.Presentation.PresentationDismissed" | "AudioPlayer.PlaybackFailed" | "AudioPlayer.PlaybackFinished" | "AudioPlayer.PlaybackNearlyFinished" | "AudioPlayer.PlaybackStarted" | "AudioPlayer.PlaybackStopped" | "CardRenderer.DisplayContentFinished" | "CardRenderer.DisplayContentStarted" | "CardRenderer.ReadContentFinished" | "CardRenderer.ReadContentStarted" | "CustomInterfaceController.EventsReceived" | "CustomInterfaceController.Expired" | "DeviceSetup.SetupCompleted" | "Display.ElementSelected" | "Display.UserEvent" | "FitnessSessionController.FitnessSessionEnded" | "FitnessSessionController.FitnessSessionError" | "FitnessSessionController.FitnessSessionPaused" | "FitnessSessionController.FitnessSessionResumed" | "FitnessSessionController.FitnessSessionStarted" | "GameEngine.InputHandlerEvent" | "Messaging.MessageReceived" | "MessagingController.UpdateConversationsStatus" | "MessagingController.UpdateMessagesStatusRequest" | "MessagingController.UpdateSendMessageStatusRequest" | "MessagingController.UploadConversations" | "PlaybackController.NextCommandIssued" | "PlaybackController.PauseCommandIssued" | "PlaybackController.PlayCommandIssued" | "PlaybackController.PreviousCommandIssued" | "EffectsController.RequestEffectChangeRequest" | "EffectsController.RequestGuiChangeRequest" | "EffectsController.StateReceiptChangeRequest"

Name of the event to be subscribed to.

enum

FlashBriefingContentType

FlashBriefingContentType: "TEXT" | "AUDIO" | "AUDIO_AND_VIDEO"

format of the feed content.

enum

FlashBriefingGenre

FlashBriefingGenre: "HEADLINE_NEWS" | "BUSINESS" | "POLITICS" | "ENTERTAINMENT" | "TECHNOLOGY" | "HUMOR" | "LIFESTYLE" | "SPORTS" | "SCIENCE" | "HEALTH_AND_FITNESS" | "ARTS_AND_CULTURE" | "PRODUCTIVITY_AND_UTILITIES" | "OTHER"

Type or subject of the content in the feed.

enum

FlashBriefingUpdateFrequency

FlashBriefingUpdateFrequency: "HOURLY" | "DAILY" | "WEEKLY" | "UNKNOWN"

Tells how often the feed has new content.

enum

GadgetSupport

GadgetSupport: "REQUIRED" | "OPTIONAL"

Specifies if gadget support is required/optional for this skill to work.

enum

HealthProtocolVersion

HealthProtocolVersion: "1" | "2"
enum

Interface

Interface: AlexaPresentationAplInterface | VideoAppInterface | CustomInterface | AlexaPresentationHtmlInterface | AudioInterface | GameEngineInterface | DisplayInterface | GadgetControllerInterface
interface

MusicContentName

MusicContentName: "ON_DEMAND" | "RADIO" | "PODCAST"

Name of the content type that's supported for the music skill.

enum

PermissionName

PermissionName: "payments:autopay_consent" | "alexa::async_event:write" | "avs::distributed_audio" | "alexa::devices:all:address:full:read" | "alexa:devices:all:address:country_and_postal_code:read" | "alexa::devices:all:geolocation:read" | "alexa::health:profile:write" | "alexa::household:lists:read" | "alexa::household:lists:write" | "alexa::personality:explicit:read" | "alexa::personality:explicit:write" | "alexa::profile:name:read" | "alexa::profile:email:read" | "alexa::profile:mobile_number:read" | "alexa::profile:given_name:read" | "alexa::customer_id:read" | "alexa::person_id:read" | "alexa::raw_person_id:read" | "alexa::devices:all:notifications:write" | "alexa::devices:all:notifications:urgent:write" | "alexa::alerts:reminders:skill:readwrite" | "alexa::alerts:timers:skill:readwrite" | "alexa::skill:cds:monetization" | "alexa::music:cast" | "alexa::skill:products:entitlements" | "alexa::skill:proactive_enablement" | "alexa::authenticate:2:mandatory" | "alexa::authenticate:2:optional" | "alexa::user_experience_guidance:read" | "alexa::device_id:read" | "alexa::device_type:read"

Name of the required permission.

enum

RequestName

RequestName: "Search" | "Create" | "Update"

Name of the request.

enum

SSLCertificateType

SSLCertificateType: "SelfSigned" | "Wildcard" | "Trusted"

The SSL certificate type of the skill's HTTPS endpoint. Only valid for HTTPS endpoint not for AWS Lambda ARN.

enum

SmartHomeProtocol

SmartHomeProtocol: "1" | "2" | "2.5" | "2.9" | "3"

Version of the Smart Home API. Default and recommended value is '3'. You may create a skill with version '2' for testing migration to version '3', but a skill submission using version '2' will not be certified.

enum

Version

Version: "1"

Version of the interface.

enum

ViewportMode

ViewportMode: "HUB" | "TV"

Defines the mode of viewport that comply with this specification. E.g. HUB TV.

enum

ViewportShape

ViewportShape: "RECTANGLE" | "ROUND"

Defines the shape of the device's viewport.

enum