2020/07/31 - Amazon Chime - 10 updated api methods
Changes This release increases the CreateMeetingWithAttendee max attendee limit to 10.
{'PhoneNumberErrors': {'ErrorCode': {'Throttling'}}}
Associates phone numbers with the specified Amazon Chime Voice Connector.
See also: AWS API Documentation
Request Syntax
client.associate_phone_numbers_with_voice_connector(
VoiceConnectorId='string',
E164PhoneNumbers=[
'string',
],
ForceAssociate=True|False
)
string
[REQUIRED]
The Amazon Chime Voice Connector ID.
list
[REQUIRED]
List of phone numbers, in E.164 format.
(string) --
boolean
If true, associates the provided phone numbers with the provided Amazon Chime Voice Connector and removes any previously existing associations. If false, does not associate any phone numbers that have previously existing associations.
dict
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.
{'PhoneNumberErrors': {'ErrorCode': {'Throttling'}}}
Associates phone numbers with the specified Amazon Chime Voice Connector group.
See also: AWS API Documentation
Request Syntax
client.associate_phone_numbers_with_voice_connector_group(
VoiceConnectorGroupId='string',
E164PhoneNumbers=[
'string',
],
ForceAssociate=True|False
)
string
[REQUIRED]
The Amazon Chime Voice Connector group ID.
list
[REQUIRED]
List of phone numbers, in E.164 format.
(string) --
boolean
If true, associates the provided phone numbers with the provided Amazon Chime Voice Connector Group and removes any previously existing associations. If false, does not associate any phone numbers that have previously existing associations.
dict
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.
{'Errors': {'ErrorCode': {'Throttling'}}}
Adds up to 50 members to a chat room in an Amazon Chime Enterprise account. Members can be either 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
client.batch_create_room_membership(
AccountId='string',
RoomId='string',
MembershipItemList=[
{
'MemberId': 'string',
'Role': 'Administrator'|'Member'
},
]
)
string
[REQUIRED]
The Amazon Chime account ID.
string
[REQUIRED]
The room ID.
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.
dict
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.
{'PhoneNumberErrors': {'ErrorCode': {'Throttling'}}}
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
client.batch_delete_phone_number(
PhoneNumberIds=[
'string',
]
)
list
[REQUIRED]
List of phone number IDs.
(string) --
dict
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.
{'UserErrors': {'ErrorCode': {'Throttling'}}}
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
client.batch_suspend_user(
AccountId='string',
UserIdList=[
'string',
]
)
string
[REQUIRED]
The Amazon Chime account ID.
list
[REQUIRED]
The request containing the user IDs to suspend.
(string) --
dict
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.
{'UserErrors': {'ErrorCode': {'Throttling'}}}
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
client.batch_unsuspend_user(
AccountId='string',
UserIdList=[
'string',
]
)
string
[REQUIRED]
The Amazon Chime account ID.
list
[REQUIRED]
The request containing the user IDs to unsuspend.
(string) --
dict
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.
{'PhoneNumberErrors': {'ErrorCode': {'Throttling'}}}
Updates phone number product types or calling names. You can update one attribute at a time for each UpdatePhoneNumberRequestItem . For example, you can update either the product type or the calling name.
For product types, choose from Amazon Chime Business Calling and Amazon Chime Voice Connector. For toll-free numbers, you must use the Amazon Chime Voice Connector 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
client.batch_update_phone_number(
UpdatePhoneNumberRequestItems=[
{
'PhoneNumberId': 'string',
'ProductType': 'BusinessCalling'|'VoiceConnector',
'CallingName': 'string'
},
]
)
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.
dict
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.
{'UserErrors': {'ErrorCode': {'Throttling'}}}
Updates user details within the UpdateUserRequestItem object for up to 20 users for the specified Amazon Chime account. Currently, only LicenseType updates are supported for this action.
See also: AWS API Documentation
Request Syntax
client.batch_update_user(
AccountId='string',
UpdateUserRequestItems=[
{
'UserId': 'string',
'LicenseType': 'Basic'|'Plus'|'Pro'|'ProTrial',
'UserType': 'PrivateUser'|'SharedDevice',
'AlexaForBusinessMetadata': {
'IsAlexaForBusinessEnabled': True|False,
'AlexaForBusinessRoomArn': 'string'
}
},
]
)
string
[REQUIRED]
The Amazon Chime account ID.
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.
dict
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.
{'PhoneNumberErrors': {'ErrorCode': {'Throttling'}}}
Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector.
See also: AWS API Documentation
Request Syntax
client.disassociate_phone_numbers_from_voice_connector(
VoiceConnectorId='string',
E164PhoneNumbers=[
'string',
]
)
string
[REQUIRED]
The Amazon Chime Voice Connector ID.
list
[REQUIRED]
List of phone numbers, in E.164 format.
(string) --
dict
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.
{'PhoneNumberErrors': {'ErrorCode': {'Throttling'}}}
Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector group.
See also: AWS API Documentation
Request Syntax
client.disassociate_phone_numbers_from_voice_connector_group(
VoiceConnectorGroupId='string',
E164PhoneNumbers=[
'string',
]
)
string
[REQUIRED]
The Amazon Chime Voice Connector group ID.
list
[REQUIRED]
List of phone numbers, in E.164 format.
(string) --
dict
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.