app_instance_admins

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

Overview

Name	app_instance_admins
Type	Resource
Id	aws.chime_sdk_identity.app_instance_admins

Fields

The following fields are returned by SELECT queries:

describe_app_instance_admin

Name	Datatype	Description
admin	object	The AppInstanceAdmin data.
app_instance_arn	string	The ARN of the AppInstance for which the user is an administrator. (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 administrator was created.

list_app_instance_admins

Name	Datatype	Description
app_instance_admins	array	The information for each administrator.
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>)
next_token	string	The token returned from previous API requests until the number of administrators 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_admin	select	app_instance_admin_arn, app_instance_arn, region		Returns the full details of an AppInstanceAdmin.
list_app_instance_admins	select	app_instance_arn, region	max-results, next-token	Returns a list of the administrators in the AppInstance.
create_app_instance_admin	insert	app_instance_arn, region, AppInstanceAdminArn		Promotes an AppInstanceUser or AppInstanceBot to an AppInstanceAdmin. The promoted entity can perform the following actions. ChannelModerator actions across all channels in the AppInstance. DeleteChannelMessage actions. Only an AppInstanceUser and AppInstanceBot can be promoted to an AppInstanceAdmin role.
delete_app_instance_admin	delete	app_instance_admin_arn, app_instance_arn, region		Demotes an AppInstanceAdmin to an AppInstanceUser or AppInstanceBot. This action does not delete the user.

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_admin_arn	string	The ARN of the AppInstance's administrator.
app_instance_arn	string	The ARN of the AppInstance.
region	string	AWS region (default: us-east-1)
max-results	integer	The maximum number of administrators that you want to return.
next-token	string	The token returned from previous API requests until the number of administrators is reached.

SELECT examples

describe_app_instance_admin

Returns the full details of an AppInstanceAdmin.

SELECT
admin,
app_instance_arn,
created_timestamp
FROM aws.chime_sdk_identity.app_instance_admins
WHERE app_instance_admin_arn = '{{ app_instance_admin_arn }}' -- required
AND app_instance_arn = '{{ app_instance_arn }}' -- required
AND region = '{{ region }}' -- required
;

list_app_instance_admins

Returns a list of the administrators in the AppInstance.

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

INSERT examples

create_app_instance_admin

Promotes an AppInstanceUser or AppInstanceBot to an AppInstanceAdmin. The promoted entity can perform the following actions. ChannelModerator actions across all channels in the AppInstance. DeleteChannelMessage actions. Only an AppInstanceUser and AppInstanceBot can be promoted to an AppInstanceAdmin role.

INSERT INTO aws.chime_sdk_identity.app_instance_admins (
AppInstanceAdminArn,
app_instance_arn,
region
)
SELECT 
'{{ AppInstanceAdminArn }}' /* required */,
'{{ app_instance_arn }}',
'{{ region }}'
RETURNING
app_instance_admin,
app_instance_arn
;

Manifest

# Description fields are for documentation purposes
- name: app_instance_admins
props:
  - name: app_instance_arn
    value: "{{ app_instance_arn }}"
    description: Required parameter for the app_instance_admins resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the app_instance_admins resource.
  - name: AppInstanceAdminArn
    value: "{{ AppInstanceAdminArn }}"

DELETE examples

delete_app_instance_admin

Demotes an AppInstanceAdmin to an AppInstanceUser or AppInstanceBot. This action does not delete the user.

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