Package com.pulumi.aws.lex.inputs

Class BotState

  • public final class BotState
extends com.pulumi.resources.ResourceArgs

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  BotState.Builder  

      • Nested classes/interfaces inherited from class com.pulumi.resources.InputArgs

        com.pulumi.resources.InputArgs.InputArgsInternal

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static BotState Empty  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.Optional<com.pulumi.core.Output<BotAbortStatementArgs>> abortStatement()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> arn()  
      static BotState.Builder builder()  
      static BotState.Builder builder​(BotState defaults)  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> checksum()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> childDirected()  
      java.util.Optional<com.pulumi.core.Output<BotClarificationPromptArgs>> clarificationPrompt()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> createdDate()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> createVersion()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> description()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> detectSentiment()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> enableModelImprovements()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> failureReason()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> idleSessionTtlInSeconds()  
      java.util.Optional<com.pulumi.core.Output<java.util.List<BotIntentArgs>>> intents()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> lastUpdatedDate()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> locale()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> name()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Double>> nluIntentConfidenceThreshold()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> processBehavior()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> region()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> status()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> version()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> voiceId()  

      • Methods inherited from class com.pulumi.resources.ResourceArgs

        validateMember

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • Empty

        public static final BotState Empty

    • Method Detail

      • abortStatement

        public java.util.Optional<com.pulumi.core.Output<BotAbortStatementArgs>> abortStatement()
        Returns:
        The message that Amazon Lex uses to abort a conversation. Attributes are documented under statement.

      • arn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> arn()

      • checksum

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> checksum()
        Returns:
        Checksum identifying the version of the bot that was created. The checksum is not included as an argument because the resource will add it automatically when updating the bot.

      • childDirected

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> childDirected()
        Returns:
        By specifying true, 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. For more information see the [Amazon Lex FAQ](https://aws.amazon.com/lex/faqs#data-security) and the [Amazon Lex PutBot API Docs](https://docs.aws.amazon.com/lex/latest/dg/API_PutBot.html#lex-PutBot-request-childDirected).

      • clarificationPrompt

        public java.util.Optional<com.pulumi.core.Output<BotClarificationPromptArgs>> clarificationPrompt()
        Returns:
        The message that Amazon Lex uses when it doesn't understand the user's request. Attributes are documented under prompt.

      • createVersion

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> createVersion()
        Returns:
        Determines if a new bot version is created when the initial resource is created and on each update. Defaults to `false`.

      • createdDate

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> createdDate()
        Returns:
        The date when the bot version was created.

      • description

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> description()
        Returns:
        A description of the bot. Must be less than or equal to 200 characters in length.

      • detectSentiment

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> detectSentiment()
        Returns:
        When set to true user utterances are sent to Amazon Comprehend for sentiment analysis. If you don't specify detectSentiment, the default is `false`.

      • enableModelImprovements

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> enableModelImprovements()
        Returns:
        Set to `true` to enable access to natural language understanding improvements. When you set the `enableModelImprovements` parameter to true you can use the `nluIntentConfidenceThreshold` parameter to configure confidence scores. For more information, see [Confidence Scores](https://docs.aws.amazon.com/lex/latest/dg/confidence-scores.html). You can only set the `enableModelImprovements` parameter in certain Regions. If you set the parameter to true, your bot has access to accuracy improvements. For more information see the [Amazon Lex Bot PutBot API Docs](https://docs.aws.amazon.com/lex/latest/dg/API_PutBot.html#lex-PutBot-request-enableModelImprovements).

      • failureReason

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> failureReason()
        Returns:
        If status is FAILED, Amazon Lex provides the reason that it failed to build the bot.

      • idleSessionTtlInSeconds

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> idleSessionTtlInSeconds()
        Returns:
        The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. Default is `300`. Must be a number between 60 and 86400 (inclusive).

      • intents

        public java.util.Optional<com.pulumi.core.Output<java.util.List<BotIntentArgs>>> intents()
        Returns:
        A set of Intent objects. Each intent represents a command that a user can express. Attributes are documented under intent. Can have up to 250 Intent objects.

      • lastUpdatedDate

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> lastUpdatedDate()
        Returns:
        The date when the $LATEST version of this bot was updated.

      • locale

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> locale()
        Returns:
        Specifies the target locale for the bot. Any intent used in the bot must be compatible with the locale of the bot. For available locales, see [Amazon Lex Bot PutBot API Docs](https://docs.aws.amazon.com/lex/latest/dg/API_PutBot.html#lex-PutBot-request-locale). Default is `en-US`.

      • name

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> name()
        Returns:
        The name of the bot that you want to create, case sensitive. Must be between 2 and 50 characters in length.

      • nluIntentConfidenceThreshold

        public java.util.Optional<com.pulumi.core.Output<java.lang.Double>> nluIntentConfidenceThreshold()
        Returns:
        Determines the threshold where Amazon Lex will insert the AMAZON.FallbackIntent, AMAZON.KendraSearchIntent, or both when returning alternative intents in a PostContent or PostText response. AMAZON.FallbackIntent and AMAZON.KendraSearchIntent are only inserted if they are configured for the bot. For more information see [Amazon Lex Bot PutBot API Docs](https://docs.aws.amazon.com/lex/latest/dg/API_PutBot.html#lex-PutBot-request-nluIntentConfidenceThreshold) This value requires `enableModelImprovements` to be set to `true` and the default is `0`. Must be a float between 0 and 1.

      • processBehavior

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> processBehavior()
        Returns:
        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. Default is `SAVE`.

      • region

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • status

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> status()
        Returns:
        When you send a request to create or update a bot, Amazon Lex sets the status response element to BUILDING. After Amazon Lex builds the bot, it sets status to READY. If Amazon Lex can't build the bot, it sets status to FAILED. Amazon Lex returns the reason for the failure in the failureReason response element.

      • version

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> version()
        Returns:
        The version of the bot.

      • voiceId

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> voiceId()
        Returns:
        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](http://docs.aws.amazon.com/polly/latest/dg/voicelist.html) in the Amazon Polly Developer Guide.