app_instance_users

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

Overview

Name	app_instance_users
Type	Resource
Id	aws.chime_sdk_identity.app_instance_users

Fields

The following fields are returned by SELECT queries:

list_app_instance_users

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_users	array	The information for each requested AppInstanceUser.
next_token	string	The token passed by previous API calls until all requested users are returned. (pattern: <code>.*</code>)

describe_app_instance_user

Name	Datatype	Description
app_instance_user_arn	string	The ARN of the AppInstanceUser. (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 the AppInstanceUser was created.
expiration_settings	object	Determines the interval after which an AppInstanceUser is automatically deleted.
last_updated_timestamp	string (date-time)	The time at which the AppInstanceUser was last updated.
metadata	string	The metadata of the AppInstanceUser. (pattern: <code>.*</code>)
name	string	The name of the AppInstanceUser. (pattern: <code>.\S.</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_app_instance_users	select	app-instance-arn, region	max-results, next-token	List all AppInstanceUsers created under a single AppInstance.
describe_app_instance_user	select	app_instance_user_arn, region		Returns the full details of an AppInstanceUser.
create_app_instance_user	insert	region, AppInstanceArn, AppInstanceUserId, Name, ClientRequestToken		Creates a user under an Amazon Chime AppInstance. The request consists of a unique appInstanceUserId and Name for that user.
update_app_instance_user	update	app_instance_user_arn, region, Name, Metadata		Updates the details of an AppInstanceUser. You can update names and metadata.
put_app_instance_user_expiration_settings	replace	app_instance_user_arn, region		Sets the number of days before the AppInstanceUser is automatically deleted. A background process deletes expired AppInstanceUsers within 6 hours of expiration. Actual deletion times may vary. Expired AppInstanceUsers that have not yet been deleted appear as active, and you can update their expiration settings. The system honors the new settings.
delete_app_instance_user	delete	app_instance_user_arn, region		Deletes an AppInstanceUser.

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_user_arn	string	The ARN of the user request being deleted.
region	string	AWS region (default: us-east-1)
max-results	integer	The maximum number of requests that you want returned.
next-token	string	The token passed by previous API calls until all requested users are returned.

SELECT examples

list_app_instance_users

List all AppInstanceUsers created under a single AppInstance.

SELECT
app_instance_arn,
app_instance_users,
next_token
FROM aws.chime_sdk_identity.app_instance_users
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_user

Returns the full details of an AppInstanceUser.

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

INSERT examples

create_app_instance_user

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

INSERT INTO aws.chime_sdk_identity.app_instance_users (
AppInstanceArn,
AppInstanceUserId,
Name,
Metadata,
ClientRequestToken,
Tags,
ExpirationSettings,
region
)
SELECT 
'{{ AppInstanceArn }}' /* required */,
'{{ AppInstanceUserId }}' /* required */,
'{{ Name }}' /* required */,
'{{ Metadata }}',
'{{ ClientRequestToken }}' /* required */,
'{{ Tags }}',
'{{ ExpirationSettings }}',
'{{ region }}'
RETURNING
app_instance_user_arn
;

Manifest

# Description fields are for documentation purposes
- name: app_instance_users
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the app_instance_users resource.
  - name: AppInstanceArn
    value: "{{ AppInstanceArn }}"
  - name: AppInstanceUserId
    value: "{{ AppInstanceUserId }}"
  - name: Name
    value: "{{ Name }}"
  - name: Metadata
    value: "{{ Metadata }}"
  - name: ClientRequestToken
    value: "{{ ClientRequestToken }}"
  - name: Tags
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: ExpirationSettings
    description: |
      Determines the interval after which an AppInstanceUser is automatically deleted.
    value:
      ExpirationDays: {{ ExpirationDays }}
      ExpirationCriterion: "{{ ExpirationCriterion }}"

UPDATE examples

update_app_instance_user

Updates the details of an AppInstanceUser. You can update names and metadata.

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

REPLACE examples

put_app_instance_user_expiration_settings

Sets the number of days before the AppInstanceUser is automatically deleted. A background process deletes expired AppInstanceUsers within 6 hours of expiration. Actual deletion times may vary. Expired AppInstanceUsers that have not yet been deleted appear as active, and you can update their expiration settings. The system honors the new settings.

REPLACE aws.chime_sdk_identity.app_instance_users
SET 
ExpirationSettings = '{{ ExpirationSettings }}'
WHERE 
app_instance_user_arn = '{{ app_instance_user_arn }}' --required
AND region = '{{ region }}' --required
RETURNING
app_instance_user_arn,
expiration_settings;

DELETE examples

delete_app_instance_user

Deletes an AppInstanceUser.

DELETE FROM aws.chime_sdk_identity.app_instance_users
WHERE app_instance_user_arn = '{{ app_instance_user_arn }}' --required
AND region = '{{ region }}' --required
;