interface PromptSpecificationProperty

Language	Type name
.NET	Amazon.CDK.AWS.Lex.CfnBot.PromptSpecificationProperty
Java	software.amazon.awscdk.services.lex.CfnBot.PromptSpecificationProperty
Python	aws_cdk.aws_lex.CfnBot.PromptSpecificationProperty
TypeScript	@aws-cdk/aws-lex » CfnBot » PromptSpecificationProperty

Specifies a list of message groups that Amazon Lex sends to a user to elicit a response.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as lex from '@aws-cdk/aws-lex';
const promptSpecificationProperty: lex.CfnBot.PromptSpecificationProperty = {
  maxRetries: 123,
  messageGroupsList: [{
    message: {
      customPayload: {
        value: 'value',
      },
      imageResponseCard: {
        title: 'title',

        // the properties below are optional
        buttons: [{
          text: 'text',
          value: 'value',
        }],
        imageUrl: 'imageUrl',
        subtitle: 'subtitle',
      },
      plainTextMessage: {
        value: 'value',
      },
      ssmlMessage: {
        value: 'value',
      },
    },

    // the properties below are optional
    variations: [{
      customPayload: {
        value: 'value',
      },
      imageResponseCard: {
        title: 'title',

        // the properties below are optional
        buttons: [{
          text: 'text',
          value: 'value',
        }],
        imageUrl: 'imageUrl',
        subtitle: 'subtitle',
      },
      plainTextMessage: {
        value: 'value',
      },
      ssmlMessage: {
        value: 'value',
      },
    }],
  }],

  // the properties below are optional
  allowInterrupt: false,
  messageSelectionStrategy: 'messageSelectionStrategy',
  promptAttemptsSpecification: {
    promptAttemptsSpecificationKey: {
      allowedInputTypes: {
        allowAudioInput: false,
        allowDtmfInput: false,
      },

      // the properties below are optional
      allowInterrupt: false,
      audioAndDtmfInputSpecification: {
        startTimeoutMs: 123,

        // the properties below are optional
        audioSpecification: {
          endTimeoutMs: 123,
          maxLengthMs: 123,
        },
        dtmfSpecification: {
          deletionCharacter: 'deletionCharacter',
          endCharacter: 'endCharacter',
          endTimeoutMs: 123,
          maxLength: 123,
        },
      },
      textInputSpecification: {
        startTimeoutMs: 123,
      },
    },
  },
};

Properties

Name	Type	Description
maxRetries	number	The maximum number of times the bot tries to elicit a response from the user using this prompt.
messageGroupsList	IResolvable | IResolvable | MessageGroupProperty[]	A collection of messages that Amazon Lex can send to the user.
allowInterrupt?	boolean | IResolvable	Indicates whether the user can interrupt a speech prompt from the bot.
messageSelectionStrategy?	string	Indicates how a message is selected from a message group among retries.
promptAttemptsSpecification?	IResolvable | { [string]: IResolvable | PromptAttemptSpecificationProperty }	Specifies the advanced settings on each attempt of the prompt.

---

maxRetries

Type: number

The maximum number of times the bot tries to elicit a response from the user using this prompt.

---

messageGroupsList

Type: IResolvable | IResolvable | MessageGroupProperty[]

A collection of messages that Amazon Lex can send to the user.

Amazon Lex chooses the actual message to send at runtime.

---

allowInterrupt?

Type: boolean | IResolvable (optional)

Indicates whether the user can interrupt a speech prompt from the bot.

---

messageSelectionStrategy?

Type: string (optional)

Indicates how a message is selected from a message group among retries.

---

promptAttemptsSpecification?

Type: IResolvable | { [string]: IResolvable | PromptAttemptSpecificationProperty } (optional)

Specifies the advanced settings on each attempt of the prompt.