1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. lex
  5. getBot

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.45.0 published on Monday, Dec 22, 2025 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

aws-native.lex.getBot

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.45.0 published on Monday, Dec 22, 2025 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

    Resource Type definition for an Amazon Lex conversational bot performing automated tasks such as ordering a pizza, booking a hotel, and so on.

    Using getBot

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getBot(args: GetBotArgs, opts?: InvokeOptions): Promise<GetBotResult>
function getBotOutput(args: GetBotOutputArgs, opts?: InvokeOptions): Output<GetBotResult>
    def get_bot(id: Optional[str] = None,
            opts: Optional[InvokeOptions] = None) -> GetBotResult
def get_bot_output(id: Optional[pulumi.Input[str]] = None,
            opts: Optional[InvokeOptions] = None) -> Output[GetBotResult]
    func LookupBot(ctx *Context, args *LookupBotArgs, opts ...InvokeOption) (*LookupBotResult, error)
func LookupBotOutput(ctx *Context, args *LookupBotOutputArgs, opts ...InvokeOption) LookupBotResultOutput

    > Note: This function is named LookupBot in the Go SDK.

    public static class GetBot 
{
    public static Task<GetBotResult> InvokeAsync(GetBotArgs args, InvokeOptions? opts = null)
    public static Output<GetBotResult> Invoke(GetBotInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetBotResult> getBot(GetBotArgs args, InvokeOptions options)
public static Output<GetBotResult> getBot(GetBotArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:lex:getBot
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Id string
    The unique identifier of the bot.
    Id string
    The unique identifier of the bot.
    id String
    The unique identifier of the bot.
    id string
    The unique identifier of the bot.
    id str
    The unique identifier of the bot.
    id String
    The unique identifier of the bot.

    getBot Result

    The following output properties are available:

    Arn string
    The Amazon Resource Name (ARN) of the bot.
    BotTags List<Pulumi.AwsNative.Outputs.Tag>
    A list of tags to add to the bot. You can only add tags when you import a bot. You can't use the UpdateBot operation to update tags. To update tags, use the TagResource operation.
    DataPrivacy Pulumi.AwsNative.Lex.Outputs.DataPrivacyProperties
    By default, data stored by Amazon Lex is encrypted. The DataPrivacy structure provides settings that determine how Amazon Lex handles special cases of securing the data for your bot.
    Description string
    The description of the version.
    ErrorLogSettings Pulumi.AwsNative.Lex.Outputs.ErrorLogSettingsProperties
    Id string
    The unique identifier of the bot.
    IdleSessionTtlInSeconds int

    The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.

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

    You can specify between 60 (1 minute) and 86,400 (24 hours) seconds.

    Name string
    The name of the bot locale.
    RoleArn string
    The Amazon Resource Name (ARN) of the IAM role used to build and run the bot.
    Arn string
    The Amazon Resource Name (ARN) of the bot.
    BotTags Tag
    A list of tags to add to the bot. You can only add tags when you import a bot. You can't use the UpdateBot operation to update tags. To update tags, use the TagResource operation.
    DataPrivacy DataPrivacyProperties
    By default, data stored by Amazon Lex is encrypted. The DataPrivacy structure provides settings that determine how Amazon Lex handles special cases of securing the data for your bot.
    Description string
    The description of the version.
    ErrorLogSettings ErrorLogSettingsProperties
    Id string
    The unique identifier of the bot.
    IdleSessionTtlInSeconds int

    The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.

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

    You can specify between 60 (1 minute) and 86,400 (24 hours) seconds.

    Name string
    The name of the bot locale.
    RoleArn string
    The Amazon Resource Name (ARN) of the IAM role used to build and run the bot.
    arn String
    The Amazon Resource Name (ARN) of the bot.
    botTags List<Tag>
    A list of tags to add to the bot. You can only add tags when you import a bot. You can't use the UpdateBot operation to update tags. To update tags, use the TagResource operation.
    dataPrivacy DataPrivacyProperties
    By default, data stored by Amazon Lex is encrypted. The DataPrivacy structure provides settings that determine how Amazon Lex handles special cases of securing the data for your bot.
    description String
    The description of the version.
    errorLogSettings ErrorLogSettingsProperties
    id String
    The unique identifier of the bot.
    idleSessionTtlInSeconds Integer

    The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.

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

    You can specify between 60 (1 minute) and 86,400 (24 hours) seconds.

    name String
    The name of the bot locale.
    roleArn String
    The Amazon Resource Name (ARN) of the IAM role used to build and run the bot.
    arn string
    The Amazon Resource Name (ARN) of the bot.
    botTags Tag[]
    A list of tags to add to the bot. You can only add tags when you import a bot. You can't use the UpdateBot operation to update tags. To update tags, use the TagResource operation.
    dataPrivacy DataPrivacyProperties
    By default, data stored by Amazon Lex is encrypted. The DataPrivacy structure provides settings that determine how Amazon Lex handles special cases of securing the data for your bot.
    description string
    The description of the version.
    errorLogSettings ErrorLogSettingsProperties
    id string
    The unique identifier of the bot.
    idleSessionTtlInSeconds number

    The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.

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

    You can specify between 60 (1 minute) and 86,400 (24 hours) seconds.

    name string
    The name of the bot locale.
    roleArn string
    The Amazon Resource Name (ARN) of the IAM role used to build and run the bot.
    arn str
    The Amazon Resource Name (ARN) of the bot.
    bot_tags Sequence[root_Tag]
    A list of tags to add to the bot. You can only add tags when you import a bot. You can't use the UpdateBot operation to update tags. To update tags, use the TagResource operation.
    data_privacy DataPrivacyProperties
    By default, data stored by Amazon Lex is encrypted. The DataPrivacy structure provides settings that determine how Amazon Lex handles special cases of securing the data for your bot.
    description str
    The description of the version.
    error_log_settings ErrorLogSettingsProperties
    id str
    The unique identifier of the bot.
    idle_session_ttl_in_seconds int

    The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.

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

    You can specify between 60 (1 minute) and 86,400 (24 hours) seconds.

    name str
    The name of the bot locale.
    role_arn str
    The Amazon Resource Name (ARN) of the IAM role used to build and run the bot.
    arn String
    The Amazon Resource Name (ARN) of the bot.
    botTags List<Property Map>
    A list of tags to add to the bot. You can only add tags when you import a bot. You can't use the UpdateBot operation to update tags. To update tags, use the TagResource operation.
    dataPrivacy Property Map
    By default, data stored by Amazon Lex is encrypted. The DataPrivacy structure provides settings that determine how Amazon Lex handles special cases of securing the data for your bot.
    description String
    The description of the version.
    errorLogSettings Property Map
    id String
    The unique identifier of the bot.
    idleSessionTtlInSeconds Number

    The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.

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

    You can specify between 60 (1 minute) and 86,400 (24 hours) seconds.

    name String
    The name of the bot locale.
    roleArn String
    The Amazon Resource Name (ARN) of the IAM role used to build and run the bot.

    Supporting Types

    DataPrivacyProperties

    ChildDirected bool
    For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying true or false in the childDirected field. By specifying true in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ .
    ChildDirected bool
    For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying true or false in the childDirected field. By specifying true in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ .
    childDirected Boolean
    For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying true or false in the childDirected field. By specifying true in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ .
    childDirected boolean
    For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying true or false in the childDirected field. By specifying true in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ .
    child_directed bool
    For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying true or false in the childDirected field. By specifying true in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ .
    childDirected Boolean
    For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying true or false in the childDirected field. By specifying true in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ .

    ErrorLogSettingsProperties

    Enabled bool
    Enabled bool
    enabled Boolean
    enabled boolean
    enabled bool
    enabled Boolean

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.45.0 published on Monday, Dec 22, 2025 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws-native
      Meet Neo: Your AI Platform Teammate