You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.LexModelsV2

Inherits:
AWS.Service show all
Identifier:
lexmodelsv2
API Version:
2020-08-07
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

Sending a Request Using LexModelsV2

var lexmodelsv2 = new AWS.LexModelsV2();
lexmodelsv2.buildBotLocale(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the LexModelsV2 object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var lexmodelsv2 = new AWS.LexModelsV2({apiVersion: '2020-08-07'});

You can also set the API version globally in AWS.config.apiVersions using the lexmodelsv2 service identifier:

AWS.config.apiVersions = {
  lexmodelsv2: '2020-08-07',
  // other service API versions
};

var lexmodelsv2 = new AWS.LexModelsV2();

Version:

  • 2020-08-07

Waiter Resource States

This service supports a list of resource states that can be polled using the waitFor() method. The resource states are:

botAvailable, botAliasAvailable, botExportCompleted, botImportCompleted, botLocaleBuilt, botLocaleExpressTestingAvailable, botVersionAvailable, botLocaleCreated

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, setupRequestListeners, defineService

Constructor Details

new AWS.LexModelsV2(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a LexModelsV2 object

var lexmodelsv2 = new AWS.LexModelsV2({apiVersion: '2020-08-07'});

Options Hash (options):

  • params (map) —

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint) —

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String) —

    your AWS access key ID.

  • secretAccessKey (String) —

    your AWS secret access key.

  • sessionToken (AWS.Credentials) —

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials) —

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain) —

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String) —

    the region to send service requests to. See AWS.LexModelsV2.region for more information.

  • maxRetries (Integer) —

    the maximum amount of retries to attempt with a request. See AWS.LexModelsV2.maxRetries for more information.

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.LexModelsV2.maxRedirects for more information.

  • sslEnabled (Boolean) —

    whether to enable SSL for requests.

  • paramValidation (Boolean|map) —

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean) —

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean) —

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean) —

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean) —

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean) —

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean) —

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional') —

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean) —

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map) —

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map) —

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date) —

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>) —

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log) —

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number) —

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String) —

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean) —

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean) —

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean) —

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean) —

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined) —

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number) —

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean) —

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional') —

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint) —

    an Endpoint object representing the endpoint URL for service requests.

Method Details

buildBotLocale(params = {}, callback) ⇒ AWS.Request

Builds a bot, its intents, and its slot types into a specific locale. A bot can be built into multiple locales. At runtime the locale is used to choose a specific build of the bot.

Service Reference:

Examples:

Calling the buildBotLocale operation

var params = {
  botId: 'STRING_VALUE', /* required */
  botVersion: 'STRING_VALUE', /* required */
  localeId: 'STRING_VALUE' /* required */
};
lexmodelsv2.buildBotLocale(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • botId — (String)

      The identifier of the bot to build. The identifier is returned in the response from the operation.

    • botVersion — (String)

      The version of the bot to build. This can only be the draft version of the bot.

    • localeId — (String)

      The identifier of the language and locale that the bot will be used in. The string must match one of the supported locales. All of the intents, slot types, and slots used in the bot must have the same locale. For more information, see Supported languages.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • botId — (String)

        The identifier of the specified bot.

      • botVersion — (String)

        The version of the bot that was built. This is only the draft version of the bot.

      • localeId — (String)

        The language and locale specified of where the bot can be used.

      • botLocaleStatus — (String)

        The bot's build status. When the status is ReadyExpressTesting you can test the bot using the utterances defined for the intents and slot types. When the status is Built, the bot is ready for use and can be tested using any utterance.

        Possible values include:
        • "Creating"
        • "Building"
        • "Built"
        • "ReadyExpressTesting"
        • "Failed"
        • "Deleting"
        • "NotBuilt"
        • "Importing"
      • lastBuildSubmittedDateTime — (Date)

        A timestamp indicating the date and time that the bot was last built for this locale.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createBot(params = {}, callback) ⇒ AWS.Request

Creates an Amazon Lex conversational bot.

Service Reference:

Examples:

Calling the createBot operation

var params = {
  botName: 'STRING_VALUE', /* required */
  dataPrivacy: { /* required */
    childDirected: true || false /* required */
  },
  idleSessionTTLInSeconds: 'NUMBER_VALUE', /* required */
  roleArn: 'STRING_VALUE', /* required */
  botTags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  description: 'STRING_VALUE',
  testBotAliasTags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
lexmodelsv2.createBot(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • botName — (String)

      The name of the bot. The bot name must be unique in the account that creates the bot.

    • description — (String)

      A description of the bot. It appears in lists to help you identify a particular bot.

    • roleArn — (String)

      The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot.

    • dataPrivacy — (map)

      Provides information on additional privacy protections Amazon Lex should use with the bot's data.

      • childDirected — required — (Boolean)

        For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying true or false in the childDirected field. By specifying true in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ.

    • idleSessionTTLInSeconds — (Integer)

      The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.

      A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Lex deletes any data provided before the timeout.

      You can specify between 60 (1 minute) and 86,400 (24 hours) seconds.

    • botTags — (map<String>)

      A list of tags to add to the bot. You can only add tags when you create a bot. You can't use the UpdateBot operation to update tags. To update tags, use the TagResource operation.

    • testBotAliasTags — (map<String>)

      A list of tags to add to the test alias for a bot. You can only add tags when you create a bot. You can't use the UpdateAlias operation to update tags. To update tags on the test alias, use the TagResource operation.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • botId — (String)

        A unique identifier for a particular bot. You use this to identify the bot when you call other Amazon Lex API operations.

      • botName — (String)

        The name specified for the bot.

      • description — (String)

        The description specified for the bot.

      • roleArn — (String)

        The IAM role specified for the bot.

      • dataPrivacy — (map)

        The data privacy settings specified for the bot.

        • childDirected — required — (Boolean)

          For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying true or false in the childDirected field. By specifying true in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ.

      • idleSessionTTLInSeconds — (Integer)

        The session idle time specified for the bot.

      • botStatus — (String)

        Shows the current status of the bot. The bot is first in the Creating status. Once the bot is read for use, it changes to the Available status. After the bot is created, you can use the Draft version of the bot.

        Possible values include:
        • "Creating"
        • "Available"
        • "Inactive"
        • "Deleting"
        • "Failed"
        • "Versioning"
        • "Importing"
      • creationDateTime — (Date)

        A timestamp indicating the date and time that the bot was created.

      • botTags — (map<String>)

        A list of tags associated with the bot.

      • testBotAliasTags — (map<String>)

        A list of tags associated with the test alias for the bot.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createBotAlias(params = {}, callback) ⇒ AWS.Request

Creates an alias for the specified version of a bot. Use an alias to enable you to change the version of a bot without updating applications that use the bot.

For example, you can create an alias called "PROD" that your applications use to call the Amazon Lex bot.

Service Reference:

Examples:

Calling the createBotAlias operation

var params = {
  botAliasName: 'STRING_VALUE', /* required */
  botId: 'STRING_VALUE', /* required */
  botAliasLocaleSettings: {
    '<LocaleId>': {
      enabled: true || false, /* required */
      codeHookSpecification: {
        lambdaCodeHook: { /* required */
          codeHookInterfaceVersion: 'STRING_VALUE', /* required */
          lambdaARN: 'STRING_VALUE' /* required */
        }
      }
    },
    /* '<LocaleId>': ... */
  },
  botVersion: 'STRING_VALUE',
  conversationLogSettings: {
    audioLogSettings: [
      {
        destination: { /* required */
          s3Bucket: { /* required */
            logPrefix: 'STRING_VALUE', /* required */
            s3BucketArn: 'STRING_VALUE', /* required */
            kmsKeyArn: 'STRING_VALUE'
          }
        },
        enabled: true || false /* required */
      },
      /* more items */
    ],
    textLogSettings: [
      {
        destination: { /* required */
          cloudWatch: { /* required */
            cloudWatchLogGroupArn: 'STRING_VALUE', /* required */
            logPrefix: 'STRING_VALUE' /* required */
          }
        },
        enabled: true || false /* required */
      },
      /* more items */
    ]
  },
  description: 'STRING_VALUE',
  sentimentAnalysisSettings: {
    detectSentiment: true || false /* required */
  },
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
lexmodelsv2.createBotAlias(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • botAliasName — (String)

      The alias to create. The name must be unique for the bot.

    • description — (String)

      A description of the alias. Use this description to help identify the alias.

    • botVersion — (String)

      The version of the bot that this alias points to. You can use the operation to change the bot version associated with the alias.

    • botAliasLocaleSettings — (map<map>)

      Maps configuration information to a specific locale. You can use this parameter to specify a specific Lambda function to run different functions in different locales.

      • enabled — required — (Boolean)

        Determines whether the locale is enabled for the bot. If the value is false, the locale isn't available for use.

      • codeHookSpecification — (map)

        Specifies the Lambda function that should be used in the locale.

        • lambdaCodeHook — required — (map)

          Specifies a Lambda function that verifies requests to a bot or fulfills the user's request to a bot.

          • lambdaARN — required — (String)

            The Amazon Resource Name (ARN) of the Lambda function.

          • codeHookInterfaceVersion — required — (String)

            The version of the request-response that you want Amazon Lex to use to invoke your Lambda function.

    • conversationLogSettings — (map)

      Specifies whether Amazon Lex logs text and audio for a conversation with the bot. When you enable conversation logs, text logs store text input, transcripts of audio input, and associated metadata in Amazon CloudWatch Logs. Audio logs store audio input in Amazon S3.

      • textLogSettings — (Array<map>)

        The Amazon CloudWatch Logs settings for logging text and metadata.

        • enabled — required — (Boolean)

          Determines whether conversation logs should be stored for an alias.

        • destination — required — (map)

          Defines the Amazon CloudWatch Logs destination log group for conversation text logs.

          • cloudWatch — required — (map)

            Defines the Amazon CloudWatch Logs log group where text and metadata logs are delivered.

            • cloudWatchLogGroupArn — required — (String)

              The Amazon Resource Name (ARN) of the log group where text and metadata logs are delivered.

            • logPrefix — required — (String)

              The prefix of the log stream name within the log group that you specified

      • audioLogSettings — (Array<map>)

        The Amazon S3 settings for logging audio to an S3 bucket.

        • enabled — required — (Boolean)

          Determines whether audio logging in enabled for the bot.

        • destination — required — (map)

          The location of audio log files collected when conversation logging is enabled for a bot.

          • s3Bucket — required — (map)

            The Amazon S3 bucket where the audio log files are stored. The IAM role specified in the roleArn parameter of the CreateBot operation must have permission to write to this bucket.

            • kmsKeyArn — (String)

              The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key for encrypting audio log files stored in an S3 bucket.

            • s3BucketArn — required — (String)

              The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio log files are stored.

            • logPrefix — required — (String)

              The S3 prefix to assign to audio log files.

    • sentimentAnalysisSettings — (map)

      Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.

      • detectSentiment — required — (Boolean)

        Sets whether Amazon Lex uses Amazon Comprehend to detect the sentiment of user utterances.

    • botId — (String)

      The unique identifier of the bot that the alias applies to.

    • tags — (map<String>)

      A list of tags to add to the bot alias. You can only add tags when you create an alias, you can't use the UpdateBotAlias operation to update the tags on a bot alias. To update tags, use the TagResource operation.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • botAliasId — (String)

        The unique identifier of the bot alias.

      • botAliasName — (String)

        The name specified for the bot alias.

      • description — (String)

        The description specified for the bot alias.

      • botVersion — (String)

        The version of the bot associated with this alias.

      • botAliasLocaleSettings — (map<map>)

        Configuration information for a specific locale.

        • enabled — required — (Boolean)

          Determines whether the locale is enabled for the bot. If the value is false, the locale isn't available for use.

        • codeHookSpecification — (map)

          Specifies the Lambda function that should be used in the locale.

          • lambdaCodeHook — required — (map)

            Specifies a Lambda function that verifies requests to a bot or fulfills the user's request to a bot.

            • lambdaARN — required — (String)

              The Amazon Resource Name (ARN) of the Lambda function.

            • codeHookInterfaceVersion — required — (String)

              The version of the request-response that you want Amazon Lex to use to invoke your Lambda function.

      • conversationLogSettings — (map)

        The conversation log settings specified for the alias.

        • textLogSettings — (Array<map>)

          The Amazon CloudWatch Logs settings for logging text and metadata.

          • enabled — required — (Boolean)

            Determines whether conversation logs should be stored for an alias.

          • destination — required — (map)

            Defines the Amazon CloudWatch Logs destination log group for conversation text logs.

            • cloudWatch — required — (map)

              Defines the Amazon CloudWatch Logs log group where text and metadata logs are delivered.

              • cloudWatchLogGroupArn — required — (String)

                The Amazon Resource Name (ARN) of the log group where text and metadata logs are delivered.

              • logPrefix — required — (String)

                The prefix of the log stream name within the log group that you specified

        • audioLogSettings — (Array<map>)

          The Amazon S3 settings for logging audio to an S3 bucket.

          • enabled — required — (Boolean)

            Determines whether audio logging in enabled for the bot.

          • destination — required — (map)

            The location of audio log files collected when conversation logging is enabled for a bot.

            • s3Bucket — required — (map)

              The Amazon S3 bucket where the audio log files are stored. The IAM role specified in the roleArn parameter of the CreateBot operation must have permission to write to this bucket.

              • kmsKeyArn — (String)

                The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key for encrypting audio log files stored in an S3 bucket.

              • s3BucketArn — required — (String)

                The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio log files are stored.

              • logPrefix — required — (String)

                The S3 prefix to assign to audio log files.

      • sentimentAnalysisSettings — (map)

        Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.

        • detectSentiment — required — (Boolean)

          Sets whether Amazon Lex uses Amazon Comprehend to detect the sentiment of user utterances.

      • botAliasStatus — (String)

        The current status of the alias. The alias is first put into the Creating state. When the alias is ready to be used, it is put into the Available state. You can use the DescribeBotAlias operation to get the current state of an alias.

        Possible values include:
        • "Creating"
        • "Available"
        • "Deleting"
        • "Failed"
      • botId — (String)

        The unique identifier of the bot that this alias applies to.

      • creationDateTime — (Date)

        A Unix timestamp indicating the date and time that the bot alias was created.

      • tags — (map<String>)

        A list of tags associated with the bot alias.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createBotLocale(params = {}, callback) ⇒ AWS.Request

Creates a locale in the bot. The locale contains the intents and slot types that the bot uses in conversations with users in the specified language and locale. You must add a locale to a bot before you can add intents and slot types to the bot.

Service Reference:

Examples:

Calling the createBotLocale operation

var params = {
  botId: 'STRING_VALUE', /* required */
  botVersion: 'STRING_VALUE', /* required */
  localeId: 'STRING_VALUE', /* required */
  nluIntentConfidenceThreshold: 'NUMBER_VALUE', /* required */
  description: 'STRING_VALUE',
  voiceSettings: {
    voiceId: 'STRING_VALUE' /* required */
  }
};
lexmodelsv2.createBotLocale(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • botId — (String)

      The identifier of the bot to create the locale for.

    • botVersion — (String)

      The version of the bot to create the locale for. This can only be the draft version of the bot.

    • localeId — (String)

      The identifier of the language and locale that the bot will be used in. The string must match one of the supported locales. All of the intents, slot types, and slots used in the bot must have the same locale. For more information, see Supported languages.

    • description — (String)

      A description of the bot locale. Use this to help identify the bot locale in lists.

    • nluIntentConfidenceThreshold — (Float)

      Determines the threshold where Amazon Lex will insert the AMAZON.FallbackIntent, AMAZON.KendraSearchIntent, or both when returning alternative intents. AMAZON.FallbackIntent and AMAZON.KendraSearchIntent are only inserted if they are configured for the bot.

      For example, suppose a bot is configured with the confidence threshold of 0.80 and the AMAZON.FallbackIntent. Amazon Lex returns three alternative intents with the following confidence scores: IntentA (0.70), IntentB (0.60), IntentC (0.50). The response from the RecognizeText operation would be:

      • AMAZON.FallbackIntent

      • IntentA

      • IntentB

      • IntentC

    • voiceSettings — (map)

      The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user.

      • voiceId — required — (String)

        The identifier of the Amazon Polly voice to use.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • botId — (String)

        The specified bot identifier.

      • botVersion — (String)

        The specified bot version.

      • localeName — (String)

        The specified locale name.

      • localeId — (String)

        The specified locale identifier.

      • description — (String)

        The specified description of the bot locale.

      • nluIntentConfidenceThreshold — (Float)

        The specified confidence threshold for inserting the AMAZON.FallbackIntent and AMAZON.KendraSearchIntent intents.

      • voiceSettings — (map)

        The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user.

        • voiceId — required — (String)

          The identifier of the Amazon Polly voice to use.

      • botLocaleStatus — (String)

        The status of the bot.

        When the status is Creating the bot locale is being configured. When the status is Building Amazon Lex is building the bot for testing and use.

        If the status of the bot is ReadyExpressTesting, you can test the bot using the exact utterances specified in the bots' intents. When the bot is ready for full testing or to run, the status is Built.

        If there was a problem with building the bot, the status is Failed. If the bot was saved but not built, the status is NotBuilt.

        Possible values include:
        • "Creating"
        • "Building"
        • "Built"
        • "ReadyExpressTesting"
        • "Failed"
        • "Deleting"
        • "NotBuilt"
        • "Importing"
      • creationDateTime — (Date)

        A timestamp specifying the date and time that the bot locale was created.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createBotVersion(params = {}, callback) ⇒ AWS.Request

Creates a new version of the bot based on the DRAFT version. If the DRAFT version of this resource hasn't changed since you created the last version, Amazon Lex doesn't create a new version, it returns the last created version.

When you create the first version of a bot, Amazon Lex sets the version to 1. Subsequent versions increment by 1.

Service Reference:

Examples:

Calling the createBotVersion operation

var params = {
  botId: 'STRING_VALUE', /* required */
  botVersionLocaleSpecification: { /* required */
    '<LocaleId>': {
      sourceBotVersion: 'STRING_VALUE' /* required */
    },
    /* '<LocaleId>': ... */
  },
  description: 'STRING_VALUE'
};
lexmodelsv2.createBotVersion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • botId — (String)

      The identifier of the bot to create the version for.

    • description — (String)

      A description of the version. Use the description to help identify the version in lists.

    • botVersionLocaleSpecification — (map<map>)

      Specifies the locales that Amazon Lex adds to this version. You can choose the Draft version or any other previously published version for each locale. When you specify a source version, the locale data is copied from the source version to the new version.

      • sourceBotVersion — required — (String)

        The version of a bot used for a bot locale.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • botId — (String)

        The bot identifier specified in the request.

      • description — (String)

        The description of the version specified in the request.

      • botVersion — (String)

        The version number assigned to the version.

      • botVersionLocaleSpecification — (map<map>)

        The source versions used for each locale in the new version.

        • sourceBotVersion — required — (String)

          The version of a bot used for a bot locale.

      • botStatus — (String)

        When you send a request to create or update a bot, Amazon Lex sets the status response element to Creating. After Amazon Lex builds the bot, it sets status to Available. If Amazon Lex can't build the bot, it sets status to Failed.

        Possible values include:
        • "Creating"
        • "Available"
        • "Inactive"
        • "Deleting"
        • "Failed"
        • "Versioning"
        • "Importing"
      • creationDateTime — (Date)

        A timestamp of the date and time that the version was created.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createExport(params = {}, callback) ⇒ AWS.Request

Creates a zip archive containing the contents of a bot or a bot locale. The archive contains a directory structure that contains JSON files that define the bot.

You can create an archive that contains the complete definition of a bot, or you can specify that the archive contain only the definition of a single bot locale.

For more information about exporting bots, and about the structure of the export archive, see Importing and exporting bots

Service Reference:

Examples:

Calling the createExport operation

var params = {
  fileFormat: LexJson, /* required */
  resourceSpecification: { /* required */
    botExportSpecification: {
      botId: 'STRING_VALUE', /* required */
      botVersion: 'STRING_VALUE' /* required */
    },
    botLocaleExportSpecification: {
      botId: 'STRING_VALUE', /* required */
      botVersion: 'STRING_VALUE', /* required */
      localeId: 'STRING_VALUE' /* required */
    }
  },
  filePassword: 'STRING_VALUE'
};
lexmodelsv2.createExport(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • resourceSpecification — (map)

      Specifies the type of resource to export, either a bot or a bot locale. You can only specify one type of resource to export.

      • botExportSpecification — (map)

        Parameters for exporting a bot.

        • botId — required — (String)

          The identifier of the bot assigned by Amazon Lex.

        • botVersion — required — (String)

          The version of the bot that was exported. This will be either DRAFT or the version number.

      • botLocaleExportSpecification — (map)

        Parameters for exporting a bot locale.

        • botId — required — (String)

          The identifier of the bot to create the locale for.

        • botVersion — required — (String)

          The version of the bot to export.

        • localeId — required — (String)

          The identifier of the language and locale to export. The string must match one of the locales in the bot.

    • fileFormat — (String)

      The file format of the bot or bot locale definition files.

      Possible values include:
      • "LexJson"
    • filePassword — (String)

      An password to use to encrypt the exported archive. Using a password is optional, but you should encrypt the archive to protect the data in transit between Amazon Lex and your local computer.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • exportId — (String)

        An identifier for a specific request to create an export.

      • resourceSpecification — (map)

        A description of the type of resource that was exported, either a bot or a bot locale.

        • botExportSpecification — (map)

          Parameters for exporting a bot.

          • botId — required — (String)

            The identifier of the bot assigned by Amazon Lex.

          • botVersion — required — (String)

            The version of the bot that was exported. This will be either DRAFT or the version number.

        • botLocaleExportSpecification — (map)

          Parameters for exporting a bot locale.

          • botId — required — (String)

            The identifier of the bot to create the locale for.

          • botVersion — required — (String)

            The version of the bot to export.

          • localeId — required — (String)

            The identifier of the language and locale to export. The string must match one of the locales in the bot.

      • fileFormat — (String)

        The file format used for the bot or bot locale definition files.

        Possible values include:
        • "LexJson"
      • exportStatus — (String)

        The status of the export. When the status is Completed, you can use the operation to get the pre-signed S3 URL link to your exported bot or bot locale.

        Possible values include:
        • "InProgress"
        • "Completed"
        • "Failed"
        • "Deleting"
      • creationDateTime — (Date)

        The date and time that the request to export a bot was created.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createIntent(params = {}, callback) ⇒ AWS.Request

Creates an intent.

To define the interaction between the user and your bot, you define one or more intents. For example, for a pizza ordering bot you would create an OrderPizza intent.

When you create an intent, you must provide a name. You can optionally provide the following:

  • Sample utterances. For example, "I want to order a pizza" and "Can I order a pizza." You can't provide utterances for built-in intents.

  • Information to be gathered. You specify slots for the information that you bot requests from the user. You can specify standard slot types, such as date and time, or custom slot types for your application.

  • How the intent is fulfilled. You can provide a Lambda function or configure the intent to return the intent information to your client application. If you use a Lambda function, Amazon Lex invokes the function when all of the intent information is available.

  • A confirmation prompt to send to the user to confirm an intent. For example, "Shall I order your pizza?"

  • A conclusion statement to send to the user after the intent is fulfilled. For example, "I ordered your pizza."

  • A follow-up prompt that asks the user for additional activity. For example, "Do you want a drink with your pizza?"

Service Reference:

Examples:

Calling the createIntent operation

var params = {
  botId: 'STRING_VALUE', /* required */
  botVersion: 'STRING_VALUE', /* required */
  intentName: 'STRING_VALUE', /* required */
  localeId: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  dialogCodeHook: {
    enabled: true || false /* required */
  },
  fulfillmentCodeHook: {
    enabled: true || false, /* required */
    fulfillmentUpdatesSpecification: {
      active: true || false, /* required */
      startResponse: {
        delayInSeconds: 'NUMBER_VALUE', /* required */
        messageGroups: [ /* required */
          {
            message: { /* required */
              customPayload: {
                value: 'STRING_VALUE' /* required */
              },
              imageResponseCard: {
                title: 'STRING_VALUE', /* required */
                buttons: [
                  {
                    text: 'STRING_VALUE', /* required */
                    value: 'STRING_VALUE' /* required */
                  },
                  /* more items */
                ],
                imageUrl: 'STRING_VALUE',
                subtitle: 'STRING_VALUE'
              },
              plainTextMessage: {
                value: 'STRING_VALUE' /* required */
              },
              ssmlMessage: {
                value: 'STRING_VALUE' /* required */
              }
            },
            variations: [
              {
                customPayload: {
                  value: 'STRING_VALUE' /* required */
                },
                imageResponseCard: {
                  title: 'STRING_VALUE', /* required */
                  buttons: [
                    {
                      text: 'STRING_VALUE', /* required */
                      value: 'STRING_VALUE' /* required */
                    },
                    /* more items */
                  ],
                  imageUrl: 'STRING_VALUE',
                  subtitle: 'STRING_VALUE'
                },
                plainTextMessage: {
                  value: 'STRING_VALUE' /* required */
                },
                ssmlMessage: {
                  value: 'STRING_VALUE' /* required */
                }
              },
              /* more items */
            ]
          },
          /* more items */
        ],
        allowInterrupt: true || false
      },
      timeoutInSeconds: 'NUMBER_VALUE',
      updateResponse: {
        frequencyInSeconds: 'NUMBER_VALUE', /* required */
        messageGroups: [ /* required */
          {
            message: { /* required */
              customPayload: {
                value: 'STRING_VALUE' /* required */
              },
              imageResponseCard: {
                title: 'STRING_VALUE', /* required */
                buttons: [
                  {
                    text: 'STRING_VALUE', /* required */
                    value: 'STRING_VALUE' /* required */
                  },
                  /* more items */
                ],
                imageUrl: 'STRING_VALUE',
                subtitle: 'STRING_VALUE'
              },
              plainTextMessage: {
                value: 'STRING_VALUE' /* required */
              },
              ssmlMessage: {
                value: 'STRING_VALUE' /* required */
              }
            },
            variations: [
              {
                customPayload: {
                  value: 'STRING_VALUE' /* required */
                },
                imageResponseCard: {
                  title: 'STRING_VALUE', /* required */
                  buttons: [
                    {
                      text: 'STRING_VALUE', /* required */
                      value: 'STRING_VALUE' /* required */
                    },
                    /* more items */
                  ],
                  imageUrl: 'STRING_VALUE',
                  subtitle: 'STRING_VALUE'
                },
                plainTextMessage: {
                  value: 'STRING_VALUE' /* required */
                },
                ssmlMessage: {
                  value: 'STRING_VALUE' /* required */
                }
              },
              /* more items */
            ]
          },
          /* more items */
        ],
        allowInterrupt: true || false
      }
    },
    postFulfillmentStatusSpecification: {
      failureResponse: {
        messageGroups: [ /* required */
          {
            message: { /* required */
              customPayload: {
                value: 'STRING_VALUE' /* required */
              },
              imageResponseCard: {
                title: 'STRING_VALUE', /* required */
                buttons: [
                  {
                    text: 'STRING_VALUE', /* required */
                    value: 'STRING_VALUE' /* required */
                  },
                  /* more items */
                ],
                imageUrl: 'STRING_VALUE',
                subtitle: 'STRING_VALUE'
              },
              plainTextMessage: {
                value: 'STRING_VALUE' /* required */
              },
              ssmlMessage: {
                value: 'STRING_VALUE' /* required */
              }
            },
            variations: [
              {
                customPayload: {
                  value: 'STRING_VALUE' /* required */
                },
                imageResponseCard: {
                  title: 'STRING_VALUE', /* required */
                  buttons: [
                    {
                      text: 'STRING_VALUE', /* required */
                      value: 'STRING_VALUE' /* required */
                    },
                    /* more items */
                  ],
                  imageUrl: 'STRING_VALUE',
                  subtitle: 'STRING_VALUE'
                },
                plainTextMessage: {
                  value: 'STRING_VALUE' /* required */
                },
                ssmlMessage: {
                  value: 'STRING_VALUE' /* required */
                }
              },
              /* more items */
            ]
          },
          /* more items */
        ],
        allowInterrupt: true || false
      },
      successResponse: {
        messageGroups: [ /* required */
          {
            message: { /* required */
              customPayload: {
                value: 'STRING_VALUE' /* required */
              },
              imageResponseCard: {
                title: 'STRING_VALUE', /* required */
                buttons: [
                  {
                    text: 'STRING_VALUE', /* required */
                    value: 'STRING_VALUE' /* required */
                  },
                  /* more items */
                ],
                imageUrl: 'STRING_VALUE',
                subtitle: 'STRING_VALUE'
              },
              plainTextMessage: {
                value: 'STRING_VALUE' /* required */
              },
              ssmlMessage: {
                value: 'STRING_VALUE' /* required */
              }
            },
            variations: [
              {
                customPayload: {
                  value: 'STRING_VALUE' /* required */
                },
                imageResponseCard: {
                  title: 'STRING_VALUE', /* required */
                  buttons: [
                    {
                      text: 'STRING_VALUE', /* required */
                      value: 'STRING_VALUE' /* required */
                    },
                    /* more items */
                  ],
                  imageUrl: 'STRING_VALUE',
                  subtitle: 'STRING_VALUE'
                },
                plainTextMessage: {
                  value: 'STRING_VALUE' /* required */
                },
                ssmlMessage: {
                  value: 'STRING_VALUE' /* required */
                }
              },
              /* more items */
            ]
          },
          /* more items */
        ],
        allowInterrupt: true || false
      },
      timeoutResponse: {
        messageGroups: [ /* required */
          {
            message: { /* required */
              customPayload: {
                value: 'STRING_VALUE' /* required */
              },
              imageResponseCard: {
                title: 'STRING_VALUE', /* required */
                buttons: [
                  {
                    text: 'STRING_VALUE', /* required */
                    value: 'STRING_VALUE' /* required */
                  },
                  /* more items */
                ],
                imageUrl: 'STRING_VALUE',
                subtitle: 'STRING_VALUE'
              },
              plainTextMessage: {
                value: 'STRING_VALUE' /* required */
              },
              ssmlMessage: {
                value: 'STRING_VALUE' /* required */
              }
            },
            variations: [
              {
                customPayload: {
                  value: 'STRING_VALUE' /* required */
                },
                imageResponseCard: {
                  title: 'STRING_VALUE', /* required */
                  buttons: [
                    {
                      text: 'STRING_VALUE', /* required */
                      value: 'STRING_VALUE' /* required */
                    },
                    /* more items */
                  ],
                  imageUrl: 'STRING_VALUE',
                  subtitle: 'STRING_VALUE'
                },
                plainTextMessage: {
                  value: 'STRING_VALUE' /* required */
                },
                ssmlMessage: {
                  value: 'STRING_VALUE' /* required */
                }
              },
              /* more items */
            ]
          },
          /* more items */
        ],
        allowInterrupt: true || false
      }
    }
  },
  inputContexts: [
    {
      name: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  intentClosingSetting: {
    closingResponse: { /* required */
      messageGroups: [ /* required */
        {
          message: { /* required */
            customPayload: {
              value: 'STRING_VALUE' /* required */
            },
            imageResponseCard: {
              title: 'STRING_VALUE', /* required */
              buttons: [
                {
                  text: 'STRING_VALUE', /* required */
                  value: 'STRING_VALUE' /* required */
                },
                /* more items */
              ],
              imageUrl: 'STRING_VALUE',
              subtitle: 'STRING_VALUE'
            },
            plainTextMessage: {
              value: 'STRING_VALUE' /* required */
            },
            ssmlMessage: {
              value: 'STRING_VALUE' /* required */
            }
          },
          variations: [
            {
              customPayload: {
                value: 'STRING_VALUE' /* required */
              },
              imageResponseCard: {
                title: 'STRING_VALUE', /* required */
                buttons: [
                  {
                    text: 'STRING_VALUE', /* required */
                    value: 'STRING_VALUE' /* required */
                  },
                  /* more items */
                ],
                imageUrl: 'STRING_VALUE',
                subtitle: 'STRING_VALUE'
              },
              plainTextMessage: {
                value: 'STRING_VALUE' /* required */
              },
              ssmlMessage: {
                value: 'STRING_VALUE' /* required */
              }
            },
            /* more items */
          ]
        },
        /* more items */
      ],
      allowInterrupt: true || false
    },
    active: true || false
  },
  intentConfirmationSetting: {
    declinationResponse: { /* required */
      messageGroups: [ /* required */
        {
          message: { /* required */
            customPayload: {
              value: 'STRING_VALUE' /* required */
            },
            imageResponseCard: {
              title: 'STRING_VALUE', /* required */
              buttons: [
                {
                  text: 'STRING_VALUE', /* required */
                  value: 'STRING_VALUE' /* required */
                },
                /* more items */
              ],
              imageUrl: 'STRING_VALUE',
              subtitle: 'STRING_VALUE'
            },
            plainTextMessage: {
              value: 'STRING_VALUE' /* required */
            },
            ssmlMessage: {
              value: 'STRING_VALUE' /* required */
            }
          },
          variations: [
            {
              customPayload: {
                value: 'STRING_VALUE' /* required */
              },
              imageResponseCard: {
                title: 'STRING_VALUE', /* required */
                buttons: [
                  {
                    text: 'STRING_VALUE', /* required */
                    value: 'STRING_VALUE' /* required */
                  },
                  /* more items */
                ],
                imageUrl: 'STRING_VALUE',
                subtitle: 'STRING_VALUE'
              },
              plainTextMessage: {
                value: 'STRING_VALUE' /* required */
              },
              ssmlMessage: {
                value: 'STRING_VALUE' /* required */
              }
            },
            /* more items */
          ]
        },
        /* more items */
      ],
      allowInterrupt: true || false
    },
    promptSpecification: { /* required */
      maxRetries: 'NUMBER_VALUE', /* required */
      messageGroups: [ /* required */
        {
          message: { /* required */
            customPayload: {
              value: 'STRING_VALUE' /* required */
            },
            imageResponseCard: {
              title: 'STRING_VALUE', /* required */
              buttons: [
                {
                  text: 'STRING_VALUE', /* required */
                  value: 'STRING_VALUE' /* required */
                },
                /* more items */
              ],
              imageUrl: 'STRING_VALUE',
              subtitle: 'STRING_VALUE'
            },
            plainTextMessage: {
              value: 'STRING_VALUE' /* required */
            },
            ssmlMessage: {
              value: 'STRING_VALUE' /* required */
            }
          },
          variations: [
            {
              customPayload: {
                value: 'STRING_VALUE' /* required */
              },
              imageResponseCard: {
                title: 'STRING_VALUE', /* required */
                buttons: [
                  {
                    text: 'STRING_VALUE', /* required */
                    value: 'STRING_VALUE' /* required */
                  },
                  /* more items */
                ],
                imageUrl: 'STRING_VALUE',
                subtitle: 'STRING_VALUE'
              },
              plainTextMessage: {
                value: 'STRING_VALUE' /* required */
              },
              ssmlMessage: {
                value: 'STRING_VALUE' /* required */
              }
            },
            /* more items */
          ]
        },
        /* more items */
      ],
      allowInterrupt: true || false
    },
    active: true || false
  },
  kendraConfiguration: {
    kendraIndex: 'STRING_VALUE', /* required */
    queryFilterString: 'STRING_VALUE',
    queryFilterStringEnabled: true || false
  },
  outputContexts: [
    {
      name: 'STRING_VALUE', /* required */
      timeToLiveInSeconds: 'NUMBER_VALUE', /* required */
      turnsToLive: 'NUMBER_VALUE' /* required */
    },
    /* more items */
  ],
  parentIntentSignature: 'STRING_VALUE',
  sampleUtterances: [
    {
      utterance: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
lexmodelsv2.createIntent(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • intentName — (String)

      The name of the intent. Intent names must be unique in the locale that contains the intent and cannot match the name of any built-in intent.

    • description — (String)

      A description of the intent. Use the description to help identify the intent in lists.

    • parentIntentSignature — (String)

      A unique identifier for the built-in intent to base this intent on.

    • sampleUtterances — (Array<map>)

      An array of strings that a user might say to signal the intent. For example, "I want a pizza", or "I want a {PizzaSize} pizza".

      In an utterance, slot names are enclosed in curly braces (""") to indicate where they should be displayed in the utterance shown to the user..

      • utterance — required — (String)

        The sample utterance that Amazon Lex uses to build its machine-learning model to recognize intents.

    • dialogCodeHook — (map)

      Specifies that Amazon Lex invokes the alias Lambda function for each user input. You can invoke this Lambda function to personalize user interaction.

      For example, suppose that your bot determines that the user's name is John. You Lambda function might retrieve John's information from a backend database and prepopulate some of the values. For example, if you find that John is gluten intolerant, you might set the corresponding intent slot, glutenIntolerant to true. You might find John's phone number and set the corresponding session attribute.

      • enabled — required — (Boolean)

        Enables the dialog code hook so that it processes user requests.

    • fulfillmentCodeHook — (map)

      Specifies that Amazon Lex invokes the alias Lambda function when the intent is ready for fulfillment. You can invoke this function to complete the bot's transaction with the user.

      For example, in a pizza ordering bot, the Lambda function can look up the closest pizza restaurant to the customer's location and then place an order on the customer's behalf.

      • enabled — required — (Boolean)

        Indicates whether a Lambda function should be invoked to fulfill a specific intent.

      • postFulfillmentStatusSpecification — (map)

        Provides settings for messages sent to the user for after the Lambda fulfillment function completes. Post-fulfillment messages can be sent for both streaming and non-streaming conversations.

        • successResponse — (map)

          Specifies a list of message groups that Amazon Lex uses to respond the user input.

          • messageGroups — required — (Array<map>)

            A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

            • message — required — (map)

              The primary message that Amazon Lex should send to the user.

              • plainTextMessage — (map)

                A message in plain text format.

                • value — required — (String)

                  The message to send to the user.

              • customPayload — (map)

                A message in a custom format defined by the client application.

                • value — required — (String)

                  The string that is sent to your application.

              • ssmlMessage — (map)

                A message in Speech Synthesis Markup Language (SSML).

                • value — required — (String)

                  The SSML text that defines the prompt.

              • imageResponseCard — (map)

                A message that defines a response card that the client application can show to the user.

                • title — required — (String)

                  The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                • subtitle — (String)

                  The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                • imageUrl — (String)

                  The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                • buttons — (Array<map>)

                  A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                  • text — required — (String)

                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                  • value — required — (String)

                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

            • variations — (Array<map>)

              Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

              • plainTextMessage — (map)

                A message in plain text format.

                • value — required — (String)

                  The message to send to the user.

              • customPayload — (map)

                A message in a custom format defined by the client application.

                • value — required — (String)

                  The string that is sent to your application.

              • ssmlMessage — (map)

                A message in Speech Synthesis Markup Language (SSML).

                • value — required — (String)

                  The SSML text that defines the prompt.

              • imageResponseCard — (map)

                A message that defines a response card that the client application can show to the user.

                • title — required — (String)

                  The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                • subtitle — (String)

                  The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                • imageUrl — (String)

                  The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                • buttons — (Array<map>)

                  A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                  • text — required — (String)

                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                  • value — required — (String)

                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

          • allowInterrupt — (Boolean)

            Indicates whether the user can interrupt a speech response from Amazon Lex.

        • failureResponse — (map)

          Specifies a list of message groups that Amazon Lex uses to respond the user input.

          • messageGroups — required — (Array<map>)

            A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

            • message — required — (map)

              The primary message that Amazon Lex should send to the user.

              • plainTextMessage — (map)

                A message in plain text format.

                • value — required — (String)

                  The message to send to the user.

              • customPayload — (map)

                A message in a custom format defined by the client application.

                • value — required — (String)

                  The string that is sent to your application.

              • ssmlMessage — (map)

                A message in Speech Synthesis Markup Language (SSML).

                • value — required — (String)

                  The SSML text that defines the prompt.

              • imageResponseCard — (map)

                A message that defines a response card that the client application can show to the user.

                • title — required — (String)

                  The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                • subtitle — (String)

                  The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                • imageUrl — (String)

                  The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                • buttons — (Array<map>)

                  A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                  • text — required — (String)

                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                  • value — required — (String)

                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

            • variations — (Array<map>)

              Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

              • plainTextMessage — (map)

                A message in plain text format.

                • value — required — (String)

                  The message to send to the user.

              • customPayload — (map)

                A message in a custom format defined by the client application.

                • value — required — (String)

                  The string that is sent to your application.

              • ssmlMessage — (map)

                A message in Speech Synthesis Markup Language (SSML).

                • value — required — (String)

                  The SSML text that defines the prompt.

              • imageResponseCard — (map)

                A message that defines a response card that the client application can show to the user.

                • title — required — (String)

                  The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                • subtitle — (String)

                  The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                • imageUrl — (String)

                  The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                • buttons — (Array<map>)

                  A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                  • text — required — (String)

                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                  • value — required — (String)

                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

          • allowInterrupt — (Boolean)

            Indicates whether the user can interrupt a speech response from Amazon Lex.

        • timeoutResponse — (map)

          Specifies a list of message groups that Amazon Lex uses to respond the user input.

          • messageGroups — required — (Array<map>)

            A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

            • message — required — (map)

              The primary message that Amazon Lex should send to the user.

              • plainTextMessage — (map)

                A message in plain text format.

                • value — required — (String)

                  The message to send to the user.

              • customPayload — (map)

                A message in a custom format defined by the client application.

                • value — required — (String)

                  The string that is sent to your application.

              • ssmlMessage — (map)

                A message in Speech Synthesis Markup Language (SSML).

                • value — required — (String)

                  The SSML text that defines the prompt.

              • imageResponseCard — (map)

                A message that defines a response card that the client application can show to the user.

                • title — required — (String)

                  The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                • subtitle — (String)

                  The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                • imageUrl — (String)

                  The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                • buttons — (Array<map>)

                  A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                  • text — required — (String)

                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                  • value — required — (String)

                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

            • variations — (Array<map>)

              Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

              • plainTextMessage — (map)

                A message in plain text format.

                • value — required — (String)

                  The message to send to the user.

              • customPayload — (map)

                A message in a custom format defined by the client application.

                • value — required — (String)

                  The string that is sent to your application.

              • ssmlMessage — (map)

                A message in Speech Synthesis Markup Language (SSML).

                • value — required — (String)

                  The SSML text that defines the prompt.

              • imageResponseCard — (map)

                A message that defines a response card that the client application can show to the user.

                • title — required — (String)

                  The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                • subtitle — (String)

                  The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                • imageUrl — (String)

                  The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                • buttons — (Array<map>)

                  A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                  • text — required — (String)

                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                  • value — required — (String)

                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

          • allowInterrupt — (Boolean)

            Indicates whether the user can interrupt a speech response from Amazon Lex.

      • fulfillmentUpdatesSpecification — (map)

        Provides settings for update messages sent to the user for long-running Lambda fulfillment functions. Fulfillment updates can be used only with streaming conversations.

        • active — required — (Boolean)

          Determines whether fulfillment updates are sent to the user. When this field is true, updates are sent.

          If the active field is set to true, the startResponse, updateResponse, and timeoutInSeconds fields are required.

        • startResponse — (map)

          Provides configuration information for the message sent to users when the fulfillment Lambda functions starts running.

          • delayInSeconds — required — (Integer)

            The delay between when the Lambda fulfillment function starts running and the start message is played. If the Lambda function returns before the delay is over, the start message isn't played.

          • messageGroups — required — (Array<map>)

            One to 5 message groups that contain start messages. Amazon Lex chooses one of the messages to play to the user.

            • message — required — (map)

              The primary message that Amazon Lex should send to the user.

              • plainTextMessage — (map)

                A message in plain text format.

                • value — required — (String)

                  The message to send to the user.

              • customPayload — (map)

                A message in a custom format defined by the client application.

                • value — required — (String)

                  The string that is sent to your application.

              • ssmlMessage — (map)

                A message in Speech Synthesis Markup Language (SSML).

                • value — required — (String)

                  The SSML text that defines the prompt.

              • imageResponseCard — (map)

                A message that defines a response card that the client application can show to the user.

                • title — required — (String)

                  The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                • subtitle — (String)

                  The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                • imageUrl — (String)

                  The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                • buttons — (Array<map>)

                  A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                  • text — required — (String)

                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                  • value — required — (String)

                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

            • variations — (Array<map>)

              Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

              • plainTextMessage — (map)

                A message in plain text format.

                • value — required — (String)

                  The message to send to the user.

              • customPayload — (map)

                A message in a custom format defined by the client application.

                • value — required — (String)

                  The string that is sent to your application.

              • ssmlMessage — (map)

                A message in Speech Synthesis Markup Language (SSML).

                • value — required — (String)

                  The SSML text that defines the prompt.

              • imageResponseCard — (map)

                A message that defines a response card that the client application can show to the user.

                • title — required — (String)

                  The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                • subtitle — (String)

                  The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                • imageUrl — (String)

                  The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                • buttons — (Array<map>)

                  A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                  • text — required — (String)

                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                  • value — required — (String)

                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

          • allowInterrupt — (Boolean)

            Determines whether the user can interrupt the start message while it is playing.

        • updateResponse — (map)

          Provides configuration information for messages sent periodically to the user while the fulfillment Lambda function is running.

          • frequencyInSeconds — required — (Integer)

            The frequency that a message is sent to the user. When the period ends, Amazon Lex chooses a message from the message groups and plays it to the user. If the fulfillment Lambda returns before the first period ends, an update message is not played to the user.

          • messageGroups — required — (Array<map>)

            One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.

            • message — required — (map)

              The primary message that Amazon Lex should send to the user.

              • plainTextMessage — (map)

                A message in plain text format.

                • value — required — (String)

                  The message to send to the user.

              • customPayload — (map)

                A message in a custom format defined by the client application.

                • value — required — (String)

                  The string that is sent to your application.

              • ssmlMessage — (map)

                A message in Speech Synthesis Markup Language (SSML).

                • value — required — (String)

                  The SSML text that defines the prompt.

              • imageResponseCard — (map)

                A message that defines a response card that the client application can show to the user.

                • title — required — (String)

                  The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                • subtitle — (String)

                  The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                • imageUrl — (String)

                  The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                • buttons — (Array<map>)

                  A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                  • text — required — (String)

                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                  • value — required — (String)

                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

            • variations — (Array<map>)

              Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

              • plainTextMessage — (map)

                A message in plain text format.

                • value — required — (String)

                  The message to send to the user.

              • customPayload — (map)

                A message in a custom format defined by the client application.

                • value — required — (String)

                  The string that is sent to your application.

              • ssmlMessage — (map)

                A message in Speech Synthesis Markup Language (SSML).

                • value — required — (String)

                  The SSML text that defines the prompt.

              • imageResponseCard — (map)

                A message that defines a response card that the client application can show to the user.

                • title — required — (String)

                  The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                • subtitle — (String)

                  The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                • imageUrl — (String)

                  The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                • buttons — (Array<map>)

                  A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                  • text — required — (String)

                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                  • value — required — (String)

                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

          • allowInterrupt — (Boolean)

            Determines whether the user can interrupt an update message while it is playing.

        • timeoutInSeconds — (Integer)

          The length of time that the fulfillment Lambda function should run before it times out.

    • intentConfirmationSetting — (map)

      Provides prompts that Amazon Lex sends to the user to confirm the completion of an intent. If the user answers "no," the settings contain a statement that is sent to the user to end the intent.

      • promptSpecification — required — (map)

        Prompts the user to confirm the intent. This question should have a yes or no answer.

        Amazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for fulfillment. For example, with the OrderPizza intent, you might want to confirm that the order is correct before placing it. For other intents, such as intents that simply respond to user questions, you might not need to ask the user for confirmation before providing the information.

        • messageGroups — required — (Array<map>)

          A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.

          • message — required — (map)

            The primary message that Amazon Lex should send to the user.

            • plainTextMessage — (map)

              A message in plain text format.

              • value — required — (String)

                The message to send to the user.

            • customPayload — (map)

              A message in a custom format defined by the client application.

              • value — required — (String)

                The string that is sent to your application.

            • ssmlMessage — (map)

              A message in Speech Synthesis Markup Language (SSML).

              • value — required — (String)

                The SSML text that defines the prompt.

            • imageResponseCard — (map)

              A message that defines a response card that the client application can show to the user.

              • title — required — (String)

                The title to display on the response card. The format of the title is determined by the platform displaying the response card.

              • subtitle — (String)

                The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

              • imageUrl — (String)

                The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

              • buttons — (Array<map>)

                A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                • text — required — (String)

                  The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                • value — required — (String)

                  The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

          • variations — (Array<map>)

            Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

            • plainTextMessage — (map)

              A message in plain text format.

              • value — required — (String)

                The message to send to the user.

            • customPayload — (map)

              A message in a custom format defined by the client application.

              • value — required — (String)

                The string that is sent to your application.

            • ssmlMessage — (map)

              A message in Speech Synthesis Markup Language (SSML).

              • value — required — (String)

                The SSML text that defines the prompt.

            • imageResponseCard — (map)

              A message that defines a response card that the client application can show to the user.

              • title — required — (String)

                The title to display on the response card. The format of the title is determined by the platform displaying the response card.

              • subtitle — (String)

                The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

              • imageUrl — (String)

                The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

              • buttons — (Array<map>)

                A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                • text — required — (String)

                  The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                • value — required — (String)

                  The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

        • maxRetries — required — (Integer)

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

        • allowInterrupt — (Boolean)

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

      • declinationResponse — required — (map)

        When the user answers "no" to the question defined in promptSpecification, Amazon Lex responds with this response to acknowledge that the intent was canceled.

        • messageGroups — required — (Array<map>)

          A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

          • message — required — (map)

            The primary message that Amazon Lex should send to the user.

            • plainTextMessage — (map)

              A message in plain text format.

              • value — required — (String)

                The message to send to the user.

            • customPayload — (map)

              A message in a custom format defined by the client application.

              • value — required — (String)

                The string that is sent to your application.

            • ssmlMessage — (map)

              A message in Speech Synthesis Markup Language (SSML).

              • value — required — (String)

                The SSML text that defines the prompt.

            • imageResponseCard — (map)

              A message that defines a response card that the client application can show to the user.

              • title — required — (String)

                The title to display on the response card. The format of the title is determined by the platform displaying the response card.

              • subtitle — (String)

                The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

              • imageUrl — (String)

                The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

              • buttons — (Array<map>)

                A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                • text — required — (String)

                  The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                • value — required — (String)

                  The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

          • variations — (Array<map>)

            Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

            • plainTextMessage — (map)

              A message in plain text format.

              • value — required — (String)

                The message to send to the user.

            • customPayload — (map)

              A message in a custom format defined by the client application.

              • value — required — (String)

                The string that is sent to your application.

            • ssmlMessage — (map)

              A message in Speech Synthesis Markup Language (SSML).

              • value — required — (String)

                The SSML text that defines the prompt.

            • imageResponseCard — (map)

              A message that defines a response card that the client application can show to the user.

              • title — required — (String)

                The title to display on the response card. The format of the title is determined by the platform displaying the response card.

              • subtitle — (String)

                The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

              • imageUrl — (String)

                The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

              • buttons — (Array<map>)

                A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                • text — required — (String)

                  The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                • value — required — (String)

                  The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

        • allowInterrupt — (Boolean)

          Indicates whether the user can interrupt a speech response from Amazon Lex.

      • active — (Boolean)

        Specifies whether the intent's confirmation is sent to the user. When this field is false, confirmation and declination responses aren't sent. If the active field isn't specified, the default is true.

    • intentClosingSetting — (map)

      Sets the response that Amazon Lex sends to the user when the intent is closed.

      • closingResponse — required — (map)

        The response that Amazon Lex sends to the user when the intent is complete.

        • messageGroups — required — (Array<map>)

          A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

          • message — required — (map)

            The primary message that Amazon Lex should send to the user.

            • plainTextMessage — (map)

              A message in plain text format.

              • value — required — (String)

                The message to send to the user.

            • customPayload — (map)

              A message in a custom format defined by the client application.

              • value — required — (String)

                The string that is sent to your application.

            • ssmlMessage — (map)

              A message in Speech Synthesis Markup Language (SSML).

              • value — required — (String)

                The SSML text that defines the prompt.

            • imageResponseCard — (map)

              A message that defines a response card that the client application can show to the user.

              • title — required — (String)

                The title to display on the response card. The format of the title is determined by the platform displaying the response card.

              • subtitle — (String)

                The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

              • imageUrl — (String)

                The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

              • buttons — (Array<map>)

                A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                • text — required — (String)

                  The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                • value — required — (String)

                  The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

          • variations — (Array<map>)

            Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

            • plainTextMessage — (map)

              A message in plain text format.

              • value — required — (String)

                The message to send to the user.

            • customPayload — (map)

              A message in a custom format defined by the client application.

              • value — required — (String)

                The string that is sent to your application.

            • ssmlMessage — (map)

              A message in Speech Synthesis Markup Language (SSML).

              • value — required — (String)

                The SSML text that defines the prompt.

            • imageResponseCard — (map)

              A message that defines a response card that the client application can show to the user.

              • title — required — (String)

                The title to display on the response card. The format of the title is determined by the platform displaying the response card.

              • subtitle — (String)

                The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

              • imageUrl — (String)

                The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

              • buttons — (Array<map>)

                A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                • text — required — (String)

                  The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                • value — required — (String)

                  The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

        • allowInterrupt — (Boolean)

          Indicates whether the user can interrupt a speech response from Amazon Lex.

      • active — (Boolean)

        Specifies whether an intent's closing response is used. When this field is false, the closing response isn't sent to the user. If the active field isn't specified, the default is true.

    • inputContexts — (Array<map>)

      A list of contexts that must be active for this intent to be considered by Amazon Lex.

      When an intent has an input context list, Amazon Lex only considers using the intent in an interaction with the user when the specified contexts are included in the active context list for the session. If the contexts are not active, then Amazon Lex will not use the intent.

      A context can be automatically activated using the outputContexts property or it can be set at runtime.

      For example, if there are two intents with different input contexts that respond to the same utterances, only the intent with the active context will respond.

      An intent may have up to 5 input contexts. If an intent has multiple input contexts, all of the contexts must be active to consider the intent.

      • name — required — (String)

        The name of the context.

    • outputContexts — (Array<map>)

      A lists of contexts that the intent activates when it is fulfilled.

      You can use an output context to indicate the intents that Amazon Lex should consider for the next turn of the conversation with a customer.

      When you use the outputContextsList property, all of the contexts specified in the list are activated when the intent is fulfilled. You can set up to 10 output contexts. You can also set the number of conversation turns that the context should be active, or the length of time that the context should be active.

      • name — required — (String)

        The name of the output context.

      • timeToLiveInSeconds — required — (Integer)

        The amount of time, in seconds, that the output context should remain active. The time is figured from the first time the context is sent to the user.

      • turnsToLive — required — (Integer)

        The number of conversation turns that the output context should remain active. The number of turns is counted from the first time that the context is sent to the user.

    • kendraConfiguration — (map)

      Configuration information required to use the AMAZON.KendraSearchIntent intent to connect to an Amazon Kendra index. The AMAZON.KendraSearchIntent intent is called when Amazon Lex can't determine another intent to invoke.

      • kendraIndex — required — (String)

        The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the AMAZON.KendraSearchIntent intent to search. The index must be in the same account and Region as the Amazon Lex bot.

      • queryFilterStringEnabled — (Boolean)

        Determines whether the AMAZON.KendraSearchIntent intent uses a custom query string to query the Amazon Kendra index.

      • queryFilterString — (String)

        A query filter that Amazon Lex sends to Amazon Kendra to filter the response from a query. The filter is in the format defined by Amazon Kendra. For more information, see Filtering queries.

    • botId — (String)

      The identifier of the bot associated with this intent.

    • botVersion — (String)

      The identifier of the version of the bot associated with this intent.

    • localeId — (String)

      The identifier of the language and locale where this intent is used. All of the bots, slot types, and slots used by the intent must have the same locale. For more information, see Supported languages.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • intentId — (String)

        A unique identifier for the intent.

      • intentName — (String)

        The name specified for the intent.

      • description — (String)

        The description specified for the intent.

      • parentIntentSignature — (String)

        The signature of the parent intent specified for the intent.

      • sampleUtterances — (Array<map>)

        The sample utterances specified for the intent.

        • utterance — required — (String)

          The sample utterance that Amazon Lex uses to build its machine-learning model to recognize intents.

      • dialogCodeHook — (map)

        The dialog Lambda function specified for the intent.

        • enabled — required — (Boolean)

          Enables the dialog code hook so that it processes user requests.

      • fulfillmentCodeHook — (map)

        The fulfillment Lambda function specified for the intent.

        • enabled — required — (Boolean)

          Indicates whether a Lambda function should be invoked to fulfill a specific intent.

        • postFulfillmentStatusSpecification — (map)

          Provides settings for messages sent to the user for after the Lambda fulfillment function completes. Post-fulfillment messages can be sent for both streaming and non-streaming conversations.

          • successResponse — (map)

            Specifies a list of message groups that Amazon Lex uses to respond the user input.

            • messageGroups — required — (Array<map>)

              A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

              • message — required — (map)

                The primary message that Amazon Lex should send to the user.

                • plainTextMessage — (map)

                  A message in plain text format.

                  • value — required — (String)

                    The message to send to the user.

                • customPayload — (map)

                  A message in a custom format defined by the client application.

                  • value — required — (String)

                    The string that is sent to your application.

                • ssmlMessage — (map)

                  A message in Speech Synthesis Markup Language (SSML).

                  • value — required — (String)

                    The SSML text that defines the prompt.

                • imageResponseCard — (map)

                  A message that defines a response card that the client application can show to the user.

                  • title — required — (String)

                    The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                  • subtitle — (String)

                    The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                  • imageUrl — (String)

                    The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                  • buttons — (Array<map>)

                    A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                    • text — required — (String)

                      The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                    • value — required — (String)

                      The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

              • variations — (Array<map>)

                Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                • plainTextMessage — (map)

                  A message in plain text format.

                  • value — required — (String)

                    The message to send to the user.

                • customPayload — (map)

                  A message in a custom format defined by the client application.

                  • value — required — (String)

                    The string that is sent to your application.

                • ssmlMessage — (map)

                  A message in Speech Synthesis Markup Language (SSML).

                  • value — required — (String)

                    The SSML text that defines the prompt.

                • imageResponseCard — (map)

                  A message that defines a response card that the client application can show to the user.

                  • title — required — (String)

                    The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                  • subtitle — (String)

                    The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                  • imageUrl — (String)

                    The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                  • buttons — (Array<map>)

                    A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                    • text — required — (String)

                      The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                    • value — required — (String)

                      The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

            • allowInterrupt — (Boolean)

              Indicates whether the user can interrupt a speech response from Amazon Lex.

          • failureResponse — (map)

            Specifies a list of message groups that Amazon Lex uses to respond the user input.

            • messageGroups — required — (Array<map>)

              A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

              • message — required — (map)

                The primary message that Amazon Lex should send to the user.

                • plainTextMessage — (map)

                  A message in plain text format.

                  • value — required — (String)

                    The message to send to the user.

                • customPayload — (map)

                  A message in a custom format defined by the client application.

                  • value — required — (String)

                    The string that is sent to your application.

                • ssmlMessage — (map)

                  A message in Speech Synthesis Markup Language (SSML).

                  • value — required — (String)

                    The SSML text that defines the prompt.

                • imageResponseCard — (map)

                  A message that defines a response card that the client application can show to the user.

                  • title — required — (String)

                    The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                  • subtitle — (String)

                    The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                  • imageUrl — (String)

                    The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                  • buttons — (Array<map>)

                    A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                    • text — required — (String)

                      The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                    • value — required — (String)

                      The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

              • variations — (Array<map>)

                Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                • plainTextMessage — (map)

                  A message in plain text format.

                  • value — required — (String)

                    The message to send to the user.

                • customPayload — (map)

                  A message in a custom format defined by the client application.

                  • value — required — (String)

                    The string that is sent to your application.

                • ssmlMessage — (map)

                  A message in Speech Synthesis Markup Language (SSML).

                  • value — required — (String)

                    The SSML text that defines the prompt.

                • imageResponseCard — (map)

                  A message that defines a response card that the client application can show to the user.

                  • title — required — (String)

                    The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                  • subtitle — (String)

                    The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                  • imageUrl — (String)

                    The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                  • buttons — (Array<map>)

                    A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                    • text — required — (String)

                      The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                    • value — required — (String)

                      The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

            • allowInterrupt — (Boolean)

              Indicates whether the user can interrupt a speech response from Amazon Lex.

          • timeoutResponse — (map)

            Specifies a list of message groups that Amazon Lex uses to respond the user input.

            • messageGroups — required — (Array<map>)

              A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

              • message — required — (map)

                The primary message that Amazon Lex should send to the user.

                • plainTextMessage — (map)

                  A message in plain text format.

                  • value — required — (String)

                    The message to send to the user.

                • customPayload — (map)

                  A message in a custom format defined by the client application.

                  • value — required — (String)

                    The string that is sent to your application.

                • ssmlMessage — (map)

                  A message in Speech Synthesis Markup Language (SSML).

                  • value — required — (String)

                    The SSML text that defines the prompt.

                • imageResponseCard — (map)

                  A message that defines a response card that the client application can show to the user.

                  • title — required — (String)

                    The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                  • subtitle — (String)

                    The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                  • imageUrl — (String)

                    The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                  • buttons — (Array<map>)

                    A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                    • text — required — (String)

                      The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                    • value — required — (String)

                      The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

              • variations — (Array<map>)

                Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                • plainTextMessage — (map)

                  A message in plain text format.

                  • value — required — (String)

                    The message to send to the user.

                • customPayload — (map)

                  A message in a custom format defined by the client application.

                  • value — required — (String)

                    The string that is sent to your application.

                • ssmlMessage — (map)

                  A message in Speech Synthesis Markup Language (SSML).

                  • value — required — (String)

                    The SSML text that defines the prompt.

                • imageResponseCard — (map)

                  A message that defines a response card that the client application can show to the user.

                  • title — required — (String)

                    The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                  • subtitle — (String)

                    The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                  • imageUrl — (String)

                    The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                  • buttons — (Array<map>)

                    A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                    • text — required — (String)

                      The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                    • value — required — (String)

                      The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

            • allowInterrupt — (Boolean)

              Indicates whether the user can interrupt a speech response from Amazon Lex.

        • fulfillmentUpdatesSpecification — (map)

          Provides settings for update messages sent to the user for long-running Lambda fulfillment functions. Fulfillment updates can be used only with streaming conversations.

          • active — required — (Boolean)

            Determines whether fulfillment updates are sent to the user. When this field is true, updates are sent.

            If the active field is set to true, the startResponse, updateResponse, and timeoutInSeconds fields are required.

          • startResponse — (map)

            Provides configuration information for the message sent to users when the fulfillment Lambda functions starts running.

            • delayInSeconds — required — (Integer)

              The delay between when the Lambda fulfillment function starts running and the start message is played. If the Lambda function returns before the delay is over, the start message isn't played.

            • messageGroups — required — (Array<map>)

              One to 5 message groups that contain start messages. Amazon Lex chooses one of the messages to play to the user.

              • message — required — (map)

                The primary message that Amazon Lex should send to the user.

                • plainTextMessage — (map)

                  A message in plain text format.

                  • value — required — (String)

                    The message to send to the user.

                • customPayload — (map)

                  A message in a custom format defined by the client application.

                  • value — required — (String)

                    The string that is sent to your application.

                • ssmlMessage — (map)

                  A message in Speech Synthesis Markup Language (SSML).

                  • value — required — (String)

                    The SSML text that defines the prompt.

                • imageResponseCard — (map)

                  A message that defines a response card that the client application can show to the user.

                  • title — required — (String)

                    The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                  • subtitle — (String)

                    The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                  • imageUrl — (String)

                    The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                  • buttons — (Array<map>)

                    A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                    • text — required — (String)

                      The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                    • value — required — (String)

                      The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

              • variations — (Array<map>)

                Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                • plainTextMessage — (map)

                  A message in plain text format.

                  • value — required — (String)

                    The message to send to the user.

                • customPayload — (map)

                  A message in a custom format defined by the client application.

                  • value — required — (String)

                    The string that is sent to your application.

                • ssmlMessage — (map)

                  A message in Speech Synthesis Markup Language (SSML).

                  • value — required — (String)

                    The SSML text that defines the prompt.

                • imageResponseCard — (map)

                  A message that defines a response card that the client application can show to the user.

                  • title — required — (String)

                    The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                  • subtitle — (String)

                    The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                  • imageUrl — (String)

                    The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                  • buttons — (Array<map>)

                    A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                    • text — required — (String)

                      The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                    • value — required — (String)

                      The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

            • allowInterrupt — (Boolean)

              Determines whether the user can interrupt the start message while it is playing.

          • updateResponse — (map)

            Provides configuration information for messages sent periodically to the user while the fulfillment Lambda function is running.

            • frequencyInSeconds — required — (Integer)

              The frequency that a message is sent to the user. When the period ends, Amazon Lex chooses a message from the message groups and plays it to the user. If the fulfillment Lambda returns before the first period ends, an update message is not played to the user.

            • messageGroups — required — (Array<map>)

              One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.

              • message — required — (map)

                The primary message that Amazon Lex should send to the user.

                • plainTextMessage — (map)

                  A message in plain text format.

                  • value — required — (String)

                    The message to send to the user.

                • customPayload — (map)

                  A message in a custom format defined by the client application.

                  • value — required — (String)

                    The string that is sent to your application.

                • ssmlMessage — (map)

                  A message in Speech Synthesis Markup Language (SSML).

                  • value — required — (String)

                    The SSML text that defines the prompt.

                • imageResponseCard — (map)

                  A message that defines a response card that the client application can show to the user.

                  • title — required — (String)

                    The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                  • subtitle — (String)

                    The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                  • imageUrl — (String)

                    The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                  • buttons — (Array<map>)

                    A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                    • text — required — (String)

                      The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                    • value — required — (String)

                      The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

              • variations — (Array<map>)

                Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                • plainTextMessage — (map)

                  A message in plain text format.

                  • value — required — (String)

                    The message to send to the user.

                • customPayload — (map)

                  A message in a custom format defined by the client application.

                  • value — required — (String)

                    The string that is sent to your application.

                • ssmlMessage — (map)

                  A message in Speech Synthesis Markup Language (SSML).

                  • value — required — (String)

                    The SSML text that defines the prompt.

                • imageResponseCard — (map)

                  A message that defines a response card that the client application can show to the user.

                  • title — required — (String)

                    The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                  • subtitle — (String)

                    The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                  • imageUrl — (String)

                    The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                  • buttons — (Array<map>)

                    A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                    • text — required — (String)

                      The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                    • value — required — (String)

                      The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

            • allowInterrupt — (Boolean)

              Determines whether the user can interrupt an update message while it is playing.

          • timeoutInSeconds — (Integer)

            The length of time that the fulfillment Lambda function should run before it times out.

      • intentConfirmationSetting — (map)

        The confirmation setting specified for the intent.

        • promptSpecification — required — (map)

          Prompts the user to confirm the intent. This question should have a yes or no answer.

          Amazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for fulfillment. For example, with the OrderPizza intent, you might want to confirm that the order is correct before placing it. For other intents, such as intents that simply respond to user questions, you might not need to ask the user for confirmation before providing the information.

          • messageGroups — required — (Array<map>)

            A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.

            • message — required — (map)

              The primary message that Amazon Lex should send to the user.

              • plainTextMessage — (map)

                A message in plain text format.

                • value — required — (String)

                  The message to send to the user.

              • customPayload — (map)

                A message in a custom format defined by the client application.

                • value — required — (String)

                  The string that is sent to your application.

              • ssmlMessage — (map)

                A message in Speech Synthesis Markup Language (SSML).

                • value — required — (String)

                  The SSML text that defines the prompt.

              • imageResponseCard — (map)

                A message that defines a response card that the client application can show to the user.

                • title — required — (String)

                  The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                • subtitle — (String)

                  The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                • imageUrl — (String)

                  The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                • buttons — (Array<map>)

                  A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                  • text — required — (String)

                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                  • value — required — (String)

                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

            • variations — (Array<map>)

              Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

              • plainTextMessage — (map)

                A message in plain text format.

                • value — required — (String)

                  The message to send to the user.

              • customPayload — (map)

                A message in a custom format defined by the client application.

                • value — required — (String)

                  The string that is sent to your application.

              • ssmlMessage — (map)

                A message in Speech Synthesis Markup Language (SSML).

                • value — required — (String)

                  The SSML text that defines the prompt.

              • imageResponseCard — (map)

                A message that defines a response card that the client application can show to the user.

                • title — required — (String)

                  The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                • subtitle — (String)

                  The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                • imageUrl — (String)

                  The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                • buttons — (Array<map>)

                  A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                  • text — required — (String)

                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                  • value — required — (String)

                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

          • maxRetries — required — (Integer)

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

          • allowInterrupt — (Boolean)

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

        • declinationResponse — required — (map)

          When the user answers "no" to the question defined in promptSpecification, Amazon Lex responds with this response to acknowledge that the intent was canceled.

          • messageGroups — required — (Array<map>)

            A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

            • message — required — (map)

              The primary message that Amazon Lex should send to the user.

              • plainTextMessage — (map)

                A message in plain text format.

                • value — required — (String)

                  The message to send to the user.

              • customPayload — (map)

                A message in a custom format defined by the client application.

                • value — required — (String)

                  The string that is sent to your application.

              • ssmlMessage — (map)

                A message in Speech Synthesis Markup Language (SSML).

                • value — required — (String)

                  The SSML text that defines the prompt.

              • imageResponseCard — (map)

                A message that defines a response card that the client application can show to the user.

                • title — required — (String)

                  The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                • subtitle — (String)

                  The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                • imageUrl — (String)

                  The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                • buttons — (Array<map>)

                  A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                  • text — required — (String)

                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                  • value — required — (String)

                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

            • variations — (Array<map>)

              Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

              • plainTextMessage — (map)

                A message in plain text format.

                • value — required — (String)

                  The message to send to the user.

              • customPayload — (map)

                A message in a custom format defined by the client application.

                • value — required — (String)

                  The string that is sent to your application.

              • ssmlMessage — (map)

                A message in Speech Synthesis Markup Language (SSML).

                • value — required — (String)

                  The SSML text that defines the prompt.

              • imageResponseCard — (map)

                A message that defines a response card that the client application can show to the user.

                • title — required — (String)

                  The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                • subtitle — (String)

                  The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                • imageUrl — (String)

                  The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                • buttons — (Array<map>)

                  A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                  • text — required — (String)

                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                  • value — required — (String)

                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

          • allowInterrupt — (Boolean)

            Indicates whether the user can interrupt a speech response from Amazon Lex.

        • active — (Boolean)

          Specifies whether the intent's confirmation is sent to the user. When this field is false, confirmation and declination responses aren't sent. If the active field isn't specified, the default is true.

      • intentClosingSetting — (map)

        The closing setting specified for the intent.

        • closingResponse — required — (map)

          The response that Amazon Lex sends to the user when the intent is complete.

          • messageGroups — required — (Array<map>)

            A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

            • message — required — (map)

              The primary message that Amazon Lex should send to the user.

              • plainTextMessage — (map)

                A message in plain text format.

                • value — required — (String)

                  The message to send to the user.

              • customPayload — (map)

                A message in a custom format defined by the client application.

                • value — required — (String)

                  The string that is sent to your application.

              • ssmlMessage — (map)

                A message in Speech Synthesis Markup Language (SSML).

                • value — required — (String)

                  The SSML text that defines the prompt.

              • imageResponseCard — (map)

                A message that defines a response card that the client application can show to the user.

                • title — required — (String)

                  The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                • subtitle — (String)

                  The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                • imageUrl — (String)

                  The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                • buttons — (Array<map>)

                  A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                  • text — required — (String)

                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                  • value — required — (String)

                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

            • variations — (Array<map>)

              Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

              • plainTextMessage — (map)

                A message in plain text format.

                • value — required — (String)

                  The message to send to the user.

              • customPayload — (map)

                A message in a custom format defined by the client application.

                • value — required — (String)

                  The string that is sent to your application.

              • ssmlMessage — (map)

                A message in Speech Synthesis Markup Language (SSML).

                • value — required — (String)

                  The SSML text that defines the prompt.

              • imageResponseCard — (map)

                A message that defines a response card that the client application can show to the user.

                • title — required — (String)

                  The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                • subtitle — (String)

                  The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                • imageUrl — (String)

                  The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                • buttons — (Array<map>)

                  A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                  • text — required — (String)

                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                  • value — required — (String)

                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

          • allowInterrupt — (Boolean)

            Indicates whether the user can interrupt a speech response from Amazon Lex.

        • active — (Boolean)

          Specifies whether an intent's closing response is used. When this field is false, the closing response isn't sent to the user. If the active field isn't specified, the default is true.

      • inputContexts — (Array<map>)

        The list of input contexts specified for the intent.

        • name — required — (String)

          The name of the context.

      • outputContexts — (Array<map>)

        The list of output contexts specified for the intent.

        • name — required — (String)

          The name of the output context.

        • timeToLiveInSeconds — required — (Integer)

          The amount of time, in seconds, that the output context should remain active. The time is figured from the first time the context is sent to the user.

        • turnsToLive — required — (Integer)

          The number of conversation turns that the output context should remain active. The number of turns is counted from the first time that the context is sent to the user.

      • kendraConfiguration — (map)

        Configuration for searching a Amazon Kendra index specified for the intent.

        • kendraIndex — required — (String)

          The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the AMAZON.KendraSearchIntent intent to search. The index must be in the same account and Region as the Amazon Lex bot.

        • queryFilterStringEnabled — (Boolean)

          Determines whether the AMAZON.KendraSearchIntent intent uses a custom query string to query the Amazon Kendra index.

        • queryFilterString — (String)

          A query filter that Amazon Lex sends to Amazon Kendra to filter the response from a query. The filter is in the format defined by Amazon Kendra. For more information, see Filtering queries.

      • botId — (String)

        The identifier of the bot associated with the intent.

      • botVersion — (String)

        The identifier of the version of the bot associated with the intent.

      • localeId — (String)

        The locale that the intent is specified to use.

      • creationDateTime — (Date)

        A timestamp of the date and time that the intent was created.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createResourcePolicy(params = {}, callback) ⇒ AWS.Request

Creates a new resource policy with the specified policy statements.

Service Reference:

Examples:

Calling the createResourcePolicy operation

var params = {
  policy: 'STRING_VALUE', /* required */
  resourceArn: 'STRING_VALUE' /* required */
};
lexmodelsv2.createResourcePolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • resourceArn — (String)

      The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.

    • policy — (String)

      A resource policy to add to the resource. The policy is a JSON structure that contains one or more statements that define the policy. The policy must follow the IAM syntax. For more information about the contents of a JSON policy document, see IAM JSON policy reference .

      If the policy isn't valid, Amazon Lex returns a validation exception.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • resourceArn — (String)

        The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy was attached to.

      • revisionId — (String)

        The current revision of the resource policy. Use the revision ID to make sure that you are updating the most current version of a resource policy when you add a policy statement to a resource, delete a resource, or update a resource.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createResourcePolicyStatement(params = {}, callback) ⇒ AWS.Request

Adds a new resource policy statement to a bot or bot alias. If a resource policy exists, the statement is added to the current resource policy. If a policy doesn't exist, a new policy is created.

You can't create a resource policy statement that allows cross-account access.

Service Reference:

Examples:

Calling the createResourcePolicyStatement operation

var params = {
  action: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  effect: Allow | Deny, /* required */
  principal: [ /* required */
    {
      arn: 'STRING_VALUE',
      service: 'STRING_VALUE'
    },
    /* more items */
  ],
  resourceArn: 'STRING_VALUE', /* required */
  statementId: 'STRING_VALUE', /* required */
  condition: {
    '<ConditionOperator>': {
      '<ConditionKey>': 'STRING_VALUE',
      /* '<ConditionKey>': ... */
    },
    /* '<ConditionOperator>': ... */
  },
  expectedRevisionId: 'STRING_VALUE'
};
lexmodelsv2.createResourcePolicyStatement(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • resourceArn — (String)

      The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.

    • statementId — (String)

      The name of the statement. The ID is the same as the Sid IAM property. The statement name must be unique within the policy. For more information, see IAM JSON policy elements: Sid.

    • effect — (String)

      Determines whether the statement allows or denies access to the resource.

      Possible values include:
      • "Allow"
      • "Deny"
    • principal — (Array<map>)

      An IAM principal, such as an IAM users, IAM roles, or AWS services that is allowed or denied access to a resource. For more information, see AWS JSON policy elements: Principal.

      • service — (String)

        The name of the AWS service that should allowed or denied access to an Amazon Lex action.

      • arn — (String)

        The Amazon Resource Name (ARN) of the principal.

    • action — (Array<String>)

      The Amazon Lex action that this policy either allows or denies. The action must apply to the resource type of the specified ARN. For more information, see Actions, resources, and condition keys for Amazon Lex V2.

    • condition — (map<map<String>>)

      Specifies a condition when the policy is in effect. If the principal of the policy is a service principal, you must provide two condition blocks, one with a SourceAccount global condition key and one with a SourceArn global condition key.

      For more information, see IAM JSON policy elements: Condition .

    • expectedRevisionId — (String)

      The identifier of the revision of the policy to edit. If this revision ID doesn't match the current revision ID, Amazon Lex throws an exception.

      If you don't specify a revision, Amazon Lex overwrites the contents of the policy with the new values.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • resourceArn — (String)

        The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.

      • revisionId — (String)

        The current revision of the resource policy. Use the revision ID to make sure that you are updating the most current version of a resource policy when you add a policy statement to a resource, delete a resource, or update a resource.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createSlot(params = {}, callback) ⇒ AWS.Request

Creates a slot in an intent. A slot is a variable needed to fulfill an intent. For example, an OrderPizza intent might need slots for size, crust, and number of pizzas. For each slot, you define one or more utterances that Amazon Lex uses to elicit a response from the user.

Service Reference:

Examples:

Calling the createSlot operation

var params = {
  botId: 'STRING_VALUE', /* required */
  botVersion: 'STRING_VALUE', /* required */
  intentId: 'STRING_VALUE', /* required */
  localeId: 'STRING_VALUE', /* required */
  slotName: 'STRING_VALUE', /* required */
  slotTypeId: 'STRING_VALUE', /* required */
  valueElicitationSetting: { /* required */
    slotConstraint: Required | Optional, /* required */
    defaultValueSpecification: {
      defaultValueList: [ /* required */
        {
          defaultValue: 'STRING_VALUE' /* required */
        },
        /* more items */
      ]
    },
    promptSpecification: {
      maxRetries: 'NUMBER_VALUE', /* required */
      messageGroups: [ /* required */
        {
          message: { /* required */
            customPayload: {
              value: 'STRING_VALUE' /* required */
            },
            imageResponseCard: {
              title: 'STRING_VALUE', /* required */
              buttons: [
                {
                  text: 'STRING_VALUE', /* required */
                  value: 'STRING_VALUE' /* required */
                },
                /* more items */
              ],
              imageUrl: 'STRING_VALUE',
              subtitle: 'STRING_VALUE'
            },
            plainTextMessage: {
              value: 'STRING_VALUE' /* required */
            },
            ssmlMessage: {
              value: 'STRING_VALUE' /* required */
            }
          },
          variations: [
            {
              customPayload: {
                value: 'STRING_VALUE' /* required */
              },
              imageResponseCard: {
                title: 'STRING_VALUE', /* required */
                buttons: [
                  {
                    text: 'STRING_VALUE', /* required */
                    value: 'STRING_VALUE' /* required */
                  },
                  /* more items */
                ],
                imageUrl: 'STRING_VALUE',
                subtitle: 'STRING_VALUE'
              },
              plainTextMessage: {
                value: 'STRING_VALUE' /* required */
              },
              ssmlMessage: {
                value: 'STRING_VALUE' /* required */
              }
            },
            /* more items */
          ]
        },
        /* more items */
      ],
      allowInterrupt: true || false
    },
    sampleUtterances: [
      {
        utterance: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    waitAndContinueSpecification: {
      continueResponse: { /* required */
        messageGroups: [ /* required */
          {
            message: { /* required */
              customPayload: {
                value: 'STRING_VALUE' /* required */
              },
              imageResponseCard: {
                title: 'STRING_VALUE', /* required */
                buttons: [
                  {
                    text: 'STRING_VALUE', /* required */
                    value: 'STRING_VALUE' /* required */
                  },
                  /* more items */
                ],
                imageUrl: 'STRING_VALUE',
                subtitle: 'STRING_VALUE'
              },
              plainTextMessage: {
                value: 'STRING_VALUE' /* required */
              },
              ssmlMessage: {
                value: 'STRING_VALUE' /* required */
              }
            },
            variations: [
              {
                customPayload: {
                  value: 'STRING_VALUE' /* required */
                },
                imageResponseCard: {
                  title: 'STRING_VALUE', /* required */
                  buttons: [
                    {
                      text: 'STRING_VALUE', /* required */
                      value: 'STRING_VALUE' /* required */
                    },
                    /* more items */
                  ],
                  imageUrl: 'STRING_VALUE',
                  subtitle: 'STRING_VALUE'
                },
                plainTextMessage: {
                  value: 'STRING_VALUE' /* required */
                },
                ssmlMessage: {
                  value: 'STRING_VALUE' /* required */
                }
              },
              /* more items */
            ]
          },
          /* more items */
        ],
        allowInterrupt: true || false
      },
      waitingResponse: { /* required */
        messageGroups: [ /* required */
          {
            message: { /* required */
              customPayload: {
                value: 'STRING_VALUE' /* required */
              },
              imageResponseCard: {
                title: 'STRING_VALUE', /* required */
                buttons: [
                  {
                    text: 'STRING_VALUE', /* required */
                    value: 'STRING_VALUE' /* required */
                  },
                  /* more items */
                ],
                imageUrl: 'STRING_VALUE',
                subtitle: 'STRING_VALUE'
              },
              plainTextMessage: {
                value: 'STRING_VALUE' /* required */
              },
              ssmlMessage: {
                value: 'STRING_VALUE' /* required */
              }
            },
            variations: [
              {
                customPayload: {
                  value: 'STRING_VALUE' /* required */
                },
                imageResponseCard: {
                  title: 'STRING_VALUE', /* required */
                  buttons: [
                    {
                      text: 'STRING_VALUE', /* required */
                      value: 'STRING_VALUE' /* required */
                    },
                    /* more items */
                  ],
                  imageUrl: 'STRING_VALUE',
                  subtitle: 'STRING_VALUE'
                },
                plainTextMessage: {
                  value: 'STRING_VALUE' /* required */
                },
                ssmlMessage: {
                  value: 'STRING_VALUE' /* required */
                }
              },
              /* more items */
            ]
          },
          /* more items */
        ],
        allowInterrupt: true || false
      },
      active: true || false,
      stillWaitingResponse: {
        frequencyInSeconds: 'NUMBER_VALUE', /* required */
        messageGroups: [ /* required */
          {
            message: { /* required */
              customPayload: {
                value: 'STRING_VALUE' /* required */
              },
              imageResponseCard: {
                title: 'STRING_VALUE', /* required */
                buttons: [
                  {
                    text: 'STRING_VALUE', /* required */
                    value: 'STRING_VALUE' /* required */
                  },
                  /* more items */
                ],
                imageUrl: 'STRING_VALUE',
                subtitle: 'STRING_VALUE'
              },
              plainTextMessage: {
                value: 'STRING_VALUE' /* required */
              },
              ssmlMessage: {
                value: 'STRING_VALUE' /* required */
              }
            },
            variations: [
              {
                customPayload: {
                  value: 'STRING_VALUE' /* required */
                },
                imageResponseCard: {
                  title: 'STRING_VALUE', /* required */
                  buttons: [
                    {
                      text: 'STRING_VALUE', /* required */
                      value: 'STRING_VALUE' /* required */
                    },
                    /* more items */
                  ],
                  imageUrl: 'STRING_VALUE',
                  subtitle: 'STRING_VALUE'
                },
                plainTextMessage: {
                  value: 'STRING_VALUE' /* required */
                },
                ssmlMessage: {
                  value: 'STRING_VALUE' /* required */
                }
              },
              /* more items */
            ]
          },
          /* more items */
        ],
        timeoutInSeconds: 'NUMBER_VALUE', /* required */
        allowInterrupt: true || false
      }
    }
  },
  description: 'STRING_VALUE',
  multipleValuesSetting: {
    allowMultipleValues: true || false
  },
  obfuscationSetting: {
    obfuscationSettingType: None | DefaultObfuscation /* required */
  }
};
lexmodelsv2.createSlot(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • slotName — (String)

      The name of the slot. Slot names must be unique within the bot that contains the slot.

    • description — (String)

      A description of the slot. Use this to help identify the slot in lists.

    • slotTypeId — (String)

      The unique identifier for the slot type associated with this slot. The slot type determines the values that can be entered into the slot.

    • valueElicitationSetting — (map)

      Specifies prompts that Amazon Lex sends to the user to elicit a response that provides the value for the slot.

      • defaultValueSpecification — (map)

        A list of default values for a slot. Default values are used when Amazon Lex hasn't determined a value for a slot. You can specify default values from context variables, session attributes, and defined values.

        • defaultValueList — required — (Array<map>)

          A list of default values. Amazon Lex chooses the default value to use in the order that they are presented in the list.

          • defaultValue — required — (String)

            The default value to use when a user doesn't provide a value for a slot.

      • slotConstraint — required — (String)

        Specifies whether the slot is required or optional.

        Possible values include:
        • "Required"
        • "Optional"
      • promptSpecification — (map)

        The prompt that Amazon Lex uses to elicit the slot value from the user.

        • messageGroups — required — (Array<map>)

          A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.

          • message — required — (map)

            The primary message that Amazon Lex should send to the user.

            • plainTextMessage — (map)

              A message in plain text format.

              • value — required — (String)

                The message to send to the user.

            • customPayload — (map)

              A message in a custom format defined by the client application.

              • value — required — (String)

                The string that is sent to your application.

            • ssmlMessage — (map)

              A message in Speech Synthesis Markup Language (SSML).

              • value — required — (String)

                The SSML text that defines the prompt.

            • imageResponseCard — (map)

              A message that defines a response card that the client application can show to the user.

              • title — required — (String)

                The title to display on the response card. The format of the title is determined by the platform displaying the response card.

              • subtitle — (String)

                The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

              • imageUrl — (String)

                The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

              • buttons — (Array<map>)

                A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                • text — required — (String)

                  The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                • value — required — (String)

                  The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

          • variations — (Array<map>)

            Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

            • plainTextMessage — (map)

              A message in plain text format.

              • value — required — (String)

                The message to send to the user.

            • customPayload — (map)

              A message in a custom format defined by the client application.

              • value — required — (String)

                The string that is sent to your application.

            • ssmlMessage — (map)

              A message in Speech Synthesis Markup Language (SSML).

              • value — required — (String)

                The SSML text that defines the prompt.

            • imageResponseCard — (map)

              A message that defines a response card that the client application can show to the user.

              • title — required — (String)

                The title to display on the response card. The format of the title is determined by the platform displaying the response card.

              • subtitle — (String)

                The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

              • imageUrl — (String)

                The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

              • buttons — (Array<map>)

                A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                • text — required — (String)

                  The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                • value — required — (String)

                  The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

        • maxRetries — required — (Integer)

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

        • allowInterrupt — (Boolean)

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

      • sampleUtterances — (Array<map>)

        If you know a specific pattern that users might respond to an Amazon Lex request for a slot value, you can provide those utterances to improve accuracy. This is optional. In most cases, Amazon Lex is capable of understanding user utterances.

        • utterance — required — (String)

          The sample utterance that Amazon Lex uses to build its machine-learning model to recognize intents.

      • waitAndContinueSpecification — (map)

        Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input.

        • waitingResponse — required — (map)

          The response that Amazon Lex sends to indicate that the bot is waiting for the conversation to continue.

          • messageGroups — required — (Array<map>)

            A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

            • message — required — (map)

              The primary message that Amazon Lex should send to the user.

              • plainTextMessage — (map)

                A message in plain text format.

                • value — required — (String)

                  The message to send to the user.

              • customPayload — (map)

                A message in a custom format defined by the client application.

                • value — required — (String)

                  The string that is sent to your application.

              • ssmlMessage — (map)

                A message in Speech Synthesis Markup Language (SSML).

                • value — required — (String)

                  The SSML text that defines the prompt.

              • imageResponseCard — (map)

                A message that defines a response card that the client application can show to the user.

                • title — required — (String)

                  The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                • subtitle — (String)

                  The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                • imageUrl — (String)

                  The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                • buttons — (Array<map>)

                  A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                  • text — required — (String)

                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                  • value — required — (String)

                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

            • variations — (Array<map>)

              Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

              • plainTextMessage — (map)

                A message in plain text format.

                • value — required — (String)

                  The message to send to the user.

              • customPayload — (map)

                A message in a custom format defined by the client application.

                • value — required — (String)

                  The string that is sent to your application.

              • ssmlMessage — (map)

                A message in Speech Synthesis Markup Language (SSML).

                • value — required — (String)

                  The SSML text that defines the prompt.

              • imageResponseCard — (map)

                A message that defines a response card that the client application can show to the user.

                • title — required — (String)

                  The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                • subtitle — (String)

                  The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                • imageUrl — (String)

                  The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                • buttons — (Array<map>)

                  A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                  • text — required — (String)

                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                  • value — required — (String)

                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

          • allowInterrupt — (Boolean)

            Indicates whether the user can interrupt a speech response from Amazon Lex.

        • continueResponse — required — (map)

          The response that Amazon Lex sends to indicate that the bot is ready to continue the conversation.

          • messageGroups — required — (Array<map>)

            A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

            • message — required — (map)

              The primary message that Amazon Lex should send to the user.

              • plainTextMessage — (map)

                A message in plain text format.

                • value — required — (String)

                  The message to send to the user.

              • customPayload — (map)

                A message in a custom format defined by the client application.

                • value — required — (String)

                  The string that is sent to your application.

              • ssmlMessage — (map)

                A message in Speech Synthesis Markup Language (SSML).

                • value — required — (String)

                  The SSML text that defines the prompt.

              • imageResponseCard — (map)

                A message that defines a response card that the client application can show to the user.

                • title — required — (String)

                  The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                • subtitle — (String)

                  The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                • imageUrl — (String)

                  The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                • buttons — (Array<map>)

                  A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                  • text — required — (String)

                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                  • value — required — (String)

                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

            • variations — (Array<map>)

              Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

              • plainTextMessage — (map)

                A message in plain text format.

                • value — required — (String)

                  The message to send to the user.

              • customPayload — (map)

                A message in a custom format defined by the client application.

                • value — required — (String)

                  The string that is sent to your application.

              • ssmlMessage — (map)

                A message in Speech Synthesis Markup Language (SSML).

                • value — required — (String)

                  The SSML text that defines the prompt.

              • imageResponseCard — (map)

                A message that defines a response card that the client application can show to the user.

                • title — required — (String)

                  The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                • subtitle — (String)

                  The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                • imageUrl — (String)

                  The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                • buttons — (Array<map>)

                  A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                  • text — required — (String)

                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                  • value — required — (String)

                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

          • allowInterrupt — (Boolean)

            Indicates whether the user can interrupt a speech response from Amazon Lex.

        • stillWaitingResponse — (map)

          A response that Amazon Lex sends periodically to the user to indicate that the bot is still waiting for input from the user.

          • messageGroups — required — (Array<map>)

            One or more message groups, each containing one or more messages, that define the prompts that Amazon Lex sends to the user.

            • message — required — (map)

              The primary message that Amazon Lex should send to the user.

              • plainTextMessage — (map)

                A message in plain text format.

                • value — required — (String)

                  The message to send to the user.

              • customPayload — (map)

                A message in a custom format defined by the client application.

                • value — required — (String)

                  The string that is sent to your application.

              • ssmlMessage — (map)

                A message in Speech Synthesis Markup Language (SSML).

                • value — required — (String)

                  The SSML text that defines the prompt.

              • imageResponseCard — (map)

                A message that defines a response card that the client application can show to the user.

                • title — required — (String)

                  The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                • subtitle — (String)

                  The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                • imageUrl — (String)

                  The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                • buttons — (Array<map>)

                  A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                  • text — required — (String)

                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                  • value — required — (String)

                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

            • variations — (Array<map>)

              Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

              • plainTextMessage — (map)

                A message in plain text format.

                • value — required — (String)

                  The message to send to the user.

              • customPayload — (map)

                A message in a custom format defined by the client application.

                • value — required — (String)

                  The string that is sent to your application.

              • ssmlMessage — (map)

                A message in Speech Synthesis Markup Language (SSML).

                • value — required — (String)

                  The SSML text that defines the prompt.

              • imageResponseCard — (map)

                A message that defines a response card that the client application can show to the user.

                • title — required — (String)

                  The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                • subtitle — (String)

                  The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                • imageUrl — (String)

                  The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                • buttons — (Array<map>)

                  A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                  • text — required — (String)

                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                  • value — required — (String)

                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

          • frequencyInSeconds — required — (Integer)

            How often a message should be sent to the user. Minimum of 1 second, maximum of 5 minutes.

          • timeoutInSeconds — required — (Integer)

            If Amazon Lex waits longer than this length of time for a response, it will stop sending messages.

          • allowInterrupt — (Boolean)

            Indicates that the user can interrupt the response by speaking while the message is being played.

        • active — (Boolean)

          Specifies whether the bot will wait for a user to respond. When this field is false, wait and continue responses for a slot aren't used. If the active field isn't specified, the default is true.

    • obfuscationSetting — (map)

      Determines how slot values are used in Amazon CloudWatch logs. If the value of the obfuscationSetting parameter is DefaultObfuscation, slot values are obfuscated in the log output. If the value is None, the actual value is present in the log output.

      The default is to obfuscate values in the CloudWatch logs.

      • obfuscationSettingType — required — (String)

        Value that determines whether Amazon Lex obscures slot values in conversation logs. The default is to obscure the values.

        Possible values include:
        • "None"
        • "DefaultObfuscation"
    • botId — (String)

      The identifier of the bot associated with the slot.

    • botVersion — (String)

      The version of the bot associated with the slot.

    • localeId — (String)

      The identifier of the language and locale that the slot will be used in. The string must match one of the supported locales. All of the bots, intents, slot types used by the slot must have the same locale. For more information, see Supported languages.

    • intentId — (String)

      The identifier of the intent that contains the slot.

    • multipleValuesSetting — (map)

      Indicates whether the slot returns multiple values in one response. Multi-value slots are only available in the en-US locale. If you set this value to true in any other locale, Amazon Lex throws a ValidationException.

      If the multipleValuesSetting is not set, the default value is false.

      • allowMultipleValues — (Boolean)

        Indicates whether a slot can return multiple values. When true, the slot may return more than one value in a response. When false, the slot returns only a single value.

        Multi-value slots are only available in the en-US locale. If you set this value to true in any other locale, Amazon Lex throws a ValidationException.

        If the allowMutlipleValues is not set, the default value is false.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • slotId — (String)

        The unique identifier associated with the slot. Use this to identify the slot when you update or delete it.

      • slotName — (String)

        The name specified for the slot.

      • description — (String)

        The description associated with the slot.

      • slotTypeId — (String)

        The unique identifier of the slot type associated with this slot.

      • valueElicitationSetting — (map)

        The value elicitation settings specified for the slot.

        • defaultValueSpecification — (map)

          A list of default values for a slot. Default values are used when Amazon Lex hasn't determined a value for a slot. You can specify default values from context variables, session attributes, and defined values.

          • defaultValueList — required — (Array<map>)

            A list of default values. Amazon Lex chooses the default value to use in the order that they are presented in the list.

            • defaultValue — required — (String)

              The default value to use when a user doesn't provide a value for a slot.

        • slotConstraint — required — (String)

          Specifies whether the slot is required or optional.

          Possible values include:
          • "Required"
          • "Optional"
        • promptSpecification — (map)

          The prompt that Amazon Lex uses to elicit the slot value from the user.

          • messageGroups — required — (Array<map>)

            A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.

            • message — required — (map)

              The primary message that Amazon Lex should send to the user.

              • plainTextMessage — (map)

                A message in plain text format.

                • value — required — (String)

                  The message to send to the user.

              • customPayload — (map)

                A message in a custom format defined by the client application.

                • value — required — (String)

                  The string that is sent to your application.

              • ssmlMessage — (map)

                A message in Speech Synthesis Markup Language (SSML).

                • value — required — (String)

                  The SSML text that defines the prompt.

              • imageResponseCard — (map)

                A message that defines a response card that the client application can show to the user.

                • title — required — (String)

                  The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                • subtitle — (String)

                  The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                • imageUrl — (String)

                  The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                • buttons — (Array<map>)

                  A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                  • text — required — (String)

                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                  • value — required — (String)

                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

            • variations — (Array<map>)

              Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

              • plainTextMessage — (map)

                A message in plain text format.

                • value — required — (String)

                  The message to send to the user.

              • customPayload — (map)

                A message in a custom format defined by the client application.

                • value — required — (String)

                  The string that is sent to your application.

              • ssmlMessage — (map)

                A message in Speech Synthesis Markup Language (SSML).

                • value — required — (String)

                  The SSML text that defines the prompt.

              • imageResponseCard — (map)

                A message that defines a response card that the client application can show to the user.

                • title — required — (String)

                  The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                • subtitle — (String)

                  The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                • imageUrl — (String)

                  The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                • buttons — (Array<map>)

                  A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                  • text — required — (String)

                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                  • value — required — (String)

                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

          • maxRetries — required — (Integer)

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

          • allowInterrupt — (Boolean)

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

        • sampleUtterances — (Array<map>)

          If you know a specific pattern that users might respond to an Amazon Lex request for a slot value, you can provide those utterances to improve accuracy. This is optional. In most cases, Amazon Lex is capable of understanding user utterances.

          • utterance — required — (String)

            The sample utterance that Amazon Lex uses to build its machine-learning model to recognize intents.

        • waitAndContinueSpecification — (map)

          Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input.

          • waitingResponse — required — (map)

            The response that Amazon Lex sends to indicate that the bot is waiting for the conversation to continue.

            • messageGroups — required — (Array<map>)

              A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

              • message — required — (map)

                The primary message that Amazon Lex should send to the user.

                • plainTextMessage — (map)

                  A message in plain text format.

                  • value — required — (String)

                    The message to send to the user.

                • customPayload — (map)

                  A message in a custom format defined by the client application.

                  • value — required — (String)

                    The string that is sent to your application.

                • ssmlMessage — (map)

                  A message in Speech Synthesis Markup Language (SSML).

                  • value — required — (String)

                    The SSML text that defines the prompt.

                • imageResponseCard — (map)

                  A message that defines a response card that the client application can show to the user.

                  • title — required — (String)

                    The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                  • subtitle — (String)

                    The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                  • imageUrl — (String)

                    The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                  • buttons — (Array<map>)

                    A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                    • text — required — (String)

                      The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                    • value — required — (String)

                      The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

              • variations — (Array<map>)

                Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                • plainTextMessage — (map)

                  A message in plain text format.

                  • value — required — (String)

                    The message to send to the user.

                • customPayload — (map)

                  A message in a custom format defined by the client application.

                  • value — required — (String)

                    The string that is sent to your application.

                • ssmlMessage — (map)

                  A message in Speech Synthesis Markup Language (SSML).

                  • value — required — (String)

                    The SSML text that defines the prompt.

                • imageResponseCard — (map)

                  A message that defines a response card that the client application can show to the user.

                  • title — required — (String)

                    The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                  • subtitle — (String)

                    The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                  • imageUrl — (String)

                    The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                  • buttons — (Array<map>)

                    A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                    • text — required — (String)

                      The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                    • value — required — (String)

                      The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

            • allowInterrupt — (Boolean)

              Indicates whether the user can interrupt a speech response from Amazon Lex.

          • continueResponse — required — (map)

            The response that Amazon Lex sends to indicate that the bot is ready to continue the conversation.

            • messageGroups — required — (Array<map>)

              A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

              • message — required — (map)

                The primary message that Amazon Lex should send to the user.

                • plainTextMessage — (map)

                  A message in plain text format.

                  • value — required — (String)

                    The message to send to the user.

                • customPayload — (map)

                  A message in a custom format defined by the client application.

                  • value — required — (String)

                    The string that is sent to your application.

                • ssmlMessage — (map)

                  A message in Speech Synthesis Markup Language (SSML).

                  • value — required — (String)

                    The SSML text that defines the prompt.

                • imageResponseCard — (map)

                  A message that defines a response card that the client application can show to the user.

                  • title — required — (String)

                    The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                  • subtitle — (String)

                    The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                  • imageUrl — (String)

                    The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                  • buttons — (Array<map>)

                    A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                    • text — required — (String)

                      The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                    • value — required — (String)

                      The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

              • variations — (Array<map>)

                Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                • plainTextMessage — (map)

                  A message in plain text format.

                  • value — required — (String)

                    The message to send to the user.

                • customPayload — (map)

                  A message in a custom format defined by the client application.

                  • value — required — (String)

                    The string that is sent to your application.

                • ssmlMessage — (map)

                  A message in Speech Synthesis Markup Language (SSML).

                  • value — required — (String)

                    The SSML text that defines the prompt.

                • imageResponseCard — (map)

                  A message that defines a response card that the client application can show to the user.

                  • title — required — (String)

                    The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                  • subtitle — (String)

                    The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                  • imageUrl — (String)

                    The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                  • buttons — (Array<map>)

                    A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                    • text — required — (String)

                      The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                    • value — required — (String)

                      The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

            • allowInterrupt — (Boolean)

              Indicates whether the user can interrupt a speech response from Amazon Lex.

          • stillWaitingResponse — (map)

            A response that Amazon Lex sends periodically to the user to indicate that the bot is still waiting for input from the user.

            • messageGroups — required — (Array<map>)

              One or more message groups, each containing one or more messages, that define the prompts that Amazon Lex sends to the user.

              • message — required — (map)

                The primary message that Amazon Lex should send to the user.

                • plainTextMessage — (map)

                  A message in plain text format.

                  • value — required — (String)

                    The message to send to the user.

                • customPayload — (map)

                  A message in a custom format defined by the client application.

                  • value — required — (String)

                    The string that is sent to your application.

                • ssmlMessage — (map)

                  A message in Speech Synthesis Markup Language (SSML).

                  • value — required — (String)

                    The SSML text that defines the prompt.

                • imageResponseCard — (map)

                  A message that defines a response card that the client application can show to the user.

                  • title — required — (String)

                    The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                  • subtitle — (String)

                    The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                  • imageUrl — (String)

                    The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                  • buttons — (Array<map>)

                    A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                    • text — required — (String)

                      The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                    • value — required — (String)

                      The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

              • variations — (Array<map>)

                Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                • plainTextMessage — (map)

                  A message in plain text format.

                  • value — required — (String)

                    The message to send to the user.

                • customPayload — (map)

                  A message in a custom format defined by the client application.

                  • value — required — (String)

                    The string that is sent to your application.

                • ssmlMessage — (map)

                  A message in Speech Synthesis Markup Language (SSML).

                  • value — required — (String)

                    The SSML text that defines the prompt.

                • imageResponseCard — (map)

                  A message that defines a response card that the client application can show to the user.

                  • title — required — (String)

                    The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                  • subtitle — (String)

                    The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                  • imageUrl — (String)

                    The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                  • buttons — (Array<map>)

                    A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                    • text — required — (String)

                      The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                    • value — required — (String)

                      The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

            • frequencyInSeconds — required — (Integer)

              How often a message should be sent to the user. Minimum of 1 second, maximum of 5 minutes.

            • timeoutInSeconds — required — (Integer)

              If Amazon Lex waits longer than this length of time for a response, it will stop sending messages.

            • allowInterrupt — (Boolean)

              Indicates that the user can interrupt the response by speaking while the message is being played.

          • active — (Boolean)

            Specifies whether the bot will wait for a user to respond. When this field is false, wait and continue responses for a slot aren't used. If the active field isn't specified, the default is true.

      • obfuscationSetting — (map)

        Indicates whether the slot is configured to obfuscate values in Amazon CloudWatch logs.

        • obfuscationSettingType — required — (String)

          Value that determines whether Amazon Lex obscures slot values in conversation logs. The default is to obscure the values.

          Possible values include:
          • "None"
          • "DefaultObfuscation"
      • botId — (String)

        The unique identifier of the bot associated with the slot.

      • botVersion — (String)

        The version of the bot associated with the slot.

      • localeId — (String)

        The language and local specified for the slot.

      • intentId — (String)

        The unique identifier of the intent associated with the slot.

      • creationDateTime — (Date)

        The timestamp of the date and time that the slot was created.

      • multipleValuesSetting — (map)

        Indicates whether the slot returns multiple values in one response.

        • allowMultipleValues — (Boolean)

          Indicates whether a slot can return multiple values. When true, the slot may return more than one value in a response. When false, the slot returns only a single value.

          Multi-value slots are only available in the en-US locale. If you set this value to true in any other locale, Amazon Lex throws a ValidationException.

          If the allowMutlipleValues is not set, the default value is false.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createSlotType(params = {}, callback) ⇒ AWS.Request

Creates a custom slot type

To create a custom slot type, specify a name for the slot type and a set of enumeration values, the values that a slot of this type can assume.

Service Reference:

Examples:

Calling the createSlotType operation

var params = {
  botId: 'STRING_VALUE', /* required */
  botVersion: 'STRING_VALUE', /* required */
  localeId: 'STRING_VALUE', /* required */
  slotTypeName: 'STRING_VALUE', /* required */
  valueSelectionSetting: { /* required */
    resolutionStrategy: OriginalValue | TopResolution, /* required */
    regexFilter: {
      pattern: 'STRING_VALUE' /* required */
    }
  },
  description: 'STRING_VALUE',
  parentSlotTypeSignature: 'STRING_VALUE',
  slotTypeValues: [
    {
      sampleValue: {
        value: 'STRING_VALUE' /* required */
      },
      synonyms: [
        {
          value: 'STRING_VALUE' /* required */
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
lexmodelsv2.createSlotType(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • slotTypeName — (String)

      The name for the slot. A slot type name must be unique within the account.

    • description — (String)

      A description of the slot type. Use the description to help identify the slot type in lists.

    • slotTypeValues — (Array<map>)

      A list of SlotTypeValue objects that defines the values that the slot type can take. Each value can have a list of synonyms, additional values that help train the machine learning model about the values that it resolves for a slot.

      • sampleValue — (map)

        The value of the slot type entry.

        • value — required — (String)

          The value that can be used for a slot type.

      • synonyms — (Array<map>)

        Additional values related to the slot type entry.

        • value — required — (String)

          The value that can be used for a slot type.

    • valueSelectionSetting — (map)

      Determines the strategy that Amazon Lex uses to select a value from the list of possible values. The field can be set to one of the following values:

      • OriginalValue - Returns the value entered by the user, if the user value is similar to the slot value.

      • TopResolution - If there is a resolution list for the slot, return the first value in the resolution list. If there is no resolution list, return null.

      If you don't specify the valueSelectionSetting parameter, the default is OriginalValue.

      • resolutionStrategy — required — (String)

        Determines the slot resolution strategy that Amazon Lex uses to return slot type values. The field can be set to one of the following values:

        • OriginalValue - Returns the value entered by the user, if the user value is similar to the slot value.

        • TopResolution - If there is a resolution list for the slot, return the first value in the resolution list as the slot type value. If there is no resolution list, null is returned.

        If you don't specify the valueSelectionStrategy, the default is OriginalValue.

        Possible values include:
        • "OriginalValue"
        • "TopResolution"
      • regexFilter — (map)

        A regular expression used to validate the value of a slot.

        • pattern — required — (String)

          A regular expression used to validate the value of a slot.

          Use a standard regular expression. Amazon Lex supports the following characters in the regular expression:

          • A-Z, a-z

          • 0-9

          • Unicode characters ("\ u<Unicode>")

          Represent Unicode characters with four digits, for example "\u0041" or "\u005A".

          The following regular expression operators are not supported:

          • Infinite repeaters: *, +, or {x,} with no upper bound.

          • Wild card (.)

    • parentSlotTypeSignature — (String)

      The built-in slot type used as a parent of this slot type. When you define a parent slot type, the new slot type has the configuration of the parent slot type.

      Only AMAZON.AlphaNumeric is supported.

    • botId — (String)

      The identifier of the bot associated with this slot type.

    • botVersion — (String)

      The identifier of the bot version associated with this slot type.

    • localeId — (String)

      The identifier of the language and locale that the slot type will be used in. The string must match one of the supported locales. All of the bots, intents, and slots used by the slot type must have the same locale. For more information, see Supported languages.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • slotTypeId — (String)

        The unique identifier assigned to the slot type. Use this to identify the slot type in the UpdateSlotType and DeleteSlotType operations.

      • slotTypeName — (String)

        The name specified for the slot type.

      • description — (String)

        The description specified for the slot type.

      • slotTypeValues — (Array<map>)

        The list of values that the slot type can assume.

        • sampleValue — (map)

          The value of the slot type entry.

          • value — required — (String)

            The value that can be used for a slot type.

        • synonyms — (Array<map>)

          Additional values related to the slot type entry.

          • value — required — (String)

            The value that can be used for a slot type.

      • valueSelectionSetting — (map)

        The strategy that Amazon Lex uses to select a value from the list of possible values.

        • resolutionStrategy — required — (String)

          Determines the slot resolution strategy that Amazon Lex uses to return slot type values. The field can be set to one of the following values:

          • OriginalValue - Returns the value entered by the user, if the user value is similar to the slot value.

          • TopResolution - If there is a resolution list for the slot, return the first value in the resolution list as the slot type value. If there is no resolution list, null is returned.

          If you don't specify the valueSelectionStrategy, the default is OriginalValue.

          Possible values include:
          • "OriginalValue"
          • "TopResolution"
        • regexFilter — (map)

          A regular expression used to validate the value of a slot.

          • pattern — required — (String)

            A regular expression used to validate the value of a slot.

            Use a standard regular expression. Amazon Lex supports the following characters in the regular expression:

            • A-Z, a-z

            • 0-9

            • Unicode characters ("\ u<Unicode>")

            Represent Unicode characters with four digits, for example "\u0041" or "\u005A".

            The following regular expression operators are not supported:

            • Infinite repeaters: *, +, or {x,} with no upper bound.

            • Wild card (.)

      • parentSlotTypeSignature — (String)

        The signature of the base slot type specified for the slot type.

      • botId — (String)

        The identifier for the bot associated with the slot type.

      • botVersion — (String)

        The version of the bot associated with the slot type.

      • localeId — (String)

        The specified language and local specified for the slot type.

      • creationDateTime — (Date)

        A timestamp of the date and time that the slot type was created.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createUploadUrl(params = {}, callback) ⇒ AWS.Request

Gets a pre-signed S3 write URL that you use to upload the zip archive when importing a bot or a bot locale.

Service Reference:

Examples:

Calling the createUploadUrl operation

var params = {
};
lexmodelsv2.createUploadUrl(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • importId — (String)

        An identifier for a unique import job. Use it when you call the operation.

      • uploadUrl — (String)

        A pre-signed S3 write URL. Upload the zip archive file that contains the definition of your bot or bot locale.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteBot(params = {}, callback) ⇒ AWS.Request

Deletes all versions of a bot, including the Draft version. To delete a specific version, use the DeleteBotVersion operation.

When you delete a bot, all of the resources contained in the bot are also deleted. Deleting a bot removes all locales, intents, slot, and slot types defined for the bot.

If a bot has an alias, the DeleteBot operation returns a ResourceInUseException exception. If you want to delete the bot and the alias, set the skipResourceInUseCheck parameter to true.

Service Reference:

Examples:

Calling the deleteBot operation

var params = {
  botId: 'STRING_VALUE', /* required */
  skipResourceInUseCheck: true || false
};
lexmodelsv2.deleteBot(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • botId — (String)

      The identifier of the bot to delete.

    • skipResourceInUseCheck — (Boolean)

      When true, Amazon Lex doesn't check to see if another resource, such as an alias, is using the bot before it is deleted.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • botId — (String)

        The unique identifier of the bot that Amazon Lex is deleting.

      • botStatus — (String)

        The current status of the bot. The status is Deleting while the bot and its associated resources are being deleted.

        Possible values include:
        • "Creating"
        • "Available"
        • "Inactive"
        • "Deleting"
        • "Failed"
        • "Versioning"
        • "Importing"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteBotAlias(params = {}, callback) ⇒ AWS.Request

Deletes the specified bot alias.

Service Reference:

Examples:

Calling the deleteBotAlias operation

var params = {
  botAliasId: 'STRING_VALUE', /* required */
  botId: 'STRING_VALUE', /* required */
  skipResourceInUseCheck: true || false
};
lexmodelsv2.deleteBotAlias(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • botAliasId — (String)

      The unique identifier of the bot alias to delete.

    • botId — (String)

      The unique identifier of the bot associated with the alias to delete.

    • skipResourceInUseCheck — (Boolean)

      When this parameter is true, Amazon Lex doesn't check to see if any other resource is using the alias before it is deleted.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • botAliasId — (String)

        The unique identifier of the bot alias to delete.

      • botId — (String)

        The unique identifier of the bot that contains the alias to delete.

      • botAliasStatus — (String)

        The current status of the alias. The status is Deleting while the alias is in the process of being deleted. Once the alias is deleted, it will no longer appear in the list of aliases returned by the ListBotAliases operation.

        Possible values include:
        • "Creating"
        • "Available"
        • "Deleting"
        • "Failed"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteBotLocale(params = {}, callback) ⇒ AWS.Request

Removes a locale from a bot.

When you delete a locale, all intents, slots, and slot types defined for the locale are also deleted.

Service Reference:

Examples:

Calling the deleteBotLocale operation

var params = {
  botId: 'STRING_VALUE', /* required */
  botVersion: 'STRING_VALUE', /* required */
  localeId: 'STRING_VALUE' /* required */
};
lexmodelsv2.deleteBotLocale(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • botId — (String)

      The unique identifier of the bot that contains the locale.

    • botVersion — (String)

      The version of the bot that contains the locale.

    • localeId — (String)

      The identifier of the language and locale that will be deleted. The string must match one of the supported locales. For more information, see Supported languages.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • botId — (String)

        The identifier of the bot that contained the deleted locale.

      • botVersion — (String)

        The version of the bot that contained the deleted locale.

      • localeId — (String)

        The language and locale of the deleted locale.

      • botLocaleStatus — (String)

        The status of deleting the bot locale. The locale first enters the Deleting status. Once the locale is deleted it no longer appears in the list of locales for the bot.

        Possible values include:
        • "Creating"
        • "Building"
        • "Built"
        • "ReadyExpressTesting"
        • "Failed"
        • "Deleting"
        • "NotBuilt"
        • "Importing"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteBotVersion(params = {}, callback) ⇒ AWS.Request

Deletes a specific version of a bot. To delete all version of a bot, use the DeleteBot operation.

Service Reference:

Examples:

Calling the deleteBotVersion operation

var params = {
  botId: 'STRING_VALUE', /* required */
  botVersion: 'STRING_VALUE', /* required */
  skipResourceInUseCheck: true || false
};
lexmodelsv2.deleteBotVersion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • botId — (String)

      The identifier of the bot that contains the version.

    • botVersion — (String)

      The version of the bot to delete.

    • skipResourceInUseCheck — (Boolean)

      By default, the DeleteBotVersion operations throws a ResourceInUseException exception if you try to delete a bot version that has an alias pointing at it. Set the skipResourceInUseCheck parameter to true to skip this check and remove the version even if an alias points to it.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • botId — (String)

        The identifier of the bot that is being deleted.

      • botVersion — (String)

        The version of the bot that is being deleted.

      • botStatus — (String)

        The current status of the bot.

        Possible values include:
        • "Creating"
        • "Available"
        • "Inactive"
        • "Deleting"
        • "Failed"
        • "Versioning"
        • "Importing"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteExport(params = {}, callback) ⇒ AWS.Request

Removes a previous export and the associated files stored in an S3 bucket.

Service Reference:

Examples:

Calling the deleteExport operation

var params = {
  exportId: 'STRING_VALUE' /* required */
};
lexmodelsv2.deleteExport(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • exportId — (String)

      The unique identifier of the export to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • exportId — (String)

        The unique identifier of the deleted export.

      • exportStatus — (String)

        The current status of the deletion. When the deletion is complete, the export will no longer be returned by the operation and calls to the with the export identifier will fail.

        Possible values include:
        • "InProgress"
        • "Completed"
        • "Failed"
        • "Deleting"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteImport(params = {}, callback) ⇒ AWS.Request

Removes a previous import and the associated file stored in an S3 bucket.

Service Reference:

Examples:

Calling the deleteImport operation

var params = {
  importId: 'STRING_VALUE' /* required */
};
lexmodelsv2.deleteImport(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • importId — (String)

      The unique identifier of the import to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • importId — (String)

        The unique identifier of the deleted import.

      • importStatus — (String)

        The current status of the deletion. When the deletion is complete, the import will no longer be returned by the operation and calls to the with the import identifier will fail.

        Possible values include:
        • "InProgress"
        • "Completed"
        • "Failed"
        • "Deleting"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteIntent(params = {}, callback) ⇒ AWS.Request

Removes the specified intent.

Deleting an intent also deletes the slots associated with the intent.

Service Reference:

Examples:

Calling the deleteIntent operation

var params = {
  botId: 'STRING_VALUE', /* required */
  botVersion: 'STRING_VALUE', /* required */
  intentId: 'STRING_VALUE', /* required */
  localeId: 'STRING_VALUE' /* required */
};
lexmodelsv2.deleteIntent(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • intentId — (String)

      The unique identifier of the intent to delete.

    • botId — (String)

      The identifier of the bot associated with the intent.

    • botVersion — (String)

      The version of the bot associated with the intent.

    • localeId — (String)

      The identifier of the language and locale where the bot will be deleted. The string must match one of the supported locales. For more information, see Supported languages.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteResourcePolicy(params = {}, callback) ⇒ AWS.Request

Removes an existing policy from a bot or bot alias. If the resource doesn't have a policy attached, Amazon Lex returns an exception.

Service Reference:

Examples:

Calling the deleteResourcePolicy operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  expectedRevisionId: 'STRING_VALUE'
};
lexmodelsv2.deleteResourcePolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • resourceArn — (String)

      The Amazon Resource Name (ARN) of the bot or bot alias that has the resource policy attached.

    • expectedRevisionId — (String)

      The identifier of the revision to edit. If this ID doesn't match the current revision number, Amazon Lex returns an exception

      If you don't specify a revision ID, Amazon Lex will delete the current policy.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • resourceArn — (String)

        The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy was deleted from.

      • revisionId — (String)

        The current revision of the resource policy. Use the revision ID to make sure that you are updating the most current version of a resource policy when you add a policy statement to a resource, delete a resource, or update a resource.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteResourcePolicyStatement(params = {}, callback) ⇒ AWS.Request

Deletes a policy statement from a resource policy. If you delete the last statement from a policy, the policy is deleted. If you specify a statement ID that doesn't exist in the policy, or if the bot or bot alias doesn't have a policy attached, Amazon Lex returns an exception.

Service Reference:

Examples:

Calling the deleteResourcePolicyStatement operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  statementId: 'STRING_VALUE', /* required */
  expectedRevisionId: 'STRING_VALUE'
};
lexmodelsv2.deleteResourcePolicyStatement(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • resourceArn — (String)

      The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.

    • statementId — (String)

      The name of the statement (SID) to delete from the policy.

    • expectedRevisionId — (String)

      The identifier of the revision of the policy to delete the statement from. If this revision ID doesn't match the current revision ID, Amazon Lex throws an exception.

      If you don't specify a revision, Amazon Lex removes the current contents of the statement.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • resourceArn — (String)

        The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy statement was removed from.

      • revisionId — (String)

        The current revision of the resource policy. Use the revision ID to make sure that you are updating the most current version of a resource policy when you add a policy statement to a resource, delete a resource, or update a resource.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteSlot(params = {}, callback) ⇒ AWS.Request

Deletes the specified slot from an intent.

Service Reference:

Examples:

Calling the deleteSlot operation

var params = {
  botId: 'STRING_VALUE', /* required */
  botVersion: 'STRING_VALUE', /* required */
  intentId: 'STRING_VALUE', /* required */
  localeId: 'STRING_VALUE', /* required */
  slotId: 'STRING_VALUE' /* required */
};
lexmodelsv2.deleteSlot(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • slotId — (String)

      The identifier of the slot to delete.

    • botId — (String)

      The identifier of the bot associated with the slot to delete.

    • botVersion — (String)

      The version of the bot associated with the slot to delete.

    • localeId — (String)

      The identifier of the language and locale that the slot will be deleted from. The string must match one of the supported locales. For more information, see Supported languages.

    • intentId — (String)

      The identifier of the intent associated with the slot.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteSlotType(params = {}, callback) ⇒ AWS.Request

Deletes a slot type from a bot locale.

If a slot is using the slot type, Amazon Lex throws a ResourceInUseException exception. To avoid the exception, set the skipResourceInUseCheck parameter to true.

Service Reference:

Examples:

Calling the deleteSlotType operation

var params = {
  botId: 'STRING_VALUE', /* required */
  botVersion: 'STRING_VALUE', /* required */
  localeId: 'STRING_VALUE', /* required */
  slotTypeId: 'STRING_VALUE', /* required */
  skipResourceInUseCheck: true || false
};
lexmodelsv2.deleteSlotType(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • slotTypeId — (String)

      The identifier of the slot type to delete.

    • botId — (String)

      The identifier of the bot associated with the slot type.

    • botVersion — (String)

      The version of the bot associated with the slot type.

    • localeId — (String)

      The identifier of the language and locale that the slot type will be deleted from. The string must match one of the supported locales. For more information, see Supported languages.

    • skipResourceInUseCheck — (Boolean)

      By default, the DeleteSlotType operations throws a ResourceInUseException exception if you try to delete a slot type used by a slot. Set the skipResourceInUseCheck parameter to true to skip this check and remove the slot type even if a slot uses it.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteUtterances(params = {}, callback) ⇒ AWS.Request

Deletes stored utterances.

Amazon Lex stores the utterances that users send to your bot. Utterances are stored for 15 days for use with the operation, and then stored indefinitely for use in improving the ability of your bot to respond to user input..

Use the DeleteUtterances operation to manually delete utterances for a specific session. When you use the DeleteUtterances operation, utterances stored for improving your bot's ability to respond to user input are deleted immediately. Utterances stored for use with the ListAggregatedUtterances operation are deleted after 15 days.

Service Reference:

Examples:

Calling the deleteUtterances operation

var params = {
  botId: 'STRING_VALUE', /* required */
  localeId: 'STRING_VALUE',
  sessionId: 'STRING_VALUE'
};
lexmodelsv2.deleteUtterances(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • botId — (String)

      The unique identifier of the bot that contains the utterances.

    • localeId — (String)

      The identifier of the language and locale where the utterances were collected. The string must match one of the supported locales. For more information, see Supported languages.

    • sessionId — (String)

      The unique identifier of the session with the user. The ID is returned in the response from the and operations.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeBot(params = {}, callback) ⇒ AWS.Request

Provides metadata information about a bot.

Service Reference:

Examples:

Calling the describeBot operation

var params = {
  botId: 'STRING_VALUE' /* required */
};
lexmodelsv2.describeBot(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • botId — (String)

      The unique identifier of the bot to describe.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • botId — (String)

        The unique identifier of the bot.

      • botName — (String)

        The name of the bot.

      • description — (String)

        The description of the bot.

      • roleArn — (String)

        The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot.

      • dataPrivacy — (map)

        Settings for managing data privacy of the bot and its conversations with users.

        • childDirected — required — (Boolean)

          For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying true or false in the childDirected field. By specifying true in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ.

      • idleSessionTTLInSeconds — (Integer)

        The maximum time in seconds that Amazon Lex retains the data gathered in a conversation.

      • botStatus — (String)

        The current status of the bot. When the status is Available the bot is ready to be used in conversations with users.

        Possible values include:
        • "Creating"
        • "Available"
        • "Inactive"
        • "Deleting"
        • "Failed"
        • "Versioning"
        • "Importing"
      • creationDateTime — (Date)

        A timestamp of the date and time that the bot was created.

      • lastUpdatedDateTime — (Date)

        A timestamp of the date and time that the bot was last updated.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

describeBotAlias(params = {}, callback) ⇒ AWS.Request

Get information about a specific bot alias.

Service Reference:

Examples:

Calling the describeBotAlias operation

var params = {
  botAliasId: 'STRING_VALUE', /* required */
  botId: 'STRING_VALUE' /* required */
};
lexmodelsv2.describeBotAlias(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • botAliasId — (String)

      The identifier of the bot alias to describe.

    • botId — (String)

      The identifier of the bot associated with the bot alias to describe.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • botAliasId — (String)

        The identifier of the bot alias.

      • botAliasName — (String)

        The name of the bot alias.

      • description — (String)

        The description of the bot alias.

      • botVersion — (String)

        The version of the bot associated with the bot alias.

      • botAliasLocaleSettings — (map<map>)

        The locale settings that are unique to the alias.

        • enabled — required — (Boolean)

          Determines whether the locale is enabled for the bot. If the value is false, the locale isn't available for use.

        • codeHookSpecification — (map)

          Specifies the Lambda function that should be used in the locale.

          • lambdaCodeHook — required — (map)

            Specifies a Lambda function that verifies requests to a bot or fulfills the user's request to a bot.

            • lambdaARN — required — (String)

              The Amazon Resource Name (ARN) of the Lambda function.

            • codeHookInterfaceVersion — required — (String)

              The version of the request-response that you want Amazon Lex to use to invoke your Lambda function.

      • conversationLogSettings — (map)

        Specifics of how Amazon Lex logs text and audio conversations with the bot associated with the alias.

        • textLogSettings — (Array<map>)

          The Amazon CloudWatch Logs settings for logging text and metadata.

          • enabled — required — (Boolean)

            Determines whether conversation logs should be stored for an alias.

          • destination — required — (map)

            Defines the Amazon CloudWatch Logs destination log group for conversation text logs.

            • cloudWatch — required — (map)

              Defines the Amazon CloudWatch Logs log group where text and metadata logs are delivered.

              • cloudWatchLogGroupArn — required — (String)

                The Amazon Resource Name (ARN) of the log group where text and metadata logs are delivered.

              • logPrefix — required — (String)

                The prefix of the log stream name within the log group that you specified

        • audioLogSettings — (Array<map>)

          The Amazon S3 settings for logging audio to an S3 bucket.

          • enabled — required — (Boolean)

            Determines whether audio logging in enabled for the bot.

          • destination — required — (map)

            The location of audio log files collected when conversation logging is enabled for a bot.

            • s3Bucket — required — (map)

              The Amazon S3 bucket where the audio log files are stored. The IAM role specified in the roleArn parameter of the CreateBot operation must have permission to write to this bucket.

              • kmsKeyArn — (String)

                The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key for encrypting audio log files stored in an S3 bucket.

              • s3BucketArn — required — (String)

                The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio log files are stored.

              • logPrefix — required — (String)

                The S3 prefix to assign to audio log files.

      • sentimentAnalysisSettings — (map)

        Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.

        • detectSentiment — required — (Boolean)

          Sets whether Amazon Lex uses Amazon Comprehend to detect the sentiment of user utterances.

      • botAliasHistoryEvents — (Array<map>)

        A list of events that affect a bot alias. For example, an event is recorded when the version that the alias points to changes.

        • botVersion — (String)

          The version of the bot that was used in the event.

        • startDate — (Date)

          The date and time that the event started.

        • endDate — (Date)

          The date and time that the event ended.

      • botAliasStatus — (String)

        The current status of the alias. When the alias is Available, the alias is ready for use with your bot.

        Possible values include:
        • "Creating"
        • "Available"
        • "Deleting"
        • "Failed"
      • botId — (String)

        The identifier of the bot associated with the bot alias.

      • creationDateTime — (Date)

        A timestamp of the date and time that the alias was created.

      • lastUpdatedDateTime — (Date)

        A timestamp of the date and time that the alias was last updated.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

describeBotLocale(params = {}, callback) ⇒ AWS.Request

Describes the settings that a bot has for a specific locale.

Service Reference:

Examples:

Calling the describeBotLocale operation

var params = {
  botId: 'STRING_VALUE', /* required */
  botVersion: 'STRING_VALUE', /* required */
  localeId: 'STRING_VALUE' /* required */
};
lexmodelsv2.describeBotLocale(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • botId — (String)

      The identifier of the bot associated with the locale.

    • botVersion — (String)

      The identifier of the version of the bot associated with the locale.

    • localeId — (String)

      The unique identifier of the locale to describe. The string must match one of the supported locales. For more information, see Supported languages.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • botId — (String)

        The identifier of the bot associated with the locale.

      • botVersion — (String)

        The identifier of the version of the bot associated with the locale.

      • localeId — (String)

        The unique identifier of the described locale.

      • localeName — (String)

        The name of the locale.

      • description — (String)

        The description of the locale.

      • nluIntentConfidenceThreshold — (Float)

        The confidence threshold where Amazon Lex inserts the AMAZON.FallbackIntent and AMAZON.KendraSearchIntent intents in the list of possible intents for an utterance.

      • voiceSettings — (map)

        The Amazon Polly voice Amazon Lex uses for voice interaction with the user.

        • voiceId — required — (String)

          The identifier of the Amazon Polly voice to use.

      • intentsCount — (Integer)

        The number of intents defined for the locale.

      • slotTypesCount — (Integer)

        The number of slot types defined for the locale.

      • botLocaleStatus — (String)

        The status of the bot. If the status is Failed, the reasons for the failure are listed in the failureReasons field.

        Possible values include:
        • "Creating"
        • "Building"
        • "Built"
        • "ReadyExpressTesting"
        • "Failed"
        • "Deleting"
        • "NotBuilt"
        • "Importing"
      • failureReasons — (Array<String>)

        if botLocaleStatus is Failed, Amazon Lex explains why it failed to build the bot.

      • creationDateTime — (Date)

        The date and time that the locale was created.

      • lastUpdatedDateTime — (Date)

        The date and time that the locale was last updated.

      • lastBuildSubmittedDateTime — (Date)

        The date and time that the locale was last submitted for building.

      • botLocaleHistoryEvents — (Array<map>)

        History of changes, such as when a locale is used in an alias, that have taken place for the locale.

        • event — required — (String)

          A description of the event that occurred.

        • eventDate — required — (Date)

          A timestamp of the date and time that the event occurred.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

describeBotVersion(params = {}, callback) ⇒ AWS.Request

Provides metadata about a version of a bot.

Service Reference:

Examples:

Calling the describeBotVersion operation

var params = {
  botId: 'STRING_VALUE', /* required */
  botVersion: 'STRING_VALUE' /* required */
};
lexmodelsv2.describeBotVersion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • botId — (String)

      The identifier of the bot containing the version to return metadata for.

    • botVersion — (String)

      The version of the bot to return metadata for.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • botId — (String)

        The identifier of the bot that contains the version.

      • botName — (String)

        The name of the bot that contains the version.

      • botVersion — (String)

        The version of the bot to describe.

      • description — (String)

        The description specified for the bot.

      • roleArn — (String)

        The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot version.

      • dataPrivacy — (map)

        Data privacy settings for the bot version.

        • childDirected — required — (Boolean)

          For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying true or false in the childDirected field. By specifying true in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ.

      • idleSessionTTLInSeconds — (Integer)

        The number of seconds that a session with the bot remains active before it is discarded by Amazon Lex.

      • botStatus — (String)

        The current status of the bot. When the status is Available, the bot version is ready for use.

        Possible values include:
        • "Creating"
        • "Available"
        • "Inactive"
        • "Deleting"
        • "Failed"
        • "Versioning"
        • "Importing"
      • failureReasons — (Array<String>)

        If the botStatus is Failed, this contains a list of reasons that the version couldn't be built.

      • creationDateTime — (Date)

        A timestamp of the date and time that the bot version was created.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

describeExport(params = {}, callback) ⇒ AWS.Request

Gets information about a specific export.

Service Reference:

Examples:

Calling the describeExport operation

var params = {
  exportId: 'STRING_VALUE' /* required */
};
lexmodelsv2.describeExport(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • exportId — (String)

      The unique identifier of the export to describe.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • exportId — (String)

        The unique identifier of the described export.

      • resourceSpecification — (map)

        The bot, bot ID, and optional locale ID of the exported bot or bot locale.

        • botExportSpecification — (map)

          Parameters for exporting a bot.

          • botId — required — (String)

            The identifier of the bot assigned by Amazon Lex.

          • botVersion — required — (String)

            The version of the bot that was exported. This will be either DRAFT or the version number.

        • botLocaleExportSpecification — (map)

          Parameters for exporting a bot locale.

          • botId — required — (String)

            The identifier of the bot to create the locale for.

          • botVersion — required — (String)

            The version of the bot to export.

          • localeId — required — (String)

            The identifier of the language and locale to export. The string must match one of the locales in the bot.

      • fileFormat — (String)

        The file format used in the files that describe the bot or bot locale.

        Possible values include:
        • "LexJson"
      • exportStatus — (String)

        The status of the export. When the status is Complete the export archive file is available for download.

        Possible values include:
        • "InProgress"
        • "Completed"
        • "Failed"
        • "Deleting"
      • failureReasons — (Array<String>)

        If the exportStatus is failed, contains one or more reasons why the export could not be completed.

      • downloadUrl — (String)

        A pre-signed S3 URL that points to the bot or bot locale archive. The URL is only available for 5 minutes after calling the DescribeExport operation.

      • creationDateTime — (Date)

        The date and time that the export was created.

      • lastUpdatedDateTime — (Date)

        The last date and time that the export was updated.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

describeImport(params = {}, callback) ⇒ AWS.Request

Gets information about a specific import.

Service Reference:

Examples:

Calling the describeImport operation

var params = {
  importId: 'STRING_VALUE' /* required */
};
lexmodelsv2.describeImport(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • importId — (String)

      The unique identifier of the import to describe.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • importId — (String)

        The unique identifier of the described import.

      • resourceSpecification — (map)

        The specifications of the imported bot or bot locale.

        • botImportSpecification — (map)

          Parameters for importing a bot.

          • botName — required — (String)

            The name that Amazon Lex should use for the bot.

          • roleArn — required — (String)

            The Amazon Resource Name (ARN) of the IAM role used to build and run the bot.

          • dataPrivacy — required — (map)

            By default, data stored by Amazon Lex is encrypted. The DataPrivacy structure provides settings that determine how Amazon Lex handles special cases of securing the data for your bot.

            • childDirected — required — (Boolean)

              For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying true or false in the childDirected field. By specifying true in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ.

          • idleSessionTTLInSeconds — (Integer)

            The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.

            A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Lex deletes any data provided before the timeout.

            You can specify between 60 (1 minute) and 86,400 (24 hours) seconds.

          • botTags — (map<String>)

            A list of tags to add to the bot. You can only add tags when you import a bot. You can't use the UpdateBot operation to update tags. To update tags, use the TagResource operation.

          • testBotAliasTags — (map<String>)

            A list of tags to add to the test alias for a bot. You can only add tags when you import a bot. You can't use the UpdateAlias operation to update tags. To update tags on the test alias, use the TagResource operation.

        • botLocaleImportSpecification — (map)

          Parameters for importing a bot locale.

          • botId — required — (String)

            The identifier of the bot to import the locale to.

          • botVersion — required — (String)

            The version of the bot to import the locale to. This can only be the DRAFT version of the bot.

          • localeId — required — (String)

            The identifier of the language and locale that the bot will be used in. The string must match one of the supported locales. All of the intents, slot types, and slots used in the bot must have the same locale. For more information, see Supported languages.

          • nluIntentConfidenceThreshold — (Float)

            Determines the threshold where Amazon Lex will insert the AMAZON.FallbackIntent, AMAZON.KendraSearchIntent, or both when returning alternative intents. AMAZON.FallbackIntent and AMAZON.KendraSearchIntent are only inserted if they are configured for the bot.

            For example, suppose a bot is configured with the confidence threshold of 0.80 and the AMAZON.FallbackIntent. Amazon Lex returns three alternative intents with the following confidence scores: IntentA (0.70), IntentB (0.60), IntentC (0.50). The response from the PostText operation would be:

            • AMAZON.FallbackIntent

            • IntentA

            • IntentB

            • IntentC

          • voiceSettings — (map)

            Defines settings for using an Amazon Polly voice to communicate with a user.

            • voiceId — required — (String)

              The identifier of the Amazon Polly voice to use.

      • importedResourceId — (String)

        The unique identifier that Amazon Lex assigned to the resource created by the import.

      • importedResourceName — (String)

        The name of the imported resource.

      • mergeStrategy — (String)

        The strategy used when there was a name conflict between the imported resource and an existing resource. When the merge strategy is FailOnConflict existing resources are not overwritten and the import fails.

        Possible values include:
        • "Overwrite"
        • "FailOnConflict"
      • importStatus — (String)

        The status of the import process. When the status is Completed the resource is imported and ready for use.

        Possible values include:
        • "InProgress"
        • "Completed"
        • "Failed"
        • "Deleting"
      • failureReasons — (Array<String>)

        If the importStatus field is Failed, this provides one or more reasons for the failure.

      • creationDateTime — (Date)

        The date and time that the import was created.

      • lastUpdatedDateTime — (Date)

        The date and time that the import was last updated.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

describeIntent(params = {}, callback) ⇒ AWS.Request

Returns metadata about an intent.

Service Reference:

Examples:

Calling the describeIntent operation

var params = {
  botId: 'STRING_VALUE', /* required */
  botVersion: 'STRING_VALUE', /* required */
  intentId: 'STRING_VALUE', /* required */
  localeId: 'STRING_VALUE' /* required */
};
lexmodelsv2.describeIntent(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • intentId — (String)

      The identifier of the intent to describe.

    • botId — (String)

      The identifier of the bot associated with the intent.

    • botVersion — (String)

      The version of the bot associated with the intent.

    • localeId — (String)

      The identifier of the language and locale of the intent to describe. The string must match one of the supported locales. For more information, see Supported languages.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • intentId — (String)

        The unique identifier assigned to the intent when it was created.

      • intentName — (String)

        The name specified for the intent.

      • description — (String)

        The description of the intent.

      • parentIntentSignature — (String)

        The identifier of the built-in intent that this intent is derived from, if any.

      • sampleUtterances — (Array<map>)

        User utterances that trigger this intent.

        • utterance — required — (String)

          The sample utterance that Amazon Lex uses to build its machine-learning model to recognize intents.

      • dialogCodeHook — (map)

        The Lambda function called during each turn of a conversation with the intent.

        • enabled — required — (Boolean)

          Enables the dialog code hook so that it processes user requests.

      • fulfillmentCodeHook — (map)

        The Lambda function called when the intent is complete and ready for fulfillment.

        • enabled — required — (Boolean)

          Indicates whether a Lambda function should be invoked to fulfill a specific intent.

        • postFulfillmentStatusSpecification — (map)

          Provides settings for messages sent to the user for after the Lambda fulfillment function completes. Post-fulfillment messages can be sent for both streaming and non-streaming conversations.

          • successResponse — (map)

            Specifies a list of message groups that Amazon Lex uses to respond the user input.

            • messageGroups — required — (Array<map>)

              A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

              • message — required — (map)

                The primary message that Amazon Lex should send to the user.

                • plainTextMessage — (map)

                  A message in plain text format.

                  • value — required — (String)

                    The message to send to the user.

                • customPayload — (map)

                  A message in a custom format defined by the client application.

                  • value — required — (String)

                    The string that is sent to your application.

                • ssmlMessage — (map)

                  A message in Speech Synthesis Markup Language (SSML).

                  • value — required — (String)

                    The SSML text that defines the prompt.

                • imageResponseCard — (map)

                  A message that defines a response card that the client application can show to the user.

                  • title — required — (String)

                    The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                  • subtitle — (String)

                    The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                  • imageUrl — (String)

                    The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                  • buttons — (Array<map>)

                    A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                    • text — required — (String)

                      The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                    • value — required — (String)

                      The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

              • variations — (Array<map>)

                Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                • plainTextMessage — (map)

                  A message in plain text format.

                  • value — required — (String)

                    The message to send to the user.

                • customPayload — (map)

                  A message in a custom format defined by the client application.

                  • value — required — (String)

                    The string that is sent to your application.

                • ssmlMessage — (map)

                  A message in Speech Synthesis Markup Language (SSML).

                  • value — required — (String)

                    The SSML text that defines the prompt.

                • imageResponseCard — (map)

                  A message that defines a response card that the client application can show to the user.

                  • title — required — (String)

                    The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                  • subtitle — (String)

                    The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                  • imageUrl — (String)

                    The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                  • buttons — (Array<map>)

                    A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                    • text — required — (String)

                      The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                    • value — required — (String)

                      The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

            • allowInterrupt — (Boolean)

              Indicates whether the user can interrupt a speech response from Amazon Lex.

          • failureResponse — (map)

            Specifies a list of message groups that Amazon Lex uses to respond the user input.

            • messageGroups — required — (Array<map>)

              A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

              • message — required — (map)

                The primary message that Amazon Lex should send to the user.

                • plainTextMessage — (map)

                  A message in plain text format.

                  • value — required — (String)

                    The message to send to the user.

                • customPayload — (map)

                  A message in a custom format defined by the client application.

                  • value — required — (String)

                    The string that is sent to your application.

                • ssmlMessage — (map)

                  A message in Speech Synthesis Markup Language (SSML).

                  • value — required — (String)

                    The SSML text that defines the prompt.

                • imageResponseCard — (map)

                  A message that defines a response card that the client application can show to the user.

                  • title — required — (String)

                    The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                  • subtitle — (String)

                    The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                  • imageUrl — (String)

                    The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                  • buttons — (Array<map>)

                    A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                    • text — required — (String)

                      The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                    • value — required — (String)

                      The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

              • variations — (Array<map>)

                Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                • plainTextMessage — (map)

                  A message in plain text format.

                  • value — required — (String)

                    The message to send to the user.

                • customPayload — (map)

                  A message in a custom format defined by the client application.

                  • value — required — (String)

                    The string that is sent to your application.

                • ssmlMessage — (map)

                  A message in Speech Synthesis Markup Language (SSML).

                  • value — required — (String)

                    The SSML text that defines the prompt.

                • imageResponseCard — (map)

                  A message that defines a response card that the client application can show to the user.

                  • title — required — (String)

                    The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                  • subtitle — (String)

                    The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                  • imageUrl — (String)

                    The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                  • buttons — (Array<map>)

                    A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                    • text — required — (String)

                      The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                    • value — required — (String)

                      The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

            • allowInterrupt — (Boolean)

              Indicates whether the user can interrupt a speech response from Amazon Lex.

          • timeoutResponse — (map)

            Specifies a list of message groups that Amazon Lex uses to respond the user input.

            • messageGroups — required — (Array<map>)

              A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

              • message — required — (map)

                The primary message that Amazon Lex should send to the user.

                • plainTextMessage — (map)

                  A message in plain text format.

                  • value — required — (String)

                    The message to send to the user.

                • customPayload — (map)

                  A message in a custom format defined by the client application.

                  • value — required — (String)

                    The string that is sent to your application.

                • ssmlMessage — (map)

                  A message in Speech Synthesis Markup Language (SSML).

                  • value — required — (String)

                    The SSML text that defines the prompt.

                • imageResponseCard — (map)

                  A message that defines a response card that the client application can show to the user.

                  • title — required — (String)

                    The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                  • subtitle — (String)

                    The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                  • imageUrl — (String)

                    The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                  • buttons — (Array<map>)

                    A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                    • text — required — (String)

                      The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                    • value — required — (String)

                      The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

              • variations — (Array<map>)

                Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                • plainTextMessage — (map)

                  A message in plain text format.

                  • value — required — (String)

                    The message to send to the user.

                • customPayload — (map)

                  A message in a custom format defined by the client application.

                  • value — required — (String)

                    The string that is sent to your application.

                • ssmlMessage — (map)

                  A message in Speech Synthesis Markup Language (SSML).

                  • value — required — (String)

                    The SSML text that defines the prompt.

                • imageResponseCard — (map)

                  A message that defines a response card that the client application can show to the user.

                  • title — required — (String)

                    The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                  • subtitle — (String)

                    The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                  • imageUrl — (String)

                    The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                  • buttons — (Array<map>)

                    A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                    • text — required — (String)

                      The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                    • value — required — (String)

                      The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

            • allowInterrupt — (Boolean)

              Indicates whether the user can interrupt a speech response from Amazon Lex.

        • fulfillmentUpdatesSpecification — (map)

          Provides settings for update messages sent to the user for long-running Lambda fulfillment functions. Fulfillment updates can be used only with streaming conversations.

          • active — required — (Boolean)

            Determines whether fulfillment updates are sent to the user. When this field is true, updates are sent.

            If the active field is set to true, the startResponse, updateResponse, and timeoutInSeconds fields are required.

          • startResponse — (map)

            Provides configuration information for the message sent to users when the fulfillment Lambda functions starts running.

            • delayInSeconds — required — (Integer)

              The delay between when the Lambda fulfillment function starts running and the start message is played. If the Lambda function returns before the delay is over, the start message isn't played.

            • messageGroups — required — (Array<map>)

              One to 5 message groups that contain start messages. Amazon Lex chooses one of the messages to play to the user.

              • message — required — (map)

                The primary message that Amazon Lex should send to the user.

                • plainTextMessage — (map)

                  A message in plain text format.

                  • value — required — (String)

                    The message to send to the user.

                • customPayload — (map)

                  A message in a custom format defined by the client application.

                  • value — required — (String)

                    The string that is sent to your application.

                • ssmlMessage — (map)

                  A message in Speech Synthesis Markup Language (SSML).

                  • value — required — (String)

                    The SSML text that defines the prompt.

                • imageResponseCard — (map)

                  A message that defines a response card that the client application can show to the user.

                  • title — required — (String)

                    The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                  • subtitle — (String)

                    The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                  • imageUrl — (String)

                    The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                  • buttons — (Array<map>)

                    A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                    • text — required — (String)

                      The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                    • value — required — (String)

                      The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

              • variations — (Array<map>)

                Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                • plainTextMessage — (map)

                  A message in plain text format.

                  • value — required — (String)

                    The message to send to the user.

                • customPayload — (map)

                  A message in a custom format defined by the client application.

                  • value — required — (String)

                    The string that is sent to your application.

                • ssmlMessage — (map)

                  A message in Speech Synthesis Markup Language (SSML).

                  • value — required — (String)

                    The SSML text that defines the prompt.

                • imageResponseCard — (map)

                  A message that defines a response card that the client application can show to the user.

                  • title — required — (String)

                    The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                  • subtitle — (String)

                    The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                  • imageUrl — (String)

                    The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                  • buttons — (Array<map>)

                    A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                    • text — required — (String)

                      The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                    • value — required — (String)

                      The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

            • allowInterrupt — (Boolean)

              Determines whether the user can interrupt the start message while it is playing.

          • updateResponse — (map)

            Provides configuration information for messages sent periodically to the user while the fulfillment Lambda function is running.

            • frequencyInSeconds — required — (Integer)

              The frequency that a message is sent to the user. When the period ends, Amazon Lex chooses a message from the message groups and plays it to the user. If the fulfillment Lambda returns before the first period ends, an update message is not played to the user.

            • messageGroups — required — (Array<map>)

              One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.

              • message — required — (map)

                The primary message that Amazon Lex should send to the user.

                • plainTextMessage — (map)

                  A message in plain text format.

                  • value — required — (String)

                    The message to send to the user.

                • customPayload — (map)

                  A message in a custom format defined by the client application.

                  • value — required — (String)

                    The string that is sent to your application.

                • ssmlMessage — (map)

                  A message in Speech Synthesis Markup Language (SSML).

                  • value — required — (String)

                    The SSML text that defines the prompt.

                • imageResponseCard — (map)

                  A message that defines a response card that the client application can show to the user.

                  • title — required — (String)

                    The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                  • subtitle — (String)

                    The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                  • imageUrl — (String)

                    The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                  • buttons — (Array<map>)

                    A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                    • text — required — (String)

                      The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                    • value — required — (String)

                      The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

              • variations — (Array<map>)

                Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                • plainTextMessage — (map)

                  A message in plain text format.

                  • value — required — (String)

                    The message to send to the user.

                • customPayload — (map)

                  A message in a custom format defined by the client application.

                  • value — required — (String)

                    The string that is sent to your application.

                • ssmlMessage — (map)

                  A message in Speech Synthesis Markup Language (SSML).

                  • value — required — (String)

                    The SSML text that defines the prompt.

                • imageResponseCard — (map)

                  A message that defines a response card that the client application can show to the user.

                  • title — required — (String)

                    The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                  • subtitle — (String)

                    The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                  • imageUrl — (String)

                    The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                  • buttons — (Array<map>)

                    A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                    • text — required — (String)

                      The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                    • value — required — (String)

                      The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

            • allowInterrupt — (Boolean)

              Determines whether the user can interrupt an update message while it is playing.

          • timeoutInSeconds — (Integer)

            The length of time that the fulfillment Lambda function should run before it times out.

      • slotPriorities — (Array<map>)

        The list that determines the priority that slots should be elicited from the user.

        • priority — required — (Integer)

          The priority that a slot should be elicited.

        • slotId — required — (String)

          The unique identifier of the slot.

      • intentConfirmationSetting — (map)

        Prompts that Amazon Lex sends to the user to confirm completion of an intent.

        • promptSpecification — required — (map)

          Prompts the user to confirm the intent. This question should have a yes or no answer.

          Amazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for fulfillment. For example, with the OrderPizza intent, you might want to confirm that the order is correct before placing it. For other intents, such as intents that simply respond to user questions, you might not need to ask the user for confirmation before providing the information.

          • messageGroups — required — (Array<map>)

            A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.

            • message — required — (map)

              The primary message that Amazon Lex should send to the user.

              • plainTextMessage — (map)

                A message in plain text format.

                • value — required — (String)

                  The message to send to the user.

              • customPayload — (map)

                A message in a custom format defined by the client application.

                • value — required — (String)

                  The string that is sent to your application.

              • ssmlMessage — (map)

                A message in Speech Synthesis Markup Language (SSML).

                • value — required — (String)

                  The SSML text that defines the prompt.

              • imageResponseCard — (map)

                A message that defines a response card that the client application can show to the user.

                • title — required — (String)

                  The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                • subtitle — (String)

                  The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                • imageUrl — (String)

                  The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                • buttons — (Array<map>)

                  A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                  • text — required — (String)

                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                  • value — required — (String)

                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

            • variations — (Array<map>)

              Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

              • plainTextMessage — (map)

                A message in plain text format.

                • value — required — (String)

                  The message to send to the user.

              • customPayload — (map)

                A message in a custom format defined by the client application.

                • value — required — (String)

                  The string that is sent to your application.

              • ssmlMessage — (map)

                A message in Speech Synthesis Markup Language (SSML).

                • value — required — (String)

                  The SSML text that defines the prompt.

              • imageResponseCard — (map)

                A message that defines a response card that the client application can show to the user.

                • title — required — (String)

                  The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                • subtitle — (String)

                  The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                • imageUrl — (String)

                  The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                • buttons — (Array<map>)

                  A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                  • text — required — (String)

                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                  • value — required — (String)

                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

          • maxRetries — required — (Integer)

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

          • allowInterrupt — (Boolean)

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

        • declinationResponse — required — (map)

          When the user answers "no" to the question defined in promptSpecification, Amazon Lex responds with this response to acknowledge that the intent was canceled.

          • messageGroups — required — (Array<map>)

            A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

            • message — required — (map)

              The primary message that Amazon Lex should send to the user.

              • plainTextMessage — (map)

                A message in plain text format.

                • value — required — (String)

                  The message to send to the user.

              • customPayload — (map)

                A message in a custom format defined by the client application.

                • value — required — (String)

                  The string that is sent to your application.

              • ssmlMessage — (map)

                A message in Speech Synthesis Markup Language (SSML).

                • value — required — (String)

                  The SSML text that defines the prompt.

              • imageResponseCard — (map)

                A message that defines a response card that the client application can show to the user.

                • title — required — (String)

                  The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                • subtitle — (String)

                  The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                • imageUrl — (String)

                  The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                • buttons — (Array<map>)

                  A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                  • text — required — (String)

                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                  • value — required — (String)

                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

            • variations — (Array<map>)

              Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

              • plainTextMessage — (map)

                A message in plain text format.

                • value — required — (String)

                  The message to send to the user.

              • customPayload — (map)

                A message in a custom format defined by the client application.

                • value — required — (String)

                  The string that is sent to your application.

              • ssmlMessage — (map)

                A message in Speech Synthesis Markup Language (SSML).

                • value — required — (String)

                  The SSML text that defines the prompt.

              • imageResponseCard — (map)

                A message that defines a response card that the client application can show to the user.

                • title — required — (String)

                  The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                • subtitle — (String)

                  The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                • imageUrl — (String)

                  The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                • buttons — (Array<map>)

                  A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                  • text — required — (String)

                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                  • value — required — (String)

                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

          • allowInterrupt — (Boolean)

            Indicates whether the user can interrupt a speech response from Amazon Lex.

        • active — (Boolean)

          Specifies whether the intent's confirmation is sent to the user. When this field is false, confirmation and declination responses aren't sent. If the active field isn't specified, the default is true.

      • intentClosingSetting — (map)

        The response that Amazon Lex sends to when the intent is closed.

        • closingResponse — required — (map)

          The response that Amazon Lex sends to the user when the intent is complete.

          • messageGroups — required — (Array<map>)

            A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

            • message — required — (map)

              The primary message that Amazon Lex should send to the user.

              • plainTextMessage — (map)

                A message in plain text format.

                • value — required — (String)

                  The message to send to the user.

              • customPayload — (map)

                A message in a custom format defined by the client application.

                • value — required — (String)

                  The string that is sent to your application.

              • ssmlMessage — (map)

                A message in Speech Synthesis Markup Language (SSML).

                • value — required — (String)

                  The SSML text that defines the prompt.

              • imageResponseCard — (map)

                A message that defines a response card that the client application can show to the user.

                • title — required — (String)

                  The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                • subtitle — (String)

                  The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                • imageUrl — (String)

                  The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                • buttons — (Array<map>)

                  A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                  • text — required — (String)

                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                  • value — required — (String)

                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

            • variations — (Array<map>)

              Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

              • plainTextMessage — (map)

                A message in plain text format.

                • value — required — (String)

                  The message to send to the user.

              • customPayload — (map)

                A message in a custom format defined by the client application.

                • value — required — (String)

                  The string that is sent to your application.

              • ssmlMessage — (map)

                A message in Speech Synthesis Markup Language (SSML).

                • value — required — (String)

                  The SSML text that defines the prompt.

              • imageResponseCard — (map)

                A message that defines a response card that the client application can show to the user.

                • title — required — (String)

                  The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                • subtitle — (String)

                  The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                • imageUrl — (String)

                  The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                • buttons — (Array<map>)

                  A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                  • text — required — (String)

                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                  • value — required — (String)

                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

          • allowInterrupt — (Boolean)

            Indicates whether the user can interrupt a speech response from Amazon Lex.

        • active — (Boolean)

          Specifies whether an intent's closing response is used. When this field is false, the closing response isn't sent to the user. If the active field isn't specified, the default is true.

      • inputContexts — (Array<map>)

        A list of contexts that must be active for the intent to be considered for sending to the user.

        • name — required — (String)

          The name of the context.

      • outputContexts — (Array<map>)

        A list of contexts that are activated when the intent is fulfilled.

        • name — required — (String)

          The name of the output context.

        • timeToLiveInSeconds — required — (Integer)

          The amount of time, in seconds, that the output context should remain active. The time is figured from the first time the context is sent to the user.

        • turnsToLive — required — (Integer)

          The number of conversation turns that the output context should remain active. The number of turns is counted from the first time that the context is sent to the user.

      • kendraConfiguration — (map)

        Configuration information required to use the AMAZON.KendraSearchIntent intent.

        • kendraIndex — required — (String)

          The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the AMAZON.KendraSearchIntent intent to search. The index must be in the same account and Region as the Amazon Lex bot.

        • queryFilterStringEnabled — (Boolean)

          Determines whether the AMAZON.KendraSearchIntent intent uses a custom query string to query the Amazon Kendra index.

        • queryFilterString — (String)

          A query filter that Amazon Lex sends to Amazon Kendra to filter the response from a query. The filter is in the format defined by Amazon Kendra. For more information, see Filtering queries.

      • botId — (String)

        The identifier of the bot associated with the intent.

      • botVersion — (String)

        The version of the bot associated with the intent.

      • localeId — (String)

        The language and locale specified for the intent.

      • creationDateTime — (Date)

        A timestamp of the date and time that the intent was created.

      • lastUpdatedDateTime — (Date)

        A timestamp of the date and time that the intent was last updated.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeResourcePolicy(params = {}, callback) ⇒ AWS.Request

Gets the resource policy and policy revision for a bot or bot alias.

Service Reference:

Examples:

Calling the describeResourcePolicy operation

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
lexmodelsv2.describeResourcePolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • resourceArn — (String)

      The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • resourceArn — (String)

        The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.

      • policy — (String)

        The JSON structure that contains the resource policy. For more information about the contents of a JSON policy document, see IAM JSON policy reference .

      • revisionId — (String)

        The current revision of the resource policy. Use the revision ID to make sure that you are updating the most current version of a resource policy when you add a policy statement to a resource, delete a resource, or update a resource.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeSlot(params = {}, callback) ⇒ AWS.Request

Gets metadata information about a slot.

Service Reference:

Examples:

Calling the describeSlot operation

var params = {
  botId: 'STRING_VALUE', /* required */
  botVersion: 'STRING_VALUE', /* required */
  intentId: 'STRING_VALUE', /* required */
  localeId: 'STRING_VALUE', /* required */
  slotId: 'STRING_VALUE' /* required */
};
lexmodelsv2.describeSlot(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • slotId — (String)

      The unique identifier for the slot.

    • botId — (String)

      The identifier of the bot associated with the slot.

    • botVersion — (String)

      The version of the bot associated with the slot.

    • localeId — (String)

      The identifier of the language and locale of the slot to describe. The string must match one of the supported locales. For more information, see Supported languages.

    • intentId — (String)

      The identifier of the intent that contains the slot.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • slotId — (String)

        The unique identifier generated for the slot.

      • slotName — (String)

        The name specified for the slot.

      • description — (String)

        The description specified for the slot.

      • slotTypeId — (String)

        The identifier of the slot type that determines the values entered into the slot.

      • valueElicitationSetting — (map)

        Prompts that Amazon Lex uses to elicit a value for the slot.

        • defaultValueSpecification — (map)

          A list of default values for a slot. Default values are used when Amazon Lex hasn't determined a value for a slot. You can specify default values from context variables, session attributes, and defined values.

          • defaultValueList — required — (Array<map>)

            A list of default values. Amazon Lex chooses the default value to use in the order that they are presented in the list.

            • defaultValue — required — (String)

              The default value to use when a user doesn't provide a value for a slot.

        • slotConstraint — required — (String)

          Specifies whether the slot is required or optional.

          Possible values include:
          • "Required"
          • "Optional"
        • promptSpecification — (map)

          The prompt that Amazon Lex uses to elicit the slot value from the user.

          • messageGroups — required — (Array<map>)

            A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.

            • message — required — (map)

              The primary message that Amazon Lex should send to the user.

              • plainTextMessage — (map)

                A message in plain text format.

                • value — required — (String)

                  The message to send to the user.

              • customPayload — (map)

                A message in a custom format defined by the client application.

                • value — required — (String)

                  The string that is sent to your application.

              • ssmlMessage — (map)

                A message in Speech Synthesis Markup Language (SSML).

                • value — required — (String)

                  The SSML text that defines the prompt.

              • imageResponseCard — (map)

                A message that defines a response card that the client application can show to the user.

                • title — required — (String)

                  The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                • subtitle — (String)

                  The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                • imageUrl — (String)

                  The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                • buttons — (Array<map>)

                  A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                  • text — required — (String)

                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                  • value — required — (String)

                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

            • variations — (Array<map>)

              Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

              • plainTextMessage — (map)

                A message in plain text format.

                • value — required — (String)

                  The message to send to the user.

              • customPayload — (map)

                A message in a custom format defined by the client application.

                • value — required — (String)

                  The string that is sent to your application.

              • ssmlMessage — (map)

                A message in Speech Synthesis Markup Language (SSML).

                • value — required — (String)

                  The SSML text that defines the prompt.

              • imageResponseCard — (map)

                A message that defines a response card that the client application can show to the user.

                • title — required — (String)

                  The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                • subtitle — (String)

                  The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                • imageUrl — (String)

                  The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                • buttons — (Array<map>)

                  A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                  • text — required — (String)

                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                  • value — required — (String)

                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

          • maxRetries — required — (Integer)

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

          • allowInterrupt — (Boolean)

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

        • sampleUtterances — (Array<map>)

          If you know a specific pattern that users might respond to an Amazon Lex request for a slot value, you can provide those utterances to improve accuracy. This is optional. In most cases, Amazon Lex is capable of understanding user utterances.

          • utterance — required — (String)

            The sample utterance that Amazon Lex uses to build its machine-learning model to recognize intents.

        • waitAndContinueSpecification — (map)

          Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input.

          • waitingResponse — required — (map)

            The response that Amazon Lex sends to indicate that the bot is waiting for the conversation to continue.

            • messageGroups — required — (Array<map>)

              A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

              • message — required — (map)

                The primary message that Amazon Lex should send to the user.

                • plainTextMessage — (map)

                  A message in plain text format.

                  • value — required — (String)

                    The message to send to the user.

                • customPayload — (map)

                  A message in a custom format defined by the client application.

                  • value — required — (String)

                    The string that is sent to your application.

                • ssmlMessage — (map)

                  A message in Speech Synthesis Markup Language (SSML).

                  • value — required — (String)

                    The SSML text that defines the prompt.

                • imageResponseCard — (map)

                  A message that defines a response card that the client application can show to the user.

                  • title — required — (String)

                    The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                  • subtitle — (String)

                    The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                  • imageUrl — (String)

                    The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                  • buttons — (Array<map>)

                    A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                    • text — required — (String)

                      The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                    • value — required — (String)

                      The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

              • variations — (Array<map>)

                Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                • plainTextMessage — (map)

                  A message in plain text format.

                  • value — required — (String)

                    The message to send to the user.

                • customPayload — (map)

                  A message in a custom format defined by the client application.

                  • value — required — (String)

                    The string that is sent to your application.

                • ssmlMessage — (map)

                  A message in Speech Synthesis Markup Language (SSML).

                  • value — required — (String)

                    The SSML text that defines the prompt.

                • imageResponseCard — (map)

                  A message that defines a response card that the client application can show to the user.

                  • title — required — (String)

                    The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                  • subtitle — (String)

                    The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                  • imageUrl — (String)

                    The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                  • buttons — (Array<map>)

                    A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                    • text — required — (String)

                      The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                    • value — required — (String)

                      The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

            • allowInterrupt — (Boolean)

              Indicates whether the user can interrupt a speech response from Amazon Lex.

          • continueResponse — required — (map)

            The response that Amazon Lex sends to indicate that the bot is ready to continue the conversation.

            • messageGroups — required — (Array<map>)

              A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

              • message — required — (map)

                The primary message that Amazon Lex should send to the user.

                • plainTextMessage — (map)

                  A message in plain text format.

                  • value — required — (String)

                    The message to send to the user.

                • customPayload — (map)

                  A message in a custom format defined by the client application.

                  • value — required — (String)

                    The string that is sent to your application.

                • ssmlMessage — (map)

                  A message in Speech Synthesis Markup Language (SSML).

                  • value — required — (String)

                    The SSML text that defines the prompt.

                • imageResponseCard — (map)

                  A message that defines a response card that the client application can show to the user.

                  • title — required — (String)

                    The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                  • subtitle — (String)

                    The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                  • imageUrl — (String)

                    The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                  • buttons — (Array<map>)

                    A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                    • text — required — (String)

                      The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                    • value — required — (String)

                      The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

              • variations — (Array<map>)

                Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                • plainTextMessage — (map)

                  A message in plain text format.

                  • value — required — (String)

                    The message to send to the user.

                • customPayload — (map)

                  A message in a custom format defined by the client application.

                  • value — required — (String)

                    The string that is sent to your application.

                • ssmlMessage — (map)

                  A message in Speech Synthesis Markup Language (SSML).

                  • value — required — (String)

                    The SSML text that defines the prompt.

                • imageResponseCard — (map)

                  A message that defines a response card that the client application can show to the user.

                  • title — required — (String)

                    The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                  • subtitle — (String)

                    The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                  • imageUrl — (String)

                    The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                  • buttons — (Array<map>)

                    A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                    • text — required — (String)

                      The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                    • value — required — (String)

                      The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

            • allowInterrupt — (Boolean)

              Indicates whether the user can interrupt a speech response from Amazon Lex.

          • stillWaitingResponse — (map)

            A response that Amazon Lex sends periodically to the user to indicate that the bot is still waiting for input from the user.

            • messageGroups — required — (Array<map>)

              One or more message groups, each containing one or more messages, that define the prompts that Amazon Lex sends to the user.

              • message — required — (map)

                The primary message that Amazon Lex should send to the user.

                • plainTextMessage — (map)

                  A message in plain text format.

                  • value — required — (String)

                    The message to send to the user.

                • customPayload — (map)

                  A message in a custom format defined by the client application.

                  • value — required — (String)

                    The string that is sent to your application.

                • ssmlMessage — (map)

                  A message in Speech Synthesis Markup Language (SSML).

                  • value — required — (String)

                    The SSML text that defines the prompt.

                • imageResponseCard — (map)

                  A message that defines a response card that the client application can show to the user.

                  • title — required — (String)

                    The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                  • subtitle — (String)

                    The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                  • imageUrl — (String)

                    The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                  • buttons — (Array<map>)

                    A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                    • text — required — (String)

                      The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                    • value — required — (String)

                      The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

              • variations — (Array<map>)

                Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                • plainTextMessage — (map)

                  A message in plain text format.

                  • value — required — (String)

                    The message to send to the user.

                • customPayload — (map)

                  A message in a custom format defined by the client application.

                  • value — required — (String)

                    The string that is sent to your application.

                • ssmlMessage — (map)

                  A message in Speech Synthesis Markup Language (SSML).

                  • value — required — (String)

                    The SSML text that defines the prompt.

                • imageResponseCard — (map)

                  A message that defines a response card that the client application can show to the user.

                  • title — required — (String)

                    The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                  • subtitle — (String)

                    The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                  • imageUrl — (String)

                    The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                  • buttons — (Array<map>)

                    A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                    • text — required — (String)

                      The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                    • value — required — (String)

                      The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

            • frequencyInSeconds — required — (Integer)

              How often a message should be sent to the user. Minimum of 1 second, maximum of 5 minutes.

            • timeoutInSeconds — required — (Integer)

              If Amazon Lex waits longer than this length of time for a response, it will stop sending messages.

            • allowInterrupt — (Boolean)

              Indicates that the user can interrupt the response by speaking while the message is being played.

          • active — (Boolean)

            Specifies whether the bot will wait for a user to respond. When this field is false, wait and continue responses for a slot aren't used. If the active field isn't specified, the default is true.

      • obfuscationSetting — (map)

        Whether slot values are shown in Amazon CloudWatch logs. If the value is None, the actual value of the slot is shown in logs.

        • obfuscationSettingType — required — (String)

          Value that determines whether Amazon Lex obscures slot values in conversation logs. The default is to obscure the values.

          Possible values include:
          • "None"
          • "DefaultObfuscation"
      • botId — (String)

        The identifier of the bot associated with the slot.

      • botVersion — (String)

        The version of the bot associated with the slot.

      • localeId — (String)

        The language and locale specified for the slot.

      • intentId — (String)

        The identifier of the intent associated with the slot.

      • creationDateTime — (Date)

        A timestamp of the date and time that the slot was created.

      • lastUpdatedDateTime — (Date)

        A timestamp of the date and time that the slot was last updated.

      • multipleValuesSetting — (map)

        Indicates whether the slot accepts multiple values in a single utterance.

        If the multipleValuesSetting is not set, the default value is false.

        • allowMultipleValues — (Boolean)

          Indicates whether a slot can return multiple values. When true, the slot may return more than one value in a response. When false, the slot returns only a single value.

          Multi-value slots are only available in the en-US locale. If you set this value to true in any other locale, Amazon Lex throws a ValidationException.

          If the allowMutlipleValues is not set, the default value is false.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeSlotType(params = {}, callback) ⇒ AWS.Request

Gets metadata information about a slot type.

Service Reference:

Examples:

Calling the describeSlotType operation

var params = {
  botId: 'STRING_VALUE', /* required */
  botVersion: 'STRING_VALUE', /* required */
  localeId: 'STRING_VALUE', /* required */
  slotTypeId: 'STRING_VALUE' /* required */
};
lexmodelsv2.describeSlotType(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • slotTypeId — (String)

      The identifier of the slot type.

    • botId — (String)

      The identifier of the bot associated with the slot type.

    • botVersion — (String)

      The version of the bot associated with the slot type.

    • localeId — (String)

      The identifier of the language and locale of the slot type to describe. The string must match one of the supported locales. For more information, see Supported languages.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • slotTypeId — (String)

        The unique identifier for the slot type.

      • slotTypeName — (String)

        The name specified for the slot type.

      • description — (String)

        The description specified for the slot type.

      • slotTypeValues — (Array<map>)

        The values that the slot type can take. Includes any synonyms for the slot type values.

        • sampleValue — (map)

          The value of the slot type entry.

          • value — required — (String)

            The value that can be used for a slot type.

        • synonyms — (Array<map>)

          Additional values related to the slot type entry.

          • value — required — (String)

            The value that can be used for a slot type.

      • valueSelectionSetting — (map)

        The strategy that Amazon Lex uses to choose a value from a list of possible values.

        • resolutionStrategy — required — (String)

          Determines the slot resolution strategy that Amazon Lex uses to return slot type values. The field can be set to one of the following values:

          • OriginalValue - Returns the value entered by the user, if the user value is similar to the slot value.

          • TopResolution - If there is a resolution list for the slot, return the first value in the resolution list as the slot type value. If there is no resolution list, null is returned.

          If you don't specify the valueSelectionStrategy, the default is OriginalValue.

          Possible values include:
          • "OriginalValue"
          • "TopResolution"
        • regexFilter — (map)

          A regular expression used to validate the value of a slot.

          • pattern — required — (String)

            A regular expression used to validate the value of a slot.

            Use a standard regular expression. Amazon Lex supports the following characters in the regular expression:

            • A-Z, a-z

            • 0-9

            • Unicode characters ("\ u<Unicode>")

            Represent Unicode characters with four digits, for example "\u0041" or "\u005A".

            The following regular expression operators are not supported:

            • Infinite repeaters: *, +, or {x,} with no upper bound.

            • Wild card (.)

      • parentSlotTypeSignature — (String)

        The built in slot type used as a parent to this slot type.

      • botId — (String)

        The identifier of the bot associated with the slot type.

      • botVersion — (String)

        The version of the bot associated with the slot type.

      • localeId — (String)

        The language and locale specified for the slot type.

      • creationDateTime — (Date)

        A timestamp of the date and time that the slot type was created.

      • lastUpdatedDateTime — (Date)

        A timestamp of the date and time that the slot type was last updated.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listAggregatedUtterances(params = {}, callback) ⇒ AWS.Request

Provides a list of utterances that users have sent to the bot.

Utterances are aggregated by the text of the utterance. For example, all instances where customers used the phrase "I want to order pizza" are aggregated into the same line in the response.

You can see both detected utterances and missed utterances. A detected utterance is where the bot properly recognized the utterance and activated the associated intent. A missed utterance was not recognized by the bot and didn't activate an intent.

Utterances can be aggregated for a bot alias or for a bot version, but not both at the same time.

Utterances statistics are not generated under the following conditions:

  • The childDirected field was set to true when the bot was created.

  • You are using slot obfuscation with one or more slots.

  • You opted out of participating in improving Amazon Lex.

Service Reference:

Examples:

Calling the listAggregatedUtterances operation

var params = {
  aggregationDuration: { /* required */
    relativeAggregationDuration: { /* required */
      timeDimension: Hours | Days | Weeks, /* required */
      timeValue: 'NUMBER_VALUE' /* required */
    }
  },
  botId: 'STRING_VALUE', /* required */
  localeId: 'STRING_VALUE', /* required */
  botAliasId: 'STRING_VALUE',
  botVersion: 'STRING_VALUE',
  filters: [
    {
      name: Utterance, /* required */
      operator: CO | EQ, /* required */
      values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  sortBy: {
    attribute: HitCount | MissedCount, /* required */
    order: Ascending | Descending /* required */
  }
};
lexmodelsv2.listAggregatedUtterances(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • botId — (String)

      The unique identifier of the bot associated with this request.

    • botAliasId — (String)

      The identifier of the bot alias associated with this request. If you specify the bot alias, you can't specify the bot version.

    • botVersion — (String)

      The identifier of the bot version associated with this request. If you specify the bot version, you can't specify the bot alias.

    • localeId — (String)

      The identifier of the language and locale where the utterances were collected. For more information, see Supported languages.

    • aggregationDuration — (map)

      The time window for aggregating the utterance information. You can specify a time between one hour and two weeks.

      • relativeAggregationDuration — required — (map)

        The desired time window for aggregating utterances.

        • timeDimension — required — (String)

          The type of time period that the timeValue field represents.

          Possible values include:
          • "Hours"
          • "Days"
          • "Weeks"
        • timeValue — required — (Integer)

          The period of the time window to gather statistics for. The valid value depends on the setting of the timeDimension field.

          • Hours - 1/3/6/12/24

          • Days - 3

          • Weeks - 1/2

    • sortBy — (map)

      Specifies sorting parameters for the list of utterances. You can sort by the hit count, the missed count, or the number of distinct sessions the utterance appeared in.

      • attribute — required — (String)

        The utterance attribute to sort by.

        Possible values include:
        • "HitCount"
        • "MissedCount"
      • order — required — (String)

        Specifies whether to sort the aggregated utterances in ascending or descending order.

        Possible values include:
        • "Ascending"
        • "Descending"
    • filters — (Array<map>)

      Provides the specification of a filter used to limit the utterances in the response to only those that match the filter specification. You can only specify one filter and one string to filter on.

      • name — required — (String)

        The name of the field to filter the utterance list.

        Possible values include:
        • "Utterance"
      • values — required — (Array<String>)

        The value to use for filtering the list of bots.

      • operator — required — (String)

        The operator to use for the filter. Specify EQ when the ListAggregatedUtterances operation should return only utterances that equal the specified value. Specify CO when the ListAggregatedUtterances operation should return utterances that contain the specified value.

        Possible values include:
        • "CO"
        • "EQ"
    • maxResults — (Integer)

      The maximum number of utterances to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned. If you don't specify the maxResults parameter, 1,000 results are returned.

    • nextToken — (String)

      If the response from the ListAggregatedUtterances operation contains more results that specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • botId — (String)

        The identifier of the bot that contains the utterances.

      • botAliasId — (String)

        The identifier of the bot alias that contains the utterances. If you specified the bot version, the bot alias ID isn't returned.

      • botVersion — (String)

        The identifier of the bot version that contains the utterances. If you specified the bot alias, the bot version isn't returned.

      • localeId — (String)

        The identifier of the language and locale that the utterances are in.

      • aggregationDuration — (map)

        The time period used to aggregate the utterance data.

        • relativeAggregationDuration — required — (map)

          The desired time window for aggregating utterances.

          • timeDimension — required — (String)

            The type of time period that the timeValue field represents.

            Possible values include:
            • "Hours"
            • "Days"
            • "Weeks"
          • timeValue — required — (Integer)

            The period of the time window to gather statistics for. The valid value depends on the setting of the timeDimension field.

            • Hours - 1/3/6/12/24

            • Days - 3

            • Weeks - 1/2

      • aggregationWindowStartTime — (Date)

        The date and time that the aggregation window begins. Only data collected after this time is returned in the results.

      • aggregationWindowEndTime — (Date)

        The date and time that the aggregation window ends. Only data collected between the start time and the end time are returned in the results.

      • aggregationLastRefreshedDateTime — (Date)

        The last date and time that the aggregated data was collected. The time period depends on the length of the aggregation window.

        • Hours - for 1 hour time window, every half hour; otherwise every hour.

        • Days - every 6 hours

        • Weeks - for a one week time window, every 12 hours; otherwise, every day

      • aggregatedUtterancesSummaries — (Array<map>)

        Summaries of the aggregated utterance data. Each response contains information about the number of times that the utterance was seen during the time period, whether it was detected or missed, and when it was seen during the time period.

        • utterance — (String)

          The text of the utterance. If the utterance was used with the RecognizeUtterance operation, the text is the transcription of the audio utterance.

        • hitCount — (Integer)

          The number of times that the utterance was detected by Amazon Lex during the time period. When an utterance is detected, it activates an intent or a slot.

        • missedCount — (Integer)

          The number of times that the utterance was missed by Amazon Lex An utterance is missed when it doesn't activate an intent or slot.

        • utteranceFirstRecordedInAggregationDuration — (Date)

          The date and time that the utterance was first recorded in the time window for aggregation. An utterance may have been sent to Amazon Lex before that time, but only utterances within the time window are counted.

        • utteranceLastRecordedInAggregationDuration — (Date)

          The last date and time that an utterance was recorded in the time window for aggregation. An utterance may be sent to Amazon Lex after that time, but only utterances within the time window are counted.

        • containsDataFromDeletedResources — (Boolean)

          Aggregated utterance data may contain utterances from versions of your bot that have since been deleted. When the aggregated contains this kind of data, this field is set to true.

      • nextToken — (String)

        A token that indicates whether there are more results to return in a response to the ListAggregatedUtterances operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListAggregatedUtterances operation request to get the next page of results.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listBotAliases(params = {}, callback) ⇒ AWS.Request

Gets a list of aliases for the specified bot.

Service Reference:

Examples:

Calling the listBotAliases operation

var params = {
  botId: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
lexmodelsv2.listBotAliases(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • botId — (String)

      The identifier of the bot to list aliases for.

    • maxResults — (Integer)

      The maximum number of aliases to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.

    • nextToken — (String)

      If the response from the ListBotAliases operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • botAliasSummaries — (Array<map>)

        Summary information for the bot aliases that meet the filter criteria specified in the request. The length of the list is specified in the maxResults parameter of the request. If there are more aliases available, the nextToken field contains a token to get the next page of results.

        • botAliasId — (String)

          The unique identifier assigned to the bot alias. You can use this ID to get detailed information about the alias using the DescribeBotAlias operation.

        • botAliasName — (String)

          The name of the bot alias.

        • description — (String)

          The description of the bot alias.

        • botVersion — (String)

          The version of the bot that the bot alias references.

        • botAliasStatus — (String)

          The current state of the bot alias. If the status is Available, the alias is ready for use.

          Possible values include:
          • "Creating"
          • "Available"
          • "Deleting"
          • "Failed"
        • creationDateTime — (Date)

          A timestamp of the date and time that the bot alias was created.

        • lastUpdatedDateTime — (Date)

          A timestamp of the date and time that the bot alias was last updated.

      • nextToken — (String)

        A token that indicates whether there are more results to return in a response to the ListBotAliases operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListBotAliases operation request to get the next page of results.

      • botId — (String)

        The identifier of the bot associated with the aliases.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listBotLocales(params = {}, callback) ⇒ AWS.Request

Gets a list of locales for the specified bot.

Service Reference:

Examples:

Calling the listBotLocales operation

var params = {
  botId: 'STRING_VALUE', /* required */
  botVersion: 'STRING_VALUE', /* required */
  filters: [
    {
      name: BotLocaleName, /* required */
      operator: CO | EQ, /* required */
      values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  sortBy: {
    attribute: BotLocaleName, /* required */
    order: Ascending | Descending /* required */
  }
};
lexmodelsv2.listBotLocales(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • botId — (String)

      The identifier of the bot to list locales for.

    • botVersion — (String)

      The version of the bot to list locales for.

    • sortBy — (map)

      Specifies sorting parameters for the list of locales. You can sort by locale name in ascending or descending order.

      • attribute — required — (String)

        The bot locale attribute to sort by.

        Possible values include:
        • "BotLocaleName"
      • order — required — (String)

        Specifies whether to sort the bot locales in ascending or descending order.

        Possible values include:
        • "Ascending"
        • "Descending"
    • filters — (Array<map>)

      Provides the specification for a filter used to limit the response to only those locales that match the filter specification. You can only specify one filter and one value to filter on.

      • name — required — (String)

        The name of the field to filter the list of bots.

        Possible values include:
        • "BotLocaleName"
      • values — required — (Array<String>)

        The value to use for filtering the list of bots.

      • operator — required — (String)

        The operator to use for the filter. Specify EQ when the ListBotLocales operation should return only aliases that equal the specified value. Specify CO when the ListBotLocales operation should return aliases that contain the specified value.

        Possible values include:
        • "CO"
        • "EQ"
    • maxResults — (Integer)

      The maximum number of aliases to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.

    • nextToken — (String)

      If the response from the ListBotLocales operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token as the nextToken parameter to return the next page of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • botId — (String)

        The identifier of the bot to list locales for.

      • botVersion — (String)

        The version of the bot.

      • nextToken — (String)

        A token that indicates whether there are more results to return in a response to the ListBotLocales operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListBotLocales operation request to get the next page of results.

      • botLocaleSummaries — (Array<map>)

        Summary information for the locales that meet the filter criteria specified in the request. The length of the list is specified in the maxResults parameter of the request. If there are more locales available, the nextToken field contains a token to get the next page of results.

        • localeId — (String)

          The language and locale of the bot locale.

        • localeName — (String)

          The name of the bot locale.

        • description — (String)

          The description of the bot locale.

        • botLocaleStatus — (String)

          The current status of the bot locale. When the status is Built the locale is ready for use.

          Possible values include:
          • "Creating"
          • "Building"
          • "Built"
          • "ReadyExpressTesting"
          • "Failed"
          • "Deleting"
          • "NotBuilt"
          • "Importing"
        • lastUpdatedDateTime — (Date)

          A timestamp of the date and time that the bot locale was last updated.

        • lastBuildSubmittedDateTime — (Date)

          A timestamp of the date and time that the bot locale was last built.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listBots(params = {}, callback) ⇒ AWS.Request

Gets a list of available bots.

Service Reference:

Examples:

Calling the listBots operation

var params = {
  filters: [
    {
      name: BotName, /* required */
      operator: CO | EQ, /* required */
      values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  sortBy: {
    attribute: BotName, /* required */
    order: Ascending | Descending /* required */
  }
};
lexmodelsv2.listBots(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • sortBy — (map)

      Specifies sorting parameters for the list of bots. You can specify that the list be sorted by bot name in ascending or descending order.

      • attribute — required — (String)

        The attribute to use to sort the list of bots.

        Possible values include:
        • "BotName"
      • order — required — (String)

        The order to sort the list. You can choose ascending or descending.

        Possible values include:
        • "Ascending"
        • "Descending"
    • filters — (Array<map>)

      Provides the specification of a filter used to limit the bots in the response to only those that match the filter specification. You can only specify one filter and one string to filter on.

      • name — required — (String)

        The name of the field to filter the list of bots.

        Possible values include:
        • "BotName"
      • values — required — (Array<String>)

        The value to use for filtering the list of bots.

      • operator — required — (String)

        The operator to use for the filter. Specify EQ when the ListBots operation should return only aliases that equal the specified value. Specify CO when the ListBots operation should return aliases that contain the specified value.

        Possible values include:
        • "CO"
        • "EQ"
    • maxResults — (Integer)

      The maximum number of bots to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned.

    • nextToken — (String)

      If the response from the ListBots operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • botSummaries — (Array<map>)

        Summary information for the bots that meet the filter criteria specified in the request. The length of the list is specified in the maxResults parameter of the request. If there are more bots available, the nextToken field contains a token to the next page of results.

        • botId — (String)

          The unique identifier assigned to the bot. Use this ID to get detailed information about the bot with the DescribeBot operation.

        • botName — (String)

          The name of the bot.

        • description — (String)

          The description of the bot.

        • botStatus — (String)

          The current status of the bot. When the status is Available the bot is ready for use.

          Possible values include:
          • "Creating"
          • "Available"
          • "Inactive"
          • "Deleting"
          • "Failed"
          • "Versioning"
          • "Importing"
        • latestBotVersion — (String)

          The latest numerical version in use for the bot.

        • lastUpdatedDateTime — (Date)

          The date and time that the bot was last updated.

      • nextToken — (String)

        A token that indicates whether there are more results to return in a response to the ListBots operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListBots operation request to get the next page of results.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listBotVersions(params = {}, callback) ⇒ AWS.Request

Gets information about all of the versions of a bot.

The ListBotVersions operation returns a summary of each version of a bot. For example, if a bot has three numbered versions, the ListBotVersions operation returns for summaries, one for each numbered version and one for the DRAFT version.

The ListBotVersions operation always returns at least one version, the DRAFT version.

Service Reference:

Examples:

Calling the listBotVersions operation

var params = {
  botId: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  sortBy: {
    attribute: BotVersion, /* required */
    order: Ascending | Descending /* required */
  }
};
lexmodelsv2.listBotVersions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • botId — (String)

      The identifier of the bot to list versions for.

    • sortBy — (map)

      Specifies sorting parameters for the list of versions. You can specify that the list be sorted by version name in either ascending or descending order.

      • attribute — required — (String)

        The attribute to use to sort the list of versions.

        Possible values include:
        • "BotVersion"
      • order — required — (String)

        The order to sort the list. You can specify ascending or descending order.

        Possible values include:
        • "Ascending"
        • "Descending"
    • maxResults — (Integer)

      The maximum number of versions to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.

    • nextToken — (String)

      If the response to the ListBotVersion operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • botId — (String)

        The identifier of the bot to list versions for.

      • botVersionSummaries — (Array<map>)

        Summary information for the bot versions that meet the filter criteria specified in the request. The length of the list is specified in the maxResults parameter of the request. If there are more versions available, the nextToken field contains a token to get the next page of results.

        • botName — (String)

          The name of the bot associated with the version.

        • botVersion — (String)

          The numeric version of the bot, or DRAFT to indicate that this is the version of the bot that can be updated..

        • description — (String)

          The description of the version.

        • botStatus — (String)

          The status of the bot. When the status is available, the version of the bot is ready for use.

          Possible values include:
          • "Creating"
          • "Available"
          • "Inactive"
          • "Deleting"
          • "Failed"
          • "Versioning"
          • "Importing"
        • creationDateTime — (Date)

          A timestamp of the date and time that the version was created.

      • nextToken — (String)

        A token that indicates whether there are more results to return in a response to the ListBotVersions operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListBotAliases operation request to get the next page of results.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listBuiltInIntents(params = {}, callback) ⇒ AWS.Request

Gets a list of built-in intents provided by Amazon Lex that you can use in your bot.

To use a built-in intent as a the base for your own intent, include the built-in intent signature in the parentIntentSignature parameter when you call the CreateIntent operation. For more information, see CreateIntent.

Service Reference:

Examples:

Calling the listBuiltInIntents operation

var params = {
  localeId: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  sortBy: {
    attribute: IntentSignature, /* required */
    order: Ascending | Descending /* required */
  }
};
lexmodelsv2.listBuiltInIntents(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • localeId — (String)

      The identifier of the language and locale of the intents to list. The string must match one of the supported locales. For more information, see Supported languages.

    • sortBy — (map)

      Specifies sorting parameters for the list of built-in intents. You can specify that the list be sorted by the built-in intent signature in either ascending or descending order.

      • attribute — required — (String)

        The attribute to use to sort the list of built-in intents.

        Possible values include:
        • "IntentSignature"
      • order — required — (String)

        The order to sort the list. You can specify ascending or descending order.

        Possible values include:
        • "Ascending"
        • "Descending"
    • maxResults — (Integer)

      The maximum number of built-in intents to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.

    • nextToken — (String)

      If the response from the ListBuiltInIntents operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • builtInIntentSummaries — (Array<map>)

        Summary information for the built-in intents that meet the filter criteria specified in the request. The length of the list is specified in the maxResults parameter of the request. If there are more intents available, the nextToken field contains a token to get the next page of results.

        • intentSignature — (String)

          The signature of the built-in intent. Use this to specify the parent intent of a derived intent.

        • description — (String)

          The description of the intent.

      • nextToken — (String)

        A token that indicates whether there are more results to return in a response to the ListBuiltInIntents operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListBotAliases operation request to get the next page of results.

      • localeId — (String)

        The language and locale of the intents in the list.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listBuiltInSlotTypes(params = {}, callback) ⇒ AWS.Request

Gets a list of built-in slot types that meet the specified criteria.

Service Reference:

Examples:

Calling the listBuiltInSlotTypes operation

var params = {
  localeId: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  sortBy: {
    attribute: SlotTypeSignature, /* required */
    order: Ascending | Descending /* required */
  }
};
lexmodelsv2.listBuiltInSlotTypes(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • localeId — (String)

      The identifier of the language and locale of the slot types to list. The string must match one of the supported locales. For more information, see Supported languages.

    • sortBy — (map)

      Determines the sort order for the response from the ListBuiltInSlotTypes operation. You can choose to sort by the slot type signature in either ascending or descending order.

      • attribute — required — (String)

        The attribute to use to sort the list of built-in intents.

        Possible values include:
        • "SlotTypeSignature"
      • order — required — (String)

        The order to sort the list. You can choose ascending or descending.

        Possible values include:
        • "Ascending"
        • "Descending"
    • maxResults — (Integer)

      The maximum number of built-in slot types to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.

    • nextToken — (String)

      If the response from the ListBuiltInSlotTypes operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • builtInSlotTypeSummaries — (Array<map>)

        Summary information for the built-in slot types that meet the filter criteria specified in the request. The length of the list is specified in the maxResults parameter of the request. If there are more slot types available, the nextToken field contains a token to get the next page of results.

        • slotTypeSignature — (String)

          The signature of the built-in slot type. Use this to specify the parent slot type of a derived slot type.

        • description — (String)

          The description of the built-in slot type.

      • nextToken — (String)

        A token that indicates whether there are more results to return in a response to the ListBuiltInSlotTypes operation. If the nextToken field is present, you send the contents as the nextToken parameter of a LIstBuiltInSlotTypes operation request to get the next page of results.

      • localeId — (String)

        The language and locale of the slot types in the list.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listExports(params = {}, callback) ⇒ AWS.Request

Lists the exports for a bot or bot locale. Exports are kept in the list for 7 days.

Service Reference:

Examples:

Calling the listExports operation

var params = {
  botId: 'STRING_VALUE',
  botVersion: 'STRING_VALUE',
  filters: [
    {
      name: ExportResourceType, /* required */
      operator: CO | EQ, /* required */
      values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  sortBy: {
    attribute: LastUpdatedDateTime, /* required */
    order: Ascending | Descending /* required */
  }
};
lexmodelsv2.listExports(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • botId — (String)

      The unique identifier that Amazon Lex assigned to the bot.

    • botVersion — (String)

      The version of the bot to list exports for.

    • sortBy — (map)

      Determines the field that the list of exports is sorted by. You can sort by the LastUpdatedDateTime field in ascending or descending order.

      • attribute — required — (String)

        The export field to use for sorting.

        Possible values include:
        • "LastUpdatedDateTime"
      • order — required — (String)

        The order to sort the list.

        Possible values include:
        • "Ascending"
        • "Descending"
    • filters — (Array<map>)

      Provides the specification of a filter used to limit the exports in the response to only those that match the filter specification. You can only specify one filter and one string to filter on.

      • name — required — (String)

        The name of the field to use for filtering.

        Possible values include:
        • "ExportResourceType"
      • values — required — (Array<String>)

        The values to use to filter the response.

      • operator — required — (String)

        The operator to use for the filter. Specify EQ when the ListExports operation should return only resource types that equal the specified value. Specify CO when the ListExports operation should return resource types that contain the specified value.

        Possible values include:
        • "CO"
        • "EQ"
    • maxResults — (Integer)

      The maximum number of exports to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.

    • nextToken — (String)

      If the response from the ListExports operation contains more results that specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • botId — (String)

        The unique identifier assigned to the bot by Amazon Lex.

      • botVersion — (String)

        The version of the bot that was exported.

      • exportSummaries — (Array<map>)

        Summary information for the exports that meet the filter criteria specified in the request. The length of the list is specified in the maxResults parameter. If there are more exports available, the nextToken field contains a token to get the next page of results.

        • exportId — (String)

          The unique identifier that Amazon Lex assigned to the export.

        • resourceSpecification — (map)

          Information about the bot or bot locale that was exported.

          • botExportSpecification — (map)

            Parameters for exporting a bot.

            • botId — required — (String)

              The identifier of the bot assigned by Amazon Lex.

            • botVersion — required — (String)

              The version of the bot that was exported. This will be either DRAFT or the version number.

          • botLocaleExportSpecification — (map)

            Parameters for exporting a bot locale.

            • botId — required — (String)

              The identifier of the bot to create the locale for.

            • botVersion — required — (String)

              The version of the bot to export.

            • localeId — required — (String)

              The identifier of the language and locale to export. The string must match one of the locales in the bot.

        • fileFormat — (String)

          The file format used in the export files.

          Possible values include:
          • "LexJson"
        • exportStatus — (String)

          The status of the export. When the status is Completed the export is ready to download.

          Possible values include:
          • "InProgress"
          • "Completed"
          • "Failed"
          • "Deleting"
        • creationDateTime — (Date)

          The date and time that the export was created.

        • lastUpdatedDateTime — (Date)

          The date and time that the export was last updated.

      • nextToken — (String)

        A token that indicates whether there are more results to return in a response to the ListExports operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListExports operation request to get the next page of results.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listImports(params = {}, callback) ⇒ AWS.Request

Lists the imports for a bot or bot locale. Imports are kept in the list for 7 days.

Service Reference:

Examples:

Calling the listImports operation

var params = {
  botId: 'STRING_VALUE',
  botVersion: 'STRING_VALUE',
  filters: [
    {
      name: ImportResourceType, /* required */
      operator: CO | EQ, /* required */
      values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  sortBy: {
    attribute: LastUpdatedDateTime, /* required */
    order: Ascending | Descending /* required */
  }
};
lexmodelsv2.listImports(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • botId — (String)

      The unique identifier that Amazon Lex assigned to the bot.

    • botVersion — (String)

      The version of the bot to list imports for.

    • sortBy — (map)

      Determines the field that the list of imports is sorted by. You can sort by the LastUpdatedDateTime field in ascending or descending order.

      • attribute — required — (String)

        The export field to use for sorting.

        Possible values include:
        • "LastUpdatedDateTime"
      • order — required — (String)

        The order to sort the list.

        Possible values include:
        • "Ascending"
        • "Descending"
    • filters — (Array<map>)

      Provides the specification of a filter used to limit the bots in the response to only those that match the filter specification. You can only specify one filter and one string to filter on.

      • name — required — (String)

        The name of the field to use for filtering.

        Possible values include:
        • "ImportResourceType"
      • values — required — (Array<String>)

        The values to use to filter the response.

      • operator — required — (String)

        The operator to use for the filter. Specify EQ when the ListImports operation should return only resource types that equal the specified value. Specify CO when the ListImports operation should return resource types that contain the specified value.

        Possible values include:
        • "CO"
        • "EQ"
    • maxResults — (Integer)

      The maximum number of imports to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.

    • nextToken — (String)

      If the response from the ListImports operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • botId — (String)

        The unique identifier assigned by Amazon Lex to the bot.

      • botVersion — (String)

        The version of the bot that was imported. It will always be DRAFT.

      • importSummaries — (Array<map>)

        Summary information for the imports that meet the filter criteria specified in the request. The length of the list is specified in the maxResults parameter. If there are more imports available, the nextToken field contains a token to get the next page of results.

        • importId — (String)

          The unique identifier that Amazon Lex assigned to the import.

        • importedResourceId — (String)

          The unique identifier that Amazon Lex assigned to the imported resource.

        • importedResourceName — (String)

          The name that you gave the imported resource.

        • importStatus — (String)

          The status of the resource. When the status is Completed the resource is ready to build.

          Possible values include:
          • "InProgress"
          • "Completed"
          • "Failed"
          • "Deleting"
        • mergeStrategy — (String)

          The strategy used to merge existing bot or bot locale definitions with the imported definition.

          Possible values include:
          • "Overwrite"
          • "FailOnConflict"
        • creationDateTime — (Date)

          The date and time that the import was created.

        • lastUpdatedDateTime — (Date)

          The date and time that the import was last updated.

      • nextToken — (String)

        A token that indicates whether there are more results to return in a response to the ListImports operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListImports operation request to get the next page of results.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listIntents(params = {}, callback) ⇒ AWS.Request

Get a list of intents that meet the specified criteria.

Service Reference:

Examples:

Calling the listIntents operation

var params = {
  botId: 'STRING_VALUE', /* required */
  botVersion: 'STRING_VALUE', /* required */
  localeId: 'STRING_VALUE', /* required */
  filters: [
    {
      name: IntentName, /* required */
      operator: CO | EQ, /* required */
      values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  sortBy: {
    attribute: IntentName | LastUpdatedDateTime, /* required */
    order: Ascending | Descending /* required */
  }
};
lexmodelsv2.listIntents(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • botId — (String)

      The unique identifier of the bot that contains the intent.

    • botVersion — (String)

      The version of the bot that contains the intent.

    • localeId — (String)

      The identifier of the language and locale of the intents to list. The string must match one of the supported locales. For more information, see Supported languages.

    • sortBy — (map)

      Determines the sort order for the response from the ListIntents operation. You can choose to sort by the intent name or last updated date in either ascending or descending order.

      • attribute — required — (String)

        The attribute to use to sort the list of intents.

        Possible values include:
        • "IntentName"
        • "LastUpdatedDateTime"
      • order — required — (String)

        The order to sort the list. You can choose ascending or descending.

        Possible values include:
        • "Ascending"
        • "Descending"
    • filters — (Array<map>)

      Provides the specification of a filter used to limit the intents in the response to only those that match the filter specification. You can only specify one filter and only one string to filter on.

      • name — required — (String)

        The name of the field to use for the filter.

        Possible values include:
        • "IntentName"
      • values — required — (Array<String>)

        The value to use for the filter.

      • operator — required — (String)

        The operator to use for the filter. Specify EQ when the ListIntents operation should return only aliases that equal the specified value. Specify CO when the ListIntents operation should return aliases that contain the specified value.

        Possible values include:
        • "CO"
        • "EQ"
    • maxResults — (Integer)

      The maximum number of intents to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.

    • nextToken — (String)

      If the response from the ListIntents operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • botId — (String)

        The identifier of the bot that contains the intent.

      • botVersion — (String)

        The version of the bot that contains the intent.

      • localeId — (String)

        The language and locale of the intents in the list.

      • intentSummaries — (Array<map>)

        Summary information for the intents that meet the filter criteria specified in the request. The length of the list is specified in the maxResults parameter of the request. If there are more intents available, the nextToken field contains a token to get the next page of results.

        • intentId — (String)

          The unique identifier assigned to the intent. Use this ID to get detailed information about the intent with the DescribeIntent operation.

        • intentName — (String)

          The name of the intent.

        • description — (String)

          The description of the intent.

        • parentIntentSignature — (String)

          If this intent is derived from a built-in intent, the name of the parent intent.

        • inputContexts — (Array<map>)

          The input contexts that must be active for this intent to be considered for recognition.

          • name — required — (String)

            The name of the context.

        • outputContexts — (Array<map>)

          The output contexts that are activated when this intent is fulfilled.

          • name — required — (String)

            The name of the output context.

          • timeToLiveInSeconds — required — (Integer)

            The amount of time, in seconds, that the output context should remain active. The time is figured from the first time the context is sent to the user.

          • turnsToLive — required — (Integer)

            The number of conversation turns that the output context should remain active. The number of turns is counted from the first time that the context is sent to the user.

        • lastUpdatedDateTime — (Date)

          The timestamp of the date and time that the intent was last updated.

      • nextToken — (String)

        A token that indicates whether there are more results to return in a response to the ListIntents operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListIntents operation request to get the next page of results.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listSlots(params = {}, callback) ⇒ AWS.Request

Gets a list of slots that match the specified criteria.

Service Reference:

Examples:

Calling the listSlots operation

var params = {
  botId: 'STRING_VALUE', /* required */
  botVersion: 'STRING_VALUE', /* required */
  intentId: 'STRING_VALUE', /* required */
  localeId: 'STRING_VALUE', /* required */
  filters: [
    {
      name: SlotName, /* required */
      operator: CO | EQ, /* required */
      values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  sortBy: {
    attribute: SlotName | LastUpdatedDateTime, /* required */
    order: Ascending | Descending /* required */
  }
};
lexmodelsv2.listSlots(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • botId — (String)

      The identifier of the bot that contains the slot.

    • botVersion — (String)

      The version of the bot that contains the slot.

    • localeId — (String)

      The identifier of the language and locale of the slots to list. The string must match one of the supported locales. For more information, see Supported languages.

    • intentId — (String)

      The unique identifier of the intent that contains the slot.

    • sortBy — (map)

      Determines the sort order for the response from the ListSlots operation. You can choose to sort by the slot name or last updated date in either ascending or descending order.

      • attribute — required — (String)

        The attribute to use to sort the list.

        Possible values include:
        • "SlotName"
        • "LastUpdatedDateTime"
      • order — required — (String)

        The order to sort the list. You can choose ascending or descending.

        Possible values include:
        • "Ascending"
        • "Descending"
    • filters — (Array<map>)

      Provides the specification of a filter used to limit the slots in the response to only those that match the filter specification. You can only specify one filter and only one string to filter on.

      • name — required — (String)

        The name of the field to use for filtering.

        Possible values include:
        • "SlotName"
      • values — required — (Array<String>)

        The value to use to filter the response.

      • operator — required — (String)

        The operator to use for the filter. Specify EQ when the ListSlots operation should return only aliases that equal the specified value. Specify CO when the ListSlots operation should return aliases that contain the specified value.

        Possible values include:
        • "CO"
        • "EQ"
    • maxResults — (Integer)

      The maximum number of slots to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.

    • nextToken — (String)

      If the response from the ListSlots operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • botId — (String)

        The identifier of the bot that contains the slots.

      • botVersion — (String)

        The version of the bot that contains the slots.

      • localeId — (String)

        The language and locale of the slots in the list.

      • intentId — (String)

        The identifier of the intent that contains the slots.

      • slotSummaries — (Array<map>)

        Summary information for the slots that meet the filter criteria specified in the request. The length of the list is specified in the maxResults parameter of the request. If there are more slots available, the nextToken field contains a token to get the next page of results.

        • slotId — (String)

          The unique identifier of the slot.

        • slotName — (String)

          The name given to the slot.

        • description — (String)

          The description of the slot.

        • slotConstraint — (String)

          Whether the slot is required or optional. An intent is complete when all required slots are filled.

          Possible values include:
          • "Required"
          • "Optional"
        • slotTypeId — (String)

          The unique identifier for the slot type that defines the values for the slot.

        • valueElicitationPromptSpecification — (map)

          Prompts that are sent to the user to elicit a value for the slot.

          • messageGroups — required — (Array<map>)

            A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.

            • message — required — (map)

              The primary message that Amazon Lex should send to the user.

              • plainTextMessage — (map)

                A message in plain text format.

                • value — required — (String)

                  The message to send to the user.

              • customPayload — (map)

                A message in a custom format defined by the client application.

                • value — required — (String)

                  The string that is sent to your application.

              • ssmlMessage — (map)

                A message in Speech Synthesis Markup Language (SSML).

                • value — required — (String)

                  The SSML text that defines the prompt.

              • imageResponseCard — (map)

                A message that defines a response card that the client application can show to the user.

                • title — required — (String)

                  The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                • subtitle — (String)

                  The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                • imageUrl — (String)

                  The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                • buttons — (Array<map>)

                  A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                  • text — required — (String)

                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                  • value — required — (String)

                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

            • variations — (Array<map>)

              Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

              • plainTextMessage — (map)

                A message in plain text format.

                • value — required — (String)

                  The message to send to the user.

              • customPayload — (map)

                A message in a custom format defined by the client application.

                • value — required — (String)

                  The string that is sent to your application.

              • ssmlMessage — (map)

                A message in Speech Synthesis Markup Language (SSML).

                • value — required — (String)

                  The SSML text that defines the prompt.

              • imageResponseCard — (map)

                A message that defines a response card that the client application can show to the user.

                • title — required — (String)

                  The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                • subtitle — (String)

                  The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                • imageUrl — (String)

                  The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                • buttons — (Array<map>)

                  A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                  • text — required — (String)

                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                  • value — required — (String)

                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

          • maxRetries — required — (Integer)

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

          • allowInterrupt — (Boolean)

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

        • lastUpdatedDateTime — (Date)

          The timestamp of the last date and time that the slot was updated.

      • nextToken — (String)

        A token that indicates whether there are more results to return in a response to the ListSlots operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListSlots operation request to get the next page of results.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listSlotTypes(params = {}, callback) ⇒ AWS.Request

Gets a list of slot types that match the specified criteria.

Service Reference:

Examples:

Calling the listSlotTypes operation

var params = {
  botId: 'STRING_VALUE', /* required */
  botVersion: 'STRING_VALUE', /* required */
  localeId: 'STRING_VALUE', /* required */
  filters: [
    {
      name: SlotTypeName, /* required */
      operator: CO | EQ, /* required */
      values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  sortBy: {
    attribute: SlotTypeName | LastUpdatedDateTime, /* required */
    order: Ascending | Descending /* required */
  }
};
lexmodelsv2.listSlotTypes(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • botId — (String)

      The unique identifier of the bot that contains the slot types.

    • botVersion — (String)

      The version of the bot that contains the slot type.

    • localeId — (String)

      The identifier of the language and locale of the slot types to list. The string must match one of the supported locales. For more information, see Supported languages.

    • sortBy — (map)

      Determines the sort order for the response from the ListSlotTypes operation. You can choose to sort by the slot type name or last updated date in either ascending or descending order.

      • attribute — required — (String)

        The attribute to use to sort the list of slot types.

        Possible values include:
        • "SlotTypeName"
        • "LastUpdatedDateTime"
      • order — required — (String)

        The order to sort the list. You can say ascending or descending.

        Possible values include:
        • "Ascending"
        • "Descending"
    • filters — (Array<map>)

      Provides the specification of a filter used to limit the slot types in the response to only those that match the filter specification. You can only specify one filter and only one string to filter on.

      • name — required — (String)

        The name of the field to use for filtering.

        Possible values include:
        • "SlotTypeName"
      • values — required — (Array<String>)

        The value to use to filter the response.

      • operator — required — (String)

        The operator to use for the filter. Specify EQ when the ListSlotTypes operation should return only aliases that equal the specified value. Specify CO when the ListSlotTypes operation should return aliases that contain the specified value.

        Possible values include:
        • "CO"
        • "EQ"
    • maxResults — (Integer)

      The maximum number of slot types to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.

    • nextToken — (String)

      If the response from the ListSlotTypes operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • botId — (String)

        The identifier of the bot that contains the slot types.

      • botVersion — (String)

        The version of the bot that contains the slot types.

      • localeId — (String)

        The language and local of the slot types in the list.

      • slotTypeSummaries — (Array<map>)

        Summary information for the slot types that meet the filter criteria specified in the request. The length of the list is specified in the maxResults parameter of the request. If there are more slot types available, the nextToken field contains a token to get the next page of results.

        • slotTypeId — (String)

          The unique identifier assigned to the slot type.

        • slotTypeName — (String)

          The name of the slot type.

        • description — (String)

          The description of the slot type.

        • parentSlotTypeSignature — (String)

          If the slot type is derived from a built-on slot type, the name of the parent slot type.

        • lastUpdatedDateTime — (Date)

          A timestamp of the date and time that the slot type was last updated.

      • nextToken — (String)

        A token that indicates whether there are more results to return in a response to the ListSlotTypes operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListSlotTypes operation request to get the next page of results.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Gets a list of tags associated with a resource. Only bots, bot aliases, and bot channels can have tags associated with them.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  resourceARN: 'STRING_VALUE' /* required */
};
lexmodelsv2.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • resourceARN — (String)

      The Amazon Resource Name (ARN) of the resource to get a list of tags for.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • tags — (map<String>)

        The tags associated with a resource.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

startImport(params = {}, callback) ⇒ AWS.Request

Starts importing a bot or bot locale from a zip archive that you uploaded to an S3 bucket.

Service Reference:

Examples:

Calling the startImport operation

var params = {
  importId: 'STRING_VALUE', /* required */
  mergeStrategy: Overwrite | FailOnConflict, /* required */
  resourceSpecification: { /* required */
    botImportSpecification: {
      botName: 'STRING_VALUE', /* required */
      dataPrivacy: { /* required */
        childDirected: true || false /* required */
      },
      roleArn: 'STRING_VALUE', /* required */
      botTags: {
        '<TagKey>': 'STRING_VALUE',
        /* '<TagKey>': ... */
      },
      idleSessionTTLInSeconds: 'NUMBER_VALUE',
      testBotAliasTags: {
        '<TagKey>': 'STRING_VALUE',
        /* '<TagKey>': ... */
      }
    },
    botLocaleImportSpecification: {
      botId: 'STRING_VALUE', /* required */
      botVersion: 'STRING_VALUE', /* required */
      localeId: 'STRING_VALUE', /* required */
      nluIntentConfidenceThreshold: 'NUMBER_VALUE',
      voiceSettings: {
        voiceId: 'STRING_VALUE' /* required */
      }
    }
  },
  filePassword: 'STRING_VALUE'
};
lexmodelsv2.startImport(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • importId — (String)

      The unique identifier for the import. It is included in the response from the operation.

    • resourceSpecification — (map)

      Parameters for creating the bot or bot locale.

      • botImportSpecification — (map)

        Parameters for importing a bot.

        • botName — required — (String)

          The name that Amazon Lex should use for the bot.

        • roleArn — required — (String)

          The Amazon Resource Name (ARN) of the IAM role used to build and run the bot.

        • dataPrivacy — required — (map)

          By default, data stored by Amazon Lex is encrypted. The DataPrivacy structure provides settings that determine how Amazon Lex handles special cases of securing the data for your bot.

          • childDirected — required — (Boolean)

            For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying true or false in the childDirected field. By specifying true in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ.

        • idleSessionTTLInSeconds — (Integer)

          The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.

          A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Lex deletes any data provided before the timeout.

          You can specify between 60 (1 minute) and 86,400 (24 hours) seconds.

        • botTags — (map<String>)

          A list of tags to add to the bot. You can only add tags when you import a bot. You can't use the UpdateBot operation to update tags. To update tags, use the TagResource operation.

        • testBotAliasTags — (map<String>)

          A list of tags to add to the test alias for a bot. You can only add tags when you import a bot. You can't use the UpdateAlias operation to update tags. To update tags on the test alias, use the TagResource operation.

      • botLocaleImportSpecification — (map)

        Parameters for importing a bot locale.

        • botId — required — (String)

          The identifier of the bot to import the locale to.

        • botVersion — required — (String)

          The version of the bot to import the locale to. This can only be the DRAFT version of the bot.

        • localeId — required — (String)

          The identifier of the language and locale that the bot will be used in. The string must match one of the supported locales. All of the intents, slot types, and slots used in the bot must have the same locale. For more information, see Supported languages.

        • nluIntentConfidenceThreshold — (Float)

          Determines the threshold where Amazon Lex will insert the AMAZON.FallbackIntent, AMAZON.KendraSearchIntent, or both when returning alternative intents. AMAZON.FallbackIntent and AMAZON.KendraSearchIntent are only inserted if they are configured for the bot.

          For example, suppose a bot is configured with the confidence threshold of 0.80 and the AMAZON.FallbackIntent. Amazon Lex returns three alternative intents with the following confidence scores: IntentA (0.70), IntentB (0.60), IntentC (0.50). The response from the PostText operation would be:

          • AMAZON.FallbackIntent

          • IntentA

          • IntentB

          • IntentC

        • voiceSettings — (map)

          Defines settings for using an Amazon Polly voice to communicate with a user.

          • voiceId — required — (String)

            The identifier of the Amazon Polly voice to use.

    • mergeStrategy — (String)

      The strategy to use when there is a name conflict between the imported resource and an existing resource. When the merge strategy is FailOnConflict existing resources are not overwritten and the import fails.

      Possible values include:
      • "Overwrite"
      • "FailOnConflict"
    • filePassword — (String)

      The password used to encrypt the zip archive that contains the bot or bot locale definition. You should always encrypt the zip archive to protect it during transit between your site and Amazon Lex.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • importId — (String)

        A unique identifier for the import.

      • resourceSpecification — (map)

        The parameters used when importing the bot or bot locale.

        • botImportSpecification — (map)

          Parameters for importing a bot.

          • botName — required — (String)

            The name that Amazon Lex should use for the bot.

          • roleArn — required — (String)

            The Amazon Resource Name (ARN) of the IAM role used to build and run the bot.

          • dataPrivacy — required — (map)

            By default, data stored by Amazon Lex is encrypted. The DataPrivacy structure provides settings that determine how Amazon Lex handles special cases of securing the data for your bot.

            • childDirected — required — (Boolean)

              For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying true or false in the childDirected field. By specifying true in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ.

          • idleSessionTTLInSeconds — (Integer)

            The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.

            A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Lex deletes any data provided before the timeout.

            You can specify between 60 (1 minute) and 86,400 (24 hours) seconds.

          • botTags — (map<String>)

            A list of tags to add to the bot. You can only add tags when you import a bot. You can't use the UpdateBot operation to update tags. To update tags, use the TagResource operation.

          • testBotAliasTags — (map<String>)

            A list of tags to add to the test alias for a bot. You can only add tags when you import a bot. You can't use the UpdateAlias operation to update tags. To update tags on the test alias, use the TagResource operation.

        • botLocaleImportSpecification — (map)

          Parameters for importing a bot locale.

          • botId — required — (String)

            The identifier of the bot to import the locale to.

          • botVersion — required — (String)

            The version of the bot to import the locale to. This can only be the DRAFT version of the bot.

          • localeId — required — (String)

            The identifier of the language and locale that the bot will be used in. The string must match one of the supported locales. All of the intents, slot types, and slots used in the bot must have the same locale. For more information, see Supported languages.

          • nluIntentConfidenceThreshold — (Float)

            Determines the threshold where Amazon Lex will insert the AMAZON.FallbackIntent, AMAZON.KendraSearchIntent, or both when returning alternative intents. AMAZON.FallbackIntent and AMAZON.KendraSearchIntent are only inserted if they are configured for the bot.

            For example, suppose a bot is configured with the confidence threshold of 0.80 and the AMAZON.FallbackIntent. Amazon Lex returns three alternative intents with the following confidence scores: IntentA (0.70), IntentB (0.60), IntentC (0.50). The response from the PostText operation would be:

            • AMAZON.FallbackIntent

            • IntentA

            • IntentB

            • IntentC

          • voiceSettings — (map)

            Defines settings for using an Amazon Polly voice to communicate with a user.

            • voiceId — required — (String)

              The identifier of the Amazon Polly voice to use.

      • mergeStrategy — (String)

        The strategy used when there was a name conflict between the imported resource and an existing resource. When the merge strategy is FailOnConflict existing resources are not overwritten and the import fails.

        Possible values include:
        • "Overwrite"
        • "FailOnConflict"
      • importStatus — (String)

        The current status of the import. When the status is Complete the bot or bot alias is ready to use.

        Possible values include:
        • "InProgress"
        • "Completed"
        • "Failed"
        • "Deleting"
      • creationDateTime — (Date)

        The date and time that the import request was created.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

tagResource(params = {}, callback) ⇒ AWS.Request

Adds the specified tags to the specified resource. If a tag key already exists, the existing value is replaced with the new value.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  resourceARN: 'STRING_VALUE', /* required */
  tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
lexmodelsv2.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • resourceARN — (String)

      The Amazon Resource Name (ARN) of the bot, bot alias, or bot channel to tag.

    • tags — (map<String>)

      A list of tag keys to add to the resource. If a tag key already exists, the existing value is replaced with the new value.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

untagResource(params = {}, callback) ⇒ AWS.Request

Removes tags from a bot, bot alias, or bot channel.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  resourceARN: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
lexmodelsv2.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • resourceARN — (String)

      The Amazon Resource Name (ARN) of the resource to remove the tags from.

    • tagKeys — (Array<String>)

      A list of tag keys to remove from the resource. If a tag key does not exist on the resource, it is ignored.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateBot(params = {}, callback) ⇒ AWS.Request

Updates the configuration of an existing bot.

Service Reference:

Examples:

Calling the updateBot operation

var params = {
  botId: 'STRING_VALUE', /* required */
  botName: 'STRING_VALUE', /* required */
  dataPrivacy: { /* required */
    childDirected: true || false /* required */
  },
  idleSessionTTLInSeconds: 'NUMBER_VALUE', /* required */
  roleArn: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE'
};
lexmodelsv2.updateBot(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • botId — (String)

      The unique identifier of the bot to update. This identifier is returned by the CreateBot operation.

    • botName — (String)

      The new name of the bot. The name must be unique in the account that creates the bot.

    • description — (String)

      A description of the bot.

    • roleArn — (String)

      The Amazon Resource Name (ARN) of an IAM role that has permissions to access the bot.

    • dataPrivacy — (map)

      Provides information on additional privacy protections Amazon Lex should use with the bot's data.

      • childDirected — required — (Boolean)

        For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying true or false in the childDirected field. By specifying true in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ.

    • idleSessionTTLInSeconds — (Integer)

      The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.

      A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Lex deletes any data provided before the timeout.

      You can specify between 60 (1 minute) and 86,400 (24 hours) seconds.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • botId — (String)

        The unique identifier of the bot that was updated.

      • botName — (String)

        The name of the bot after the update.

      • description — (String)

        The description of the bot after the update.

      • roleArn — (String)

        The Amazon Resource Name (ARN) of the IAM role used by the bot after the update.

      • dataPrivacy — (map)

        The data privacy settings for the bot after the update.

        • childDirected — required — (Boolean)

          For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying true or false in the childDirected field. By specifying true in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ.

      • idleSessionTTLInSeconds — (Integer)

        The session timeout, in seconds, for the bot after the update.

      • botStatus — (String)

        Shows the current status of the bot. The bot is first in the Creating status. Once the bot is read for use, it changes to the Available status. After the bot is created, you can use the DRAFT version of the bot.

        Possible values include:
        • "Creating"
        • "Available"
        • "Inactive"
        • "Deleting"
        • "Failed"
        • "Versioning"
        • "Importing"
      • creationDateTime — (Date)

        A timestamp of the date and time that the bot was created.

      • lastUpdatedDateTime — (Date)

        A timestamp of the date and time that the bot was last updated.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateBotAlias(params = {}, callback) ⇒ AWS.Request

Updates the configuration of an existing bot alias.

Service Reference:

Examples:

Calling the updateBotAlias operation

var params = {
  botAliasId: 'STRING_VALUE', /* required */
  botAliasName: 'STRING_VALUE', /* required */
  botId: 'STRING_VALUE', /* required */
  botAliasLocaleSettings: {
    '<LocaleId>': {
      enabled: true || false, /* required */
      codeHookSpecification: {
        lambdaCodeHook: { /* required */
          codeHookInterfaceVersion: 'STRING_VALUE', /* required */
          lambdaARN: 'STRING_VALUE' /* required */
        }
      }
    },
    /* '<LocaleId>': ... */
  },
  botVersion: 'STRING_VALUE',
  conversationLogSettings: {
    audioLogSettings: [
      {
        destination: { /* required */
          s3Bucket: { /* required */
            logPrefix: 'STRING_VALUE', /* required */
            s3BucketArn: 'STRING_VALUE', /* required */
            kmsKeyArn: 'STRING_VALUE'
          }
        },
        enabled: true || false /* required */
      },
      /* more items */
    ],
    textLogSettings: [
      {
        destination: { /* required */
          cloudWatch: { /* required */
            cloudWatchLogGroupArn: 'STRING_VALUE', /* required */
            logPrefix: 'STRING_VALUE' /* required */
          }
        },
        enabled: true || false /* required */
      },
      /* more items */
    ]
  },
  description: 'STRING_VALUE',
  sentimentAnalysisSettings: {
    detectSentiment: true || false /* required */
  }
};
lexmodelsv2.updateBotAlias(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • botAliasId — (String)

      The unique identifier of the bot alias.

    • botAliasName — (String)

      The new name to assign to the bot alias.

    • description — (String)

      The new description to assign to the bot alias.

    • botVersion — (String)

      The new bot version to assign to the bot alias.

    • botAliasLocaleSettings — (map<map>)

      The new Lambda functions to use in each locale for the bot alias.

      • enabled — required — (Boolean)

        Determines whether the locale is enabled for the bot. If the value is false, the locale isn't available for use.

      • codeHookSpecification — (map)

        Specifies the Lambda function that should be used in the locale.

        • lambdaCodeHook — required — (map)

          Specifies a Lambda function that verifies requests to a bot or fulfills the user's request to a bot.

          • lambdaARN — required — (String)

            The Amazon Resource Name (ARN) of the Lambda function.

          • codeHookInterfaceVersion — required — (String)

            The version of the request-response that you want Amazon Lex to use to invoke your Lambda function.

    • conversationLogSettings — (map)

      The new settings for storing conversation logs in Amazon CloudWatch Logs and Amazon S3 buckets.

      • textLogSettings — (Array<map>)

        The Amazon CloudWatch Logs settings for logging text and metadata.

        • enabled — required — (Boolean)

          Determines whether conversation logs should be stored for an alias.

        • destination — required — (map)

          Defines the Amazon CloudWatch Logs destination log group for conversation text logs.

          • cloudWatch — required — (map)

            Defines the Amazon CloudWatch Logs log group where text and metadata logs are delivered.

            • cloudWatchLogGroupArn — required — (String)

              The Amazon Resource Name (ARN) of the log group where text and metadata logs are delivered.

            • logPrefix — required — (String)

              The prefix of the log stream name within the log group that you specified

      • audioLogSettings — (Array<map>)

        The Amazon S3 settings for logging audio to an S3 bucket.

        • enabled — required — (Boolean)

          Determines whether audio logging in enabled for the bot.

        • destination — required — (map)

          The location of audio log files collected when conversation logging is enabled for a bot.

          • s3Bucket — required — (map)

            The Amazon S3 bucket where the audio log files are stored. The IAM role specified in the roleArn parameter of the CreateBot operation must have permission to write to this bucket.

            • kmsKeyArn — (String)

              The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key for encrypting audio log files stored in an S3 bucket.

            • s3BucketArn — required — (String)

              The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio log files are stored.

            • logPrefix — required — (String)

              The S3 prefix to assign to audio log files.

    • sentimentAnalysisSettings — (map)

      Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.

      • detectSentiment — required — (Boolean)

        Sets whether Amazon Lex uses Amazon Comprehend to detect the sentiment of user utterances.

    • botId — (String)

      The identifier of the bot with the updated alias.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • botAliasId — (String)

        The identifier of the updated bot alias.

      • botAliasName — (String)

        The updated name of the bot alias.

      • description — (String)

        The updated description of the bot alias.

      • botVersion — (String)

        The updated version of the bot that the alias points to.

      • botAliasLocaleSettings — (map<map>)

        The updated Lambda functions to use in each locale for the bot alias.

        • enabled — required — (Boolean)

          Determines whether the locale is enabled for the bot. If the value is false, the locale isn't available for use.

        • codeHookSpecification — (map)

          Specifies the Lambda function that should be used in the locale.

          • lambdaCodeHook — required — (map)

            Specifies a Lambda function that verifies requests to a bot or fulfills the user's request to a bot.

            • lambdaARN — required — (String)

              The Amazon Resource Name (ARN) of the Lambda function.

            • codeHookInterfaceVersion — required — (String)

              The version of the request-response that you want Amazon Lex to use to invoke your Lambda function.

      • conversationLogSettings — (map)

        The updated settings for storing conversation logs in Amazon CloudWatch Logs and Amazon S3 buckets.

        • textLogSettings — (Array<map>)

          The Amazon CloudWatch Logs settings for logging text and metadata.

          • enabled — required — (Boolean)

            Determines whether conversation logs should be stored for an alias.

          • destination — required — (map)

            Defines the Amazon CloudWatch Logs destination log group for conversation text logs.

            • cloudWatch — required — (map)

              Defines the Amazon CloudWatch Logs log group where text and metadata logs are delivered.

              • cloudWatchLogGroupArn — required — (String)

                The Amazon Resource Name (ARN) of the log group where text and metadata logs are delivered.

              • logPrefix — required — (String)

                The prefix of the log stream name within the log group that you specified

        • audioLogSettings — (Array<map>)

          The Amazon S3 settings for logging audio to an S3 bucket.

          • enabled — required — (Boolean)

            Determines whether audio logging in enabled for the bot.

          • destination — required — (map)

            The location of audio log files collected when conversation logging is enabled for a bot.

            • s3Bucket — required — (map)

              The Amazon S3 bucket where the audio log files are stored. The IAM role specified in the roleArn parameter of the CreateBot operation must have permission to write to this bucket.

              • kmsKeyArn — (String)

                The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key for encrypting audio log files stored in an S3 bucket.

              • s3BucketArn — required — (String)

                The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio log files are stored.

              • logPrefix — required — (String)

                The S3 prefix to assign to audio log files.

      • sentimentAnalysisSettings — (map)

        Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.

        • detectSentiment — required — (Boolean)

          Sets whether Amazon Lex uses Amazon Comprehend to detect the sentiment of user utterances.

      • botAliasStatus — (String)

        The current status of the bot alias. When the status is Available the alias is ready for use.

        Possible values include:
        • "Creating"
        • "Available"
        • "Deleting"
        • "Failed"
      • botId — (String)

        The identifier of the bot with the updated alias.

      • creationDateTime — (Date)

        A timestamp of the date and time that the bot was created.

      • lastUpdatedDateTime — (Date)

        A timestamp of the date and time that the bot was last updated.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateBotLocale(params = {}, callback) ⇒ AWS.Request

Updates the settings that a bot has for a specific locale.

Service Reference:

Examples:

Calling the updateBotLocale operation

var params = {
  botId: 'STRING_VALUE', /* required */
  botVersion: 'STRING_VALUE', /* required */
  localeId: 'STRING_VALUE', /* required */
  nluIntentConfidenceThreshold: 'NUMBER_VALUE', /* required */
  description: 'STRING_VALUE',
  voiceSettings: {
    voiceId: 'STRING_VALUE' /* required */
  }
};
lexmodelsv2.updateBotLocale(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • botId — (String)

      The unique identifier of the bot that contains the locale.

    • botVersion — (String)

      The version of the bot that contains the locale to be updated. The version can only be the DRAFT version.

    • localeId — (String)

      The identifier of the language and locale to update. The string must match one of the supported locales. For more information, see Supported languages.

    • description — (String)

      The new description of the locale.

    • nluIntentConfidenceThreshold — (Float)

      The new confidence threshold where Amazon Lex inserts the AMAZON.FallbackIntent and AMAZON.KendraSearchIntent intents in the list of possible intents for an utterance.

    • voiceSettings — (map)

      The new Amazon Polly voice Amazon Lex should use for voice interaction with the user.

      • voiceId — required — (String)

        The identifier of the Amazon Polly voice to use.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • botId — (String)

        The identifier of the bot that contains the updated locale.

      • botVersion — (String)

        The version of the bot that contains the updated locale.

      • localeId — (String)

        The language and locale of the updated bot locale.

      • localeName — (String)

        The updated locale name for the locale.

      • description — (String)

        The updated description of the locale.

      • nluIntentConfidenceThreshold — (Float)

        The updated confidence threshold for inserting the AMAZON.FallbackIntent and AMAZON.KendraSearchIntent intents in the list of possible intents for an utterance.

      • voiceSettings — (map)

        The updated Amazon Polly voice to use for voice interaction with the user.

        • voiceId — required — (String)

          The identifier of the Amazon Polly voice to use.

      • botLocaleStatus — (String)

        The current status of the locale. When the bot status is Built the locale is ready for use.

        Possible values include:
        • "Creating"
        • "Building"
        • "Built"
        • "ReadyExpressTesting"
        • "Failed"
        • "Deleting"
        • "NotBuilt"
        • "Importing"
      • failureReasons — (Array<String>)

        If the botLocaleStatus is Failed, the failureReasons field lists the errors that occurred while building the bot.

      • creationDateTime — (Date)

        A timestamp of the date and time that the locale was created.

      • lastUpdatedDateTime — (Date)

        A timestamp of the date and time that the locale was last updated.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateExport(params = {}, callback) ⇒ AWS.Request

Updates the password used to protect an export zip archive.

The password is not required. If you don't supply a password, Amazon Lex generates a zip file that is not protected by a password. This is the archive that is available at the pre-signed S3 URL provided by the operation.

Service Reference:

Examples:

Calling the updateExport operation

var params = {
  exportId: 'STRING_VALUE', /* required */
  filePassword: 'STRING_VALUE'
};
lexmodelsv2.updateExport(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • exportId — (String)

      The unique identifier Amazon Lex assigned to the export.

    • filePassword — (String)

      The new password to use to encrypt the export zip archive.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • exportId — (String)

        The unique identifier Amazon Lex assigned to the export.

      • resourceSpecification — (map)

        A description of the type of resource that was exported, either a bot or a bot locale.

        • botExportSpecification — (map)

          Parameters for exporting a bot.

          • botId — required — (String)

            The identifier of the bot assigned by Amazon Lex.

          • botVersion — required — (String)

            The version of the bot that was exported. This will be either DRAFT or the version number.

        • botLocaleExportSpecification — (map)

          Parameters for exporting a bot locale.

          • botId — required — (String)

            The identifier of the bot to create the locale for.

          • botVersion — required — (String)

            The version of the bot to export.

          • localeId — required — (String)

            The identifier of the language and locale to export. The string must match one of the locales in the bot.

      • fileFormat — (String)

        The file format used for the files that define the resource.

        Possible values include:
        • "LexJson"
      • exportStatus — (String)

        The status of the export. When the status is Completed the export archive is available for download.

        Possible values include:
        • "InProgress"
        • "Completed"
        • "Failed"
        • "Deleting"
      • creationDateTime — (Date)

        The date and time that the export was created.

      • lastUpdatedDateTime — (Date)

        The date and time that the export was last updated.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateIntent(params = {}, callback) ⇒ AWS.Request

Updates the settings for an intent.

Service Reference:

Examples:

Calling the updateIntent operation

var params = {
  botId: 'STRING_VALUE', /* required */
  botVersion: 'STRING_VALUE', /* required */
  intentId: 'STRING_VALUE', /* required */
  intentName: 'STRING_VALUE', /* required */
  localeId: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  dialogCodeHook: {
    enabled: true || false /* required */
  },
  fulfillmentCodeHook: {
    enabled: true || false, /* required */
    fulfillmentUpdatesSpecification: {
      active: true || false, /* required */
      startResponse: {
        delayInSeconds: 'NUMBER_VALUE', /* required */
        messageGroups: [ /* required */
          {
            message: { /* required */
              customPayload: {
                value: 'STRING_VALUE' /* required */
              },
              imageResponseCard: {
                title: 'STRING_VALUE', /* required */
                buttons: [
                  {
                    text: 'STRING_VALUE', /* required */
                    value: 'STRING_VALUE' /* required */
                  },
                  /* more items */
                ],
                imageUrl: 'STRING_VALUE',
                subtitle: 'STRING_VALUE'
              },
              plainTextMessage: {
                value: 'STRING_VALUE' /* required */
              },
              ssmlMessage: {
                value: 'STRING_VALUE' /* required */
              }
            },
            variations: [
              {
                customPayload: {
                  value: 'STRING_VALUE' /* required */
                },
                imageResponseCard: {
                  title: 'STRING_VALUE', /* required */
                  buttons: [
                    {
                      text: 'STRING_VALUE', /* required */
                      value: 'STRING_VALUE' /* required */
                    },
                    /* more items */
                  ],
                  imageUrl: 'STRING_VALUE',
                  subtitle: 'STRING_VALUE'
                },
                plainTextMessage: {
                  value: 'STRING_VALUE' /* required */
                },
                ssmlMessage: {
                  value: 'STRING_VALUE' /* required */
                }
              },
              /* more items */
            ]
          },
          /* more items */
        ],
        allowInterrupt: true || false
      },
      timeoutInSeconds: 'NUMBER_VALUE',
      updateResponse: {
        frequencyInSeconds: 'NUMBER_VALUE', /* required */
        messageGroups: [ /* required */
          {
            message: { /* required */
              customPayload: {
                value: 'STRING_VALUE' /* required */
              },
              imageResponseCard: {
                title: 'STRING_VALUE', /* required */
                buttons: [
                  {
                    text: 'STRING_VALUE', /* required */
                    value: 'STRING_VALUE' /* required */
                  },
                  /* more items */
                ],
                imageUrl: 'STRING_VALUE',
                subtitle: 'STRING_VALUE'
              },
              plainTextMessage: {
                value: 'STRING_VALUE' /* required */
              },
              ssmlMessage: {
                value: 'STRING_VALUE' /* required */
              }
            },
            variations: [
              {
                customPayload: {
                  value: 'STRING_VALUE' /* required */
                },
                imageResponseCard: {
                  title: 'STRING_VALUE', /* required */
                  buttons: [
                    {
                      text: 'STRING_VALUE', /* required */
                      value: 'STRING_VALUE' /* required */
                    },
                    /* more items */
                  ],
                  imageUrl: 'STRING_VALUE',
                  subtitle: 'STRING_VALUE'
                },
                plainTextMessage: {
                  value: 'STRING_VALUE' /* required */
                },
                ssmlMessage: {
                  value: 'STRING_VALUE' /* required */
                }
              },
              /* more items */
            ]
          },
          /* more items */
        ],
        allowInterrupt: true || false
      }
    },
    postFulfillmentStatusSpecification: {
      failureResponse: {
        messageGroups: [ /* required */
          {
            message: { /* required */
              customPayload: {
                value: 'STRING_VALUE' /* required */
              },
              imageResponseCard: {
                title: 'STRING_VALUE', /* required */
                buttons: [
                  {
                    text: 'STRING_VALUE', /* required */
                    value: 'STRING_VALUE' /* required */
                  },
                  /* more items */
                ],
                imageUrl: 'STRING_VALUE',
                subtitle: 'STRING_VALUE'
              },
              plainTextMessage: {
                value: 'STRING_VALUE' /* required */
              },
              ssmlMessage: {
                value: 'STRING_VALUE' /* required */
              }
            },
            variations: [
              {
                customPayload: {
                  value: 'STRING_VALUE' /* required */
                },
                imageResponseCard: {
                  title: 'STRING_VALUE', /* required */
                  buttons: [
                    {
                      text: 'STRING_VALUE', /* required */
                      value: 'STRING_VALUE' /* required */
                    },
                    /* more items */
                  ],
                  imageUrl: 'STRING_VALUE',
                  subtitle: 'STRING_VALUE'
                },
                plainTextMessage: {
                  value: 'STRING_VALUE' /* required */
                },
                ssmlMessage: {
                  value: 'STRING_VALUE' /* required */
                }
              },
              /* more items */
            ]
          },
          /* more items */
        ],
        allowInterrupt: true || false
      },
      successResponse: {
        messageGroups: [ /* required */
          {
            message: { /* required */
              customPayload: {
                value: 'STRING_VALUE' /* required */
              },
              imageResponseCard: {
                title: 'STRING_VALUE', /* required */
                buttons: [
                  {
                    text: 'STRING_VALUE', /* required */
                    value: 'STRING_VALUE' /* required */
                  },
                  /* more items */
                ],
                imageUrl: 'STRING_VALUE',
                subtitle: 'STRING_VALUE'
              },
              plainTextMessage: {
                value: 'STRING_VALUE' /* required */
              },
              ssmlMessage: {
                value: 'STRING_VALUE' /* required */
              }
            },
            variations: [
              {
                customPayload: {
                  value: 'STRING_VALUE' /* required */
                },
                imageResponseCard: {
                  title: 'STRING_VALUE', /* required */
                  buttons: [
                    {
                      text: 'STRING_VALUE', /* required */
                      value: 'STRING_VALUE' /* required */
                    },
                    /* more items */
                  ],
                  imageUrl: 'STRING_VALUE',
                  subtitle: 'STRING_VALUE'
                },
                plainTextMessage: {
                  value: 'STRING_VALUE' /* required */
                },
                ssmlMessage: {
                  value: 'STRING_VALUE' /* required */
                }
              },
              /* more items */
            ]
          },
          /* more items */
        ],
        allowInterrupt: true || false
      },
      timeoutResponse: {
        messageGroups: [ /* required */
          {
            message: { /* required */
              customPayload: {
                value: 'STRING_VALUE' /* required */
              },
              imageResponseCard: {
                title: 'STRING_VALUE', /* required */
                buttons: [
                  {
                    text: 'STRING_VALUE', /* required */
                    value: 'STRING_VALUE' /* required */
                  },
                  /* more items */
                ],
                imageUrl: 'STRING_VALUE',
                subtitle: 'STRING_VALUE'
              },
              plainTextMessage: {
                value: 'STRING_VALUE' /* required */
              },
              ssmlMessage: {
                value: 'STRING_VALUE' /* required */
              }
            },
            variations: [
              {
                customPayload: {
                  value: 'STRING_VALUE' /* required */
                },
                imageResponseCard: {
                  title: 'STRING_VALUE', /* required */
                  buttons: [
                    {
                      text: 'STRING_VALUE', /* required */
                      value: 'STRING_VALUE' /* required */
                    },
                    /* more items */
                  ],
                  imageUrl: 'STRING_VALUE',
                  subtitle: 'STRING_VALUE'
                },
                plainTextMessage: {
                  value: 'STRING_VALUE' /* required */
                },
                ssmlMessage: {
                  value: 'STRING_VALUE' /* required */
                }
              },
              /* more items */
            ]
          },
          /* more items */
        ],
        allowInterrupt: true || false
      }
    }
  },
  inputContexts: [
    {
      name: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  intentClosingSetting: {
    closingResponse: { /* required */
      messageGroups: [ /* required */
        {
          message: { /* required */
            customPayload: {
              value: 'STRING_VALUE' /* required */
            },
            imageResponseCard: {
              title: 'STRING_VALUE', /* required */
              buttons: [
                {
                  text: 'STRING_VALUE', /* required */
                  value: 'STRING_VALUE' /* required */
                },
                /* more items */
              ],
              imageUrl: 'STRING_VALUE',
              subtitle: 'STRING_VALUE'
            },
            plainTextMessage: {
              value: 'STRING_VALUE' /* required */
            },
            ssmlMessage: {
              value: 'STRING_VALUE' /* required */
            }
          },
          variations: [
            {
              customPayload: {
                value: 'STRING_VALUE' /* required */
              },
              imageResponseCard: {
                title: 'STRING_VALUE', /* required */
                buttons: [
                  {
                    text: 'STRING_VALUE', /* required */
                    value: 'STRING_VALUE' /* required */
                  },
                  /* more items */
                ],
                imageUrl: 'STRING_VALUE',
                subtitle: 'STRING_VALUE'
              },
              plainTextMessage: {
                value: 'STRING_VALUE' /* required */
              },
              ssmlMessage: {
                value: 'STRING_VALUE' /* required */
              }
            },
            /* more items */
          ]
        },
        /* more items */
      ],
      allowInterrupt: true || false
    },
    active: true || false
  },
  intentConfirmationSetting: {
    declinationResponse: { /* required */
      messageGroups: [ /* required */
        {
          message: { /* required */
            customPayload: {
              value: 'STRING_VALUE' /* required */
            },
            imageResponseCard: {
              title: 'STRING_VALUE', /* required */
              buttons: [
                {
                  text: 'STRING_VALUE', /* required */
                  value: 'STRING_VALUE' /* required */
                },
                /* more items */
              ],
              imageUrl: 'STRING_VALUE',
              subtitle: 'STRING_VALUE'
            },
            plainTextMessage: {
              value: 'STRING_VALUE' /* required */
            },
            ssmlMessage: {
              value: 'STRING_VALUE' /* required */
            }
          },
          variations: [
            {
              customPayload: {
                value: 'STRING_VALUE' /* required */
              },
              imageResponseCard: {
                title: 'STRING_VALUE', /* required */
                buttons: [
                  {
                    text: 'STRING_VALUE', /* required */
                    value: 'STRING_VALUE' /* required */
                  },
                  /* more items */
                ],
                imageUrl: 'STRING_VALUE',
                subtitle: 'STRING_VALUE'
              },
              plainTextMessage: {
                value: 'STRING_VALUE' /* required */
              },
              ssmlMessage: {
                value: 'STRING_VALUE' /* required */
              }
            },
            /* more items */
          ]
        },
        /* more items */
      ],
      allowInterrupt: true || false
    },
    promptSpecification: { /* required */
      maxRetries: 'NUMBER_VALUE', /* required */
      messageGroups: [ /* required */
        {
          message: { /* required */
            customPayload: {
              value: 'STRING_VALUE' /* required */
            },
            imageResponseCard: {
              title: 'STRING_VALUE', /* required */
              buttons: [
                {
                  text: 'STRING_VALUE', /* required */
                  value: 'STRING_VALUE' /* required */
                },
                /* more items */
              ],
              imageUrl: 'STRING_VALUE',
              subtitle: 'STRING_VALUE'
            },
            plainTextMessage: {
              value: 'STRING_VALUE' /* required */
            },
            ssmlMessage: {
              value: 'STRING_VALUE' /* required */
            }
          },
          variations: [
            {
              customPayload: {
                value: 'STRING_VALUE' /* required */
              },
              imageResponseCard: {
                title: 'STRING_VALUE', /* required */
                buttons: [
                  {
                    text: 'STRING_VALUE', /* required */
                    value: 'STRING_VALUE' /* required */
                  },
                  /* more items */
                ],
                imageUrl: 'STRING_VALUE',
                subtitle: 'STRING_VALUE'
              },
              plainTextMessage: {
                value: 'STRING_VALUE' /* required */
              },
              ssmlMessage: {
                value: 'STRING_VALUE' /* required */
              }
            },
            /* more items */
          ]
        },
        /* more items */
      ],
      allowInterrupt: true || false
    },
    active: true || false
  },
  kendraConfiguration: {
    kendraIndex: 'STRING_VALUE', /* required */
    queryFilterString: 'STRING_VALUE',
    queryFilterStringEnabled: true || false
  },
  outputContexts: [
    {
      name: 'STRING_VALUE', /* required */
      timeToLiveInSeconds: 'NUMBER_VALUE', /* required */
      turnsToLive: 'NUMBER_VALUE' /* required */
    },
    /* more items */
  ],
  parentIntentSignature: 'STRING_VALUE',
  sampleUtterances: [
    {
      utterance: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  slotPriorities: [
    {
      priority: 'NUMBER_VALUE', /* required */
      slotId: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
lexmodelsv2.updateIntent(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • intentId — (String)

      The unique identifier of the intent to update.

    • intentName — (String)

      The new name for the intent.

    • description — (String)

      The new description of the intent.

    • parentIntentSignature — (String)

      The signature of the new built-in intent to use as the parent of this intent.

    • sampleUtterances — (Array<map>)

      New utterances used to invoke the intent.

      • utterance — required — (String)

        The sample utterance that Amazon Lex uses to build its machine-learning model to recognize intents.

    • dialogCodeHook — (map)

      The new Lambda function to use between each turn of the conversation with the bot.

      • enabled — required — (Boolean)

        Enables the dialog code hook so that it processes user requests.

    • fulfillmentCodeHook — (map)

      The new Lambda function to call when all of the intents required slots are provided and the intent is ready for fulfillment.

      • enabled — required — (Boolean)

        Indicates whether a Lambda function should be invoked to fulfill a specific intent.

      • postFulfillmentStatusSpecification — (map)

        Provides settings for messages sent to the user for after the Lambda fulfillment function completes. Post-fulfillment messages can be sent for both streaming and non-streaming conversations.

        • successResponse — (map)

          Specifies a list of message groups that Amazon Lex uses to respond the user input.

          • messageGroups — required — (Array<map>)

            A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

            • message — required — (map)

              The primary message that Amazon Lex should send to the user.

              • plainTextMessage — (map)

                A message in plain text format.

                • value — required — (String)

                  The message to send to the user.

              • customPayload — (map)

                A message in a custom format defined by the client application.

                • value — required — (String)

                  The string that is sent to your application.

              • ssmlMessage — (map)

                A message in Speech Synthesis Markup Language (SSML).

                • value — required — (String)

                  The SSML text that defines the prompt.

              • imageResponseCard — (map)

                A message that defines a response card that the client application can show to the user.

                • title — required — (String)

                  The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                • subtitle — (String)

                  The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                • imageUrl — (String)

                  The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                • buttons — (Array<map>)

                  A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                  • text — required — (String)

                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                  • value — required — (String)

                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

            • variations — (Array<map>)

              Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

              • plainTextMessage — (map)

                A message in plain text format.

                • value — required — (String)

                  The message to send to the user.

              • customPayload — (map)

                A message in a custom format defined by the client application.

                • value — required — (String)

                  The string that is sent to your application.

              • ssmlMessage — (map)

                A message in Speech Synthesis Markup Language (SSML).

                • value — required — (String)

                  The SSML text that defines the prompt.

              • imageResponseCard — (map)

                A message that defines a response card that the client application can show to the user.

                • title — required — (String)

                  The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                • subtitle — (String)

                  The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                • imageUrl — (String)

                  The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                • buttons — (Array<map>)

                  A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                  • text — required — (String)

                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                  • value — required — (String)

                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

          • allowInterrupt — (Boolean)

            Indicates whether the user can interrupt a speech response from Amazon Lex.

        • failureResponse — (map)

          Specifies a list of message groups that Amazon Lex uses to respond the user input.

          • messageGroups — required — (Array<map>)

            A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

            • message — required — (map)

              The primary message that Amazon Lex should send to the user.

              • plainTextMessage — (map)

                A message in plain text format.

                • value — required — (String)

                  The message to send to the user.

              • customPayload — (map)

                A message in a custom format defined by the client application.

                • value — required — (String)

                  The string that is sent to your application.

              • ssmlMessage — (map)

                A message in Speech Synthesis Markup Language (SSML).

                • value — required — (String)

                  The SSML text that defines the prompt.

              • imageResponseCard — (map)

                A message that defines a response card that the client application can show to the user.

                • title — required — (String)

                  The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                • subtitle — (String)

                  The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                • imageUrl — (String)

                  The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                • buttons — (Array<map>)

                  A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                  • text — required — (String)

                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                  • value — required — (String)

                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

            • variations — (Array<map>)

              Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

              • plainTextMessage — (map)

                A message in plain text format.

                • value — required — (String)

                  The message to send to the user.

              • customPayload — (map)

                A message in a custom format defined by the client application.

                • value — required — (String)

                  The string that is sent to your application.

              • ssmlMessage — (map)

                A message in Speech Synthesis Markup Language (SSML).

                • value — required — (String)

                  The SSML text that defines the prompt.

              • imageResponseCard — (map)

                A message that defines a response card that the client application can show to the user.

                • title — required — (String)

                  The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                • subtitle — (String)

                  The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                • imageUrl — (String)

                  The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                • buttons — (Array<map>)

                  A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                  • text — required — (String)

                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                  • value — required — (String)

                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

          • allowInterrupt — (Boolean)

            Indicates whether the user can interrupt a speech response from Amazon Lex.

        • timeoutResponse — (map)

          Specifies a list of message groups that Amazon Lex uses to respond the user input.

          • messageGroups — required — (Array<map>)

            A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

            • message — required — (map)

              The primary message that Amazon Lex should send to the user.

              • plainTextMessage — (map)

                A message in plain text format.

                • value — required — (String)

                  The message to send to the user.

              • customPayload — (map)

                A message in a custom format defined by the client application.

                • value — required — (String)

                  The string that is sent to your application.

              • ssmlMessage — (map)

                A message in Speech Synthesis Markup Language (SSML).

                • value — required — (String)

                  The SSML text that defines the prompt.

              • imageResponseCard — (map)

                A message that defines a response card that the client application can show to the user.

                • title — required — (String)

                  The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                • subtitle — (String)

                  The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                • imageUrl — (String)

                  The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                • buttons — (Array<map>)

                  A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                  • text — required — (String)

                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                  • value — required — (String)

                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

            • variations — (Array<map>)

              Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

              • plainTextMessage — (map)

                A message in plain text format.

                • value — required — (String)

                  The message to send to the user.

              • customPayload — (map)

                A message in a custom format defined by the client application.

                • value — required — (String)

                  The string that is sent to your application.

              • ssmlMessage — (map)

                A message in Speech Synthesis Markup Language (SSML).

                • value — required — (String)

                  The SSML text that defines the prompt.

              • imageResponseCard — (map)

                A message that defines a response card that the client application can show to the user.

                • title — required — (String)

                  The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                • subtitle — (String)

                  The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                • imageUrl — (String)

                  The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                • buttons — (Array<map>)

                  A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                  • text — required — (String)

                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                  • value — required — (String)

                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

          • allowInterrupt — (Boolean)

            Indicates whether the user can interrupt a speech response from Amazon Lex.

      • fulfillmentUpdatesSpecification — (map)

        Provides settings for update messages sent to the user for long-running Lambda fulfillment functions. Fulfillment updates can be used only with streaming conversations.

        • active — required — (Boolean)

          Determines whether fulfillment updates are sent to the user. When this field is true, updates are sent.

          If the active field is set to true, the startResponse, updateResponse, and timeoutInSeconds fields are required.

        • startResponse — (map)

          Provides configuration information for the message sent to users when the fulfillment Lambda functions starts running.

          • delayInSeconds — required — (Integer)

            The delay between when the Lambda fulfillment function starts running and the start message is played. If the Lambda function returns before the delay is over, the start message isn't played.

          • messageGroups — required — (Array<map>)

            One to 5 message groups that contain start messages. Amazon Lex chooses one of the messages to play to the user.

            • message — required — (map)

              The primary message that Amazon Lex should send to the user.

              • plainTextMessage — (map)

                A message in plain text format.

                • value — required — (String)

                  The message to send to the user.

              • customPayload — (map)

                A message in a custom format defined by the client application.

                • value — required — (String)

                  The string that is sent to your application.

              • ssmlMessage — (map)

                A message in Speech Synthesis Markup Language (SSML).

                • value — required — (String)

                  The SSML text that defines the prompt.

              • imageResponseCard — (map)

                A message that defines a response card that the client application can show to the user.

                • title — required — (String)

                  The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                • subtitle — (String)

                  The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                • imageUrl — (String)

                  The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                • buttons — (Array<map>)

                  A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                  • text — required — (String)

                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                  • value — required — (String)

                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

            • variations — (Array<map>)

              Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

              • plainTextMessage — (map)

                A message in plain text format.

                • value — required — (String)

                  The message to send to the user.

              • customPayload — (map)

                A message in a custom format defined by the client application.

                • value — required — (String)

                  The string that is sent to your application.

              • ssmlMessage — (map)

                A message in Speech Synthesis Markup Language (SSML).

                • value — required — (String)

                  The SSML text that defines the prompt.

              • imageResponseCard — (map)

                A message that defines a response card that the client application can show to the user.

                • title — required — (String)

                  The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                • subtitle — (String)

                  The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                • imageUrl — (String)

                  The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                • buttons — (Array<map>)

                  A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                  • text — required — (String)

                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                  • value — required — (String)

                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

          • allowInterrupt — (Boolean)

            Determines whether the user can interrupt the start message while it is playing.

        • updateResponse — (map)

          Provides configuration information for messages sent periodically to the user while the fulfillment Lambda function is running.

          • frequencyInSeconds — required — (Integer)

            The frequency that a message is sent to the user. When the period ends, Amazon Lex chooses a message from the message groups and plays it to the user. If the fulfillment Lambda returns before the first period ends, an update message is not played to the user.

          • messageGroups — required — (Array<map>)

            One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.

            • message — required — (map)

              The primary message that Amazon Lex should send to the user.

              • plainTextMessage — (map)

                A message in plain text format.

                • value — required — (String)

                  The message to send to the user.

              • customPayload — (map)

                A message in a custom format defined by the client application.

                • value — required — (String)

                  The string that is sent to your application.

              • ssmlMessage — (map)

                A message in Speech Synthesis Markup Language (SSML).

                • value — required — (String)

                  The SSML text that defines the prompt.

              • imageResponseCard — (map)

                A message that defines a response card that the client application can show to the user.

                • title — required — (String)

                  The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                • subtitle — (String)

                  The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                • imageUrl — (String)

                  The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                • buttons — (Array<map>)

                  A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                  • text — required — (String)

                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                  • value — required — (String)

                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

            • variations — (Array<map>)

              Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

              • plainTextMessage — (map)

                A message in plain text format.

                • value — required — (String)

                  The message to send to the user.

              • customPayload — (map)

                A message in a custom format defined by the client application.

                • value — required — (String)

                  The string that is sent to your application.

              • ssmlMessage — (map)

                A message in Speech Synthesis Markup Language (SSML).

                • value — required — (String)

                  The SSML text that defines the prompt.

              • imageResponseCard — (map)

                A message that defines a response card that the client application can show to the user.

                • title — required — (String)

                  The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                • subtitle — (String)

                  The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                • imageUrl — (String)

                  The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                • buttons — (Array<map>)

                  A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                  • text — required — (String)

                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                  • value — required — (String)

                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

          • allowInterrupt — (Boolean)

            Determines whether the user can interrupt an update message while it is playing.

        • timeoutInSeconds — (Integer)

          The length of time that the fulfillment Lambda function should run before it times out.

    • slotPriorities — (Array<map>)

      A new list of slots and their priorities that are contained by the intent.

      • priority — required — (Integer)

        The priority that a slot should be elicited.

      • slotId — required — (String)

        The unique identifier of the slot.

    • intentConfirmationSetting — (map)

      New prompts that Amazon Lex sends to the user to confirm the completion of an intent.

      • promptSpecification — required — (map)

        Prompts the user to confirm the intent. This question should have a yes or no answer.

        Amazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for fulfillment. For example, with the OrderPizza intent, you might want to confirm that the order is correct before placing it. For other intents, such as intents that simply respond to user questions, you might not need to ask the user for confirmation before providing the information.

        • messageGroups — required — (Array<map>)

          A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.

          • message — required — (map)

            The primary message that Amazon Lex should send to the user.

            • plainTextMessage — (map)

              A message in plain text format.

              • value — required — (String)

                The message to send to the user.

            • customPayload — (map)

              A message in a custom format defined by the client application.

              • value — required — (String)

                The string that is sent to your application.

            • ssmlMessage — (map)

              A message in Speech Synthesis Markup Language (SSML).

              • value — required — (String)

                The SSML text that defines the prompt.

            • imageResponseCard — (map)

              A message that defines a response card that the client application can show to the user.

              • title — required — (String)

                The title to display on the response card. The format of the title is determined by the platform displaying the response card.

              • subtitle — (String)

                The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

              • imageUrl — (String)

                The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

              • buttons — (Array<map>)

                A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                • text — required — (String)

                  The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                • value — required — (String)

                  The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

          • variations — (Array<map>)

            Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

            • plainTextMessage — (map)

              A message in plain text format.

              • value — required — (String)

                The message to send to the user.

            • customPayload — (map)

              A message in a custom format defined by the client application.

              • value — required — (String)

                The string that is sent to your application.

            • ssmlMessage — (map)

              A message in Speech Synthesis Markup Language (SSML).

              • value — required — (String)

                The SSML text that defines the prompt.

            • imageResponseCard — (map)

              A message that defines a response card that the client application can show to the user.

              • title — required — (String)

                The title to display on the response card. The format of the title is determined by the platform displaying the response card.

              • subtitle — (String)

                The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

              • imageUrl — (String)

                The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

              • buttons — (Array<map>)

                A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                • text — required — (String)

                  The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                • value — required — (String)

                  The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

        • maxRetries — required — (Integer)

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

        • allowInterrupt — (Boolean)

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

      • declinationResponse — required — (map)

        When the user answers "no" to the question defined in promptSpecification, Amazon Lex responds with this response to acknowledge that the intent was canceled.

        • messageGroups — required — (Array<map>)

          A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

          • message — required — (map)

            The primary message that Amazon Lex should send to the user.

            • plainTextMessage — (map)

              A message in plain text format.

              • value — required — (String)

                The message to send to the user.

            • customPayload — (map)

              A message in a custom format defined by the client application.

              • value — required — (String)

                The string that is sent to your application.

            • ssmlMessage — (map)

              A message in Speech Synthesis Markup Language (SSML).

              • value — required — (String)

                The SSML text that defines the prompt.

            • imageResponseCard — (map)

              A message that defines a response card that the client application can show to the user.

              • title — required — (String)

                The title to display on the response card. The format of the title is determined by the platform displaying the response card.

              • subtitle — (String)

                The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

              • imageUrl — (String)

                The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

              • buttons — (Array<map>)

                A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                • text — required — (String)

                  The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                • value — required — (String)

                  The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

          • variations — (Array<map>)

            Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

            • plainTextMessage — (map)

              A message in plain text format.

              • value — required — (String)

                The message to send to the user.

            • customPayload — (map)

              A message in a custom format defined by the client application.

              • value — required — (String)

                The string that is sent to your application.

            • ssmlMessage — (map)

              A message in Speech Synthesis Markup Language (SSML).

              • value — required — (String)

                The SSML text that defines the prompt.

            • imageResponseCard — (map)

              A message that defines a response card that the client application can show to the user.

              • title — required — (String)

                The title to display on the response card. The format of the title is determined by the platform displaying the response card.

              • subtitle — (String)

                The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

              • imageUrl — (String)

                The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

              • buttons — (Array<map>)

                A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                • text — required — (String)

                  The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                • value — required — (String)

                  The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

        • allowInterrupt — (Boolean)

          Indicates whether the user can interrupt a speech response from Amazon Lex.

      • active — (Boolean)

        Specifies whether the intent's confirmation is sent to the user. When this field is false, confirmation and declination responses aren't sent. If the active field isn't specified, the default is true.

    • intentClosingSetting — (map)

      The new response that Amazon Lex sends the user when the intent is closed.

      • closingResponse — required — (map)

        The response that Amazon Lex sends to the user when the intent is complete.

        • messageGroups — required — (Array<map>)

          A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

          • message — required — (map)

            The primary message that Amazon Lex should send to the user.

            • plainTextMessage — (map)

              A message in plain text format.

              • value — required — (String)

                The message to send to the user.

            • customPayload — (map)

              A message in a custom format defined by the client application.

              • value — required — (String)

                The string that is sent to your application.

            • ssmlMessage — (map)

              A message in Speech Synthesis Markup Language (SSML).

              • value — required — (String)

                The SSML text that defines the prompt.

            • imageResponseCard — (map)

              A message that defines a response card that the client application can show to the user.

              • title — required — (String)

                The title to display on the response card. The format of the title is determined by the platform displaying the response card.

              • subtitle — (String)

                The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

              • imageUrl — (String)

                The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

              • buttons — (Array<map>)

                A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                • text — required — (String)

                  The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                • value — required — (String)

                  The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

          • variations — (Array<map>)

            Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

            • plainTextMessage — (map)

              A message in plain text format.

              • value — required — (String)

                The message to send to the user.

            • customPayload — (map)

              A message in a custom format defined by the client application.

              • value — required — (String)

                The string that is sent to your application.

            • ssmlMessage — (map)

              A message in Speech Synthesis Markup Language (SSML).

              • value — required — (String)

                The SSML text that defines the prompt.

            • imageResponseCard — (map)

              A message that defines a response card that the client application can show to the user.

              • title — required — (String)

                The title to display on the response card. The format of the title is determined by the platform displaying the response card.

              • subtitle — (String)

                The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

              • imageUrl — (String)

                The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

              • buttons — (Array<map>)

                A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                • text — required — (String)

                  The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                • value — required — (String)

                  The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

        • allowInterrupt — (Boolean)

          Indicates whether the user can interrupt a speech response from Amazon Lex.

      • active — (Boolean)

        Specifies whether an intent's closing response is used. When this field is false, the closing response isn't sent to the user. If the active field isn't specified, the default is true.

    • inputContexts — (Array<map>)

      A new list of contexts that must be active in order for Amazon Lex to consider the intent.

      • name — required — (String)

        The name of the context.

    • outputContexts — (Array<map>)

      A new list of contexts that Amazon Lex activates when the intent is fulfilled.

      • name — required — (String)

        The name of the output context.

      • timeToLiveInSeconds — required — (Integer)

        The amount of time, in seconds, that the output context should remain active. The time is figured from the first time the context is sent to the user.

      • turnsToLive — required — (Integer)

        The number of conversation turns that the output context should remain active. The number of turns is counted from the first time that the context is sent to the user.

    • kendraConfiguration — (map)

      New configuration settings for connecting to an Amazon Kendra index.

      • kendraIndex — required — (String)

        The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the AMAZON.KendraSearchIntent intent to search. The index must be in the same account and Region as the Amazon Lex bot.

      • queryFilterStringEnabled — (Boolean)

        Determines whether the AMAZON.KendraSearchIntent intent uses a custom query string to query the Amazon Kendra index.

      • queryFilterString — (String)

        A query filter that Amazon Lex sends to Amazon Kendra to filter the response from a query. The filter is in the format defined by Amazon Kendra. For more information, see Filtering queries.

    • botId — (String)

      The identifier of the bot that contains the intent.

    • botVersion — (String)

      The version of the bot that contains the intent. Must be DRAFT.

    • localeId — (String)

      The identifier of the language and locale where this intent is used. The string must match one of the supported locales. For more information, see Supported languages.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • intentId — (String)

        The identifier of the intent that was updated.

      • intentName — (String)

        The updated name of the intent.

      • description — (String)

        The updated description of the intent.

      • parentIntentSignature — (String)

        The updated built-in intent that is the parent of this intent.

      • sampleUtterances — (Array<map>)

        The updated list of sample utterances for the intent.

        • utterance — required — (String)

          The sample utterance that Amazon Lex uses to build its machine-learning model to recognize intents.

      • dialogCodeHook — (map)

        The updated Lambda function called during each turn of the conversation with the user.

        • enabled — required — (Boolean)

          Enables the dialog code hook so that it processes user requests.

      • fulfillmentCodeHook — (map)

        The updated Lambda function called when the intent is ready for fulfillment.

        • enabled — required — (Boolean)

          Indicates whether a Lambda function should be invoked to fulfill a specific intent.

        • postFulfillmentStatusSpecification — (map)

          Provides settings for messages sent to the user for after the Lambda fulfillment function completes. Post-fulfillment messages can be sent for both streaming and non-streaming conversations.

          • successResponse — (map)

            Specifies a list of message groups that Amazon Lex uses to respond the user input.

            • messageGroups — required — (Array<map>)

              A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

              • message — required — (map)

                The primary message that Amazon Lex should send to the user.

                • plainTextMessage — (map)

                  A message in plain text format.

                  • value — required — (String)

                    The message to send to the user.

                • customPayload — (map)

                  A message in a custom format defined by the client application.

                  • value — required — (String)

                    The string that is sent to your application.

                • ssmlMessage — (map)

                  A message in Speech Synthesis Markup Language (SSML).

                  • value — required — (String)

                    The SSML text that defines the prompt.

                • imageResponseCard — (map)

                  A message that defines a response card that the client application can show to the user.

                  • title — required — (String)

                    The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                  • subtitle — (String)

                    The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                  • imageUrl — (String)

                    The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                  • buttons — (Array<map>)

                    A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                    • text — required — (String)

                      The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                    • value — required — (String)

                      The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

              • variations — (Array<map>)

                Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                • plainTextMessage — (map)

                  A message in plain text format.

                  • value — required — (String)

                    The message to send to the user.

                • customPayload — (map)

                  A message in a custom format defined by the client application.

                  • value — required — (String)

                    The string that is sent to your application.

                • ssmlMessage — (map)

                  A message in Speech Synthesis Markup Language (SSML).

                  • value — required — (String)

                    The SSML text that defines the prompt.

                • imageResponseCard — (map)

                  A message that defines a response card that the client application can show to the user.

                  • title — required — (String)

                    The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                  • subtitle — (String)

                    The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                  • imageUrl — (String)

                    The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                  • buttons — (Array<map>)

                    A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                    • text — required — (String)

                      The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                    • value — required — (String)

                      The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

            • allowInterrupt — (Boolean)

              Indicates whether the user can interrupt a speech response from Amazon Lex.

          • failureResponse — (map)

            Specifies a list of message groups that Amazon Lex uses to respond the user input.

            • messageGroups — required — (Array<map>)

              A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

              • message — required — (map)

                The primary message that Amazon Lex should send to the user.

                • plainTextMessage — (map)

                  A message in plain text format.

                  • value — required — (String)

                    The message to send to the user.

                • customPayload — (map)

                  A message in a custom format defined by the client application.

                  • value — required — (String)

                    The string that is sent to your application.

                • ssmlMessage — (map)

                  A message in Speech Synthesis Markup Language (SSML).

                  • value — required — (String)

                    The SSML text that defines the prompt.

                • imageResponseCard — (map)

                  A message that defines a response card that the client application can show to the user.

                  • title — required — (String)

                    The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                  • subtitle — (String)

                    The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                  • imageUrl — (String)

                    The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                  • buttons — (Array<map>)

                    A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                    • text — required — (String)

                      The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                    • value — required — (String)

                      The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

              • variations — (Array<map>)

                Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                • plainTextMessage — (map)

                  A message in plain text format.

                  • value — required — (String)

                    The message to send to the user.

                • customPayload — (map)

                  A message in a custom format defined by the client application.

                  • value — required — (String)

                    The string that is sent to your application.

                • ssmlMessage — (map)

                  A message in Speech Synthesis Markup Language (SSML).

                  • value — required — (String)

                    The SSML text that defines the prompt.

                • imageResponseCard — (map)

                  A message that defines a response card that the client application can show to the user.

                  • title — required — (String)

                    The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                  • subtitle — (String)

                    The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                  • imageUrl — (String)

                    The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                  • buttons — (Array<map>)

                    A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                    • text — required — (String)

                      The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                    • value — required — (String)

                      The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

            • allowInterrupt — (Boolean)

              Indicates whether the user can interrupt a speech response from Amazon Lex.

          • timeoutResponse — (map)

            Specifies a list of message groups that Amazon Lex uses to respond the user input.

            • messageGroups — required — (Array<map>)

              A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

              • message — required — (map)

                The primary message that Amazon Lex should send to the user.

                • plainTextMessage — (map)

                  A message in plain text format.

                  • value — required — (String)

                    The message to send to the user.

                • customPayload — (map)

                  A message in a custom format defined by the client application.

                  • value — required — (String)

                    The string that is sent to your application.

                • ssmlMessage — (map)

                  A message in Speech Synthesis Markup Language (SSML).

                  • value — required — (String)

                    The SSML text that defines the prompt.

                • imageResponseCard — (map)

                  A message that defines a response card that the client application can show to the user.

                  • title — required — (String)

                    The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                  • subtitle — (String)

                    The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                  • imageUrl — (String)

                    The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                  • buttons — (Array<map>)

                    A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                    • text — required — (String)

                      The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                    • value — required — (String)

                      The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

              • variations — (Array<map>)

                Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                • plainTextMessage — (map)

                  A message in plain text format.

                  • value — required — (String)

                    The message to send to the user.

                • customPayload — (map)

                  A message in a custom format defined by the client application.

                  • value — required — (String)

                    The string that is sent to your application.

                • ssmlMessage — (map)

                  A message in Speech Synthesis Markup Language (SSML).

                  • value — required — (String)

                    The SSML text that defines the prompt.

                • imageResponseCard — (map)

                  A message that defines a response card that the client application can show to the user.

                  • title — required — (String)

                    The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                  • subtitle — (String)

                    The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                  • imageUrl — (String)

                    The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                  • buttons — (Array<map>)

                    A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                    • text — required — (String)

                      The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                    • value — required — (String)

                      The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

            • allowInterrupt — (Boolean)

              Indicates whether the user can interrupt a speech response from Amazon Lex.

        • fulfillmentUpdatesSpecification — (map)

          Provides settings for update messages sent to the user for long-running Lambda fulfillment functions. Fulfillment updates can be used only with streaming conversations.

          • active — required — (Boolean)

            Determines whether fulfillment updates are sent to the user. When this field is true, updates are sent.

            If the active field is set to true, the startResponse, updateResponse, and timeoutInSeconds fields are required.

          • startResponse — (map)

            Provides configuration information for the message sent to users when the fulfillment Lambda functions starts running.

            • delayInSeconds — required — (Integer)

              The delay between when the Lambda fulfillment function starts running and the start message is played. If the Lambda function returns before the delay is over, the start message isn't played.

            • messageGroups — required — (Array<map>)

              One to 5 message groups that contain start messages. Amazon Lex chooses one of the messages to play to the user.

              • message — required — (map)

                The primary message that Amazon Lex should send to the user.

                • plainTextMessage — (map)

                  A message in plain text format.

                  • value — required — (String)

                    The message to send to the user.

                • customPayload — (map)

                  A message in a custom format defined by the client application.

                  • value — required — (String)

                    The string that is sent to your application.

                • ssmlMessage — (map)

                  A message in Speech Synthesis Markup Language (SSML).

                  • value — required — (String)

                    The SSML text that defines the prompt.

                • imageResponseCard — (map)

                  A message that defines a response card that the client application can show to the user.

                  • title — required — (String)

                    The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                  • subtitle — (String)

                    The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                  • imageUrl — (String)

                    The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                  • buttons — (Array<map>)

                    A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                    • text — required — (String)

                      The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                    • value — required — (String)

                      The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

              • variations — (Array<map>)

                Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                • plainTextMessage — (map)

                  A message in plain text format.

                  • value — required — (String)

                    The message to send to the user.

                • customPayload — (map)

                  A message in a custom format defined by the client application.

                  • value — required — (String)

                    The string that is sent to your application.

                • ssmlMessage — (map)

                  A message in Speech Synthesis Markup Language (SSML).

                  • value — required — (String)

                    The SSML text that defines the prompt.

                • imageResponseCard — (map)

                  A message that defines a response card that the client application can show to the user.

                  • title — required — (String)

                    The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                  • subtitle — (String)

                    The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                  • imageUrl — (String)

                    The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                  • buttons — (Array<map>)

                    A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                    • text — required — (String)

                      The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                    • value — required — (String)

                      The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

            • allowInterrupt — (Boolean)

              Determines whether the user can interrupt the start message while it is playing.

          • updateResponse — (map)

            Provides configuration information for messages sent periodically to the user while the fulfillment Lambda function is running.

            • frequencyInSeconds — required — (Integer)

              The frequency that a message is sent to the user. When the period ends, Amazon Lex chooses a message from the message groups and plays it to the user. If the fulfillment Lambda returns before the first period ends, an update message is not played to the user.

            • messageGroups — required — (Array<map>)

              One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.

              • message — required — (map)

                The primary message that Amazon Lex should send to the user.

                • plainTextMessage — (map)

                  A message in plain text format.

                  • value — required — (String)

                    The message to send to the user.

                • customPayload — (map)

                  A message in a custom format defined by the client application.

                  • value — required — (String)

                    The string that is sent to your application.

                • ssmlMessage — (map)

                  A message in Speech Synthesis Markup Language (SSML).

                  • value — required — (String)

                    The SSML text that defines the prompt.

                • imageResponseCard — (map)

                  A message that defines a response card that the client application can show to the user.

                  • title — required — (String)

                    The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                  • subtitle — (String)

                    The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                  • imageUrl — (String)

                    The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                  • buttons — (Array<map>)

                    A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                    • text — required — (String)

                      The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                    • value — required — (String)

                      The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

              • variations — (Array<map>)

                Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                • plainTextMessage — (map)

                  A message in plain text format.

                  • value — required — (String)

                    The message to send to the user.

                • customPayload — (map)

                  A message in a custom format defined by the client application.

                  • value — required — (String)

                    The string that is sent to your application.

                • ssmlMessage — (map)

                  A message in Speech Synthesis Markup Language (SSML).

                  • value — required — (String)

                    The SSML text that defines the prompt.

                • imageResponseCard — (map)

                  A message that defines a response card that the client application can show to the user.

                  • title — required — (String)

                    The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                  • subtitle — (String)

                    The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                  • imageUrl — (String)

                    The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                  • buttons — (Array<map>)

                    A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                    • text — required — (String)

                      The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                    • value — required — (String)

                      The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

            • allowInterrupt — (Boolean)

              Determines whether the user can interrupt an update message while it is playing.

          • timeoutInSeconds — (Integer)

            The length of time that the fulfillment Lambda function should run before it times out.

      • slotPriorities — (Array<map>)

        The updated list of slots and their priorities that are elicited from the user for the intent.

        • priority — required — (Integer)

          The priority that a slot should be elicited.

        • slotId — required — (String)

          The unique identifier of the slot.

      • intentConfirmationSetting — (map)

        The updated prompts that Amazon Lex sends to the user to confirm the completion of an intent.

        • promptSpecification — required — (map)

          Prompts the user to confirm the intent. This question should have a yes or no answer.

          Amazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for fulfillment. For example, with the OrderPizza intent, you might want to confirm that the order is correct before placing it. For other intents, such as intents that simply respond to user questions, you might not need to ask the user for confirmation before providing the information.

          • messageGroups — required — (Array<map>)

            A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.

            • message — required — (map)

              The primary message that Amazon Lex should send to the user.

              • plainTextMessage — (map)

                A message in plain text format.

                • value — required — (String)

                  The message to send to the user.

              • customPayload — (map)

                A message in a custom format defined by the client application.

                • value — required — (String)

                  The string that is sent to your application.

              • ssmlMessage — (map)

                A message in Speech Synthesis Markup Language (SSML).

                • value — required — (String)

                  The SSML text that defines the prompt.

              • imageResponseCard — (map)

                A message that defines a response card that the client application can show to the user.

                • title — required — (String)

                  The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                • subtitle — (String)

                  The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                • imageUrl — (String)

                  The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                • buttons — (Array<map>)

                  A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                  • text — required — (String)

                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                  • value — required — (String)

                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

            • variations — (Array<map>)

              Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

              • plainTextMessage — (map)

                A message in plain text format.

                • value — required — (String)

                  The message to send to the user.

              • customPayload — (map)

                A message in a custom format defined by the client application.

                • value — required — (String)

                  The string that is sent to your application.

              • ssmlMessage — (map)

                A message in Speech Synthesis Markup Language (SSML).

                • value — required — (String)

                  The SSML text that defines the prompt.

              • imageResponseCard — (map)

                A message that defines a response card that the client application can show to the user.

                • title — required — (String)

                  The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                • subtitle — (String)

                  The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                • imageUrl — (String)

                  The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                • buttons — (Array<map>)

                  A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                  • text — required — (String)

                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                  • value — required — (String)

                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

          • maxRetries — required — (Integer)

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

          • allowInterrupt — (Boolean)

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

        • declinationResponse — required — (map)

          When the user answers "no" to the question defined in promptSpecification, Amazon Lex responds with this response to acknowledge that the intent was canceled.

          • messageGroups — required — (Array<map>)

            A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

            • message — required — (map)

              The primary message that Amazon Lex should send to the user.

              • plainTextMessage — (map)

                A message in plain text format.

                • value — required — (String)

                  The message to send to the user.

              • customPayload — (map)

                A message in a custom format defined by the client application.

                • value — required — (String)

                  The string that is sent to your application.

              • ssmlMessage — (map)

                A message in Speech Synthesis Markup Language (SSML).

                • value — required — (String)

                  The SSML text that defines the prompt.

              • imageResponseCard — (map)

                A message that defines a response card that the client application can show to the user.

                • title — required — (String)

                  The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                • subtitle — (String)

                  The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                • imageUrl — (String)

                  The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                • buttons — (Array<map>)

                  A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                  • text — required — (String)

                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                  • value — required — (String)

                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

            • variations — (Array<map>)

              Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

              • plainTextMessage — (map)

                A message in plain text format.

                • value — required — (String)

                  The message to send to the user.

              • customPayload — (map)

                A message in a custom format defined by the client application.

                • value — required — (String)

                  The string that is sent to your application.

              • ssmlMessage — (map)

                A message in Speech Synthesis Markup Language (SSML).

                • value — required — (String)

                  The SSML text that defines the prompt.

              • imageResponseCard — (map)

                A message that defines a response card that the client application can show to the user.

                • title — required — (String)

                  The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                • subtitle — (String)

                  The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                • imageUrl — (String)

                  The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                • buttons — (Array<map>)

                  A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                  • text — required — (String)

                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                  • value — required — (String)

                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

          • allowInterrupt — (Boolean)

            Indicates whether the user can interrupt a speech response from Amazon Lex.

        • active — (Boolean)

          Specifies whether the intent's confirmation is sent to the user. When this field is false, confirmation and declination responses aren't sent. If the active field isn't specified, the default is true.

      • intentClosingSetting — (map)

        The updated response that Amazon Lex sends the user when the intent is closed.

        • closingResponse — required — (map)

          The response that Amazon Lex sends to the user when the intent is complete.

          • messageGroups — required — (Array<map>)

            A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

            • message — required — (map)

              The primary message that Amazon Lex should send to the user.

              • plainTextMessage — (map)

                A message in plain text format.

                • value — required — (String)

                  The message to send to the user.

              • customPayload — (map)

                A message in a custom format defined by the client application.

                • value — required — (String)

                  The string that is sent to your application.

              • ssmlMessage — (map)

                A message in Speech Synthesis Markup Language (SSML).

                • value — required — (String)

                  The SSML text that defines the prompt.

              • imageResponseCard — (map)

                A message that defines a response card that the client application can show to the user.

                • title — required — (String)

                  The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                • subtitle — (String)

                  The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                • imageUrl — (String)

                  The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                • buttons — (Array<map>)

                  A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                  • text — required — (String)

                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                  • value — required — (String)

                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

            • variations — (Array<map>)

              Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

              • plainTextMessage — (map)

                A message in plain text format.

                • value — required — (String)

                  The message to send to the user.

              • customPayload — (map)

                A message in a custom format defined by the client application.

                • value — required — (String)

                  The string that is sent to your application.

              • ssmlMessage — (map)

                A message in Speech Synthesis Markup Language (SSML).

                • value — required — (String)

                  The SSML text that defines the prompt.

              • imageResponseCard — (map)

                A message that defines a response card that the client application can show to the user.

                • title — required — (String)

                  The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                • subtitle — (String)

                  The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                • imageUrl — (String)

                  The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                • buttons — (Array<map>)

                  A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                  • text — required — (String)

                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                  • value — required — (String)

                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

          • allowInterrupt — (Boolean)

            Indicates whether the user can interrupt a speech response from Amazon Lex.

        • active — (Boolean)

          Specifies whether an intent's closing response is used. When this field is false, the closing response isn't sent to the user. If the active field isn't specified, the default is true.

      • inputContexts — (Array<map>)

        The updated list of contexts that must be active for the intent to be considered by Amazon Lex.

        • name — required — (String)

          The name of the context.

      • outputContexts — (Array<map>)

        The updated list of contexts that Amazon Lex activates when the intent is fulfilled.

        • name — required — (String)

          The name of the output context.

        • timeToLiveInSeconds — required — (Integer)

          The amount of time, in seconds, that the output context should remain active. The time is figured from the first time the context is sent to the user.

        • turnsToLive — required — (Integer)

          The number of conversation turns that the output context should remain active. The number of turns is counted from the first time that the context is sent to the user.

      • kendraConfiguration — (map)

        The updated configuration for connecting to an Amazon Kendra index with the AMAZON.KendraSearchIntent intent.

        • kendraIndex — required — (String)

          The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the AMAZON.KendraSearchIntent intent to search. The index must be in the same account and Region as the Amazon Lex bot.

        • queryFilterStringEnabled — (Boolean)

          Determines whether the AMAZON.KendraSearchIntent intent uses a custom query string to query the Amazon Kendra index.

        • queryFilterString — (String)

          A query filter that Amazon Lex sends to Amazon Kendra to filter the response from a query. The filter is in the format defined by Amazon Kendra. For more information, see Filtering queries.

      • botId — (String)

        The identifier of the bot that contains the intent.

      • botVersion — (String)

        The version of the bot that contains the intent. Will always be DRAFT.

      • localeId — (String)

        The updated language and locale of the intent.

      • creationDateTime — (Date)

        A timestamp of when the intent was created.

      • lastUpdatedDateTime — (Date)

        A timestamp of the last time that the intent was modified.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateResourcePolicy(params = {}, callback) ⇒ AWS.Request

Replaces the existing resource policy for a bot or bot alias with a new one. If the policy doesn't exist, Amazon Lex returns an exception.

Service Reference:

Examples:

Calling the updateResourcePolicy operation

var params = {
  policy: 'STRING_VALUE', /* required */
  resourceArn: 'STRING_VALUE', /* required */
  expectedRevisionId: 'STRING_VALUE'
};
lexmodelsv2.updateResourcePolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • resourceArn — (String)

      The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.

    • policy — (String)

      A resource policy to add to the resource. The policy is a JSON structure that contains one or more statements that define the policy. The policy must follow the IAM syntax. For more information about the contents of a JSON policy document, see IAM JSON policy reference .

      If the policy isn't valid, Amazon Lex returns a validation exception.

    • expectedRevisionId — (String)

      The identifier of the revision of the policy to update. If this revision ID doesn't match the current revision ID, Amazon Lex throws an exception.

      If you don't specify a revision, Amazon Lex overwrites the contents of the policy with the new values.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • resourceArn — (String)

        The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.

      • revisionId — (String)

        The current revision of the resource policy. Use the revision ID to make sure that you are updating the most current version of a resource policy when you add a policy statement to a resource, delete a resource, or update a resource.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateSlot(params = {}, callback) ⇒ AWS.Request

Updates the settings for a slot.

Service Reference:

Examples:

Calling the updateSlot operation

var params = {
  botId: 'STRING_VALUE', /* required */
  botVersion: 'STRING_VALUE', /* required */
  intentId: 'STRING_VALUE', /* required */
  localeId: 'STRING_VALUE', /* required */
  slotId: 'STRING_VALUE', /* required */
  slotName: 'STRING_VALUE', /* required */
  slotTypeId: 'STRING_VALUE', /* required */
  valueElicitationSetting: { /* required */
    slotConstraint: Required | Optional, /* required */
    defaultValueSpecification: {
      defaultValueList: [ /* required */
        {
          defaultValue: 'STRING_VALUE' /* required */
        },
        /* more items */
      ]
    },
    promptSpecification: {
      maxRetries: 'NUMBER_VALUE', /* required */
      messageGroups: [ /* required */
        {
          message: { /* required */
            customPayload: {
              value: 'STRING_VALUE' /* required */
            },
            imageResponseCard: {
              title: 'STRING_VALUE', /* required */
              buttons: [
                {
                  text: 'STRING_VALUE', /* required */
                  value: 'STRING_VALUE' /* required */
                },
                /* more items */
              ],
              imageUrl: 'STRING_VALUE',
              subtitle: 'STRING_VALUE'
            },
            plainTextMessage: {
              value: 'STRING_VALUE' /* required */
            },
            ssmlMessage: {
              value: 'STRING_VALUE' /* required */
            }
          },
          variations: [
            {
              customPayload: {
                value: 'STRING_VALUE' /* required */
              },
              imageResponseCard: {
                title: 'STRING_VALUE', /* required */
                buttons: [
                  {
                    text: 'STRING_VALUE', /* required */
                    value: 'STRING_VALUE' /* required */
                  },
                  /* more items */
                ],
                imageUrl: 'STRING_VALUE',
                subtitle: 'STRING_VALUE'
              },
              plainTextMessage: {
                value: 'STRING_VALUE' /* required */
              },
              ssmlMessage: {
                value: 'STRING_VALUE' /* required */
              }
            },
            /* more items */
          ]
        },
        /* more items */
      ],
      allowInterrupt: true || false
    },
    sampleUtterances: [
      {
        utterance: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    waitAndContinueSpecification: {
      continueResponse: { /* required */
        messageGroups: [ /* required */
          {
            message: { /* required */
              customPayload: {
                value: 'STRING_VALUE' /* required */
              },
              imageResponseCard: {
                title: 'STRING_VALUE', /* required */
                buttons: [
                  {
                    text: 'STRING_VALUE', /* required */
                    value: 'STRING_VALUE' /* required */
                  },
                  /* more items */
                ],
                imageUrl: 'STRING_VALUE',
                subtitle: 'STRING_VALUE'
              },
              plainTextMessage: {
                value: 'STRING_VALUE' /* required */
              },
              ssmlMessage: {
                value: 'STRING_VALUE' /* required */
              }
            },
            variations: [
              {
                customPayload: {
                  value: 'STRING_VALUE' /* required */
                },
                imageResponseCard: {
                  title: 'STRING_VALUE', /* required */
                  buttons: [
                    {
                      text: 'STRING_VALUE', /* required */
                      value: 'STRING_VALUE' /* required */
                    },
                    /* more items */
                  ],
                  imageUrl: 'STRING_VALUE',
                  subtitle: 'STRING_VALUE'
                },
                plainTextMessage: {
                  value: 'STRING_VALUE' /* required */
                },
                ssmlMessage: {
                  value: 'STRING_VALUE' /* required */
                }
              },
              /* more items */
            ]
          },
          /* more items */
        ],
        allowInterrupt: true || false
      },
      waitingResponse: { /* required */
        messageGroups: [ /* required */
          {
            message: { /* required */
              customPayload: {
                value: 'STRING_VALUE' /* required */
              },
              imageResponseCard: {
                title: 'STRING_VALUE', /* required */
                buttons: [
                  {
                    text: 'STRING_VALUE', /* required */
                    value: 'STRING_VALUE' /* required */
                  },
                  /* more items */
                ],
                imageUrl: 'STRING_VALUE',
                subtitle: 'STRING_VALUE'
              },
              plainTextMessage: {
                value: 'STRING_VALUE' /* required */
              },
              ssmlMessage: {
                value: 'STRING_VALUE' /* required */
              }
            },
            variations: [
              {
                customPayload: {
                  value: 'STRING_VALUE' /* required */
                },
                imageResponseCard: {
                  title: 'STRING_VALUE', /* required */
                  buttons: [
                    {
                      text: 'STRING_VALUE', /* required */
                      value: 'STRING_VALUE' /* required */
                    },
                    /* more items */
                  ],
                  imageUrl: 'STRING_VALUE',
                  subtitle: 'STRING_VALUE'
                },
                plainTextMessage: {
                  value: 'STRING_VALUE' /* required */
                },
                ssmlMessage: {
                  value: 'STRING_VALUE' /* required */
                }
              },
              /* more items */
            ]
          },
          /* more items */
        ],
        allowInterrupt: true || false
      },
      active: true || false,
      stillWaitingResponse: {
        frequencyInSeconds: 'NUMBER_VALUE', /* required */
        messageGroups: [ /* required */
          {
            message: { /* required */
              customPayload: {
                value: 'STRING_VALUE' /* required */
              },
              imageResponseCard: {
                title: 'STRING_VALUE', /* required */
                buttons: [
                  {
                    text: 'STRING_VALUE', /* required */
                    value: 'STRING_VALUE' /* required */
                  },
                  /* more items */
                ],
                imageUrl: 'STRING_VALUE',
                subtitle: 'STRING_VALUE'
              },
              plainTextMessage: {
                value: 'STRING_VALUE' /* required */
              },
              ssmlMessage: {
                value: 'STRING_VALUE' /* required */
              }
            },
            variations: [
              {
                customPayload: {
                  value: 'STRING_VALUE' /* required */
                },
                imageResponseCard: {
                  title: 'STRING_VALUE', /* required */
                  buttons: [
                    {
                      text: 'STRING_VALUE', /* required */
                      value: 'STRING_VALUE' /* required */
                    },
                    /* more items */
                  ],
                  imageUrl: 'STRING_VALUE',
                  subtitle: 'STRING_VALUE'
                },
                plainTextMessage: {
                  value: 'STRING_VALUE' /* required */
                },
                ssmlMessage: {
                  value: 'STRING_VALUE' /* required */
                }
              },
              /* more items */
            ]
          },
          /* more items */
        ],
        timeoutInSeconds: 'NUMBER_VALUE', /* required */
        allowInterrupt: true || false
      }
    }
  },
  description: 'STRING_VALUE',
  multipleValuesSetting: {
    allowMultipleValues: true || false
  },
  obfuscationSetting: {
    obfuscationSettingType: None | DefaultObfuscation /* required */
  }
};
lexmodelsv2.updateSlot(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • slotId — (String)

      The unique identifier for the slot to update.

    • slotName — (String)

      The new name for the slot.

    • description — (String)

      The new description for the slot.

    • slotTypeId — (String)

      The unique identifier of the new slot type to associate with this slot.

    • valueElicitationSetting — (map)

      A new set of prompts that Amazon Lex sends to the user to elicit a response the provides a value for the slot.

      • defaultValueSpecification — (map)

        A list of default values for a slot. Default values are used when Amazon Lex hasn't determined a value for a slot. You can specify default values from context variables, session attributes, and defined values.

        • defaultValueList — required — (Array<map>)

          A list of default values. Amazon Lex chooses the default value to use in the order that they are presented in the list.

          • defaultValue — required — (String)

            The default value to use when a user doesn't provide a value for a slot.

      • slotConstraint — required — (String)

        Specifies whether the slot is required or optional.

        Possible values include:
        • "Required"
        • "Optional"
      • promptSpecification — (map)

        The prompt that Amazon Lex uses to elicit the slot value from the user.

        • messageGroups — required — (Array<map>)

          A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.

          • message — required — (map)

            The primary message that Amazon Lex should send to the user.

            • plainTextMessage — (map)

              A message in plain text format.

              • value — required — (String)

                The message to send to the user.

            • customPayload — (map)

              A message in a custom format defined by the client application.

              • value — required — (String)

                The string that is sent to your application.

            • ssmlMessage — (map)

              A message in Speech Synthesis Markup Language (SSML).

              • value — required — (String)

                The SSML text that defines the prompt.

            • imageResponseCard — (map)

              A message that defines a response card that the client application can show to the user.

              • title — required — (String)

                The title to display on the response card. The format of the title is determined by the platform displaying the response card.

              • subtitle — (String)

                The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

              • imageUrl — (String)

                The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

              • buttons — (Array<map>)

                A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                • text — required — (String)

                  The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                • value — required — (String)

                  The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

          • variations — (Array<map>)

            Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

            • plainTextMessage — (map)

              A message in plain text format.

              • value — required — (String)

                The message to send to the user.

            • customPayload — (map)

              A message in a custom format defined by the client application.

              • value — required — (String)

                The string that is sent to your application.

            • ssmlMessage — (map)

              A message in Speech Synthesis Markup Language (SSML).

              • value — required — (String)

                The SSML text that defines the prompt.

            • imageResponseCard — (map)

              A message that defines a response card that the client application can show to the user.

              • title — required — (String)

                The title to display on the response card. The format of the title is determined by the platform displaying the response card.

              • subtitle — (String)

                The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

              • imageUrl — (String)

                The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

              • buttons — (Array<map>)

                A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                • text — required — (String)

                  The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                • value — required — (String)

                  The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

        • maxRetries — required — (Integer)

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

        • allowInterrupt — (Boolean)

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

      • sampleUtterances — (Array<map>)

        If you know a specific pattern that users might respond to an Amazon Lex request for a slot value, you can provide those utterances to improve accuracy. This is optional. In most cases, Amazon Lex is capable of understanding user utterances.

        • utterance — required — (String)

          The sample utterance that Amazon Lex uses to build its machine-learning model to recognize intents.

      • waitAndContinueSpecification — (map)

        Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input.

        • waitingResponse — required — (map)

          The response that Amazon Lex sends to indicate that the bot is waiting for the conversation to continue.

          • messageGroups — required — (Array<map>)

            A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

            • message — required — (map)

              The primary message that Amazon Lex should send to the user.

              • plainTextMessage — (map)

                A message in plain text format.

                • value — required — (String)

                  The message to send to the user.

              • customPayload — (map)

                A message in a custom format defined by the client application.

                • value — required — (String)

                  The string that is sent to your application.

              • ssmlMessage — (map)

                A message in Speech Synthesis Markup Language (SSML).

                • value — required — (String)

                  The SSML text that defines the prompt.

              • imageResponseCard — (map)

                A message that defines a response card that the client application can show to the user.

                • title — required — (String)

                  The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                • subtitle — (String)

                  The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                • imageUrl — (String)

                  The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                • buttons — (Array<map>)

                  A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                  • text — required — (String)

                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                  • value — required — (String)

                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

            • variations — (Array<map>)

              Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

              • plainTextMessage — (map)

                A message in plain text format.

                • value — required — (String)

                  The message to send to the user.

              • customPayload — (map)

                A message in a custom format defined by the client application.

                • value — required — (String)

                  The string that is sent to your application.

              • ssmlMessage — (map)

                A message in Speech Synthesis Markup Language (SSML).

                • value — required — (String)

                  The SSML text that defines the prompt.

              • imageResponseCard — (map)

                A message that defines a response card that the client application can show to the user.

                • title — required — (String)

                  The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                • subtitle — (String)

                  The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                • imageUrl — (String)

                  The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                • buttons — (Array<map>)

                  A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                  • text — required — (String)

                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                  • value — required — (String)

                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

          • allowInterrupt — (Boolean)

            Indicates whether the user can interrupt a speech response from Amazon Lex.

        • continueResponse — required — (map)

          The response that Amazon Lex sends to indicate that the bot is ready to continue the conversation.

          • messageGroups — required — (Array<map>)

            A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

            • message — required — (map)

              The primary message that Amazon Lex should send to the user.

              • plainTextMessage — (map)

                A message in plain text format.

                • value — required — (String)

                  The message to send to the user.

              • customPayload — (map)

                A message in a custom format defined by the client application.

                • value — required — (String)

                  The string that is sent to your application.

              • ssmlMessage — (map)

                A message in Speech Synthesis Markup Language (SSML).

                • value — required — (String)

                  The SSML text that defines the prompt.

              • imageResponseCard — (map)

                A message that defines a response card that the client application can show to the user.

                • title — required — (String)

                  The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                • subtitle — (String)

                  The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                • imageUrl — (String)

                  The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                • buttons — (Array<map>)

                  A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                  • text — required — (String)

                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                  • value — required — (String)

                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

            • variations — (Array<map>)

              Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

              • plainTextMessage — (map)

                A message in plain text format.

                • value — required — (String)

                  The message to send to the user.

              • customPayload — (map)

                A message in a custom format defined by the client application.

                • value — required — (String)

                  The string that is sent to your application.

              • ssmlMessage — (map)

                A message in Speech Synthesis Markup Language (SSML).

                • value — required — (String)

                  The SSML text that defines the prompt.

              • imageResponseCard — (map)

                A message that defines a response card that the client application can show to the user.

                • title — required — (String)

                  The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                • subtitle — (String)

                  The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                • imageUrl — (String)

                  The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                • buttons — (Array<map>)

                  A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                  • text — required — (String)

                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                  • value — required — (String)

                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

          • allowInterrupt — (Boolean)

            Indicates whether the user can interrupt a speech response from Amazon Lex.

        • stillWaitingResponse — (map)

          A response that Amazon Lex sends periodically to the user to indicate that the bot is still waiting for input from the user.

          • messageGroups — required — (Array<map>)

            One or more message groups, each containing one or more messages, that define the prompts that Amazon Lex sends to the user.

            • message — required — (map)

              The primary message that Amazon Lex should send to the user.

              • plainTextMessage — (map)

                A message in plain text format.

                • value — required — (String)

                  The message to send to the user.

              • customPayload — (map)

                A message in a custom format defined by the client application.

                • value — required — (String)

                  The string that is sent to your application.

              • ssmlMessage — (map)

                A message in Speech Synthesis Markup Language (SSML).

                • value — required — (String)

                  The SSML text that defines the prompt.

              • imageResponseCard — (map)

                A message that defines a response card that the client application can show to the user.

                • title — required — (String)

                  The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                • subtitle — (String)

                  The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                • imageUrl — (String)

                  The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                • buttons — (Array<map>)

                  A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                  • text — required — (String)

                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                  • value — required — (String)

                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

            • variations — (Array<map>)

              Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

              • plainTextMessage — (map)

                A message in plain text format.

                • value — required — (String)

                  The message to send to the user.

              • customPayload — (map)

                A message in a custom format defined by the client application.

                • value — required — (String)

                  The string that is sent to your application.

              • ssmlMessage — (map)

                A message in Speech Synthesis Markup Language (SSML).

                • value — required — (String)

                  The SSML text that defines the prompt.

              • imageResponseCard — (map)

                A message that defines a response card that the client application can show to the user.

                • title — required — (String)

                  The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                • subtitle — (String)

                  The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                • imageUrl — (String)

                  The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                • buttons — (Array<map>)

                  A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                  • text — required — (String)

                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                  • value — required — (String)

                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

          • frequencyInSeconds — required — (Integer)

            How often a message should be sent to the user. Minimum of 1 second, maximum of 5 minutes.

          • timeoutInSeconds — required — (Integer)

            If Amazon Lex waits longer than this length of time for a response, it will stop sending messages.

          • allowInterrupt — (Boolean)

            Indicates that the user can interrupt the response by speaking while the message is being played.

        • active — (Boolean)

          Specifies whether the bot will wait for a user to respond. When this field is false, wait and continue responses for a slot aren't used. If the active field isn't specified, the default is true.

    • obfuscationSetting — (map)

      New settings that determine how slot values are formatted in Amazon CloudWatch logs.

      • obfuscationSettingType — required — (String)

        Value that determines whether Amazon Lex obscures slot values in conversation logs. The default is to obscure the values.

        Possible values include:
        • "None"
        • "DefaultObfuscation"
    • botId — (String)

      The unique identifier of the bot that contains the slot.

    • botVersion — (String)

      The version of the bot that contains the slot. Must always be DRAFT.

    • localeId — (String)

      The identifier of the language and locale that contains the slot. The string must match one of the supported locales. For more information, see Supported languages.

    • intentId — (String)

      The identifier of the intent that contains the slot.

    • multipleValuesSetting — (map)

      Determines whether the slot accepts multiple values in one response. Multiple value slots are only available in the en-US locale. If you set this value to true in any other locale, Amazon Lex throws a ValidationException.

      If the multipleValuesSetting is not set, the default value is false.

      • allowMultipleValues — (Boolean)

        Indicates whether a slot can return multiple values. When true, the slot may return more than one value in a response. When false, the slot returns only a single value.

        Multi-value slots are only available in the en-US locale. If you set this value to true in any other locale, Amazon Lex throws a ValidationException.

        If the allowMutlipleValues is not set, the default value is false.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • slotId — (String)

        The unique identifier of the slot that was updated.

      • slotName — (String)

        The updated name of the slot.

      • description — (String)

        The updated description of the bot.

      • slotTypeId — (String)

        The updated identifier of the slot type that provides values for the slot.

      • valueElicitationSetting — (map)

        The updated prompts that Amazon Lex sends to the user to elicit a response that provides a value for the slot.

        • defaultValueSpecification — (map)

          A list of default values for a slot. Default values are used when Amazon Lex hasn't determined a value for a slot. You can specify default values from context variables, session attributes, and defined values.

          • defaultValueList — required — (Array<map>)

            A list of default values. Amazon Lex chooses the default value to use in the order that they are presented in the list.

            • defaultValue — required — (String)

              The default value to use when a user doesn't provide a value for a slot.

        • slotConstraint — required — (String)

          Specifies whether the slot is required or optional.

          Possible values include:
          • "Required"
          • "Optional"
        • promptSpecification — (map)

          The prompt that Amazon Lex uses to elicit the slot value from the user.

          • messageGroups — required — (Array<map>)

            A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.

            • message — required — (map)

              The primary message that Amazon Lex should send to the user.

              • plainTextMessage — (map)

                A message in plain text format.

                • value — required — (String)

                  The message to send to the user.

              • customPayload — (map)

                A message in a custom format defined by the client application.

                • value — required — (String)

                  The string that is sent to your application.

              • ssmlMessage — (map)

                A message in Speech Synthesis Markup Language (SSML).

                • value — required — (String)

                  The SSML text that defines the prompt.

              • imageResponseCard — (map)

                A message that defines a response card that the client application can show to the user.

                • title — required — (String)

                  The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                • subtitle — (String)

                  The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                • imageUrl — (String)

                  The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                • buttons — (Array<map>)

                  A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                  • text — required — (String)

                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                  • value — required — (String)

                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

            • variations — (Array<map>)

              Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

              • plainTextMessage — (map)

                A message in plain text format.

                • value — required — (String)

                  The message to send to the user.

              • customPayload — (map)

                A message in a custom format defined by the client application.

                • value — required — (String)

                  The string that is sent to your application.

              • ssmlMessage — (map)

                A message in Speech Synthesis Markup Language (SSML).

                • value — required — (String)

                  The SSML text that defines the prompt.

              • imageResponseCard — (map)

                A message that defines a response card that the client application can show to the user.

                • title — required — (String)

                  The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                • subtitle — (String)

                  The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                • imageUrl — (String)

                  The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                • buttons — (Array<map>)

                  A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                  • text — required — (String)

                    The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                  • value — required — (String)

                    The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

          • maxRetries — required — (Integer)

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

          • allowInterrupt — (Boolean)

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

        • sampleUtterances — (Array<map>)

          If you know a specific pattern that users might respond to an Amazon Lex request for a slot value, you can provide those utterances to improve accuracy. This is optional. In most cases, Amazon Lex is capable of understanding user utterances.

          • utterance — required — (String)

            The sample utterance that Amazon Lex uses to build its machine-learning model to recognize intents.

        • waitAndContinueSpecification — (map)

          Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input.

          • waitingResponse — required — (map)

            The response that Amazon Lex sends to indicate that the bot is waiting for the conversation to continue.

            • messageGroups — required — (Array<map>)

              A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

              • message — required — (map)

                The primary message that Amazon Lex should send to the user.

                • plainTextMessage — (map)

                  A message in plain text format.

                  • value — required — (String)

                    The message to send to the user.

                • customPayload — (map)

                  A message in a custom format defined by the client application.

                  • value — required — (String)

                    The string that is sent to your application.

                • ssmlMessage — (map)

                  A message in Speech Synthesis Markup Language (SSML).

                  • value — required — (String)

                    The SSML text that defines the prompt.

                • imageResponseCard — (map)

                  A message that defines a response card that the client application can show to the user.

                  • title — required — (String)

                    The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                  • subtitle — (String)

                    The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                  • imageUrl — (String)

                    The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                  • buttons — (Array<map>)

                    A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                    • text — required — (String)

                      The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                    • value — required — (String)

                      The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

              • variations — (Array<map>)

                Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                • plainTextMessage — (map)

                  A message in plain text format.

                  • value — required — (String)

                    The message to send to the user.

                • customPayload — (map)

                  A message in a custom format defined by the client application.

                  • value — required — (String)

                    The string that is sent to your application.

                • ssmlMessage — (map)

                  A message in Speech Synthesis Markup Language (SSML).

                  • value — required — (String)

                    The SSML text that defines the prompt.

                • imageResponseCard — (map)

                  A message that defines a response card that the client application can show to the user.

                  • title — required — (String)

                    The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                  • subtitle — (String)

                    The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                  • imageUrl — (String)

                    The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                  • buttons — (Array<map>)

                    A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                    • text — required — (String)

                      The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                    • value — required — (String)

                      The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

            • allowInterrupt — (Boolean)

              Indicates whether the user can interrupt a speech response from Amazon Lex.

          • continueResponse — required — (map)

            The response that Amazon Lex sends to indicate that the bot is ready to continue the conversation.

            • messageGroups — required — (Array<map>)

              A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

              • message — required — (map)

                The primary message that Amazon Lex should send to the user.

                • plainTextMessage — (map)

                  A message in plain text format.

                  • value — required — (String)

                    The message to send to the user.

                • customPayload — (map)

                  A message in a custom format defined by the client application.

                  • value — required — (String)

                    The string that is sent to your application.

                • ssmlMessage — (map)

                  A message in Speech Synthesis Markup Language (SSML).

                  • value — required — (String)

                    The SSML text that defines the prompt.

                • imageResponseCard — (map)

                  A message that defines a response card that the client application can show to the user.

                  • title — required — (String)

                    The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                  • subtitle — (String)

                    The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                  • imageUrl — (String)

                    The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                  • buttons — (Array<map>)

                    A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                    • text — required — (String)

                      The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                    • value — required — (String)

                      The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

              • variations — (Array<map>)

                Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                • plainTextMessage — (map)

                  A message in plain text format.

                  • value — required — (String)

                    The message to send to the user.

                • customPayload — (map)

                  A message in a custom format defined by the client application.

                  • value — required — (String)

                    The string that is sent to your application.

                • ssmlMessage — (map)

                  A message in Speech Synthesis Markup Language (SSML).

                  • value — required — (String)

                    The SSML text that defines the prompt.

                • imageResponseCard — (map)

                  A message that defines a response card that the client application can show to the user.

                  • title — required — (String)

                    The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                  • subtitle — (String)

                    The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                  • imageUrl — (String)

                    The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                  • buttons — (Array<map>)

                    A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                    • text — required — (String)

                      The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                    • value — required — (String)

                      The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

            • allowInterrupt — (Boolean)

              Indicates whether the user can interrupt a speech response from Amazon Lex.

          • stillWaitingResponse — (map)

            A response that Amazon Lex sends periodically to the user to indicate that the bot is still waiting for input from the user.

            • messageGroups — required — (Array<map>)

              One or more message groups, each containing one or more messages, that define the prompts that Amazon Lex sends to the user.

              • message — required — (map)

                The primary message that Amazon Lex should send to the user.

                • plainTextMessage — (map)

                  A message in plain text format.

                  • value — required — (String)

                    The message to send to the user.

                • customPayload — (map)

                  A message in a custom format defined by the client application.

                  • value — required — (String)

                    The string that is sent to your application.

                • ssmlMessage — (map)

                  A message in Speech Synthesis Markup Language (SSML).

                  • value — required — (String)

                    The SSML text that defines the prompt.

                • imageResponseCard — (map)

                  A message that defines a response card that the client application can show to the user.

                  • title — required — (String)

                    The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                  • subtitle — (String)

                    The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                  • imageUrl — (String)

                    The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                  • buttons — (Array<map>)

                    A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                    • text — required — (String)

                      The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                    • value — required — (String)

                      The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

              • variations — (Array<map>)

                Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

                • plainTextMessage — (map)

                  A message in plain text format.

                  • value — required — (String)

                    The message to send to the user.

                • customPayload — (map)

                  A message in a custom format defined by the client application.

                  • value — required — (String)

                    The string that is sent to your application.

                • ssmlMessage — (map)

                  A message in Speech Synthesis Markup Language (SSML).

                  • value — required — (String)

                    The SSML text that defines the prompt.

                • imageResponseCard — (map)

                  A message that defines a response card that the client application can show to the user.

                  • title — required — (String)

                    The title to display on the response card. The format of the title is determined by the platform displaying the response card.

                  • subtitle — (String)

                    The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

                  • imageUrl — (String)

                    The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

                  • buttons — (Array<map>)

                    A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

                    • text — required — (String)

                      The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

                    • value — required — (String)

                      The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

            • frequencyInSeconds — required — (Integer)

              How often a message should be sent to the user. Minimum of 1 second, maximum of 5 minutes.

            • timeoutInSeconds — required — (Integer)

              If Amazon Lex waits longer than this length of time for a response, it will stop sending messages.

            • allowInterrupt — (Boolean)

              Indicates that the user can interrupt the response by speaking while the message is being played.

          • active — (Boolean)

            Specifies whether the bot will wait for a user to respond. When this field is false, wait and continue responses for a slot aren't used. If the active field isn't specified, the default is true.

      • obfuscationSetting — (map)

        The updated setting that determines whether the slot value is obfuscated in the Amazon CloudWatch logs.

        • obfuscationSettingType — required — (String)

          Value that determines whether Amazon Lex obscures slot values in conversation logs. The default is to obscure the values.

          Possible values include:
          • "None"
          • "DefaultObfuscation"
      • botId — (String)

        The identifier of the bot that contains the slot.

      • botVersion — (String)

        The identifier of the slot version that contains the slot. Will always be DRAFT.

      • localeId — (String)

        The locale that contains the slot.

      • intentId — (String)

        The intent that contains the slot.

      • creationDateTime — (Date)

        The timestamp of the date and time that the slot was created.

      • lastUpdatedDateTime — (Date)

        The timestamp of the date and time that the slot was last updated.

      • multipleValuesSetting — (map)

        Indicates whether the slot accepts multiple values in one response.

        • allowMultipleValues — (Boolean)

          Indicates whether a slot can return multiple values. When true, the slot may return more than one value in a response. When false, the slot returns only a single value.

          Multi-value slots are only available in the en-US locale. If you set this value to true in any other locale, Amazon Lex throws a ValidationException.

          If the allowMutlipleValues is not set, the default value is false.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateSlotType(params = {}, callback) ⇒ AWS.Request

Updates the configuration of an existing slot type.

Service Reference:

Examples:

Calling the updateSlotType operation

var params = {
  botId: 'STRING_VALUE', /* required */
  botVersion: 'STRING_VALUE', /* required */
  localeId: 'STRING_VALUE', /* required */
  slotTypeId: 'STRING_VALUE', /* required */
  slotTypeName: 'STRING_VALUE', /* required */
  valueSelectionSetting: { /* required */
    resolutionStrategy: OriginalValue | TopResolution, /* required */
    regexFilter: {
      pattern: 'STRING_VALUE' /* required */
    }
  },
  description: 'STRING_VALUE',
  parentSlotTypeSignature: 'STRING_VALUE',
  slotTypeValues: [
    {
      sampleValue: {
        value: 'STRING_VALUE' /* required */
      },
      synonyms: [
        {
          value: 'STRING_VALUE' /* required */
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
lexmodelsv2.updateSlotType(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • slotTypeId — (String)

      The unique identifier of the slot type to update.

    • slotTypeName — (String)

      The new name of the slot type.

    • description — (String)

      The new description of the slot type.

    • slotTypeValues — (Array<map>)

      A new list of values and their optional synonyms that define the values that the slot type can take.

      • sampleValue — (map)

        The value of the slot type entry.

        • value — required — (String)

          The value that can be used for a slot type.

      • synonyms — (Array<map>)

        Additional values related to the slot type entry.

        • value — required — (String)

          The value that can be used for a slot type.

    • valueSelectionSetting — (map)

      The strategy that Amazon Lex should use when deciding on a value from the list of slot type values.

      • resolutionStrategy — required — (String)

        Determines the slot resolution strategy that Amazon Lex uses to return slot type values. The field can be set to one of the following values:

        • OriginalValue - Returns the value entered by the user, if the user value is similar to the slot value.

        • TopResolution - If there is a resolution list for the slot, return the first value in the resolution list as the slot type value. If there is no resolution list, null is returned.

        If you don't specify the valueSelectionStrategy, the default is OriginalValue.

        Possible values include:
        • "OriginalValue"
        • "TopResolution"
      • regexFilter — (map)

        A regular expression used to validate the value of a slot.

        • pattern — required — (String)

          A regular expression used to validate the value of a slot.

          Use a standard regular expression. Amazon Lex supports the following characters in the regular expression:

          • A-Z, a-z

          • 0-9

          • Unicode characters ("\ u<Unicode>")

          Represent Unicode characters with four digits, for example "\u0041" or "\u005A".

          The following regular expression operators are not supported:

          • Infinite repeaters: *, +, or {x,} with no upper bound.

          • Wild card (.)

    • parentSlotTypeSignature — (String)

      The new built-in slot type that should be used as the parent of this slot type.

    • botId — (String)

      The identifier of the bot that contains the slot type.

    • botVersion — (String)

      The version of the bot that contains the slot type. Must be DRAFT.

    • localeId — (String)

      The identifier of the language and locale that contains the slot type. The string must match one of the supported locales. For more information, see Supported languages.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • slotTypeId — (String)

        The unique identifier of the updated slot type.

      • slotTypeName — (String)

        The updated name of the slot type.

      • description — (String)

        The updated description of the slot type.

      • slotTypeValues — (Array<map>)

        The updated values that the slot type provides.

        • sampleValue — (map)

          The value of the slot type entry.

          • value — required — (String)

            The value that can be used for a slot type.

        • synonyms — (Array<map>)

          Additional values related to the slot type entry.

          • value — required — (String)

            The value that can be used for a slot type.

      • valueSelectionSetting — (map)

        The updated strategy that Amazon Lex uses to determine which value to select from the slot type.

        • resolutionStrategy — required — (String)

          Determines the slot resolution strategy that Amazon Lex uses to return slot type values. The field can be set to one of the following values:

          • OriginalValue - Returns the value entered by the user, if the user value is similar to the slot value.

          • TopResolution - If there is a resolution list for the slot, return the first value in the resolution list as the slot type value. If there is no resolution list, null is returned.

          If you don't specify the valueSelectionStrategy, the default is OriginalValue.

          Possible values include:
          • "OriginalValue"
          • "TopResolution"
        • regexFilter — (map)

          A regular expression used to validate the value of a slot.

          • pattern — required — (String)

            A regular expression used to validate the value of a slot.

            Use a standard regular expression. Amazon Lex supports the following characters in the regular expression:

            • A-Z, a-z

            • 0-9

            • Unicode characters ("\ u<Unicode>")

            Represent Unicode characters with four digits, for example "\u0041" or "\u005A".

            The following regular expression operators are not supported:

            • Infinite repeaters: *, +, or {x,} with no upper bound.

            • Wild card (.)

      • parentSlotTypeSignature — (String)

        The updated signature of the built-in slot type that is the parent of this slot type.

      • botId — (String)

        The identifier of the bot that contains the slot type.

      • botVersion — (String)

        The version of the bot that contains the slot type. This is always DRAFT.

      • localeId — (String)

        The language and locale of the updated slot type.

      • creationDateTime — (Date)

        The timestamp of the date and time that the slot type was created.

      • lastUpdatedDateTime — (Date)

        A timestamp of the date and time that the slot type was last updated.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

waitFor(state, params = {}, callback) ⇒ AWS.Request

Waits for a given LexModelsV2 resource. The final callback or 'complete' event will be fired only when the resource is either in its final state or the waiter has timed out and stopped polling for the final state.

Examples:

Waiting for the botAvailable state

var params = {
  botId: 'STRING_VALUE' /* required */
};
lexmodelsv2.waitFor('botAvailable', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • state (String) —

    the resource state to wait for. Available states for this service are listed in "Waiter Resource States" below.

  • params (map) (defaults to: {}) —

    a list of parameters for the given state. See each waiter resource state for required parameters.

Callback (callback):

  • function(err, data) { ... }

    Callback containing error and data information. See the respective resource state for the expected error or data information.

    If the waiter times out its requests, it will return a ResourceNotReady error.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

Waiter Resource Details

lexmodelsv2.waitFor('botAvailable', params = {}, [callback]) ⇒ AWS.Request

Waits for the botAvailable state by periodically calling the underlying LexModelsV2.describeBot() operation every 10 seconds (at most 35 times).

Examples:

Waiting for the botAvailable state

var params = {
  botId: 'STRING_VALUE' /* required */
};
lexmodelsv2.waitFor('botAvailable', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) —
    • botId — (String)

      The unique identifier of the bot to describe.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • botId — (String)

        The unique identifier of the bot.

      • botName — (String)

        The name of the bot.

      • description — (String)

        The description of the bot.

      • roleArn — (String)

        The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot.

      • dataPrivacy — (map)

        Settings for managing data privacy of the bot and its conversations with users.

        • childDirected — required — (Boolean)

          For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying true or false in the childDirected field. By specifying true in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ.

      • idleSessionTTLInSeconds — (Integer)

        The maximum time in seconds that Amazon Lex retains the data gathered in a conversation.

      • botStatus — (String)

        The current status of the bot. When the status is Available the bot is ready to be used in conversations with users.

        Possible values include:
        • "Creating"
        • "Available"
        • "Inactive"
        • "Deleting"
        • "Failed"
        • "Versioning"
        • "Importing"
      • creationDateTime — (Date)

        A timestamp of the date and time that the bot was created.

      • lastUpdatedDateTime — (Date)

        A timestamp of the date and time that the bot was last updated.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

See Also:

lexmodelsv2.waitFor('botAliasAvailable', params = {}, [callback]) ⇒ AWS.Request

Waits for the botAliasAvailable state by periodically calling the underlying LexModelsV2.describeBotAlias() operation every 10 seconds (at most 35 times).

Examples:

Waiting for the botAliasAvailable state

var params = {
  botAliasId: 'STRING_VALUE', /* required */
  botId: 'STRING_VALUE' /* required */
};
lexmodelsv2.waitFor('botAliasAvailable', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) —
    • botAliasId — (String)

      The identifier of the bot alias to describe.

    • botId — (String)

      The identifier of the bot associated with the bot alias to describe.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • botAliasId — (String)

        The identifier of the bot alias.

      • botAliasName — (String)

        The name of the bot alias.

      • description — (String)

        The description of the bot alias.

      • botVersion — (String)

        The version of the bot associated with the bot alias.

      • botAliasLocaleSettings — (map<map>)

        The locale settings that are unique to the alias.

        • enabled — required — (Boolean)

          Determines whether the locale is enabled for the bot. If the value is false, the locale isn't available for use.

        • codeHookSpecification — (map)

          Specifies the Lambda function that should be used in the locale.

          • lambdaCodeHook — required — (map)

            Specifies a Lambda function that verifies requests to a bot or fulfills the user's request to a bot.

            • lambdaARN — required — (String)

              The Amazon Resource Name (ARN) of the Lambda function.

            • codeHookInterfaceVersion — required — (String)

              The version of the request-response that you want Amazon Lex to use to invoke your Lambda function.

      • conversationLogSettings — (map)

        Specifics of how Amazon Lex logs text and audio conversations with the bot associated with the alias.

        • textLogSettings — (Array<map>)

          The Amazon CloudWatch Logs settings for logging text and metadata.

          • enabled — required — (Boolean)

            Determines whether conversation logs should be stored for an alias.

          • destination — required — (map)

            Defines the Amazon CloudWatch Logs destination log group for conversation text logs.

            • cloudWatch — required — (map)

              Defines the Amazon CloudWatch Logs log group where text and metadata logs are delivered.

              • cloudWatchLogGroupArn — required — (String)

                The Amazon Resource Name (ARN) of the log group where text and metadata logs are delivered.

              • logPrefix — required — (String)

                The prefix of the log stream name within the log group that you specified

        • audioLogSettings — (Array<map>)

          The Amazon S3 settings for logging audio to an S3 bucket.

          • enabled — required — (Boolean)

            Determines whether audio logging in enabled for the bot.

          • destination — required — (map)

            The location of audio log files collected when conversation logging is enabled for a bot.

            • s3Bucket — required — (map)

              The Amazon S3 bucket where the audio log files are stored. The IAM role specified in the roleArn parameter of the CreateBot operation must have permission to write to this bucket.

              • kmsKeyArn — (String)

                The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key for encrypting audio log files stored in an S3 bucket.

              • s3BucketArn — required — (String)

                The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio log files are stored.

              • logPrefix — required — (String)

                The S3 prefix to assign to audio log files.

      • sentimentAnalysisSettings — (map)

        Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.

        • detectSentiment — required — (Boolean)

          Sets whether Amazon Lex uses Amazon Comprehend to detect the sentiment of user utterances.

      • botAliasHistoryEvents — (Array<map>)

        A list of events that affect a bot alias. For example, an event is recorded when the version that the alias points to changes.

        • botVersion — (String)

          The version of the bot that was used in the event.

        • startDate — (Date)

          The date and time that the event started.

        • endDate — (Date)

          The date and time that the event ended.

      • botAliasStatus — (String)

        The current status of the alias. When the alias is Available, the alias is ready for use with your bot.

        Possible values include:
        • "Creating"
        • "Available"
        • "Deleting"
        • "Failed"
      • botId — (String)

        The identifier of the bot associated with the bot alias.

      • creationDateTime — (Date)

        A timestamp of the date and time that the alias was created.

      • lastUpdatedDateTime — (Date)

        A timestamp of the date and time that the alias was last updated.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

See Also:

lexmodelsv2.waitFor('botExportCompleted', params = {}, [callback]) ⇒ AWS.Request

Waits for the botExportCompleted state by periodically calling the underlying LexModelsV2.describeExport() operation every 10 seconds (at most 35 times).

Examples:

Waiting for the botExportCompleted state

var params = {
  exportId: 'STRING_VALUE' /* required */
};
lexmodelsv2.waitFor('botExportCompleted', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) —
    • exportId — (String)

      The unique identifier of the export to describe.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • exportId — (String)

        The unique identifier of the described export.

      • resourceSpecification — (map)

        The bot, bot ID, and optional locale ID of the exported bot or bot locale.

        • botExportSpecification — (map)

          Parameters for exporting a bot.

          • botId — required — (String)

            The identifier of the bot assigned by Amazon Lex.

          • botVersion — required — (String)

            The version of the bot that was exported. This will be either DRAFT or the version number.

        • botLocaleExportSpecification — (map)

          Parameters for exporting a bot locale.

          • botId — required — (String)

            The identifier of the bot to create the locale for.

          • botVersion — required — (String)

            The version of the bot to export.

          • localeId — required — (String)

            The identifier of the language and locale to export. The string must match one of the locales in the bot.

      • fileFormat — (String)

        The file format used in the files that describe the bot or bot locale.

        Possible values include:
        • "LexJson"
      • exportStatus — (String)

        The status of the export. When the status is Complete the export archive file is available for download.

        Possible values include:
        • "InProgress"
        • "Completed"
        • "Failed"
        • "Deleting"
      • failureReasons — (Array<String>)

        If the exportStatus is failed, contains one or more reasons why the export could not be completed.

      • downloadUrl — (String)

        A pre-signed S3 URL that points to the bot or bot locale archive. The URL is only available for 5 minutes after calling the DescribeExport operation.

      • creationDateTime — (Date)

        The date and time that the export was created.

      • lastUpdatedDateTime — (Date)

        The last date and time that the export was updated.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

See Also:

lexmodelsv2.waitFor('botImportCompleted', params = {}, [callback]) ⇒ AWS.Request

Waits for the botImportCompleted state by periodically calling the underlying LexModelsV2.describeImport() operation every 10 seconds (at most 35 times).

Examples:

Waiting for the botImportCompleted state

var params = {
  importId: 'STRING_VALUE' /* required */
};
lexmodelsv2.waitFor('botImportCompleted', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) —
    • importId — (String)

      The unique identifier of the import to describe.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • importId — (String)

        The unique identifier of the described import.

      • resourceSpecification — (map)

        The specifications of the imported bot or bot locale.

        • botImportSpecification — (map)

          Parameters for importing a bot.

          • botName — required — (String)

            The name that Amazon Lex should use for the bot.

          • roleArn — required — (String)

            The Amazon Resource Name (ARN) of the IAM role used to build and run the bot.

          • dataPrivacy — required — (map)

            By default, data stored by Amazon Lex is encrypted. The DataPrivacy structure provides settings that determine how Amazon Lex handles special cases of securing the data for your bot.

            • childDirected — required — (Boolean)

              For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying true or false in the childDirected field. By specifying true in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ.

          • idleSessionTTLInSeconds — (Integer)

            The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.

            A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Lex deletes any data provided before the timeout.

            You can specify between 60 (1 minute) and 86,400 (24 hours) seconds.

          • botTags — (map<String>)

            A list of tags to add to the bot. You can only add tags when you import a bot. You can't use the UpdateBot operation to update tags. To update tags, use the TagResource operation.

          • testBotAliasTags — (map<String>)

            A list of tags to add to the test alias for a bot. You can only add tags when you import a bot. You can't use the UpdateAlias operation to update tags. To update tags on the test alias, use the TagResource operation.

        • botLocaleImportSpecification — (map)

          Parameters for importing a bot locale.

          • botId — required — (String)

            The identifier of the bot to import the locale to.

          • botVersion — required — (String)

            The version of the bot to import the locale to. This can only be the DRAFT version of the bot.

          • localeId — required — (String)

            The identifier of the language and locale that the bot will be used in. The string must match one of the supported locales. All of the intents, slot types, and slots used in the bot must have the same locale. For more information, see Supported languages.

          • nluIntentConfidenceThreshold — (Float)

            Determines the threshold where Amazon Lex will insert the AMAZON.FallbackIntent, AMAZON.KendraSearchIntent, or both when returning alternative intents. AMAZON.FallbackIntent and AMAZON.KendraSearchIntent are only inserted if they are configured for the bot.

            For example, suppose a bot is configured with the confidence threshold of 0.80 and the AMAZON.FallbackIntent. Amazon Lex returns three alternative intents with the following confidence scores: IntentA (0.70), IntentB (0.60), IntentC (0.50). The response from the PostText operation would be:

            • AMAZON.FallbackIntent

            • IntentA

            • IntentB

            • IntentC

          • voiceSettings — (map)

            Defines settings for using an Amazon Polly voice to communicate with a user.

            • voiceId — required — (String)

              The identifier of the Amazon Polly voice to use.

      • importedResourceId — (String)

        The unique identifier that Amazon Lex assigned to the resource created by the import.

      • importedResourceName — (String)

        The name of the imported resource.

      • mergeStrategy — (String)

        The strategy used when there was a name conflict between the imported resource and an existing resource. When the merge strategy is FailOnConflict existing resources are not overwritten and the import fails.

        Possible values include:
        • "Overwrite"
        • "FailOnConflict"
      • importStatus — (String)

        The status of the import process. When the status is Completed the resource is imported and ready for use.

        Possible values include:
        • "InProgress"
        • "Completed"
        • "Failed"
        • "Deleting"
      • failureReasons — (Array<String>)

        If the importStatus field is Failed, this provides one or more reasons for the failure.

      • creationDateTime — (Date)

        The date and time that the import was created.

      • lastUpdatedDateTime — (Date)

        The date and time that the import was last updated.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

See Also:

lexmodelsv2.waitFor('botLocaleBuilt', params = {}, [callback]) ⇒ AWS.Request

Waits for the botLocaleBuilt state by periodically calling the underlying LexModelsV2.describeBotLocale() operation every 10 seconds (at most 35 times).

Examples:

Waiting for the botLocaleBuilt state

var params = {
  botId: 'STRING_VALUE', /* required */
  botVersion: 'STRING_VALUE', /* required */
  localeId: 'STRING_VALUE' /* required */
};
lexmodelsv2.waitFor('botLocaleBuilt', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) —
    • botId — (String)

      The identifier of the bot associated with the locale.

    • botVersion — (String)

      The identifier of the version of the bot associated with the locale.

    • localeId — (String)

      The unique identifier of the locale to describe. The string must match one of the supported locales. For more information, see Supported languages.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • botId — (String)

        The identifier of the bot associated with the locale.

      • botVersion — (String)

        The identifier of the version of the bot associated with the locale.

      • localeId — (String)

        The unique identifier of the described locale.

      • localeName — (String)

        The name of the locale.

      • description — (String)

        The description of the locale.

      • nluIntentConfidenceThreshold — (Float)

        The confidence threshold where Amazon Lex inserts the AMAZON.FallbackIntent and AMAZON.KendraSearchIntent intents in the list of possible intents for an utterance.

      • voiceSettings — (map)

        The Amazon Polly voice Amazon Lex uses for voice interaction with the user.

        • voiceId — required — (String)

          The identifier of the Amazon Polly voice to use.

      • intentsCount — (Integer)

        The number of intents defined for the locale.

      • slotTypesCount — (Integer)

        The number of slot types defined for the locale.

      • botLocaleStatus — (String)

        The status of the bot. If the status is Failed, the reasons for the failure are listed in the failureReasons field.

        Possible values include:
        • "Creating"
        • "Building"
        • "Built"
        • "ReadyExpressTesting"
        • "Failed"
        • "Deleting"
        • "NotBuilt"
        • "Importing"
      • failureReasons — (Array<String>)

        if botLocaleStatus is Failed, Amazon Lex explains why it failed to build the bot.

      • creationDateTime — (Date)

        The date and time that the locale was created.

      • lastUpdatedDateTime — (Date)

        The date and time that the locale was last updated.

      • lastBuildSubmittedDateTime — (Date)

        The date and time that the locale was last submitted for building.

      • botLocaleHistoryEvents — (Array<map>)

        History of changes, such as when a locale is used in an alias, that have taken place for the locale.

        • event — required — (String)

          A description of the event that occurred.

        • eventDate — required — (Date)

          A timestamp of the date and time that the event occurred.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

See Also:

lexmodelsv2.waitFor('botLocaleExpressTestingAvailable', params = {}, [callback]) ⇒ AWS.Request

Waits for the botLocaleExpressTestingAvailable state by periodically calling the underlying LexModelsV2.describeBotLocale() operation every 10 seconds (at most 35 times).

Examples:

Waiting for the botLocaleExpressTestingAvailable state

var params = {
  botId: 'STRING_VALUE', /* required */
  botVersion: 'STRING_VALUE', /* required */
  localeId: 'STRING_VALUE' /* required */
};
lexmodelsv2.waitFor('botLocaleExpressTestingAvailable', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) —
    • botId — (String)

      The identifier of the bot associated with the locale.

    • botVersion — (String)

      The identifier of the version of the bot associated with the locale.

    • localeId — (String)

      The unique identifier of the locale to describe. The string must match one of the supported locales. For more information, see Supported languages.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • botId — (String)

        The identifier of the bot associated with the locale.

      • botVersion — (String)

        The identifier of the version of the bot associated with the locale.

      • localeId — (String)

        The unique identifier of the described locale.

      • localeName — (String)

        The name of the locale.

      • description — (String)

        The description of the locale.

      • nluIntentConfidenceThreshold — (Float)

        The confidence threshold where Amazon Lex inserts the AMAZON.FallbackIntent and AMAZON.KendraSearchIntent intents in the list of possible intents for an utterance.

      • voiceSettings — (map)

        The Amazon Polly voice Amazon Lex uses for voice interaction with the user.

        • voiceId — required — (String)

          The identifier of the Amazon Polly voice to use.

      • intentsCount — (Integer)

        The number of intents defined for the locale.

      • slotTypesCount — (Integer)

        The number of slot types defined for the locale.

      • botLocaleStatus — (String)

        The status of the bot. If the status is Failed, the reasons for the failure are listed in the failureReasons field.

        Possible values include:
        • "Creating"
        • "Building"
        • "Built"
        • "ReadyExpressTesting"
        • "Failed"
        • "Deleting"
        • "NotBuilt"
        • "Importing"
      • failureReasons — (Array<String>)

        if botLocaleStatus is Failed, Amazon Lex explains why it failed to build the bot.

      • creationDateTime — (Date)

        The date and time that the locale was created.

      • lastUpdatedDateTime — (Date)

        The date and time that the locale was last updated.

      • lastBuildSubmittedDateTime — (Date)

        The date and time that the locale was last submitted for building.

      • botLocaleHistoryEvents — (Array<map>)

        History of changes, such as when a locale is used in an alias, that have taken place for the locale.

        • event — required — (String)

          A description of the event that occurred.

        • eventDate — required — (Date)

          A timestamp of the date and time that the event occurred.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

See Also:

lexmodelsv2.waitFor('botVersionAvailable', params = {}, [callback]) ⇒ AWS.Request

Waits for the botVersionAvailable state by periodically calling the underlying LexModelsV2.describeBotVersion() operation every 10 seconds (at most 35 times).

Examples:

Waiting for the botVersionAvailable state

var params = {
  botId: 'STRING_VALUE', /* required */
  botVersion: 'STRING_VALUE' /* required */
};
lexmodelsv2.waitFor('botVersionAvailable', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) —
    • botId — (String)

      The identifier of the bot containing the version to return metadata for.

    • botVersion — (String)

      The version of the bot to return metadata for.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • botId — (String)

        The identifier of the bot that contains the version.

      • botName — (String)

        The name of the bot that contains the version.

      • botVersion — (String)

        The version of the bot to describe.

      • description — (String)

        The description specified for the bot.

      • roleArn — (String)

        The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot version.

      • dataPrivacy — (map)

        Data privacy settings for the bot version.

        • childDirected — required — (Boolean)

          For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying true or false in the childDirected field. By specifying true in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ.

      • idleSessionTTLInSeconds — (Integer)

        The number of seconds that a session with the bot remains active before it is discarded by Amazon Lex.

      • botStatus — (String)

        The current status of the bot. When the status is Available, the bot version is ready for use.

        Possible values include:
        • "Creating"
        • "Available"
        • "Inactive"
        • "Deleting"
        • "Failed"
        • "Versioning"
        • "Importing"
      • failureReasons — (Array<String>)

        If the botStatus is Failed, this contains a list of reasons that the version couldn't be built.

      • creationDateTime — (Date)

        A timestamp of the date and time that the bot version was created.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

See Also:

lexmodelsv2.waitFor('botLocaleCreated', params = {}, [callback]) ⇒ AWS.Request

Waits for the botLocaleCreated state by periodically calling the underlying LexModelsV2.describeBotLocale() operation every 10 seconds (at most 35 times).

Examples:

Waiting for the botLocaleCreated state

var params = {
  botId: 'STRING_VALUE', /* required */
  botVersion: 'STRING_VALUE', /* required */
  localeId: 'STRING_VALUE' /* required */
};
lexmodelsv2.waitFor('botLocaleCreated', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) —
    • botId — (String)

      The identifier of the bot associated with the locale.

    • botVersion — (String)

      The identifier of the version of the bot associated with the locale.

    • localeId — (String)

      The unique identifier of the locale to describe. The string must match one of the supported locales. For more information, see Supported languages.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • botId — (String)

        The identifier of the bot associated with the locale.

      • botVersion — (String)

        The identifier of the version of the bot associated with the locale.

      • localeId — (String)

        The unique identifier of the described locale.

      • localeName — (String)

        The name of the locale.

      • description — (String)

        The description of the locale.

      • nluIntentConfidenceThreshold — (Float)

        The confidence threshold where Amazon Lex inserts the AMAZON.FallbackIntent and AMAZON.KendraSearchIntent intents in the list of possible intents for an utterance.

      • voiceSettings — (map)

        The Amazon Polly voice Amazon Lex uses for voice interaction with the user.

        • voiceId — required — (String)

          The identifier of the Amazon Polly voice to use.

      • intentsCount — (Integer)

        The number of intents defined for the locale.

      • slotTypesCount — (Integer)

        The number of slot types defined for the locale.

      • botLocaleStatus — (String)

        The status of the bot. If the status is Failed, the reasons for the failure are listed in the failureReasons field.

        Possible values include:
        • "Creating"
        • "Building"
        • "Built"
        • "ReadyExpressTesting"
        • "Failed"
        • "Deleting"
        • "NotBuilt"
        • "Importing"
      • failureReasons — (Array<String>)

        if botLocaleStatus is Failed, Amazon Lex explains why it failed to build the bot.

      • creationDateTime — (Date)

        The date and time that the locale was created.

      • lastUpdatedDateTime — (Date)

        The date and time that the locale was last updated.

      • lastBuildSubmittedDateTime — (Date)

        The date and time that the locale was last submitted for building.

      • botLocaleHistoryEvents — (Array<map>)

        History of changes, such as when a locale is used in an alias, that have taken place for the locale.

        • event — required — (String)

          A description of the event that occurred.

        • eventDate — required — (Date)

          A timestamp of the date and time that the event occurred.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

See Also: