interface PromptSpecificationProperty

Language	Type name
.NET	`Amazon.CDK.Mixins.Preview.AWS.Lex.Mixins.CfnBotPropsMixin.PromptSpecificationProperty`
Go	`github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awslex/mixins#CfnBotPropsMixin_PromptSpecificationProperty`
Java	`software.amazon.awscdk.mixins.preview.services.lex.mixins.CfnBotPropsMixin.PromptSpecificationProperty`
Python	`aws_cdk.mixins_preview.aws_lex.mixins.CfnBotPropsMixin.PromptSpecificationProperty`
TypeScript	`@aws-cdk/mixins-preview` » `aws_lex` » `mixins` » `CfnBotPropsMixin` » `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 { mixins as lex_mixins } from '@aws-cdk/mixins-preview/aws-lex';
const promptSpecificationProperty: lex_mixins.CfnBotPropsMixin.PromptSpecificationProperty = {
  allowInterrupt: false,
  maxRetries: 123,
  messageGroupsList: [{
    message: {
      customPayload: {
        value: 'value',
      },
      imageResponseCard: {
        buttons: [{
          text: 'text',
          value: 'value',
        }],
        imageUrl: 'imageUrl',
        subtitle: 'subtitle',
        title: 'title',
      },
      plainTextMessage: {
        value: 'value',
      },
      ssmlMessage: {
        value: 'value',
      },
    },
    variations: [{
      customPayload: {
        value: 'value',
      },
      imageResponseCard: {
        buttons: [{
          text: 'text',
          value: 'value',
        }],
        imageUrl: 'imageUrl',
        subtitle: 'subtitle',
        title: 'title',
      },
      plainTextMessage: {
        value: 'value',
      },
      ssmlMessage: {
        value: 'value',
      },
    }],
  }],
  messageSelectionStrategy: 'messageSelectionStrategy',
  promptAttemptsSpecification: {
    promptAttemptsSpecificationKey: {
      allowedInputTypes: {
        allowAudioInput: false,
        allowDtmfInput: false,
      },
      allowInterrupt: false,
      audioAndDtmfInputSpecification: {
        audioSpecification: {
          endTimeoutMs: 123,
          maxLengthMs: 123,
        },
        dtmfSpecification: {
          deletionCharacter: 'deletionCharacter',
          endCharacter: 'endCharacter',
          endTimeoutMs: 123,
          maxLength: 123,
        },
        startTimeoutMs: 123,
      },
      textInputSpecification: {
        startTimeoutMs: 123,
      },
    },
  },
};

Properties

Name	Type	Description
allowInterrupt?	`boolean \|` `IResolvable`	Indicates whether the user can interrupt a speech prompt from the bot.
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.
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.

allowInterrupt?

Type: boolean | IResolvable (optional)

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

maxRetries?

Type: number (optional)

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

messageGroupsList?

Type: IResolvable | (IResolvable | MessageGroupProperty)[] (optional)

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

Amazon Lex chooses the actual message to send at runtime.

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.

AWS CDK

2.233.0