See: newPutIntent smart constructor.

Create a value of PutIntent with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:fulfillmentActivity:PutIntent', putIntent_fulfillmentActivity - Required. 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).

$sel:slots:PutIntent', putIntent_slots - 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 how-it-works.

$sel:rejectionStatement:PutIntent', putIntent_rejectionStatement - When the user answers "no" to the question defined in confirmationPrompt, Amazon Lex responds with this statement to acknowledge that the intent was canceled.

You must provide both the rejectionStatement and the confirmationPrompt, or neither.

$sel:checksum:PutIntent', putIntent_checksum - 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.

$sel:conclusionStatement:PutIntent', putIntent_conclusionStatement - 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.

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

$sel:sampleUtterances:PutIntent', putIntent_sampleUtterances - 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.

$sel:parentIntentSignature:PutIntent', putIntent_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.

$sel:kendraConfiguration:PutIntent', putIntent_kendraConfiguration - Configuration information required to use the AMAZON.KendraSearchIntent intent to connect to an Amazon Kendra index. For more information, see AMAZON.KendraSearchIntent.

$sel:inputContexts:PutIntent', putIntent_inputContexts - An array of InputContext objects that lists the contexts that must be active for Amazon Lex to choose the intent in a conversation with the user.

$sel:followUpPrompt:PutIntent', putIntent_followUpPrompt - 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.

$sel:outputContexts:PutIntent', putIntent_outputContexts - An array of OutputContext objects that lists the contexts that the intent activates when the intent is fulfilled.

$sel:confirmationPrompt:PutIntent', putIntent_confirmationPrompt - 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.

You you must provide both the rejectionStatement and the confirmationPrompt, or neither.

$sel:createVersion:PutIntent', putIntent_createVersion - When set to true a new numbered version of the intent is created. This is the same as calling the CreateIntentVersion operation. If you do not specify createVersion, the default is false.

$sel:dialogCodeHook:PutIntent', putIntent_dialogCodeHook - 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.

$sel:description:PutIntent', putIntent_description - A description of the intent.

$sel:name:PutIntent', putIntent_name - 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.

Required. 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).

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 how-it-works.

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

You must provide both the rejectionStatement and the confirmationPrompt, or neither.

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.

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.

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

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.

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.

Configuration information required to use the AMAZON.KendraSearchIntent intent to connect to an Amazon Kendra index. For more information, see AMAZON.KendraSearchIntent.

An array of InputContext objects that lists the contexts that must be active for Amazon Lex to choose the intent in a conversation with the user.

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.

An array of OutputContext objects that lists the contexts that the intent activates when the intent is fulfilled.

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.

You you must provide both the rejectionStatement and the confirmationPrompt, or neither.

When set to true a new numbered version of the intent is created. This is the same as calling the CreateIntentVersion operation. If you do not specify createVersion, the default is false.

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.

A description of the intent.

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.

See: newPutIntentResponse smart constructor.

Create a value of PutIntentResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:fulfillmentActivity:PutIntent', putIntentResponse_fulfillmentActivity - 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.

$sel:slots:PutIntent', putIntentResponse_slots - An array of intent slots that are configured for the intent.

$sel:rejectionStatement:PutIntent', putIntentResponse_rejectionStatement - If the user answers "no" to the question defined in confirmationPrompt Amazon Lex responds with this statement to acknowledge that the intent was canceled.

$sel:checksum:PutIntent', putIntentResponse_checksum - Checksum of the $LATESTversion of the intent created or updated.

$sel:conclusionStatement:PutIntent', putIntentResponse_conclusionStatement - After the Lambda function specified in thefulfillmentActivityintent fulfills the intent, Amazon Lex conveys this statement to the user.

$sel:sampleUtterances:PutIntent', putIntentResponse_sampleUtterances - An array of sample utterances that are configured for the intent.

$sel:parentIntentSignature:PutIntent', putIntentResponse_parentIntentSignature - A unique identifier for the built-in intent that this intent is based on.

$sel:createdDate:PutIntentResponse', putIntentResponse_createdDate - The date that the intent was created.

$sel:kendraConfiguration:PutIntent', putIntentResponse_kendraConfiguration - Configuration information, if any, required to connect to an Amazon Kendra index and use the AMAZON.KendraSearchIntent intent.

$sel:name:PutIntent', putIntentResponse_name - The name of the intent.

$sel:version:PutIntentResponse', putIntentResponse_version - The version of the intent. For a new intent, the version is always $LATEST.

$sel:inputContexts:PutIntent', putIntentResponse_inputContexts - An array of InputContext objects that lists the contexts that must be active for Amazon Lex to choose the intent in a conversation with the user.

$sel:followUpPrompt:PutIntent', putIntentResponse_followUpPrompt - If defined in the intent, Amazon Lex uses this prompt to solicit additional user activity after the intent is fulfilled.

$sel:lastUpdatedDate:PutIntentResponse', putIntentResponse_lastUpdatedDate - The date that the intent was updated. When you create a resource, the creation date and last update dates are the same.

$sel:outputContexts:PutIntent', putIntentResponse_outputContexts - An array of OutputContext objects that lists the contexts that the intent activates when the intent is fulfilled.

$sel:confirmationPrompt:PutIntent', putIntentResponse_confirmationPrompt - If defined in the intent, Amazon Lex prompts the user to confirm the intent before fulfilling it.

$sel:createVersion:PutIntent', putIntentResponse_createVersion - True if a new version of the intent was created. If the createVersion field was not specified in the request, the createVersion field is set to false in the response.

$sel:dialogCodeHook:PutIntent', putIntentResponse_dialogCodeHook - If defined in the intent, Amazon Lex invokes this Lambda function for each user input.

$sel:description:PutIntent', putIntentResponse_description - A description of the intent.

$sel:httpStatus:PutIntentResponse', putIntentResponse_httpStatus - The response's http status code.

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.

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

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

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

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

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

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

The date that the intent was created.

Configuration information, if any, required to connect to an Amazon Kendra index and use the AMAZON.KendraSearchIntent intent.

The name of the intent.

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

An array of InputContext objects that lists the contexts that must be active for Amazon Lex to choose the intent in a conversation with the user.

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

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

An array of OutputContext objects that lists the contexts that the intent activates when the intent is fulfilled.

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

True if a new version of the intent was created. If the createVersion field was not specified in the request, the createVersion field is set to false in the response.

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

A description of the intent.

The response's http status code.