accounts

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

Overview

Name	accounts
Type	Resource
Id	aws.chime.accounts

Fields

The following fields are returned by SELECT queries:

get_account

Name	Datatype	Description
account_id	string	The Amazon Chime account ID.
account_status	string	The status of the account. (Suspended, Active)
account_type	string	The Amazon Chime account type. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide. (Team, EnterpriseDirectory, EnterpriseLWA, EnterpriseOIDC)
aws_account_id	string	The AWS account ID.
created_timestamp	string (date-time)	The Amazon Chime account creation timestamp, in ISO 8601 format.
default_license	string	The default license for the Amazon Chime account. (Basic, Plus, Pro, ProTrial)
name	string	The Amazon Chime account name.
signin_delegate_groups	array	The sign-in delegate groups associated with the account.
supported_licenses	array	Supported licenses for the Amazon Chime account.

list_accounts

Name	Datatype	Description
account_id	string	The Amazon Chime account ID.
account_status	string	The status of the account. (Suspended, Active)
account_type	string	The Amazon Chime account type. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide. (Team, EnterpriseDirectory, EnterpriseLWA, EnterpriseOIDC)
aws_account_id	string	The AWS account ID.
created_timestamp	string (date-time)	The Amazon Chime account creation timestamp, in ISO 8601 format.
default_license	string	The default license for the Amazon Chime account. (Basic, Plus, Pro, ProTrial)
name	string	The Amazon Chime account name.
signin_delegate_groups	array	The sign-in delegate groups associated with the account.
supported_licenses	array	Supported licenses for the Amazon Chime account.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_account	select	account_id, region		Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.
list_accounts	select	region	name, user-email, next-token, max-results	Lists the Amazon Chime accounts under the administrator's AWS account. You can filter accounts by account name prefix. To find out which Amazon Chime account a user belongs to, you can filter by the user's email address, which returns one account result.
create_account	insert	region		Creates an Amazon Chime account under the administrator's AWS account. Only Team account types are currently supported for this action. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.
associate_signin_delegate_groups_with_account	update	account_id, region, SigninDelegateGroups		Associates the specified sign-in delegate groups with the specified Amazon Chime account.
disassociate_signin_delegate_groups_from_account	update	account_id, region, GroupNames		Disassociates the specified sign-in delegate groups from the specified Amazon Chime account.
update_account	update	account_id, region		Updates account details for the specified Amazon Chime account. Currently, only account name and default license updates are supported for this action.
delete_account	delete	account_id, region		Deletes the specified Amazon Chime account. You must suspend all users before deleting Team account. You can use the BatchSuspendUser action to dodo. For EnterpriseLWA and EnterpriseAD accounts, you must release the claimed domains for your Amazon Chime account before deletion. As soon as you release the domain, all users under that account are suspended. Deleted accounts appear in your Disabled accounts list for 90 days. To restore deleted account from your Disabled accounts list, you must contact AWS Support. After 90 days, deleted accounts are permanently removed from your Disabled accounts list.
batch_create_room_membership	exec	account_id, room_id, region, MembershipItemList		Adds up to 50 members to a chat room in an Amazon Chime Enterprise account. Members can be users or bots. The member role designates whether the member is a chat room administrator or a general chat room member.
batch_suspend_user	exec	account_id, region, UserIdList		Suspends up to 50 users from a Team or EnterpriseLWA Amazon Chime account. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide. Users suspended from a Team account are disassociated from the account,but they can continue to use Amazon Chime as free users. To remove the suspension from suspended Team account users, invite them to the Team account again. You can use the InviteUsers action to do so. Users suspended from an EnterpriseLWA account are immediately signed out of Amazon Chime and can no longer sign in. To remove the suspension from suspended EnterpriseLWA account users, use the BatchUnsuspendUser action. To sign out users without suspending them, use the LogoutUser action.
batch_unsuspend_user	exec	account_id, region, UserIdList		Removes the suspension from up to 50 previously suspended users for the specified Amazon Chime EnterpriseLWA account. Only users on EnterpriseLWA accounts can be unsuspended using this action. For more information about different account types, see Managing Your Amazon Chime Accounts in the account types, in the Amazon Chime Administration Guide. Previously suspended users who are unsuspended using this action are returned to Registered status. Users who are not previously suspended are ignored.
batch_update_user	exec	account_id, region, UpdateUserRequestItems		Updates user details within the UpdateUserRequestItem object for up to 20 users for the specified Amazon Chime account. Currently, only LicenseType updates are supported for this action.
logout_user	exec	account_id, user_id, region		Logs out the specified user from all of the devices they are currently logged into.
redact_conversation_message	exec	account_id, conversation_id, message_id, region		Redacts the specified message from the specified Amazon Chime conversation.
redact_room_message	exec	account_id, room_id, message_id, region		Redacts the specified message from the specified Amazon Chime channel.
regenerate_security_token	exec	account_id, bot_id, region		Regenerates the security token for a bot.
reset_personal_pin	exec	account_id, user_id, region		Resets the personal meeting PIN for the specified user on an Amazon Chime account. Returns the User object with the updated personal meeting PIN.

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
account_id	string	The Amazon Chime account ID.
bot_id	string	The bot ID.
conversation_id	string	The conversation ID.
message_id	string	The message ID.
region	string	AWS region (default: us-east-1)
room_id	string	The room ID.
user_id	string	The user ID.
max-results	integer	The maximum number of results to return in a single call. Defaults to 100.
name	string	Amazon Chime account name prefix with which to filter results.
next-token	string	The token to use to retrieve the next page of results.
user-email	string	User email address with which to filter results.

SELECT examples

get_account

Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.

SELECT
account_id,
account_status,
account_type,
aws_account_id,
created_timestamp,
default_license,
name,
signin_delegate_groups,
supported_licenses
FROM aws.chime.accounts
WHERE account_id = '{{ account_id }}' -- required
AND region = '{{ region }}' -- required
;

list_accounts

Lists the Amazon Chime accounts under the administrator's AWS account. You can filter accounts by account name prefix. To find out which Amazon Chime account a user belongs to, you can filter by the user's email address, which returns one account result.

SELECT
account_id,
account_status,
account_type,
aws_account_id,
created_timestamp,
default_license,
name,
signin_delegate_groups,
supported_licenses
FROM aws.chime.accounts
WHERE region = '{{ region }}' -- required
AND name = '{{ name }}'
AND `user-email` = '{{ user-email }}'
AND `next-token` = '{{ next-token }}'
AND `max-results` = '{{ max-results }}'
;

INSERT examples

create_account

Creates an Amazon Chime account under the administrator's AWS account. Only Team account types are currently supported for this action. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.

INSERT INTO aws.chime.accounts (
Name,
region
)
SELECT 
'{{ Name }}',
'{{ region }}'
RETURNING
account
;

Manifest

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

UPDATE examples

associate_signin_delegate_groups_with_account

Associates the specified sign-in delegate groups with the specified Amazon Chime account.

UPDATE aws.chime.accounts
SET 
SigninDelegateGroups = '{{ SigninDelegateGroups }}'
WHERE 
account_id = '{{ account_id }}' --required
AND region = '{{ region }}' --required
AND SigninDelegateGroups = '{{ SigninDelegateGroups }}' --required;

disassociate_signin_delegate_groups_from_account

Disassociates the specified sign-in delegate groups from the specified Amazon Chime account.

UPDATE aws.chime.accounts
SET 
GroupNames = '{{ GroupNames }}'
WHERE 
account_id = '{{ account_id }}' --required
AND region = '{{ region }}' --required
AND GroupNames = '{{ GroupNames }}' --required;

update_account

Updates account details for the specified Amazon Chime account. Currently, only account name and default license updates are supported for this action.

UPDATE aws.chime.accounts
SET 
Name = '{{ Name }}',
DefaultLicense = '{{ DefaultLicense }}'
WHERE 
account_id = '{{ account_id }}' --required
AND region = '{{ region }}' --required
RETURNING
account;

DELETE examples

delete_account

Deletes the specified Amazon Chime account. You must suspend all users before deleting Team account. You can use the BatchSuspendUser action to dodo. For EnterpriseLWA and EnterpriseAD accounts, you must release the claimed domains for your Amazon Chime account before deletion. As soon as you release the domain, all users under that account are suspended. Deleted accounts appear in your Disabled accounts list for 90 days. To restore deleted account from your Disabled accounts list, you must contact AWS Support. After 90 days, deleted accounts are permanently removed from your Disabled accounts list.

DELETE FROM aws.chime.accounts
WHERE account_id = '{{ account_id }}' --required
AND region = '{{ region }}' --required
;

Lifecycle Methods

batch_create_room_membership

Adds up to 50 members to a chat room in an Amazon Chime Enterprise account. Members can be users or bots. The member role designates whether the member is a chat room administrator or a general chat room member.

EXEC aws.chime.accounts.batch_create_room_membership 
@account_id='{{ account_id }}' --required, 
@room_id='{{ room_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"MembershipItemList": "{{ MembershipItemList }}"
}'
;

batch_suspend_user

Suspends up to 50 users from a Team or EnterpriseLWA Amazon Chime account. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide. Users suspended from a Team account are disassociated from the account,but they can continue to use Amazon Chime as free users. To remove the suspension from suspended Team account users, invite them to the Team account again. You can use the InviteUsers action to do so. Users suspended from an EnterpriseLWA account are immediately signed out of Amazon Chime and can no longer sign in. To remove the suspension from suspended EnterpriseLWA account users, use the BatchUnsuspendUser action. To sign out users without suspending them, use the LogoutUser action.

EXEC aws.chime.accounts.batch_suspend_user 
@account_id='{{ account_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"UserIdList": "{{ UserIdList }}"
}'
;

batch_unsuspend_user

Removes the suspension from up to 50 previously suspended users for the specified Amazon Chime EnterpriseLWA account. Only users on EnterpriseLWA accounts can be unsuspended using this action. For more information about different account types, see Managing Your Amazon Chime Accounts in the account types, in the Amazon Chime Administration Guide. Previously suspended users who are unsuspended using this action are returned to Registered status. Users who are not previously suspended are ignored.

EXEC aws.chime.accounts.batch_unsuspend_user 
@account_id='{{ account_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"UserIdList": "{{ UserIdList }}"
}'
;

batch_update_user

Updates user details within the UpdateUserRequestItem object for up to 20 users for the specified Amazon Chime account. Currently, only LicenseType updates are supported for this action.

EXEC aws.chime.accounts.batch_update_user 
@account_id='{{ account_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"UpdateUserRequestItems": "{{ UpdateUserRequestItems }}"
}'
;

logout_user

Logs out the specified user from all of the devices they are currently logged into.

EXEC aws.chime.accounts.logout_user 
@account_id='{{ account_id }}' --required, 
@user_id='{{ user_id }}' --required, 
@region='{{ region }}' --required
;

redact_conversation_message

Redacts the specified message from the specified Amazon Chime conversation.

EXEC aws.chime.accounts.redact_conversation_message 
@account_id='{{ account_id }}' --required, 
@conversation_id='{{ conversation_id }}' --required, 
@message_id='{{ message_id }}' --required, 
@region='{{ region }}' --required
;

redact_room_message

Redacts the specified message from the specified Amazon Chime channel.

EXEC aws.chime.accounts.redact_room_message 
@account_id='{{ account_id }}' --required, 
@room_id='{{ room_id }}' --required, 
@message_id='{{ message_id }}' --required, 
@region='{{ region }}' --required
;

regenerate_security_token

Regenerates the security token for a bot.

EXEC aws.chime.accounts.regenerate_security_token 
@account_id='{{ account_id }}' --required, 
@bot_id='{{ bot_id }}' --required, 
@region='{{ region }}' --required
;

reset_personal_pin

Resets the personal meeting PIN for the specified user on an Amazon Chime account. Returns the User object with the updated personal meeting PIN.

EXEC aws.chime.accounts.reset_personal_pin 
@account_id='{{ account_id }}' --required, 
@user_id='{{ user_id }}' --required, 
@region='{{ region }}' --required
;