interface SpecificationsProperty

Language	Type name
.NET	Amazon.CDK.AWS.Lex.CfnBot.SpecificationsProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awslex#CfnBot_SpecificationsProperty
Java	software.amazon.awscdk.services.lex.CfnBot.SpecificationsProperty
Python	aws_cdk.aws_lex.CfnBot.SpecificationsProperty
TypeScript	aws-cdk-lib » aws_lex » CfnBot » SpecificationsProperty

Subslot specifications.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-specifications.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_lex as lex } from 'aws-cdk-lib';
const specificationsProperty: lex.CfnBot.SpecificationsProperty = {
  slotTypeId: 'slotTypeId',
  valueElicitationSetting: {
    defaultValueSpecification: {
      defaultValueList: [{
        defaultValue: 'defaultValue',
      }],
    },
    promptSpecification: {
      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,
          },
        },
      },
    },
    sampleUtterances: [{
      utterance: 'utterance',
    }],
    waitAndContinueSpecification: {
      continueResponse: {
        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,
      },
      waitingResponse: {
        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,
      },

      // the properties below are optional
      isActive: false,
      stillWaitingResponse: {
        frequencyInSeconds: 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',
            },
          }],
        }],
        timeoutInSeconds: 123,

        // the properties below are optional
        allowInterrupt: false,
      },
    },
  },
};

Properties

Name	Type	Description
slotTypeId	string	The unique identifier assigned to the slot type.
valueElicitationSetting	IResolvable | SubSlotValueElicitationSettingProperty	Specifies the elicitation setting details for constituent sub slots of a composite slot.

---

slotTypeId

Type: string

The unique identifier assigned to the slot type.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-specifications.html#cfn-lex-bot-specifications-slottypeid

---

valueElicitationSetting

Type: IResolvable | SubSlotValueElicitationSettingProperty

Specifies the elicitation setting details for constituent sub slots of a composite slot.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-specifications.html#cfn-lex-bot-specifications-valueelicitationsetting