AWS Lex (Models) (version v1.*.*)

name (required)#

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

Type: string

$body#

Type: object

{
  "checksum" : "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."
}

name (required)#

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

Type: string

$body#

Type: object

{
  "checksum" : "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."
}

name (required)#

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

Type: string

$body#

Type: object

{
  "checksum" : "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."
}

name (required)#

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

Type: string

botName (required)#

The name of the bot that the alias points to.

Type: string

name (required)#

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

Type: string

aliasName (required)#

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

Type: string

botName (required)#

The name of the Amazon Lex bot.

Type: string

name (required)#

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

Type: string

name (required)#

The name of the bot.

Type: string

version (required)#

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.

Type: string

name (required)#

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

Type: string

name (required)#

The name of the intent.

Type: string

version (required)#

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.

Type: string

name (required)#

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

Type: string

name (required)#

The name of the slot type.

Type: string

version (required)#

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.

Type: string

botName (required)#

The name of the bot that stored the utterances.

Type: string

userId (required)#

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.

Type: string

name (required)#

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

Type: string

versionoralias (required)#

The version or alias of the bot.

Type: string

botName (required)#

The name of the bot.

Type: string

name (required)#

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

Type: string

botName (required)#

The name of the bot.

Type: string

nameContains#

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

Type: string

aliasName (required)#

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

Type: string

botName (required)#

The name of the Amazon Lex bot.

Type: string

name (required)#

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

Type: string

aliasName (required)#

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

Type: string

botName (required)#

The name of the Amazon Lex bot in the association.

Type: string

nameContains#

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.

Type: string

name (required)#

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

Type: string

nameContains#

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

Type: string

signature (required)#

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.

Type: string

locale#

A list of locales that the intent supports.

Type: string

Potential values: en-US, en-GB, de-DE

signatureContains#

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.

Type: string

locale#

A list of locales that the slot type supports.

Type: string

Potential values: en-US, en-GB, de-DE

signatureContains#

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

Type: string

exportType (required)#

The format of the exported data.

Type: string

Potential values: ALEXA_SKILLS_KIT, LEX

name (required)#

The name of the bot to export.

Type: string

resourceType (required)#

The type of resource to export.

Type: string

Potential values: BOT, INTENT, SLOT_TYPE

version (required)#

The version of the bot to export.

Type: string

importId (required)#

The identifier of the import job information to return.

Type: string

name (required)#

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

Type: string

version (required)#

The version of the intent.

Type: string

name (required)#

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

Type: string

nameContains#

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

Type: string

name (required)#

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

Type: string

version (required)#

The version of the slot type.

Type: string

name (required)#

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

Type: string

nameContains#

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

Type: string

bot_versions (required)#

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

Type: array

[ "string" ]

botname (required)#

The name of the bot for which utterance information should be returned.

Type: string

status_type (required)#

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

Type: string

Potential values: Detected, Missed

name (required)#

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

Type: string

$body#

Type: object

{
  "createVersion" : "boolean",
  "intents" : [ {
    "intentName" : "The name of the intent.",
    "intentVersion" : "The version of the intent."
  } ],
  "voiceId" : "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.",
  "clarificationPrompt" : {
    "maxAttempts" : "The number of times to prompt the user for information.",
    "responseCard" : "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. ",
    "messages" : [ {
      "contentType" : "The content type of the message string.",
      "groupNumber" : "Identifies the message group that the message belongs to. When a group is assigned to a message, Amazon Lex returns one message from each group in the response.",
      "content" : "The text of the message."
    } ]
  },
  "processBehavior" : "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 SAVE Amazon Lex saves the bot, but doesn't build it.  \nIf you don't specify this value, the default value is BUILD.",
  "checksum" : "Identifies a specific revision of the $LATEST version. \nWhen you create a new bot, leave the checksum field blank. If you specify a checksum you get a BadRequestException exception. \nWhen 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.",
  "description" : "A description of the bot.",
  "idleSessionTTLInSeconds" : "The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. \nA 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. \nFor 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. \nIf 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. \nThe default is 300 seconds (5 minutes).",
  "childDirected" : "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. \nIf 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. ",
  "locale" : " Specifies the target locale for the bot. Any intent used in the bot must be compatible with the locale of the bot.  \nThe default is en-US.",
  "abortStatement" : {
    "responseCard" : " 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. ",
    "messages" : [ {
      "contentType" : "The content type of the message string.",
      "groupNumber" : "Identifies the message group that the message belongs to. When a group is assigned to a message, Amazon Lex returns one message from each group in the response.",
      "content" : "The text of the message."
    } ]
  }
}

botName (required)#

The name of the bot.

Type: string

name (required)#

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

Type: string

$body#

Type: object

{
  "checksum" : "Identifies a specific revision of the $LATEST version. \nWhen you create a new bot alias, leave the checksum field blank. If you specify a checksum you get a BadRequestException exception. \nWhen 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.",
  "description" : "A description of the alias.",
  "botVersion" : "The version of the bot."
}

name (required)#

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.

Type: string

$body#

Type: object

{
  "createVersion" : "boolean",
  "sampleUtterances" : [ "string" ],
  "slots" : [ {
    "valueElicitationPrompt" : {
      "maxAttempts" : "The number of times to prompt the user for information.",
      "responseCard" : "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. ",
      "messages" : [ {
        "contentType" : "The content type of the message string.",
        "groupNumber" : "Identifies the message group that the message belongs to. When a group is assigned to a message, Amazon Lex returns one message from each group in the response.",
        "content" : "The text of the message."
      } ]
    },
    "sampleUtterances" : [ "string" ],
    "responseCard" : " 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. ",
    "slotConstraint" : "Specifies whether the slot is required or optional. ",
    "slotType" : "The type of the slot, either a custom slot type that you defined or one of the built-in slot types.",
    "slotTypeVersion" : "The version of the slot type.",
    "name" : "The name of the slot.",
    "description" : "A description of the slot.",
    "priority" : " 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. \nIf multiple slots share the same priority, the order in which Lex elicits values is arbitrary."
  } ],
  "rejectionStatement" : {
    "responseCard" : " 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. ",
    "messages" : [ {
      "contentType" : "The content type of the message string.",
      "groupNumber" : "Identifies the message group that the message belongs to. When a group is assigned to a message, Amazon Lex returns one message from each group in the response.",
      "content" : "The text of the message."
    } ]
  },
  "parentIntentSignature" : "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.",
  "conclusionStatement" : {
    "responseCard" : " 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. ",
    "messages" : [ {
      "contentType" : "The content type of the message string.",
      "groupNumber" : "Identifies the message group that the message belongs to. When a group is assigned to a message, Amazon Lex returns one message from each group in the response.",
      "content" : "The text of the message."
    } ]
  },
  "confirmationPrompt" : {
    "maxAttempts" : "The number of times to prompt the user for information.",
    "responseCard" : "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. ",
    "messages" : [ {
      "contentType" : "The content type of the message string.",
      "groupNumber" : "Identifies the message group that the message belongs to. When a group is assigned to a message, Amazon Lex returns one message from each group in the response.",
      "content" : "The text of the message."
    } ]
  },
  "checksum" : "Identifies a specific revision of the $LATEST version. \nWhen you create a new intent, leave the checksum field blank. If you specify a checksum you get a BadRequestException exception. \nWhen 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.",
  "description" : "A description of the intent.",
  "dialogCodeHook" : {
    "messageVersion" : "The version of the request-response that you want Amazon Lex to use to invoke your Lambda function. For more information, see using-lambda.",
    "uri" : "The Amazon Resource Name (ARN) of the Lambda function."
  },
  "followUpPrompt" : {
    "rejectionStatement" : {
      "responseCard" : " 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. ",
      "messages" : [ {
        "contentType" : "The content type of the message string.",
        "groupNumber" : "Identifies the message group that the message belongs to. When a group is assigned to a message, Amazon Lex returns one message from each group in the response.",
        "content" : "The text of the message."
      } ]
    },
    "prompt" : {
      "maxAttempts" : "The number of times to prompt the user for information.",
      "responseCard" : "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. ",
      "messages" : [ {
        "contentType" : "The content type of the message string.",
        "groupNumber" : "Identifies the message group that the message belongs to. When a group is assigned to a message, Amazon Lex returns one message from each group in the response.",
        "content" : "The text of the message."
      } ]
    }
  },
  "fulfillmentActivity" : {
    "type" : " How the intent should be fulfilled, either by running a Lambda function or by returning the slot data to the client application. ",
    "codeHook" : {
      "messageVersion" : "The version of the request-response that you want Amazon Lex to use to invoke your Lambda function. For more information, see using-lambda.",
      "uri" : "The Amazon Resource Name (ARN) of the Lambda function."
    }
  }
}

name (required)#

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.

Type: string

$body#

Type: object

{
  "valueSelectionStrategy" : "Determines the slot resolution strategy that Amazon Lex uses to return slot type values. The field can be set to one of the following values:  \n  ORIGINAL_VALUE - Returns the value entered by the user, if the user value is similar to the slot value.  \n  TOP_RESOLUTION - If there is a resolution list for the slot, return the first value in the resolution list as the slot type value. If there is no resolution list, null is returned.   \nIf you don't specify the valueSelectionStrategy, the default is ORIGINAL_VALUE.",
  "createVersion" : "boolean",
  "checksum" : "Identifies a specific revision of the $LATEST version. \nWhen you create a new slot type, leave the checksum field blank. If you specify a checksum you get a BadRequestException exception. \nWhen 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.",
  "description" : "A description of the slot type.",
  "enumerationValues" : [ {
    "synonyms" : [ "string" ],
    "value" : "The value of the slot type."
  } ]
}

$body#

Type: object

{
  "payload" : "A zip archive in binary format. The archive should contain one file, a JSON file containing the resource to import. The resource should match the type specified in the resourceType field.",
  "mergeStrategy" : "Specifies the action that the StartImport operation should take when there is an existing resource with the same name.  \n FAIL_ON_CONFLICT - The import operation is stopped on the first conflict between a resource in the import file and an existing resource. The name of the resource causing the conflict is in the failureReason field of the response to the GetImport operation. OVERWRITE_LATEST - The import operation proceeds even if there is a conflict with an existing resource. The $LASTEST version of the existing resource is overwritten with the data from the import file. ",
  "resourceType" : "Specifies the type of resource to export. Each resource also exports any resources that it depends on.   \n A bot exports dependent intents.  \n An intent exports dependent slot types. "
}