Class: AWS.LexModelBuildingService

Inherits:
AWS.Service show all
Identifier:
lexmodelbuildingservice
API Version:
2017-04-19
Defined in:
(unknown)

Overview

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

Sending a Request Using LexModelBuildingService

var lexmodelbuildingservice = new AWS.LexModelBuildingService();
lexmodelbuildingservice.createBotVersion(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 LexModelBuildingService object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var lexmodelbuildingservice = new AWS.LexModelBuildingService({apiVersion: '2017-04-19'});

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

AWS.config.apiVersions = {
  lexmodelbuildingservice: '2017-04-19',
  // other service API versions
};

var lexmodelbuildingservice = new AWS.LexModelBuildingService();

Version:

  • 2017-04-19

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

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

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

Examples:

Constructing a LexModelBuildingService object

var lexmodelbuildingservice = new AWS.LexModelBuildingService({apiVersion: '2017-04-19'});

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)

    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'.

  • 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.LexModelBuildingService.region for more information.

  • maxRetries (Integer)

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

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.LexModelBuildingService.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.

  • 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 returns the amount of time to delay in milliseconds. The base option will be ignored if this option is supplied.
  • 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.

Property Details

endpointAWS.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

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

Creates a new version of the bot based on the $LATEST version. If the $LATEST 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.

Note: You can update only the $LATEST version of the bot. You can't update the numbered versions that you create with the CreateBotVersion operation.

When you create the first version of a bot, Amazon Lex sets the version to 1. Subsequent versions increment by 1. For more information, see versioning-intro.

This operation requires permission for the lex:CreateBotVersion action.

Service Reference:

Examples:

Calling the createBotVersion operation

var params = {
  name: 'STRING_VALUE', /* required */
  checksum: 'STRING_VALUE'
};
lexmodelbuildingservice.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: {})
    • name — (String)

      The name of the bot that you want to create a new version of. The name is case sensitive.

    • checksum — (String)

      Identifies a specific revision of the $LATEST version of the bot. If you specify a checksum and the $LATEST version of the bot has a different checksum, a PreconditionFailedException exception is returned and Amazon Lex doesn't publish a new version. If you don't specify a checksum, Amazon Lex publishes the $LATEST version.

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:

      • name — (String)

        The name of the bot.

      • description — (String)

        A description of the bot.

      • intents — (Array<map>)

        An array of Intent objects. For more information, see PutBot.

        • intentNamerequired — (String)

          The name of the intent.

        • intentVersionrequired — (String)

          The version of the intent.

      • clarificationPrompt — (map)

        The message that Amazon Lex uses when it doesn't understand the user's request. For more information, see PutBot.

        • messagesrequired — (Array<map>)

          An array of objects, each of which provides a message string and its type. You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML).

          • contentTyperequired — (String)

            The content type of the message string.

            Possible values include:
            • "PlainText"
            • "SSML"
          • contentrequired — (String)

            The text of the message.

        • maxAttemptsrequired — (Integer)

          The number of times to prompt the user for information.

        • responseCard — (String)

          A response card. Amazon Lex uses this prompt at runtime, in the PostText API response. It substitutes session attributes and slot values for placeholders in the response card. For more information, see ex-resp-card.

      • abortStatement — (map)

        The message that Amazon Lex uses to abort a conversation. For more information, see PutBot.

        • messagesrequired — (Array<map>)

          A collection of message objects.

          • contentTyperequired — (String)

            The content type of the message string.

            Possible values include:
            • "PlainText"
            • "SSML"
          • contentrequired — (String)

            The text of the message.

        • responseCard — (String)

          At runtime, if the client is using the PostText API, Amazon Lex includes the response card in the response. It substitutes all of the session attributes and slot values for placeholders in the response card.

      • status — (String)

        When you send a request to create or update a bot, Amazon Lex sets the status response element to BUILDING. After Amazon Lex builds the bot, it sets status to READY. If Amazon Lex can't build the bot, it sets status to FAILED. Amazon Lex returns the reason for the failure in the failureReason response element.

        Possible values include:
        • "BUILDING"
        • "READY"
        • "FAILED"
        • "NOT_BUILT"
      • failureReason — (String)

        If status is FAILED, Amazon Lex provides the reason that it failed to build the bot.

      • lastUpdatedDate — (Date)

        The date when the $LATEST version of this bot was updated.

      • createdDate — (Date)

        The date when the bot version was created.

      • idleSessionTTLInSeconds — (Integer)

        The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. For more information, see PutBot.

      • voiceId — (String)

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

      • checksum — (String)

        Checksum identifying the version of the bot that was created.

      • version — (String)

        The version of the bot.

      • locale — (String)

        Specifies the target locale for the bot.

        Possible values include:
        • "en-US"
      • childDirected — (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.

Returns:

  • (AWS.Request)

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

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

Creates a new version of an intent based on the $LATEST version of the intent. If the $LATEST version of this intent hasn't changed since you last updated it, Amazon Lex doesn't create a new version. It returns the last version you created.

Note: You can update only the $LATEST version of the intent. You can't update the numbered versions that you create with the CreateIntentVersion operation.

When you create a version of an intent, Amazon Lex sets the version to 1. Subsequent versions increment by 1. For more information, see versioning-intro.

This operation requires permissions to perform the lex:CreateIntentVersion action.

Service Reference:

Examples:

Calling the createIntentVersion operation

var params = {
  name: 'STRING_VALUE', /* required */
  checksum: 'STRING_VALUE'
};
lexmodelbuildingservice.createIntentVersion(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: {})
    • name — (String)

      The name of the intent that you want to create a new version of. The name is case sensitive.

    • checksum — (String)

      Checksum of the $LATEST version of the intent that should be used to create the new version. If you specify a checksum and the $LATEST version of the intent has a different checksum, Amazon Lex returns a PreconditionFailedException exception and doesn't publish a new version. If you don't specify a checksum, Amazon Lex publishes the $LATEST version.

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:

      • name — (String)

        The name of the intent.

      • description — (String)

        A description of the intent.

      • slots — (Array<map>)

        An array of slot types that defines the information required to fulfill the intent.

        • namerequired — (String)

          The name of the slot.

        • description — (String)

          A description of the slot.

        • slotConstraintrequired — (String)

          Specifies whether the slot is required or optional.

          Possible values include:
          • "Required"
          • "Optional"
        • slotType — (String)

          The type of the slot, either a custom slot type that you defined or one of the built-in slot types.

        • slotTypeVersion — (String)

          The version of the slot type.

        • valueElicitationPrompt — (map)

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

          • messagesrequired — (Array<map>)

            An array of objects, each of which provides a message string and its type. You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML).

            • contentTyperequired — (String)

              The content type of the message string.

              Possible values include:
              • "PlainText"
              • "SSML"
            • contentrequired — (String)

              The text of the message.

          • maxAttemptsrequired — (Integer)

            The number of times to prompt the user for information.

          • responseCard — (String)

            A response card. Amazon Lex uses this prompt at runtime, in the PostText API response. It substitutes session attributes and slot values for placeholders in the response card. For more information, see ex-resp-card.

        • priority — (Integer)

          Directs Lex the order in which to elicit this slot value from the user. For example, if the intent has two slots with priorities 1 and 2, AWS Lex first elicits a value for the slot with priority 1.

          If multiple slots share the same priority, the order in which Lex elicits values is arbitrary.

        • sampleUtterances — (Array<String>)

          If you know a specific pattern with which 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.

        • responseCard — (String)

          A set of possible responses for the slot type used by text-based clients. A user chooses an option from the response card, instead of using text to reply.

      • sampleUtterances — (Array<String>)

        An array of sample utterances configured for the intent.

      • confirmationPrompt — (map)

        If defined, the prompt that Amazon Lex uses to confirm the user's intent before fulfilling it.

        • messagesrequired — (Array<map>)

          An array of objects, each of which provides a message string and its type. You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML).

          • contentTyperequired — (String)

            The content type of the message string.

            Possible values include:
            • "PlainText"
            • "SSML"
          • contentrequired — (String)

            The text of the message.

        • maxAttemptsrequired — (Integer)

          The number of times to prompt the user for information.

        • responseCard — (String)

          A response card. Amazon Lex uses this prompt at runtime, in the PostText API response. It substitutes session attributes and slot values for placeholders in the response card. For more information, see ex-resp-card.

      • rejectionStatement — (map)

        If the user answers "no" to the question defined in confirmationPrompt, Amazon Lex responds with this statement to acknowledge that the intent was canceled.

        • messagesrequired — (Array<map>)

          A collection of message objects.

          • contentTyperequired — (String)

            The content type of the message string.

            Possible values include:
            • "PlainText"
            • "SSML"
          • contentrequired — (String)

            The text of the message.

        • responseCard — (String)

          At runtime, if the client is using the PostText API, Amazon Lex includes the response card in the response. It substitutes all of the session attributes and slot values for placeholders in the response card.

      • followUpPrompt — (map)

        If defined, Amazon Lex uses this prompt to solicit additional user activity after the intent is fulfilled.

        • promptrequired — (map)

          Prompts for information from the user.

          • messagesrequired — (Array<map>)

            An array of objects, each of which provides a message string and its type. You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML).

            • contentTyperequired — (String)

              The content type of the message string.

              Possible values include:
              • "PlainText"
              • "SSML"
            • contentrequired — (String)

              The text of the message.

          • maxAttemptsrequired — (Integer)

            The number of times to prompt the user for information.

          • responseCard — (String)

            A response card. Amazon Lex uses this prompt at runtime, in the PostText API response. It substitutes session attributes and slot values for placeholders in the response card. For more information, see ex-resp-card.

        • rejectionStatementrequired — (map)

          If the user answers "no" to the question defined in the prompt field, Amazon Lex responds with this statement to acknowledge that the intent was canceled.

          • messagesrequired — (Array<map>)

            A collection of message objects.

            • contentTyperequired — (String)

              The content type of the message string.

              Possible values include:
              • "PlainText"
              • "SSML"
            • contentrequired — (String)

              The text of the message.

          • responseCard — (String)

            At runtime, if the client is using the PostText API, Amazon Lex includes the response card in the response. It substitutes all of the session attributes and slot values for placeholders in the response card.

      • conclusionStatement — (map)

        After the Lambda function specified in the fulfillmentActivity field fulfills the intent, Amazon Lex conveys this statement to the user.

        • messagesrequired — (Array<map>)

          A collection of message objects.

          • contentTyperequired — (String)

            The content type of the message string.

            Possible values include:
            • "PlainText"
            • "SSML"
          • contentrequired — (String)

            The text of the message.

        • responseCard — (String)

          At runtime, if the client is using the PostText API, Amazon Lex includes the response card in the response. It substitutes all of the session attributes and slot values for placeholders in the response card.

      • dialogCodeHook — (map)

        If defined, Amazon Lex invokes this Lambda function for each user input.

        • urirequired — (String)

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

        • messageVersionrequired — (String)

          The version of the request-response that you want Amazon Lex to use to invoke your Lambda function. For more information, see using-lambda.

      • fulfillmentActivity — (map)

        Describes how the intent is fulfilled.

        • typerequired — (String)

          How the intent should be fulfilled, either by running a Lambda function or by returning the slot data to the client application.

          Possible values include:
          • "ReturnIntent"
          • "CodeHook"
        • codeHook — (map)

          A description of the Lambda function that is run to fulfill the intent.

          • urirequired — (String)

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

          • messageVersionrequired — (String)

            The version of the request-response that you want Amazon Lex to use to invoke your Lambda function. For more information, see using-lambda.

      • parentIntentSignature — (String)

        A unique identifier for a built-in intent.

      • lastUpdatedDate — (Date)

        The date that the intent was updated.

      • createdDate — (Date)

        The date that the intent was created.

      • version — (String)

        The version number assigned to the new version of the intent.

      • checksum — (String)

        Checksum of the intent version created.

Returns:

  • (AWS.Request)

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

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

Creates a new version of a slot type based on the $LATEST version of the specified slot type. If the $LATEST version of this resource has not changed since the last version that you created, Amazon Lex doesn't create a new version. It returns the last version that you created.

Note: You can update only the $LATEST version of a slot type. You can't update the numbered versions that you create with the CreateSlotTypeVersion operation.

When you create a version of a slot type, Amazon Lex sets the version to 1. Subsequent versions increment by 1. For more information, see versioning-intro.

This operation requires permissions for the lex:CreateSlotTypeVersion action.

Service Reference:

Examples:

Calling the createSlotTypeVersion operation

var params = {
  name: 'STRING_VALUE', /* required */
  checksum: 'STRING_VALUE'
};
lexmodelbuildingservice.createSlotTypeVersion(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: {})
    • name — (String)

      The name of the slot type that you want to create a new version for. The name is case sensitive.

    • checksum — (String)

      Checksum for the $LATEST version of the slot type that you want to publish. If you specify a checksum and the $LATEST version of the slot type has a different checksum, Amazon Lex returns a PreconditionFailedException exception and doesn't publish the new version. If you don't specify a checksum, Amazon Lex publishes the $LATEST version.

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:

      • name — (String)

        The name of the slot type.

      • description — (String)

        A description of the slot type.

      • enumerationValues — (Array<map>)

        A list of EnumerationValue objects that defines the values that the slot type can take.

        • valuerequired — (String)

          The value of the slot type.

      • lastUpdatedDate — (Date)

        The date that the slot type was updated. When you create a resource, the creation date and last update date are the same.

      • createdDate — (Date)

        The date that the slot type was created.

      • version — (String)

        The version assigned to the new slot type version.

      • checksum — (String)

        Checksum of the $LATEST version of the slot type.

Returns:

  • (AWS.Request)

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

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

Deletes all versions of the bot, including the $LATEST version. To delete a specific version of the bot, use the DeleteBotVersion operation.

If a bot has an alias, you can't delete it. Instead, the DeleteBot operation returns a ResourceInUseException exception that includes a reference to the alias that refers to the bot. To remove the reference to the bot, delete the alias. If you get the same exception again, delete the referring alias until the DeleteBot operation is successful.

This operation requires permissions for the lex:DeleteBot action.

Service Reference:

Examples:

Calling the deleteBot operation

var params = {
  name: 'STRING_VALUE' /* required */
};
lexmodelbuildingservice.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: {})
    • name — (String)

      The name of the bot. The name is case sensitive.

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.

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

Deletes an alias for the specified bot.

You can't delete an alias that is used in the association between a bot and a messaging channel. If an alias is used in a channel association, the DeleteBot operation returns a ResourceInUseException exception that includes a reference to the channel association that refers to the bot. You can remove the reference to the alias by deleting the channel association. If you get the same exception again, delete the referring association until the DeleteBotAlias operation is successful.

Service Reference:

Examples:

Calling the deleteBotAlias operation

var params = {
  botName: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE' /* required */
};
lexmodelbuildingservice.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: {})
    • name — (String)

      The name of the alias to delete. The name is case sensitive.

    • botName — (String)

      The name of the bot that the alias points 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.

Returns:

  • (AWS.Request)

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

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

Deletes the association between an Amazon Lex bot and a messaging platform.

This operation requires permission for the lex:DeleteBotChannelAssociation action.

Service Reference:

Examples:

Calling the deleteBotChannelAssociation operation

var params = {
  botAlias: 'STRING_VALUE', /* required */
  botName: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE' /* required */
};
lexmodelbuildingservice.deleteBotChannelAssociation(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: {})
    • name — (String)

      The name of the association. The name is case sensitive.

    • botName — (String)

      The name of the Amazon Lex bot.

    • botAlias — (String)

      An alias that points to the specific version of the Amazon Lex bot to which this association is being made.

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.

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

Deletes a specific version of a bot. To delete all versions of a bot, use the DeleteBot operation.

This operation requires permissions for the lex:DeleteBotVersion action.

Service Reference:

Examples:

Calling the deleteBotVersion operation

var params = {
  name: 'STRING_VALUE', /* required */
  version: 'STRING_VALUE' /* required */
};
lexmodelbuildingservice.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: {})
    • name — (String)

      The name of the bot.

    • version — (String)

      The version of the bot to delete. You cannot delete the $LATEST version of the bot. To delete the $LATEST version, use the DeleteBot 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.

Returns:

  • (AWS.Request)

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

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

Deletes all versions of the intent, including the $LATEST version. To delete a specific version of the intent, use the DeleteIntentVersion operation.

You can delete a version of an intent only if it is not referenced. To delete an intent that is referred to in one or more bots (see how-it-works), you must remove those references first.

Note: If you get the ResourceInUseException exception, it provides an example reference that shows where the intent is referenced. To remove the reference to the intent, either update the bot or delete it. If you get the same exception when you attempt to delete the intent again, repeat until the intent has no references and the call to DeleteIntent is successful.

This operation requires permission for the lex:DeleteIntent action.

Service Reference:

Examples:

Calling the deleteIntent operation

var params = {
  name: 'STRING_VALUE' /* required */
};
lexmodelbuildingservice.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: {})
    • name — (String)

      The name of the intent. The name is case sensitive.

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.

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

Deletes a specific version of an intent. To delete all versions of a intent, use the DeleteIntent operation.

This operation requires permissions for the lex:DeleteIntentVersion action.

Service Reference:

Examples:

Calling the deleteIntentVersion operation

var params = {
  name: 'STRING_VALUE', /* required */
  version: 'STRING_VALUE' /* required */
};
lexmodelbuildingservice.deleteIntentVersion(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: {})
    • name — (String)

      The name of the intent.

    • version — (String)

      The version of the intent to delete. You cannot delete the $LATEST version of the intent. To delete the $LATEST version, use the DeleteIntent 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.

Returns:

  • (AWS.Request)

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

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

Deletes all versions of the slot type, including the $LATEST version. To delete a specific version of the slot type, use the DeleteSlotTypeVersion operation.

You can delete a version of a slot type only if it is not referenced. To delete a slot type that is referred to in one or more intents, you must remove those references first.

Note: If you get the ResourceInUseException exception, the exception provides an example reference that shows the intent where the slot type is referenced. To remove the reference to the slot type, either update the intent or delete it. If you get the same exception when you attempt to delete the slot type again, repeat until the slot type has no references and the DeleteSlotType call is successful.

This operation requires permission for the lex:DeleteSlotType action.

Service Reference:

Examples:

Calling the deleteSlotType operation

var params = {
  name: 'STRING_VALUE' /* required */
};
lexmodelbuildingservice.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: {})
    • name — (String)

      The name of the slot type. The name is case sensitive.

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.

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

Deletes a specific version of a slot type. To delete all versions of a slot type, use the DeleteSlotType operation.

This operation requires permissions for the lex:DeleteSlotTypeVersion action.

Service Reference:

Examples:

Calling the deleteSlotTypeVersion operation

var params = {
  name: 'STRING_VALUE', /* required */
  version: 'STRING_VALUE' /* required */
};
lexmodelbuildingservice.deleteSlotTypeVersion(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: {})
    • name — (String)

      The name of the slot type.

    • version — (String)

      The version of the slot type to delete. You cannot delete the $LATEST version of the slot type. To delete the $LATEST version, use the DeleteSlotType 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.

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 unless the childDirected field in the bot is set to true. Utterances are stored for 15 days for use with the GetUtterancesView operation, and then stored indefinately for use in improving the ability of your bot to respond to user input.

Use the DeleteStoredUtterances operation to manually delete stored utterances for a specific user.

This operation requires permissions for the lex:DeleteUtterances action.

Service Reference:

Examples:

Calling the deleteUtterances operation

var params = {
  botName: 'STRING_VALUE', /* required */
  userId: 'STRING_VALUE' /* required */
};
lexmodelbuildingservice.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: {})
    • botName — (String)

      The name of the bot that stored the utterances.

    • userId — (String)

      The unique identifier for the user that made the utterances. This is the user ID that was sent in the PostContent or PostText operation request that contained the utterance.

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.

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

Returns metadata information for a specific bot. You must provide the bot name and the bot version or alias.

The GetBot operation requires permissions for the lex:GetBot action.

Service Reference:

Examples:

To get information about a bot


/* This example shows how to get configuration information for a bot. */

 var params = {
  name: "DocOrderPizza", 
  versionOrAlias: "$LATEST"
 };
 lexmodelbuildingservice.getBot(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    version: "$LATEST", 
    name: "DocOrderPizzaBot", 
    abortStatement: {
     messages: [
        {
       content: "I don't understand. Can you try again?", 
       contentType: "PlainText"
      }, 
        {
       content: "I'm sorry, I don't understand.", 
       contentType: "PlainText"
      }
     ]
    }, 
    checksum: "20172ee3-fa06-49b2-bbc5-667c090303e9", 
    childDirected: true, 
    clarificationPrompt: {
     maxAttempts: 1, 
     messages: [
        {
       content: "I'm sorry, I didn't hear that. Can you repeate what you just said?", 
       contentType: "PlainText"
      }, 
        {
       content: "Can you say that again?", 
       contentType: "PlainText"
      }
     ]
    }, 
    createdDate: <Date Representation>, 
    description: "Orders a pizza from a local pizzeria.", 
    idleSessionTTLInSeconds: 300, 
    intents: [
       {
      intentName: "DocOrderPizza", 
      intentVersion: "$LATEST"
     }
    ], 
    lastUpdatedDate: <Date Representation>, 
    locale: "en-US", 
    status: "NOT_BUILT"
   }
   */
 });

Calling the getBot operation

var params = {
  name: 'STRING_VALUE', /* required */
  versionOrAlias: 'STRING_VALUE' /* required */
};
lexmodelbuildingservice.getBot(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: {})
    • name — (String)

      The name of the bot. The name is case sensitive.

    • versionOrAlias — (String)

      The version or alias of the bot.

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:

      • name — (String)

        The name of the bot.

      • description — (String)

        A description of the bot.

      • intents — (Array<map>)

        An array of intent objects. For more information, see PutBot.

        • intentNamerequired — (String)

          The name of the intent.

        • intentVersionrequired — (String)

          The version of the intent.

      • clarificationPrompt — (map)

        The message Amazon Lex uses when it doesn't understand the user's request. For more information, see PutBot.

        • messagesrequired — (Array<map>)

          An array of objects, each of which provides a message string and its type. You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML).

          • contentTyperequired — (String)

            The content type of the message string.

            Possible values include:
            • "PlainText"
            • "SSML"
          • contentrequired — (String)

            The text of the message.

        • maxAttemptsrequired — (Integer)

          The number of times to prompt the user for information.

        • responseCard — (String)

          A response card. Amazon Lex uses this prompt at runtime, in the PostText API response. It substitutes session attributes and slot values for placeholders in the response card. For more information, see ex-resp-card.

      • abortStatement — (map)

        The message that Amazon Lex returns when the user elects to end the conversation without completing it. For more information, see PutBot.

        • messagesrequired — (Array<map>)

          A collection of message objects.

          • contentTyperequired — (String)

            The content type of the message string.

            Possible values include:
            • "PlainText"
            • "SSML"
          • contentrequired — (String)

            The text of the message.

        • responseCard — (String)

          At runtime, if the client is using the PostText API, Amazon Lex includes the response card in the response. It substitutes all of the session attributes and slot values for placeholders in the response card.

      • status — (String)

        The status of the bot. If the bot is ready to run, the status is READY. If there was a problem with building the bot, the status is FAILED and the failureReason explains why the bot did not build. If the bot was saved but not built, the status is NOT BUILT.

        Possible values include:
        • "BUILDING"
        • "READY"
        • "FAILED"
        • "NOT_BUILT"
      • failureReason — (String)

        If status is FAILED, Amazon Lex explains why it failed to build the bot.

      • lastUpdatedDate — (Date)

        The date that the bot was updated. When you create a resource, the creation date and last updated date are the same.

      • createdDate — (Date)

        The date that the bot was created.

      • idleSessionTTLInSeconds — (Integer)

        The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. For more information, see PutBot.

      • voiceId — (String)

        The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user. For more information, see PutBot.

      • checksum — (String)

        Checksum of the bot used to identify a specific revision of the bot's $LATEST version.

      • version — (String)

        The version of the bot. For a new bot, the version is always $LATEST.

      • locale — (String)

        The target locale for the bot.

        Possible values include:
        • "en-US"
      • childDirected — (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.

Returns:

  • (AWS.Request)

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

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

Returns information about an Amazon Lex bot alias. For more information about aliases, see versioning-aliases.

This operation requires permissions for the lex:GetBotAlias action.

Service Reference:

Examples:

Calling the getBotAlias operation

var params = {
  botName: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE' /* required */
};
lexmodelbuildingservice.getBotAlias(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: {})
    • name — (String)

      The name of the bot alias. The name is case sensitive.

    • botName — (String)

      The name of the bot.

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:

      • name — (String)

        The name of the bot alias.

      • description — (String)

        A description of the bot alias.

      • botVersion — (String)

        The version of the bot that the alias points to.

      • botName — (String)

        The name of the bot that the alias points to.

      • lastUpdatedDate — (Date)

        The date that the bot alias was updated. When you create a resource, the creation date and the last updated date are the same.

      • createdDate — (Date)

        The date that the bot alias was created.

      • checksum — (String)

        Checksum of the bot alias.

Returns:

  • (AWS.Request)

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

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

Returns a list of aliases for a specified Amazon Lex bot.

This operation requires permissions for the lex:GetBotAliases action.

Service Reference:

Examples:

Calling the getBotAliases operation

var params = {
  botName: 'STRING_VALUE', /* required */
  maxResults: 0,
  nameContains: 'STRING_VALUE',
  nextToken: 'STRING_VALUE'
};
lexmodelbuildingservice.getBotAliases(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.

    • nextToken — (String)

      A pagination token for fetching the next page of aliases. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of aliases, specify the pagination token in the next request.

    • maxResults — (Integer)

      The maximum number of aliases to return in the response. The default is 50. .

    • nameContains — (String)

      Substring to match in bot alias names. An alias will be returned if any part of its name matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz."

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:

      • BotAliases — (Array<map>)

        An array of BotAliasMetadata objects, each describing a bot alias.

        • name — (String)

          The name of the bot alias.

        • description — (String)

          A description of the bot alias.

        • botVersion — (String)

          The version of the Amazon Lex bot to which the alias points.

        • botName — (String)

          The name of the bot to which the alias points.

        • lastUpdatedDate — (Date)

          The date that the bot alias was updated. When you create a resource, the creation date and last updated date are the same.

        • createdDate — (Date)

          The date that the bot alias was created.

        • checksum — (String)

          Checksum of the bot alias.

      • nextToken — (String)

        A pagination token for fetching next page of aliases. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of aliases, specify the pagination token in the next request.

Returns:

  • (AWS.Request)

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

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

Returns information about the association between an Amazon Lex bot and a messaging platform.

This operation requires permissions for the lex:GetBotChannelAssociation action.

Service Reference:

Examples:

Calling the getBotChannelAssociation operation

var params = {
  botAlias: 'STRING_VALUE', /* required */
  botName: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE' /* required */
};
lexmodelbuildingservice.getBotChannelAssociation(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: {})
    • name — (String)

      The name of the association between the bot and the channel. The name is case sensitive.

    • botName — (String)

      The name of the Amazon Lex bot.

    • botAlias — (String)

      An alias pointing to the specific version of the Amazon Lex bot to which this association is being made.

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:

      • name — (String)

        The name of the association between the bot and the channel.

      • description — (String)

        A description of the association between the bot and the channel.

      • botAlias — (String)

        An alias pointing to the specific version of the Amazon Lex bot to which this association is being made.

      • botName — (String)

        The name of the Amazon Lex bot.

      • createdDate — (Date)

        The date that the association between the bot and the channel was created.

      • type — (String)

        The type of the messaging platform.

        Possible values include:
        • "Facebook"
        • "Slack"
        • "Twilio-Sms"
      • botConfiguration — (map<String>)

        Provides information that the messaging platform needs to communicate with the Amazon Lex bot.

Returns:

  • (AWS.Request)

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

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

Returns a list of all of the channels associated with the specified bot.

The GetBotChannelAssociations operation requires permissions for the lex:GetBotChannelAssociations action.

Service Reference:

Examples:

Calling the getBotChannelAssociations operation

var params = {
  botAlias: 'STRING_VALUE', /* required */
  botName: 'STRING_VALUE', /* required */
  maxResults: 0,
  nameContains: 'STRING_VALUE',
  nextToken: 'STRING_VALUE'
};
lexmodelbuildingservice.getBotChannelAssociations(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 Amazon Lex bot in the association.

    • botAlias — (String)

      An alias pointing to the specific version of the Amazon Lex bot to which this association is being made.

    • nextToken — (String)

      A pagination token for fetching the next page of associations. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of associations, specify the pagination token in the next request.

    • maxResults — (Integer)

      The maximum number of associations to return in the response. The default is 50.

    • nameContains — (String)

      Substring to match in channel association names. An association will be returned if any part of its name matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz." To return all bot channel associations, use a hyphen ("-") as the nameContains parameter.

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:

      • botChannelAssociations — (Array<map>)

        An array of objects, one for each association, that provides information about the Amazon Lex bot and its association with the channel.

        • name — (String)

          The name of the association between the bot and the channel.

        • description — (String)

          A text description of the association you are creating.

        • botAlias — (String)

          An alias pointing to the specific version of the Amazon Lex bot to which this association is being made.

        • botName — (String)

          The name of the Amazon Lex bot to which this association is being made.

          Note: Currently, Amazon Lex supports associations with Facebook and Slack, and Twilio.
        • createdDate — (Date)

          The date that the association between the Amazon Lex bot and the channel was created.

        • type — (String)

          Specifies the type of association by indicating the type of channel being established between the Amazon Lex bot and the external messaging platform.

          Possible values include:
          • "Facebook"
          • "Slack"
          • "Twilio-Sms"
        • botConfiguration — (map<String>)

          Provides information necessary to communicate with the messaging platform.

      • nextToken — (String)

        A pagination token that fetches the next page of associations. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of associations, specify the pagination token in the next request.

Returns:

  • (AWS.Request)

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

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

Returns bot information as follows:

  • If you provide the nameContains field, the response includes information for the $LATEST version of all bots whose name contains the specified string.

  • If you don't specify the nameContains field, the operation returns information about the $LATEST version of all of your bots.

This operation requires permission for the lex:GetBots action.

Service Reference:

Examples:

To get a list of bots


/* This example shows how to get a list of all of the bots in your account. */

 var params = {
  maxResults: 5, 
  nextToken: ""
 };
 lexmodelbuildingservice.getBots(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    bots: [
       {
      version: "$LATEST", 
      name: "DocOrderPizzaBot", 
      createdDate: <Date Representation>, 
      description: "Orders a pizza from a local pizzeria.", 
      lastUpdatedDate: <Date Representation>, 
      status: "NOT_BUILT"
     }
    ]
   }
   */
 });

Calling the getBots operation

var params = {
  maxResults: 0,
  nameContains: 'STRING_VALUE',
  nextToken: 'STRING_VALUE'
};
lexmodelbuildingservice.getBots(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: {})
    • nextToken — (String)

      A pagination token that fetches the next page of bots. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of bots, specify the pagination token in the next request.

    • maxResults — (Integer)

      The maximum number of bots to return in the response that the request will return. The default is 10.

    • nameContains — (String)

      Substring to match in bot names. A bot will be returned if any part of its name matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz."

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:

      • bots — (Array<map>)

        An array of botMetadata objects, with one entry for each bot.

        • name — (String)

          The name of the bot.

        • description — (String)

          A description of the bot.

        • status — (String)

          The status of the bot.

          Possible values include:
          • "BUILDING"
          • "READY"
          • "FAILED"
          • "NOT_BUILT"
        • lastUpdatedDate — (Date)

          The date that the bot was updated. When you create a bot, the creation date and last updated date are the same.

        • createdDate — (Date)

          The date that the bot was created.

        • version — (String)

          The version of the bot. For a new bot, the version is always $LATEST.

      • nextToken — (String)

        If the response is truncated, it includes a pagination token that you can specify in your next request to fetch the next page of bots.

Returns:

  • (AWS.Request)

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

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

Gets information about all of the versions of a bot.

The GetBotVersions operation returns a BotMetadata object for each version of a bot. For example, if a bot has three numbered versions, the GetBotVersions operation returns four BotMetadata objects in the response, one for each numbered version and one for the $LATEST version.

The GetBotVersions operation always returns at least one version, the $LATEST version.

This operation requires permissions for the lex:GetBotVersions action.

Service Reference:

Examples:

Calling the getBotVersions operation

var params = {
  name: 'STRING_VALUE', /* required */
  maxResults: 0,
  nextToken: 'STRING_VALUE'
};
lexmodelbuildingservice.getBotVersions(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: {})
    • name — (String)

      The name of the bot for which versions should be returned.

    • nextToken — (String)

      A pagination token for fetching the next page of bot versions. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of versions, specify the pagination token in the next request.

    • maxResults — (Integer)

      The maximum number of bot versions to return in the response. The default is 10.

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:

      • bots — (Array<map>)

        An array of BotMetadata objects, one for each numbered version of the bot plus one for the $LATEST version.

        • name — (String)

          The name of the bot.

        • description — (String)

          A description of the bot.

        • status — (String)

          The status of the bot.

          Possible values include:
          • "BUILDING"
          • "READY"
          • "FAILED"
          • "NOT_BUILT"
        • lastUpdatedDate — (Date)

          The date that the bot was updated. When you create a bot, the creation date and last updated date are the same.

        • createdDate — (Date)

          The date that the bot was created.

        • version — (String)

          The version of the bot. For a new bot, the version is always $LATEST.

      • nextToken — (String)

        A pagination token for fetching the next page of bot versions. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of versions, specify the pagination token in the next request.

Returns:

  • (AWS.Request)

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

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

Returns information about a built-in intent.

This operation requires permission for the lex:GetBuiltinIntent action.

Service Reference:

Examples:

Calling the getBuiltinIntent operation

var params = {
  signature: 'STRING_VALUE' /* required */
};
lexmodelbuildingservice.getBuiltinIntent(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: {})
    • signature — (String)

      The unique identifier for a built-in intent. To find the signature for an intent, see Standard Built-in Intents in the Alexa Skills Kit.

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:

      • signature — (String)

        The unique identifier for a built-in intent.

      • supportedLocales — (Array<String>)

        A list of locales that the intent supports.

      • slots — (Array<map>)

        An array of BuiltinIntentSlot objects, one entry for each slot type in the intent.

        • name — (String)

          A list of the slots defined for the intent.

Returns:

  • (AWS.Request)

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

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

Gets a list of built-in intents that meet the specified criteria.

This operation requires permission for the lex:GetBuiltinIntents action.

Service Reference:

Examples:

Calling the getBuiltinIntents operation

var params = {
  locale: en-US,
  maxResults: 0,
  nextToken: 'STRING_VALUE',
  signatureContains: 'STRING_VALUE'
};
lexmodelbuildingservice.getBuiltinIntents(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: {})
    • locale — (String)

      A list of locales that the intent supports.

      Possible values include:
      • "en-US"
    • signatureContains — (String)

      Substring to match in built-in intent signatures. An intent will be returned if any part of its signature matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz." To find the signature for an intent, see Standard Built-in Intents in the Alexa Skills Kit.

    • nextToken — (String)

      A pagination token that fetches the next page of intents. If this API call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of intents, use the pagination token in the next request.

    • maxResults — (Integer)

      The maximum number of intents to return in the response. The default is 10.

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:

      • intents — (Array<map>)

        An array of builtinIntentMetadata objects, one for each intent in the response.

        • signature — (String)

          A unique identifier for the built-in intent. To find the signature for an intent, see Standard Built-in Intents in the Alexa Skills Kit.

        • supportedLocales — (Array<String>)

          A list of identifiers for the locales that the intent supports.

      • nextToken — (String)

        A pagination token that fetches the next page of intents. If the response to this API call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of intents, specify the pagination token in the next request.

Returns:

  • (AWS.Request)

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

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

Gets a list of built-in slot types that meet the specified criteria.

For a list of built-in slot types, see Slot Type Reference in the Alexa Skills Kit.

This operation requires permission for the lex:GetBuiltInSlotTypes action.

Service Reference:

Examples:

Calling the getBuiltinSlotTypes operation

var params = {
  locale: en-US,
  maxResults: 0,
  nextToken: 'STRING_VALUE',
  signatureContains: 'STRING_VALUE'
};
lexmodelbuildingservice.getBuiltinSlotTypes(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: {})
    • locale — (String)

      A list of locales that the slot type supports.

      Possible values include:
      • "en-US"
    • signatureContains — (String)

      Substring to match in built-in slot type signatures. A slot type will be returned if any part of its signature matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz."

    • nextToken — (String)

      A pagination token that fetches the next page of slot types. If the response to this API call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of slot types, specify the pagination token in the next request.

    • maxResults — (Integer)

      The maximum number of slot types to return in the response. The default is 10.

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:

      • slotTypes — (Array<map>)

        An array of BuiltInSlotTypeMetadata objects, one entry for each slot type returned.

        • signature — (String)

          A unique identifier for the built-in slot type. To find the signature for a slot type, see Slot Type Reference in the Alexa Skills Kit.

        • supportedLocales — (Array<String>)

          A list of target locales for the slot.

      • nextToken — (String)

        If the response is truncated, the response includes a pagination token that you can use in your next request to fetch the next page of slot types.

Returns:

  • (AWS.Request)

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

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

Returns information about an intent. In addition to the intent name, you must specify the intent version.

This operation requires permissions to perform the lex:GetIntent action.

Service Reference:

Examples:

To get a information about an intent


/* This example shows how to get information about an intent. */

 var params = {
  version: "$LATEST", 
  name: "DocOrderPizza"
 };
 lexmodelbuildingservice.getIntent(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    version: "$LATEST", 
    name: "DocOrderPizza", 
    checksum: "ca9bc13d-afc8-4706-bbaf-091f7a5935d6", 
    conclusionStatement: {
     messages: [
        {
       content: "All right, I ordered  you a {Crust} crust {Type} pizza with {Sauce} sauce.", 
       contentType: "PlainText"
      }, 
        {
       content: "OK, your {Crust} crust {Type} pizza with {Sauce} sauce is on the way.", 
       contentType: "PlainText"
      }
     ], 
     responseCard: "foo"
    }, 
    confirmationPrompt: {
     maxAttempts: 1, 
     messages: [
        {
       content: "Should I order  your {Crust} crust {Type} pizza with {Sauce} sauce?", 
       contentType: "PlainText"
      }
     ]
    }, 
    createdDate: <Date Representation>, 
    description: "Order a pizza from a local pizzeria.", 
    fulfillmentActivity: {
     type: "ReturnIntent"
    }, 
    lastUpdatedDate: <Date Representation>, 
    rejectionStatement: {
     messages: [
        {
       content: "Ok, I'll cancel your order.", 
       contentType: "PlainText"
      }, 
        {
       content: "I cancelled your order.", 
       contentType: "PlainText"
      }
     ]
    }, 
    sampleUtterances: [
       "Order me a pizza.", 
       "Order me a {Type} pizza.", 
       "I want a {Crust} crust {Type} pizza", 
       "I want a {Crust} crust {Type} pizza with {Sauce} sauce."
    ], 
    slots: [
       {
      name: "Type", 
      description: "The type of pizza to order.", 
      priority: 1, 
      sampleUtterances: [
         "Get me a {Type} pizza.", 
         "A {Type} pizza please.", 
         "I'd like a {Type} pizza."
      ], 
      slotConstraint: "Required", 
      slotType: "DocPizzaType", 
      slotTypeVersion: "$LATEST", 
      valueElicitationPrompt: {
       maxAttempts: 1, 
       messages: [
          {
         content: "What type of pizza would you like?", 
         contentType: "PlainText"
        }, 
          {
         content: "Vegie or cheese pizza?", 
         contentType: "PlainText"
        }, 
          {
         content: "I can get you a vegie or a cheese pizza.", 
         contentType: "PlainText"
        }
       ]
      }
     }, 
       {
      name: "Crust", 
      description: "The type of pizza crust to order.", 
      priority: 2, 
      sampleUtterances: [
         "Make it a {Crust} crust.", 
         "I'd like a {Crust} crust."
      ], 
      slotConstraint: "Required", 
      slotType: "DocPizzaCrustType", 
      slotTypeVersion: "$LATEST", 
      valueElicitationPrompt: {
       maxAttempts: 1, 
       messages: [
          {
         content: "What type of crust would you like?", 
         contentType: "PlainText"
        }, 
          {
         content: "Thick or thin crust?", 
         contentType: "PlainText"
        }
       ]
      }
     }, 
       {
      name: "Sauce", 
      description: "The type of sauce to use on the pizza.", 
      priority: 3, 
      sampleUtterances: [
         "Make it {Sauce} sauce.", 
         "I'd like {Sauce} sauce."
      ], 
      slotConstraint: "Required", 
      slotType: "DocPizzaSauceType", 
      slotTypeVersion: "$LATEST", 
      valueElicitationPrompt: {
       maxAttempts: 1, 
       messages: [
          {
         content: "White or red sauce?", 
         contentType: "PlainText"
        }, 
          {
         content: "Garlic or tomato sauce?", 
         contentType: "PlainText"
        }
       ]
      }
     }
    ]
   }
   */
 });

Calling the getIntent operation

var params = {
  name: 'STRING_VALUE', /* required */
  version: 'STRING_VALUE' /* required */
};
lexmodelbuildingservice.getIntent(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: {})
    • name — (String)

      The name of the intent. The name is case sensitive.

    • version — (String)

      The version of the intent.

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:

      • name — (String)

        The name of the intent.

      • description — (String)

        A description of the intent.

      • slots — (Array<map>)

        An array of intent slots configured for the intent.

        • namerequired — (String)

          The name of the slot.

        • description — (String)

          A description of the slot.

        • slotConstraintrequired — (String)

          Specifies whether the slot is required or optional.

          Possible values include:
          • "Required"
          • "Optional"
        • slotType — (String)

          The type of the slot, either a custom slot type that you defined or one of the built-in slot types.

        • slotTypeVersion — (String)

          The version of the slot type.

        • valueElicitationPrompt — (map)

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

          • messagesrequired — (Array<map>)

            An array of objects, each of which provides a message string and its type. You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML).

            • contentTyperequired — (String)

              The content type of the message string.

              Possible values include:
              • "PlainText"
              • "SSML"
            • contentrequired — (String)

              The text of the message.

          • maxAttemptsrequired — (Integer)

            The number of times to prompt the user for information.

          • responseCard — (String)

            A response card. Amazon Lex uses this prompt at runtime, in the PostText API response. It substitutes session attributes and slot values for placeholders in the response card. For more information, see ex-resp-card.

        • priority — (Integer)

          Directs Lex the order in which to elicit this slot value from the user. For example, if the intent has two slots with priorities 1 and 2, AWS Lex first elicits a value for the slot with priority 1.

          If multiple slots share the same priority, the order in which Lex elicits values is arbitrary.

        • sampleUtterances — (Array<String>)

          If you know a specific pattern with which 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.

        • responseCard — (String)

          A set of possible responses for the slot type used by text-based clients. A user chooses an option from the response card, instead of using text to reply.

      • sampleUtterances — (Array<String>)

        An array of sample utterances configured for the intent.

      • confirmationPrompt — (map)

        If defined in the bot, Amazon Lex uses prompt to confirm the intent before fulfilling the user's request. For more information, see PutIntent.

        • messagesrequired — (Array<map>)

          An array of objects, each of which provides a message string and its type. You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML).

          • contentTyperequired — (String)

            The content type of the message string.

            Possible values include:
            • "PlainText"
            • "SSML"
          • contentrequired — (String)

            The text of the message.

        • maxAttemptsrequired — (Integer)

          The number of times to prompt the user for information.

        • responseCard — (String)

          A response card. Amazon Lex uses this prompt at runtime, in the PostText API response. It substitutes session attributes and slot values for placeholders in the response card. For more information, see ex-resp-card.

      • rejectionStatement — (map)

        If the user answers "no" to the question defined in confirmationPrompt, Amazon Lex responds with this statement to acknowledge that the intent was canceled.

        • messagesrequired — (Array<map>)

          A collection of message objects.

          • contentTyperequired — (String)

            The content type of the message string.

            Possible values include:
            • "PlainText"
            • "SSML"
          • contentrequired — (String)

            The text of the message.

        • responseCard — (String)

          At runtime, if the client is using the PostText API, Amazon Lex includes the response card in the response. It substitutes all of the session attributes and slot values for placeholders in the response card.

      • followUpPrompt — (map)

        If defined in the bot, Amazon Lex uses this prompt to solicit additional user activity after the intent is fulfilled. For more information, see PutIntent.

        • promptrequired — (map)

          Prompts for information from the user.

          • messagesrequired — (Array<map>)

            An array of objects, each of which provides a message string and its type. You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML).

            • contentTyperequired — (String)

              The content type of the message string.

              Possible values include:
              • "PlainText"
              • "SSML"
            • contentrequired — (String)

              The text of the message.

          • maxAttemptsrequired — (Integer)

            The number of times to prompt the user for information.

          • responseCard — (String)

            A response card. Amazon Lex uses this prompt at runtime, in the PostText API response. It substitutes session attributes and slot values for placeholders in the response card. For more information, see ex-resp-card.

        • rejectionStatementrequired — (map)

          If the user answers "no" to the question defined in the prompt field, Amazon Lex responds with this statement to acknowledge that the intent was canceled.

          • messagesrequired — (Array<map>)

            A collection of message objects.

            • contentTyperequired — (String)

              The content type of the message string.

              Possible values include:
              • "PlainText"
              • "SSML"
            • contentrequired — (String)

              The text of the message.

          • responseCard — (String)

            At runtime, if the client is using the PostText API, Amazon Lex includes the response card in the response. It substitutes all of the session attributes and slot values for placeholders in the response card.

      • conclusionStatement — (map)

        After the Lambda function specified in the fulfillmentActivity element fulfills the intent, Amazon Lex conveys this statement to the user.

        • messagesrequired — (Array<map>)

          A collection of message objects.

          • contentTyperequired — (String)

            The content type of the message string.

            Possible values include:
            • "PlainText"
            • "SSML"
          • contentrequired — (String)

            The text of the message.

        • responseCard — (String)

          At runtime, if the client is using the PostText API, Amazon Lex includes the response card in the response. It substitutes all of the session attributes and slot values for placeholders in the response card.

      • dialogCodeHook — (map)

        If defined in the bot, Amazon Amazon Lex invokes this Lambda function for each user input. For more information, see PutIntent.

        • urirequired — (String)

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

        • messageVersionrequired — (String)

          The version of the request-response that you want Amazon Lex to use to invoke your Lambda function. For more information, see using-lambda.

      • fulfillmentActivity — (map)

        Describes how the intent is fulfilled. For more information, see PutIntent.

        • typerequired — (String)

          How the intent should be fulfilled, either by running a Lambda function or by returning the slot data to the client application.

          Possible values include:
          • "ReturnIntent"
          • "CodeHook"
        • codeHook — (map)

          A description of the Lambda function that is run to fulfill the intent.

          • urirequired — (String)

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

          • messageVersionrequired — (String)

            The version of the request-response that you want Amazon Lex to use to invoke your Lambda function. For more information, see using-lambda.

      • parentIntentSignature — (String)

        A unique identifier for a built-in intent.

      • lastUpdatedDate — (Date)

        The date that the intent was updated. When you create a resource, the creation date and the last updated date are the same.

      • createdDate — (Date)

        The date that the intent was created.

      • version — (String)

        The version of the intent.

      • checksum — (String)

        Checksum of the intent.

Returns:

  • (AWS.Request)

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

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

Returns intent information as follows:

  • If you specify the nameContains field, returns the $LATEST version of all intents that contain the specified string.

  • If you don't specify the nameContains field, returns information about the $LATEST version of all intents.

The operation requires permission for the lex:GetIntents action.

Service Reference:

Examples:

To get a list of intents


/* This example shows how to get a list of all of the intents in your account. */

 var params = {
  maxResults: 10, 
  nextToken: ""
 };
 lexmodelbuildingservice.getIntents(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    intents: [
       {
      version: "$LATEST", 
      name: "DocOrderPizza", 
      createdDate: <Date Representation>, 
      description: "Order a pizza from a local pizzeria.", 
      lastUpdatedDate: <Date Representation>
     }
    ]
   }
   */
 });

Calling the getIntents operation

var params = {
  maxResults: 0,
  nameContains: 'STRING_VALUE',
  nextToken: 'STRING_VALUE'
};
lexmodelbuildingservice.getIntents(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: {})
    • nextToken — (String)

      A pagination token that fetches the next page of intents. If the response to this API call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of intents, specify the pagination token in the next request.

    • maxResults — (Integer)

      The maximum number of intents to return in the response. The default is 10.

    • nameContains — (String)

      Substring to match in intent names. An intent will be returned if any part of its name matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz."

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:

      • intents — (Array<map>)

        An array of Intent objects. For more information, see PutBot.

        • name — (String)

          The name of the intent.

        • description — (String)

          A description of the intent.

        • lastUpdatedDate — (Date)

          The date that the intent was updated. When you create an intent, the creation date and last updated date are the same.

        • createdDate — (Date)

          The date that the intent was created.

        • version — (String)

          The version of the intent.

      • nextToken — (String)

        If the response is truncated, the response includes a pagination token that you can specify in your next request to fetch the next page of intents.

Returns:

  • (AWS.Request)

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

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

Gets information about all of the versions of an intent.

The GetIntentVersions operation returns an IntentMetadata object for each version of an intent. For example, if an intent has three numbered versions, the GetIntentVersions operation returns four IntentMetadata objects in the response, one for each numbered version and one for the $LATEST version.

The GetIntentVersions operation always returns at least one version, the $LATEST version.

This operation requires permissions for the lex:GetIntentVersions action.

Service Reference:

Examples:

Calling the getIntentVersions operation

var params = {
  name: 'STRING_VALUE', /* required */
  maxResults: 0,
  nextToken: 'STRING_VALUE'
};
lexmodelbuildingservice.getIntentVersions(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: {})
    • name — (String)

      The name of the intent for which versions should be returned.

    • nextToken — (String)

      A pagination token for fetching the next page of intent versions. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of versions, specify the pagination token in the next request.

    • maxResults — (Integer)

      The maximum number of intent versions to return in the response. The default is 10.

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:

      • intents — (Array<map>)

        An array of IntentMetadata objects, one for each numbered version of the intent plus one for the $LATEST version.

        • name — (String)

          The name of the intent.

        • description — (String)

          A description of the intent.

        • lastUpdatedDate — (Date)

          The date that the intent was updated. When you create an intent, the creation date and last updated date are the same.

        • createdDate — (Date)

          The date that the intent was created.

        • version — (String)

          The version of the intent.

      • nextToken — (String)

        A pagination token for fetching the next page of intent versions. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of versions, specify the pagination token in the next request.

Returns:

  • (AWS.Request)

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

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

Returns information about a specific version of a slot type. In addition to specifying the slot type name, you must specify the slot type version.

This operation requires permissions for the lex:GetSlotType action.

Service Reference:

Examples:

To get information about a slot type


/* This example shows how to get information about a slot type. */

 var params = {
  version: "$LATEST", 
  name: "DocPizzaCrustType"
 };
 lexmodelbuildingservice.getSlotType(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    version: "$LATEST", 
    name: "DocPizzaCrustType", 
    checksum: "210b3d5a-90a3-4b22-ac7e-f50c2c71095f", 
    createdDate: <Date Representation>, 
    description: "Available crust types", 
    enumerationValues: [
       {
      value: "thick"
     }, 
       {
      value: "thin"
     }
    ], 
    lastUpdatedDate: <Date Representation>
   }
   */
 });

Calling the getSlotType operation

var params = {
  name: 'STRING_VALUE', /* required */
  version: 'STRING_VALUE' /* required */
};
lexmodelbuildingservice.getSlotType(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: {})
    • name — (String)

      The name of the slot type. The name is case sensitive.

    • version — (String)

      The version of the slot type.

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:

      • name — (String)

        The name of the slot type.

      • description — (String)

        A description of the slot type.

      • enumerationValues — (Array<map>)

        A list of EnumerationValue objects that defines the values that the slot type can take.

        • valuerequired — (String)

          The value of the slot type.

      • lastUpdatedDate — (Date)

        The date that the slot type was updated. When you create a resource, the creation date and last update date are the same.

      • createdDate — (Date)

        The date that the slot type was created.

      • version — (String)

        The version of the slot type.

      • checksum — (String)

        Checksum of the $LATEST version of the slot type.

Returns:

  • (AWS.Request)

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

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

Returns slot type information as follows:

  • If you specify the nameContains field, returns the $LATEST version of all slot types that contain the specified string.

  • If you don't specify the nameContains field, returns information about the $LATEST version of all slot types.

The operation requires permission for the lex:GetSlotTypes action.

Service Reference:

Examples:

To get a list of slot types


/* This example shows how to get a list of all of the slot types in your account. */

 var params = {
  maxResults: 10, 
  nextToken: ""
 };
 lexmodelbuildingservice.getSlotTypes(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    slotTypes: [
       {
      version: "$LATEST", 
      name: "DocPizzaCrustType", 
      createdDate: <Date Representation>, 
      description: "Available crust types", 
      lastUpdatedDate: <Date Representation>
     }, 
       {
      version: "$LATEST", 
      name: "DocPizzaSauceType", 
      createdDate: <Date Representation>, 
      description: "Available pizza sauces", 
      lastUpdatedDate: <Date Representation>
     }, 
       {
      version: "$LATEST", 
      name: "DocPizzaType", 
      createdDate: <Date Representation>, 
      description: "Available pizzas", 
      lastUpdatedDate: <Date Representation>
     }
    ]
   }
   */
 });

Calling the getSlotTypes operation

var params = {
  maxResults: 0,
  nameContains: 'STRING_VALUE',
  nextToken: 'STRING_VALUE'
};
lexmodelbuildingservice.getSlotTypes(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: {})
    • nextToken — (String)

      A pagination token that fetches the next page of slot types. If the response to this API call is truncated, Amazon Lex returns a pagination token in the response. To fetch next page of slot types, specify the pagination token in the next request.

    • maxResults — (Integer)

      The maximum number of slot types to return in the response. The default is 10.

    • nameContains — (String)

      Substring to match in slot type names. A slot type will be returned if any part of its name matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz."

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:

      • slotTypes — (Array<map>)

        An array of objects, one for each slot type, that provides information such as the name of the slot type, the version, and a description.

        • name — (String)

          The name of the slot type.

        • description — (String)

          A description of the slot type.

        • lastUpdatedDate — (Date)

          The date that the slot type was updated. When you create a resource, the creation date and last updated date are the same.

        • createdDate — (Date)

          The date that the slot type was created.

        • version — (String)

          The version of the slot type.

      • nextToken — (String)

        If the response is truncated, it includes a pagination token that you can specify in your next request to fetch the next page of slot types.

Returns:

  • (AWS.Request)

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

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

Gets information about all versions of a slot type.

The GetSlotTypeVersions operation returns a SlotTypeMetadata object for each version of a slot type. For example, if a slot type has three numbered versions, the GetSlotTypeVersions operation returns four SlotTypeMetadata objects in the response, one for each numbered version and one for the $LATEST version.

The GetSlotTypeVersions operation always returns at least one version, the $LATEST version.

This operation requires permissions for the lex:GetSlotTypeVersions action.

Service Reference:

Examples:

Calling the getSlotTypeVersions operation

var params = {
  name: 'STRING_VALUE', /* required */
  maxResults: 0,
  nextToken: 'STRING_VALUE'
};
lexmodelbuildingservice.getSlotTypeVersions(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: {})
    • name — (String)

      The name of the slot type for which versions should be returned.

    • nextToken — (String)

      A pagination token for fetching the next page of slot type versions. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of versions, specify the pagination token in the next request.

    • maxResults — (Integer)

      The maximum number of slot type versions to return in the response. The default is 10.

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:

      • slotTypes — (Array<map>)

        An array of SlotTypeMetadata objects, one for each numbered version of the slot type plus one for the $LATEST version.

        • name — (String)

          The name of the slot type.

        • description — (String)

          A description of the slot type.

        • lastUpdatedDate — (Date)

          The date that the slot type was updated. When you create a resource, the creation date and last updated date are the same.

        • createdDate — (Date)

          The date that the slot type was created.

        • version — (String)

          The version of the slot type.

      • nextToken — (String)

        A pagination token for fetching the next page of slot type versions. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of versions, specify the pagination token in the next request.

Returns:

  • (AWS.Request)

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

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

Use the GetUtterancesView operation to get information about the utterances that your users have made to your bot. You can use this list to tune the utterances that your bot responds to.

For example, say that you have created a bot to order flowers. After your users have used your bot for a while, use the GetUtterancesView operation to see the requests that they have made and whether they have been successful. You might find that the utterance "I want flowers" is not being recognized. You could add this utterance to the OrderFlowers intent so that your bot recognizes that utterance.

After you publish a new version of a bot, you can get information about the old version and the new so that you can compare the performance across the two versions.

Data is available for the last 15 days. You can request information for up to 5 versions in each request. The response contains information about a maximum of 100 utterances for each version.

If the bot's childDirected field is set to true, utterances for the bot are not stored and cannot be retrieved with the GetUtterancesView operation. For more information, see PutBot.

This operation requires permissions for the lex:GetUtterancesView action.

Service Reference:

Examples:

Calling the getUtterancesView operation

var params = {
  botName: 'STRING_VALUE', /* required */
  botVersions: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  statusType: Detected | Missed /* required */
};
lexmodelbuildingservice.getUtterancesView(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 for which utterance information should be returned.

    • botVersions — (Array<String>)

      An array of bot versions for which utterance information should be returned. The limit is 5 versions per request.

    • statusType — (String)

      To return utterances that were recognized and handled, useDetected. To return utterances that were not recognized, use Missed.

      Possible values include:
      • "Detected"
      • "Missed"

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:

      • botName — (String)

        The name of the bot for which utterance information was returned.

      • utterances — (Array<map>)

        An array of UtteranceList objects, each containing a list of UtteranceData objects describing the utterances that were processed by your bot. The response contains a maximum of 100 UtteranceData objects for each version.

        • botVersion — (String)

          The version of the bot that processed the list.

        • utterances — (Array<map>)

          One or more UtteranceData objects that contain information about the utterances that have been made to a bot. The maximum number of object is 100.

          • utteranceString — (String)

            The text that was entered by the user or the text representation of an audio clip.

          • count — (Integer)

            The number of times that the utterance was processed.

          • distinctUsers — (Integer)

            The total number of individuals that used the utterance.

          • firstUtteredDate — (Date)

            The date that the utterance was first recorded.

          • lastUtteredDate — (Date)

            The date that the utterance was last recorded.

Returns:

  • (AWS.Request)

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

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

Creates an Amazon Lex conversational bot or replaces an existing bot. When you create or update a bot you are only required to specify a name. You can use this to add intents later, or to remove intents from an existing bot. When you create a bot with a name only, the bot is created or updated but Amazon Lex returns the response FAILED. You can build the bot after you add one or more intents. For more information about Amazon Lex bots, see how-it-works.

If you specify the name of an existing bot, the fields in the request replace the existing values in the $LATEST version of the bot. Amazon Lex removes any fields that you don't provide values for in the request, except for the idleTTLInSeconds and privacySettings fields, which are set to their default values. If you don't specify values for required fields, Amazon Lex throws an exception.

This operation requires permissions for the lex:PutBot action. For more information, see auth-and-access-control.

Service Reference:

Examples:

To create a bot


/* This example shows how to create a bot for ordering pizzas. */

 var params = {
  name: "DocOrderPizzaBot", 
  abortStatement: {
   messages: [
      {
     content: "I don't understand. Can you try again?", 
     contentType: "PlainText"
    }, 
      {
     content: "I'm sorry, I don't understand.", 
     contentType: "PlainText"
    }
   ]
  }, 
  childDirected: true, 
  clarificationPrompt: {
   maxAttempts: 1, 
   messages: [
      {
     content: "I'm sorry, I didn't hear that. Can you repeate what you just said?", 
     contentType: "PlainText"
    }, 
      {
     content: "Can you say that again?", 
     contentType: "PlainText"
    }
   ]
  }, 
  description: "Orders a pizza from a local pizzeria.", 
  idleSessionTTLInSeconds: 300, 
  intents: [
     {
    intentName: "DocOrderPizza", 
    intentVersion: "$LATEST"
   }
  ], 
  locale: "en-US", 
  processBehavior: "SAVE"
 };
 lexmodelbuildingservice.putBot(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    version: "$LATEST", 
    name: "DocOrderPizzaBot", 
    abortStatement: {
     messages: [
        {
       content: "I don't understand. Can you try again?", 
       contentType: "PlainText"
      }, 
        {
       content: "I'm sorry, I don't understand.", 
       contentType: "PlainText"
      }
     ]
    }, 
    checksum: "20172ee3-fa06-49b2-bbc5-667c090303e9", 
    childDirected: true, 
    clarificationPrompt: {
     maxAttempts: 1, 
     messages: [
        {
       content: "I'm sorry, I didn't hear that. Can you repeate what you just said?", 
       contentType: "PlainText"
      }, 
        {
       content: "Can you say that again?", 
       contentType: "PlainText"
      }
     ]
    }, 
    createdDate: <Date Representation>, 
    description: "Orders a pizza from a local pizzeria.", 
    idleSessionTTLInSeconds: 300, 
    intents: [
       {
      intentName: "DocOrderPizza", 
      intentVersion: "$LATEST"
     }
    ], 
    lastUpdatedDate: <Date Representation>, 
    locale: "en-US", 
    status: "NOT_BUILT"
   }
   */
 });

Calling the putBot operation

var params = {
  childDirected: true || false, /* required */
  locale: en-US, /* required */
  name: 'STRING_VALUE', /* required */
  abortStatement: {
    messages: [ /* required */
      {
        content: 'STRING_VALUE', /* required */
        contentType: PlainText | SSML /* required */
      },
      /* more items */
    ],
    responseCard: 'STRING_VALUE'
  },
  checksum: 'STRING_VALUE',
  clarificationPrompt: {
    maxAttempts: 0, /* required */
    messages: [ /* required */
      {
        content: 'STRING_VALUE', /* required */
        contentType: PlainText | SSML /* required */
      },
      /* more items */
    ],
    responseCard: 'STRING_VALUE'
  },
  description: 'STRING_VALUE',
  idleSessionTTLInSeconds: 0,
  intents: [
    {
      intentName: 'STRING_VALUE', /* required */
      intentVersion: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  processBehavior: SAVE | BUILD,
  voiceId: 'STRING_VALUE'
};
lexmodelbuildingservice.putBot(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: {})
    • name — (String)

      The name of the bot. The name is not case sensitive.

    • description — (String)

      A description of the bot.

    • intents — (Array<map>)

      An array of Intent objects. Each intent represents a command that a user can express. For example, a pizza ordering bot might support an OrderPizza intent. For more information, see how-it-works.

      • intentNamerequired — (String)

        The name of the intent.

      • intentVersionrequired — (String)

        The version of the intent.

    • clarificationPrompt — (map)

      When Amazon Lex doesn't understand the user's intent, it uses this message to get clarification. To specify how many times Amazon Lex should repeate the clarification prompt, use the maxAttempts field. If Amazon Lex still doesn't understand, it sends the message in the abortStatement field.

      When you create a clarification prompt, make sure that it suggests the correct response from the user. for example, for a bot that orders pizza and drinks, you might create this clarification prompt: "What would you like to do? You can say 'Order a pizza' or 'Order a drink.'"

      • messagesrequired — (Array<map>)

        An array of objects, each of which provides a message string and its type. You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML).

        • contentTyperequired — (String)

          The content type of the message string.

          Possible values include:
          • "PlainText"
          • "SSML"
        • contentrequired — (String)

          The text of the message.

      • maxAttemptsrequired — (Integer)

        The number of times to prompt the user for information.

      • responseCard — (String)

        A response card. Amazon Lex uses this prompt at runtime, in the PostText API response. It substitutes session attributes and slot values for placeholders in the response card. For more information, see ex-resp-card.

    • abortStatement — (map)

      When Amazon Lex can't understand the user's input in context, it tries to elicit the information a few times. After that, Amazon Lex sends the message defined in abortStatement to the user, and then aborts the conversation. To set the number of retries, use the valueElicitationPrompt field for the slot type.

      For example, in a pizza ordering bot, Amazon Lex might ask a user "What type of crust would you like?" If the user's response is not one of the expected responses (for example, "thin crust, "deep dish," etc.), Amazon Lex tries to elicit a correct response a few more times.

      For example, in a pizza ordering application, OrderPizza might be one of the intents. This intent might require the CrustType slot. You specify the valueElicitationPrompt field when you create the CrustType slot.

      • messagesrequired — (Array<map>)

        A collection of message objects.

        • contentTyperequired — (String)

          The content type of the message string.

          Possible values include:
          • "PlainText"
          • "SSML"
        • contentrequired — (String)

          The text of the message.

      • responseCard — (String)

        At runtime, if the client is using the PostText API, Amazon Lex includes the response card in the response. It substitutes all of the session attributes and slot values for placeholders in the response card.

    • idleSessionTTLInSeconds — (Integer)

      The maximum time in seconds that Amazon Lex retains the data gathered in a conversation.

      A user interaction session 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.

      For example, suppose that a user chooses the OrderPizza intent, but gets sidetracked halfway through placing an order. If the user doesn't complete the order within the specified time, Amazon Lex discards the slot information that it gathered, and the user must start over.

      If you don't include the idleSessionTTLInSeconds element in a PutBot operation request, Amazon Lex uses the default value. This is also true if the request replaces an existing bot.

      The default is 300 seconds (5 minutes).

    • voiceId — (String)

      The Amazon Polly voice ID that you want Amazon Lex to use for voice interactions with the user. The locale configured for the voice must match the locale of the bot. For more information, see Available Voices in the Amazon Polly Developer Guide.

    • checksum — (String)

      Identifies a specific revision of the $LATEST version.

      When you create a new bot, leave the checksum field blank. If you specify a checksum you get a BadRequestException exception.

      When you want to update a bot, set the checksum field to the checksum of the most recent revision of the $LATEST version. If you don't specify the checksum field, or if the checksum does not match the $LATEST version, you get a PreconditionFailedException exception.

    • processBehavior — (String)

      If you set the processBehavior element to Build, Amazon Lex builds the bot so that it can be run. If you set the element to SaveAmazon Lex saves the bot, but doesn't build it.

      If you don't specify this value, the default value is Save.

      Possible values include:
      • "SAVE"
      • "BUILD"
    • locale — (String)

      Specifies the target locale for the bot. Any intent used in the bot must be compatible with the locale of the bot.

      The default is en-US.

      Possible values include:
      • "en-US"
    • childDirected — (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.

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:

      • name — (String)

        The name of the bot.

      • description — (String)

        A description of the bot.

      • intents — (Array<map>)

        An array of Intent objects. For more information, see PutBot.

        • intentNamerequired — (String)

          The name of the intent.

        • intentVersionrequired — (String)

          The version of the intent.

      • clarificationPrompt — (map)

        The prompts that Amazon Lex uses when it doesn't understand the user's intent. For more information, see PutBot.

        • messagesrequired — (Array<map>)

          An array of objects, each of which provides a message string and its type. You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML).

          • contentTyperequired — (String)

            The content type of the message string.

            Possible values include:
            • "PlainText"
            • "SSML"
          • contentrequired — (String)

            The text of the message.

        • maxAttemptsrequired — (Integer)

          The number of times to prompt the user for information.

        • responseCard — (String)

          A response card. Amazon Lex uses this prompt at runtime, in the PostText API response. It substitutes session attributes and slot values for placeholders in the response card. For more information, see ex-resp-card.

      • abortStatement — (map)

        The message that Amazon Lex uses to abort a conversation. For more information, see PutBot.

        • messagesrequired — (Array<map>)

          A collection of message objects.

          • contentTyperequired — (String)

            The content type of the message string.

            Possible values include:
            • "PlainText"
            • "SSML"
          • contentrequired — (String)

            The text of the message.

        • responseCard — (String)

          At runtime, if the client is using the PostText API, Amazon Lex includes the response card in the response. It substitutes all of the session attributes and slot values for placeholders in the response card.

      • status — (String)

        When you send a request to create a bot with processBehavior set to BUILD, Amazon Lex sets the status response element to BUILDING. After Amazon Lex builds the bot, it sets status to READY. If Amazon Lex can't build the bot, Amazon Lex sets status to FAILED. Amazon Lex returns the reason for the failure in the failureReason response element.

        When you set processBehaviorto SAVE, Amazon Lex sets the status code to NOT BUILT.

        Possible values include:
        • "BUILDING"
        • "READY"
        • "FAILED"
        • "NOT_BUILT"
      • failureReason — (String)

        If status is FAILED, Amazon Lex provides the reason that it failed to build the bot.

      • lastUpdatedDate — (Date)

        The date that the bot was updated. When you create a resource, the creation date and last updated date are the same.

      • createdDate — (Date)

        The date that the bot was created.

      • idleSessionTTLInSeconds — (Integer)

        The maximum length of time that Amazon Lex retains the data gathered in a conversation. For more information, see PutBot.

      • voiceId — (String)

        The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user. For more information, see PutBot.

      • checksum — (String)

        Checksum of the bot that you created.

      • version — (String)

        The version of the bot. For a new bot, the version is always $LATEST.

      • locale — (String)

        The target locale for the bot.

        Possible values include:
        • "en-US"
      • childDirected — (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.

Returns:

  • (AWS.Request)

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

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

Creates an alias for the specified version of the bot or replaces an alias for the specified bot. To change the version of the bot that the alias points to, replace the alias. For more information about aliases, see versioning-aliases.

This operation requires permissions for the lex:PutBotAlias action.

Service Reference:

Examples:

Calling the putBotAlias operation

var params = {
  botName: 'STRING_VALUE', /* required */
  botVersion: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  checksum: 'STRING_VALUE',
  description: 'STRING_VALUE'
};
lexmodelbuildingservice.putBotAlias(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: {})
    • name — (String)

      The name of the alias. The name is not case sensitive.

    • description — (String)

      A description of the alias.

    • botVersion — (String)

      The version of the bot.

    • botName — (String)

      The name of the bot.

    • checksum — (String)

      Identifies a specific revision of the $LATEST version.

      When you create a new bot alias, leave the checksum field blank. If you specify a checksum you get a BadRequestException exception.

      When you want to update a bot alias, set the checksum field to the checksum of the most recent revision of the $LATEST version. If you don't specify the checksum field, or if the checksum does not match the $LATEST version, you get a PreconditionFailedException 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:

      • name — (String)

        The name of the alias.

      • description — (String)

        A description of the alias.

      • botVersion — (String)

        The version of the bot that the alias points to.

      • botName — (String)

        The name of the bot that the alias points to.

      • lastUpdatedDate — (Date)

        The date that the bot alias was updated. When you create a resource, the creation date and the last updated date are the same.

      • createdDate — (Date)

        The date that the bot alias was created.

      • checksum — (String)

        The checksum for the current version of the alias.

Returns:

  • (AWS.Request)

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

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

Creates an intent or replaces an existing intent.

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

To create an intent or replace an existing intent, you must provide the following:

  • Intent name. For example, OrderPizza.

  • Sample utterances. For example, "Can I order a pizza, please." and "I want to order a pizza."

  • Information to be gathered. You specify slot types for the information that your bot will request from the user. You can specify standard slot types, such as a date or a time, or custom slot types such as the size and crust of a pizza.

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

You can specify other optional information in the request, such as:

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

  • A conclusion statement to send to the user after the intent has been fulfilled. For example, "I placed your pizza order."

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

If you specify an existing intent name to update the intent, Amazon Lex replaces the values in the $LATEST version of the slot type with the values in the request. Amazon Lex removes fields that you don't provide in the request. If you don't specify the required fields, Amazon Lex throws an exception.

For more information, see how-it-works.

This operation requires permissions for the lex:PutIntent action.

Service Reference:

Examples:

To create an intent


/* This example shows how to create an intent for ordering pizzas. */

 var params = {
  name: "DocOrderPizza", 
  conclusionStatement: {
   messages: [
      {
     content: "All right, I ordered  you a {Crust} crust {Type} pizza with {Sauce} sauce.", 
     contentType: "PlainText"
    }, 
      {
     content: "OK, your {Crust} crust {Type} pizza with {Sauce} sauce is on the way.", 
     contentType: "PlainText"
    }
   ], 
   responseCard: "foo"
  }, 
  confirmationPrompt: {
   maxAttempts: 1, 
   messages: [
      {
     content: "Should I order  your {Crust} crust {Type} pizza with {Sauce} sauce?", 
     contentType: "PlainText"
    }
   ]
  }, 
  description: "Order a pizza from a local pizzeria.", 
  fulfillmentActivity: {
   type: "ReturnIntent"
  }, 
  rejectionStatement: {
   messages: [
      {
     content: "Ok, I'll cancel your order.", 
     contentType: "PlainText"
    }, 
      {
     content: "I cancelled your order.", 
     contentType: "PlainText"
    }
   ]
  }, 
  sampleUtterances: [
     "Order me a pizza.", 
     "Order me a {Type} pizza.", 
     "I want a {Crust} crust {Type} pizza", 
     "I want a {Crust} crust {Type} pizza with {Sauce} sauce."
  ], 
  slots: [
     {
    name: "Type", 
    description: "The type of pizza to order.", 
    priority: 1, 
    sampleUtterances: [
       "Get me a {Type} pizza.", 
       "A {Type} pizza please.", 
       "I'd like a {Type} pizza."
    ], 
    slotConstraint: "Required", 
    slotType: "DocPizzaType", 
    slotTypeVersion: "$LATEST", 
    valueElicitationPrompt: {
     maxAttempts: 1, 
     messages: [
        {
       content: "What type of pizza would you like?", 
       contentType: "PlainText"
      }, 
        {
       content: "Vegie or cheese pizza?", 
       contentType: "PlainText"
      }, 
        {
       content: "I can get you a vegie or a cheese pizza.", 
       contentType: "PlainText"
      }
     ]
    }
   }, 
     {
    name: "Crust", 
    description: "The type of pizza crust to order.", 
    priority: 2, 
    sampleUtterances: [
       "Make it a {Crust} crust.", 
       "I'd like a {Crust} crust."
    ], 
    slotConstraint: "Required", 
    slotType: "DocPizzaCrustType", 
    slotTypeVersion: "$LATEST", 
    valueElicitationPrompt: {
     maxAttempts: 1, 
     messages: [
        {
       content: "What type of crust would you like?", 
       contentType: "PlainText"
      }, 
        {
       content: "Thick or thin crust?", 
       contentType: "PlainText"
      }
     ]
    }
   }, 
     {
    name: "Sauce", 
    description: "The type of sauce to use on the pizza.", 
    priority: 3, 
    sampleUtterances: [
       "Make it {Sauce} sauce.", 
       "I'd like {Sauce} sauce."
    ], 
    slotConstraint: "Required", 
    slotType: "DocPizzaSauceType", 
    slotTypeVersion: "$LATEST", 
    valueElicitationPrompt: {
     maxAttempts: 1, 
     messages: [
        {
       content: "White or red sauce?", 
       contentType: "PlainText"
      }, 
        {
       content: "Garlic or tomato sauce?", 
       contentType: "PlainText"
      }
     ]
    }
   }
  ]
 };
 lexmodelbuildingservice.putIntent(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    version: "$LATEST", 
    name: "DocOrderPizza", 
    checksum: "ca9bc13d-afc8-4706-bbaf-091f7a5935d6", 
    conclusionStatement: {
     messages: [
        {
       content: "All right, I ordered  you a {Crust} crust {Type} pizza with {Sauce} sauce.", 
       contentType: "PlainText"
      }, 
        {
       content: "OK, your {Crust} crust {Type} pizza with {Sauce} sauce is on the way.", 
       contentType: "PlainText"
      }
     ], 
     responseCard: "foo"
    }, 
    confirmationPrompt: {
     maxAttempts: 1, 
     messages: [
        {
       content: "Should I order  your {Crust} crust {Type} pizza with {Sauce} sauce?", 
       contentType: "PlainText"
      }
     ]
    }, 
    createdDate: <Date Representation>, 
    description: "Order a pizza from a local pizzeria.", 
    fulfillmentActivity: {
     type: "ReturnIntent"
    }, 
    lastUpdatedDate: <Date Representation>, 
    rejectionStatement: {
     messages: [
        {
       content: "Ok, I'll cancel your order.", 
       contentType: "PlainText"
      }, 
        {
       content: "I cancelled your order.", 
       contentType: "PlainText"
      }
     ]
    }, 
    sampleUtterances: [
       "Order me a pizza.", 
       "Order me a {Type} pizza.", 
       "I want a {Crust} crust {Type} pizza", 
       "I want a {Crust} crust {Type} pizza with {Sauce} sauce."
    ], 
    slots: [
       {
      name: "Sauce", 
      description: "The type of sauce to use on the pizza.", 
      priority: 3, 
      sampleUtterances: [
         "Make it {Sauce} sauce.", 
         "I'd like {Sauce} sauce."
      ], 
      slotConstraint: "Required", 
      slotType: "DocPizzaSauceType", 
      slotTypeVersion: "$LATEST", 
      valueElicitationPrompt: {
       maxAttempts: 1, 
       messages: [
          {
         content: "White or red sauce?", 
         contentType: "PlainText"
        }, 
          {
         content: "Garlic or tomato sauce?", 
         contentType: "PlainText"
        }
       ]
      }
     }, 
       {
      name: "Type", 
      description: "The type of pizza to order.", 
      priority: 1, 
      sampleUtterances: [
         "Get me a {Type} pizza.", 
         "A {Type} pizza please.", 
         "I'd like a {Type} pizza."
      ], 
      slotConstraint: "Required", 
      slotType: "DocPizzaType", 
      slotTypeVersion: "$LATEST", 
      valueElicitationPrompt: {
       maxAttempts: 1, 
       messages: [
          {
         content: "What type of pizza would you like?", 
         contentType: "PlainText"
        }, 
          {
         content: "Vegie or cheese pizza?", 
         contentType: "PlainText"
        }, 
          {
         content: "I can get you a vegie or a cheese pizza.", 
         contentType: "PlainText"
        }
       ]
      }
     }, 
       {
      name: "Crust", 
      description: "The type of pizza crust to order.", 
      priority: 2, 
      sampleUtterances: [
         "Make it a {Crust} crust.", 
         "I'd like a {Crust} crust."
      ], 
      slotConstraint: "Required", 
      slotType: "DocPizzaCrustType", 
      slotTypeVersion: "$LATEST", 
      valueElicitationPrompt: {
       maxAttempts: 1, 
       messages: [
          {
         content: "What type of crust would you like?", 
         contentType: "PlainText"
        }, 
          {
         content: "Thick or thin crust?", 
         contentType: "PlainText"
        }
       ]
      }
     }
    ]
   }
   */
 });

Calling the putIntent operation

var params = {
  name: 'STRING_VALUE', /* required */
  checksum: 'STRING_VALUE',
  conclusionStatement: {
    messages: [ /* required */
      {
        content: 'STRING_VALUE', /* required */
        contentType: PlainText | SSML /* required */
      },
      /* more items */
    ],
    responseCard: 'STRING_VALUE'
  },
  confirmationPrompt: {
    maxAttempts: 0, /* required */
    messages: [ /* required */
      {
        content: 'STRING_VALUE', /* required */
        contentType: PlainText | SSML /* required */
      },
      /* more items */
    ],
    responseCard: 'STRING_VALUE'
  },
  description: 'STRING_VALUE',
  dialogCodeHook: {
    messageVersion: 'STRING_VALUE', /* required */
    uri: 'STRING_VALUE' /* required */
  },
  followUpPrompt: {
    prompt: { /* required */
      maxAttempts: 0, /* required */
      messages: [ /* required */
        {
          content: 'STRING_VALUE', /* required */
          contentType: PlainText | SSML /* required */
        },
        /* more items */
      ],
      responseCard: 'STRING_VALUE'
    },
    rejectionStatement: { /* required */
      messages: [ /* required */
        {
          content: 'STRING_VALUE', /* required */
          contentType: PlainText | SSML /* required */
        },
        /* more items */
      ],
      responseCard: 'STRING_VALUE'
    }
  },
  fulfillmentActivity: {
    type: ReturnIntent | CodeHook, /* required */
    codeHook: {
      messageVersion: 'STRING_VALUE', /* required */
      uri: 'STRING_VALUE' /* required */
    }
  },
  parentIntentSignature: 'STRING_VALUE',
  rejectionStatement: {
    messages: [ /* required */
      {
        content: 'STRING_VALUE', /* required */
        contentType: PlainText | SSML /* required */
      },
      /* more items */
    ],
    responseCard: 'STRING_VALUE'
  },
  sampleUtterances: [
    'STRING_VALUE',
    /* more items */
  ],
  slots: [
    {
      name: 'STRING_VALUE', /* required */
      slotConstraint: Required | Optional, /* required */
      description: 'STRING_VALUE',
      priority: 0,
      responseCard: 'STRING_VALUE',
      sampleUtterances: [
        'STRING_VALUE',
        /* more items */
      ],
      slotType: 'STRING_VALUE',
      slotTypeVersion: 'STRING_VALUE',
      valueElicitationPrompt: {
        maxAttempts: 0, /* required */
        messages: [ /* required */
          {
            content: 'STRING_VALUE', /* required */
            contentType: PlainText | SSML /* required */
          },
          /* more items */
        ],
        responseCard: 'STRING_VALUE'
      }
    },
    /* more items */
  ]
};
lexmodelbuildingservice.putIntent(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: {})
    • name — (String)

      The name of the intent. The name is not case sensitive.

      The name can't match a built-in intent name, or a built-in intent name with "AMAZON." removed. For example, because there is a built-in intent called AMAZON.HelpIntent, you can't create a custom intent called HelpIntent.

      For a list of built-in intents, see Standard Built-in Intents in the Alexa Skills Kit.

    • description — (String)

      A description of the intent.

    • slots — (Array<map>)

      An array of intent slots. At runtime, Amazon Lex elicits required slot values from the user using prompts defined in the slots. For more information, see <xref linkend="how-it-works"/>.

      • namerequired — (String)

        The name of the slot.

      • description — (String)

        A description of the slot.

      • slotConstraintrequired — (String)

        Specifies whether the slot is required or optional.

        Possible values include:
        • "Required"
        • "Optional"
      • slotType — (String)

        The type of the slot, either a custom slot type that you defined or one of the built-in slot types.

      • slotTypeVersion — (String)

        The version of the slot type.

      • valueElicitationPrompt — (map)

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

        • messagesrequired — (Array<map>)

          An array of objects, each of which provides a message string and its type. You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML).

          • contentTyperequired — (String)

            The content type of the message string.

            Possible values include:
            • "PlainText"
            • "SSML"
          • contentrequired — (String)

            The text of the message.

        • maxAttemptsrequired — (Integer)

          The number of times to prompt the user for information.

        • responseCard — (String)

          A response card. Amazon Lex uses this prompt at runtime, in the PostText API response. It substitutes session attributes and slot values for placeholders in the response card. For more information, see ex-resp-card.

      • priority — (Integer)

        Directs Lex the order in which to elicit this slot value from the user. For example, if the intent has two slots with priorities 1 and 2, AWS Lex first elicits a value for the slot with priority 1.

        If multiple slots share the same priority, the order in which Lex elicits values is arbitrary.

      • sampleUtterances — (Array<String>)

        If you know a specific pattern with which 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.

      • responseCard — (String)

        A set of possible responses for the slot type used by text-based clients. A user chooses an option from the response card, instead of using text to reply.

    • sampleUtterances — (Array<String>)

      An array of utterances (strings) that a user might say to signal the intent. For example, "I want {PizzaSize} pizza", "Order {Quantity} {PizzaSize} pizzas".

      In each utterance, a slot name is enclosed in curly braces.

    • confirmationPrompt — (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.

      Note: You you must provide both the rejectionStatement and the confirmationPrompt, or neither.
      • messagesrequired — (Array<map>)

        An array of objects, each of which provides a message string and its type. You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML).

        • contentTyperequired — (String)

          The content type of the message string.

          Possible values include:
          • "PlainText"
          • "SSML"
        • contentrequired — (String)

          The text of the message.

      • maxAttemptsrequired — (Integer)

        The number of times to prompt the user for information.

      • responseCard — (String)

        A response card. Amazon Lex uses this prompt at runtime, in the PostText API response. It substitutes session attributes and slot values for placeholders in the response card. For more information, see ex-resp-card.

    • rejectionStatement — (map)

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

      Note: You must provide both the rejectionStatement and the confirmationPrompt, or neither.
      • messagesrequired — (Array<map>)

        A collection of message objects.

        • contentTyperequired — (String)

          The content type of the message string.

          Possible values include:
          • "PlainText"
          • "SSML"
        • contentrequired — (String)

          The text of the message.

      • responseCard — (String)

        At runtime, if the client is using the PostText API, Amazon Lex includes the response card in the response. It substitutes all of the session attributes and slot values for placeholders in the response card.

    • followUpPrompt — (map)

      Amazon Lex uses this prompt to solicit additional activity after fulfilling an intent. For example, after the OrderPizza intent is fulfilled, you might prompt the user to order a drink.

      The action that Amazon Lex takes depends on the user's response, as follows:

      • If the user says "Yes" it responds with the clarification prompt that is configured for the bot.

      • if the user says "Yes" and continues with an utterance that triggers an intent it starts a conversation for the intent.

      • If the user says "No" it responds with the rejection statement configured for the the follow-up prompt.

      • If it doesn't recognize the utterance it repeats the follow-up prompt again.

      The followUpPrompt field and the conclusionStatement field are mutually exclusive. You can specify only one.

      • promptrequired — (map)

        Prompts for information from the user.

        • messagesrequired — (Array<map>)

          An array of objects, each of which provides a message string and its type. You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML).

          • contentTyperequired — (String)

            The content type of the message string.

            Possible values include:
            • "PlainText"
            • "SSML"
          • contentrequired — (String)

            The text of the message.

        • maxAttemptsrequired — (Integer)

          The number of times to prompt the user for information.

        • responseCard — (String)

          A response card. Amazon Lex uses this prompt at runtime, in the PostText API response. It substitutes session attributes and slot values for placeholders in the response card. For more information, see ex-resp-card.

      • rejectionStatementrequired — (map)

        If the user answers "no" to the question defined in the prompt field, Amazon Lex responds with this statement to acknowledge that the intent was canceled.

        • messagesrequired — (Array<map>)

          A collection of message objects.

          • contentTyperequired — (String)

            The content type of the message string.

            Possible values include:
            • "PlainText"
            • "SSML"
          • contentrequired — (String)

            The text of the message.

        • responseCard — (String)

          At runtime, if the client is using the PostText API, Amazon Lex includes the response card in the response. It substitutes all of the session attributes and slot values for placeholders in the response card.

    • conclusionStatement — (map)

      The statement that you want Amazon Lex to convey to the user after the intent is successfully fulfilled by the Lambda function.

      This element is relevant only if you provide a Lambda function in the fulfillmentActivity. If you return the intent to the client application, you can't specify this element.

      Note: The followUpPrompt and conclusionStatement are mutually exclusive. You can specify only one.
      • messagesrequired — (Array<map>)

        A collection of message objects.

        • contentTyperequired — (String)

          The content type of the message string.

          Possible values include:
          • "PlainText"
          • "SSML"
        • contentrequired — (String)

          The text of the message.

      • responseCard — (String)

        At runtime, if the client is using the PostText API, Amazon Lex includes the response card in the response. It substitutes all of the session attributes and slot values for placeholders in the response card.

    • dialogCodeHook — (map)

      Specifies a Lambda function to invoke for each user input. You can invoke this Lambda function to personalize user interaction.

      For example, suppose your bot determines that the user is John. Your 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.

      • urirequired — (String)

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

      • messageVersionrequired — (String)

        The version of the request-response that you want Amazon Lex to use to invoke your Lambda function. For more information, see using-lambda.

    • fulfillmentActivity — (map)

      Describes how the intent is fulfilled. For example, after a user provides all of the information for a pizza order, fulfillmentActivity defines how the bot places an order with a local pizza store.

      You might configure Amazon Lex to return all of the intent information to the client application, or direct it to invoke a Lambda function that can process the intent (for example, place an order with a pizzeria).

      • typerequired — (String)

        How the intent should be fulfilled, either by running a Lambda function or by returning the slot data to the client application.

        Possible values include:
        • "ReturnIntent"
        • "CodeHook"
      • codeHook — (map)

        A description of the Lambda function that is run to fulfill the intent.

        • urirequired — (String)

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

        • messageVersionrequired — (String)

          The version of the request-response that you want Amazon Lex to use to invoke your Lambda function. For more information, see using-lambda.

    • parentIntentSignature — (String)

      A unique identifier for the built-in intent to base this intent on. To find the signature for an intent, see Standard Built-in Intents in the Alexa Skills Kit.

    • checksum — (String)

      Identifies a specific revision of the $LATEST version.

      When you create a new intent, leave the checksum field blank. If you specify a checksum you get a BadRequestException exception.

      When you want to update a intent, set the checksum field to the checksum of the most recent revision of the $LATEST version. If you don't specify the checksum field, or if the checksum does not match the $LATEST version, you get a PreconditionFailedException 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:

      • name — (String)

        The name of the intent.

      • description — (String)

        A description of the intent.

      • slots — (Array<map>)

        An array of intent slots that are configured for the intent.

        • namerequired — (String)

          The name of the slot.

        • description — (String)

          A description of the slot.

        • slotConstraintrequired — (String)

          Specifies whether the slot is required or optional.

          Possible values include:
          • "Required"
          • "Optional"
        • slotType — (String)

          The type of the slot, either a custom slot type that you defined or one of the built-in slot types.

        • slotTypeVersion — (String)

          The version of the slot type.

        • valueElicitationPrompt — (map)

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

          • messagesrequired — (Array<map>)

            An array of objects, each of which provides a message string and its type. You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML).

            • contentTyperequired — (String)

              The content type of the message string.

              Possible values include:
              • "PlainText"
              • "SSML"
            • contentrequired — (String)

              The text of the message.

          • maxAttemptsrequired — (Integer)

            The number of times to prompt the user for information.

          • responseCard — (String)

            A response card. Amazon Lex uses this prompt at runtime, in the PostText API response. It substitutes session attributes and slot values for placeholders in the response card. For more information, see ex-resp-card.

        • priority — (Integer)

          Directs Lex the order in which to elicit this slot value from the user. For example, if the intent has two slots with priorities 1 and 2, AWS Lex first elicits a value for the slot with priority 1.

          If multiple slots share the same priority, the order in which Lex elicits values is arbitrary.

        • sampleUtterances — (Array<String>)

          If you know a specific pattern with which 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.

        • responseCard — (String)

          A set of possible responses for the slot type used by text-based clients. A user chooses an option from the response card, instead of using text to reply.

      • sampleUtterances — (Array<String>)

        An array of sample utterances that are configured for the intent.

      • confirmationPrompt — (map)

        If defined in the intent, Amazon Lex prompts the user to confirm the intent before fulfilling it.

        • messagesrequired — (Array<map>)

          An array of objects, each of which provides a message string and its type. You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML).

          • contentTyperequired — (String)

            The content type of the message string.

            Possible values include:
            • "PlainText"
            • "SSML"
          • contentrequired — (String)

            The text of the message.

        • maxAttemptsrequired — (Integer)

          The number of times to prompt the user for information.

        • responseCard — (String)

          A response card. Amazon Lex uses this prompt at runtime, in the PostText API response. It substitutes session attributes and slot values for placeholders in the response card. For more information, see ex-resp-card.

      • rejectionStatement — (map)

        If the user answers "no" to the question defined in confirmationPrompt Amazon Lex responds with this statement to acknowledge that the intent was canceled.

        • messagesrequired — (Array<map>)

          A collection of message objects.

          • contentTyperequired — (String)

            The content type of the message string.

            Possible values include:
            • "PlainText"
            • "SSML"
          • contentrequired — (String)

            The text of the message.

        • responseCard — (String)

          At runtime, if the client is using the PostText API, Amazon Lex includes the response card in the response. It substitutes all of the session attributes and slot values for placeholders in the response card.

      • followUpPrompt — (map)

        If defined in the intent, Amazon Lex uses this prompt to solicit additional user activity after the intent is fulfilled.

        • promptrequired — (map)

          Prompts for information from the user.

          • messagesrequired — (Array<map>)

            An array of objects, each of which provides a message string and its type. You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML).

            • contentTyperequired — (String)

              The content type of the message string.

              Possible values include:
              • "PlainText"
              • "SSML"
            • contentrequired — (String)

              The text of the message.

          • maxAttemptsrequired — (Integer)

            The number of times to prompt the user for information.

          • responseCard — (String)

            A response card. Amazon Lex uses this prompt at runtime, in the PostText API response. It substitutes session attributes and slot values for placeholders in the response card. For more information, see ex-resp-card.

        • rejectionStatementrequired — (map)

          If the user answers "no" to the question defined in the prompt field, Amazon Lex responds with this statement to acknowledge that the intent was canceled.

          • messagesrequired — (Array<map>)

            A collection of message objects.

            • contentTyperequired — (String)

              The content type of the message string.

              Possible values include:
              • "PlainText"
              • "SSML"
            • contentrequired — (String)

              The text of the message.

          • responseCard — (String)

            At runtime, if the client is using the PostText API, Amazon Lex includes the response card in the response. It substitutes all of the session attributes and slot values for placeholders in the response card.

      • conclusionStatement — (map)

        After the Lambda function specified in thefulfillmentActivityintent fulfills the intent, Amazon Lex conveys this statement to the user.

        • messagesrequired — (Array<map>)

          A collection of message objects.

          • contentTyperequired — (String)

            The content type of the message string.

            Possible values include:
            • "PlainText"
            • "SSML"
          • contentrequired — (String)

            The text of the message.

        • responseCard — (String)

          At runtime, if the client is using the PostText API, Amazon Lex includes the response card in the response. It substitutes all of the session attributes and slot values for placeholders in the response card.

      • dialogCodeHook — (map)

        If defined in the intent, Amazon Lex invokes this Lambda function for each user input.

        • urirequired — (String)

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

        • messageVersionrequired — (String)

          The version of the request-response that you want Amazon Lex to use to invoke your Lambda function. For more information, see using-lambda.

      • fulfillmentActivity — (map)

        If defined in the intent, Amazon Lex invokes this Lambda function to fulfill the intent after the user provides all of the information required by the intent.

        • typerequired — (String)

          How the intent should be fulfilled, either by running a Lambda function or by returning the slot data to the client application.

          Possible values include:
          • "ReturnIntent"
          • "CodeHook"
        • codeHook — (map)

          A description of the Lambda function that is run to fulfill the intent.

          • urirequired — (String)

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

          • messageVersionrequired — (String)

            The version of the request-response that you want Amazon Lex to use to invoke your Lambda function. For more information, see using-lambda.

      • parentIntentSignature — (String)

        A unique identifier for the built-in intent that this intent is based on.

      • lastUpdatedDate — (Date)

        The date that the intent was updated. When you create a resource, the creation date and last update dates are the same.

      • createdDate — (Date)

        The date that the intent was created.

      • version — (String)

        The version of the intent. For a new intent, the version is always $LATEST.

      • checksum — (String)

        Checksum of the $LATESTversion of the intent created or updated.

Returns:

  • (AWS.Request)

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

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

Creates a custom slot type or replaces an existing custom slot type.

To create a custom slot type, specify a name for the slot type and a set of enumeration values, which are the values that a slot of this type can assume. For more information, see how-it-works.

If you specify the name of an existing slot type, the fields in the request replace the existing values in the $LATEST version of the slot type. Amazon Lex removes the fields that you don't provide in the request. If you don't specify required fields, Amazon Lex throws an exception.

This operation requires permissions for the lex:PutSlotType action.

Service Reference:

Examples:

To Create a Slot Type


/* This example shows how to create a slot type that describes pizza sauces. */

 var params = {
  name: "PizzaSauceType", 
  description: "Available pizza sauces", 
  enumerationValues: [
     {
    value: "red"
   }, 
     {
    value: "white"
   }
  ]
 };
 lexmodelbuildingservice.putSlotType(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    version: "$LATEST", 
    name: "DocPizzaSauceType", 
    checksum: "cfd00ed1-775d-4357-947c-aca7e73b44ba", 
    createdDate: <Date Representation>, 
    description: "Available pizza sauces", 
    enumerationValues: [
       {
      value: "red"
     }, 
       {
      value: "white"
     }
    ], 
    lastUpdatedDate: <Date Representation>
   }
   */
 });

Calling the putSlotType operation

var params = {
  name: 'STRING_VALUE', /* required */
  checksum: 'STRING_VALUE',
  description: 'STRING_VALUE',
  enumerationValues: [
    {
      value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
lexmodelbuildingservice.putSlotType(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: {})
    • name — (String)

      The name of the slot type. The name is not case sensitive.

      The name can't match a built-in slot type name, or a built-in slot type name with "AMAZON." removed. For example, because there is a built-in slot type called AMAZON.DATE, you can't create a custom slot type called DATE.

      For a list of built-in slot types, see Slot Type Reference in the Alexa Skills Kit.

    • description — (String)

      A description of the slot type.

    • enumerationValues — (Array<map>)

      A list of EnumerationValue objects that defines the values that the slot type can take.

      • valuerequired — (String)

        The value of the slot type.

    • checksum — (String)

      Identifies a specific revision of the $LATEST version.

      When you create a new slot type, leave the checksum field blank. If you specify a checksum you get a BadRequestException exception.

      When you want to update a slot type, set the checksum field to the checksum of the most recent revision of the $LATEST version. If you don't specify the checksum field, or if the checksum does not match the $LATEST version, you get a PreconditionFailedException 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:

      • name — (String)

        The name of the slot type.

      • description — (String)

        A description of the slot type.

      • enumerationValues — (Array<map>)

        A list of EnumerationValue objects that defines the values that the slot type can take.

        • valuerequired — (String)

          The value of the slot type.

      • lastUpdatedDate — (Date)

        The date that the slot type was updated. When you create a slot type, the creation date and last update date are the same.

      • createdDate — (Date)

        The date that the slot type was created.

      • version — (String)

        The version of the slot type. For a new slot type, the version is always $LATEST.

      • checksum — (String)

        Checksum of the $LATEST version of the slot type.

Returns:

  • (AWS.Request)

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