Table of Contents
A low-level client representing Amazon Chime:
import boto3
client = boto3.client('chime')
These are the available methods:
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'
)
[REQUIRED]
The Amazon Chime account ID.
[REQUIRED]
The user ID.
[REQUIRED]
The phone number, in E.164 format.
dict
Response Syntax
{}
Response Structure
Associates a phone number with the specified Amazon Chime Voice Connector.
See also: AWS API Documentation
Request Syntax
response = client.associate_phone_numbers_with_voice_connector(
VoiceConnectorId='string',
E164PhoneNumbers=[
'string',
]
)
[REQUIRED]
The Amazon Chime Voice Connector ID.
List of phone numbers, in E.164 format.
dict
Response Syntax
{
'PhoneNumberErrors': [
{
'PhoneNumberId': 'string',
'ErrorCode': 'Unauthorized'|'Forbidden'|'NotFound'|'BadRequest'|'Conflict'|'ServiceFailure'|'ServiceUnavailable'|'Unprocessable'|'Throttled'|'PreconditionFailed',
'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.
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',
]
)
[REQUIRED]
List of phone number IDs.
{
'PhoneNumberErrors': [
{
'PhoneNumberId': 'string',
'ErrorCode': 'Unauthorized'|'Forbidden'|'NotFound'|'BadRequest'|'Conflict'|'ServiceFailure'|'ServiceUnavailable'|'Unprocessable'|'Throttled'|'PreconditionFailed',
'ErrorMessage': 'string'
},
]
}
Response Structure
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.
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.
The phone number ID for which the action failed.
The error code.
The error message.
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 dissasociated 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',
]
)
[REQUIRED]
The Amazon Chime account ID.
[REQUIRED]
The request containing the user IDs to suspend.
dict
Response Syntax
{
'UserErrors': [
{
'UserId': 'string',
'ErrorCode': 'Unauthorized'|'Forbidden'|'NotFound'|'BadRequest'|'Conflict'|'ServiceFailure'|'ServiceUnavailable'|'Unprocessable'|'Throttled'|'PreconditionFailed',
'ErrorMessage': 'string'
},
]
}
Response Structure
(dict) --
UserErrors (list) --
If the BatchSuspendUser action fails for one or more of the user IDs in the request, a list of the user IDs is returned, along with error codes and error messages.
(dict) --
The list of errors returned when errors are encountered during the BatchSuspendUser , BatchUnsuspendUser , or BatchUpdateUser actions. This includes user IDs, error codes, and error messages.
UserId (string) --
The user ID for which the action failed.
ErrorCode (string) --
The error code.
ErrorMessage (string) --
The error message.
Removes the suspension from up to 50 previously suspended users for the specified Amazon Chime EnterpriseLWA account. Only users on EnterpriseLWA accounts can be unsuspended using this action. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide .
Previously suspended users who are unsuspended using this action are returned to Registered status. Users who are not previously suspended are ignored.
See also: AWS API Documentation
Request Syntax
response = client.batch_unsuspend_user(
AccountId='string',
UserIdList=[
'string',
]
)
[REQUIRED]
The Amazon Chime account ID.
[REQUIRED]
The request containing the user IDs to unsuspend.
dict
Response Syntax
{
'UserErrors': [
{
'UserId': 'string',
'ErrorCode': 'Unauthorized'|'Forbidden'|'NotFound'|'BadRequest'|'Conflict'|'ServiceFailure'|'ServiceUnavailable'|'Unprocessable'|'Throttled'|'PreconditionFailed',
'ErrorMessage': 'string'
},
]
}
Response Structure
(dict) --
UserErrors (list) --
If the BatchUnsuspendUser action fails for one or more of the user IDs in the request, a list of the user IDs is returned, along with error codes and error messages.
(dict) --
The list of errors returned when errors are encountered during the BatchSuspendUser , BatchUnsuspendUser , or BatchUpdateUser actions. This includes user IDs, error codes, and error messages.
UserId (string) --
The user ID for which the action failed.
ErrorCode (string) --
The error code.
ErrorMessage (string) --
The error message.
Updates phone number product types. Choose from Amazon Chime Business Calling and Amazon Chime Voice Connector product types. For toll-free numbers, you can use only the Amazon Chime Voice Connector product type.
See also: AWS API Documentation
Request Syntax
response = client.batch_update_phone_number(
UpdatePhoneNumberRequestItems=[
{
'PhoneNumberId': 'string',
'ProductType': 'BusinessCalling'|'VoiceConnector'
},
]
)
[REQUIRED]
The request containing the phone number IDs and product types to update.
The phone number ID and product type fields to update, used with the BatchUpdatePhoneNumber and UpdatePhoneNumber actions.
The phone number ID to update.
The product type to update.
{
'PhoneNumberErrors': [
{
'PhoneNumberId': 'string',
'ErrorCode': 'Unauthorized'|'Forbidden'|'NotFound'|'BadRequest'|'Conflict'|'ServiceFailure'|'ServiceUnavailable'|'Unprocessable'|'Throttled'|'PreconditionFailed',
'ErrorMessage': 'string'
},
]
}
Response Structure
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.
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.
The phone number ID for which the action failed.
The error code.
The error message.
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'
},
]
)
[REQUIRED]
The Amazon Chime account ID.
[REQUIRED]
The request containing the user IDs and details to update.
The user ID and user fields to update, used with the BatchUpdateUser action.
The user ID.
The user license type.
dict
Response Syntax
{
'UserErrors': [
{
'UserId': 'string',
'ErrorCode': 'Unauthorized'|'Forbidden'|'NotFound'|'BadRequest'|'Conflict'|'ServiceFailure'|'ServiceUnavailable'|'Unprocessable'|'Throttled'|'PreconditionFailed',
'ErrorMessage': 'string'
},
]
}
Response Structure
(dict) --
UserErrors (list) --
If the BatchUpdateUser action fails for one or more of the user IDs in the request, a list of the user IDs is returned, along with error codes and error messages.
(dict) --
The list of errors returned when errors are encountered during the BatchSuspendUser , BatchUnsuspendUser , or BatchUpdateUser actions. This includes user IDs, error codes, and error messages.
UserId (string) --
The user ID for which the action failed.
ErrorCode (string) --
The error code.
ErrorMessage (string) --
The error message.
Check if an operation can be paginated.
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'
)
[REQUIRED]
The name of the Amazon Chime account.
{
'Account': {
'AwsAccountId': 'string',
'AccountId': 'string',
'Name': 'string',
'AccountType': 'Team'|'EnterpriseDirectory'|'EnterpriseLWA'|'EnterpriseOIDC',
'CreatedTimestamp': datetime(2015, 1, 1),
'DefaultLicense': 'Basic'|'Plus'|'Pro'|'ProTrial',
'SupportedLicenses': [
'Basic'|'Plus'|'Pro'|'ProTrial',
]
}
}
Response Structure
The Amazon Chime account details.
The AWS account ID.
The Amazon Chime account ID.
The Amazon Chime account name.
The Amazon Chime account type. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide .
The Amazon Chime account creation timestamp, in ISO 8601 format.
The default license for the Amazon Chime account.
Supported licenses for the Amazon Chime account.
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'
)
[REQUIRED]
The Amazon Chime account ID.
[REQUIRED]
The bot display name.
dict
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.
Creates an order for phone numbers to be provisioned. Choose from Amazon Chime Business Calling and Amazon Chime Voice Connector product types. For toll-free numbers, you can use only the Amazon Chime Voice Connector product type.
See also: AWS API Documentation
Request Syntax
response = client.create_phone_number_order(
ProductType='BusinessCalling'|'VoiceConnector',
E164PhoneNumbers=[
'string',
]
)
[REQUIRED]
The phone number product type.
[REQUIRED]
List of phone numbers, in E.164 format.
dict
Response Syntax
{
'PhoneNumberOrder': {
'PhoneNumberOrderId': 'string',
'ProductType': 'BusinessCalling'|'VoiceConnector',
'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 timestamp, in ISO 8601 format.
UpdatedTimestamp (datetime) --
The updated phone number order timestamp, in ISO 8601 format.
Creates an Amazon Chime Voice Connector under the administrator's AWS account. Enabling CreateVoiceConnectorRequest$RequireEncryption configures your Amazon Chime Voice Connector to use TLS transport for SIP signaling and Secure RTP (SRTP) for media. Inbound calls use TLS transport, and unencrypted outbound calls are blocked.
See also: AWS API Documentation
Request Syntax
response = client.create_voice_connector(
Name='string',
RequireEncryption=True|False
)
[REQUIRED]
The name of the Amazon Chime Voice Connector.
[REQUIRED]
When enabled, requires encryption for the Amazon Chime Voice Connector.
dict
Response Syntax
{
'VoiceConnector': {
'VoiceConnectorId': 'string',
'Name': 'string',
'OutboundHostName': 'string',
'RequireEncryption': True|False,
'CreatedTimestamp': datetime(2015, 1, 1),
'UpdatedTimestamp': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
VoiceConnector (dict) --
The Amazon Chime Voice Connector details.
VoiceConnectorId (string) --
The Amazon Chime Voice Connector ID.
Name (string) --
The name of the Amazon Chime Voice Connector.
OutboundHostName (string) --
The outbound host name for the Amazon Chime Voice Connector.
RequireEncryption (boolean) --
Designates whether encryption is required for the Amazon Chime Voice Connector.
CreatedTimestamp (datetime) --
The Amazon Chime Voice Connector creation timestamp, in ISO 8601 format.
UpdatedTimestamp (datetime) --
The updated Amazon Chime Voice Connector timestamp, in ISO 8601 format.
Deletes the specified Amazon Chime account. You must suspend all users before deleting a Team account. You can use the BatchSuspendUser action to do so.
For EnterpriseLWA and EnterpriseAD accounts, you must release the claimed domains for your Amazon Chime account before deletion. As soon as you release the domain, all users under that account are suspended.
Deleted accounts appear in your Disabled accounts list for 90 days. To restore a deleted account from your Disabled accounts list, you must contact AWS Support.
After 90 days, deleted accounts are permanently removed from your Disabled accounts list.
See also: AWS API Documentation
Request Syntax
response = client.delete_account(
AccountId='string'
)
[REQUIRED]
The Amazon Chime account ID.
{}
Response Structure
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'
)
[REQUIRED]
The Amazon Chime account ID.
[REQUIRED]
The bot ID.
None
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'
)
[REQUIRED]
The phone number ID.
Deletes the specified Amazon Chime Voice Connector. Any phone numbers assigned to the Amazon Chime Voice Connector must be unassigned from it before it can be deleted.
See also: AWS API Documentation
Request Syntax
response = client.delete_voice_connector(
VoiceConnectorId='string'
)
[REQUIRED]
The Amazon Chime Voice Connector ID.
Deletes the origination settings for the specified Amazon Chime Voice Connector.
See also: AWS API Documentation
Request Syntax
response = client.delete_voice_connector_origination(
VoiceConnectorId='string'
)
[REQUIRED]
The Amazon Chime Voice Connector ID.
Deletes the termination settings for the specified Amazon Chime Voice Connector.
See also: AWS API Documentation
Request Syntax
response = client.delete_voice_connector_termination(
VoiceConnectorId='string'
)
[REQUIRED]
The Amazon Chime Voice Connector ID.
Deletes the specified SIP credentials used by your equipment to authenticate during call termination.
See also: AWS API Documentation
Request Syntax
response = client.delete_voice_connector_termination_credentials(
VoiceConnectorId='string',
Usernames=[
'string',
]
)
[REQUIRED]
The Amazon Chime Voice Connector ID.
The RFC2617 compliant username associated with the SIP credentials, in US-ASCII format.
None
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'
)
[REQUIRED]
The Amazon Chime account ID.
[REQUIRED]
The user ID.
dict
Response Syntax
{}
Response Structure
Disassociates the specified phone number from the specified Amazon Chime Voice Connector.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_phone_numbers_from_voice_connector(
VoiceConnectorId='string',
E164PhoneNumbers=[
'string',
]
)
[REQUIRED]
The Amazon Chime Voice Connector ID.
List of phone numbers, in E.164 format.
dict
Response Syntax
{
'PhoneNumberErrors': [
{
'PhoneNumberId': 'string',
'ErrorCode': 'Unauthorized'|'Forbidden'|'NotFound'|'BadRequest'|'Conflict'|'ServiceFailure'|'ServiceUnavailable'|'Unprocessable'|'Throttled'|'PreconditionFailed',
'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.
Generate a presigned url given a client, its method, and arguments
The presigned url
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'
)
[REQUIRED]
The Amazon Chime account ID.
{
'Account': {
'AwsAccountId': 'string',
'AccountId': 'string',
'Name': 'string',
'AccountType': 'Team'|'EnterpriseDirectory'|'EnterpriseLWA'|'EnterpriseOIDC',
'CreatedTimestamp': datetime(2015, 1, 1),
'DefaultLicense': 'Basic'|'Plus'|'Pro'|'ProTrial',
'SupportedLicenses': [
'Basic'|'Plus'|'Pro'|'ProTrial',
]
}
}
Response Structure
The Amazon Chime account details.
The AWS account ID.
The Amazon Chime account ID.
The Amazon Chime account name.
The Amazon Chime account type. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide .
The Amazon Chime account creation timestamp, in ISO 8601 format.
The default license for the Amazon Chime account.
Supported licenses for the Amazon Chime account.
Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dial out settings. For more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide .
See also: AWS API Documentation
Request Syntax
response = client.get_account_settings(
AccountId='string'
)
[REQUIRED]
The Amazon Chime account ID.
{
'AccountSettings': {
'DisableRemoteControl': True|False,
'EnableDialOut': True|False
}
}
Response Structure
The Amazon Chime account settings.
Setting that stops or starts remote control of shared screens during meetings.
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 .
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'
)
[REQUIRED]
The Amazon Chime account ID.
[REQUIRED]
The bot ID.
dict
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.
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'
)
[REQUIRED]
The Amazon Chime account ID.
[REQUIRED]
The bot ID.
dict
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.
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()
{
'BusinessCalling': {
'CdrBucket': 'string'
},
'VoiceConnector': {
'CdrBucket': 'string'
}
}
Response Structure
The Amazon Chime Business Calling settings.
The Amazon S3 bucket designated for call detail record storage.
The Amazon Chime Voice Connector settings.
The Amazon S3 bucket designated for call detail record storage.
Create a paginator for an operation.
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'
)
[REQUIRED]
The phone number ID.
{
'PhoneNumber': {
'PhoneNumberId': 'string',
'E164PhoneNumber': 'string',
'Type': 'Local'|'TollFree',
'ProductType': 'BusinessCalling'|'VoiceConnector',
'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',
'AssociatedTimestamp': datetime(2015, 1, 1)
},
],
'CreatedTimestamp': datetime(2015, 1, 1),
'UpdatedTimestamp': datetime(2015, 1, 1),
'DeletionTimestamp': datetime(2015, 1, 1)
}
}
Response Structure
The phone number details.
The phone number ID.
The phone number, in E.164 format.
The phone number type.
The phone number product type.
The phone number status.
The phone number capabilities.
Allows or denies inbound calling for the specified phone number.
Allows or denies outbound calling for the specified phone number.
Allows or denies inbound SMS messaging for the specified phone number.
Allows or denies outbound SMS messaging for the specified phone number.
Allows or denies inbound MMS messaging for the specified phone number.
Allows or denies outbound MMS messaging for the specified phone number.
The phone number associations.
The phone number associations, such as Amazon Chime account ID, Amazon Chime user ID, or Amazon Chime Voice Connector ID.
Contains the ID for the entity specified in Name.
Defines the association with an Amazon Chime account ID, user ID, or Amazon Chime Voice Connector ID.
The timestamp of the phone number association, in ISO 8601 format.
The phone number creation timestamp, in ISO 8601 format.
The updated phone number timestamp, in ISO 8601 format.
The deleted phone number timestamp, in ISO 8601 format.
Retrieves details for the specified phone number order, such as 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'
)
[REQUIRED]
The ID for the phone number order.
{
'PhoneNumberOrder': {
'PhoneNumberOrderId': 'string',
'ProductType': 'BusinessCalling'|'VoiceConnector',
'Status': 'Processing'|'Successful'|'Failed'|'Partial',
'OrderedPhoneNumbers': [
{
'E164PhoneNumber': 'string',
'Status': 'Processing'|'Acquired'|'Failed'
},
],
'CreatedTimestamp': datetime(2015, 1, 1),
'UpdatedTimestamp': datetime(2015, 1, 1)
}
}
Response Structure
The phone number order details.
The phone number order ID.
The phone number order product type.
The status of the phone number order.
The ordered phone number details, such as the phone number in E.164 format and the phone number status.
A phone number for which an order has been placed.
The phone number, in E.164 format.
The phone number status.
The phone number order creation timestamp, in ISO 8601 format.
The updated phone number order timestamp, in ISO 8601 format.
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'
)
[REQUIRED]
The Amazon Chime account ID.
[REQUIRED]
The user ID.
dict
Response Syntax
{
'User': {
'UserId': 'string',
'AccountId': 'string',
'PrimaryEmail': 'string',
'PrimaryProvisionedNumber': 'string',
'DisplayName': 'string',
'LicenseType': 'Basic'|'Plus'|'Pro'|'ProTrial',
'UserRegistrationStatus': 'Unregistered'|'Registered'|'Suspended',
'UserInvitationStatus': 'Pending'|'Accepted'|'Failed',
'RegisteredOn': datetime(2015, 1, 1),
'InvitedOn': datetime(2015, 1, 1),
'PersonalPIN': 'string'
}
}
Response Structure
(dict) --
User (dict) --
The user details.
UserId (string) --
The user ID.
AccountId (string) --
The Amazon Chime account ID.
PrimaryEmail (string) --
The primary email address of the user.
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.
UserRegistrationStatus (string) --
The user registration status.
UserInvitationStatus (string) --
The user invite status.
RegisteredOn (datetime) --
Date and time when the user is registered, in ISO 8601 format.
InvitedOn (datetime) --
Date and time when the user is invited to the Amazon Chime account, in ISO 8601 format.
PersonalPIN (string) --
The user's personal meeting PIN.
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'
)
[REQUIRED]
The Amazon Chime account ID.
[REQUIRED]
The user ID.
dict
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.
Retrieves details for the specified Amazon Chime Voice Connector, such as timestamps, name, outbound host, and encryption requirements.
See also: AWS API Documentation
Request Syntax
response = client.get_voice_connector(
VoiceConnectorId='string'
)
[REQUIRED]
The Amazon Chime Voice Connector ID.
{
'VoiceConnector': {
'VoiceConnectorId': 'string',
'Name': 'string',
'OutboundHostName': 'string',
'RequireEncryption': True|False,
'CreatedTimestamp': datetime(2015, 1, 1),
'UpdatedTimestamp': datetime(2015, 1, 1)
}
}
Response Structure
The Amazon Chime Voice Connector details.
The Amazon Chime Voice Connector ID.
The name of the Amazon Chime Voice Connector.
The outbound host name for the Amazon Chime Voice Connector.
Designates whether encryption is required for the Amazon Chime Voice Connector.
The Amazon Chime Voice Connector creation timestamp, in ISO 8601 format.
The updated Amazon Chime Voice Connector timestamp, in ISO 8601 format.
Retrieves origination setting details for the specified Amazon Chime Voice Connector.
See also: AWS API Documentation
Request Syntax
response = client.get_voice_connector_origination(
VoiceConnectorId='string'
)
[REQUIRED]
The Amazon Chime Voice Connector ID.
{
'Origination': {
'Routes': [
{
'Host': 'string',
'Port': 123,
'Protocol': 'TCP'|'UDP',
'Priority': 123,
'Weight': 123
},
],
'Disabled': True|False
}
}
Response Structure
The origination setting details.
The call distribution properties defined for your SIP hosts. Valid range: Minimum value of 1. Maximum value of 20.
Origination routes define call distribution properties for your SIP hosts to receive inbound calls using your Amazon Chime Voice Connector. Limit: 10 origination routes per Amazon Chime Voice Connector.
The FODN or IP address to contact for origination traffic.
The designated origination route port. Defaults to 5060.
The protocol to use for the origination route. Encryption-enabled Amazon Chime Voice Connectors use TCP protocol by default.
The priority associated with the host, with 1 being the highest priority. Higher priority hosts are attempted first.
The weight associated with the host. If hosts are equal in priority, calls are distributed among them based on their relative weight.
When origination settings are disabled, inbound calls are not enabled for your Amazon Chime Voice Connector.
Retrieves termination setting details for the specified Amazon Chime Voice Connector.
See also: AWS API Documentation
Request Syntax
response = client.get_voice_connector_termination(
VoiceConnectorId='string'
)
[REQUIRED]
The Amazon Chime Voice Connector ID.
{
'Termination': {
'CpsLimit': 123,
'DefaultPhoneNumber': 'string',
'CallingRegions': [
'string',
],
'CidrAllowedList': [
'string',
],
'Disabled': True|False
}
}
Response Structure
The termination setting details.
The limit on calls per second. Max value based on account service limit. Default value of 1.
The default caller ID phone number.
The countries to which calls are allowed.
The IP addresses allowed to make calls, in CIDR format.
When termination settings are disabled, outbound calls can not be made.
Retrieves information about the last time a SIP OPTIONS ping was received from your SIP infrastructure for the specified Amazon Chime Voice Connector.
See also: AWS API Documentation
Request Syntax
response = client.get_voice_connector_termination_health(
VoiceConnectorId='string'
)
[REQUIRED]
The Amazon Chime Voice Connector ID.
{
'TerminationHealth': {
'Timestamp': datetime(2015, 1, 1),
'Source': 'string'
}
}
Response Structure
The termination health details.
The timestamp, in ISO 8601 format.
The source IP address.
Returns an object that can wait for some condition.
Sends email invites to as many as 50 users, inviting them to the specified Amazon Chime Team account. Only Team account types are currently supported for this action.
See also: AWS API Documentation
Request Syntax
response = client.invite_users(
AccountId='string',
UserEmailList=[
'string',
]
)
[REQUIRED]
The Amazon Chime account ID.
[REQUIRED]
The user email addresses to which to send the invite.
dict
Response Syntax
{
'Invites': [
{
'InviteId': 'string',
'Status': 'Pending'|'Accepted'|'Failed',
'EmailAddress': 'string',
'EmailStatus': 'NotSent'|'Sent'|'Failed'
},
]
}
Response Structure
(dict) --
Invites (list) --
The invite details.
(dict) --
Invitation object returned after emailing users to invite them to join the Amazon Chime Team account.
InviteId (string) --
The invite ID.
Status (string) --
The status of the invite.
EmailAddress (string) --
The email address to which the invite is sent.
EmailStatus (string) --
The status of the invite email.
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
)
dict
Response Syntax
{
'Accounts': [
{
'AwsAccountId': 'string',
'AccountId': 'string',
'Name': 'string',
'AccountType': 'Team'|'EnterpriseDirectory'|'EnterpriseLWA'|'EnterpriseOIDC',
'CreatedTimestamp': datetime(2015, 1, 1),
'DefaultLicense': 'Basic'|'Plus'|'Pro'|'ProTrial',
'SupportedLicenses': [
'Basic'|'Plus'|'Pro'|'ProTrial',
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Accounts (list) --
List of Amazon Chime accounts and account details.
(dict) --
The Amazon Chime account details. An AWS account can have multiple Amazon Chime accounts.
AwsAccountId (string) --
The AWS account ID.
AccountId (string) --
The Amazon Chime account ID.
Name (string) --
The Amazon Chime account name.
AccountType (string) --
The Amazon Chime account type. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide .
CreatedTimestamp (datetime) --
The Amazon Chime account creation timestamp, in ISO 8601 format.
DefaultLicense (string) --
The default license for the Amazon Chime account.
SupportedLicenses (list) --
Supported licenses for the Amazon Chime account.
NextToken (string) --
The token to use to retrieve the next page of results.
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'
)
[REQUIRED]
The Amazon Chime account ID.
dict
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.
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
)
dict
Response Syntax
{
'PhoneNumberOrders': [
{
'PhoneNumberOrderId': 'string',
'ProductType': 'BusinessCalling'|'VoiceConnector',
'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 timestamp, in ISO 8601 format.
UpdatedTimestamp (datetime) --
The updated phone number order timestamp, in ISO 8601 format.
NextToken (string) --
The token to use to retrieve the next page of results.
Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, or Amazon Chime Voice Connector.
See also: AWS API Documentation
Request Syntax
response = client.list_phone_numbers(
Status='AcquireInProgress'|'AcquireFailed'|'Unassigned'|'Assigned'|'ReleaseInProgress'|'DeleteInProgress'|'ReleaseFailed'|'DeleteFailed',
ProductType='BusinessCalling'|'VoiceConnector',
FilterName='AccountId'|'UserId'|'VoiceConnectorId',
FilterValue='string',
MaxResults=123,
NextToken='string'
)
dict
Response Syntax
{
'PhoneNumbers': [
{
'PhoneNumberId': 'string',
'E164PhoneNumber': 'string',
'Type': 'Local'|'TollFree',
'ProductType': 'BusinessCalling'|'VoiceConnector',
'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',
'AssociatedTimestamp': datetime(2015, 1, 1)
},
],
'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.
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, or Amazon Chime Voice Connector 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, or Amazon Chime Voice Connector ID.
AssociatedTimestamp (datetime) --
The timestamp of the phone number association, in ISO 8601 format.
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.
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',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The Amazon Chime account ID.
dict
Response Syntax
{
'Users': [
{
'UserId': 'string',
'AccountId': 'string',
'PrimaryEmail': 'string',
'PrimaryProvisionedNumber': 'string',
'DisplayName': 'string',
'LicenseType': 'Basic'|'Plus'|'Pro'|'ProTrial',
'UserRegistrationStatus': 'Unregistered'|'Registered'|'Suspended',
'UserInvitationStatus': 'Pending'|'Accepted'|'Failed',
'RegisteredOn': datetime(2015, 1, 1),
'InvitedOn': datetime(2015, 1, 1),
'PersonalPIN': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Users (list) --
List of users and user details.
(dict) --
The user on the Amazon Chime account.
UserId (string) --
The user ID.
AccountId (string) --
The Amazon Chime account ID.
PrimaryEmail (string) --
The primary email address of the user.
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.
UserRegistrationStatus (string) --
The user registration status.
UserInvitationStatus (string) --
The user invite status.
RegisteredOn (datetime) --
Date and time when the user is registered, in ISO 8601 format.
InvitedOn (datetime) --
Date and time when the user is invited to the Amazon Chime account, in ISO 8601 format.
PersonalPIN (string) --
The user's personal meeting PIN.
NextToken (string) --
The token to use to retrieve the next page of results.
Lists the SIP credentials for the specified Amazon Chime Voice Connector.
See also: AWS API Documentation
Request Syntax
response = client.list_voice_connector_termination_credentials(
VoiceConnectorId='string'
)
[REQUIRED]
The Amazon Chime Voice Connector ID.
{
'Usernames': [
'string',
]
}
Response Structure
A list of user names.
Lists the Amazon Chime Voice Connectors for the administrator's AWS account.
See also: AWS API Documentation
Request Syntax
response = client.list_voice_connectors(
NextToken='string',
MaxResults=123
)
dict
Response Syntax
{
'VoiceConnectors': [
{
'VoiceConnectorId': 'string',
'Name': 'string',
'OutboundHostName': 'string',
'RequireEncryption': True|False,
'CreatedTimestamp': datetime(2015, 1, 1),
'UpdatedTimestamp': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
VoiceConnectors (list) --
The details of the Amazon Chime Voice Connectors.
(dict) --
The Amazon Chime Voice Connector configuration, including outbound host name and encryption settings.
VoiceConnectorId (string) --
The Amazon Chime Voice Connector ID.
Name (string) --
The name of the Amazon Chime Voice Connector.
OutboundHostName (string) --
The outbound host name for the Amazon Chime Voice Connector.
RequireEncryption (boolean) --
Designates whether encryption is required for the Amazon Chime Voice Connector.
CreatedTimestamp (datetime) --
The Amazon Chime Voice Connector creation timestamp, in ISO 8601 format.
UpdatedTimestamp (datetime) --
The updated Amazon Chime Voice Connector timestamp, in ISO 8601 format.
NextToken (string) --
The token to use to retrieve the next page of results.
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'
)
[REQUIRED]
The Amazon Chime account ID.
[REQUIRED]
The user ID.
dict
Response Syntax
{}
Response Structure
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'
)
[REQUIRED]
The Amazon Chime account ID.
[REQUIRED]
The bot ID.
dict
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 either an HTTPS endpoint or a 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.
Adds origination settings for the specified Amazon Chime Voice Connector.
See also: AWS API Documentation
Request Syntax
response = client.put_voice_connector_origination(
VoiceConnectorId='string',
Origination={
'Routes': [
{
'Host': 'string',
'Port': 123,
'Protocol': 'TCP'|'UDP',
'Priority': 123,
'Weight': 123
},
],
'Disabled': True|False
}
)
[REQUIRED]
The Amazon Chime Voice Connector ID.
[REQUIRED]
The origination setting details to add.
The call distribution properties defined for your SIP hosts. Valid range: Minimum value of 1. Maximum value of 20.
Origination routes define call distribution properties for your SIP hosts to receive inbound calls using your Amazon Chime Voice Connector. Limit: 10 origination routes per Amazon Chime Voice Connector.
The FODN or IP address to contact for origination traffic.
The designated origination route port. Defaults to 5060.
The protocol to use for the origination route. Encryption-enabled Amazon Chime Voice Connectors use TCP protocol by default.
The priority associated with the host, with 1 being the highest priority. Higher priority hosts are attempted first.
The weight associated with the host. If hosts are equal in priority, calls are distributed among them based on their relative weight.
When origination settings are disabled, inbound calls are not enabled for your Amazon Chime Voice Connector.
dict
Response Syntax
{
'Origination': {
'Routes': [
{
'Host': 'string',
'Port': 123,
'Protocol': 'TCP'|'UDP',
'Priority': 123,
'Weight': 123
},
],
'Disabled': True|False
}
}
Response Structure
(dict) --
Origination (dict) --
The updated origination setting details.
Routes (list) --
The call distribution properties defined for your SIP hosts. Valid range: Minimum value of 1. Maximum value of 20.
(dict) --
Origination routes define call distribution properties for your SIP hosts to receive inbound calls using your Amazon Chime Voice Connector. Limit: 10 origination routes per Amazon Chime Voice Connector.
Host (string) --
The FODN or IP address to contact for origination traffic.
Port (integer) --
The designated origination route port. Defaults to 5060.
Protocol (string) --
The protocol to use for the origination route. Encryption-enabled Amazon Chime Voice Connectors use TCP protocol by default.
Priority (integer) --
The priority associated with the host, with 1 being the highest priority. Higher priority hosts are attempted first.
Weight (integer) --
The weight associated with the host. If hosts are equal in priority, calls are distributed among them based on their relative weight.
Disabled (boolean) --
When origination settings are disabled, inbound calls are not enabled for your Amazon Chime Voice Connector.
Adds termination settings for the specified Amazon Chime Voice Connector.
See also: AWS API Documentation
Request Syntax
response = client.put_voice_connector_termination(
VoiceConnectorId='string',
Termination={
'CpsLimit': 123,
'DefaultPhoneNumber': 'string',
'CallingRegions': [
'string',
],
'CidrAllowedList': [
'string',
],
'Disabled': True|False
}
)
[REQUIRED]
The Amazon Chime Voice Connector ID.
[REQUIRED]
The termination setting details to add.
The limit on calls per second. Max value based on account service limit. Default value of 1.
The default caller ID phone number.
The countries to which calls are allowed.
The IP addresses allowed to make calls, in CIDR format.
When termination settings are disabled, outbound calls can not be made.
dict
Response Syntax
{
'Termination': {
'CpsLimit': 123,
'DefaultPhoneNumber': 'string',
'CallingRegions': [
'string',
],
'CidrAllowedList': [
'string',
],
'Disabled': True|False
}
}
Response Structure
(dict) --
Termination (dict) --
The updated termination setting details.
CpsLimit (integer) --
The limit on calls per second. Max value based on account service limit. Default value of 1.
DefaultPhoneNumber (string) --
The default caller ID phone number.
CallingRegions (list) --
The countries to which calls are allowed.
CidrAllowedList (list) --
The IP addresses allowed to make calls, in CIDR format.
Disabled (boolean) --
When termination settings are disabled, outbound calls can not be made.
Adds termination SIP credentials for the specified Amazon Chime Voice Connector.
See also: AWS API Documentation
Request Syntax
response = client.put_voice_connector_termination_credentials(
VoiceConnectorId='string',
Credentials=[
{
'Username': 'string',
'Password': 'string'
},
]
)
[REQUIRED]
The Amazon Chime Voice Connector ID.
The termination SIP credentials.
The SIP credentials used to authenticate requests to your Amazon Chime Voice Connector.
The RFC2617 compliant user name associated with the SIP credentials, in US-ASCII format.
The RFC2617 compliant password associated with the SIP credentials, in US-ASCII format.
None
Regenerates the security token for a bot.
See also: AWS API Documentation
Request Syntax
response = client.regenerate_security_token(
AccountId='string',
BotId='string'
)
[REQUIRED]
The Amazon Chime account ID.
[REQUIRED]
The bot ID.
dict
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 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.
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'
)
[REQUIRED]
The Amazon Chime account ID.
[REQUIRED]
The user ID.
dict
Response Syntax
{
'User': {
'UserId': 'string',
'AccountId': 'string',
'PrimaryEmail': 'string',
'PrimaryProvisionedNumber': 'string',
'DisplayName': 'string',
'LicenseType': 'Basic'|'Plus'|'Pro'|'ProTrial',
'UserRegistrationStatus': 'Unregistered'|'Registered'|'Suspended',
'UserInvitationStatus': 'Pending'|'Accepted'|'Failed',
'RegisteredOn': datetime(2015, 1, 1),
'InvitedOn': datetime(2015, 1, 1),
'PersonalPIN': 'string'
}
}
Response Structure
(dict) --
User (dict) --
The user details and new personal meeting PIN.
UserId (string) --
The user ID.
AccountId (string) --
The Amazon Chime account ID.
PrimaryEmail (string) --
The primary email address of the user.
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.
UserRegistrationStatus (string) --
The user registration status.
UserInvitationStatus (string) --
The user invite status.
RegisteredOn (datetime) --
Date and time when the user is registered, in ISO 8601 format.
InvitedOn (datetime) --
Date and time when the user is invited to the Amazon Chime account, in ISO 8601 format.
PersonalPIN (string) --
The user's personal meeting PIN.
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'
)
[REQUIRED]
The phone number.
{
'PhoneNumber': {
'PhoneNumberId': 'string',
'E164PhoneNumber': 'string',
'Type': 'Local'|'TollFree',
'ProductType': 'BusinessCalling'|'VoiceConnector',
'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',
'AssociatedTimestamp': datetime(2015, 1, 1)
},
],
'CreatedTimestamp': datetime(2015, 1, 1),
'UpdatedTimestamp': datetime(2015, 1, 1),
'DeletionTimestamp': datetime(2015, 1, 1)
}
}
Response Structure
The phone number details.
The phone number ID.
The phone number, in E.164 format.
The phone number type.
The phone number product type.
The phone number status.
The phone number capabilities.
Allows or denies inbound calling for the specified phone number.
Allows or denies outbound calling for the specified phone number.
Allows or denies inbound SMS messaging for the specified phone number.
Allows or denies outbound SMS messaging for the specified phone number.
Allows or denies inbound MMS messaging for the specified phone number.
Allows or denies outbound MMS messaging for the specified phone number.
The phone number associations.
The phone number associations, such as Amazon Chime account ID, Amazon Chime user ID, or Amazon Chime Voice Connector ID.
Contains the ID for the entity specified in Name.
Defines the association with an Amazon Chime account ID, user ID, or Amazon Chime Voice Connector ID.
The timestamp of the phone number association, in ISO 8601 format.
The phone number creation timestamp, in ISO 8601 format.
The updated phone number timestamp, in ISO 8601 format.
The deleted phone number timestamp, in ISO 8601 format.
Searches phone numbers that can be ordered.
See also: AWS API Documentation
Request Syntax
response = client.search_available_phone_numbers(
AreaCode='string',
City='string',
Country='string',
State='string',
TollFreePrefix='string',
MaxResults=123,
NextToken='string'
)
dict
Response Syntax
{
'E164PhoneNumbers': [
'string',
]
}
Response Structure
(dict) --
E164PhoneNumbers (list) --
List of phone numbers, in E.164 format.
Updates account details for the specified Amazon Chime account. Currently, only account name updates are supported for this action.
See also: AWS API Documentation
Request Syntax
response = client.update_account(
AccountId='string',
Name='string'
)
[REQUIRED]
The Amazon Chime account ID.
dict
Response Syntax
{
'Account': {
'AwsAccountId': 'string',
'AccountId': 'string',
'Name': 'string',
'AccountType': 'Team'|'EnterpriseDirectory'|'EnterpriseLWA'|'EnterpriseOIDC',
'CreatedTimestamp': datetime(2015, 1, 1),
'DefaultLicense': 'Basic'|'Plus'|'Pro'|'ProTrial',
'SupportedLicenses': [
'Basic'|'Plus'|'Pro'|'ProTrial',
]
}
}
Response Structure
(dict) --
Account (dict) --
The 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.
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
}
)
[REQUIRED]
The Amazon Chime account ID.
[REQUIRED]
The Amazon Chime account settings to update.
Setting that stops or starts remote control of shared screens during meetings.
Setting that allows meeting participants to choose the Call me at a phone number option. For more information, see Join a Meeting without the Amazon Chime App .
dict
Response Syntax
{}
Response Structure
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
)
[REQUIRED]
The Amazon Chime account ID.
[REQUIRED]
The bot ID.
dict
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.
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'
}
)
[REQUIRED]
The Amazon Chime Business Calling settings.
The Amazon S3 bucket designated for call detail record storage.
[REQUIRED]
The Amazon Chime Voice Connector settings.
The Amazon S3 bucket designated for call detail record storage.
None
Updates phone number details, such as product type, for the specified phone number ID. For toll-free numbers, you can use only the Amazon Chime Voice Connector product type.
See also: AWS API Documentation
Request Syntax
response = client.update_phone_number(
PhoneNumberId='string',
ProductType='BusinessCalling'|'VoiceConnector'
)
[REQUIRED]
The phone number ID.
dict
Response Syntax
{
'PhoneNumber': {
'PhoneNumberId': 'string',
'E164PhoneNumber': 'string',
'Type': 'Local'|'TollFree',
'ProductType': 'BusinessCalling'|'VoiceConnector',
'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',
'AssociatedTimestamp': datetime(2015, 1, 1)
},
],
'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.
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, or Amazon Chime Voice Connector 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, or Amazon Chime Voice Connector ID.
AssociatedTimestamp (datetime) --
The timestamp of the phone number association, in ISO 8601 format.
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.
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'
)
[REQUIRED]
The Amazon Chime account ID.
[REQUIRED]
The user ID.
dict
Response Syntax
{
'User': {
'UserId': 'string',
'AccountId': 'string',
'PrimaryEmail': 'string',
'PrimaryProvisionedNumber': 'string',
'DisplayName': 'string',
'LicenseType': 'Basic'|'Plus'|'Pro'|'ProTrial',
'UserRegistrationStatus': 'Unregistered'|'Registered'|'Suspended',
'UserInvitationStatus': 'Pending'|'Accepted'|'Failed',
'RegisteredOn': datetime(2015, 1, 1),
'InvitedOn': datetime(2015, 1, 1),
'PersonalPIN': 'string'
}
}
Response Structure
(dict) --
User (dict) --
The updated user details.
UserId (string) --
The user ID.
AccountId (string) --
The Amazon Chime account ID.
PrimaryEmail (string) --
The primary email address of the user.
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.
UserRegistrationStatus (string) --
The user registration status.
UserInvitationStatus (string) --
The user invite status.
RegisteredOn (datetime) --
Date and time when the user is registered, in ISO 8601 format.
InvitedOn (datetime) --
Date and time when the user is invited to the Amazon Chime account, in ISO 8601 format.
PersonalPIN (string) --
The user's personal meeting PIN.
Updates 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
}
}
)
[REQUIRED]
The Amazon Chime account ID.
[REQUIRED]
The user ID.
[REQUIRED]
The user settings to update.
The telephony settings associated with the user.
Allows or denies inbound calling.
Allows or denies outbound calling.
Allows or denies SMS messaging.
None
Updates details for the specified Amazon Chime Voice Connector.
See also: AWS API Documentation
Request Syntax
response = client.update_voice_connector(
VoiceConnectorId='string',
Name='string',
RequireEncryption=True|False
)
[REQUIRED]
The Amazon Chime Voice Connector ID.
[REQUIRED]
The name of the Amazon Chime Voice Connector.
[REQUIRED]
When enabled, requires encryption for the Amazon Chime Voice Connector.
dict
Response Syntax
{
'VoiceConnector': {
'VoiceConnectorId': 'string',
'Name': 'string',
'OutboundHostName': 'string',
'RequireEncryption': True|False,
'CreatedTimestamp': datetime(2015, 1, 1),
'UpdatedTimestamp': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
VoiceConnector (dict) --
The Amazon Chime Voice Connector details.
VoiceConnectorId (string) --
The Amazon Chime Voice Connector ID.
Name (string) --
The name of the Amazon Chime Voice Connector.
OutboundHostName (string) --
The outbound host name for the Amazon Chime Voice Connector.
RequireEncryption (boolean) --
Designates whether encryption is required for the Amazon Chime Voice Connector.
CreatedTimestamp (datetime) --
The Amazon Chime Voice Connector creation timestamp, in ISO 8601 format.
UpdatedTimestamp (datetime) --
The updated Amazon Chime Voice Connector timestamp, in ISO 8601 format.
The available paginators are:
paginator = client.get_paginator('list_accounts')
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'
}
)
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Accounts': [
{
'AwsAccountId': 'string',
'AccountId': 'string',
'Name': 'string',
'AccountType': 'Team'|'EnterpriseDirectory'|'EnterpriseLWA'|'EnterpriseOIDC',
'CreatedTimestamp': datetime(2015, 1, 1),
'DefaultLicense': 'Basic'|'Plus'|'Pro'|'ProTrial',
'SupportedLicenses': [
'Basic'|'Plus'|'Pro'|'ProTrial',
]
},
],
}
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.
paginator = client.get_paginator('list_users')
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',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The Amazon Chime account ID.
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Users': [
{
'UserId': 'string',
'AccountId': 'string',
'PrimaryEmail': 'string',
'PrimaryProvisionedNumber': 'string',
'DisplayName': 'string',
'LicenseType': 'Basic'|'Plus'|'Pro'|'ProTrial',
'UserRegistrationStatus': 'Unregistered'|'Registered'|'Suspended',
'UserInvitationStatus': 'Pending'|'Accepted'|'Failed',
'RegisteredOn': datetime(2015, 1, 1),
'InvitedOn': datetime(2015, 1, 1),
'PersonalPIN': 'string'
},
],
}
Response Structure
(dict) --
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.
UserRegistrationStatus (string) --
The user registration status.
UserInvitationStatus (string) --
The user invite status.
RegisteredOn (datetime) --
Date and time when the user is registered, in ISO 8601 format.
InvitedOn (datetime) --
Date and time when the user is invited to the Amazon Chime account, in ISO 8601 format.
PersonalPIN (string) --
The user's personal meeting PIN.