AWS API Changes

2021/07/16 - Amazon Chime - 4 updated api methods

Changes This SDK release adds Account Status as one of the attributes in Account API response

CreateAccount (updated)

Link ¶
Changes (response)

{'Account': {'AccountStatus': 'Suspended | Active'}}

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',
        ],
        'AccountStatus': 'Suspended'|'Active',
        '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) --
  - AccountStatus (string) --
    
    The status of the account, Suspended or Active .
  - 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': {'AccountStatus': 'Suspended | Active'}}

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',
        ],
        'AccountStatus': 'Suspended'|'Active',
        '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) --
  - AccountStatus (string) --
    
    The status of the account, Suspended or Active .
  - 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.

ListAccounts (updated)

Link ¶
Changes (response)

{'Accounts': {'AccountStatus': 'Suspended | Active'}}

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',
            ],
            'AccountStatus': 'Suspended'|'Active',
            '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) --
    - AccountStatus (string) --
      
      The status of the account, Suspended or Active .
    - 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.

UpdateAccount (updated)

Link ¶
Changes (response)

{'Account': {'AccountStatus': 'Suspended | Active'}}

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

See also: AWS API Documentation

Request Syntax

client.update_account(
    AccountId='string',
    Name='string',
    DefaultLicense='Basic'|'Plus'|'Pro'|'ProTrial'
)

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.

type DefaultLicense

string

param DefaultLicense

The default license applied when you add users to an 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',
        ],
        'AccountStatus': 'Suspended'|'Active',
        '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) --
  - AccountStatus (string) --
    
    The status of the account, Suspended or Active .
  - 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.