app_instances

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

Overview

Name	app_instances
Type	Resource
Id	aws.chime_sdk_identity.app_instances

Fields

The following fields are returned by SELECT queries:

describe_app_instance

Name	Datatype	Description
app_instance_arn	string	The ARN of the messaging instance. (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>)
created_timestamp	string (date-time)	The time at which an AppInstance was created. In epoch milliseconds.
last_updated_timestamp	string (date-time)	The time an AppInstance was last updated. In epoch milliseconds.
metadata	string	The metadata of an AppInstance. (pattern: <code>.*</code>)
name	string	The name of an AppInstance. (pattern: <code>[\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]*</code>)

list_app_instances

Name	Datatype	Description
app_instances	array	The information for each AppInstance.
next_token	string	The token passed by previous API requests until the maximum number of AppInstances is reached. (pattern: <code>.*</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_app_instance	select	app_instance_arn, region		Returns the full details of an AppInstance.
list_app_instances	select	region	max-results, next-token	Lists all Amazon Chime AppInstances created under a single AWS account.
create_app_instance	insert	region, Name, ClientRequestToken		Creates an Amazon Chime SDK messaging AppInstance under an AWS account. Only SDK messaging customers use this API. CreateAppInstance supports idempotency behavior as described in the AWS API Standard. identity
update_app_instance	update	app_instance_arn, region, Name, Metadata		Updates AppInstance metadata.
delete_app_instance	delete	app_instance_arn, region		Deletes an AppInstance and all associated data asynchronously.

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.
region	string	AWS region (default: us-east-1)
max-results	integer	The maximum number of AppInstances that you want to return.
next-token	string	The token passed by previous API requests until you reach the maximum number of AppInstances.

SELECT examples

describe_app_instance

Returns the full details of an AppInstance.

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

list_app_instances

Lists all Amazon Chime AppInstances created under a single AWS account.

SELECT
app_instances,
next_token
FROM aws.chime_sdk_identity.app_instances
WHERE region = '{{ region }}' -- required
AND `max-results` = '{{ max-results }}'
AND `next-token` = '{{ next-token }}'
;

INSERT examples

create_app_instance

Creates an Amazon Chime SDK messaging AppInstance under an AWS account. Only SDK messaging customers use this API. CreateAppInstance supports idempotency behavior as described in the AWS API Standard. identity

INSERT INTO aws.chime_sdk_identity.app_instances (
Name,
Metadata,
ClientRequestToken,
Tags,
region
)
SELECT 
'{{ Name }}' /* required */,
'{{ Metadata }}',
'{{ ClientRequestToken }}' /* required */,
'{{ Tags }}',
'{{ region }}'
RETURNING
app_instance_arn
;

Manifest

# Description fields are for documentation purposes
- name: app_instances
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the app_instances resource.
  - name: Name
    value: "{{ Name }}"
  - name: Metadata
    value: "{{ Metadata }}"
  - name: ClientRequestToken
    value: "{{ ClientRequestToken }}"
  - name: Tags
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

UPDATE examples

update_app_instance

Updates AppInstance metadata.

UPDATE aws.chime_sdk_identity.app_instances
SET 
Name = '{{ Name }}',
Metadata = '{{ Metadata }}'
WHERE 
app_instance_arn = '{{ app_instance_arn }}' --required
AND region = '{{ region }}' --required
AND Name = '{{ Name }}' --required
AND Metadata = '{{ Metadata }}' --required
RETURNING
app_instance_arn;

DELETE examples

delete_app_instance

Deletes an AppInstance and all associated data asynchronously.

DELETE FROM aws.chime_sdk_identity.app_instances
WHERE app_instance_arn = '{{ app_instance_arn }}' --required
AND region = '{{ region }}' --required
;