Chime / Client / get_account_settings

get_account_settings#

Chime.Client.get_account_settings(**kwargs)#

Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dialout 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

response = client.get_account_settings(
    AccountId='string'
)
Parameters:

AccountId (string) –

[REQUIRED]

The Amazon Chime account ID.

Return type:

dict

Returns:

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.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException

  • Chime.Client.exceptions.NotFoundException

  • Chime.Client.exceptions.BadRequestException

  • Chime.Client.exceptions.ForbiddenException

  • Chime.Client.exceptions.ThrottledClientException

  • Chime.Client.exceptions.ServiceUnavailableException

  • Chime.Client.exceptions.ServiceFailureException