AWS API Changes

2020/01/10 - Amazon Chime - 3 new 10 updated api methods

Changes Add shared profile support to new and existing users

CreateUser (new)

Creates a user under the specified Amazon Chime account.

Request Syntax

client.create_user(
    AccountId='string',
    Username='string',
    Email='string',
    UserType='PrivateUser'|'SharedDevice'
)

type AccountId

string

param AccountId

[REQUIRED]

The Amazon Chime account ID.

type Username

string

param Username

The user name.

type Email

string

param Email

The user's email address.

type UserType

string

param UserType

The user type.

rtype

dict

returns

Response Syntax

{
    'User': {
        'UserId': 'string',
        'AccountId': 'string',
        'PrimaryEmail': 'string',
        'PrimaryProvisionedNumber': 'string',
        'DisplayName': 'string',
        'LicenseType': 'Basic'|'Plus'|'Pro'|'ProTrial',
        'UserType': 'PrivateUser'|'SharedDevice',
        'UserRegistrationStatus': 'Unregistered'|'Registered'|'Suspended',
        'UserInvitationStatus': 'Pending'|'Accepted'|'Failed',
        'RegisteredOn': datetime(2015, 1, 1),
        'InvitedOn': datetime(2015, 1, 1),
        'AlexaForBusinessMetadata': {
            'IsAlexaForBusinessEnabled': True|False,
            'AlexaForBusinessRoomArn': 'string'
        },
        'PersonalPIN': 'string'
    }
}

Response Structure

(dict) --
- User (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.
  - PrimaryProvisionedNumber (string) --
    
    The primary phone number associated with the user.
  - DisplayName (string) --
    
    The display name of the user.
  - LicenseType (string) --
    
    The license type for the user.
  - UserType (string) --
    
    The user type.
  - 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.
  - AlexaForBusinessMetadata (dict) --
    
    The Alexa for Business metadata.
    - IsAlexaForBusinessEnabled (boolean) --
      
      Starts or stops Alexa for Business.
    - AlexaForBusinessRoomArn (string) --
      
      The ARN of the room resource.
  - PersonalPIN (string) --
    
    The user's personal meeting PIN.

DisassociateSigninDelegateGroupsFromAccount (new)

Link ¶

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

See also: AWS API Documentation

Request Syntax

client.disassociate_signin_delegate_groups_from_account(
    AccountId='string',
    GroupNames=[
        'string',
    ]
)

type AccountId

string

param AccountId

[REQUIRED]

The Amazon Chime account ID.

type GroupNames

list

param GroupNames

[REQUIRED]

The sign-in delegate group names.

(string) --

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

AssociateSigninDelegateGroupsWithAccount (new)

Link ¶

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

See also: AWS API Documentation

Request Syntax

client.associate_signin_delegate_groups_with_account(
    AccountId='string',
    SigninDelegateGroups=[
        {
            'GroupName': 'string'
        },
    ]
)

type AccountId

string

param AccountId

[REQUIRED]

The Amazon Chime account ID.

type SigninDelegateGroups

list

param SigninDelegateGroups

[REQUIRED]

The sign-in delegate groups.

(dict) --

An Active Directory (AD) group whose members are granted permission to act as delegates.
- GroupName (string) --
  
  The group name.

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

BatchUpdateUser (updated)

Link ¶
Changes (request)

{'UpdateUserRequestItems': {'AlexaForBusinessMetadata': {'AlexaForBusinessRoomArn': 'string',
                                                         'IsAlexaForBusinessEnabled': 'boolean'},
                            'UserType': 'PrivateUser | SharedDevice'}}

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',
            'UserType': 'PrivateUser'|'SharedDevice',
            'AlexaForBusinessMetadata': {
                'IsAlexaForBusinessEnabled': True|False,
                'AlexaForBusinessRoomArn': 'string'
            }
        },
    ]
)

type AccountId

string

param AccountId

[REQUIRED]

The Amazon Chime account ID.

type UpdateUserRequestItems

list

param UpdateUserRequestItems

[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.
- UserType (string) --
  
  The user type.
- AlexaForBusinessMetadata (dict) --
  
  The Alexa for Business metadata.
  - IsAlexaForBusinessEnabled (boolean) --
    
    Starts or stops Alexa for Business.
  - AlexaForBusinessRoomArn (string) --
    
    The ARN of the room resource.

rtype

dict

returns

Response Syntax

{
    'UserErrors': [
        {
            'UserId': 'string',
            'ErrorCode': 'BadRequest'|'Conflict'|'Forbidden'|'NotFound'|'PreconditionFailed'|'ResourceLimitExceeded'|'ServiceFailure'|'AccessDenied'|'ServiceUnavailable'|'Throttled'|'Unauthorized'|'Unprocessable'|'VoiceConnectorGroupAssociationsExist'|'PhoneNumberAssociationsExist',
            '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.

CreateAccount (updated)

Link ¶
Changes (response)

{'Account': {'SigninDelegateGroups': [{'GroupName': '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'
)

type Name

string

param Name

[REQUIRED]

The name of the Amazon Chime account.

rtype

dict

returns

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',
        ],
        'SigninDelegateGroups': [
            {
                'GroupName': 'string'
            },
        ]
    }
}

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) --
  - SigninDelegateGroups (list) --
    
    The sign-in delegate groups associated with the account.
    - (dict) --
      
      An Active Directory (AD) group whose members are granted permission to act as delegates.
      - GroupName (string) --
        
        The group name.

GetAccount (updated)

Link ¶
Changes (response)

{'Account': {'SigninDelegateGroups': [{'GroupName': 'string'}]}}

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'
)

type AccountId

string

param AccountId

[REQUIRED]

The Amazon Chime account ID.

rtype

dict

returns

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',
        ],
        'SigninDelegateGroups': [
            {
                'GroupName': 'string'
            },
        ]
    }
}

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) --
  - SigninDelegateGroups (list) --
    
    The sign-in delegate groups associated with the account.
    - (dict) --
      
      An Active Directory (AD) group whose members are granted permission to act as delegates.
      - GroupName (string) --
        
        The group name.

GetUser (updated)

Link ¶
Changes (response)

{'User': {'AlexaForBusinessMetadata': {'AlexaForBusinessRoomArn': 'string',
                                       'IsAlexaForBusinessEnabled': 'boolean'},
          'UserType': 'PrivateUser | SharedDevice'}}

Retrieves details for the specified user ID, such as primary email address, license type, and personal meeting PIN.

To retrieve user details with an email address instead of a user ID, use the ListUsers action, and then filter by email address.

See also: AWS API Documentation

Request Syntax

client.get_user(
    AccountId='string',
    UserId='string'
)

type AccountId

string

param AccountId

[REQUIRED]

The Amazon Chime account ID.

type UserId

string

param UserId

[REQUIRED]

The user ID.

rtype

dict

returns

Response Syntax

{
    'User': {
        'UserId': 'string',
        'AccountId': 'string',
        'PrimaryEmail': 'string',
        'PrimaryProvisionedNumber': 'string',
        'DisplayName': 'string',
        'LicenseType': 'Basic'|'Plus'|'Pro'|'ProTrial',
        'UserType': 'PrivateUser'|'SharedDevice',
        'UserRegistrationStatus': 'Unregistered'|'Registered'|'Suspended',
        'UserInvitationStatus': 'Pending'|'Accepted'|'Failed',
        'RegisteredOn': datetime(2015, 1, 1),
        'InvitedOn': datetime(2015, 1, 1),
        'AlexaForBusinessMetadata': {
            'IsAlexaForBusinessEnabled': True|False,
            'AlexaForBusinessRoomArn': 'string'
        },
        '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.
  - PrimaryProvisionedNumber (string) --
    
    The primary phone number associated with the user.
  - DisplayName (string) --
    
    The display name of the user.
  - LicenseType (string) --
    
    The license type for the user.
  - UserType (string) --
    
    The user type.
  - 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.
  - AlexaForBusinessMetadata (dict) --
    
    The Alexa for Business metadata.
    - IsAlexaForBusinessEnabled (boolean) --
      
      Starts or stops Alexa for Business.
    - AlexaForBusinessRoomArn (string) --
      
      The ARN of the room resource.
  - PersonalPIN (string) --
    
    The user's personal meeting PIN.

InviteUsers (updated)

Link ¶
Changes (request)

{'UserType': 'PrivateUser | SharedDevice'}

Sends email to a maximum of 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',
    ],
    UserType='PrivateUser'|'SharedDevice'
)

type AccountId

string

param AccountId

[REQUIRED]

The Amazon Chime account ID.

type UserEmailList

list

param UserEmailList

[REQUIRED]

The user email addresses to which to send the email invitation.

(string) --

type UserType

string

param UserType

The user type.

rtype

dict

returns

Response Syntax

{
    'Invites': [
        {
            'InviteId': 'string',
            'Status': 'Pending'|'Accepted'|'Failed',
            'EmailAddress': 'string',
            'EmailStatus': 'NotSent'|'Sent'|'Failed'
        },
    ]
}

Response Structure

(dict) --
- Invites (list) --
  
  The email invitation 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.

ListAccounts (updated)

Link ¶
Changes (response)

{'Accounts': {'SigninDelegateGroups': [{'GroupName': 'string'}]}}

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
)

type Name

string

param Name

Amazon Chime account name prefix with which to filter results.

type UserEmail

string

param UserEmail

User email address with which to filter results.

type NextToken

string

param NextToken

The token to use to retrieve the next page of results.

type MaxResults

integer

param MaxResults

The maximum number of results to return in a single call. Defaults to 100.

rtype

dict

returns

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',
            ],
            'SigninDelegateGroups': [
                {
                    'GroupName': 'string'
                },
            ]
        },
    ],
    '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) --
    - SigninDelegateGroups (list) --
      
      The sign-in delegate groups associated with the account.
      - (dict) --
        
        An Active Directory (AD) group whose members are granted permission to act as delegates.
        
        GroupName (string) --
        
        The group name.
- NextToken (string) --
  
  The token to use to retrieve the next page of results.

ListUsers (updated)

Link ¶
Changes (request, response)
Request

{'UserType': 'PrivateUser | SharedDevice'}

Response

{'Users': {'AlexaForBusinessMetadata': {'AlexaForBusinessRoomArn': 'string',
                                        'IsAlexaForBusinessEnabled': 'boolean'},
           'UserType': 'PrivateUser | SharedDevice'}}

Lists the users that belong to the specified Amazon Chime account. You can specify an email address to list only the user that the email address belongs to.

See also: AWS API Documentation

Request Syntax

client.list_users(
    AccountId='string',
    UserEmail='string',
    UserType='PrivateUser'|'SharedDevice',
    MaxResults=123,
    NextToken='string'
)

type AccountId

string

param AccountId

[REQUIRED]

The Amazon Chime account ID.

type UserEmail

string

param UserEmail

Optional. The user email address used to filter results. Maximum 1.

type UserType

string

param UserType

The user type.

type MaxResults

integer

param MaxResults

The maximum number of results to return in a single call. Defaults to 100.

type NextToken

string

param NextToken

The token to use to retrieve the next page of results.

rtype

dict

returns

Response Syntax

{
    'Users': [
        {
            'UserId': 'string',
            'AccountId': 'string',
            'PrimaryEmail': 'string',
            'PrimaryProvisionedNumber': 'string',
            'DisplayName': 'string',
            'LicenseType': 'Basic'|'Plus'|'Pro'|'ProTrial',
            'UserType': 'PrivateUser'|'SharedDevice',
            'UserRegistrationStatus': 'Unregistered'|'Registered'|'Suspended',
            'UserInvitationStatus': 'Pending'|'Accepted'|'Failed',
            'RegisteredOn': datetime(2015, 1, 1),
            'InvitedOn': datetime(2015, 1, 1),
            'AlexaForBusinessMetadata': {
                'IsAlexaForBusinessEnabled': True|False,
                'AlexaForBusinessRoomArn': 'string'
            },
            '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.
    - PrimaryProvisionedNumber (string) --
      
      The primary phone number associated with the user.
    - DisplayName (string) --
      
      The display name of the user.
    - LicenseType (string) --
      
      The license type for the user.
    - UserType (string) --
      
      The user type.
    - 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.
    - AlexaForBusinessMetadata (dict) --
      
      The Alexa for Business metadata.
      - IsAlexaForBusinessEnabled (boolean) --
        
        Starts or stops Alexa for Business.
      - AlexaForBusinessRoomArn (string) --
        
        The ARN of the room resource.
    - PersonalPIN (string) --
      
      The user's personal meeting PIN.
- NextToken (string) --
  
  The token to use to retrieve the next page of results.

ResetPersonalPIN (updated)

Link ¶
Changes (response)

{'User': {'AlexaForBusinessMetadata': {'AlexaForBusinessRoomArn': 'string',
                                       'IsAlexaForBusinessEnabled': 'boolean'},
          'UserType': 'PrivateUser | SharedDevice'}}

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'
)

type AccountId

string

param AccountId

[REQUIRED]

The Amazon Chime account ID.

type UserId

string

param UserId

[REQUIRED]

The user ID.

rtype

dict

returns

Response Syntax

{
    'User': {
        'UserId': 'string',
        'AccountId': 'string',
        'PrimaryEmail': 'string',
        'PrimaryProvisionedNumber': 'string',
        'DisplayName': 'string',
        'LicenseType': 'Basic'|'Plus'|'Pro'|'ProTrial',
        'UserType': 'PrivateUser'|'SharedDevice',
        'UserRegistrationStatus': 'Unregistered'|'Registered'|'Suspended',
        'UserInvitationStatus': 'Pending'|'Accepted'|'Failed',
        'RegisteredOn': datetime(2015, 1, 1),
        'InvitedOn': datetime(2015, 1, 1),
        'AlexaForBusinessMetadata': {
            'IsAlexaForBusinessEnabled': True|False,
            'AlexaForBusinessRoomArn': 'string'
        },
        '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.
  - PrimaryProvisionedNumber (string) --
    
    The primary phone number associated with the user.
  - DisplayName (string) --
    
    The display name of the user.
  - LicenseType (string) --
    
    The license type for the user.
  - UserType (string) --
    
    The user type.
  - 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.
  - AlexaForBusinessMetadata (dict) --
    
    The Alexa for Business metadata.
    - IsAlexaForBusinessEnabled (boolean) --
      
      Starts or stops Alexa for Business.
    - AlexaForBusinessRoomArn (string) --
      
      The ARN of the room resource.
  - PersonalPIN (string) --
    
    The user's personal meeting PIN.

UpdateAccount (updated)

Link ¶
Changes (response)

{'Account': {'SigninDelegateGroups': [{'GroupName': 'string'}]}}

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'
)

type AccountId

string

param AccountId

[REQUIRED]

The Amazon Chime account ID.

type Name

string

param Name

The new name for the specified Amazon Chime account.

rtype

dict

returns

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',
        ],
        'SigninDelegateGroups': [
            {
                'GroupName': 'string'
            },
        ]
    }
}

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) --
  - SigninDelegateGroups (list) --
    
    The sign-in delegate groups associated with the account.
    - (dict) --
      
      An Active Directory (AD) group whose members are granted permission to act as delegates.
      - GroupName (string) --
        
        The group name.

UpdateUser (updated)

Link ¶
Changes (request, response)
Request

{'AlexaForBusinessMetadata': {'AlexaForBusinessRoomArn': 'string',
                              'IsAlexaForBusinessEnabled': 'boolean'},
 'UserType': 'PrivateUser | SharedDevice'}

Response

{'User': {'AlexaForBusinessMetadata': {'AlexaForBusinessRoomArn': 'string',
                                       'IsAlexaForBusinessEnabled': 'boolean'},
          'UserType': 'PrivateUser | SharedDevice'}}

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',
    UserType='PrivateUser'|'SharedDevice',
    AlexaForBusinessMetadata={
        'IsAlexaForBusinessEnabled': True|False,
        'AlexaForBusinessRoomArn': 'string'
    }
)

type AccountId

string

param AccountId

[REQUIRED]

The Amazon Chime account ID.

type UserId

string

param UserId

[REQUIRED]

The user ID.

type LicenseType

string

param LicenseType

The user license type to update. This must be a supported license type for the Amazon Chime account that the user belongs to.

type UserType

string

param UserType

The user type.

type AlexaForBusinessMetadata

dict

param AlexaForBusinessMetadata

The Alexa for Business metadata.

IsAlexaForBusinessEnabled (boolean) --

Starts or stops Alexa for Business.
AlexaForBusinessRoomArn (string) --

The ARN of the room resource.

rtype

dict

returns

Response Syntax

{
    'User': {
        'UserId': 'string',
        'AccountId': 'string',
        'PrimaryEmail': 'string',
        'PrimaryProvisionedNumber': 'string',
        'DisplayName': 'string',
        'LicenseType': 'Basic'|'Plus'|'Pro'|'ProTrial',
        'UserType': 'PrivateUser'|'SharedDevice',
        'UserRegistrationStatus': 'Unregistered'|'Registered'|'Suspended',
        'UserInvitationStatus': 'Pending'|'Accepted'|'Failed',
        'RegisteredOn': datetime(2015, 1, 1),
        'InvitedOn': datetime(2015, 1, 1),
        'AlexaForBusinessMetadata': {
            'IsAlexaForBusinessEnabled': True|False,
            'AlexaForBusinessRoomArn': 'string'
        },
        '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.
  - PrimaryProvisionedNumber (string) --
    
    The primary phone number associated with the user.
  - DisplayName (string) --
    
    The display name of the user.
  - LicenseType (string) --
    
    The license type for the user.
  - UserType (string) --
    
    The user type.
  - 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.
  - AlexaForBusinessMetadata (dict) --
    
    The Alexa for Business metadata.
    - IsAlexaForBusinessEnabled (boolean) --
      
      Starts or stops Alexa for Business.
    - AlexaForBusinessRoomArn (string) --
      
      The ARN of the room resource.
  - PersonalPIN (string) --
    
    The user's personal meeting PIN.