bots

Creates, updates, deletes or gets a bot resource or lists bots in a region

Overview

Name	bots
Type	Resource
Description	Amazon Lex conversational bot performing automated tasks such as ordering a pizza, booking a hotel, and so on.
Id	awscc.lex.bots

Fields

get (all properties)

Name	Datatype	Description
id	string	Unique ID of resource
arn	string
name	string	A unique identifier for a resource.
description	string	A description of the version. Use the description to help identify the version in lists.
role_arn	string
▶data_privacy	object
▶error_log_settings	object
idle_session_ttl_in_seconds	integer
▶bot_locales	array
▶bot_file_s3_location	object
▶bot_tags	array
test_bot_alias_tags	array
auto_build_bot_locales	boolean
▶test_bot_alias_settings	object
▶replication	object
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
id	string	Unique ID of resource
region	string	AWS region.

For more information, see AWS::Lex::Bot.

Methods

Name	Resource	Accessible by	Required Params
create_resource	bots	INSERT	Name, RoleArn, DataPrivacy, IdleSessionTTLInSeconds, region
delete_resource	bots	DELETE	Identifier, region
update_resource	bots	UPDATE	Identifier, PatchDocument, region
list_resources	bots_list_only	SELECT	region
get_resource	bots	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual bot.

SELECT
  region,
  id,
  arn,
  name,
  description,
  role_arn,
  data_privacy,
  error_log_settings,
  idle_session_ttl_in_seconds,
  bot_locales,
  bot_file_s3_location,
  bot_tags,
  test_bot_alias_tags,
  auto_build_bot_locales,
  test_bot_alias_settings,
  replication
FROM awscc.lex.bots
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}';

list (identifiers only)

Lists all bots in a region.

SELECT
  region,
  id
FROM awscc.lex.bots_list_only
WHERE
  region = '{{ region }}';

INSERT example

Use the following StackQL query and manifest file to create a new bot resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.lex.bots (
  Name,
  RoleArn,
  DataPrivacy,
  IdleSessionTTLInSeconds,
  region
)
SELECT
  '{{ name }}',
  '{{ role_arn }}',
  '{{ data_privacy }}',
  '{{ idle_session_ttl_in_seconds }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.lex.bots (
  Name,
  Description,
  RoleArn,
  DataPrivacy,
  ErrorLogSettings,
  IdleSessionTTLInSeconds,
  BotLocales,
  BotFileS3Location,
  BotTags,
  TestBotAliasTags,
  AutoBuildBotLocales,
  TestBotAliasSettings,
  Replication,
  region
)
SELECT
  '{{ name }}',
  '{{ description }}',
  '{{ role_arn }}',
  '{{ data_privacy }}',
  '{{ error_log_settings }}',
  '{{ idle_session_ttl_in_seconds }}',
  '{{ bot_locales }}',
  '{{ bot_file_s3_location }}',
  '{{ bot_tags }}',
  '{{ test_bot_alias_tags }}',
  '{{ auto_build_bot_locales }}',
  '{{ test_bot_alias_settings }}',
  '{{ replication }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: bot
  props:
    - name: name
      value: '{{ name }}'
    - name: description
      value: '{{ description }}'
    - name: role_arn
      value: '{{ role_arn }}'
    - name: data_privacy
      value:
        child_directed: '{{ child_directed }}'
    - name: error_log_settings
      value:
        enabled: '{{ enabled }}'
    - name: idle_session_ttl_in_seconds
      value: '{{ idle_session_ttl_in_seconds }}'
    - name: bot_locales
      value:
        - locale_id: '{{ locale_id }}'
          description: null
          voice_settings:
            voice_id: '{{ voice_id }}'
            engine: '{{ engine }}'
          generative_ai_settings:
            buildtime_settings:
              descriptive_bot_builder_specification:
                enabled: '{{ enabled }}'
                bedrock_model_specification:
                  model_arn: '{{ model_arn }}'
                  bedrock_guardrail_configuration:
                    bedrock_guardrail_identifier: '{{ bedrock_guardrail_identifier }}'
                    bedrock_guardrail_version: '{{ bedrock_guardrail_version }}'
                  bedrock_trace_status: '{{ bedrock_trace_status }}'
                  bedrock_model_custom_prompt: '{{ bedrock_model_custom_prompt }}'
              sample_utterance_generation_specification:
                enabled: '{{ enabled }}'
                bedrock_model_specification: null
            runtime_settings:
              nlu_improvement_specification:
                enabled: '{{ enabled }}'
              slot_resolution_improvement_specification:
                enabled: '{{ enabled }}'
                bedrock_model_specification: null
          nlu_confidence_threshold: null
          intents:
            - name: null
              description: null
              parent_intent_signature: '{{ parent_intent_signature }}'
              sample_utterances:
                - utterance: '{{ utterance }}'
              dialog_code_hook:
                enabled: '{{ enabled }}'
              fulfillment_code_hook:
                fulfillment_updates_specification:
                  start_response:
                    message_groups:
                      - message:
                          plain_text_message:
                            value: '{{ value }}'
                          custom_payload:
                            value: '{{ value }}'
                          ssm_lmessage:
                            value: '{{ value }}'
                          image_response_card:
                            title: '{{ title }}'
                            subtitle: null
                            image_url: '{{ image_url }}'
                            buttons:
                              - text: '{{ text }}'
                                value: '{{ value }}'
                        variations:
                          - null
                    delay_in_seconds: '{{ delay_in_seconds }}'
                    allow_interrupt: '{{ allow_interrupt }}'
                  update_response:
                    message_groups: null
                    frequency_in_seconds: '{{ frequency_in_seconds }}'
                    allow_interrupt: '{{ allow_interrupt }}'
                  timeout_in_seconds: '{{ timeout_in_seconds }}'
                  active: '{{ active }}'
                post_fulfillment_status_specification:
                  success_response:
                    message_groups_list: null
                    allow_interrupt: '{{ allow_interrupt }}'
                  success_next_step:
                    dialog_action:
                      type: '{{ type }}'
                      slot_to_elicit: null
                      suppress_next_message: '{{ suppress_next_message }}'
                    intent:
                      name: null
                      slots:
                        - slot_name: null
                          slot_value_override:
                            shape: '{{ shape }}'
                            value:
                              interpreted_value: '{{ interpreted_value }}'
                            values:
                              - null
                    session_attributes:
                      - key: '{{ key }}'
                        value: '{{ value }}'
                  success_conditional:
                    is_active: '{{ is_active }}'
                    conditional_branches:
                      - name: null
                        condition:
                          expression_string: '{{ expression_string }}'
                        next_step: null
                        response: null
                    default_branch:
                      next_step: null
                      response: null
                  failure_response: null
                  failure_next_step: null
                  failure_conditional: null
                  timeout_response: null
                  timeout_next_step: null
                  timeout_conditional: null
                enabled: '{{ enabled }}'
                is_active: '{{ is_active }}'
              intent_confirmation_setting:
                prompt_specification:
                  message_groups_list: null
                  max_retries: '{{ max_retries }}'
                  allow_interrupt: '{{ allow_interrupt }}'
                  message_selection_strategy: '{{ message_selection_strategy }}'
                  prompt_attempts_specification: {}
                is_active: '{{ is_active }}'
                confirmation_response: null
                confirmation_next_step: null
                confirmation_conditional: null
                declination_response: null
                declination_next_step: null
                declination_conditional: null
                failure_response: null
                failure_next_step: null
                failure_conditional: null
                code_hook:
                  enable_code_hook_invocation: '{{ enable_code_hook_invocation }}'
                  is_active: '{{ is_active }}'
                  invocation_label: null
                  post_code_hook_specification:
                    success_response: null
                    success_next_step: null
                    success_conditional: null
                    failure_response: null
                    failure_next_step: null
                    failure_conditional: null
                    timeout_response: null
                    timeout_next_step: null
                    timeout_conditional: null
                elicitation_code_hook:
                  enable_code_hook_invocation: '{{ enable_code_hook_invocation }}'
                  invocation_label: null
              intent_closing_setting:
                closing_response: null
                is_active: '{{ is_active }}'
                conditional: null
                next_step: null
              initial_response_setting:
                initial_response: null
                next_step: null
                conditional: null
                code_hook: null
              input_contexts:
                - name: null
              output_contexts:
                - name: null
                  time_to_live_in_seconds: '{{ time_to_live_in_seconds }}'
                  turns_to_live: '{{ turns_to_live }}'
              kendra_configuration:
                kendra_index: '{{ kendra_index }}'
                query_filter_string_enabled: '{{ query_filter_string_enabled }}'
                query_filter_string: '{{ query_filter_string }}'
              qn_aintent_configuration:
                data_source_configuration:
                  opensearch_configuration:
                    domain_endpoint: '{{ domain_endpoint }}'
                    index_name: '{{ index_name }}'
                    include_fields:
                      - '{{ include_fields[0] }}'
                    exact_response: '{{ exact_response }}'
                    exact_response_fields:
                      question_field: '{{ question_field }}'
                      answer_field: '{{ answer_field }}'
                  bedrock_knowledge_store_configuration:
                    bedrock_knowledge_base_arn: '{{ bedrock_knowledge_base_arn }}'
                    exact_response: '{{ exact_response }}'
                    b_kb_exact_response_fields:
                      answer_field: '{{ answer_field }}'
                  kendra_configuration:
                    kendra_index: '{{ kendra_index }}'
                    query_filter_string: '{{ query_filter_string }}'
                    query_filter_string_enabled: '{{ query_filter_string_enabled }}'
                    exact_response: '{{ exact_response }}'
                bedrock_model_configuration: null
              q_in_connect_intent_configuration:
                q_in_connect_assistant_configuration:
                  assistant_arn: '{{ assistant_arn }}'
              bedrock_agent_intent_configuration:
                bedrock_agent_configuration:
                  bedrock_agent_id: '{{ bedrock_agent_id }}'
                  bedrock_agent_alias_id: '{{ bedrock_agent_alias_id }}'
                bedrock_agent_intent_knowledge_base_configuration:
                  bedrock_knowledge_base_arn: '{{ bedrock_knowledge_base_arn }}'
                  bedrock_model_configuration: null
              slot_priorities:
                - priority: '{{ priority }}'
                  slot_name: null
              slots:
                - name: null
                  description: null
                  slot_type_name: '{{ slot_type_name }}'
                  value_elicitation_setting:
                    default_value_specification:
                      default_value_list:
                        - default_value: '{{ default_value }}'
                    slot_constraint: '{{ slot_constraint }}'
                    prompt_specification: null
                    sample_utterances: null
                    wait_and_continue_specification:
                      waiting_response: null
                      continue_response: null
                      still_waiting_response:
                        message_groups_list: null
                        frequency_in_seconds: '{{ frequency_in_seconds }}'
                        timeout_in_seconds: '{{ timeout_in_seconds }}'
                        allow_interrupt: '{{ allow_interrupt }}'
                      is_active: '{{ is_active }}'
                    slot_capture_setting:
                      capture_response: null
                      capture_next_step: null
                      capture_conditional: null
                      failure_response: null
                      failure_next_step: null
                      failure_conditional: null
                      code_hook: null
                      elicitation_code_hook: null
                  obfuscation_setting:
                    obfuscation_setting_type: '{{ obfuscation_setting_type }}'
                  multiple_values_setting:
                    allow_multiple_values: '{{ allow_multiple_values }}'
                  sub_slot_setting:
                    expression: '{{ expression }}'
                    slot_specifications: {}
          slot_types:
            - name: null
              description: null
              parent_slot_type_signature: '{{ parent_slot_type_signature }}'
              slot_type_values:
                - sample_value:
                    value: '{{ value }}'
                  synonyms:
                    - null
              value_selection_setting:
                resolution_strategy: '{{ resolution_strategy }}'
                regex_filter:
                  pattern: '{{ pattern }}'
                advanced_recognition_setting:
                  audio_recognition_strategy: '{{ audio_recognition_strategy }}'
              external_source_setting:
                grammar_slot_type_setting:
                  source:
                    s3_bucket_name: '{{ s3_bucket_name }}'
                    s3_object_key: '{{ s3_object_key }}'
                    kms_key_arn: '{{ kms_key_arn }}'
              composite_slot_type_setting:
                sub_slots:
                  - name: '{{ name }}'
                    slot_type_id: '{{ slot_type_id }}'
          custom_vocabulary:
            custom_vocabulary_items:
              - phrase: '{{ phrase }}'
                weight: '{{ weight }}'
                display_as: '{{ display_as }}'
    - name: bot_file_s3_location
      value:
        s3_bucket: null
        s3_object_key: null
        s3_object_version: '{{ s3_object_version }}'
    - name: bot_tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'
    - name: test_bot_alias_tags
      value:
        - null
    - name: auto_build_bot_locales
      value: '{{ auto_build_bot_locales }}'
    - name: test_bot_alias_settings
      value:
        bot_alias_locale_settings:
          - locale_id: '{{ locale_id }}'
            bot_alias_locale_setting:
              code_hook_specification:
                lambda_code_hook:
                  code_hook_interface_version: '{{ code_hook_interface_version }}'
                  lambda_arn: '{{ lambda_arn }}'
              enabled: '{{ enabled }}'
        conversation_log_settings:
          audio_log_settings:
            - destination:
                s3_bucket:
                  s3_bucket_arn: '{{ s3_bucket_arn }}'
                  log_prefix: '{{ log_prefix }}'
                  kms_key_arn: '{{ kms_key_arn }}'
              enabled: '{{ enabled }}'
          text_log_settings:
            - destination:
                cloud_watch:
                  cloud_watch_log_group_arn: '{{ cloud_watch_log_group_arn }}'
                  log_prefix: '{{ log_prefix }}'
              enabled: '{{ enabled }}'
        description: null
        sentiment_analysis_settings:
          detect_sentiment: '{{ detect_sentiment }}'
    - name: replication
      value:
        replica_regions:
          - '{{ replica_regions[0] }}'

UPDATE example

Use the following StackQL query and manifest file to update a bot resource, using stack-deploy.

/*+ update */
UPDATE awscc.lex.bots
SET PatchDocument = string('{{ {
    "Name": name,
    "Description": description,
    "RoleArn": role_arn,
    "DataPrivacy": data_privacy,
    "ErrorLogSettings": error_log_settings,
    "IdleSessionTTLInSeconds": idle_session_ttl_in_seconds,
    "BotLocales": bot_locales,
    "BotFileS3Location": bot_file_s3_location,
    "BotTags": bot_tags,
    "TestBotAliasTags": test_bot_alias_tags,
    "AutoBuildBotLocales": auto_build_bot_locales,
    "TestBotAliasSettings": test_bot_alias_settings,
    "Replication": replication
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.lex.bots
WHERE
  Identifier = '{{ id }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

To operate on the bots resource, the following permissions are required:

Create

iam:PassRole,
lex:DescribeBot,
lex:CreateUploadUrl,
lex:StartImport,
lex:DescribeImport,
lex:ListTagsForResource,
lex:TagResource,
lex:CreateBot,
lex:CreateBotLocale,
lex:CreateIntent,
lex:CreateSlot,
lex:CreateSlotType,
lex:UpdateBot,
lex:UpdateBotLocale,
lex:UpdateIntent,
lex:UpdateSlot,
lex:UpdateSlotType,
lex:DeleteBotLocale,
lex:DeleteIntent,
lex:DeleteSlot,
lex:DeleteSlotType,
lex:DescribeBotLocale,
lex:BuildBotLocale,
lex:ListBots,
lex:ListBotLocales,
lex:CreateCustomVocabulary,
lex:UpdateCustomVocabulary,
lex:DeleteCustomVocabulary,
s3:GetObject,
lex:UpdateBotAlias,
iam:CreateServiceLinkedRole,
iam:GetRole,
lex:CreateBotReplica,
lex:DescribeBotReplica,
lex:DeleteBotReplica

Read

lex:DescribeBot,
lex:ListTagsForResource,
lex:DescribeBotReplica

Update

iam:PassRole,
lex:DescribeBot,
lex:CreateUploadUrl,
lex:StartImport,
lex:DescribeImport,
lex:ListTagsForResource,
lex:TagResource,
lex:UntagResource,
lex:CreateBot,
lex:CreateBotLocale,
lex:CreateIntent,
lex:CreateSlot,
lex:CreateSlotType,
lex:UpdateBot,
lex:UpdateBotLocale,
lex:UpdateIntent,
lex:UpdateSlot,
lex:UpdateSlotType,
lex:DeleteBotLocale,
lex:DeleteIntent,
lex:DeleteSlot,
lex:DeleteSlotType,
lex:DescribeBotLocale,
lex:BuildBotLocale,
lex:ListBots,
lex:ListBotLocales,
lex:CreateCustomVocabulary,
lex:UpdateCustomVocabulary,
lex:DeleteCustomVocabulary,
s3:GetObject,
lex:UpdateBotAlias,
lex:CreateBotReplica,
lex:DescribeBotReplica,
lex:DeleteBotReplica

Delete

lex:DeleteBot,
lex:DescribeBot,
lex:DeleteBotLocale,
lex:DeleteIntent,
lex:DeleteSlotType,
lex:DeleteSlot,
lex:DeleteBotVersion,
lex:DeleteBotChannel,
lex:DeleteBotAlias,
lex:DeleteCustomVocabulary,
lex:DeleteBotReplica

List

lex:ListBots,
lex:ListBotReplicas