bot_replicas

Creates, updates, deletes, gets or lists a bot_replicas resource.

Overview

Name	bot_replicas
Type	Resource
Id	aws.lexv2_models.bot_replicas

Fields

The following fields are returned by SELECT queries:

describe_bot_replica

Name	Datatype	Description
bot_id	string	The unique bot ID of the replicated bot being monitored. (pattern: <code>^[0-9a-zA-Z]+$</code>)
bot_replica_status	string	The operational status of the replicated bot being monitored. (Enabling, Enabled, Deleting, Failed)
creation_date_time	string (date-time)	The creation date and time of the replicated bot being monitored.
failure_reasons	array	The failure reasons the bot being monitored failed to replicate.
replica_region	string	The region that contains the replicated bots. Minimum value = 2, maximum value = 25.
source_region	string	The region that contains the replicated bots. Minimum value = 2, maximum value = 25.

list_bot_replicas

Name	Datatype	Description
bot_id	string	the unique bot IDs in the list of replicated bots. (pattern: <code>^[0-9a-zA-Z]+$</code>)
bot_replica_summaries	array	The summary details for the replicated bots.
source_region	string	The region that contains the replicated bots. Minimum value = 2, maximum value = 25.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_bot_replica	select	bot_id, replica_region, region		Monitors the bot replication status through the UI console.
list_bot_replicas	select	bot_id, region		The action to list the replicated bots.
create_bot_replica	insert	bot_id, region, replicaRegion		Action to create a replication of the source bot in the secondary region.
delete_bot_replica	delete	bot_id, replica_region, region		The action to delete the replicated bot in the secondary region.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
bot_id	string	The unique ID of the replicated bot to be deleted from the secondary region
region	string	AWS region (default: us-east-1)
replica_region	string	The secondary region of the replicated bot that will be deleted.

SELECT examples

describe_bot_replica

Monitors the bot replication status through the UI console.

SELECT
bot_id,
bot_replica_status,
creation_date_time,
failure_reasons,
replica_region,
source_region
FROM aws.lexv2_models.bot_replicas
WHERE bot_id = '{{ bot_id }}' -- required
AND replica_region = '{{ replica_region }}' -- required
AND region = '{{ region }}' -- required
;

list_bot_replicas

The action to list the replicated bots.

SELECT
bot_id,
bot_replica_summaries,
source_region
FROM aws.lexv2_models.bot_replicas
WHERE bot_id = '{{ bot_id }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples

create_bot_replica

Action to create a replication of the source bot in the secondary region.

INSERT INTO aws.lexv2_models.bot_replicas (
replicaRegion,
bot_id,
region
)
SELECT 
'{{ replicaRegion }}' /* required */,
'{{ bot_id }}',
'{{ region }}'
RETURNING
bot_id,
bot_replica_status,
creation_date_time,
replica_region,
source_region
;

Manifest

# Description fields are for documentation purposes
- name: bot_replicas
props:
  - name: bot_id
    value: "{{ bot_id }}"
    description: Required parameter for the bot_replicas resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the bot_replicas resource.
  - name: replicaRegion
    value: "{{ replicaRegion }}"
    description: |
      The region that contains the replicated bots. Minimum value = 2, maximum value = 25.

DELETE examples

delete_bot_replica

The action to delete the replicated bot in the secondary region.

DELETE FROM aws.lexv2_models.bot_replicas
WHERE bot_id = '{{ bot_id }}' --required
AND replica_region = '{{ replica_region }}' --required
AND region = '{{ region }}' --required
;