2018/10/30 - Amazon Chime - 16 new api methods
Changes This is the initial release for the Amazon Chime AWS SDK. In this release, Amazon Chime adds support for administrative actions on users and accounts. API Documentation is also updated on https://docs.aws.amazon.com/chime/index.html
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 dissociated 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 are no longer able to 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.
See also: AWS API Documentation
Request Syntax
client.batch_suspend_user(
AccountId='string',
UserIdList=[
'string',
]
)
string
[REQUIRED]
The Amazon Chime account ID.
list
[REQUIRED]
The request containing the user IDs to suspend.
(string) --
dict
Response Syntax
{
'UserErrors': [
{
'UserId': 'string',
'ErrorCode': 'Unauthorized'|'Forbidden'|'NotFound'|'BadRequest'|'Conflict'|'ServiceFailure'|'ServiceUnavailable'|'Unprocessable'|'Throttled'|'PreconditionFailed',
'ErrorMessage': 'string'
},
]
}
Response Structure
(dict) --
UserErrors (list) --
If the BatchSuspendUser action fails for one or more of the user IDs in the request, a list of the user IDs is returned, along with error codes and error messages.
(dict) --
The list of errors returned when errors are encountered during the BatchSuspendUser , BatchUnsuspendUser , or BatchUpdateUser actions. This includes user IDs, error codes, and error messages.
UserId (string) --
The user ID for which the action failed.
ErrorCode (string) --
The error code.
ErrorMessage (string) --
The error message.
Deletes the specified Amazon Chime account. You must suspend all users before deleting a Team account. You can use the BatchSuspendUser action to do so.
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 a 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.
See also: AWS API Documentation
Request Syntax
client.delete_account(
AccountId='string'
)
string
[REQUIRED]
The Amazon Chime account ID.
dict
Response Syntax
{}
Response Structure
(dict) --
Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dial out settings. For more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide .
See also: AWS API Documentation
Request Syntax
client.get_account_settings(
AccountId='string'
)
string
[REQUIRED]
The Amazon Chime account ID.
dict
Response Syntax
{
'AccountSettings': {
'DisableRemoteControl': True|False,
'EnableDialOut': True|False
}
}
Response Structure
(dict) --
AccountSettings (dict) --
The Amazon Chime account settings.
DisableRemoteControl (boolean) --
Setting that stops or starts remote control of shared screens during meetings.
EnableDialOut (boolean) --
Setting that allows meeting participants to choose the Call me at a phone number option. For more information, see Join a Meeting without the Amazon Chime App .
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 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.
See also: AWS API Documentation
Request Syntax
client.batch_unsuspend_user(
AccountId='string',
UserIdList=[
'string',
]
)
string
[REQUIRED]
The Amazon Chime account ID.
list
[REQUIRED]
The request containing the user IDs to unsuspend.
(string) --
dict
Response Syntax
{
'UserErrors': [
{
'UserId': 'string',
'ErrorCode': 'Unauthorized'|'Forbidden'|'NotFound'|'BadRequest'|'Conflict'|'ServiceFailure'|'ServiceUnavailable'|'Unprocessable'|'Throttled'|'PreconditionFailed',
'ErrorMessage': 'string'
},
]
}
Response Structure
(dict) --
UserErrors (list) --
If the BatchUnsuspendUser action fails for one or more of the user IDs in the request, a list of the user IDs is returned, along with error codes and error messages.
(dict) --
The list of errors returned when errors are encountered during the BatchSuspendUser , BatchUnsuspendUser , or BatchUpdateUser actions. This includes user IDs, error codes, and error messages.
UserId (string) --
The user ID for which the action failed.
ErrorCode (string) --
The error code.
ErrorMessage (string) --
The error message.
Retrieves details for the specified user ID, such as primary email address, license type, and personal meeting PIN.
See also: AWS API Documentation
Request Syntax
client.get_user(
AccountId='string',
UserId='string'
)
string
[REQUIRED]
The Amazon Chime account ID.
string
[REQUIRED]
The user ID.
dict
Response Syntax
{
'User': {
'UserId': 'string',
'AccountId': 'string',
'PrimaryEmail': 'string',
'DisplayName': 'string',
'LicenseType': 'Basic'|'Plus'|'Pro'|'ProTrial',
'UserRegistrationStatus': 'Unregistered'|'Registered'|'Suspended',
'UserInvitationStatus': 'Pending'|'Accepted'|'Failed',
'RegisteredOn': datetime(2015, 1, 1),
'InvitedOn': datetime(2015, 1, 1),
'PersonalPIN': 'string'
}
}
Response Structure
(dict) --
User (dict) --
The user details.
UserId (string) --
The user ID.
AccountId (string) --
The Amazon Chime account ID.
PrimaryEmail (string) --
The primary email address of the user.
DisplayName (string) --
The display name of the user.
LicenseType (string) --
The license type for the user.
UserRegistrationStatus (string) --
The user registration status.
UserInvitationStatus (string) --
The user invite status.
RegisteredOn (datetime) --
Date and time when the user is registered, in ISO 8601 format.
InvitedOn (datetime) --
Date and time when the user is invited to the Amazon Chime account, in ISO 8601 format.
PersonalPIN (string) --
The user's personal meeting 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.
See also: AWS API Documentation
Request Syntax
client.reset_personal_pin(
AccountId='string',
UserId='string'
)
string
[REQUIRED]
The Amazon Chime account ID.
string
[REQUIRED]
The user ID.
dict
Response Syntax
{
'User': {
'UserId': 'string',
'AccountId': 'string',
'PrimaryEmail': 'string',
'DisplayName': 'string',
'LicenseType': 'Basic'|'Plus'|'Pro'|'ProTrial',
'UserRegistrationStatus': 'Unregistered'|'Registered'|'Suspended',
'UserInvitationStatus': 'Pending'|'Accepted'|'Failed',
'RegisteredOn': datetime(2015, 1, 1),
'InvitedOn': datetime(2015, 1, 1),
'PersonalPIN': 'string'
}
}
Response Structure
(dict) --
User (dict) --
The user details and new personal meeting PIN.
UserId (string) --
The user ID.
AccountId (string) --
The Amazon Chime account ID.
PrimaryEmail (string) --
The primary email address of the user.
DisplayName (string) --
The display name of the user.
LicenseType (string) --
The license type for the user.
UserRegistrationStatus (string) --
The user registration status.
UserInvitationStatus (string) --
The user invite status.
RegisteredOn (datetime) --
Date and time when the user is registered, in ISO 8601 format.
InvitedOn (datetime) --
Date and time when the user is invited to the Amazon Chime account, in ISO 8601 format.
PersonalPIN (string) --
The user's personal meeting PIN.
Updates user details for a specified user ID. Currently, only LicenseType updates are supported for this action.
See also: AWS API Documentation
Request Syntax
client.update_user(
AccountId='string',
UserId='string',
LicenseType='Basic'|'Plus'|'Pro'|'ProTrial'
)
string
[REQUIRED]
The Amazon Chime account ID.
string
[REQUIRED]
The user ID.
string
The user license type to update. This must be a supported license type for the Amazon Chime account that the user belongs to.
dict
Response Syntax
{
'User': {
'UserId': 'string',
'AccountId': 'string',
'PrimaryEmail': 'string',
'DisplayName': 'string',
'LicenseType': 'Basic'|'Plus'|'Pro'|'ProTrial',
'UserRegistrationStatus': 'Unregistered'|'Registered'|'Suspended',
'UserInvitationStatus': 'Pending'|'Accepted'|'Failed',
'RegisteredOn': datetime(2015, 1, 1),
'InvitedOn': datetime(2015, 1, 1),
'PersonalPIN': 'string'
}
}
Response Structure
(dict) --
User (dict) --
The updated user details.
UserId (string) --
The user ID.
AccountId (string) --
The Amazon Chime account ID.
PrimaryEmail (string) --
The primary email address of the user.
DisplayName (string) --
The display name of the user.
LicenseType (string) --
The license type for the user.
UserRegistrationStatus (string) --
The user registration status.
UserInvitationStatus (string) --
The user invite status.
RegisteredOn (datetime) --
Date and time when the user is registered, in ISO 8601 format.
InvitedOn (datetime) --
Date and time when the user is invited to the Amazon Chime account, in ISO 8601 format.
PersonalPIN (string) --
The user's personal meeting PIN.
Sends email invites to as many as 50 users, inviting them to the specified Amazon Chime Team account. Only Team account types are currently supported for this action.
See also: AWS API Documentation
Request Syntax
client.invite_users(
AccountId='string',
UserEmailList=[
'string',
]
)
string
[REQUIRED]
The Amazon Chime account ID.
list
[REQUIRED]
The user email addresses to which to send the invite.
(string) --
dict
Response Syntax
{
'Invites': [
{
'InviteId': 'string',
'Status': 'Pending'|'Accepted'|'Failed',
'EmailAddress': 'string',
'EmailStatus': 'NotSent'|'Sent'|'Failed'
},
]
}
Response Structure
(dict) --
Invites (list) --
The invite details.
(dict) --
Invitation object returned after emailing users to invite them to join the Amazon Chime Team account.
InviteId (string) --
The invite ID.
Status (string) --
The status of the invite.
EmailAddress (string) --
The email address to which the invite is sent.
EmailStatus (string) --
The status of the invite email.
Updates account details for the specified Amazon Chime account. Currently, only account name updates are supported for this action.
See also: AWS API Documentation
Request Syntax
client.update_account(
AccountId='string',
Name='string'
)
string
[REQUIRED]
The Amazon Chime account ID.
string
The new name for the specified Amazon Chime account.
dict
Response Syntax
{
'Account': {
'AwsAccountId': 'string',
'AccountId': 'string',
'Name': 'string',
'AccountType': 'Team'|'EnterpriseDirectory'|'EnterpriseLWA'|'EnterpriseOIDC',
'CreatedTimestamp': datetime(2015, 1, 1),
'DefaultLicense': 'Basic'|'Plus'|'Pro'|'ProTrial',
'SupportedLicenses': [
'Basic'|'Plus'|'Pro'|'ProTrial',
]
}
}
Response Structure
(dict) --
Account (dict) --
The updated Amazon Chime account details.
AwsAccountId (string) --
The AWS account ID.
AccountId (string) --
The Amazon Chime account ID.
Name (string) --
The Amazon Chime account name.
AccountType (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 .
CreatedTimestamp (datetime) --
The Amazon Chime account creation timestamp, in ISO 8601 format.
DefaultLicense (string) --
The default license for the Amazon Chime account.
SupportedLicenses (list) --
Supported licenses for the Amazon Chime account.
(string) --
Lists the users that belong to the specified Amazon Chime account.
See also: AWS API Documentation
Request Syntax
client.list_users(
AccountId='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The Amazon Chime account ID.
integer
The maximum number of results to return in a single call. Defaults to 100.
string
The token to use to retrieve the next page of results.
dict
Response Syntax
{
'Users': [
{
'UserId': 'string',
'AccountId': 'string',
'PrimaryEmail': 'string',
'DisplayName': 'string',
'LicenseType': 'Basic'|'Plus'|'Pro'|'ProTrial',
'UserRegistrationStatus': 'Unregistered'|'Registered'|'Suspended',
'UserInvitationStatus': 'Pending'|'Accepted'|'Failed',
'RegisteredOn': datetime(2015, 1, 1),
'InvitedOn': datetime(2015, 1, 1),
'PersonalPIN': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Users (list) --
List of users and user details.
(dict) --
The user on the Amazon Chime account.
UserId (string) --
The user ID.
AccountId (string) --
The Amazon Chime account ID.
PrimaryEmail (string) --
The primary email address of the user.
DisplayName (string) --
The display name of the user.
LicenseType (string) --
The license type for the user.
UserRegistrationStatus (string) --
The user registration status.
UserInvitationStatus (string) --
The user invite status.
RegisteredOn (datetime) --
Date and time when the user is registered, in ISO 8601 format.
InvitedOn (datetime) --
Date and time when the user is invited to the Amazon Chime account, in ISO 8601 format.
PersonalPIN (string) --
The user's personal meeting PIN.
NextToken (string) --
The token to use to retrieve the next page of results.
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.
See also: AWS API Documentation
Request Syntax
client.batch_update_user(
AccountId='string',
UpdateUserRequestItems=[
{
'UserId': 'string',
'LicenseType': 'Basic'|'Plus'|'Pro'|'ProTrial'
},
]
)
string
[REQUIRED]
The Amazon Chime account ID.
list
[REQUIRED]
The request containing the user IDs and details to update.
(dict) --
The user ID and user fields to update, used with the BatchUpdateUser action.
UserId (string) -- [REQUIRED]
The user ID.
LicenseType (string) --
The user license type.
dict
Response Syntax
{
'UserErrors': [
{
'UserId': 'string',
'ErrorCode': 'Unauthorized'|'Forbidden'|'NotFound'|'BadRequest'|'Conflict'|'ServiceFailure'|'ServiceUnavailable'|'Unprocessable'|'Throttled'|'PreconditionFailed',
'ErrorMessage': 'string'
},
]
}
Response Structure
(dict) --
UserErrors (list) --
If the BatchUpdateUser action fails for one or more of the user IDs in the request, a list of the user IDs is returned, along with error codes and error messages.
(dict) --
The list of errors returned when errors are encountered during the BatchSuspendUser , BatchUnsuspendUser , or BatchUpdateUser actions. This includes user IDs, error codes, and error messages.
UserId (string) --
The user ID for which the action failed.
ErrorCode (string) --
The error code.
ErrorMessage (string) --
The error message.
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.
See also: AWS API Documentation
Request Syntax
client.list_accounts(
Name='string',
UserEmail='string',
NextToken='string',
MaxResults=123
)
string
Amazon Chime account name prefix with which to filter results.
string
User email address with which to filter results.
string
The token to use to retrieve the next page of results.
integer
The maximum number of results to return in a single call. Defaults to 100.
dict
Response Syntax
{
'Accounts': [
{
'AwsAccountId': 'string',
'AccountId': 'string',
'Name': 'string',
'AccountType': 'Team'|'EnterpriseDirectory'|'EnterpriseLWA'|'EnterpriseOIDC',
'CreatedTimestamp': datetime(2015, 1, 1),
'DefaultLicense': 'Basic'|'Plus'|'Pro'|'ProTrial',
'SupportedLicenses': [
'Basic'|'Plus'|'Pro'|'ProTrial',
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Accounts (list) --
List of Amazon Chime accounts and account details.
(dict) --
The Amazon Chime account details. An AWS account can have multiple Amazon Chime accounts.
AwsAccountId (string) --
The AWS account ID.
AccountId (string) --
The Amazon Chime account ID.
Name (string) --
The Amazon Chime account name.
AccountType (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 .
CreatedTimestamp (datetime) --
The Amazon Chime account creation timestamp, in ISO 8601 format.
DefaultLicense (string) --
The default license for the Amazon Chime account.
SupportedLicenses (list) --
Supported licenses for the Amazon Chime account.
(string) --
NextToken (string) --
The token to use to retrieve the next page of results.
Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.
See also: AWS API Documentation
Request Syntax
client.get_account(
AccountId='string'
)
string
[REQUIRED]
The Amazon Chime account ID.
dict
Response Syntax
{
'Account': {
'AwsAccountId': 'string',
'AccountId': 'string',
'Name': 'string',
'AccountType': 'Team'|'EnterpriseDirectory'|'EnterpriseLWA'|'EnterpriseOIDC',
'CreatedTimestamp': datetime(2015, 1, 1),
'DefaultLicense': 'Basic'|'Plus'|'Pro'|'ProTrial',
'SupportedLicenses': [
'Basic'|'Plus'|'Pro'|'ProTrial',
]
}
}
Response Structure
(dict) --
Account (dict) --
The Amazon Chime account details.
AwsAccountId (string) --
The AWS account ID.
AccountId (string) --
The Amazon Chime account ID.
Name (string) --
The Amazon Chime account name.
AccountType (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 .
CreatedTimestamp (datetime) --
The Amazon Chime account creation timestamp, in ISO 8601 format.
DefaultLicense (string) --
The default license for the Amazon Chime account.
SupportedLicenses (list) --
Supported licenses for the Amazon Chime account.
(string) --
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 .
See also: AWS API Documentation
Request Syntax
client.create_account(
Name='string'
)
string
[REQUIRED]
The name of the Amazon Chime account.
dict
Response Syntax
{
'Account': {
'AwsAccountId': 'string',
'AccountId': 'string',
'Name': 'string',
'AccountType': 'Team'|'EnterpriseDirectory'|'EnterpriseLWA'|'EnterpriseOIDC',
'CreatedTimestamp': datetime(2015, 1, 1),
'DefaultLicense': 'Basic'|'Plus'|'Pro'|'ProTrial',
'SupportedLicenses': [
'Basic'|'Plus'|'Pro'|'ProTrial',
]
}
}
Response Structure
(dict) --
Account (dict) --
The Amazon Chime account details.
AwsAccountId (string) --
The AWS account ID.
AccountId (string) --
The Amazon Chime account ID.
Name (string) --
The Amazon Chime account name.
AccountType (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 .
CreatedTimestamp (datetime) --
The Amazon Chime account creation timestamp, in ISO 8601 format.
DefaultLicense (string) --
The default license for the Amazon Chime account.
SupportedLicenses (list) --
Supported licenses for the Amazon Chime account.
(string) --
Updates the settings for the specified Amazon Chime account. You can update settings for remote control of shared screens, or for the dial-out option. For more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide .
See also: AWS API Documentation
Request Syntax
client.update_account_settings(
AccountId='string',
AccountSettings={
'DisableRemoteControl': True|False,
'EnableDialOut': True|False
}
)
string
[REQUIRED]
The Amazon Chime account ID.
dict
[REQUIRED]
The Amazon Chime account settings to update.
DisableRemoteControl (boolean) --
Setting that stops or starts remote control of shared screens during meetings.
EnableDialOut (boolean) --
Setting that allows meeting participants to choose the Call me at a phone number option. For more information, see Join a Meeting without the Amazon Chime App .
dict
Response Syntax
{}
Response Structure
(dict) --
Logs out the specified user from all of the devices they are currently logged into.
See also: AWS API Documentation
Request Syntax
client.logout_user(
AccountId='string',
UserId='string'
)
string
[REQUIRED]
The Amazon Chime account ID.
string
[REQUIRED]
The user ID.
dict
Response Syntax
{}
Response Structure
(dict) --