app_instance_bots

Creates, updates, deletes, gets or lists an app_instance_bots resource.

Overview

Name	app_instance_bots
Type	Resource
Id	aws.chime_sdk_identity.app_instance_bots

Fields

The following fields are returned by SELECT queries:

list_app_instance_bots

Name	Datatype	Description
app_instance_arn	string	The ARN of the AppInstance. (pattern: <code>arn:[a-z0-9-.]{1,63}:[a-z0-9-.]{0,63}:[a-z0-9-.]{0,63}:[a-z0-9-.]{0,63}:[^/].{0,1023}</code>)
app_instance_bots	array	The information for each requested AppInstanceBot.
next_token	string	The token passed by previous API calls until all requested bots are returned. (pattern: <code>.*</code>)

describe_app_instance_bot

Name	Datatype	Description
app_instance_bot_arn	string	The ARN of the AppInstanceBot. (pattern: <code>arn:[a-z0-9-.]{1,63}:[a-z0-9-.]{0,63}:[a-z0-9-.]{0,63}:[a-z0-9-.]{0,63}:[^/].{0,1023}</code>)
configuration	object	A structure that contains configuration data.
created_timestamp	string (date-time)	The time at which the AppInstanceBot was created.
last_updated_timestamp	string (date-time)	The time at which the AppInstanceBot was last updated.
metadata	string	The metadata for an AppInstanceBot. (pattern: <code>.*</code>)
name	string	The name of the AppInstanceBot. (pattern: <code>[\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]*</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_app_instance_bots	select	app-instance-arn, region	max-results, next-token	Lists all AppInstanceBots created under a single AppInstance.
describe_app_instance_bot	select	app_instance_bot_arn, region		The AppInstanceBot's information.
create_app_instance_bot	insert	region, AppInstanceArn, ClientRequestToken, Configuration		Creates a bot under an Amazon Chime AppInstance. The request consists of a unique Configuration and Name for that bot.
update_app_instance_bot	update	app_instance_bot_arn, region, Name, Metadata		Updates the name and metadata of an AppInstanceBot.
delete_app_instance_bot	delete	app_instance_bot_arn, region		Deletes an AppInstanceBot.

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
app-instance-arn	string	The ARN of the AppInstance.
app_instance_bot_arn	string	The ARN of the AppInstanceBot being deleted.
region	string	AWS region (default: us-east-1)
max-results	integer	The maximum number of requests to return.
next-token	string	The token passed by previous API calls until all requested bots are returned.

SELECT examples

list_app_instance_bots

Lists all AppInstanceBots created under a single AppInstance.

SELECT
app_instance_arn,
app_instance_bots,
next_token
FROM aws.chime_sdk_identity.app_instance_bots
WHERE `app-instance-arn` = '{{ app-instance-arn }}' -- required
AND region = '{{ region }}' -- required
AND `max-results` = '{{ max-results }}'
AND `next-token` = '{{ next-token }}'
;

describe_app_instance_bot

The AppInstanceBot's information.

SELECT
app_instance_bot_arn,
configuration,
created_timestamp,
last_updated_timestamp,
metadata,
name
FROM aws.chime_sdk_identity.app_instance_bots
WHERE app_instance_bot_arn = '{{ app_instance_bot_arn }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples

create_app_instance_bot

Creates a bot under an Amazon Chime AppInstance. The request consists of a unique Configuration and Name for that bot.

INSERT INTO aws.chime_sdk_identity.app_instance_bots (
AppInstanceArn,
Name,
Metadata,
ClientRequestToken,
Tags,
Configuration,
region
)
SELECT 
'{{ AppInstanceArn }}' /* required */,
'{{ Name }}',
'{{ Metadata }}',
'{{ ClientRequestToken }}' /* required */,
'{{ Tags }}',
'{{ Configuration }}' /* required */,
'{{ region }}'
RETURNING
app_instance_bot_arn
;

Manifest

# Description fields are for documentation purposes
- name: app_instance_bots
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the app_instance_bots resource.
  - name: AppInstanceArn
    value: "{{ AppInstanceArn }}"
  - name: Name
    value: "{{ Name }}"
  - name: Metadata
    value: "{{ Metadata }}"
  - name: ClientRequestToken
    value: "{{ ClientRequestToken }}"
  - name: Tags
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: Configuration
    description: |
      A structure that contains configuration data.
    value:
      Lex:
        RespondsTo: "{{ RespondsTo }}"
        InvokedBy:
          StandardMessages: "{{ StandardMessages }}"
          TargetedMessages: "{{ TargetedMessages }}"
        LexBotAliasArn: "{{ LexBotAliasArn }}"
        LocaleId: "{{ LocaleId }}"
        WelcomeIntent: "{{ WelcomeIntent }}"

UPDATE examples

update_app_instance_bot

Updates the name and metadata of an AppInstanceBot.

UPDATE aws.chime_sdk_identity.app_instance_bots
SET 
Name = '{{ Name }}',
Metadata = '{{ Metadata }}',
Configuration = '{{ Configuration }}'
WHERE 
app_instance_bot_arn = '{{ app_instance_bot_arn }}' --required
AND region = '{{ region }}' --required
AND Name = '{{ Name }}' --required
AND Metadata = '{{ Metadata }}' --required
RETURNING
app_instance_bot_arn;

DELETE examples

delete_app_instance_bot

Deletes an AppInstanceBot.

DELETE FROM aws.chime_sdk_identity.app_instance_bots
WHERE app_instance_bot_arn = '{{ app_instance_bot_arn }}' --required
AND region = '{{ region }}' --required
;