Chime ***** Client ====== class Chime.Client A low-level client representing Amazon Chime Warning: **Most of these APIs are no longer supported and will not be updated.** We recommend using the latest versions in the Amazon Chime SDK API reference, in the Amazon Chime SDK.Using the latest versions requires migrating to dedicated namespaces. For more information, refer to Migrating from the Amazon Chime namespace in the *Amazon Chime SDK Developer Guide*. The Amazon Chime application programming interface (API) is designed so administrators can perform key tasks, such as creating and managing Amazon Chime accounts, users, and Voice Connectors. This guide provides detailed information about the Amazon Chime API, including operations, types, inputs and outputs, and error codes. You can use an AWS SDK, the AWS Command Line Interface (AWS CLI), or the REST API to make API calls for Amazon Chime. We recommend using an AWS SDK or the AWS CLI. The page for each API action contains a *See Also* section that includes links to information about using the action with a language-specific AWS SDK or the AWS CLI. Using an AWS SDK You don't need to write code to calculate a signature for request authentication. The SDK clients authenticate your requests by using access keys that you provide. For more information about AWS SDKs, see the AWS Developer Center. Using the AWS CLI Use your access keys with the AWS CLI to make API calls. For information about setting up the AWS CLI, see Installing the AWS Command Line Interface in the *AWS Command Line Interface User Guide*. For a list of available Amazon Chime commands, see the Amazon Chime commands in the *AWS CLI Command Reference*. Using REST APIs If you use REST to make API calls, you must authenticate your request by providing a signature. Amazon Chime supports Signature Version 4. For more information, see Signature Version 4 Signing Process in the *Amazon Web Services General Reference*. When making REST API calls, use the service name "chime" and REST endpoint "https://service.chime.aws.amazon.com". Administrative permissions are controlled using AWS Identity and Access Management (IAM). For more information, see Identity and Access Management for Amazon Chime in the *Amazon Chime Administration Guide*. import boto3 client = boto3.client('chime') These are the available methods: * associate_phone_number_with_user * associate_signin_delegate_groups_with_account * batch_create_room_membership * batch_delete_phone_number * batch_suspend_user * batch_unsuspend_user * batch_update_phone_number * batch_update_user * can_paginate * close * create_account * create_bot * create_meeting_dial_out * create_phone_number_order * create_room * create_room_membership * create_user * delete_account * delete_events_configuration * delete_phone_number * delete_room * delete_room_membership * disassociate_phone_number_from_user * disassociate_signin_delegate_groups_from_account * get_account * get_account_settings * get_bot * get_events_configuration * get_global_settings * get_paginator * get_phone_number * get_phone_number_order * get_phone_number_settings * get_retention_settings * get_room * get_user * get_user_settings * get_waiter * invite_users * list_accounts * list_bots * list_phone_number_orders * list_phone_numbers * list_room_memberships * list_rooms * list_supported_phone_number_countries * list_users * logout_user * put_events_configuration * put_retention_settings * redact_conversation_message * redact_room_message * regenerate_security_token * reset_personal_pin * restore_phone_number * search_available_phone_numbers * update_account * update_account_settings * update_bot * update_global_settings * update_phone_number * update_phone_number_settings * update_room * update_room_membership * update_user * update_user_settings Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * ListAccounts * ListUsers Chime / Paginator / ListUsers ListUsers ********* class Chime.Paginator.ListUsers paginator = client.get_paginator('list_users') paginate(**kwargs) Creates an iterator that will paginate through responses from "Chime.Client.list_users()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( AccountId='string', UserEmail='string', UserType='PrivateUser'|'SharedDevice', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **AccountId** (*string*) -- **[REQUIRED]** The Amazon Chime account ID. * **UserEmail** (*string*) -- Optional. The user email address used to filter results. Maximum 1. * **UserType** (*string*) -- The user type. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: 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' }, ], } **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. Chime / Paginator / ListAccounts ListAccounts ************ class Chime.Paginator.ListAccounts paginator = client.get_paginator('list_accounts') paginate(**kwargs) Creates an iterator that will paginate through responses from "Chime.Client.list_accounts()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( Name='string', UserEmail='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **Name** (*string*) -- Amazon Chime account name prefix with which to filter results. * **UserEmail** (*string*) -- User email address with which to filter results. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: 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' }, ] }, ], } **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. * **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. Chime / Client / list_phone_numbers list_phone_numbers ****************** Chime.Client.list_phone_numbers(**kwargs) Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, Amazon Chime Voice Connector, or Amazon Chime Voice Connector group. See also: AWS API Documentation **Request Syntax** response = client.list_phone_numbers( Status='AcquireInProgress'|'AcquireFailed'|'Unassigned'|'Assigned'|'ReleaseInProgress'|'DeleteInProgress'|'ReleaseFailed'|'DeleteFailed', ProductType='BusinessCalling'|'VoiceConnector'|'SipMediaApplicationDialIn', FilterName='AccountId'|'UserId'|'VoiceConnectorId'|'VoiceConnectorGroupId'|'SipRuleId', FilterValue='string', MaxResults=123, NextToken='string' ) Parameters: * **Status** (*string*) -- The phone number status. * **ProductType** (*string*) -- The phone number product type. * **FilterName** (*string*) -- The filter to use to limit the number of results. * **FilterValue** (*string*) -- The value to use for the filter. * **MaxResults** (*integer*) -- The maximum number of results to return in a single call. * **NextToken** (*string*) -- The token to use to retrieve the next page of results. Return type: dict Returns: **Response Syntax** { 'PhoneNumbers': [ { 'PhoneNumberId': 'string', 'E164PhoneNumber': 'string', 'Country': 'string', 'Type': 'Local'|'TollFree', 'ProductType': 'BusinessCalling'|'VoiceConnector'|'SipMediaApplicationDialIn', 'Status': 'AcquireInProgress'|'AcquireFailed'|'Unassigned'|'Assigned'|'ReleaseInProgress'|'DeleteInProgress'|'ReleaseFailed'|'DeleteFailed', 'Capabilities': { 'InboundCall': True|False, 'OutboundCall': True|False, 'InboundSMS': True|False, 'OutboundSMS': True|False, 'InboundMMS': True|False, 'OutboundMMS': True|False }, 'Associations': [ { 'Value': 'string', 'Name': 'AccountId'|'UserId'|'VoiceConnectorId'|'VoiceConnectorGroupId'|'SipRuleId', 'AssociatedTimestamp': datetime(2015, 1, 1) }, ], 'CallingName': 'string', 'CallingNameStatus': 'Unassigned'|'UpdateInProgress'|'UpdateSucceeded'|'UpdateFailed', 'CreatedTimestamp': datetime(2015, 1, 1), 'UpdatedTimestamp': datetime(2015, 1, 1), 'DeletionTimestamp': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **PhoneNumbers** *(list) --* The phone number details. * *(dict) --* A phone number used for Amazon Chime Business Calling or an Amazon Chime Voice Connector. * **PhoneNumberId** *(string) --* The phone number ID. * **E164PhoneNumber** *(string) --* The phone number, in E.164 format. * **Country** *(string) --* The phone number country. Format: ISO 3166-1 alpha-2. * **Type** *(string) --* The phone number type. * **ProductType** *(string) --* The phone number product type. * **Status** *(string) --* The phone number status. * **Capabilities** *(dict) --* The phone number capabilities. * **InboundCall** *(boolean) --* Allows or denies inbound calling for the specified phone number. * **OutboundCall** *(boolean) --* Allows or denies outbound calling for the specified phone number. * **InboundSMS** *(boolean) --* Allows or denies inbound SMS messaging for the specified phone number. * **OutboundSMS** *(boolean) --* Allows or denies outbound SMS messaging for the specified phone number. * **InboundMMS** *(boolean) --* Allows or denies inbound MMS messaging for the specified phone number. * **OutboundMMS** *(boolean) --* Allows or denies outbound MMS messaging for the specified phone number. * **Associations** *(list) --* The phone number associations. * *(dict) --* The phone number associations, such as Amazon Chime account ID, Amazon Chime user ID, Amazon Chime Voice Connector ID, or Amazon Chime Voice Connector group ID. * **Value** *(string) --* Contains the ID for the entity specified in Name. * **Name** *(string) --* Defines the association with an Amazon Chime account ID, user ID, Amazon Chime Voice Connector ID, or Amazon Chime Voice Connector group ID. * **AssociatedTimestamp** *(datetime) --* The timestamp of the phone number association, in ISO 8601 format. * **CallingName** *(string) --* The outbound calling name associated with the phone number. * **CallingNameStatus** *(string) --* The outbound calling name status. * **CreatedTimestamp** *(datetime) --* The phone number creation timestamp, in ISO 8601 format. * **UpdatedTimestamp** *(datetime) --* The updated phone number timestamp, in ISO 8601 format. * **DeletionTimestamp** *(datetime) --* The deleted phone number timestamp, in ISO 8601 format. * **NextToken** *(string) --* The token to use to retrieve the next page of results. **Exceptions** * "Chime.Client.exceptions.UnauthorizedClientException" * "Chime.Client.exceptions.ForbiddenException" * "Chime.Client.exceptions.BadRequestException" * "Chime.Client.exceptions.NotFoundException" * "Chime.Client.exceptions.ThrottledClientException" * "Chime.Client.exceptions.ServiceUnavailableException" * "Chime.Client.exceptions.ServiceFailureException" Chime / Client / update_room update_room *********** Chime.Client.update_room(**kwargs) Updates room details, such as the room name, for a room in an Amazon Chime Enterprise account. See also: AWS API Documentation **Request Syntax** response = client.update_room( AccountId='string', RoomId='string', Name='string' ) Parameters: * **AccountId** (*string*) -- **[REQUIRED]** The Amazon Chime account ID. * **RoomId** (*string*) -- **[REQUIRED]** The room ID. * **Name** (*string*) -- The room name. Return type: dict Returns: **Response Syntax** { 'Room': { 'RoomId': 'string', 'Name': 'string', 'AccountId': 'string', 'CreatedBy': 'string', 'CreatedTimestamp': datetime(2015, 1, 1), 'UpdatedTimestamp': datetime(2015, 1, 1) } } **Response Structure** * *(dict) --* * **Room** *(dict) --* The room details. * **RoomId** *(string) --* The room ID. * **Name** *(string) --* The room name. * **AccountId** *(string) --* The Amazon Chime account ID. * **CreatedBy** *(string) --* The identifier of the room creator. * **CreatedTimestamp** *(datetime) --* The room creation timestamp, in ISO 8601 format. * **UpdatedTimestamp** *(datetime) --* The room update timestamp, in ISO 8601 format. **Exceptions** * "Chime.Client.exceptions.BadRequestException" * "Chime.Client.exceptions.ForbiddenException" * "Chime.Client.exceptions.NotFoundException" * "Chime.Client.exceptions.UnauthorizedClientException" * "Chime.Client.exceptions.ThrottledClientException" * "Chime.Client.exceptions.ServiceUnavailableException" * "Chime.Client.exceptions.ServiceFailureException" Chime / Client / disassociate_phone_number_from_user disassociate_phone_number_from_user *********************************** Chime.Client.disassociate_phone_number_from_user(**kwargs) Disassociates the primary provisioned phone number from the specified Amazon Chime user. See also: AWS API Documentation **Request Syntax** response = client.disassociate_phone_number_from_user( AccountId='string', UserId='string' ) Parameters: * **AccountId** (*string*) -- **[REQUIRED]** The Amazon Chime account ID. * **UserId** (*string*) -- **[REQUIRED]** The user ID. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Chime.Client.exceptions.UnauthorizedClientException" * "Chime.Client.exceptions.NotFoundException" * "Chime.Client.exceptions.ForbiddenException" * "Chime.Client.exceptions.BadRequestException" * "Chime.Client.exceptions.ThrottledClientException" * "Chime.Client.exceptions.ServiceUnavailableException" * "Chime.Client.exceptions.ServiceFailureException" Chime / Client / get_events_configuration get_events_configuration ************************ Chime.Client.get_events_configuration(**kwargs) Gets details for an events configuration that allows a bot to receive outgoing events, such as an HTTPS endpoint or Lambda function ARN. See also: AWS API Documentation **Request Syntax** response = client.get_events_configuration( AccountId='string', BotId='string' ) Parameters: * **AccountId** (*string*) -- **[REQUIRED]** The Amazon Chime account ID. * **BotId** (*string*) -- **[REQUIRED]** The bot ID. Return type: dict Returns: **Response Syntax** { 'EventsConfiguration': { 'BotId': 'string', 'OutboundEventsHTTPSEndpoint': 'string', 'LambdaFunctionArn': 'string' } } **Response Structure** * *(dict) --* * **EventsConfiguration** *(dict) --* The events configuration details. * **BotId** *(string) --* The bot ID. * **OutboundEventsHTTPSEndpoint** *(string) --* HTTPS endpoint that allows a bot to receive outgoing events. * **LambdaFunctionArn** *(string) --* Lambda function ARN that allows a bot to receive outgoing events. **Exceptions** * "Chime.Client.exceptions.ServiceUnavailableException" * "Chime.Client.exceptions.ServiceFailureException" * "Chime.Client.exceptions.ForbiddenException" * "Chime.Client.exceptions.BadRequestException" * "Chime.Client.exceptions.UnauthorizedClientException" * "Chime.Client.exceptions.ResourceLimitExceededException" * "Chime.Client.exceptions.NotFoundException" Chime / Client / get_paginator get_paginator ************* Chime.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. Chime / Client / search_available_phone_numbers search_available_phone_numbers ****************************** Chime.Client.search_available_phone_numbers(**kwargs) Searches for phone numbers that can be ordered. For US numbers, provide at least one of the following search filters: "AreaCode", "City", "State", or "TollFreePrefix". If you provide "City", you must also provide "State". Numbers outside the US only support the "PhoneNumberType" filter, which you must use. See also: AWS API Documentation **Request Syntax** response = client.search_available_phone_numbers( AreaCode='string', City='string', Country='string', State='string', TollFreePrefix='string', PhoneNumberType='Local'|'TollFree', MaxResults=123, NextToken='string' ) Parameters: * **AreaCode** (*string*) -- The area code used to filter results. Only applies to the US. * **City** (*string*) -- The city used to filter results. Only applies to the US. * **Country** (*string*) -- The country used to filter results. Defaults to the US Format: ISO 3166-1 alpha-2. * **State** (*string*) -- The state used to filter results. Required only if you provide "City". Only applies to the US. * **TollFreePrefix** (*string*) -- The toll-free prefix that you use to filter results. Only applies to the US. * **PhoneNumberType** (*string*) -- The phone number type used to filter results. Required for non-US numbers. * **MaxResults** (*integer*) -- The maximum number of results to return in a single call. * **NextToken** (*string*) -- The token used to retrieve the next page of results. Return type: dict Returns: **Response Syntax** { 'E164PhoneNumbers': [ 'string', ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **E164PhoneNumbers** *(list) --* List of phone numbers, in E.164 format. * *(string) --* * **NextToken** *(string) --* The token used to retrieve the next page of search results. **Exceptions** * "Chime.Client.exceptions.BadRequestException" * "Chime.Client.exceptions.ForbiddenException" * "Chime.Client.exceptions.AccessDeniedException" * "Chime.Client.exceptions.UnauthorizedClientException" * "Chime.Client.exceptions.ThrottledClientException" * "Chime.Client.exceptions.ServiceUnavailableException" * "Chime.Client.exceptions.ServiceFailureException" Chime / Client / get_user get_user ******** Chime.Client.get_user(**kwargs) 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** response = client.get_user( AccountId='string', UserId='string' ) Parameters: * **AccountId** (*string*) -- **[REQUIRED]** The Amazon Chime account ID. * **UserId** (*string*) -- **[REQUIRED]** The user ID. Return type: 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. **Exceptions** * "Chime.Client.exceptions.UnauthorizedClientException" * "Chime.Client.exceptions.NotFoundException" * "Chime.Client.exceptions.ForbiddenException" * "Chime.Client.exceptions.BadRequestException" * "Chime.Client.exceptions.ThrottledClientException" * "Chime.Client.exceptions.ServiceUnavailableException" * "Chime.Client.exceptions.ServiceFailureException" Chime / Client / update_account update_account ************** Chime.Client.update_account(**kwargs) 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** response = client.update_account( AccountId='string', Name='string', DefaultLicense='Basic'|'Plus'|'Pro'|'ProTrial' ) Parameters: * **AccountId** (*string*) -- **[REQUIRED]** The Amazon Chime account ID. * **Name** (*string*) -- The new name for the specified Amazon Chime account. * **DefaultLicense** (*string*) -- The default license applied when you add users to an Amazon Chime account. Return type: 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. * **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. **Exceptions** * "Chime.Client.exceptions.UnauthorizedClientException" * "Chime.Client.exceptions.NotFoundException" * "Chime.Client.exceptions.ForbiddenException" * "Chime.Client.exceptions.BadRequestException" * "Chime.Client.exceptions.ThrottledClientException" * "Chime.Client.exceptions.ServiceUnavailableException" * "Chime.Client.exceptions.ServiceFailureException" Chime / Client / list_supported_phone_number_countries list_supported_phone_number_countries ************************************* Chime.Client.list_supported_phone_number_countries(**kwargs) Lists supported phone number countries. See also: AWS API Documentation **Request Syntax** response = client.list_supported_phone_number_countries( ProductType='BusinessCalling'|'VoiceConnector'|'SipMediaApplicationDialIn' ) Parameters: **ProductType** (*string*) -- **[REQUIRED]** The phone number product type. Return type: dict Returns: **Response Syntax** { 'PhoneNumberCountries': [ { 'CountryCode': 'string', 'SupportedPhoneNumberTypes': [ 'Local'|'TollFree', ] }, ] } **Response Structure** * *(dict) --* * **PhoneNumberCountries** *(list) --* The supported phone number countries. * *(dict) --* The phone number country. * **CountryCode** *(string) --* The phone number country code. Format: ISO 3166-1 alpha-2. * **SupportedPhoneNumberTypes** *(list) --* The supported phone number types. * *(string) --* **Exceptions** * "Chime.Client.exceptions.BadRequestException" * "Chime.Client.exceptions.ForbiddenException" * "Chime.Client.exceptions.AccessDeniedException" * "Chime.Client.exceptions.UnauthorizedClientException" * "Chime.Client.exceptions.ThrottledClientException" * "Chime.Client.exceptions.ServiceUnavailableException" * "Chime.Client.exceptions.ServiceFailureException" Chime / Client / list_rooms list_rooms ********** Chime.Client.list_rooms(**kwargs) Lists the room details for the specified Amazon Chime Enterprise account. Optionally, filter the results by a member ID (user ID or bot ID) to see a list of rooms that the member belongs to. See also: AWS API Documentation **Request Syntax** response = client.list_rooms( AccountId='string', MemberId='string', MaxResults=123, NextToken='string' ) Parameters: * **AccountId** (*string*) -- **[REQUIRED]** The Amazon Chime account ID. * **MemberId** (*string*) -- The member ID (user ID or bot ID). * **MaxResults** (*integer*) -- The maximum number of results to return in a single call. * **NextToken** (*string*) -- The token to use to retrieve the next page of results. Return type: dict Returns: **Response Syntax** { 'Rooms': [ { 'RoomId': 'string', 'Name': 'string', 'AccountId': 'string', 'CreatedBy': 'string', 'CreatedTimestamp': datetime(2015, 1, 1), 'UpdatedTimestamp': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **Rooms** *(list) --* The room details. * *(dict) --* The Amazon Chime chat room details. * **RoomId** *(string) --* The room ID. * **Name** *(string) --* The room name. * **AccountId** *(string) --* The Amazon Chime account ID. * **CreatedBy** *(string) --* The identifier of the room creator. * **CreatedTimestamp** *(datetime) --* The room creation timestamp, in ISO 8601 format. * **UpdatedTimestamp** *(datetime) --* The room update timestamp, in ISO 8601 format. * **NextToken** *(string) --* The token to use to retrieve the next page of results. **Exceptions** * "Chime.Client.exceptions.NotFoundException" * "Chime.Client.exceptions.BadRequestException" * "Chime.Client.exceptions.ForbiddenException" * "Chime.Client.exceptions.UnauthorizedClientException" * "Chime.Client.exceptions.ThrottledClientException" * "Chime.Client.exceptions.ServiceUnavailableException" * "Chime.Client.exceptions.ServiceFailureException" Chime / Client / can_paginate can_paginate ************ Chime.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Returns: "True" if the operation can be paginated, "False" otherwise. Chime / Client / list_room_memberships list_room_memberships ********************* Chime.Client.list_room_memberships(**kwargs) Lists the membership details for the specified room in an Amazon Chime Enterprise account, such as the members' IDs, email addresses, and names. See also: AWS API Documentation **Request Syntax** response = client.list_room_memberships( AccountId='string', RoomId='string', MaxResults=123, NextToken='string' ) Parameters: * **AccountId** (*string*) -- **[REQUIRED]** The Amazon Chime account ID. * **RoomId** (*string*) -- **[REQUIRED]** The room ID. * **MaxResults** (*integer*) -- The maximum number of results to return in a single call. * **NextToken** (*string*) -- The token to use to retrieve the next page of results. Return type: dict Returns: **Response Syntax** { 'RoomMemberships': [ { 'RoomId': 'string', 'Member': { 'MemberId': 'string', 'MemberType': 'User'|'Bot'|'Webhook', 'Email': 'string', 'FullName': 'string', 'AccountId': 'string' }, 'Role': 'Administrator'|'Member', 'InvitedBy': 'string', 'UpdatedTimestamp': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **RoomMemberships** *(list) --* The room membership details. * *(dict) --* The room membership details. * **RoomId** *(string) --* The room ID. * **Member** *(dict) --* The member details, such as email address, name, member ID, and member type. * **MemberId** *(string) --* The member ID (user ID or bot ID). * **MemberType** *(string) --* The member type. * **Email** *(string) --* The member email address. * **FullName** *(string) --* The member name. * **AccountId** *(string) --* The Amazon Chime account ID. * **Role** *(string) --* The membership role. * **InvitedBy** *(string) --* The identifier of the user that invited the room member. * **UpdatedTimestamp** *(datetime) --* The room membership update timestamp, in ISO 8601 format. * **NextToken** *(string) --* The token to use to retrieve the next page of results. **Exceptions** * "Chime.Client.exceptions.NotFoundException" * "Chime.Client.exceptions.BadRequestException" * "Chime.Client.exceptions.ForbiddenException" * "Chime.Client.exceptions.UnauthorizedClientException" * "Chime.Client.exceptions.ThrottledClientException" * "Chime.Client.exceptions.ServiceUnavailableException" * "Chime.Client.exceptions.ServiceFailureException" Chime / Client / batch_update_user batch_update_user ***************** Chime.Client.batch_update_user(**kwargs) 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** response = client.batch_update_user( AccountId='string', UpdateUserRequestItems=[ { 'UserId': 'string', 'LicenseType': 'Basic'|'Plus'|'Pro'|'ProTrial', 'UserType': 'PrivateUser'|'SharedDevice', 'AlexaForBusinessMetadata': { 'IsAlexaForBusinessEnabled': True|False, 'AlexaForBusinessRoomArn': 'string' } }, ] ) Parameters: * **AccountId** (*string*) -- **[REQUIRED]** The Amazon Chime account ID. * **UpdateUserRequestItems** (*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. * **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. Return type: dict Returns: **Response Syntax** { 'UserErrors': [ { 'UserId': 'string', 'ErrorCode': 'BadRequest'|'Conflict'|'Forbidden'|'NotFound'|'PreconditionFailed'|'ResourceLimitExceeded'|'ServiceFailure'|'AccessDenied'|'ServiceUnavailable'|'Throttled'|'Throttling'|'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. **Exceptions** * "Chime.Client.exceptions.UnauthorizedClientException" * "Chime.Client.exceptions.NotFoundException" * "Chime.Client.exceptions.ForbiddenException" * "Chime.Client.exceptions.BadRequestException" * "Chime.Client.exceptions.ThrottledClientException" * "Chime.Client.exceptions.ServiceUnavailableException" * "Chime.Client.exceptions.ServiceFailureException" Chime / Client / list_phone_number_orders list_phone_number_orders ************************ Chime.Client.list_phone_number_orders(**kwargs) Lists the phone number orders for the administrator's Amazon Chime account. See also: AWS API Documentation **Request Syntax** response = client.list_phone_number_orders( NextToken='string', MaxResults=123 ) Parameters: * **NextToken** (*string*) -- The token to use to retrieve the next page of results. * **MaxResults** (*integer*) -- The maximum number of results to return in a single call. Return type: dict Returns: **Response Syntax** { 'PhoneNumberOrders': [ { 'PhoneNumberOrderId': 'string', 'ProductType': 'BusinessCalling'|'VoiceConnector'|'SipMediaApplicationDialIn', 'Status': 'Processing'|'Successful'|'Failed'|'Partial', 'OrderedPhoneNumbers': [ { 'E164PhoneNumber': 'string', 'Status': 'Processing'|'Acquired'|'Failed' }, ], 'CreatedTimestamp': datetime(2015, 1, 1), 'UpdatedTimestamp': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **PhoneNumberOrders** *(list) --* The phone number order details. * *(dict) --* The details of a phone number order created for Amazon Chime. * **PhoneNumberOrderId** *(string) --* The phone number order ID. * **ProductType** *(string) --* The phone number order product type. * **Status** *(string) --* The status of the phone number order. * **OrderedPhoneNumbers** *(list) --* The ordered phone number details, such as the phone number in E.164 format and the phone number status. * *(dict) --* A phone number for which an order has been placed. * **E164PhoneNumber** *(string) --* The phone number, in E.164 format. * **Status** *(string) --* The phone number status. * **CreatedTimestamp** *(datetime) --* The phone number order creation time stamp, in ISO 8601 format. * **UpdatedTimestamp** *(datetime) --* The updated phone number order time stamp, in ISO 8601 format. * **NextToken** *(string) --* The token to use to retrieve the next page of results. **Exceptions** * "Chime.Client.exceptions.UnauthorizedClientException" * "Chime.Client.exceptions.ForbiddenException" * "Chime.Client.exceptions.BadRequestException" * "Chime.Client.exceptions.ThrottledClientException" * "Chime.Client.exceptions.ServiceUnavailableException" * "Chime.Client.exceptions.ServiceFailureException" Chime / Client / delete_phone_number delete_phone_number ******************* Chime.Client.delete_phone_number(**kwargs) Moves the specified phone number into the **Deletion queue**. A phone number must be disassociated from any users or Amazon Chime Voice Connectors before it can be deleted. Deleted phone numbers remain in the **Deletion queue** for 7 days before they are deleted permanently. See also: AWS API Documentation **Request Syntax** response = client.delete_phone_number( PhoneNumberId='string' ) Parameters: **PhoneNumberId** (*string*) -- **[REQUIRED]** The phone number ID. Returns: None **Exceptions** * "Chime.Client.exceptions.UnauthorizedClientException" * "Chime.Client.exceptions.NotFoundException" * "Chime.Client.exceptions.ForbiddenException" * "Chime.Client.exceptions.BadRequestException" * "Chime.Client.exceptions.ThrottledClientException" * "Chime.Client.exceptions.ServiceUnavailableException" * "Chime.Client.exceptions.ServiceFailureException" Chime / Client / get_phone_number_order get_phone_number_order ********************** Chime.Client.get_phone_number_order(**kwargs) Retrieves details for the specified phone number order, such as the order creation timestamp, phone numbers in E.164 format, product type, and order status. See also: AWS API Documentation **Request Syntax** response = client.get_phone_number_order( PhoneNumberOrderId='string' ) Parameters: **PhoneNumberOrderId** (*string*) -- **[REQUIRED]** The ID for the phone number order. Return type: dict Returns: **Response Syntax** { 'PhoneNumberOrder': { 'PhoneNumberOrderId': 'string', 'ProductType': 'BusinessCalling'|'VoiceConnector'|'SipMediaApplicationDialIn', 'Status': 'Processing'|'Successful'|'Failed'|'Partial', 'OrderedPhoneNumbers': [ { 'E164PhoneNumber': 'string', 'Status': 'Processing'|'Acquired'|'Failed' }, ], 'CreatedTimestamp': datetime(2015, 1, 1), 'UpdatedTimestamp': datetime(2015, 1, 1) } } **Response Structure** * *(dict) --* * **PhoneNumberOrder** *(dict) --* The phone number order details. * **PhoneNumberOrderId** *(string) --* The phone number order ID. * **ProductType** *(string) --* The phone number order product type. * **Status** *(string) --* The status of the phone number order. * **OrderedPhoneNumbers** *(list) --* The ordered phone number details, such as the phone number in E.164 format and the phone number status. * *(dict) --* A phone number for which an order has been placed. * **E164PhoneNumber** *(string) --* The phone number, in E.164 format. * **Status** *(string) --* The phone number status. * **CreatedTimestamp** *(datetime) --* The phone number order creation time stamp, in ISO 8601 format. * **UpdatedTimestamp** *(datetime) --* The updated phone number order time stamp, in ISO 8601 format. **Exceptions** * "Chime.Client.exceptions.UnauthorizedClientException" * "Chime.Client.exceptions.NotFoundException" * "Chime.Client.exceptions.ForbiddenException" * "Chime.Client.exceptions.BadRequestException" * "Chime.Client.exceptions.ThrottledClientException" * "Chime.Client.exceptions.ServiceUnavailableException" * "Chime.Client.exceptions.ServiceFailureException" Chime / Client / get_room get_room ******** Chime.Client.get_room(**kwargs) Retrieves room details, such as the room name, for a room in an Amazon Chime Enterprise account. See also: AWS API Documentation **Request Syntax** response = client.get_room( AccountId='string', RoomId='string' ) Parameters: * **AccountId** (*string*) -- **[REQUIRED]** The Amazon Chime account ID. * **RoomId** (*string*) -- **[REQUIRED]** The room ID. Return type: dict Returns: **Response Syntax** { 'Room': { 'RoomId': 'string', 'Name': 'string', 'AccountId': 'string', 'CreatedBy': 'string', 'CreatedTimestamp': datetime(2015, 1, 1), 'UpdatedTimestamp': datetime(2015, 1, 1) } } **Response Structure** * *(dict) --* * **Room** *(dict) --* The room details. * **RoomId** *(string) --* The room ID. * **Name** *(string) --* The room name. * **AccountId** *(string) --* The Amazon Chime account ID. * **CreatedBy** *(string) --* The identifier of the room creator. * **CreatedTimestamp** *(datetime) --* The room creation timestamp, in ISO 8601 format. * **UpdatedTimestamp** *(datetime) --* The room update timestamp, in ISO 8601 format. **Exceptions** * "Chime.Client.exceptions.BadRequestException" * "Chime.Client.exceptions.ForbiddenException" * "Chime.Client.exceptions.NotFoundException" * "Chime.Client.exceptions.UnauthorizedClientException" * "Chime.Client.exceptions.ThrottledClientException" * "Chime.Client.exceptions.ServiceUnavailableException" * "Chime.Client.exceptions.ServiceFailureException" Chime / Client / batch_create_room_membership batch_create_room_membership **************************** Chime.Client.batch_create_room_membership(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.batch_create_room_membership( AccountId='string', RoomId='string', MembershipItemList=[ { 'MemberId': 'string', 'Role': 'Administrator'|'Member' }, ] ) Parameters: * **AccountId** (*string*) -- **[REQUIRED]** The Amazon Chime account ID. * **RoomId** (*string*) -- **[REQUIRED]** The room ID. * **MembershipItemList** (*list*) -- **[REQUIRED]** The list of membership items. * *(dict) --* Membership details, such as member ID and member role. * **MemberId** *(string) --* The member ID. * **Role** *(string) --* The member role. Return type: dict Returns: **Response Syntax** { 'Errors': [ { 'MemberId': 'string', 'ErrorCode': 'BadRequest'|'Conflict'|'Forbidden'|'NotFound'|'PreconditionFailed'|'ResourceLimitExceeded'|'ServiceFailure'|'AccessDenied'|'ServiceUnavailable'|'Throttled'|'Throttling'|'Unauthorized'|'Unprocessable'|'VoiceConnectorGroupAssociationsExist'|'PhoneNumberAssociationsExist', 'ErrorMessage': 'string' }, ] } **Response Structure** * *(dict) --* * **Errors** *(list) --* If the action fails for one or more of the member IDs in the request, a list of the member IDs is returned, along with error codes and error messages. * *(dict) --* The list of errors returned when a member action results in an error. * **MemberId** *(string) --* The member ID. * **ErrorCode** *(string) --* The error code. * **ErrorMessage** *(string) --* The error message. **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" Chime / Client / update_room_membership update_room_membership ********************** Chime.Client.update_room_membership(**kwargs) Updates room membership details, such as the member role, for a room in an Amazon Chime Enterprise account. The member role designates whether the member is a chat room administrator or a general chat room member. The member role can be updated only for user IDs. See also: AWS API Documentation **Request Syntax** response = client.update_room_membership( AccountId='string', RoomId='string', MemberId='string', Role='Administrator'|'Member' ) Parameters: * **AccountId** (*string*) -- **[REQUIRED]** The Amazon Chime account ID. * **RoomId** (*string*) -- **[REQUIRED]** The room ID. * **MemberId** (*string*) -- **[REQUIRED]** The member ID. * **Role** (*string*) -- The role of the member. Return type: dict Returns: **Response Syntax** { 'RoomMembership': { 'RoomId': 'string', 'Member': { 'MemberId': 'string', 'MemberType': 'User'|'Bot'|'Webhook', 'Email': 'string', 'FullName': 'string', 'AccountId': 'string' }, 'Role': 'Administrator'|'Member', 'InvitedBy': 'string', 'UpdatedTimestamp': datetime(2015, 1, 1) } } **Response Structure** * *(dict) --* * **RoomMembership** *(dict) --* The room membership details. * **RoomId** *(string) --* The room ID. * **Member** *(dict) --* The member details, such as email address, name, member ID, and member type. * **MemberId** *(string) --* The member ID (user ID or bot ID). * **MemberType** *(string) --* The member type. * **Email** *(string) --* The member email address. * **FullName** *(string) --* The member name. * **AccountId** *(string) --* The Amazon Chime account ID. * **Role** *(string) --* The membership role. * **InvitedBy** *(string) --* The identifier of the user that invited the room member. * **UpdatedTimestamp** *(datetime) --* The room membership update timestamp, in ISO 8601 format. **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" Chime / Client / update_user_settings update_user_settings ******************** Chime.Client.update_user_settings(**kwargs) Updates the settings for the specified user, such as phone number settings. See also: AWS API Documentation **Request Syntax** response = client.update_user_settings( AccountId='string', UserId='string', UserSettings={ 'Telephony': { 'InboundCalling': True|False, 'OutboundCalling': True|False, 'SMS': True|False } } ) Parameters: * **AccountId** (*string*) -- **[REQUIRED]** The Amazon Chime account ID. * **UserId** (*string*) -- **[REQUIRED]** The user ID. * **UserSettings** (*dict*) -- **[REQUIRED]** The user settings to update. * **Telephony** *(dict) --* **[REQUIRED]** The telephony settings associated with the user. * **InboundCalling** *(boolean) --* **[REQUIRED]** Allows or denies inbound calling. * **OutboundCalling** *(boolean) --* **[REQUIRED]** Allows or denies outbound calling. * **SMS** *(boolean) --* **[REQUIRED]** Allows or denies SMS messaging. Returns: None **Exceptions** * "Chime.Client.exceptions.UnauthorizedClientException" * "Chime.Client.exceptions.NotFoundException" * "Chime.Client.exceptions.ForbiddenException" * "Chime.Client.exceptions.BadRequestException" * "Chime.Client.exceptions.ThrottledClientException" * "Chime.Client.exceptions.ServiceUnavailableException" * "Chime.Client.exceptions.ServiceFailureException" Chime / Client / update_user update_user *********** Chime.Client.update_user(**kwargs) Updates user details for a specified user ID. Currently, only "LicenseType" updates are supported for this action. See also: AWS API Documentation **Request Syntax** response = client.update_user( AccountId='string', UserId='string', LicenseType='Basic'|'Plus'|'Pro'|'ProTrial', UserType='PrivateUser'|'SharedDevice', AlexaForBusinessMetadata={ 'IsAlexaForBusinessEnabled': True|False, 'AlexaForBusinessRoomArn': 'string' } ) Parameters: * **AccountId** (*string*) -- **[REQUIRED]** The Amazon Chime account ID. * **UserId** (*string*) -- **[REQUIRED]** The user ID. * **LicenseType** (*string*) -- The user license type to update. This must be a supported license type for the Amazon Chime account that the user belongs to. * **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. Return type: 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. **Exceptions** * "Chime.Client.exceptions.UnauthorizedClientException" * "Chime.Client.exceptions.NotFoundException" * "Chime.Client.exceptions.ForbiddenException" * "Chime.Client.exceptions.BadRequestException" * "Chime.Client.exceptions.ThrottledClientException" * "Chime.Client.exceptions.ServiceUnavailableException" * "Chime.Client.exceptions.ServiceFailureException" Chime / Client / regenerate_security_token regenerate_security_token ************************* Chime.Client.regenerate_security_token(**kwargs) Regenerates the security token for a bot. See also: AWS API Documentation **Request Syntax** response = client.regenerate_security_token( AccountId='string', BotId='string' ) Parameters: * **AccountId** (*string*) -- **[REQUIRED]** The Amazon Chime account ID. * **BotId** (*string*) -- **[REQUIRED]** The bot ID. Return type: dict Returns: **Response Syntax** { 'Bot': { 'BotId': 'string', 'UserId': 'string', 'DisplayName': 'string', 'BotType': 'ChatBot', 'Disabled': True|False, 'CreatedTimestamp': datetime(2015, 1, 1), 'UpdatedTimestamp': datetime(2015, 1, 1), 'BotEmail': 'string', 'SecurityToken': 'string' } } **Response Structure** * *(dict) --* * **Bot** *(dict) --* A resource that allows Enterprise account administrators to configure an interface that receives events from Amazon Chime. * **BotId** *(string) --* The bot ID. * **UserId** *(string) --* The unique ID for the bot user. * **DisplayName** *(string) --* The bot display name. * **BotType** *(string) --* The bot type. * **Disabled** *(boolean) --* When true, the bot is stopped from running in your account. * **CreatedTimestamp** *(datetime) --* The bot creation timestamp, in ISO 8601 format. * **UpdatedTimestamp** *(datetime) --* The updated bot timestamp, in ISO 8601 format. * **BotEmail** *(string) --* The bot email address. * **SecurityToken** *(string) --* The security token used to authenticate Amazon Chime with the outgoing event endpoint. **Exceptions** * "Chime.Client.exceptions.ServiceUnavailableException" * "Chime.Client.exceptions.ServiceFailureException" * "Chime.Client.exceptions.ForbiddenException" * "Chime.Client.exceptions.BadRequestException" * "Chime.Client.exceptions.UnauthorizedClientException" * "Chime.Client.exceptions.NotFoundException" * "Chime.Client.exceptions.ThrottledClientException" 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" Chime / Client / redact_conversation_message redact_conversation_message *************************** Chime.Client.redact_conversation_message(**kwargs) Redacts the specified message from the specified Amazon Chime conversation. See also: AWS API Documentation **Request Syntax** response = client.redact_conversation_message( AccountId='string', ConversationId='string', MessageId='string' ) Parameters: * **AccountId** (*string*) -- **[REQUIRED]** The Amazon Chime account ID. * **ConversationId** (*string*) -- **[REQUIRED]** The conversation ID. * **MessageId** (*string*) -- **[REQUIRED]** The message ID. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Chime.Client.exceptions.NotFoundException" * "Chime.Client.exceptions.ForbiddenException" * "Chime.Client.exceptions.UnauthorizedClientException" * "Chime.Client.exceptions.ThrottledClientException" * "Chime.Client.exceptions.BadRequestException" * "Chime.Client.exceptions.ServiceUnavailableException" * "Chime.Client.exceptions.ServiceFailureException" Chime / Client / delete_room delete_room *********** Chime.Client.delete_room(**kwargs) Deletes a chat room in an Amazon Chime Enterprise account. See also: AWS API Documentation **Request Syntax** response = client.delete_room( AccountId='string', RoomId='string' ) Parameters: * **AccountId** (*string*) -- **[REQUIRED]** The Amazon Chime account ID. * **RoomId** (*string*) -- **[REQUIRED]** The chat room ID. Returns: None **Exceptions** * "Chime.Client.exceptions.BadRequestException" * "Chime.Client.exceptions.ForbiddenException" * "Chime.Client.exceptions.NotFoundException" * "Chime.Client.exceptions.UnauthorizedClientException" * "Chime.Client.exceptions.ThrottledClientException" * "Chime.Client.exceptions.ServiceUnavailableException" * "Chime.Client.exceptions.ServiceFailureException" Chime / Client / create_user create_user *********** Chime.Client.create_user(**kwargs) Creates a user under the specified Amazon Chime account. See also: AWS API Documentation **Request Syntax** response = client.create_user( AccountId='string', Username='string', Email='string', UserType='PrivateUser'|'SharedDevice' ) Parameters: * **AccountId** (*string*) -- **[REQUIRED]** The Amazon Chime account ID. * **Username** (*string*) -- The user name. * **Email** (*string*) -- The user's email address. * **UserType** (*string*) -- The user type. Return type: 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. **Exceptions** * "Chime.Client.exceptions.UnauthorizedClientException" * "Chime.Client.exceptions.NotFoundException" * "Chime.Client.exceptions.ConflictException" * "Chime.Client.exceptions.ForbiddenException" * "Chime.Client.exceptions.BadRequestException" * "Chime.Client.exceptions.ThrottledClientException" * "Chime.Client.exceptions.ServiceUnavailableException" * "Chime.Client.exceptions.ServiceFailureException" Chime / Client / update_account_settings update_account_settings *********************** Chime.Client.update_account_settings(**kwargs) 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** response = client.update_account_settings( AccountId='string', AccountSettings={ 'DisableRemoteControl': True|False, 'EnableDialOut': True|False } ) Parameters: * **AccountId** (*string*) -- **[REQUIRED]** The Amazon Chime account ID. * **AccountSettings** (*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. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Chime.Client.exceptions.UnauthorizedClientException" * "Chime.Client.exceptions.NotFoundException" * "Chime.Client.exceptions.BadRequestException" * "Chime.Client.exceptions.ForbiddenException" * "Chime.Client.exceptions.ConflictException" * "Chime.Client.exceptions.ThrottledClientException" * "Chime.Client.exceptions.ServiceUnavailableException" * "Chime.Client.exceptions.ServiceFailureException" Chime / Client / get_global_settings get_global_settings ******************* Chime.Client.get_global_settings() Retrieves global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings. See also: AWS API Documentation **Request Syntax** response = client.get_global_settings() Return type: dict Returns: **Response Syntax** { 'BusinessCalling': { 'CdrBucket': 'string' }, 'VoiceConnector': { 'CdrBucket': 'string' } } **Response Structure** * *(dict) --* * **BusinessCalling** *(dict) --* The Amazon Chime Business Calling settings. * **CdrBucket** *(string) --* The Amazon S3 bucket designated for call detail record storage. * **VoiceConnector** *(dict) --* The Amazon Chime Voice Connector settings. * **CdrBucket** *(string) --* The Amazon S3 bucket designated for call detail record storage. **Exceptions** * "Chime.Client.exceptions.UnauthorizedClientException" * "Chime.Client.exceptions.ForbiddenException" * "Chime.Client.exceptions.BadRequestException" * "Chime.Client.exceptions.ThrottledClientException" * "Chime.Client.exceptions.ServiceUnavailableException" * "Chime.Client.exceptions.ServiceFailureException" Chime / Client / create_bot create_bot ********** Chime.Client.create_bot(**kwargs) Creates a bot for an Amazon Chime Enterprise account. See also: AWS API Documentation **Request Syntax** response = client.create_bot( AccountId='string', DisplayName='string', Domain='string' ) Parameters: * **AccountId** (*string*) -- **[REQUIRED]** The Amazon Chime account ID. * **DisplayName** (*string*) -- **[REQUIRED]** The bot display name. * **Domain** (*string*) -- The domain of the Amazon Chime Enterprise account. Return type: dict Returns: **Response Syntax** { 'Bot': { 'BotId': 'string', 'UserId': 'string', 'DisplayName': 'string', 'BotType': 'ChatBot', 'Disabled': True|False, 'CreatedTimestamp': datetime(2015, 1, 1), 'UpdatedTimestamp': datetime(2015, 1, 1), 'BotEmail': 'string', 'SecurityToken': 'string' } } **Response Structure** * *(dict) --* * **Bot** *(dict) --* The bot details. * **BotId** *(string) --* The bot ID. * **UserId** *(string) --* The unique ID for the bot user. * **DisplayName** *(string) --* The bot display name. * **BotType** *(string) --* The bot type. * **Disabled** *(boolean) --* When true, the bot is stopped from running in your account. * **CreatedTimestamp** *(datetime) --* The bot creation timestamp, in ISO 8601 format. * **UpdatedTimestamp** *(datetime) --* The updated bot timestamp, in ISO 8601 format. * **BotEmail** *(string) --* The bot email address. * **SecurityToken** *(string) --* The security token used to authenticate Amazon Chime with the outgoing event endpoint. **Exceptions** * "Chime.Client.exceptions.ServiceUnavailableException" * "Chime.Client.exceptions.ServiceFailureException" * "Chime.Client.exceptions.ForbiddenException" * "Chime.Client.exceptions.BadRequestException" * "Chime.Client.exceptions.UnauthorizedClientException" * "Chime.Client.exceptions.ResourceLimitExceededException" * "Chime.Client.exceptions.NotFoundException" * "Chime.Client.exceptions.ThrottledClientException" Chime / Client / get_user_settings get_user_settings ***************** Chime.Client.get_user_settings(**kwargs) Retrieves settings for the specified user ID, such as any associated phone number settings. See also: AWS API Documentation **Request Syntax** response = client.get_user_settings( AccountId='string', UserId='string' ) Parameters: * **AccountId** (*string*) -- **[REQUIRED]** The Amazon Chime account ID. * **UserId** (*string*) -- **[REQUIRED]** The user ID. Return type: dict Returns: **Response Syntax** { 'UserSettings': { 'Telephony': { 'InboundCalling': True|False, 'OutboundCalling': True|False, 'SMS': True|False } } } **Response Structure** * *(dict) --* * **UserSettings** *(dict) --* The user settings. * **Telephony** *(dict) --* The telephony settings associated with the user. * **InboundCalling** *(boolean) --* Allows or denies inbound calling. * **OutboundCalling** *(boolean) --* Allows or denies outbound calling. * **SMS** *(boolean) --* Allows or denies SMS messaging. **Exceptions** * "Chime.Client.exceptions.UnauthorizedClientException" * "Chime.Client.exceptions.NotFoundException" * "Chime.Client.exceptions.ForbiddenException" * "Chime.Client.exceptions.BadRequestException" * "Chime.Client.exceptions.ThrottledClientException" * "Chime.Client.exceptions.ServiceUnavailableException" * "Chime.Client.exceptions.ServiceFailureException" Chime / Client / batch_suspend_user batch_suspend_user ****************** Chime.Client.batch_suspend_user(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.batch_suspend_user( AccountId='string', UserIdList=[ 'string', ] ) Parameters: * **AccountId** (*string*) -- **[REQUIRED]** The Amazon Chime account ID. * **UserIdList** (*list*) -- **[REQUIRED]** The request containing the user IDs to suspend. * *(string) --* Return type: dict Returns: **Response Syntax** { 'UserErrors': [ { 'UserId': 'string', 'ErrorCode': 'BadRequest'|'Conflict'|'Forbidden'|'NotFound'|'PreconditionFailed'|'ResourceLimitExceeded'|'ServiceFailure'|'AccessDenied'|'ServiceUnavailable'|'Throttled'|'Throttling'|'Unauthorized'|'Unprocessable'|'VoiceConnectorGroupAssociationsExist'|'PhoneNumberAssociationsExist', '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. **Exceptions** * "Chime.Client.exceptions.UnauthorizedClientException" * "Chime.Client.exceptions.NotFoundException" * "Chime.Client.exceptions.ForbiddenException" * "Chime.Client.exceptions.BadRequestException" * "Chime.Client.exceptions.ThrottledClientException" * "Chime.Client.exceptions.ServiceUnavailableException" * "Chime.Client.exceptions.ServiceFailureException" Chime / Client / batch_unsuspend_user batch_unsuspend_user ******************** Chime.Client.batch_unsuspend_user(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.batch_unsuspend_user( AccountId='string', UserIdList=[ 'string', ] ) Parameters: * **AccountId** (*string*) -- **[REQUIRED]** The Amazon Chime account ID. * **UserIdList** (*list*) -- **[REQUIRED]** The request containing the user IDs to unsuspend. * *(string) --* Return type: dict Returns: **Response Syntax** { 'UserErrors': [ { 'UserId': 'string', 'ErrorCode': 'BadRequest'|'Conflict'|'Forbidden'|'NotFound'|'PreconditionFailed'|'ResourceLimitExceeded'|'ServiceFailure'|'AccessDenied'|'ServiceUnavailable'|'Throttled'|'Throttling'|'Unauthorized'|'Unprocessable'|'VoiceConnectorGroupAssociationsExist'|'PhoneNumberAssociationsExist', '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. **Exceptions** * "Chime.Client.exceptions.UnauthorizedClientException" * "Chime.Client.exceptions.NotFoundException" * "Chime.Client.exceptions.ForbiddenException" * "Chime.Client.exceptions.BadRequestException" * "Chime.Client.exceptions.ThrottledClientException" * "Chime.Client.exceptions.ServiceUnavailableException" * "Chime.Client.exceptions.ServiceFailureException" Chime / Client / update_phone_number_settings update_phone_number_settings **************************** Chime.Client.update_phone_number_settings(**kwargs) Updates the phone number settings for the administrator's AWS account, such as the default outbound calling name. You can update the default outbound calling name once every seven days. Outbound calling names can take up to 72 hours to update. See also: AWS API Documentation **Request Syntax** response = client.update_phone_number_settings( CallingName='string' ) Parameters: **CallingName** (*string*) -- **[REQUIRED]** The default outbound calling name for the account. Returns: None **Exceptions** * "Chime.Client.exceptions.UnauthorizedClientException" * "Chime.Client.exceptions.ForbiddenException" * "Chime.Client.exceptions.BadRequestException" * "Chime.Client.exceptions.ThrottledClientException" * "Chime.Client.exceptions.ServiceUnavailableException" * "Chime.Client.exceptions.ServiceFailureException" Chime / Client / delete_room_membership delete_room_membership ********************** Chime.Client.delete_room_membership(**kwargs) Removes a member from a chat room in an Amazon Chime Enterprise account. See also: AWS API Documentation **Request Syntax** response = client.delete_room_membership( AccountId='string', RoomId='string', MemberId='string' ) Parameters: * **AccountId** (*string*) -- **[REQUIRED]** The Amazon Chime account ID. * **RoomId** (*string*) -- **[REQUIRED]** The room ID. * **MemberId** (*string*) -- **[REQUIRED]** The member ID (user ID or bot ID). Returns: None **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" Chime / Client / associate_signin_delegate_groups_with_account associate_signin_delegate_groups_with_account ********************************************* Chime.Client.associate_signin_delegate_groups_with_account(**kwargs) Associates the specified sign-in delegate groups with the specified Amazon Chime account. See also: AWS API Documentation **Request Syntax** response = client.associate_signin_delegate_groups_with_account( AccountId='string', SigninDelegateGroups=[ { 'GroupName': 'string' }, ] ) Parameters: * **AccountId** (*string*) -- **[REQUIRED]** The Amazon Chime account ID. * **SigninDelegateGroups** (*list*) -- **[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. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Chime.Client.exceptions.UnauthorizedClientException" * "Chime.Client.exceptions.NotFoundException" * "Chime.Client.exceptions.ForbiddenException" * "Chime.Client.exceptions.BadRequestException" * "Chime.Client.exceptions.ThrottledClientException" * "Chime.Client.exceptions.ServiceUnavailableException" * "Chime.Client.exceptions.ServiceFailureException" Chime / Client / update_global_settings update_global_settings ********************** Chime.Client.update_global_settings(**kwargs) Updates global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings. See also: AWS API Documentation **Request Syntax** response = client.update_global_settings( BusinessCalling={ 'CdrBucket': 'string' }, VoiceConnector={ 'CdrBucket': 'string' } ) Parameters: * **BusinessCalling** (*dict*) -- The Amazon Chime Business Calling settings. * **CdrBucket** *(string) --* The Amazon S3 bucket designated for call detail record storage. * **VoiceConnector** (*dict*) -- The Amazon Chime Voice Connector settings. * **CdrBucket** *(string) --* The Amazon S3 bucket designated for call detail record storage. Returns: None **Exceptions** * "Chime.Client.exceptions.UnauthorizedClientException" * "Chime.Client.exceptions.ForbiddenException" * "Chime.Client.exceptions.BadRequestException" * "Chime.Client.exceptions.ThrottledClientException" * "Chime.Client.exceptions.ServiceUnavailableException" * "Chime.Client.exceptions.ServiceFailureException" Chime / Client / delete_account delete_account ************** Chime.Client.delete_account(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.delete_account( AccountId='string' ) Parameters: **AccountId** (*string*) -- **[REQUIRED]** The Amazon Chime account ID. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Chime.Client.exceptions.UnauthorizedClientException" * "Chime.Client.exceptions.NotFoundException" * "Chime.Client.exceptions.ForbiddenException" * "Chime.Client.exceptions.BadRequestException" * "Chime.Client.exceptions.ThrottledClientException" * "Chime.Client.exceptions.UnprocessableEntityException" * "Chime.Client.exceptions.ServiceUnavailableException" * "Chime.Client.exceptions.ServiceFailureException" Chime / Client / get_waiter get_waiter ********** Chime.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" Chime / Client / create_room create_room *********** Chime.Client.create_room(**kwargs) Creates a chat room for the specified Amazon Chime Enterprise account. See also: AWS API Documentation **Request Syntax** response = client.create_room( AccountId='string', Name='string', ClientRequestToken='string' ) Parameters: * **AccountId** (*string*) -- **[REQUIRED]** The Amazon Chime account ID. * **Name** (*string*) -- **[REQUIRED]** The room name. * **ClientRequestToken** (*string*) -- The idempotency token for the request. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'Room': { 'RoomId': 'string', 'Name': 'string', 'AccountId': 'string', 'CreatedBy': 'string', 'CreatedTimestamp': datetime(2015, 1, 1), 'UpdatedTimestamp': datetime(2015, 1, 1) } } **Response Structure** * *(dict) --* * **Room** *(dict) --* The room details. * **RoomId** *(string) --* The room ID. * **Name** *(string) --* The room name. * **AccountId** *(string) --* The Amazon Chime account ID. * **CreatedBy** *(string) --* The identifier of the room creator. * **CreatedTimestamp** *(datetime) --* The room creation timestamp, in ISO 8601 format. * **UpdatedTimestamp** *(datetime) --* The room update timestamp, in ISO 8601 format. **Exceptions** * "Chime.Client.exceptions.NotFoundException" * "Chime.Client.exceptions.BadRequestException" * "Chime.Client.exceptions.ForbiddenException" * "Chime.Client.exceptions.UnauthorizedClientException" * "Chime.Client.exceptions.ResourceLimitExceededException" * "Chime.Client.exceptions.ThrottledClientException" * "Chime.Client.exceptions.ServiceUnavailableException" * "Chime.Client.exceptions.ServiceFailureException" Chime / Client / create_room_membership create_room_membership ********************** Chime.Client.create_room_membership(**kwargs) Adds a member to a chat room in an Amazon Chime Enterprise account. A member can be either a user or a bot. The member role designates whether the member is a chat room administrator or a general chat room member. See also: AWS API Documentation **Request Syntax** response = client.create_room_membership( AccountId='string', RoomId='string', MemberId='string', Role='Administrator'|'Member' ) Parameters: * **AccountId** (*string*) -- **[REQUIRED]** The Amazon Chime account ID. * **RoomId** (*string*) -- **[REQUIRED]** The room ID. * **MemberId** (*string*) -- **[REQUIRED]** The Amazon Chime member ID (user ID or bot ID). * **Role** (*string*) -- The role of the member. Return type: dict Returns: **Response Syntax** { 'RoomMembership': { 'RoomId': 'string', 'Member': { 'MemberId': 'string', 'MemberType': 'User'|'Bot'|'Webhook', 'Email': 'string', 'FullName': 'string', 'AccountId': 'string' }, 'Role': 'Administrator'|'Member', 'InvitedBy': 'string', 'UpdatedTimestamp': datetime(2015, 1, 1) } } **Response Structure** * *(dict) --* * **RoomMembership** *(dict) --* The room membership details. * **RoomId** *(string) --* The room ID. * **Member** *(dict) --* The member details, such as email address, name, member ID, and member type. * **MemberId** *(string) --* The member ID (user ID or bot ID). * **MemberType** *(string) --* The member type. * **Email** *(string) --* The member email address. * **FullName** *(string) --* The member name. * **AccountId** *(string) --* The Amazon Chime account ID. * **Role** *(string) --* The membership role. * **InvitedBy** *(string) --* The identifier of the user that invited the room member. * **UpdatedTimestamp** *(datetime) --* The room membership update timestamp, in ISO 8601 format. **Exceptions** * "Chime.Client.exceptions.ConflictException" * "Chime.Client.exceptions.UnauthorizedClientException" * "Chime.Client.exceptions.NotFoundException" * "Chime.Client.exceptions.BadRequestException" * "Chime.Client.exceptions.ForbiddenException" * "Chime.Client.exceptions.ResourceLimitExceededException" * "Chime.Client.exceptions.ThrottledClientException" * "Chime.Client.exceptions.ServiceUnavailableException" * "Chime.Client.exceptions.ServiceFailureException" Chime / Client / batch_update_phone_number batch_update_phone_number ************************* Chime.Client.batch_update_phone_number(**kwargs) Updates phone number product types or calling names. You can update one attribute at a time for each "UpdatePhoneNumberRequestItem". For example, you can update the product type or the calling name. For toll-free numbers, you cannot use the Amazon Chime Business Calling product type. For numbers outside the U.S., you must use the Amazon Chime SIP Media Application Dial-In product type. Updates to outbound calling names can take up to 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update. See also: AWS API Documentation **Request Syntax** response = client.batch_update_phone_number( UpdatePhoneNumberRequestItems=[ { 'PhoneNumberId': 'string', 'ProductType': 'BusinessCalling'|'VoiceConnector'|'SipMediaApplicationDialIn', 'CallingName': 'string' }, ] ) Parameters: **UpdatePhoneNumberRequestItems** (*list*) -- **[REQUIRED]** The request containing the phone number IDs and product types or calling names to update. * *(dict) --* The phone number ID, product type, or calling name fields to update, used with the BatchUpdatePhoneNumber and UpdatePhoneNumber actions. * **PhoneNumberId** *(string) --* **[REQUIRED]** The phone number ID to update. * **ProductType** *(string) --* The product type to update. * **CallingName** *(string) --* The outbound calling name to update. Return type: dict Returns: **Response Syntax** { 'PhoneNumberErrors': [ { 'PhoneNumberId': 'string', 'ErrorCode': 'BadRequest'|'Conflict'|'Forbidden'|'NotFound'|'PreconditionFailed'|'ResourceLimitExceeded'|'ServiceFailure'|'AccessDenied'|'ServiceUnavailable'|'Throttled'|'Throttling'|'Unauthorized'|'Unprocessable'|'VoiceConnectorGroupAssociationsExist'|'PhoneNumberAssociationsExist', 'ErrorMessage': 'string' }, ] } **Response Structure** * *(dict) --* * **PhoneNumberErrors** *(list) --* If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages. * *(dict) --* If the phone number action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages. * **PhoneNumberId** *(string) --* The phone number ID for which the action failed. * **ErrorCode** *(string) --* The error code. * **ErrorMessage** *(string) --* The error message. **Exceptions** * "Chime.Client.exceptions.UnauthorizedClientException" * "Chime.Client.exceptions.NotFoundException" * "Chime.Client.exceptions.ForbiddenException" * "Chime.Client.exceptions.BadRequestException" * "Chime.Client.exceptions.ThrottledClientException" * "Chime.Client.exceptions.ServiceUnavailableException" * "Chime.Client.exceptions.ServiceFailureException" Chime / Client / list_users list_users ********** Chime.Client.list_users(**kwargs) 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** response = client.list_users( AccountId='string', UserEmail='string', UserType='PrivateUser'|'SharedDevice', MaxResults=123, NextToken='string' ) Parameters: * **AccountId** (*string*) -- **[REQUIRED]** The Amazon Chime account ID. * **UserEmail** (*string*) -- Optional. The user email address used to filter results. Maximum 1. * **UserType** (*string*) -- The user type. * **MaxResults** (*integer*) -- The maximum number of results to return in a single call. Defaults to 100. * **NextToken** (*string*) -- The token to use to retrieve the next page of results. Return type: 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. **Exceptions** * "Chime.Client.exceptions.UnauthorizedClientException" * "Chime.Client.exceptions.NotFoundException" * "Chime.Client.exceptions.ForbiddenException" * "Chime.Client.exceptions.BadRequestException" * "Chime.Client.exceptions.ThrottledClientException" * "Chime.Client.exceptions.ServiceUnavailableException" * "Chime.Client.exceptions.ServiceFailureException" Chime / Client / create_account create_account ************** Chime.Client.create_account(**kwargs) 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** response = client.create_account( Name='string' ) Parameters: **Name** (*string*) -- **[REQUIRED]** The name of the Amazon Chime account. Return type: 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. * **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. **Exceptions** * "Chime.Client.exceptions.UnauthorizedClientException" * "Chime.Client.exceptions.NotFoundException" * "Chime.Client.exceptions.ForbiddenException" * "Chime.Client.exceptions.BadRequestException" * "Chime.Client.exceptions.ThrottledClientException" * "Chime.Client.exceptions.ServiceUnavailableException" * "Chime.Client.exceptions.ServiceFailureException" Chime / Client / get_retention_settings get_retention_settings ********************** Chime.Client.get_retention_settings(**kwargs) Gets the retention settings for the specified Amazon Chime Enterprise account. For more information about retention settings, see Managing Chat Retention Policies in the *Amazon Chime Administration Guide*. See also: AWS API Documentation **Request Syntax** response = client.get_retention_settings( AccountId='string' ) Parameters: **AccountId** (*string*) -- **[REQUIRED]** The Amazon Chime account ID. Return type: dict Returns: **Response Syntax** { 'RetentionSettings': { 'RoomRetentionSettings': { 'RetentionDays': 123 }, 'ConversationRetentionSettings': { 'RetentionDays': 123 } }, 'InitiateDeletionTimestamp': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **RetentionSettings** *(dict) --* The retention settings. * **RoomRetentionSettings** *(dict) --* The chat room retention settings. * **RetentionDays** *(integer) --* The number of days for which to retain chat-room messages. * **ConversationRetentionSettings** *(dict) --* The chat conversation retention settings. * **RetentionDays** *(integer) --* The number of days for which to retain conversation messages. * **InitiateDeletionTimestamp** *(datetime) --* The timestamp representing the time at which the specified items are permanently deleted, in ISO 8601 format. **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" Chime / Client / update_bot update_bot ********** Chime.Client.update_bot(**kwargs) Updates the status of the specified bot, such as starting or stopping the bot from running in your Amazon Chime Enterprise account. See also: AWS API Documentation **Request Syntax** response = client.update_bot( AccountId='string', BotId='string', Disabled=True|False ) Parameters: * **AccountId** (*string*) -- **[REQUIRED]** The Amazon Chime account ID. * **BotId** (*string*) -- **[REQUIRED]** The bot ID. * **Disabled** (*boolean*) -- When true, stops the specified bot from running in your account. Return type: dict Returns: **Response Syntax** { 'Bot': { 'BotId': 'string', 'UserId': 'string', 'DisplayName': 'string', 'BotType': 'ChatBot', 'Disabled': True|False, 'CreatedTimestamp': datetime(2015, 1, 1), 'UpdatedTimestamp': datetime(2015, 1, 1), 'BotEmail': 'string', 'SecurityToken': 'string' } } **Response Structure** * *(dict) --* * **Bot** *(dict) --* The updated bot details. * **BotId** *(string) --* The bot ID. * **UserId** *(string) --* The unique ID for the bot user. * **DisplayName** *(string) --* The bot display name. * **BotType** *(string) --* The bot type. * **Disabled** *(boolean) --* When true, the bot is stopped from running in your account. * **CreatedTimestamp** *(datetime) --* The bot creation timestamp, in ISO 8601 format. * **UpdatedTimestamp** *(datetime) --* The updated bot timestamp, in ISO 8601 format. * **BotEmail** *(string) --* The bot email address. * **SecurityToken** *(string) --* The security token used to authenticate Amazon Chime with the outgoing event endpoint. **Exceptions** * "Chime.Client.exceptions.ServiceUnavailableException" * "Chime.Client.exceptions.ServiceFailureException" * "Chime.Client.exceptions.ForbiddenException" * "Chime.Client.exceptions.BadRequestException" * "Chime.Client.exceptions.UnauthorizedClientException" * "Chime.Client.exceptions.NotFoundException" * "Chime.Client.exceptions.ThrottledClientException" Chime / Client / reset_personal_pin reset_personal_pin ****************** Chime.Client.reset_personal_pin(**kwargs) 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** response = client.reset_personal_pin( AccountId='string', UserId='string' ) Parameters: * **AccountId** (*string*) -- **[REQUIRED]** The Amazon Chime account ID. * **UserId** (*string*) -- **[REQUIRED]** The user ID. Return type: 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. **Exceptions** * "Chime.Client.exceptions.UnauthorizedClientException" * "Chime.Client.exceptions.NotFoundException" * "Chime.Client.exceptions.ForbiddenException" * "Chime.Client.exceptions.BadRequestException" * "Chime.Client.exceptions.ThrottledClientException" * "Chime.Client.exceptions.ServiceUnavailableException" * "Chime.Client.exceptions.ServiceFailureException" Chime / Client / redact_room_message redact_room_message ******************* Chime.Client.redact_room_message(**kwargs) Redacts the specified message from the specified Amazon Chime channel. See also: AWS API Documentation **Request Syntax** response = client.redact_room_message( AccountId='string', RoomId='string', MessageId='string' ) Parameters: * **AccountId** (*string*) -- **[REQUIRED]** The Amazon Chime account ID. * **RoomId** (*string*) -- **[REQUIRED]** The room ID. * **MessageId** (*string*) -- **[REQUIRED]** The message ID. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Chime.Client.exceptions.NotFoundException" * "Chime.Client.exceptions.ForbiddenException" * "Chime.Client.exceptions.UnauthorizedClientException" * "Chime.Client.exceptions.ThrottledClientException" * "Chime.Client.exceptions.BadRequestException" * "Chime.Client.exceptions.ServiceUnavailableException" * "Chime.Client.exceptions.ServiceFailureException" Chime / Client / update_phone_number update_phone_number ******************* Chime.Client.update_phone_number(**kwargs) Updates phone number details, such as product type or calling name, for the specified phone number ID. You can update one phone number detail at a time. For example, you can update either the product type or the calling name in one action. For toll-free numbers, you cannot use the Amazon Chime Business Calling product type. For numbers outside the U.S., you must use the Amazon Chime SIP Media Application Dial-In product type. Updates to outbound calling names can take 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update. See also: AWS API Documentation **Request Syntax** response = client.update_phone_number( PhoneNumberId='string', ProductType='BusinessCalling'|'VoiceConnector'|'SipMediaApplicationDialIn', CallingName='string' ) Parameters: * **PhoneNumberId** (*string*) -- **[REQUIRED]** The phone number ID. * **ProductType** (*string*) -- The product type. * **CallingName** (*string*) -- The outbound calling name associated with the phone number. Return type: dict Returns: **Response Syntax** { 'PhoneNumber': { 'PhoneNumberId': 'string', 'E164PhoneNumber': 'string', 'Country': 'string', 'Type': 'Local'|'TollFree', 'ProductType': 'BusinessCalling'|'VoiceConnector'|'SipMediaApplicationDialIn', 'Status': 'AcquireInProgress'|'AcquireFailed'|'Unassigned'|'Assigned'|'ReleaseInProgress'|'DeleteInProgress'|'ReleaseFailed'|'DeleteFailed', 'Capabilities': { 'InboundCall': True|False, 'OutboundCall': True|False, 'InboundSMS': True|False, 'OutboundSMS': True|False, 'InboundMMS': True|False, 'OutboundMMS': True|False }, 'Associations': [ { 'Value': 'string', 'Name': 'AccountId'|'UserId'|'VoiceConnectorId'|'VoiceConnectorGroupId'|'SipRuleId', 'AssociatedTimestamp': datetime(2015, 1, 1) }, ], 'CallingName': 'string', 'CallingNameStatus': 'Unassigned'|'UpdateInProgress'|'UpdateSucceeded'|'UpdateFailed', 'CreatedTimestamp': datetime(2015, 1, 1), 'UpdatedTimestamp': datetime(2015, 1, 1), 'DeletionTimestamp': datetime(2015, 1, 1) } } **Response Structure** * *(dict) --* * **PhoneNumber** *(dict) --* The updated phone number details. * **PhoneNumberId** *(string) --* The phone number ID. * **E164PhoneNumber** *(string) --* The phone number, in E.164 format. * **Country** *(string) --* The phone number country. Format: ISO 3166-1 alpha-2. * **Type** *(string) --* The phone number type. * **ProductType** *(string) --* The phone number product type. * **Status** *(string) --* The phone number status. * **Capabilities** *(dict) --* The phone number capabilities. * **InboundCall** *(boolean) --* Allows or denies inbound calling for the specified phone number. * **OutboundCall** *(boolean) --* Allows or denies outbound calling for the specified phone number. * **InboundSMS** *(boolean) --* Allows or denies inbound SMS messaging for the specified phone number. * **OutboundSMS** *(boolean) --* Allows or denies outbound SMS messaging for the specified phone number. * **InboundMMS** *(boolean) --* Allows or denies inbound MMS messaging for the specified phone number. * **OutboundMMS** *(boolean) --* Allows or denies outbound MMS messaging for the specified phone number. * **Associations** *(list) --* The phone number associations. * *(dict) --* The phone number associations, such as Amazon Chime account ID, Amazon Chime user ID, Amazon Chime Voice Connector ID, or Amazon Chime Voice Connector group ID. * **Value** *(string) --* Contains the ID for the entity specified in Name. * **Name** *(string) --* Defines the association with an Amazon Chime account ID, user ID, Amazon Chime Voice Connector ID, or Amazon Chime Voice Connector group ID. * **AssociatedTimestamp** *(datetime) --* The timestamp of the phone number association, in ISO 8601 format. * **CallingName** *(string) --* The outbound calling name associated with the phone number. * **CallingNameStatus** *(string) --* The outbound calling name status. * **CreatedTimestamp** *(datetime) --* The phone number creation timestamp, in ISO 8601 format. * **UpdatedTimestamp** *(datetime) --* The updated phone number timestamp, in ISO 8601 format. * **DeletionTimestamp** *(datetime) --* The deleted phone number timestamp, in ISO 8601 format. **Exceptions** * "Chime.Client.exceptions.UnauthorizedClientException" * "Chime.Client.exceptions.NotFoundException" * "Chime.Client.exceptions.ForbiddenException" * "Chime.Client.exceptions.BadRequestException" * "Chime.Client.exceptions.ThrottledClientException" * "Chime.Client.exceptions.ConflictException" * "Chime.Client.exceptions.ServiceUnavailableException" * "Chime.Client.exceptions.ServiceFailureException" Chime / Client / logout_user logout_user *********** Chime.Client.logout_user(**kwargs) Logs out the specified user from all of the devices they are currently logged into. See also: AWS API Documentation **Request Syntax** response = client.logout_user( AccountId='string', UserId='string' ) Parameters: * **AccountId** (*string*) -- **[REQUIRED]** The Amazon Chime account ID. * **UserId** (*string*) -- **[REQUIRED]** The user ID. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Chime.Client.exceptions.UnauthorizedClientException" * "Chime.Client.exceptions.NotFoundException" * "Chime.Client.exceptions.ForbiddenException" * "Chime.Client.exceptions.BadRequestException" * "Chime.Client.exceptions.ThrottledClientException" * "Chime.Client.exceptions.ServiceUnavailableException" * "Chime.Client.exceptions.ServiceFailureException" Chime / Client / associate_phone_number_with_user associate_phone_number_with_user ******************************** Chime.Client.associate_phone_number_with_user(**kwargs) Associates a phone number with the specified Amazon Chime user. See also: AWS API Documentation **Request Syntax** response = client.associate_phone_number_with_user( AccountId='string', UserId='string', E164PhoneNumber='string' ) Parameters: * **AccountId** (*string*) -- **[REQUIRED]** The Amazon Chime account ID. * **UserId** (*string*) -- **[REQUIRED]** The user ID. * **E164PhoneNumber** (*string*) -- **[REQUIRED]** The phone number, in E.164 format. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Chime.Client.exceptions.UnauthorizedClientException" * "Chime.Client.exceptions.NotFoundException" * "Chime.Client.exceptions.ForbiddenException" * "Chime.Client.exceptions.BadRequestException" * "Chime.Client.exceptions.AccessDeniedException" * "Chime.Client.exceptions.ThrottledClientException" * "Chime.Client.exceptions.ServiceUnavailableException" * "Chime.Client.exceptions.ServiceFailureException" Chime / Client / list_bots list_bots ********* Chime.Client.list_bots(**kwargs) Lists the bots associated with the administrator's Amazon Chime Enterprise account ID. See also: AWS API Documentation **Request Syntax** response = client.list_bots( AccountId='string', MaxResults=123, NextToken='string' ) Parameters: * **AccountId** (*string*) -- **[REQUIRED]** The Amazon Chime account ID. * **MaxResults** (*integer*) -- The maximum number of results to return in a single call. The default is 10. * **NextToken** (*string*) -- The token to use to retrieve the next page of results. Return type: dict Returns: **Response Syntax** { 'Bots': [ { 'BotId': 'string', 'UserId': 'string', 'DisplayName': 'string', 'BotType': 'ChatBot', 'Disabled': True|False, 'CreatedTimestamp': datetime(2015, 1, 1), 'UpdatedTimestamp': datetime(2015, 1, 1), 'BotEmail': 'string', 'SecurityToken': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **Bots** *(list) --* List of bots and bot details. * *(dict) --* A resource that allows Enterprise account administrators to configure an interface to receive events from Amazon Chime. * **BotId** *(string) --* The bot ID. * **UserId** *(string) --* The unique ID for the bot user. * **DisplayName** *(string) --* The bot display name. * **BotType** *(string) --* The bot type. * **Disabled** *(boolean) --* When true, the bot is stopped from running in your account. * **CreatedTimestamp** *(datetime) --* The bot creation timestamp, in ISO 8601 format. * **UpdatedTimestamp** *(datetime) --* The updated bot timestamp, in ISO 8601 format. * **BotEmail** *(string) --* The bot email address. * **SecurityToken** *(string) --* The security token used to authenticate Amazon Chime with the outgoing event endpoint. * **NextToken** *(string) --* The token to use to retrieve the next page of results. **Exceptions** * "Chime.Client.exceptions.ServiceUnavailableException" * "Chime.Client.exceptions.ServiceFailureException" * "Chime.Client.exceptions.ForbiddenException" * "Chime.Client.exceptions.UnauthorizedClientException" * "Chime.Client.exceptions.BadRequestException" * "Chime.Client.exceptions.NotFoundException" * "Chime.Client.exceptions.ThrottledClientException" Chime / Client / delete_events_configuration delete_events_configuration *************************** Chime.Client.delete_events_configuration(**kwargs) Deletes the events configuration that allows a bot to receive outgoing events. See also: AWS API Documentation **Request Syntax** response = client.delete_events_configuration( AccountId='string', BotId='string' ) Parameters: * **AccountId** (*string*) -- **[REQUIRED]** The Amazon Chime account ID. * **BotId** (*string*) -- **[REQUIRED]** The bot ID. Returns: None **Exceptions** * "Chime.Client.exceptions.ServiceUnavailableException" * "Chime.Client.exceptions.ServiceFailureException" * "Chime.Client.exceptions.ForbiddenException" * "Chime.Client.exceptions.BadRequestException" * "Chime.Client.exceptions.UnauthorizedClientException" * "Chime.Client.exceptions.ResourceLimitExceededException" Chime / Client / put_events_configuration put_events_configuration ************************ Chime.Client.put_events_configuration(**kwargs) Creates an events configuration that allows a bot to receive outgoing events sent by Amazon Chime. Choose either an HTTPS endpoint or a Lambda function ARN. For more information, see Bot. See also: AWS API Documentation **Request Syntax** response = client.put_events_configuration( AccountId='string', BotId='string', OutboundEventsHTTPSEndpoint='string', LambdaFunctionArn='string' ) Parameters: * **AccountId** (*string*) -- **[REQUIRED]** The Amazon Chime account ID. * **BotId** (*string*) -- **[REQUIRED]** The bot ID. * **OutboundEventsHTTPSEndpoint** (*string*) -- HTTPS endpoint that allows the bot to receive outgoing events. * **LambdaFunctionArn** (*string*) -- Lambda function ARN that allows the bot to receive outgoing events. Return type: dict Returns: **Response Syntax** { 'EventsConfiguration': { 'BotId': 'string', 'OutboundEventsHTTPSEndpoint': 'string', 'LambdaFunctionArn': 'string' } } **Response Structure** * *(dict) --* * **EventsConfiguration** *(dict) --* The configuration that allows a bot to receive outgoing events. Can be an HTTPS endpoint or an AWS Lambda function ARN. * **BotId** *(string) --* The bot ID. * **OutboundEventsHTTPSEndpoint** *(string) --* HTTPS endpoint that allows a bot to receive outgoing events. * **LambdaFunctionArn** *(string) --* Lambda function ARN that allows a bot to receive outgoing events. **Exceptions** * "Chime.Client.exceptions.ServiceUnavailableException" * "Chime.Client.exceptions.ServiceFailureException" * "Chime.Client.exceptions.ForbiddenException" * "Chime.Client.exceptions.BadRequestException" * "Chime.Client.exceptions.UnauthorizedClientException" * "Chime.Client.exceptions.ResourceLimitExceededException" * "Chime.Client.exceptions.NotFoundException" Chime / Client / get_account get_account *********** Chime.Client.get_account(**kwargs) Retrieves details for the specified Amazon Chime account, such as account type and supported licenses. See also: AWS API Documentation **Request Syntax** response = client.get_account( AccountId='string' ) Parameters: **AccountId** (*string*) -- **[REQUIRED]** The Amazon Chime account ID. Return type: 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. * **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. **Exceptions** * "Chime.Client.exceptions.UnauthorizedClientException" * "Chime.Client.exceptions.NotFoundException" * "Chime.Client.exceptions.ForbiddenException" * "Chime.Client.exceptions.BadRequestException" * "Chime.Client.exceptions.ThrottledClientException" * "Chime.Client.exceptions.ServiceUnavailableException" * "Chime.Client.exceptions.ServiceFailureException" Chime / Client / close close ***** Chime.Client.close() Closes underlying endpoint connections. Chime / Client / put_retention_settings put_retention_settings ********************** Chime.Client.put_retention_settings(**kwargs) Puts retention settings for the specified Amazon Chime Enterprise account. We recommend using AWS CloudTrail to monitor usage of this API for your account. For more information, see Logging Amazon Chime API Calls with AWS CloudTrail in the *Amazon Chime Administration Guide*. To turn off existing retention settings, remove the number of days from the corresponding **RetentionDays** field in the **RetentionSettings** object. For more information about retention settings, see Managing Chat Retention Policies in the *Amazon Chime Administration Guide*. See also: AWS API Documentation **Request Syntax** response = client.put_retention_settings( AccountId='string', RetentionSettings={ 'RoomRetentionSettings': { 'RetentionDays': 123 }, 'ConversationRetentionSettings': { 'RetentionDays': 123 } } ) Parameters: * **AccountId** (*string*) -- **[REQUIRED]** The Amazon Chime account ID. * **RetentionSettings** (*dict*) -- **[REQUIRED]** The retention settings. * **RoomRetentionSettings** *(dict) --* The chat room retention settings. * **RetentionDays** *(integer) --* The number of days for which to retain chat-room messages. * **ConversationRetentionSettings** *(dict) --* The chat conversation retention settings. * **RetentionDays** *(integer) --* The number of days for which to retain conversation messages. Return type: dict Returns: **Response Syntax** { 'RetentionSettings': { 'RoomRetentionSettings': { 'RetentionDays': 123 }, 'ConversationRetentionSettings': { 'RetentionDays': 123 } }, 'InitiateDeletionTimestamp': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **RetentionSettings** *(dict) --* The retention settings. * **RoomRetentionSettings** *(dict) --* The chat room retention settings. * **RetentionDays** *(integer) --* The number of days for which to retain chat-room messages. * **ConversationRetentionSettings** *(dict) --* The chat conversation retention settings. * **RetentionDays** *(integer) --* The number of days for which to retain conversation messages. * **InitiateDeletionTimestamp** *(datetime) --* The timestamp representing the time at which the specified items are permanently deleted, in ISO 8601 format. **Exceptions** * "Chime.Client.exceptions.UnauthorizedClientException" * "Chime.Client.exceptions.NotFoundException" * "Chime.Client.exceptions.BadRequestException" * "Chime.Client.exceptions.ForbiddenException" * "Chime.Client.exceptions.ConflictException" * "Chime.Client.exceptions.ThrottledClientException" * "Chime.Client.exceptions.ServiceUnavailableException" * "Chime.Client.exceptions.ServiceFailureException" Chime / Client / restore_phone_number restore_phone_number ******************** Chime.Client.restore_phone_number(**kwargs) Moves a phone number from the **Deletion queue** back into the phone number **Inventory**. See also: AWS API Documentation **Request Syntax** response = client.restore_phone_number( PhoneNumberId='string' ) Parameters: **PhoneNumberId** (*string*) -- **[REQUIRED]** The phone number. Return type: dict Returns: **Response Syntax** { 'PhoneNumber': { 'PhoneNumberId': 'string', 'E164PhoneNumber': 'string', 'Country': 'string', 'Type': 'Local'|'TollFree', 'ProductType': 'BusinessCalling'|'VoiceConnector'|'SipMediaApplicationDialIn', 'Status': 'AcquireInProgress'|'AcquireFailed'|'Unassigned'|'Assigned'|'ReleaseInProgress'|'DeleteInProgress'|'ReleaseFailed'|'DeleteFailed', 'Capabilities': { 'InboundCall': True|False, 'OutboundCall': True|False, 'InboundSMS': True|False, 'OutboundSMS': True|False, 'InboundMMS': True|False, 'OutboundMMS': True|False }, 'Associations': [ { 'Value': 'string', 'Name': 'AccountId'|'UserId'|'VoiceConnectorId'|'VoiceConnectorGroupId'|'SipRuleId', 'AssociatedTimestamp': datetime(2015, 1, 1) }, ], 'CallingName': 'string', 'CallingNameStatus': 'Unassigned'|'UpdateInProgress'|'UpdateSucceeded'|'UpdateFailed', 'CreatedTimestamp': datetime(2015, 1, 1), 'UpdatedTimestamp': datetime(2015, 1, 1), 'DeletionTimestamp': datetime(2015, 1, 1) } } **Response Structure** * *(dict) --* * **PhoneNumber** *(dict) --* The phone number details. * **PhoneNumberId** *(string) --* The phone number ID. * **E164PhoneNumber** *(string) --* The phone number, in E.164 format. * **Country** *(string) --* The phone number country. Format: ISO 3166-1 alpha-2. * **Type** *(string) --* The phone number type. * **ProductType** *(string) --* The phone number product type. * **Status** *(string) --* The phone number status. * **Capabilities** *(dict) --* The phone number capabilities. * **InboundCall** *(boolean) --* Allows or denies inbound calling for the specified phone number. * **OutboundCall** *(boolean) --* Allows or denies outbound calling for the specified phone number. * **InboundSMS** *(boolean) --* Allows or denies inbound SMS messaging for the specified phone number. * **OutboundSMS** *(boolean) --* Allows or denies outbound SMS messaging for the specified phone number. * **InboundMMS** *(boolean) --* Allows or denies inbound MMS messaging for the specified phone number. * **OutboundMMS** *(boolean) --* Allows or denies outbound MMS messaging for the specified phone number. * **Associations** *(list) --* The phone number associations. * *(dict) --* The phone number associations, such as Amazon Chime account ID, Amazon Chime user ID, Amazon Chime Voice Connector ID, or Amazon Chime Voice Connector group ID. * **Value** *(string) --* Contains the ID for the entity specified in Name. * **Name** *(string) --* Defines the association with an Amazon Chime account ID, user ID, Amazon Chime Voice Connector ID, or Amazon Chime Voice Connector group ID. * **AssociatedTimestamp** *(datetime) --* The timestamp of the phone number association, in ISO 8601 format. * **CallingName** *(string) --* The outbound calling name associated with the phone number. * **CallingNameStatus** *(string) --* The outbound calling name status. * **CreatedTimestamp** *(datetime) --* The phone number creation timestamp, in ISO 8601 format. * **UpdatedTimestamp** *(datetime) --* The updated phone number timestamp, in ISO 8601 format. * **DeletionTimestamp** *(datetime) --* The deleted phone number timestamp, in ISO 8601 format. **Exceptions** * "Chime.Client.exceptions.UnauthorizedClientException" * "Chime.Client.exceptions.NotFoundException" * "Chime.Client.exceptions.ForbiddenException" * "Chime.Client.exceptions.BadRequestException" * "Chime.Client.exceptions.ThrottledClientException" * "Chime.Client.exceptions.ResourceLimitExceededException" * "Chime.Client.exceptions.ServiceUnavailableException" * "Chime.Client.exceptions.ServiceFailureException" Chime / Client / disassociate_signin_delegate_groups_from_account disassociate_signin_delegate_groups_from_account ************************************************ Chime.Client.disassociate_signin_delegate_groups_from_account(**kwargs) Disassociates the specified sign-in delegate groups from the specified Amazon Chime account. See also: AWS API Documentation **Request Syntax** response = client.disassociate_signin_delegate_groups_from_account( AccountId='string', GroupNames=[ 'string', ] ) Parameters: * **AccountId** (*string*) -- **[REQUIRED]** The Amazon Chime account ID. * **GroupNames** (*list*) -- **[REQUIRED]** The sign-in delegate group names. * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Chime.Client.exceptions.UnauthorizedClientException" * "Chime.Client.exceptions.NotFoundException" * "Chime.Client.exceptions.ForbiddenException" * "Chime.Client.exceptions.BadRequestException" * "Chime.Client.exceptions.ThrottledClientException" * "Chime.Client.exceptions.ServiceUnavailableException" * "Chime.Client.exceptions.ServiceFailureException" Chime / Client / invite_users invite_users ************ Chime.Client.invite_users(**kwargs) 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** response = client.invite_users( AccountId='string', UserEmailList=[ 'string', ], UserType='PrivateUser'|'SharedDevice' ) Parameters: * **AccountId** (*string*) -- **[REQUIRED]** The Amazon Chime account ID. * **UserEmailList** (*list*) -- **[REQUIRED]** The user email addresses to which to send the email invitation. * *(string) --* * **UserType** (*string*) -- The user type. Return type: 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. **Exceptions** * "Chime.Client.exceptions.UnauthorizedClientException" * "Chime.Client.exceptions.NotFoundException" * "Chime.Client.exceptions.ForbiddenException" * "Chime.Client.exceptions.BadRequestException" * "Chime.Client.exceptions.ThrottledClientException" * "Chime.Client.exceptions.ServiceUnavailableException" * "Chime.Client.exceptions.ServiceFailureException" Chime / Client / create_meeting_dial_out create_meeting_dial_out *********************** Chime.Client.create_meeting_dial_out(**kwargs) Uses the join token and call metadata in a meeting request (From number, To number, and so forth) to initiate an outbound call to a public switched telephone network (PSTN) and join them into a Chime meeting. Also ensures that the From number belongs to the customer. To play welcome audio or implement an interactive voice response (IVR), use the "CreateSipMediaApplicationCall" action with the corresponding SIP media application ID. Warning: **This API is not available in a dedicated namespace.** See also: AWS API Documentation **Request Syntax** response = client.create_meeting_dial_out( MeetingId='string', FromPhoneNumber='string', ToPhoneNumber='string', JoinToken='string' ) Parameters: * **MeetingId** (*string*) -- **[REQUIRED]** The Amazon Chime SDK meeting ID. * **FromPhoneNumber** (*string*) -- **[REQUIRED]** Phone number used as the caller ID when the remote party receives a call. * **ToPhoneNumber** (*string*) -- **[REQUIRED]** Phone number called when inviting someone to a meeting. * **JoinToken** (*string*) -- **[REQUIRED]** Token used by the Amazon Chime SDK attendee. Call the CreateAttendee action to get a join token. Return type: dict Returns: **Response Syntax** { 'TransactionId': 'string' } **Response Structure** * *(dict) --* * **TransactionId** *(string) --* Unique ID that tracks API calls. **Exceptions** * "Chime.Client.exceptions.BadRequestException" * "Chime.Client.exceptions.ForbiddenException" * "Chime.Client.exceptions.ResourceLimitExceededException" * "Chime.Client.exceptions.ThrottledClientException" * "Chime.Client.exceptions.UnauthorizedClientException" * "Chime.Client.exceptions.AccessDeniedException" * "Chime.Client.exceptions.ServiceUnavailableException" * "Chime.Client.exceptions.ServiceFailureException" Chime / Client / get_phone_number_settings get_phone_number_settings ************************* Chime.Client.get_phone_number_settings() Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name. See also: AWS API Documentation **Request Syntax** response = client.get_phone_number_settings() Return type: dict Returns: **Response Syntax** { 'CallingName': 'string', 'CallingNameUpdatedTimestamp': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **CallingName** *(string) --* The default outbound calling name for the account. * **CallingNameUpdatedTimestamp** *(datetime) --* The updated outbound calling name timestamp, in ISO 8601 format. **Exceptions** * "Chime.Client.exceptions.UnauthorizedClientException" * "Chime.Client.exceptions.ForbiddenException" * "Chime.Client.exceptions.BadRequestException" * "Chime.Client.exceptions.ThrottledClientException" * "Chime.Client.exceptions.ServiceUnavailableException" * "Chime.Client.exceptions.ServiceFailureException" Chime / Client / get_bot get_bot ******* Chime.Client.get_bot(**kwargs) Retrieves details for the specified bot, such as bot email address, bot type, status, and display name. See also: AWS API Documentation **Request Syntax** response = client.get_bot( AccountId='string', BotId='string' ) Parameters: * **AccountId** (*string*) -- **[REQUIRED]** The Amazon Chime account ID. * **BotId** (*string*) -- **[REQUIRED]** The bot ID. Return type: dict Returns: **Response Syntax** { 'Bot': { 'BotId': 'string', 'UserId': 'string', 'DisplayName': 'string', 'BotType': 'ChatBot', 'Disabled': True|False, 'CreatedTimestamp': datetime(2015, 1, 1), 'UpdatedTimestamp': datetime(2015, 1, 1), 'BotEmail': 'string', 'SecurityToken': 'string' } } **Response Structure** * *(dict) --* * **Bot** *(dict) --* The chat bot details. * **BotId** *(string) --* The bot ID. * **UserId** *(string) --* The unique ID for the bot user. * **DisplayName** *(string) --* The bot display name. * **BotType** *(string) --* The bot type. * **Disabled** *(boolean) --* When true, the bot is stopped from running in your account. * **CreatedTimestamp** *(datetime) --* The bot creation timestamp, in ISO 8601 format. * **UpdatedTimestamp** *(datetime) --* The updated bot timestamp, in ISO 8601 format. * **BotEmail** *(string) --* The bot email address. * **SecurityToken** *(string) --* The security token used to authenticate Amazon Chime with the outgoing event endpoint. **Exceptions** * "Chime.Client.exceptions.ServiceUnavailableException" * "Chime.Client.exceptions.ServiceFailureException" * "Chime.Client.exceptions.ForbiddenException" * "Chime.Client.exceptions.UnauthorizedClientException" * "Chime.Client.exceptions.NotFoundException" * "Chime.Client.exceptions.BadRequestException" * "Chime.Client.exceptions.ThrottledClientException" Chime / Client / list_accounts list_accounts ************* Chime.Client.list_accounts(**kwargs) 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** response = client.list_accounts( Name='string', UserEmail='string', NextToken='string', MaxResults=123 ) Parameters: * **Name** (*string*) -- Amazon Chime account name prefix with which to filter results. * **UserEmail** (*string*) -- User email address with which to filter results. * **NextToken** (*string*) -- The token to use to retrieve the next page of results. * **MaxResults** (*integer*) -- The maximum number of results to return in a single call. Defaults to 100. Return type: 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. * **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. **Exceptions** * "Chime.Client.exceptions.UnauthorizedClientException" * "Chime.Client.exceptions.NotFoundException" * "Chime.Client.exceptions.ForbiddenException" * "Chime.Client.exceptions.BadRequestException" * "Chime.Client.exceptions.ThrottledClientException" * "Chime.Client.exceptions.ServiceUnavailableException" * "Chime.Client.exceptions.ServiceFailureException" Chime / Client / get_phone_number get_phone_number **************** Chime.Client.get_phone_number(**kwargs) Retrieves details for the specified phone number ID, such as associations, capabilities, and product type. See also: AWS API Documentation **Request Syntax** response = client.get_phone_number( PhoneNumberId='string' ) Parameters: **PhoneNumberId** (*string*) -- **[REQUIRED]** The phone number ID. Return type: dict Returns: **Response Syntax** { 'PhoneNumber': { 'PhoneNumberId': 'string', 'E164PhoneNumber': 'string', 'Country': 'string', 'Type': 'Local'|'TollFree', 'ProductType': 'BusinessCalling'|'VoiceConnector'|'SipMediaApplicationDialIn', 'Status': 'AcquireInProgress'|'AcquireFailed'|'Unassigned'|'Assigned'|'ReleaseInProgress'|'DeleteInProgress'|'ReleaseFailed'|'DeleteFailed', 'Capabilities': { 'InboundCall': True|False, 'OutboundCall': True|False, 'InboundSMS': True|False, 'OutboundSMS': True|False, 'InboundMMS': True|False, 'OutboundMMS': True|False }, 'Associations': [ { 'Value': 'string', 'Name': 'AccountId'|'UserId'|'VoiceConnectorId'|'VoiceConnectorGroupId'|'SipRuleId', 'AssociatedTimestamp': datetime(2015, 1, 1) }, ], 'CallingName': 'string', 'CallingNameStatus': 'Unassigned'|'UpdateInProgress'|'UpdateSucceeded'|'UpdateFailed', 'CreatedTimestamp': datetime(2015, 1, 1), 'UpdatedTimestamp': datetime(2015, 1, 1), 'DeletionTimestamp': datetime(2015, 1, 1) } } **Response Structure** * *(dict) --* * **PhoneNumber** *(dict) --* The phone number details. * **PhoneNumberId** *(string) --* The phone number ID. * **E164PhoneNumber** *(string) --* The phone number, in E.164 format. * **Country** *(string) --* The phone number country. Format: ISO 3166-1 alpha-2. * **Type** *(string) --* The phone number type. * **ProductType** *(string) --* The phone number product type. * **Status** *(string) --* The phone number status. * **Capabilities** *(dict) --* The phone number capabilities. * **InboundCall** *(boolean) --* Allows or denies inbound calling for the specified phone number. * **OutboundCall** *(boolean) --* Allows or denies outbound calling for the specified phone number. * **InboundSMS** *(boolean) --* Allows or denies inbound SMS messaging for the specified phone number. * **OutboundSMS** *(boolean) --* Allows or denies outbound SMS messaging for the specified phone number. * **InboundMMS** *(boolean) --* Allows or denies inbound MMS messaging for the specified phone number. * **OutboundMMS** *(boolean) --* Allows or denies outbound MMS messaging for the specified phone number. * **Associations** *(list) --* The phone number associations. * *(dict) --* The phone number associations, such as Amazon Chime account ID, Amazon Chime user ID, Amazon Chime Voice Connector ID, or Amazon Chime Voice Connector group ID. * **Value** *(string) --* Contains the ID for the entity specified in Name. * **Name** *(string) --* Defines the association with an Amazon Chime account ID, user ID, Amazon Chime Voice Connector ID, or Amazon Chime Voice Connector group ID. * **AssociatedTimestamp** *(datetime) --* The timestamp of the phone number association, in ISO 8601 format. * **CallingName** *(string) --* The outbound calling name associated with the phone number. * **CallingNameStatus** *(string) --* The outbound calling name status. * **CreatedTimestamp** *(datetime) --* The phone number creation timestamp, in ISO 8601 format. * **UpdatedTimestamp** *(datetime) --* The updated phone number timestamp, in ISO 8601 format. * **DeletionTimestamp** *(datetime) --* The deleted phone number timestamp, in ISO 8601 format. **Exceptions** * "Chime.Client.exceptions.UnauthorizedClientException" * "Chime.Client.exceptions.NotFoundException" * "Chime.Client.exceptions.ForbiddenException" * "Chime.Client.exceptions.BadRequestException" * "Chime.Client.exceptions.ThrottledClientException" * "Chime.Client.exceptions.ServiceUnavailableException" * "Chime.Client.exceptions.ServiceFailureException" Chime / Client / batch_delete_phone_number batch_delete_phone_number ************************* Chime.Client.batch_delete_phone_number(**kwargs) Moves phone numbers into the **Deletion queue**. Phone numbers must be disassociated from any users or Amazon Chime Voice Connectors before they can be deleted. Phone numbers remain in the **Deletion queue** for 7 days before they are deleted permanently. See also: AWS API Documentation **Request Syntax** response = client.batch_delete_phone_number( PhoneNumberIds=[ 'string', ] ) Parameters: **PhoneNumberIds** (*list*) -- **[REQUIRED]** List of phone number IDs. * *(string) --* Return type: dict Returns: **Response Syntax** { 'PhoneNumberErrors': [ { 'PhoneNumberId': 'string', 'ErrorCode': 'BadRequest'|'Conflict'|'Forbidden'|'NotFound'|'PreconditionFailed'|'ResourceLimitExceeded'|'ServiceFailure'|'AccessDenied'|'ServiceUnavailable'|'Throttled'|'Throttling'|'Unauthorized'|'Unprocessable'|'VoiceConnectorGroupAssociationsExist'|'PhoneNumberAssociationsExist', 'ErrorMessage': 'string' }, ] } **Response Structure** * *(dict) --* * **PhoneNumberErrors** *(list) --* If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages. * *(dict) --* If the phone number action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages. * **PhoneNumberId** *(string) --* The phone number ID for which the action failed. * **ErrorCode** *(string) --* The error code. * **ErrorMessage** *(string) --* The error message. **Exceptions** * "Chime.Client.exceptions.UnauthorizedClientException" * "Chime.Client.exceptions.NotFoundException" * "Chime.Client.exceptions.ForbiddenException" * "Chime.Client.exceptions.BadRequestException" * "Chime.Client.exceptions.ThrottledClientException" * "Chime.Client.exceptions.ServiceUnavailableException" * "Chime.Client.exceptions.ServiceFailureException" Chime / Client / create_phone_number_order create_phone_number_order ************************* Chime.Client.create_phone_number_order(**kwargs) Creates an order for phone numbers to be provisioned. For toll-free numbers, you cannot use the Amazon Chime Business Calling product type. For numbers outside the U.S., you must use the Amazon Chime SIP Media Application Dial-In product type. See also: AWS API Documentation **Request Syntax** response = client.create_phone_number_order( ProductType='BusinessCalling'|'VoiceConnector'|'SipMediaApplicationDialIn', E164PhoneNumbers=[ 'string', ] ) Parameters: * **ProductType** (*string*) -- **[REQUIRED]** The phone number product type. * **E164PhoneNumbers** (*list*) -- **[REQUIRED]** List of phone numbers, in E.164 format. * *(string) --* Return type: dict Returns: **Response Syntax** { 'PhoneNumberOrder': { 'PhoneNumberOrderId': 'string', 'ProductType': 'BusinessCalling'|'VoiceConnector'|'SipMediaApplicationDialIn', 'Status': 'Processing'|'Successful'|'Failed'|'Partial', 'OrderedPhoneNumbers': [ { 'E164PhoneNumber': 'string', 'Status': 'Processing'|'Acquired'|'Failed' }, ], 'CreatedTimestamp': datetime(2015, 1, 1), 'UpdatedTimestamp': datetime(2015, 1, 1) } } **Response Structure** * *(dict) --* * **PhoneNumberOrder** *(dict) --* The phone number order details. * **PhoneNumberOrderId** *(string) --* The phone number order ID. * **ProductType** *(string) --* The phone number order product type. * **Status** *(string) --* The status of the phone number order. * **OrderedPhoneNumbers** *(list) --* The ordered phone number details, such as the phone number in E.164 format and the phone number status. * *(dict) --* A phone number for which an order has been placed. * **E164PhoneNumber** *(string) --* The phone number, in E.164 format. * **Status** *(string) --* The phone number status. * **CreatedTimestamp** *(datetime) --* The phone number order creation time stamp, in ISO 8601 format. * **UpdatedTimestamp** *(datetime) --* The updated phone number order time stamp, in ISO 8601 format. **Exceptions** * "Chime.Client.exceptions.BadRequestException" * "Chime.Client.exceptions.ForbiddenException" * "Chime.Client.exceptions.AccessDeniedException" * "Chime.Client.exceptions.UnauthorizedClientException" * "Chime.Client.exceptions.ThrottledClientException" * "Chime.Client.exceptions.ResourceLimitExceededException" * "Chime.Client.exceptions.ServiceUnavailableException" * "Chime.Client.exceptions.ServiceFailureException"