View a markdown version of this page

AWS::Lex::Bot AudioFillerSettings - AWS CloudFormation
SyntaxProperties

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::Lex::Bot AudioFillerSettings

Configuration that plays background filler audio during speech-to-speech interactions to mask processing delays and improve the perceived responsiveness of the bot.

Audio filler requires unifiedSpeechSettings (speech-to-speech) to be enabled on the bot locale when enabled is true.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "AudioType" : String,
  "Enabled" : Boolean,
  "MinimumPlayDurationInMilliseconds" : Integer,
  "ResponseDeliveryDelayInMilliseconds" : Integer,
  "StartDelayInMilliseconds" : Integer
}

Properties

AudioType

The identifier of the audio filler to play while Amazon Lex processes the user's input. This field is required when enabled is true.

Required: No

Type: String

Allowed values: MELODY_CHIPPER_CHIME | MELODY_CURIOUS_CRAWL | MELODY_RISING_RIPPLE | MELODY_PATIENT_PING | MELODY_PONDERING_PONG | TYPING_KINETIC_KEYS | TYPING_QUIET_QWERTY

Update requires: No interruption

Enabled

Specifies whether audio filler playback is enabled for the bot locale. Set to true to play filler audio while Amazon Lex processes a user utterance. Set to false to disable filler audio.

Required: Yes

Type: Boolean

Update requires: No interruption

MinimumPlayDurationInMilliseconds

The minimum time, in milliseconds, that audio filler plays once it has started, even if the bot response becomes ready sooner. Valid range is 1000 to 5000 milliseconds. If not specified, Amazon Lex uses a default of 3000 milliseconds.

Required: No

Type: Integer

Minimum: 1000

Maximum: 5000

Update requires: No interruption

ResponseDeliveryDelayInMilliseconds

The silent delay, in milliseconds, inserted between the end of audio filler playback and the start of the bot's response. Valid range is 200 to 1000 milliseconds. If not specified, Amazon Lex uses a default of 500 milliseconds.

Required: No

Type: Integer

Minimum: 200

Maximum: 1000

Update requires: No interruption

StartDelayInMilliseconds

The time, in milliseconds, to wait after the end of the user's utterance before starting audio filler playback. Valid range is 500 to 5000 milliseconds. If not specified, Amazon Lex uses a default of 2500 milliseconds.

Required: No

Type: Integer

Minimum: 500

Maximum: 5000

Update requires: No interruption