PutIntentRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.lexmodelbuilding.model.PutIntentRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PutIntentRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

PutIntentRequest()

Constructors
Constructor and Description
`PutIntentRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PutIntentRequest`	`clone()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals(Object obj)`
`String`	`getChecksum()` Identifies a specific revision of the `$LATEST` version.
`Statement`	`getConclusionStatement()` The statement that you want Amazon Lex to convey to the user after the intent is successfully fulfilled by the Lambda function.
`Prompt`	`getConfirmationPrompt()` Prompts the user to confirm the intent.
`Boolean`	`getCreateVersion()` When set to `true` a new numbered version of the intent is created.
`String`	`getDescription()` A description of the intent.
`CodeHook`	`getDialogCodeHook()` Specifies a Lambda function to invoke for each user input.
`FollowUpPrompt`	`getFollowUpPrompt()` Amazon Lex uses this prompt to solicit additional activity after fulfilling an intent.
`FulfillmentActivity`	`getFulfillmentActivity()` Required.
`List<InputContext>`	`getInputContexts()` 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.
`KendraConfiguration`	`getKendraConfiguration()` Configuration information required to use the `AMAZON.KendraSearchIntent` intent to connect to an Amazon Kendra index.
`String`	`getName()` The name of the intent.
`List<OutputContext>`	`getOutputContexts()` An array of `OutputContext` objects that lists the contexts that the intent activates when the intent is fulfilled.
`String`	`getParentIntentSignature()` A unique identifier for the built-in intent to base this intent on.
`Statement`	`getRejectionStatement()` When the user answers "no" to the question defined in `confirmationPrompt`, Amazon Lex responds with this statement to acknowledge that the intent was canceled.
`List<String>`	`getSampleUtterances()` An array of utterances (strings) that a user might say to signal the intent.
`List<Slot>`	`getSlots()` An array of intent slots.
`int`	`hashCode()`
`Boolean`	`isCreateVersion()` When set to `true` a new numbered version of the intent is created.
`void`	`setChecksum(String checksum)` Identifies a specific revision of the `$LATEST` version.
`void`	`setConclusionStatement(Statement conclusionStatement)` The statement that you want Amazon Lex to convey to the user after the intent is successfully fulfilled by the Lambda function.
`void`	`setConfirmationPrompt(Prompt confirmationPrompt)` Prompts the user to confirm the intent.
`void`	`setCreateVersion(Boolean createVersion)` When set to `true` a new numbered version of the intent is created.
`void`	`setDescription(String description)` A description of the intent.
`void`	`setDialogCodeHook(CodeHook dialogCodeHook)` Specifies a Lambda function to invoke for each user input.
`void`	`setFollowUpPrompt(FollowUpPrompt followUpPrompt)` Amazon Lex uses this prompt to solicit additional activity after fulfilling an intent.
`void`	`setFulfillmentActivity(FulfillmentActivity fulfillmentActivity)` Required.
`void`	`setInputContexts(Collection<InputContext> 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.
`void`	`setKendraConfiguration(KendraConfiguration kendraConfiguration)` Configuration information required to use the `AMAZON.KendraSearchIntent` intent to connect to an Amazon Kendra index.
`void`	`setName(String name)` The name of the intent.
`void`	`setOutputContexts(Collection<OutputContext> outputContexts)` An array of `OutputContext` objects that lists the contexts that the intent activates when the intent is fulfilled.
`void`	`setParentIntentSignature(String parentIntentSignature)` A unique identifier for the built-in intent to base this intent on.
`void`	`setRejectionStatement(Statement 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.
`void`	`setSampleUtterances(Collection<String> sampleUtterances)` An array of utterances (strings) that a user might say to signal the intent.
`void`	`setSlots(Collection<Slot> slots)` An array of intent slots.
`String`	`toString()` Returns a string representation of this object.
`PutIntentRequest`	`withChecksum(String checksum)` Identifies a specific revision of the `$LATEST` version.
`PutIntentRequest`	`withConclusionStatement(Statement conclusionStatement)` The statement that you want Amazon Lex to convey to the user after the intent is successfully fulfilled by the Lambda function.
`PutIntentRequest`	`withConfirmationPrompt(Prompt confirmationPrompt)` Prompts the user to confirm the intent.
`PutIntentRequest`	`withCreateVersion(Boolean createVersion)` When set to `true` a new numbered version of the intent is created.
`PutIntentRequest`	`withDescription(String description)` A description of the intent.
`PutIntentRequest`	`withDialogCodeHook(CodeHook dialogCodeHook)` Specifies a Lambda function to invoke for each user input.
`PutIntentRequest`	`withFollowUpPrompt(FollowUpPrompt followUpPrompt)` Amazon Lex uses this prompt to solicit additional activity after fulfilling an intent.
`PutIntentRequest`	`withFulfillmentActivity(FulfillmentActivity fulfillmentActivity)` Required.
`PutIntentRequest`	`withInputContexts(Collection<InputContext> 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.
`PutIntentRequest`	`withInputContexts(InputContext... 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.
`PutIntentRequest`	`withKendraConfiguration(KendraConfiguration kendraConfiguration)` Configuration information required to use the `AMAZON.KendraSearchIntent` intent to connect to an Amazon Kendra index.
`PutIntentRequest`	`withName(String name)` The name of the intent.
`PutIntentRequest`	`withOutputContexts(Collection<OutputContext> outputContexts)` An array of `OutputContext` objects that lists the contexts that the intent activates when the intent is fulfilled.
`PutIntentRequest`	`withOutputContexts(OutputContext... outputContexts)` An array of `OutputContext` objects that lists the contexts that the intent activates when the intent is fulfilled.
`PutIntentRequest`	`withParentIntentSignature(String parentIntentSignature)` A unique identifier for the built-in intent to base this intent on.
`PutIntentRequest`	`withRejectionStatement(Statement 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.
`PutIntentRequest`	`withSampleUtterances(Collection<String> sampleUtterances)` An array of utterances (strings) that a user might say to signal the intent.
`PutIntentRequest`	`withSampleUtterances(String... sampleUtterances)` An array of utterances (strings) that a user might say to signal the intent.
`PutIntentRequest`	`withSlots(Collection<Slot> slots)` An array of intent slots.
`PutIntentRequest`	`withSlots(Slot... slots)` An array of intent slots.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PutIntentRequest
```
public PutIntentRequest()
```
- Method Detail
  - setName
```
public void setName(String 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.
    
    Parameters:
    
    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.
  - getName
```
public String getName()
```
    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.
    
    Returns:
    
    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.
  - withName
```
public PutIntentRequest withName(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    A description of the intent.
    
    Parameters:
    
    description - A description of the intent.
  - getDescription
```
public String getDescription()
```
    A description of the intent.
    
    Returns:
    
    A description of the intent.
  - withDescription
```
public PutIntentRequest withDescription(String description)
```
    A description of the intent.
    
    Parameters:
    
    description - A description of the intent.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getSlots
```
public List<Slot> getSlots()
```
    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.
    
    Returns:
    
    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.
  - setSlots
```
public void setSlots(Collection<Slot> 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.
    
    Parameters:
    
    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.
  - withSlots
```
public PutIntentRequest withSlots(Slot... 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.
    
    NOTE: This method appends the values to the existing list (if any). Use setSlots(java.util.Collection) or withSlots(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withSlots
```
public PutIntentRequest withSlots(Collection<Slot> 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getSampleUtterances
```
public List<String> getSampleUtterances()
```
    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.
    
    Returns:
    
    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.
  - setSampleUtterances
```
public void setSampleUtterances(Collection<String> 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.
    
    Parameters:
    
    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.
  - withSampleUtterances
```
public PutIntentRequest withSampleUtterances(String... 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.
    
    NOTE: This method appends the values to the existing list (if any). Use setSampleUtterances(java.util.Collection) or withSampleUtterances(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withSampleUtterances
```
public PutIntentRequest withSampleUtterances(Collection<String> 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setConfirmationPrompt
```
public void setConfirmationPrompt(Prompt 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.
    
    Parameters:
    
    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.
  - getConfirmationPrompt
```
public Prompt getConfirmationPrompt()
```
    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.
    
    Returns:
    
    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.
  - withConfirmationPrompt
```
public PutIntentRequest withConfirmationPrompt(Prompt 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRejectionStatement
```
public void setRejectionStatement(Statement 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.
    
    Parameters:
    
    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.
  - getRejectionStatement
```
public Statement getRejectionStatement()
```
    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.
    
    Returns:
    
    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.
  - withRejectionStatement
```
public PutIntentRequest withRejectionStatement(Statement 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFollowUpPrompt
```
public void setFollowUpPrompt(FollowUpPrompt 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.
    Parameters:
    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.
  - getFollowUpPrompt
```
public FollowUpPrompt getFollowUpPrompt()
```
    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.
    Returns:
    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.
  - withFollowUpPrompt
```
public PutIntentRequest withFollowUpPrompt(FollowUpPrompt 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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setConclusionStatement
```
public void setConclusionStatement(Statement 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.
    
    Parameters:
    
    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.
  - getConclusionStatement
```
public Statement getConclusionStatement()
```
    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.
    
    Returns:
    
    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.
  - withConclusionStatement
```
public PutIntentRequest withConclusionStatement(Statement 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDialogCodeHook
```
public void setDialogCodeHook(CodeHook 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.
    
    Parameters:
    
    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.
  - getDialogCodeHook
```
public CodeHook getDialogCodeHook()
```
    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.
    
    Returns:
    
    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.
  - withDialogCodeHook
```
public PutIntentRequest withDialogCodeHook(CodeHook 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFulfillmentActivity
```
public void setFulfillmentActivity(FulfillmentActivity 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).
    
    Parameters:
    
    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).
  - getFulfillmentActivity
```
public FulfillmentActivity getFulfillmentActivity()
```
    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).
    
    Returns:
    
    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).
  - withFulfillmentActivity
```
public PutIntentRequest withFulfillmentActivity(FulfillmentActivity 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).
    
    Parameters:
    
    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).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setParentIntentSignature
```
public void setParentIntentSignature(String 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.
    
    Parameters:
    
    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.
  - getParentIntentSignature
```
public String getParentIntentSignature()
```
    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.
    
    Returns:
    
    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.
  - withParentIntentSignature
```
public PutIntentRequest withParentIntentSignature(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setChecksum
```
public void setChecksum(String 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.
    
    Parameters:
    
    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.
  - getChecksum
```
public String getChecksum()
```
    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.
    
    Returns:
    
    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.
  - withChecksum
```
public PutIntentRequest withChecksum(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreateVersion
```
public void setCreateVersion(Boolean 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.
    
    Parameters:
    
    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.
  - getCreateVersion
```
public Boolean getCreateVersion()
```
    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.
    
    Returns:
    
    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.
  - withCreateVersion
```
public PutIntentRequest withCreateVersion(Boolean 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isCreateVersion
```
public Boolean isCreateVersion()
```
    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.
    
    Returns:
    
    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.
  - setKendraConfiguration
```
public void setKendraConfiguration(KendraConfiguration kendraConfiguration)
```
    Configuration information required to use the AMAZON.KendraSearchIntent intent to connect to an Amazon Kendra index. For more information, see AMAZON.KendraSearchIntent.
    
    Parameters:
    
    kendraConfiguration - Configuration information required to use the AMAZON.KendraSearchIntent intent to connect to an Amazon Kendra index. For more information, see AMAZON.KendraSearchIntent.
  - getKendraConfiguration
```
public KendraConfiguration getKendraConfiguration()
```
    Configuration information required to use the AMAZON.KendraSearchIntent intent to connect to an Amazon Kendra index. For more information, see AMAZON.KendraSearchIntent.
    
    Returns:
    
    Configuration information required to use the AMAZON.KendraSearchIntent intent to connect to an Amazon Kendra index. For more information, see AMAZON.KendraSearchIntent.
  - withKendraConfiguration
```
public PutIntentRequest withKendraConfiguration(KendraConfiguration kendraConfiguration)
```
    Configuration information required to use the AMAZON.KendraSearchIntent intent to connect to an Amazon Kendra index. For more information, see AMAZON.KendraSearchIntent.
    
    Parameters:
    
    kendraConfiguration - Configuration information required to use the AMAZON.KendraSearchIntent intent to connect to an Amazon Kendra index. For more information, see AMAZON.KendraSearchIntent.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getInputContexts
```
public List<InputContext> getInputContexts()
```
    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.
    
    Returns:
    
    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.
  - setInputContexts
```
public void setInputContexts(Collection<InputContext> 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.
    
    Parameters:
    
    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.
  - withInputContexts
```
public PutIntentRequest withInputContexts(InputContext... 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.
    
    NOTE: This method appends the values to the existing list (if any). Use setInputContexts(java.util.Collection) or withInputContexts(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withInputContexts
```
public PutIntentRequest withInputContexts(Collection<InputContext> 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getOutputContexts
```
public List<OutputContext> getOutputContexts()
```
    An array of OutputContext objects that lists the contexts that the intent activates when the intent is fulfilled.
    
    Returns:
    
    An array of OutputContext objects that lists the contexts that the intent activates when the intent is fulfilled.
  - setOutputContexts
```
public void setOutputContexts(Collection<OutputContext> outputContexts)
```
    An array of OutputContext objects that lists the contexts that the intent activates when the intent is fulfilled.
    
    Parameters:
    
    outputContexts - An array of OutputContext objects that lists the contexts that the intent activates when the intent is fulfilled.
  - withOutputContexts
```
public PutIntentRequest withOutputContexts(OutputContext... outputContexts)
```
    An array of OutputContext objects that lists the contexts that the intent activates when the intent is fulfilled.
    
    NOTE: This method appends the values to the existing list (if any). Use setOutputContexts(java.util.Collection) or withOutputContexts(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    outputContexts - An array of OutputContext objects that lists the contexts that the intent activates when the intent is fulfilled.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withOutputContexts
```
public PutIntentRequest withOutputContexts(Collection<OutputContext> outputContexts)
```
    An array of OutputContext objects that lists the contexts that the intent activates when the intent is fulfilled.
    
    Parameters:
    
    outputContexts - An array of OutputContext objects that lists the contexts that the intent activates when the intent is fulfilled.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public PutIntentRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

AWS SDK for Java 1.x API Reference - 1.12.778

Class PutIntentRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

PutIntentRequest

Method Detail

setName

getName

withName

setDescription

getDescription

withDescription

getSlots

setSlots

withSlots

withSlots

getSampleUtterances

setSampleUtterances

withSampleUtterances

withSampleUtterances

setConfirmationPrompt

getConfirmationPrompt

withConfirmationPrompt

setRejectionStatement

getRejectionStatement

withRejectionStatement

setFollowUpPrompt

getFollowUpPrompt

withFollowUpPrompt

setConclusionStatement

getConclusionStatement

withConclusionStatement

setDialogCodeHook

getDialogCodeHook

withDialogCodeHook

setFulfillmentActivity

getFulfillmentActivity

withFulfillmentActivity

setParentIntentSignature

getParentIntentSignature

withParentIntentSignature

setChecksum

getChecksum

withChecksum

setCreateVersion

getCreateVersion

withCreateVersion

isCreateVersion

setKendraConfiguration

getKendraConfiguration

withKendraConfiguration

getInputContexts

setInputContexts

withInputContexts

withInputContexts

getOutputContexts

setOutputContexts

withOutputContexts

withOutputContexts

toString

equals

hashCode

clone