Table of Contents
Chime.Client¶A low-level client representing Amazon Chime
The Amazon Chime API (application programming interface) is designed for developers to 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. It also includes API actions for use with the Amazon Chime SDK, which developers use to build their own communication applications. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide .
You can use an AWS SDK, the AWS Command Line Interface (AWS CLI), or the REST API to make API calls. We recommend using an AWS SDK or the AWS CLI. Each API operation includes links to information about using it 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_phone_numbers_with_voice_connector()associate_phone_numbers_with_voice_connector_group()associate_signin_delegate_groups_with_account()batch_create_attendee()batch_create_channel_membership()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_app_instance()create_app_instance_admin()create_app_instance_user()create_attendee()create_bot()create_channel()create_channel_ban()create_channel_membership()create_channel_moderator()create_media_capture_pipeline()create_meeting()create_meeting_dial_out()create_meeting_with_attendees()create_phone_number_order()create_proxy_session()create_room()create_room_membership()create_sip_media_application()create_sip_media_application_call()create_sip_rule()create_user()create_voice_connector()create_voice_connector_group()delete_account()delete_app_instance()delete_app_instance_admin()delete_app_instance_streaming_configurations()delete_app_instance_user()delete_attendee()delete_channel()delete_channel_ban()delete_channel_membership()delete_channel_message()delete_channel_moderator()delete_events_configuration()delete_media_capture_pipeline()delete_meeting()delete_phone_number()delete_proxy_session()delete_room()delete_room_membership()delete_sip_media_application()delete_sip_rule()delete_voice_connector()delete_voice_connector_emergency_calling_configuration()delete_voice_connector_group()delete_voice_connector_origination()delete_voice_connector_proxy()delete_voice_connector_streaming_configuration()delete_voice_connector_termination()delete_voice_connector_termination_credentials()describe_app_instance()describe_app_instance_admin()describe_app_instance_user()describe_channel()describe_channel_ban()describe_channel_membership()describe_channel_membership_for_app_instance_user()describe_channel_moderated_by_app_instance_user()describe_channel_moderator()disassociate_phone_number_from_user()disassociate_phone_numbers_from_voice_connector()disassociate_phone_numbers_from_voice_connector_group()disassociate_signin_delegate_groups_from_account()get_account()get_account_settings()get_app_instance_retention_settings()get_app_instance_streaming_configurations()get_attendee()get_bot()get_channel_message()get_events_configuration()get_global_settings()get_media_capture_pipeline()get_meeting()get_messaging_session_endpoint()get_paginator()get_phone_number()get_phone_number_order()get_phone_number_settings()get_proxy_session()get_retention_settings()get_room()get_sip_media_application()get_sip_media_application_logging_configuration()get_sip_rule()get_user()get_user_settings()get_voice_connector()get_voice_connector_emergency_calling_configuration()get_voice_connector_group()get_voice_connector_logging_configuration()get_voice_connector_origination()get_voice_connector_proxy()get_voice_connector_streaming_configuration()get_voice_connector_termination()get_voice_connector_termination_health()get_waiter()invite_users()list_accounts()list_app_instance_admins()list_app_instance_users()list_app_instances()list_attendee_tags()list_attendees()list_bots()list_channel_bans()list_channel_memberships()list_channel_memberships_for_app_instance_user()list_channel_messages()list_channel_moderators()list_channels()list_channels_moderated_by_app_instance_user()list_media_capture_pipelines()list_meeting_tags()list_meetings()list_phone_number_orders()list_phone_numbers()list_proxy_sessions()list_room_memberships()list_rooms()list_sip_media_applications()list_sip_rules()list_supported_phone_number_countries()list_tags_for_resource()list_users()list_voice_connector_groups()list_voice_connector_termination_credentials()list_voice_connectors()logout_user()put_app_instance_retention_settings()put_app_instance_streaming_configurations()put_events_configuration()put_retention_settings()put_sip_media_application_logging_configuration()put_voice_connector_emergency_calling_configuration()put_voice_connector_logging_configuration()put_voice_connector_origination()put_voice_connector_proxy()put_voice_connector_streaming_configuration()put_voice_connector_termination()put_voice_connector_termination_credentials()redact_channel_message()redact_conversation_message()redact_room_message()regenerate_security_token()reset_personal_pin()restore_phone_number()search_available_phone_numbers()send_channel_message()start_meeting_transcription()stop_meeting_transcription()tag_attendee()tag_meeting()tag_resource()untag_attendee()untag_meeting()untag_resource()update_account()update_account_settings()update_app_instance()update_app_instance_user()update_bot()update_channel()update_channel_message()update_channel_read_marker()update_global_settings()update_phone_number()update_phone_number_settings()update_proxy_session()update_room()update_room_membership()update_sip_media_application()update_sip_media_application_call()update_sip_rule()update_user()update_user_settings()update_voice_connector()update_voice_connector_group()validate_e911_address()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'
)
[REQUIRED]
The Amazon Chime account ID.
[REQUIRED]
The user ID.
[REQUIRED]
The phone number, in E.164 format.
dict
Response Syntax
{}
Response Structure
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.AccessDeniedExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionassociate_phone_numbers_with_voice_connector(**kwargs)¶Associates phone numbers 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',
],
ForceAssociate=True|False
)
[REQUIRED]
The Amazon Chime Voice Connector ID.
[REQUIRED]
List of phone numbers, in E.164 format.
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.
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.AccessDeniedExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionassociate_phone_numbers_with_voice_connector_group(**kwargs)¶Associates phone numbers with the specified Amazon Chime Voice Connector group.
See also: AWS API Documentation
Request Syntax
response = client.associate_phone_numbers_with_voice_connector_group(
VoiceConnectorGroupId='string',
E164PhoneNumbers=[
'string',
],
ForceAssociate=True|False
)
[REQUIRED]
The Amazon Chime Voice Connector group ID.
[REQUIRED]
List of phone numbers, in E.164 format.
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.
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.AccessDeniedExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionassociate_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'
},
]
)
[REQUIRED]
The Amazon Chime account ID.
[REQUIRED]
The sign-in delegate groups.
An Active Directory (AD) group whose members are granted permission to act as delegates.
The group name.
dict
Response Syntax
{}
Response Structure
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionbatch_create_attendee(**kwargs)¶Creates up to 100 new attendees for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide .
See also: AWS API Documentation
Request Syntax
response = client.batch_create_attendee(
MeetingId='string',
Attendees=[
{
'ExternalUserId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
)
[REQUIRED]
The Amazon Chime SDK meeting ID.
[REQUIRED]
The request containing the attendees to create.
The Amazon Chime SDK attendee fields to create, used with the BatchCreateAttendee action.
The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.
The tag key-value pairs.
Describes a tag applied to a resource.
The key of the tag.
The value of the tag.
dict
Response Syntax
{
'Attendees': [
{
'ExternalUserId': 'string',
'AttendeeId': 'string',
'JoinToken': 'string'
},
],
'Errors': [
{
'ExternalUserId': 'string',
'ErrorCode': 'string',
'ErrorMessage': 'string'
},
]
}
Response Structure
(dict) --
Attendees (list) --
The attendee information, including attendees IDs and join tokens.
(dict) --
An Amazon Chime SDK meeting attendee. Includes a unique AttendeeId and JoinToken . The JoinToken allows a client to authenticate and join as the specified attendee. The JoinToken expires when the meeting ends or when DeleteAttendee is called. After that, the attendee is unable to join the meeting.
We recommend securely transferring each JoinToken from your server application to the client so that no other client has access to the token except for the one authorized to represent the attendee.
ExternalUserId (string) --
The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.
AttendeeId (string) --
The Amazon Chime SDK attendee ID.
JoinToken (string) --
The join token used by the Amazon Chime SDK attendee.
Errors (list) --
If the action fails for one or more of the attendees in the request, a list of the attendees is returned, along with error codes and error messages.
(dict) --
The list of errors returned when errors are encountered during the BatchCreateAttendee and CreateAttendee actions. This includes external user IDs, error codes, and error messages.
ExternalUserId (string) --
The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.
ErrorCode (string) --
The error code.
ErrorMessage (string) --
The error message.
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ResourceLimitExceededExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionbatch_create_channel_membership(**kwargs)¶Adds a specified number of users to a channel.
See also: AWS API Documentation
Request Syntax
response = client.batch_create_channel_membership(
ChannelArn='string',
Type='DEFAULT'|'HIDDEN',
MemberArns=[
'string',
],
ChimeBearer='string'
)
[REQUIRED]
The ARN of the channel to which you're adding users.
DEFAULT or HIDDEN . Default members are always returned as part of ListChannelMemberships . Hidden members are only returned if the type filter in ListChannelMemberships equals HIDDEN . Otherwise hidden members are not returned. This is only supported by moderators.[REQUIRED]
The ARNs of the members you want to add to the channel.
AppInstanceUserArn of the user that makes the API call.dict
Response Syntax
{
'BatchChannelMemberships': {
'InvitedBy': {
'Arn': 'string',
'Name': 'string'
},
'Type': 'DEFAULT'|'HIDDEN',
'Members': [
{
'Arn': 'string',
'Name': 'string'
},
],
'ChannelArn': 'string'
},
'Errors': [
{
'MemberArn': 'string',
'ErrorCode': 'BadRequest'|'Conflict'|'Forbidden'|'NotFound'|'PreconditionFailed'|'ResourceLimitExceeded'|'ServiceFailure'|'AccessDenied'|'ServiceUnavailable'|'Throttled'|'Throttling'|'Unauthorized'|'Unprocessable'|'VoiceConnectorGroupAssociationsExist'|'PhoneNumberAssociationsExist',
'ErrorMessage': 'string'
},
]
}
Response Structure
(dict) --
BatchChannelMemberships (dict) --
The list of channel memberships in the response.
InvitedBy (dict) --
The identifier of the member who invited another member.
Arn (string) --
The ARN in an Identity.
Name (string) --
The name in an Identity.
Type (string) --
The membership types set for the channel users.
Members (list) --
The users successfully added to the request.
(dict) --
The details of a user.
Arn (string) --
The ARN in an Identity.
Name (string) --
The name in an Identity.
ChannelArn (string) --
The ARN of the channel to which you're adding users.
Errors (list) --
If the action fails for one or more of the memberships in the request, a list of the memberships is returned, along with error codes and error messages.
(dict) --
A list of failed member ARNs, error codes, and error messages.
MemberArn (string) --
The ARN of the member that the service couldn't add.
ErrorCode (string) --
The error code.
ErrorMessage (string) --
The error message.
Exceptions
Chime.Client.exceptions.ServiceFailureExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.ThrottledClientExceptionbatch_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'
},
]
)
[REQUIRED]
The Amazon Chime account ID.
[REQUIRED]
The room ID.
[REQUIRED]
The list of membership items.
Membership details, such as member ID and member role.
The member ID.
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.
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionbatch_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',
]
)
[REQUIRED]
List of phone number IDs.
{
'PhoneNumberErrors': [
{
'PhoneNumberId': 'string',
'ErrorCode': 'BadRequest'|'Conflict'|'Forbidden'|'NotFound'|'PreconditionFailed'|'ResourceLimitExceeded'|'ServiceFailure'|'AccessDenied'|'ServiceUnavailable'|'Throttled'|'Throttling'|'Unauthorized'|'Unprocessable'|'VoiceConnectorGroupAssociationsExist'|'PhoneNumberAssociationsExist',
'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.
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionbatch_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',
]
)
[REQUIRED]
The Amazon Chime account ID.
[REQUIRED]
The request containing the user IDs to suspend.
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.
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionbatch_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',
]
)
[REQUIRED]
The Amazon Chime account ID.
[REQUIRED]
The request containing the user IDs to unsuspend.
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.
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionbatch_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'
},
]
)
[REQUIRED]
The request containing the phone number IDs and product types or calling names to update.
The phone number ID, product type, or calling name fields to update, used with the BatchUpdatePhoneNumber and UpdatePhoneNumber actions.
The phone number ID to update.
The product type to update.
The outbound calling name to update.
{
'PhoneNumberErrors': [
{
'PhoneNumberId': 'string',
'ErrorCode': 'BadRequest'|'Conflict'|'Forbidden'|'NotFound'|'PreconditionFailed'|'ResourceLimitExceeded'|'ServiceFailure'|'AccessDenied'|'ServiceUnavailable'|'Throttled'|'Throttling'|'Unauthorized'|'Unprocessable'|'VoiceConnectorGroupAssociationsExist'|'PhoneNumberAssociationsExist',
'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.
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionbatch_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'
}
},
]
)
[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.
The user type.
The Alexa for Business metadata.
Starts or stops Alexa for Business.
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.
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptioncan_paginate(operation_name)¶Check if an operation can be paginated.
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").True if the operation can be paginated,
False otherwise.close()¶Closes underlying endpoint connections.
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'
)
[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',
],
'AccountStatus': 'Suspended'|'Active',
'SigninDelegateGroups': [
{
'GroupName': 'string'
},
]
}
}
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.
The status of the account.
The sign-in delegate groups associated with the account.
An Active Directory (AD) group whose members are granted permission to act as delegates.
The group name.
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptioncreate_app_instance(**kwargs)¶Creates an Amazon Chime SDK messaging AppInstance under an AWS account. Only SDK messaging customers use this API. CreateAppInstance supports idempotency behavior as described in the AWS API Standard.
See also: AWS API Documentation
Request Syntax
response = client.create_app_instance(
Name='string',
Metadata='string',
ClientRequestToken='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The name of the AppInstance .
AppInstance . Limited to a 1KB string in UTF-8.[REQUIRED]
The ClientRequestToken of the AppInstance .
This field is autopopulated if not provided.
Tags assigned to the AppInstance .
Describes a tag applied to a resource.
The key of the tag.
The value of the tag.
dict
Response Syntax
{
'AppInstanceArn': 'string'
}
Response Structure
(dict) --
AppInstanceArn (string) --
The Amazon Resource Number (ARN) of the AppInstance .
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ConflictExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.ResourceLimitExceededExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptioncreate_app_instance_admin(**kwargs)¶Promotes an AppInstanceUser to an AppInstanceAdmin . The promoted user can perform the following actions.
ChannelModerator actions across all channels in the AppInstance .DeleteChannelMessage actions.Only an AppInstanceUser can be promoted to an AppInstanceAdmin role.
See also: AWS API Documentation
Request Syntax
response = client.create_app_instance_admin(
AppInstanceAdminArn='string',
AppInstanceArn='string'
)
[REQUIRED]
The ARN of the administrator of the current AppInstance .
[REQUIRED]
The ARN of the AppInstance .
dict
Response Syntax
{
'AppInstanceAdmin': {
'Arn': 'string',
'Name': 'string'
},
'AppInstanceArn': 'string'
}
Response Structure
(dict) --
AppInstanceAdmin (dict) --
The name and ARN of the admin for the AppInstance .
Arn (string) --
The ARN in an Identity.
Name (string) --
The name in an Identity.
AppInstanceArn (string) --
The ARN of the of the admin for the AppInstance .
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ConflictExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.ResourceLimitExceededExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptioncreate_app_instance_user(**kwargs)¶Creates a user under an Amazon Chime AppInstance . The request consists of a unique appInstanceUserId and Name for that user.
See also: AWS API Documentation
Request Syntax
response = client.create_app_instance_user(
AppInstanceArn='string',
AppInstanceUserId='string',
Name='string',
Metadata='string',
ClientRequestToken='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The ARN of the AppInstance request.
[REQUIRED]
The user ID of the AppInstance .
[REQUIRED]
The user's name.
[REQUIRED]
The token assigned to the user requesting an AppInstance .
This field is autopopulated if not provided.
Tags assigned to the AppInstanceUser .
Describes a tag applied to a resource.
The key of the tag.
The value of the tag.
dict
Response Syntax
{
'AppInstanceUserArn': 'string'
}
Response Structure
(dict) --
AppInstanceUserArn (string) --
The user's ARN.
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ConflictExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.ResourceLimitExceededExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptioncreate_attendee(**kwargs)¶Creates a new attendee for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_attendee(
MeetingId='string',
ExternalUserId='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The Amazon Chime SDK meeting ID.
[REQUIRED]
The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.
The tag key-value pairs.
Describes a tag applied to a resource.
The key of the tag.
The value of the tag.
dict
Response Syntax
{
'Attendee': {
'ExternalUserId': 'string',
'AttendeeId': 'string',
'JoinToken': 'string'
}
}
Response Structure
(dict) --
Attendee (dict) --
The attendee information, including attendee ID and join token.
ExternalUserId (string) --
The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.
AttendeeId (string) --
The Amazon Chime SDK attendee ID.
JoinToken (string) --
The join token used by the Amazon Chime SDK attendee.
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ResourceLimitExceededExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptioncreate_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'
)
[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.
Exceptions
Chime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ResourceLimitExceededExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ThrottledClientExceptioncreate_channel(**kwargs)¶Creates a channel to which you can add users and send messages.
Restriction : You can't change a channel's privacy.
Note
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
See also: AWS API Documentation
Request Syntax
response = client.create_channel(
AppInstanceArn='string',
Name='string',
Mode='UNRESTRICTED'|'RESTRICTED',
Privacy='PUBLIC'|'PRIVATE',
Metadata='string',
ClientRequestToken='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
ChimeBearer='string'
)
[REQUIRED]
The ARN of the channel request.
[REQUIRED]
The name of the channel.
UNRESTRICTED or RESTRICTED . Administrators, moderators, and channel members can add themselves and other members to unrestricted channels. Only administrators and moderators can add members to restricted channels.PUBLIC or PRIVATE . Private channels aren't discoverable by users outside the channel. Public channels are discoverable by anyone in the AppInstance .[REQUIRED]
The client token for the request. An Idempotency token.
This field is autopopulated if not provided.
The tags for the creation request.
Describes a tag applied to a resource.
The key of the tag.
The value of the tag.
AppInstanceUserArn of the user that makes the API call.dict
Response Syntax
{
'ChannelArn': 'string'
}
Response Structure
(dict) --
ChannelArn (string) --
The ARN of the channel.
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ConflictExceptionChime.Client.exceptions.ResourceLimitExceededExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptioncreate_channel_ban(**kwargs)¶Permanently bans a member from a channel. Moderators can't add banned members to a channel. To undo a ban, you first have to DeleteChannelBan , and then CreateChannelMembership . Bans are cleaned up when you delete users or channels.
If you ban a user who is already part of a channel, that user is automatically kicked from the channel.
Note
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
See also: AWS API Documentation
Request Syntax
response = client.create_channel_ban(
ChannelArn='string',
MemberArn='string',
ChimeBearer='string'
)
[REQUIRED]
The ARN of the ban request.
[REQUIRED]
The ARN of the member being banned.
AppInstanceUserArn of the user that makes the API call.dict
Response Syntax
{
'ChannelArn': 'string',
'Member': {
'Arn': 'string',
'Name': 'string'
}
}
Response Structure
(dict) --
ChannelArn (string) --
The ARN of the response to the ban request.
Member (dict) --
The ChannelArn and BannedIdentity of the member in the ban response.
Arn (string) --
The ARN in an Identity.
Name (string) --
The name in an Identity.
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ConflictExceptionChime.Client.exceptions.ResourceLimitExceededExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptioncreate_channel_membership(**kwargs)¶Adds a user to a channel. The InvitedBy response field is derived from the request header. A channel member can:
Privacy settings impact this action as follows:
Note
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
See also: AWS API Documentation
Request Syntax
response = client.create_channel_membership(
ChannelArn='string',
MemberArn='string',
Type='DEFAULT'|'HIDDEN',
ChimeBearer='string'
)
[REQUIRED]
The ARN of the channel to which you're adding users.
[REQUIRED]
The ARN of the member you want to add to the channel.
[REQUIRED]
The membership type of a user, DEFAULT or HIDDEN . Default members are always returned as part of ListChannelMemberships . Hidden members are only returned if the type filter in ListChannelMemberships equals HIDDEN . Otherwise hidden members are not returned. This is only supported by moderators.
AppInstanceUserArn of the user that makes the API call.dict
Response Syntax
{
'ChannelArn': 'string',
'Member': {
'Arn': 'string',
'Name': 'string'
}
}
Response Structure
(dict) --
ChannelArn (string) --
The ARN of the channel.
Member (dict) --
The ARN and metadata of the member being added.
Arn (string) --
The ARN in an Identity.
Name (string) --
The name in an Identity.
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ConflictExceptionChime.Client.exceptions.ResourceLimitExceededExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptioncreate_channel_moderator(**kwargs)¶Creates a new ChannelModerator . A channel moderator can:
Note
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
See also: AWS API Documentation
Request Syntax
response = client.create_channel_moderator(
ChannelArn='string',
ChannelModeratorArn='string',
ChimeBearer='string'
)
[REQUIRED]
The ARN of the channel.
[REQUIRED]
The ARN of the moderator.
AppInstanceUserArn of the user that makes the API call.dict
Response Syntax
{
'ChannelArn': 'string',
'ChannelModerator': {
'Arn': 'string',
'Name': 'string'
}
}
Response Structure
(dict) --
ChannelArn (string) --
The ARN of the channel.
ChannelModerator (dict) --
The ARNs of the channel and the moderator.
Arn (string) --
The ARN in an Identity.
Name (string) --
The name in an Identity.
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ConflictExceptionChime.Client.exceptions.ResourceLimitExceededExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptioncreate_media_capture_pipeline(**kwargs)¶Creates a media capture pipeline.
See also: AWS API Documentation
Request Syntax
response = client.create_media_capture_pipeline(
SourceType='ChimeSdkMeeting',
SourceArn='string',
SinkType='S3Bucket',
SinkArn='string',
ClientRequestToken='string',
ChimeSdkMeetingConfiguration={
'SourceConfiguration': {
'SelectedVideoStreams': {
'AttendeeIds': [
'string',
],
'ExternalUserIds': [
'string',
]
}
},
'ArtifactsConfiguration': {
'Audio': {
'MuxType': 'AudioOnly'|'AudioWithActiveSpeakerVideo'
},
'Video': {
'State': 'Enabled'|'Disabled',
'MuxType': 'VideoOnly'
},
'Content': {
'State': 'Enabled'|'Disabled',
'MuxType': 'ContentOnly'
}
}
}
)
[REQUIRED]
Source type from which the media artifacts will be captured. A Chime SDK Meeting is the only supported source.
[REQUIRED]
ARN of the source from which the media artifacts are captured.
[REQUIRED]
Destination type to which the media artifacts are saved. You must use an S3 bucket.
[REQUIRED]
The ARN of the sink type.
The token assigned to the client making the pipeline request.
This field is autopopulated if not provided.
The configuration for a specified media capture pipeline. SourceType must be ChimeSdkMeeting .
The source configuration for a specified media capture pipline.
The selected video streams to capture for a specified media capture pipeline. The number of video streams can't exceed 25.
The attendee IDs of the streams selected for a media capture pipeline.
The external user IDs of the streams selected for a media capture pipeline.
The configuration for the artifacts in an Amazon Chime SDK meeting.
The configuration for the audio artifacts.
The MUX type of the audio artifact configuration object.
The configuration for the video artifacts.
Indicates whether the video artifact is enabled or disabled.
The MUX type of the video artifact configuration object.
The configuration for the content artifacts.
Indicates whether the content artifact is enabled or disabled.
The MUX type of the artifact configuration.
dict
Response Syntax
{
'MediaCapturePipeline': {
'MediaPipelineId': 'string',
'SourceType': 'ChimeSdkMeeting',
'SourceArn': 'string',
'Status': 'Initializing'|'InProgress'|'Failed'|'Stopping'|'Stopped',
'SinkType': 'S3Bucket',
'SinkArn': 'string',
'CreatedTimestamp': datetime(2015, 1, 1),
'UpdatedTimestamp': datetime(2015, 1, 1),
'ChimeSdkMeetingConfiguration': {
'SourceConfiguration': {
'SelectedVideoStreams': {
'AttendeeIds': [
'string',
],
'ExternalUserIds': [
'string',
]
}
},
'ArtifactsConfiguration': {
'Audio': {
'MuxType': 'AudioOnly'|'AudioWithActiveSpeakerVideo'
},
'Video': {
'State': 'Enabled'|'Disabled',
'MuxType': 'VideoOnly'
},
'Content': {
'State': 'Enabled'|'Disabled',
'MuxType': 'ContentOnly'
}
}
}
}
}
Response Structure
(dict) --
MediaCapturePipeline (dict) --
A media capture pipeline object, the ID, source type, source ARN, sink type, and sink ARN of a media capture pipeline object.
MediaPipelineId (string) --
The ID of a media capture pipeline.
SourceType (string) --
Source type from which media artifacts are saved. You must use ChimeMeeting .
SourceArn (string) --
ARN of the source from which the media artifacts will be saved.
Status (string) --
The status of the media capture pipeline.
SinkType (string) --
Destination type to which the media artifacts are saved. You must use an S3 Bucket.
SinkArn (string) --
ARN of the destination to which the media artifacts are saved.
CreatedTimestamp (datetime) --
The time at which the capture pipeline was created, in ISO 8601 format.
UpdatedTimestamp (datetime) --
The time at which the capture pipeline was updated, in ISO 8601 format.
ChimeSdkMeetingConfiguration (dict) --
The configuration for a specified media capture pipeline. SourceType must be ChimeSdkMeeting .
SourceConfiguration (dict) --
The source configuration for a specified media capture pipline.
SelectedVideoStreams (dict) --
The selected video streams to capture for a specified media capture pipeline. The number of video streams can't exceed 25.
AttendeeIds (list) --
The attendee IDs of the streams selected for a media capture pipeline.
ExternalUserIds (list) --
The external user IDs of the streams selected for a media capture pipeline.
ArtifactsConfiguration (dict) --
The configuration for the artifacts in an Amazon Chime SDK meeting.
Audio (dict) --
The configuration for the audio artifacts.
MuxType (string) --
The MUX type of the audio artifact configuration object.
Video (dict) --
The configuration for the video artifacts.
State (string) --
Indicates whether the video artifact is enabled or disabled.
MuxType (string) --
The MUX type of the video artifact configuration object.
Content (dict) --
The configuration for the content artifacts.
State (string) --
Indicates whether the content artifact is enabled or disabled.
MuxType (string) --
The MUX type of the artifact configuration.
Exceptions
Chime.Client.exceptions.ResourceLimitExceededExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptioncreate_meeting(**kwargs)¶Creates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees. For more information about specifying media Regions, see Amazon Chime SDK Media Regions in the Amazon Chime Developer Guide . For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_meeting(
ClientRequestToken='string',
ExternalMeetingId='string',
MeetingHostId='string',
MediaRegion='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
NotificationsConfiguration={
'SnsTopicArn': 'string',
'SqsQueueArn': 'string'
}
)
[REQUIRED]
The unique identifier for the client request. Use a different token for different meetings.
This field is autopopulated if not provided.
The Region in which to create the meeting. Default: us-east-1 .
Available values: af-south-1 , ap-northeast-1 , ap-northeast-2 , ap-south-1 , ap-southeast-1 , ap-southeast-2 , ca-central-1 , eu-central-1 , eu-north-1 , eu-south-1 , eu-west-1 , eu-west-2 , eu-west-3 , sa-east-1 , us-east-1 , us-east-2 , us-west-1 , us-west-2 .
The tag key-value pairs.
Describes a tag applied to a resource.
The key of the tag.
The value of the tag.
The configuration for resource targets to receive notifications when meeting and attendee events occur.
The SNS topic ARN.
The SQS queue ARN.
dict
Response Syntax
{
'Meeting': {
'MeetingId': 'string',
'ExternalMeetingId': 'string',
'MediaPlacement': {
'AudioHostUrl': 'string',
'AudioFallbackUrl': 'string',
'ScreenDataUrl': 'string',
'ScreenSharingUrl': 'string',
'ScreenViewingUrl': 'string',
'SignalingUrl': 'string',
'TurnControlUrl': 'string',
'EventIngestionUrl': 'string'
},
'MediaRegion': 'string'
}
}
Response Structure
(dict) --
Meeting (dict) --
The meeting information, including the meeting ID and MediaPlacement .
MeetingId (string) --
The Amazon Chime SDK meeting ID.
ExternalMeetingId (string) --
The external meeting ID.
MediaPlacement (dict) --
The media placement for the meeting.
AudioHostUrl (string) --
The audio host URL.
AudioFallbackUrl (string) --
The audio fallback URL.
ScreenDataUrl (string) --
The screen data URL.
ScreenSharingUrl (string) --
The screen sharing URL.
ScreenViewingUrl (string) --
The screen viewing URL.
SignalingUrl (string) --
The signaling URL.
TurnControlUrl (string) --
The turn control URL.
EventIngestionUrl (string) --
The event ingestion URL to which you send client meeting events.
MediaRegion (string) --
The Region in which you create the meeting. Available values: af-south-1 , ap-northeast-1 , ap-northeast-2 , ap-south-1 , ap-southeast-1 , ap-southeast-2 , ca-central-1 , eu-central-1 , eu-north-1 , eu-south-1 , eu-west-1 , eu-west-2 , eu-west-3 , sa-east-1 , us-east-1 , us-east-2 , us-west-1 , us-west-2 .
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.ResourceLimitExceededExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptioncreate_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.
See also: AWS API Documentation
Request Syntax
response = client.create_meeting_dial_out(
MeetingId='string',
FromPhoneNumber='string',
ToPhoneNumber='string',
JoinToken='string'
)
[REQUIRED]
The Amazon Chime SDK meeting ID.
[REQUIRED]
Phone number used as the caller ID when the remote party receives a call.
[REQUIRED]
Phone number called when inviting someone to a meeting.
[REQUIRED]
Token used by the Amazon Chime SDK attendee. Call the CreateAttendee action to get a join token.
dict
Response Syntax
{
'TransactionId': 'string'
}
Response Structure
(dict) --
TransactionId (string) --
Unique ID that tracks API calls.
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.ResourceLimitExceededExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.AccessDeniedExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptioncreate_meeting_with_attendees(**kwargs)¶Creates a new Amazon Chime SDK meeting in the specified media Region, with attendees. For more information about specifying media Regions, see Amazon Chime SDK Media Regions in the Amazon Chime Developer Guide . For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_meeting_with_attendees(
ClientRequestToken='string',
ExternalMeetingId='string',
MeetingHostId='string',
MediaRegion='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
NotificationsConfiguration={
'SnsTopicArn': 'string',
'SqsQueueArn': 'string'
},
Attendees=[
{
'ExternalUserId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
)
[REQUIRED]
The unique identifier for the client request. Use a different token for different meetings.
This field is autopopulated if not provided.
The Region in which to create the meeting. Default: us-east-1 .
Available values: af-south-1 , ap-northeast-1 , ap-northeast-2 , ap-south-1 , ap-southeast-1 , ap-southeast-2 , ca-central-1 , eu-central-1 , eu-north-1 , eu-south-1 , eu-west-1 , eu-west-2 , eu-west-3 , sa-east-1 , us-east-1 , us-east-2 , us-west-1 , us-west-2 .
The tag key-value pairs.
Describes a tag applied to a resource.
The key of the tag.
The value of the tag.
The resource target configurations for receiving Amazon Chime SDK meeting and attendee event notifications. The Amazon Chime SDK supports resource targets located in the US East (N. Virginia) AWS Region ( us-east-1 ).
The SNS topic ARN.
The SQS queue ARN.
The request containing the attendees to create.
The Amazon Chime SDK attendee fields to create, used with the BatchCreateAttendee action.
The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.
The tag key-value pairs.
Describes a tag applied to a resource.
The key of the tag.
The value of the tag.
dict
Response Syntax
{
'Meeting': {
'MeetingId': 'string',
'ExternalMeetingId': 'string',
'MediaPlacement': {
'AudioHostUrl': 'string',
'AudioFallbackUrl': 'string',
'ScreenDataUrl': 'string',
'ScreenSharingUrl': 'string',
'ScreenViewingUrl': 'string',
'SignalingUrl': 'string',
'TurnControlUrl': 'string',
'EventIngestionUrl': 'string'
},
'MediaRegion': 'string'
},
'Attendees': [
{
'ExternalUserId': 'string',
'AttendeeId': 'string',
'JoinToken': 'string'
},
],
'Errors': [
{
'ExternalUserId': 'string',
'ErrorCode': 'string',
'ErrorMessage': 'string'
},
]
}
Response Structure
(dict) --
Meeting (dict) --
A meeting created using the Amazon Chime SDK.
MeetingId (string) --
The Amazon Chime SDK meeting ID.
ExternalMeetingId (string) --
The external meeting ID.
MediaPlacement (dict) --
The media placement for the meeting.
AudioHostUrl (string) --
The audio host URL.
AudioFallbackUrl (string) --
The audio fallback URL.
ScreenDataUrl (string) --
The screen data URL.
ScreenSharingUrl (string) --
The screen sharing URL.
ScreenViewingUrl (string) --
The screen viewing URL.
SignalingUrl (string) --
The signaling URL.
TurnControlUrl (string) --
The turn control URL.
EventIngestionUrl (string) --
The event ingestion URL to which you send client meeting events.
MediaRegion (string) --
The Region in which you create the meeting. Available values: af-south-1 , ap-northeast-1 , ap-northeast-2 , ap-south-1 , ap-southeast-1 , ap-southeast-2 , ca-central-1 , eu-central-1 , eu-north-1 , eu-south-1 , eu-west-1 , eu-west-2 , eu-west-3 , sa-east-1 , us-east-1 , us-east-2 , us-west-1 , us-west-2 .
Attendees (list) --
The attendee information, including attendees IDs and join tokens.
(dict) --
An Amazon Chime SDK meeting attendee. Includes a unique AttendeeId and JoinToken . The JoinToken allows a client to authenticate and join as the specified attendee. The JoinToken expires when the meeting ends or when DeleteAttendee is called. After that, the attendee is unable to join the meeting.
We recommend securely transferring each JoinToken from your server application to the client so that no other client has access to the token except for the one authorized to represent the attendee.
ExternalUserId (string) --
The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.
AttendeeId (string) --
The Amazon Chime SDK attendee ID.
JoinToken (string) --
The join token used by the Amazon Chime SDK attendee.
Errors (list) --
If the action fails for one or more of the attendees in the request, a list of the attendees is returned, along with error codes and error messages.
(dict) --
The list of errors returned when errors are encountered during the BatchCreateAttendee and CreateAttendee actions. This includes external user IDs, error codes, and error messages.
ExternalUserId (string) --
The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.
ErrorCode (string) --
The error code.
ErrorMessage (string) --
The error message.
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.ResourceLimitExceededExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptioncreate_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',
]
)
[REQUIRED]
The phone number product type.
[REQUIRED]
List of phone numbers, in E.164 format.
dict
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.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.AccessDeniedExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ResourceLimitExceededExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptioncreate_proxy_session(**kwargs)¶Creates a proxy session on the specified Amazon Chime Voice Connector for the specified participant phone numbers.
See also: AWS API Documentation
Request Syntax
response = client.create_proxy_session(
VoiceConnectorId='string',
ParticipantPhoneNumbers=[
'string',
],
Name='string',
ExpiryMinutes=123,
Capabilities=[
'Voice'|'SMS',
],
NumberSelectionBehavior='PreferSticky'|'AvoidSticky',
GeoMatchLevel='Country'|'AreaCode',
GeoMatchParams={
'Country': 'string',
'AreaCode': 'string'
}
)
[REQUIRED]
The Amazon Chime voice connector ID.
[REQUIRED]
The participant phone numbers.
[REQUIRED]
The proxy session capabilities.
The country and area code for the proxy phone number.
The country.
The area code.
dict
Response Syntax
{
'ProxySession': {
'VoiceConnectorId': 'string',
'ProxySessionId': 'string',
'Name': 'string',
'Status': 'Open'|'InProgress'|'Closed',
'ExpiryMinutes': 123,
'Capabilities': [
'Voice'|'SMS',
],
'CreatedTimestamp': datetime(2015, 1, 1),
'UpdatedTimestamp': datetime(2015, 1, 1),
'EndedTimestamp': datetime(2015, 1, 1),
'Participants': [
{
'PhoneNumber': 'string',
'ProxyPhoneNumber': 'string'
},
],
'NumberSelectionBehavior': 'PreferSticky'|'AvoidSticky',
'GeoMatchLevel': 'Country'|'AreaCode',
'GeoMatchParams': {
'Country': 'string',
'AreaCode': 'string'
}
}
}
Response Structure
(dict) --
ProxySession (dict) --
The proxy session details.
VoiceConnectorId (string) --
The Amazon Chime voice connector ID.
ProxySessionId (string) --
The proxy session ID.
Name (string) --
The name of the proxy session.
Status (string) --
The status of the proxy session.
ExpiryMinutes (integer) --
The number of minutes allowed for the proxy session.
Capabilities (list) --
The proxy session capabilities.
CreatedTimestamp (datetime) --
The created time stamp, in ISO 8601 format.
UpdatedTimestamp (datetime) --
The updated time stamp, in ISO 8601 format.
EndedTimestamp (datetime) --
The ended time stamp, in ISO 8601 format.
Participants (list) --
The proxy session participants.
(dict) --
The phone number and proxy phone number for a participant in an Amazon Chime Voice Connector proxy session.
PhoneNumber (string) --
The participant's phone number.
ProxyPhoneNumber (string) --
The participant's proxy phone number.
NumberSelectionBehavior (string) --
The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.
GeoMatchLevel (string) --
The preference for matching the country or area code of the proxy phone number with that of the first participant.
GeoMatchParams (dict) --
The country and area code for the proxy phone number.
Country (string) --
The country.
AreaCode (string) --
The area code.
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptioncreate_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'
)
[REQUIRED]
The Amazon Chime account ID.
[REQUIRED]
The room name.
The idempotency token for the request.
This field is autopopulated if not provided.
dict
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.NotFoundExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ResourceLimitExceededExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptioncreate_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'
)
[REQUIRED]
The Amazon Chime account ID.
[REQUIRED]
The room ID.
[REQUIRED]
The Amazon Chime member ID (user ID or bot ID).
dict
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.ConflictExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.ResourceLimitExceededExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptioncreate_sip_media_application(**kwargs)¶Creates a SIP media application.
See also: AWS API Documentation
Request Syntax
response = client.create_sip_media_application(
AwsRegion='string',
Name='string',
Endpoints=[
{
'LambdaArn': 'string'
},
]
)
[REQUIRED]
The AWS Region assigned to the SIP media application.
[REQUIRED]
The SIP media application name.
[REQUIRED]
List of endpoints (Lambda Amazon Resource Names) specified for the SIP media application. Currently, only one endpoint is supported.
The endpoint assigned to the SIP media application.
Valid Amazon Resource Name (ARN) of the Lambda function. The function must be created in the same AWS Region as the SIP media application.
dict
Response Syntax
{
'SipMediaApplication': {
'SipMediaApplicationId': 'string',
'AwsRegion': 'string',
'Name': 'string',
'Endpoints': [
{
'LambdaArn': 'string'
},
],
'CreatedTimestamp': datetime(2015, 1, 1),
'UpdatedTimestamp': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
SipMediaApplication (dict) --
The SIP media application details.
SipMediaApplicationId (string) --
The SIP media application ID.
AwsRegion (string) --
The AWS Region in which the SIP media application is created.
Name (string) --
The name of the SIP media application.
Endpoints (list) --
List of endpoints for SIP media application. Currently, only one endpoint per SIP media application is permitted.
(dict) --
The endpoint assigned to the SIP media application.
LambdaArn (string) --
Valid Amazon Resource Name (ARN) of the Lambda function. The function must be created in the same AWS Region as the SIP media application.
CreatedTimestamp (datetime) --
The SIP media application creation timestamp, in ISO 8601 format.
UpdatedTimestamp (datetime) --
The SIP media application updated timestamp, in ISO 8601 format.
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.AccessDeniedExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ResourceLimitExceededExceptionChime.Client.exceptions.ConflictExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptioncreate_sip_media_application_call(**kwargs)¶Creates an outbound call to a phone number from the phone number specified in the request, and it invokes the endpoint of the specified sipMediaApplicationId .
See also: AWS API Documentation
Request Syntax
response = client.create_sip_media_application_call(
FromPhoneNumber='string',
ToPhoneNumber='string',
SipMediaApplicationId='string',
SipHeaders={
'string': 'string'
}
)
[REQUIRED]
The phone number that a user calls from. This is a phone number in your Amazon Chime phone number inventory.
[REQUIRED]
The phone number that the service should call.
[REQUIRED]
The ID of the SIP media application.
The SIP headers added to an outbound call leg.
dict
Response Syntax
{
'SipMediaApplicationCall': {
'TransactionId': 'string'
}
}
Response Structure
(dict) --
SipMediaApplicationCall (dict) --
The actual call.
TransactionId (string) --
The transaction ID of a call.
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.ResourceLimitExceededExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.AccessDeniedExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptioncreate_sip_rule(**kwargs)¶Creates a SIP rule which can be used to run a SIP media application as a target for a specific trigger type.
See also: AWS API Documentation
Request Syntax
response = client.create_sip_rule(
Name='string',
TriggerType='ToPhoneNumber'|'RequestUriHostname',
TriggerValue='string',
Disabled=True|False,
TargetApplications=[
{
'SipMediaApplicationId': 'string',
'Priority': 123,
'AwsRegion': 'string'
},
]
)
[REQUIRED]
The name of the SIP rule.
[REQUIRED]
The type of trigger assigned to the SIP rule in TriggerValue , currently RequestUriHostname or ToPhoneNumber .
[REQUIRED]
If TriggerType is RequestUriHostname , the value can be the outbound host name of an Amazon Chime Voice Connector. If TriggerType is ToPhoneNumber , the value can be a customer-owned phone number in the E164 format. The SipMediaApplication specified in the SipRule is triggered if the request URI in an incoming SIP request matches the RequestUriHostname , or if the To header in the incoming SIP request matches the ToPhoneNumber value.
[REQUIRED]
List of SIP media applications with priority and AWS Region. Only one SIP application per AWS Region can be used.
Target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.
The SIP media application ID.
Priority of the SIP media application in the target list.
The AWS Region of the target application.
dict
Response Syntax
{
'SipRule': {
'SipRuleId': 'string',
'Name': 'string',
'Disabled': True|False,
'TriggerType': 'ToPhoneNumber'|'RequestUriHostname',
'TriggerValue': 'string',
'TargetApplications': [
{
'SipMediaApplicationId': 'string',
'Priority': 123,
'AwsRegion': 'string'
},
],
'CreatedTimestamp': datetime(2015, 1, 1),
'UpdatedTimestamp': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
SipRule (dict) --
Returns the SIP rule information, including the rule ID, triggers, and target applications.
SipRuleId (string) --
The SIP rule ID.
Name (string) --
The name of the SIP rule.
Disabled (boolean) --
Indicates whether the SIP rule is enabled or disabled. You must disable a rule before you can delete it.
TriggerType (string) --
The type of trigger assigned to the SIP rule in TriggerValue , currently RequestUriHostname or ToPhoneNumber .
TriggerValue (string) --
If TriggerType is RequestUriHostname , then the value can be the outbound host name of the Amazon Chime Voice Connector. If TriggerType is ToPhoneNumber , then the value can be a customer-owned phone number in E164 format. SipRule is triggered when a SIP rule requests host name or ToPhoneNumber matches in the incoming SIP request.
TargetApplications (list) --
Target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.
(dict) --
Target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.
SipMediaApplicationId (string) --
The SIP media application ID.
Priority (integer) --
Priority of the SIP media application in the target list.
AwsRegion (string) --
The AWS Region of the target application.
CreatedTimestamp (datetime) --
The time at which the SIP rule was created, in ISO 8601 format.
UpdatedTimestamp (datetime) --
The time at which the SIP rule was last updated, in ISO 8601 format.
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.AccessDeniedExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ResourceLimitExceededExceptionChime.Client.exceptions.ConflictExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptioncreate_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'
)
[REQUIRED]
The Amazon Chime account ID.
dict
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.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ConflictExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptioncreate_voice_connector(**kwargs)¶Creates an Amazon Chime Voice Connector under the administrator's AWS account. You can choose to create an Amazon Chime Voice Connector in a specific AWS Region.
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',
AwsRegion='us-east-1'|'us-west-2',
RequireEncryption=True|False
)
[REQUIRED]
The name of the Amazon Chime Voice Connector.
us-east-1 .[REQUIRED]
When enabled, requires encryption for the Amazon Chime Voice Connector.
dict
Response Syntax
{
'VoiceConnector': {
'VoiceConnectorId': 'string',
'AwsRegion': 'us-east-1'|'us-west-2',
'Name': 'string',
'OutboundHostName': 'string',
'RequireEncryption': True|False,
'CreatedTimestamp': datetime(2015, 1, 1),
'UpdatedTimestamp': datetime(2015, 1, 1),
'VoiceConnectorArn': 'string'
}
}
Response Structure
(dict) --
VoiceConnector (dict) --
The Amazon Chime Voice Connector details.
VoiceConnectorId (string) --
The Amazon Chime Voice Connector ID.
AwsRegion (string) --
The AWS Region in which the Amazon Chime Voice Connector is created. Default: us-east-1 .
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.
VoiceConnectorArn (string) --
The ARN of the specified Amazon Chime Voice Connector.
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.AccessDeniedExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ResourceLimitExceededExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptioncreate_voice_connector_group(**kwargs)¶Creates an Amazon Chime Voice Connector group under the administrator's AWS account. You can associate Amazon Chime Voice Connectors with the Amazon Chime Voice Connector group by including VoiceConnectorItems in the request.
You can include Amazon Chime Voice Connectors from different AWS Regions in your group. This creates a fault tolerant mechanism for fallback in case of availability events.
See also: AWS API Documentation
Request Syntax
response = client.create_voice_connector_group(
Name='string',
VoiceConnectorItems=[
{
'VoiceConnectorId': 'string',
'Priority': 123
},
]
)
[REQUIRED]
The name of the Amazon Chime Voice Connector group.
The Amazon Chime Voice Connectors to route inbound calls to.
For Amazon Chime Voice Connector groups, the Amazon Chime Voice Connectors to which to route inbound calls. Includes priority configuration settings. Limit: 3 VoiceConnectorItems per Amazon Chime Voice Connector group.
The Amazon Chime Voice Connector ID.
The priority associated with the Amazon Chime Voice Connector, with 1 being the highest priority. Higher priority Amazon Chime Voice Connectors are attempted first.
dict
Response Syntax
{
'VoiceConnectorGroup': {
'VoiceConnectorGroupId': 'string',
'Name': 'string',
'VoiceConnectorItems': [
{
'VoiceConnectorId': 'string',
'Priority': 123
},
],
'CreatedTimestamp': datetime(2015, 1, 1),
'UpdatedTimestamp': datetime(2015, 1, 1),
'VoiceConnectorGroupArn': 'string'
}
}
Response Structure
(dict) --
VoiceConnectorGroup (dict) --
The Amazon Chime Voice Connector group details.
VoiceConnectorGroupId (string) --
The Amazon Chime Voice Connector group ID.
Name (string) --
The name of the Amazon Chime Voice Connector group.
VoiceConnectorItems (list) --
The Amazon Chime Voice Connectors to which to route inbound calls.
(dict) --
For Amazon Chime Voice Connector groups, the Amazon Chime Voice Connectors to which to route inbound calls. Includes priority configuration settings. Limit: 3 VoiceConnectorItems per Amazon Chime Voice Connector group.
VoiceConnectorId (string) --
The Amazon Chime Voice Connector ID.
Priority (integer) --
The priority associated with the Amazon Chime Voice Connector, with 1 being the highest priority. Higher priority Amazon Chime Voice Connectors are attempted first.
CreatedTimestamp (datetime) --
The Amazon Chime Voice Connector group creation time stamp, in ISO 8601 format.
UpdatedTimestamp (datetime) --
The updated Amazon Chime Voice Connector group time stamp, in ISO 8601 format.
VoiceConnectorGroupArn (string) --
The ARN of the specified Amazon Chime Voice Connector group.
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.AccessDeniedExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ResourceLimitExceededExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptiondelete_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'
)
[REQUIRED]
The Amazon Chime account ID.
{}
Response Structure
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.UnprocessableEntityExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptiondelete_app_instance(**kwargs)¶Deletes an AppInstance and all associated data asynchronously.
See also: AWS API Documentation
Request Syntax
response = client.delete_app_instance(
AppInstanceArn='string'
)
[REQUIRED]
The ARN of the AppInstance .
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptiondelete_app_instance_admin(**kwargs)¶Demotes an AppInstanceAdmin to an AppInstanceUser . This action does not delete the user.
See also: AWS API Documentation
Request Syntax
response = client.delete_app_instance_admin(
AppInstanceAdminArn='string',
AppInstanceArn='string'
)
[REQUIRED]
The ARN of the AppInstance 's administrator.
[REQUIRED]
The ARN of the AppInstance .
None
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ConflictExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptiondelete_app_instance_streaming_configurations(**kwargs)¶Deletes the streaming configurations of an AppInstance .
See also: AWS API Documentation
Request Syntax
response = client.delete_app_instance_streaming_configurations(
AppInstanceArn='string'
)
[REQUIRED]
The ARN of the streaming configurations being deleted.
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptiondelete_app_instance_user(**kwargs)¶Deletes an AppInstanceUser .
See also: AWS API Documentation
Request Syntax
response = client.delete_app_instance_user(
AppInstanceUserArn='string'
)
[REQUIRED]
The ARN of the user request being deleted.
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptiondelete_attendee(**kwargs)¶Deletes an attendee from the specified Amazon Chime SDK meeting and deletes their JoinToken . Attendees are automatically deleted when a Amazon Chime SDK meeting is deleted. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide .
See also: AWS API Documentation
Request Syntax
response = client.delete_attendee(
MeetingId='string',
AttendeeId='string'
)
[REQUIRED]
The Amazon Chime SDK meeting ID.
[REQUIRED]
The Amazon Chime SDK attendee ID.
None
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptiondelete_channel(**kwargs)¶Immediately makes a channel and its memberships inaccessible and marks them for deletion. This is an irreversible process.
Note
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
See also: AWS API Documentation
Request Syntax
response = client.delete_channel(
ChannelArn='string',
ChimeBearer='string'
)
[REQUIRED]
The ARN of the channel being deleted.
AppInstanceUserArn of the user that makes the API call.None
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptiondelete_channel_ban(**kwargs)¶Removes a user from a channel's ban list.
Note
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
See also: AWS API Documentation
Request Syntax
response = client.delete_channel_ban(
ChannelArn='string',
MemberArn='string',
ChimeBearer='string'
)
[REQUIRED]
The ARN of the channel from which the AppInstanceUser was banned.
[REQUIRED]
The ARN of the AppInstanceUser that you want to reinstate.
AppInstanceUserArn of the user that makes the API call.None
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptiondelete_channel_membership(**kwargs)¶Removes a member from a channel.
Note
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
See also: AWS API Documentation
Request Syntax
response = client.delete_channel_membership(
ChannelArn='string',
MemberArn='string',
ChimeBearer='string'
)
[REQUIRED]
The ARN of the channel from which you want to remove the user.
[REQUIRED]
The ARN of the member that you're removing from the channel.
AppInstanceUserArn of the user that makes the API call.None
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ConflictExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptiondelete_channel_message(**kwargs)¶Deletes a channel message. Only admins can perform this action. Deletion makes messages inaccessible immediately. A background process deletes any revisions created by UpdateChannelMessage .
Note
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
See also: AWS API Documentation
Request Syntax
response = client.delete_channel_message(
ChannelArn='string',
MessageId='string',
ChimeBearer='string'
)
[REQUIRED]
The ARN of the channel.
[REQUIRED]
The ID of the message being deleted.
AppInstanceUserArn of the user that makes the API call.None
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptiondelete_channel_moderator(**kwargs)¶Deletes a channel moderator.
Note
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
See also: AWS API Documentation
Request Syntax
response = client.delete_channel_moderator(
ChannelArn='string',
ChannelModeratorArn='string',
ChimeBearer='string'
)
[REQUIRED]
The ARN of the channel.
[REQUIRED]
The ARN of the moderator being deleted.
AppInstanceUserArn of the user that makes the API call.None
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptiondelete_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'
)
[REQUIRED]
The Amazon Chime account ID.
[REQUIRED]
The bot ID.
None
Exceptions
Chime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ResourceLimitExceededExceptiondelete_media_capture_pipeline(**kwargs)¶Deletes the media capture pipeline.
See also: AWS API Documentation
Request Syntax
response = client.delete_media_capture_pipeline(
MediaPipelineId='string'
)
[REQUIRED]
The ID of the media capture pipeline being deleted.
Exceptions
Chime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptiondelete_meeting(**kwargs)¶Deletes the specified Amazon Chime SDK meeting. The operation deletes all attendees, disconnects all clients, and prevents new clients from joining the meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide .
See also: AWS API Documentation
Request Syntax
response = client.delete_meeting(
MeetingId='string'
)
[REQUIRED]
The Amazon Chime SDK meeting ID.
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptiondelete_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'
)
[REQUIRED]
The phone number ID.
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptiondelete_proxy_session(**kwargs)¶Deletes the specified proxy session from the specified Amazon Chime Voice Connector.
See also: AWS API Documentation
Request Syntax
response = client.delete_proxy_session(
VoiceConnectorId='string',
ProxySessionId='string'
)
[REQUIRED]
The Amazon Chime voice connector ID.
[REQUIRED]
The proxy session ID.
None
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptiondelete_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'
)
[REQUIRED]
The Amazon Chime account ID.
[REQUIRED]
The chat room ID.
None
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptiondelete_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'
)
[REQUIRED]
The Amazon Chime account ID.
[REQUIRED]
The room ID.
[REQUIRED]
The member ID (user ID or bot ID).
None
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptiondelete_sip_media_application(**kwargs)¶Deletes a SIP media application.
See also: AWS API Documentation
Request Syntax
response = client.delete_sip_media_application(
SipMediaApplicationId='string'
)
[REQUIRED]
The SIP media application ID.
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ConflictExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptiondelete_sip_rule(**kwargs)¶Deletes a SIP rule. You must disable a SIP rule before you can delete it.
See also: AWS API Documentation
Request Syntax
response = client.delete_sip_rule(
SipRuleId='string'
)
[REQUIRED]
The SIP rule ID.
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ConflictExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptiondelete_voice_connector(**kwargs)¶Deletes the specified Amazon Chime Voice Connector. Any phone numbers associated with the Amazon Chime Voice Connector must be disassociated 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.
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ConflictExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptiondelete_voice_connector_emergency_calling_configuration(**kwargs)¶Deletes the emergency calling configuration details from the specified Amazon Chime Voice Connector.
See also: AWS API Documentation
Request Syntax
response = client.delete_voice_connector_emergency_calling_configuration(
VoiceConnectorId='string'
)
[REQUIRED]
The Amazon Chime Voice Connector ID.
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptiondelete_voice_connector_group(**kwargs)¶Deletes the specified Amazon Chime Voice Connector group. Any VoiceConnectorItems and phone numbers associated with the group must be removed before it can be deleted.
See also: AWS API Documentation
Request Syntax
response = client.delete_voice_connector_group(
VoiceConnectorGroupId='string'
)
[REQUIRED]
The Amazon Chime Voice Connector group ID.
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ConflictExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptiondelete_voice_connector_origination(**kwargs)¶Deletes the origination settings for the specified Amazon Chime Voice Connector.
Note
If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to deleting the origination settings.
See also: AWS API Documentation
Request Syntax
response = client.delete_voice_connector_origination(
VoiceConnectorId='string'
)
[REQUIRED]
The Amazon Chime Voice Connector ID.
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptiondelete_voice_connector_proxy(**kwargs)¶Deletes the proxy configuration from the specified Amazon Chime Voice Connector.
See also: AWS API Documentation
Request Syntax
response = client.delete_voice_connector_proxy(
VoiceConnectorId='string'
)
[REQUIRED]
The Amazon Chime Voice Connector ID.
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptiondelete_voice_connector_streaming_configuration(**kwargs)¶Deletes the streaming configuration for the specified Amazon Chime Voice Connector.
See also: AWS API Documentation
Request Syntax
response = client.delete_voice_connector_streaming_configuration(
VoiceConnectorId='string'
)
[REQUIRED]
The Amazon Chime Voice Connector ID.
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptiondelete_voice_connector_termination(**kwargs)¶Deletes the termination settings for the specified Amazon Chime Voice Connector.
Note
If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to deleting the termination settings.
See also: AWS API Documentation
Request Syntax
response = client.delete_voice_connector_termination(
VoiceConnectorId='string'
)
[REQUIRED]
The Amazon Chime Voice Connector ID.
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptiondelete_voice_connector_termination_credentials(**kwargs)¶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.
[REQUIRED]
The RFC2617 compliant username associated with the SIP credentials, in US-ASCII format.
None
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptiondescribe_app_instance(**kwargs)¶Returns the full details of an AppInstance .
See also: AWS API Documentation
Request Syntax
response = client.describe_app_instance(
AppInstanceArn='string'
)
[REQUIRED]
The ARN of the AppInstance .
{
'AppInstance': {
'AppInstanceArn': 'string',
'Name': 'string',
'Metadata': 'string',
'CreatedTimestamp': datetime(2015, 1, 1),
'LastUpdatedTimestamp': datetime(2015, 1, 1)
}
}
Response Structure
The ARN, metadata, created and last-updated timestamps, and the name of the AppInstance . All timestamps use epoch milliseconds.
The ARN of the messaging instance.
The name of an AppInstance .
The metadata of an AppInstance .
The time at which an AppInstance was created. In epoch milliseconds.
The time an AppInstance was last updated. In epoch milliseconds.
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptiondescribe_app_instance_admin(**kwargs)¶Returns the full details of an AppInstanceAdmin .
See also: AWS API Documentation
Request Syntax
response = client.describe_app_instance_admin(
AppInstanceAdminArn='string',
AppInstanceArn='string'
)
[REQUIRED]
The ARN of the AppInstanceAdmin .
[REQUIRED]
The ARN of the AppInstance .
dict
Response Syntax
{
'AppInstanceAdmin': {
'Admin': {
'Arn': 'string',
'Name': 'string'
},
'AppInstanceArn': 'string',
'CreatedTimestamp': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
AppInstanceAdmin (dict) --
The ARN and name of the AppInstanceUser , the ARN of the AppInstance , and the created and last-updated timestamps. All timestamps use epoch milliseconds.
Admin (dict) --
The AppInstanceAdmin data.
Arn (string) --
The ARN in an Identity.
Name (string) --
The name in an Identity.
AppInstanceArn (string) --
The ARN of the AppInstance for which the user is an administrator.
CreatedTimestamp (datetime) --
The time at which an administrator was created.
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptiondescribe_app_instance_user(**kwargs)¶Returns the full details of an AppInstanceUser .
See also: AWS API Documentation
Request Syntax
response = client.describe_app_instance_user(
AppInstanceUserArn='string'
)
[REQUIRED]
The ARN of the AppInstanceUser .
{
'AppInstanceUser': {
'AppInstanceUserArn': 'string',
'Name': 'string',
'CreatedTimestamp': datetime(2015, 1, 1),
'Metadata': 'string',
'LastUpdatedTimestamp': datetime(2015, 1, 1)
}
}
Response Structure
The name of the AppInstanceUser .
The ARN of the AppInstanceUser .
The name of the AppInstanceUser .
The time at which the AppInstanceUser was created.
The metadata of the AppInstanceUser .
The time at which the AppInstanceUser was last updated.
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptiondescribe_channel(**kwargs)¶Returns the full details of a channel in an Amazon Chime AppInstance .
Note
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
See also: AWS API Documentation
Request Syntax
response = client.describe_channel(
ChannelArn='string',
ChimeBearer='string'
)
[REQUIRED]
The ARN of the channel.
AppInstanceUserArn of the user that makes the API call.dict
Response Syntax
{
'Channel': {
'Name': 'string',
'ChannelArn': 'string',
'Mode': 'UNRESTRICTED'|'RESTRICTED',
'Privacy': 'PUBLIC'|'PRIVATE',
'Metadata': 'string',
'CreatedBy': {
'Arn': 'string',
'Name': 'string'
},
'CreatedTimestamp': datetime(2015, 1, 1),
'LastMessageTimestamp': datetime(2015, 1, 1),
'LastUpdatedTimestamp': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
Channel (dict) --
The channel details.
Name (string) --
The name of the channel.
ChannelArn (string) --
The ARN of the channel.
Mode (string) --
The mode of the channel.
Privacy (string) --
The channel's privacy setting.
Metadata (string) --
The channel's metadata.
CreatedBy (dict) --
The AppInstanceUser who created the channel.
Arn (string) --
The ARN in an Identity.
Name (string) --
The name in an Identity.
CreatedTimestamp (datetime) --
The time at which the AppInstanceUser created the channel.
LastMessageTimestamp (datetime) --
The time at which a member sent the last message in the channel.
LastUpdatedTimestamp (datetime) --
The time at which a channel was last updated.
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptiondescribe_channel_ban(**kwargs)¶Returns the full details of a channel ban.
Note
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
See also: AWS API Documentation
Request Syntax
response = client.describe_channel_ban(
ChannelArn='string',
MemberArn='string',
ChimeBearer='string'
)
[REQUIRED]
The ARN of the channel from which the user is banned.
[REQUIRED]
The ARN of the member being banned.
AppInstanceUserArn of the user that makes the API call.dict
Response Syntax
{
'ChannelBan': {
'Member': {
'Arn': 'string',
'Name': 'string'
},
'ChannelArn': 'string',
'CreatedTimestamp': datetime(2015, 1, 1),
'CreatedBy': {
'Arn': 'string',
'Name': 'string'
}
}
}
Response Structure
(dict) --
ChannelBan (dict) --
The details of the ban.
Member (dict) --
The member being banned from the channel.
Arn (string) --
The ARN in an Identity.
Name (string) --
The name in an Identity.
ChannelArn (string) --
The ARN of the channel from which a member is being banned.
CreatedTimestamp (datetime) --
The time at which the ban was created.
CreatedBy (dict) --
The AppInstanceUser who created the ban.
Arn (string) --
The ARN in an Identity.
Name (string) --
The name in an Identity.
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptiondescribe_channel_membership(**kwargs)¶Returns the full details of a user's channel membership.
Note
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
See also: AWS API Documentation
Request Syntax
response = client.describe_channel_membership(
ChannelArn='string',
MemberArn='string',
ChimeBearer='string'
)
[REQUIRED]
The ARN of the channel.
[REQUIRED]
The ARN of the member.
AppInstanceUserArn of the user that makes the API call.dict
Response Syntax
{
'ChannelMembership': {
'InvitedBy': {
'Arn': 'string',
'Name': 'string'
},
'Type': 'DEFAULT'|'HIDDEN',
'Member': {
'Arn': 'string',
'Name': 'string'
},
'ChannelArn': 'string',
'CreatedTimestamp': datetime(2015, 1, 1),
'LastUpdatedTimestamp': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
ChannelMembership (dict) --
The details of the membership.
InvitedBy (dict) --
The identifier of the member who invited another member.
Arn (string) --
The ARN in an Identity.
Name (string) --
The name in an Identity.
Type (string) --
The membership type set for the channel member.
Member (dict) --
The data of the channel member.
Arn (string) --
The ARN in an Identity.
Name (string) --
The name in an Identity.
ChannelArn (string) --
The ARN of the member's channel.
CreatedTimestamp (datetime) --
The time at which the channel membership was created.
LastUpdatedTimestamp (datetime) --
The time at which a channel membership was last updated.
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptiondescribe_channel_membership_for_app_instance_user(**kwargs)¶Returns the details of a channel based on the membership of the specified AppInstanceUser .
Note
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
See also: AWS API Documentation
Request Syntax
response = client.describe_channel_membership_for_app_instance_user(
ChannelArn='string',
AppInstanceUserArn='string',
ChimeBearer='string'
)
[REQUIRED]
The ARN of the channel to which the user belongs.
[REQUIRED]
The ARN of the user in a channel.
AppInstanceUserArn of the user that makes the API call.dict
Response Syntax
{
'ChannelMembership': {
'ChannelSummary': {
'Name': 'string',
'ChannelArn': 'string',
'Mode': 'UNRESTRICTED'|'RESTRICTED',
'Privacy': 'PUBLIC'|'PRIVATE',
'Metadata': 'string',
'LastMessageTimestamp': datetime(2015, 1, 1)
},
'AppInstanceUserMembershipSummary': {
'Type': 'DEFAULT'|'HIDDEN',
'ReadMarkerTimestamp': datetime(2015, 1, 1)
}
}
}
Response Structure
(dict) --
ChannelMembership (dict) --
The channel to which a user belongs.
ChannelSummary (dict) --
Summary of the details of a Channel .
Name (string) --
The name of the channel.
ChannelArn (string) --
The ARN of the channel.
Mode (string) --
The mode of the channel.
Privacy (string) --
The privacy setting of the channel.
Metadata (string) --
The metadata of the channel.
LastMessageTimestamp (datetime) --
The time at which the last message in a channel was sent.
AppInstanceUserMembershipSummary (dict) --
Summary of the membership details of an AppInstanceUser .
Type (string) --
The type of ChannelMembership .
ReadMarkerTimestamp (datetime) --
The time at which a message was last read.
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptiondescribe_channel_moderated_by_app_instance_user(**kwargs)¶Returns the full details of a channel moderated by the specified AppInstanceUser .
Note
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
See also: AWS API Documentation
Request Syntax
response = client.describe_channel_moderated_by_app_instance_user(
ChannelArn='string',
AppInstanceUserArn='string',
ChimeBearer='string'
)
[REQUIRED]
The ARN of the moderated channel.
[REQUIRED]
The ARN of the AppInstanceUser in the moderated channel.
AppInstanceUserArn of the user that makes the API call.dict
Response Syntax
{
'Channel': {
'ChannelSummary': {
'Name': 'string',
'ChannelArn': 'string',
'Mode': 'UNRESTRICTED'|'RESTRICTED',
'Privacy': 'PUBLIC'|'PRIVATE',
'Metadata': 'string',
'LastMessageTimestamp': datetime(2015, 1, 1)
}
}
}
Response Structure
(dict) --
Channel (dict) --
The moderated channel.
ChannelSummary (dict) --
Summary of the details of a Channel .
Name (string) --
The name of the channel.
ChannelArn (string) --
The ARN of the channel.
Mode (string) --
The mode of the channel.
Privacy (string) --
The privacy setting of the channel.
Metadata (string) --
The metadata of the channel.
LastMessageTimestamp (datetime) --
The time at which the last message in a channel was sent.
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptiondescribe_channel_moderator(**kwargs)¶Returns the full details of a single ChannelModerator.
Note
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
See also: AWS API Documentation
Request Syntax
response = client.describe_channel_moderator(
ChannelArn='string',
ChannelModeratorArn='string',
ChimeBearer='string'
)
[REQUIRED]
The ARN of the channel.
[REQUIRED]
The ARN of the channel moderator.
AppInstanceUserArn of the user that makes the API call.dict
Response Syntax
{
'ChannelModerator': {
'Moderator': {
'Arn': 'string',
'Name': 'string'
},
'ChannelArn': 'string',
'CreatedTimestamp': datetime(2015, 1, 1),
'CreatedBy': {
'Arn': 'string',
'Name': 'string'
}
}
}
Response Structure
(dict) --
ChannelModerator (dict) --
The details of the channel moderator.
Moderator (dict) --
The moderator's data.
Arn (string) --
The ARN in an Identity.
Name (string) --
The name in an Identity.
ChannelArn (string) --
The ARN of the moderator's channel.
CreatedTimestamp (datetime) --
The time at which the moderator was created.
CreatedBy (dict) --
The AppInstanceUser who created the moderator.
Arn (string) --
The ARN in an Identity.
Name (string) --
The name in an Identity.
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptiondisassociate_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'
)
[REQUIRED]
The Amazon Chime account ID.
[REQUIRED]
The user ID.
dict
Response Syntax
{}
Response Structure
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptiondisassociate_phone_numbers_from_voice_connector(**kwargs)¶Disassociates the specified phone numbers 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.
[REQUIRED]
List of phone numbers, in E.164 format.
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.
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptiondisassociate_phone_numbers_from_voice_connector_group(**kwargs)¶Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector group.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_phone_numbers_from_voice_connector_group(
VoiceConnectorGroupId='string',
E164PhoneNumbers=[
'string',
]
)
[REQUIRED]
The Amazon Chime Voice Connector group ID.
[REQUIRED]
List of phone numbers, in E.164 format.
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.
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptiondisassociate_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',
]
)
[REQUIRED]
The Amazon Chime account ID.
[REQUIRED]
The sign-in delegate group names.
dict
Response Syntax
{}
Response Structure
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionget_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'
)
[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',
],
'AccountStatus': 'Suspended'|'Active',
'SigninDelegateGroups': [
{
'GroupName': 'string'
},
]
}
}
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.
The status of the account.
The sign-in delegate groups associated with the account.
An Active Directory (AD) group whose members are granted permission to act as delegates.
The group name.
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionget_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'
)
[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.
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionget_app_instance_retention_settings(**kwargs)¶Gets the retention settings for an AppInstance .
See also: AWS API Documentation
Request Syntax
response = client.get_app_instance_retention_settings(
AppInstanceArn='string'
)
[REQUIRED]
The ARN of the AppInstance .
{
'AppInstanceRetentionSettings': {
'ChannelRetentionSettings': {
'RetentionDays': 123
}
},
'InitiateDeletionTimestamp': datetime(2015, 1, 1)
}
Response Structure
The retention settings for the AppInstance .
The length of time in days to retain the messages in a channel.
The time in days to retain the messages in a channel.
The timestamp representing the time at which the specified items are retained, in Epoch Seconds.
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionget_app_instance_streaming_configurations(**kwargs)¶Gets the streaming settings for an AppInstance .
See also: AWS API Documentation
Request Syntax
response = client.get_app_instance_streaming_configurations(
AppInstanceArn='string'
)
[REQUIRED]
The ARN of the AppInstance .
{
'AppInstanceStreamingConfigurations': [
{
'AppInstanceDataType': 'Channel'|'ChannelMessage',
'ResourceArn': 'string'
},
]
}
Response Structure
The streaming settings.
The details of the streaming configuration of an AppInstance .
The type of data to be streamed.
The resource ARN.
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionget_attendee(**kwargs)¶Gets the Amazon Chime SDK attendee details for a specified meeting ID and attendee ID. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide .
See also: AWS API Documentation
Request Syntax
response = client.get_attendee(
MeetingId='string',
AttendeeId='string'
)
[REQUIRED]
The Amazon Chime SDK meeting ID.
[REQUIRED]
The Amazon Chime SDK attendee ID.
dict
Response Syntax
{
'Attendee': {
'ExternalUserId': 'string',
'AttendeeId': 'string',
'JoinToken': 'string'
}
}
Response Structure
(dict) --
Attendee (dict) --
The Amazon Chime SDK attendee information.
ExternalUserId (string) --
The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.
AttendeeId (string) --
The Amazon Chime SDK attendee ID.
JoinToken (string) --
The join token used by the Amazon Chime SDK attendee.
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionget_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'
)
[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.
Exceptions
Chime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionget_channel_message(**kwargs)¶Gets the full details of a channel message.
Note
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
See also: AWS API Documentation
Request Syntax
response = client.get_channel_message(
ChannelArn='string',
MessageId='string',
ChimeBearer='string'
)
[REQUIRED]
The ARN of the channel.
[REQUIRED]
The ID of the message.
AppInstanceUserArn of the user that makes the API call.dict
Response Syntax
{
'ChannelMessage': {
'ChannelArn': 'string',
'MessageId': 'string',
'Content': 'string',
'Metadata': 'string',
'Type': 'STANDARD'|'CONTROL',
'CreatedTimestamp': datetime(2015, 1, 1),
'LastEditedTimestamp': datetime(2015, 1, 1),
'LastUpdatedTimestamp': datetime(2015, 1, 1),
'Sender': {
'Arn': 'string',
'Name': 'string'
},
'Redacted': True|False,
'Persistence': 'PERSISTENT'|'NON_PERSISTENT'
}
}
Response Structure
(dict) --
ChannelMessage (dict) --
The details of and content in the message.
ChannelArn (string) --
The ARN of the channel.
MessageId (string) --
The ID of a message.
Content (string) --
The message content.
Metadata (string) --
The message metadata.
Type (string) --
The message type.
CreatedTimestamp (datetime) --
The time at which the message was created.
LastEditedTimestamp (datetime) --
The time at which a message was edited.
LastUpdatedTimestamp (datetime) --
The time at which a message was updated.
Sender (dict) --
The message sender.
Arn (string) --
The ARN in an Identity.
Name (string) --
The name in an Identity.
Redacted (boolean) --
Hides the content of a message.
Persistence (string) --
The persistence setting for a channel message.
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionget_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'
)
[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.
Exceptions
Chime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ResourceLimitExceededExceptionChime.Client.exceptions.NotFoundExceptionget_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()
{
'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.
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionget_media_capture_pipeline(**kwargs)¶Gets an existing media capture pipeline.
See also: AWS API Documentation
Request Syntax
response = client.get_media_capture_pipeline(
MediaPipelineId='string'
)
[REQUIRED]
The ID of the pipeline that you want to get.
{
'MediaCapturePipeline': {
'MediaPipelineId': 'string',
'SourceType': 'ChimeSdkMeeting',
'SourceArn': 'string',
'Status': 'Initializing'|'InProgress'|'Failed'|'Stopping'|'Stopped',
'SinkType': 'S3Bucket',
'SinkArn': 'string',
'CreatedTimestamp': datetime(2015, 1, 1),
'UpdatedTimestamp': datetime(2015, 1, 1),
'ChimeSdkMeetingConfiguration': {
'SourceConfiguration': {
'SelectedVideoStreams': {
'AttendeeIds': [
'string',
],
'ExternalUserIds': [
'string',
]
}
},
'ArtifactsConfiguration': {
'Audio': {
'MuxType': 'AudioOnly'|'AudioWithActiveSpeakerVideo'
},
'Video': {
'State': 'Enabled'|'Disabled',
'MuxType': 'VideoOnly'
},
'Content': {
'State': 'Enabled'|'Disabled',
'MuxType': 'ContentOnly'
}
}
}
}
}
Response Structure
The media capture pipeline object.
The ID of a media capture pipeline.
Source type from which media artifacts are saved. You must use ChimeMeeting .
ARN of the source from which the media artifacts will be saved.
The status of the media capture pipeline.
Destination type to which the media artifacts are saved. You must use an S3 Bucket.
ARN of the destination to which the media artifacts are saved.
The time at which the capture pipeline was created, in ISO 8601 format.
The time at which the capture pipeline was updated, in ISO 8601 format.
The configuration for a specified media capture pipeline. SourceType must be ChimeSdkMeeting .
The source configuration for a specified media capture pipline.
The selected video streams to capture for a specified media capture pipeline. The number of video streams can't exceed 25.
The attendee IDs of the streams selected for a media capture pipeline.
The external user IDs of the streams selected for a media capture pipeline.
The configuration for the artifacts in an Amazon Chime SDK meeting.
The configuration for the audio artifacts.
The MUX type of the audio artifact configuration object.
The configuration for the video artifacts.
Indicates whether the video artifact is enabled or disabled.
The MUX type of the video artifact configuration object.
The configuration for the content artifacts.
Indicates whether the content artifact is enabled or disabled.
The MUX type of the artifact configuration.
Exceptions
Chime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionget_meeting(**kwargs)¶Gets the Amazon Chime SDK meeting details for the specified meeting ID. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide .
See also: AWS API Documentation
Request Syntax
response = client.get_meeting(
MeetingId='string'
)
[REQUIRED]
The Amazon Chime SDK meeting ID.
{
'Meeting': {
'MeetingId': 'string',
'ExternalMeetingId': 'string',
'MediaPlacement': {
'AudioHostUrl': 'string',
'AudioFallbackUrl': 'string',
'ScreenDataUrl': 'string',
'ScreenSharingUrl': 'string',
'ScreenViewingUrl': 'string',
'SignalingUrl': 'string',
'TurnControlUrl': 'string',
'EventIngestionUrl': 'string'
},
'MediaRegion': 'string'
}
}
Response Structure
The Amazon Chime SDK meeting information.
The Amazon Chime SDK meeting ID.
The external meeting ID.
The media placement for the meeting.
The audio host URL.
The audio fallback URL.
The screen data URL.
The screen sharing URL.
The screen viewing URL.
The signaling URL.
The turn control URL.
The event ingestion URL to which you send client meeting events.
The Region in which you create the meeting. Available values: af-south-1 , ap-northeast-1 , ap-northeast-2 , ap-south-1 , ap-southeast-1 , ap-southeast-2 , ca-central-1 , eu-central-1 , eu-north-1 , eu-south-1 , eu-west-1 , eu-west-2 , eu-west-3 , sa-east-1 , us-east-1 , us-east-2 , us-west-1 , us-west-2 .
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionget_messaging_session_endpoint()¶The details of the endpoint for the messaging session.
See also: AWS API Documentation
Request Syntax
response = client.get_messaging_session_endpoint()
{
'Endpoint': {
'Url': 'string'
}
}
Response Structure
The endpoint returned in the response.
The endpoint to which you establish a websocket connection.
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionget_paginator(operation_name)¶Create a paginator for an operation.
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").client.can_paginate method to
check if an operation is pageable.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'
)
[REQUIRED]
The phone number ID.
{
'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
The phone number details.
The phone number ID.
The phone number, in E.164 format.
The phone number country. Format: ISO 3166-1 alpha-2.
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, Amazon Chime Voice Connector ID, or Amazon Chime Voice Connector group ID.
Contains the ID for the entity specified in Name.
Defines the association with an Amazon Chime account ID, user ID, Amazon Chime Voice Connector ID, or Amazon Chime Voice Connector group ID.
The timestamp of the phone number association, in ISO 8601 format.
The outbound calling name associated with the phone number.
The outbound calling name status.
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.
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionget_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'
)
[REQUIRED]
The ID for the phone number order.
{
'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
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 time stamp, in ISO 8601 format.
The updated phone number order time stamp, in ISO 8601 format.
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionget_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()
{
'CallingName': 'string',
'CallingNameUpdatedTimestamp': datetime(2015, 1, 1)
}
Response Structure
The default outbound calling name for the account.
The updated outbound calling name timestamp, in ISO 8601 format.
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionget_proxy_session(**kwargs)¶Gets the specified proxy session details for the specified Amazon Chime Voice Connector.
See also: AWS API Documentation
Request Syntax
response = client.get_proxy_session(
VoiceConnectorId='string',
ProxySessionId='string'
)
[REQUIRED]
The Amazon Chime voice connector ID.
[REQUIRED]
The proxy session ID.
dict
Response Syntax
{
'ProxySession': {
'VoiceConnectorId': 'string',
'ProxySessionId': 'string',
'Name': 'string',
'Status': 'Open'|'InProgress'|'Closed',
'ExpiryMinutes': 123,
'Capabilities': [
'Voice'|'SMS',
],
'CreatedTimestamp': datetime(2015, 1, 1),
'UpdatedTimestamp': datetime(2015, 1, 1),
'EndedTimestamp': datetime(2015, 1, 1),
'Participants': [
{
'PhoneNumber': 'string',
'ProxyPhoneNumber': 'string'
},
],
'NumberSelectionBehavior': 'PreferSticky'|'AvoidSticky',
'GeoMatchLevel': 'Country'|'AreaCode',
'GeoMatchParams': {
'Country': 'string',
'AreaCode': 'string'
}
}
}
Response Structure
(dict) --
ProxySession (dict) --
The proxy session details.
VoiceConnectorId (string) --
The Amazon Chime voice connector ID.
ProxySessionId (string) --
The proxy session ID.
Name (string) --
The name of the proxy session.
Status (string) --
The status of the proxy session.
ExpiryMinutes (integer) --
The number of minutes allowed for the proxy session.
Capabilities (list) --
The proxy session capabilities.
CreatedTimestamp (datetime) --
The created time stamp, in ISO 8601 format.
UpdatedTimestamp (datetime) --
The updated time stamp, in ISO 8601 format.
EndedTimestamp (datetime) --
The ended time stamp, in ISO 8601 format.
Participants (list) --
The proxy session participants.
(dict) --
The phone number and proxy phone number for a participant in an Amazon Chime Voice Connector proxy session.
PhoneNumber (string) --
The participant's phone number.
ProxyPhoneNumber (string) --
The participant's proxy phone number.
NumberSelectionBehavior (string) --
The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.
GeoMatchLevel (string) --
The preference for matching the country or area code of the proxy phone number with that of the first participant.
GeoMatchParams (dict) --
The country and area code for the proxy phone number.
Country (string) --
The country.
AreaCode (string) --
The area code.
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionget_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'
)
[REQUIRED]
The Amazon Chime account ID.
{
'RetentionSettings': {
'RoomRetentionSettings': {
'RetentionDays': 123
},
'ConversationRetentionSettings': {
'RetentionDays': 123
}
},
'InitiateDeletionTimestamp': datetime(2015, 1, 1)
}
Response Structure
The retention settings.
The chat room retention settings.
The number of days for which to retain chat-room messages.
The chat conversation retention settings.
The number of days for which to retain conversation messages.
The timestamp representing the time at which the specified items are permanently deleted, in ISO 8601 format.
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionget_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'
)
[REQUIRED]
The Amazon Chime account ID.
[REQUIRED]
The room ID.
dict
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.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionget_sip_media_application(**kwargs)¶Retrieves the information for a SIP media application, including name, AWS Region, and endpoints.
See also: AWS API Documentation
Request Syntax
response = client.get_sip_media_application(
SipMediaApplicationId='string'
)
[REQUIRED]
The SIP media application ID.
{
'SipMediaApplication': {
'SipMediaApplicationId': 'string',
'AwsRegion': 'string',
'Name': 'string',
'Endpoints': [
{
'LambdaArn': 'string'
},
],
'CreatedTimestamp': datetime(2015, 1, 1),
'UpdatedTimestamp': datetime(2015, 1, 1)
}
}
Response Structure
The SIP media application details.
The SIP media application ID.
The AWS Region in which the SIP media application is created.
The name of the SIP media application.
List of endpoints for SIP media application. Currently, only one endpoint per SIP media application is permitted.
The endpoint assigned to the SIP media application.
Valid Amazon Resource Name (ARN) of the Lambda function. The function must be created in the same AWS Region as the SIP media application.
The SIP media application creation timestamp, in ISO 8601 format.
The SIP media application updated timestamp, in ISO 8601 format.
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionget_sip_media_application_logging_configuration(**kwargs)¶Returns the logging configuration for the specified SIP media application.
See also: AWS API Documentation
Request Syntax
response = client.get_sip_media_application_logging_configuration(
SipMediaApplicationId='string'
)
[REQUIRED]
The SIP media application ID.
{
'SipMediaApplicationLoggingConfiguration': {
'EnableSipMediaApplicationMessageLogs': True|False
}
}
Response Structure
The actual logging configuration.
Enables application message logs for the SIP media application.
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionget_sip_rule(**kwargs)¶Retrieves the details of a SIP rule, such as the rule ID, name, triggers, and target endpoints.
See also: AWS API Documentation
Request Syntax
response = client.get_sip_rule(
SipRuleId='string'
)
[REQUIRED]
The SIP rule ID.
{
'SipRule': {
'SipRuleId': 'string',
'Name': 'string',
'Disabled': True|False,
'TriggerType': 'ToPhoneNumber'|'RequestUriHostname',
'TriggerValue': 'string',
'TargetApplications': [
{
'SipMediaApplicationId': 'string',
'Priority': 123,
'AwsRegion': 'string'
},
],
'CreatedTimestamp': datetime(2015, 1, 1),
'UpdatedTimestamp': datetime(2015, 1, 1)
}
}
Response Structure
The SIP rule details.
The SIP rule ID.
The name of the SIP rule.
Indicates whether the SIP rule is enabled or disabled. You must disable a rule before you can delete it.
The type of trigger assigned to the SIP rule in TriggerValue , currently RequestUriHostname or ToPhoneNumber .
If TriggerType is RequestUriHostname , then the value can be the outbound host name of the Amazon Chime Voice Connector. If TriggerType is ToPhoneNumber , then the value can be a customer-owned phone number in E164 format. SipRule is triggered when a SIP rule requests host name or ToPhoneNumber matches in the incoming SIP request.
Target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.
Target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.
The SIP media application ID.
Priority of the SIP media application in the target list.
The AWS Region of the target application.
The time at which the SIP rule was created, in ISO 8601 format.
The time at which the SIP rule was last updated, in ISO 8601 format.
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionget_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'
)
[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',
'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.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionget_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'
)
[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.
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionget_voice_connector(**kwargs)¶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',
'AwsRegion': 'us-east-1'|'us-west-2',
'Name': 'string',
'OutboundHostName': 'string',
'RequireEncryption': True|False,
'CreatedTimestamp': datetime(2015, 1, 1),
'UpdatedTimestamp': datetime(2015, 1, 1),
'VoiceConnectorArn': 'string'
}
}
Response Structure
The Amazon Chime Voice Connector details.
The Amazon Chime Voice Connector ID.
The AWS Region in which the Amazon Chime Voice Connector is created. Default: us-east-1 .
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.
The ARN of the specified Amazon Chime Voice Connector.
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionget_voice_connector_emergency_calling_configuration(**kwargs)¶Gets the emergency calling configuration details for the specified Amazon Chime Voice Connector.
See also: AWS API Documentation
Request Syntax
response = client.get_voice_connector_emergency_calling_configuration(
VoiceConnectorId='string'
)
[REQUIRED]
The Amazon Chime Voice Connector ID.
{
'EmergencyCallingConfiguration': {
'DNIS': [
{
'EmergencyPhoneNumber': 'string',
'TestPhoneNumber': 'string',
'CallingCountry': 'string'
},
]
}
}
Response Structure
The emergency calling configuration details.
The Dialed Number Identification Service (DNIS) emergency calling configuration details.
The Dialed Number Identification Service (DNIS) emergency calling configuration details associated with an Amazon Chime Voice Connector's emergency calling configuration.
The DNIS phone number to route emergency calls to, in E.164 format.
The DNIS phone number to route test emergency calls to, in E.164 format.
The country from which emergency calls are allowed, in ISO 3166-1 alpha-2 format.
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionget_voice_connector_group(**kwargs)¶Retrieves details for the specified Amazon Chime Voice Connector group, such as timestamps,name, and associated VoiceConnectorItems .
See also: AWS API Documentation
Request Syntax
response = client.get_voice_connector_group(
VoiceConnectorGroupId='string'
)
[REQUIRED]
The Amazon Chime Voice Connector group ID.
{
'VoiceConnectorGroup': {
'VoiceConnectorGroupId': 'string',
'Name': 'string',
'VoiceConnectorItems': [
{
'VoiceConnectorId': 'string',
'Priority': 123
},
],
'CreatedTimestamp': datetime(2015, 1, 1),
'UpdatedTimestamp': datetime(2015, 1, 1),
'VoiceConnectorGroupArn': 'string'
}
}
Response Structure
The Amazon Chime Voice Connector group details.
The Amazon Chime Voice Connector group ID.
The name of the Amazon Chime Voice Connector group.
The Amazon Chime Voice Connectors to which to route inbound calls.
For Amazon Chime Voice Connector groups, the Amazon Chime Voice Connectors to which to route inbound calls. Includes priority configuration settings. Limit: 3 VoiceConnectorItems per Amazon Chime Voice Connector group.
The Amazon Chime Voice Connector ID.
The priority associated with the Amazon Chime Voice Connector, with 1 being the highest priority. Higher priority Amazon Chime Voice Connectors are attempted first.
The Amazon Chime Voice Connector group creation time stamp, in ISO 8601 format.
The updated Amazon Chime Voice Connector group time stamp, in ISO 8601 format.
The ARN of the specified Amazon Chime Voice Connector group.
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionget_voice_connector_logging_configuration(**kwargs)¶Retrieves the logging configuration details for the specified Amazon Chime Voice Connector. Shows whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.
See also: AWS API Documentation
Request Syntax
response = client.get_voice_connector_logging_configuration(
VoiceConnectorId='string'
)
[REQUIRED]
The Amazon Chime Voice Connector ID.
{
'LoggingConfiguration': {
'EnableSIPLogs': True|False,
'EnableMediaMetricLogs': True|False
}
}
Response Structure
The logging configuration details.
When true, enables SIP message logs for sending to Amazon CloudWatch Logs.
Boolean that enables the logging of Voice Connector metrics to Cloudwatch.
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionget_voice_connector_origination(**kwargs)¶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. This parameter is not required, but you must specify this parameter or Disabled .
Origination routes define call distribution properties for your SIP hosts to receive inbound calls using your Amazon Chime Voice Connector. Limit: Ten origination routes for each Amazon Chime Voice Connector.
Note
The parameters listed below are not required, but you must use at least one.
The FQDN 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 redistributed among them based on their relative weight.
When origination settings are disabled, inbound calls are not enabled for your Amazon Chime Voice Connector. This parameter is not required, but you must specify this parameter or Routes .
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionget_voice_connector_proxy(**kwargs)¶Gets the proxy configuration details for the specified Amazon Chime Voice Connector.
See also: AWS API Documentation
Request Syntax
response = client.get_voice_connector_proxy(
VoiceConnectorId='string'
)
[REQUIRED]
The Amazon Chime voice connector ID.
{
'Proxy': {
'DefaultSessionExpiryMinutes': 123,
'Disabled': True|False,
'FallBackPhoneNumber': 'string',
'PhoneNumberCountries': [
'string',
]
}
}
Response Structure
The proxy configuration details.
The default number of minutes allowed for proxy sessions.
When true, stops proxy sessions from being created on the specified Amazon Chime Voice Connector.
The phone number to route calls to after a proxy session expires.
The countries for proxy phone numbers to be selected from.
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionget_voice_connector_streaming_configuration(**kwargs)¶Retrieves the streaming configuration details for the specified Amazon Chime Voice Connector. Shows whether media streaming is enabled for sending to Amazon Kinesis. It also shows the retention period, in hours, for the Amazon Kinesis data.
See also: AWS API Documentation
Request Syntax
response = client.get_voice_connector_streaming_configuration(
VoiceConnectorId='string'
)
[REQUIRED]
The Amazon Chime Voice Connector ID.
{
'StreamingConfiguration': {
'DataRetentionInHours': 123,
'Disabled': True|False,
'StreamingNotificationTargets': [
{
'NotificationTarget': 'EventBridge'|'SNS'|'SQS'
},
]
}
}
Response Structure
The streaming configuration details.
The retention period, in hours, for the Amazon Kinesis data.
When true, media streaming to Amazon Kinesis is turned off.
The streaming notification targets.
The targeted recipient for a streaming configuration notification.
The streaming notification target.
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionget_voice_connector_termination(**kwargs)¶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 quota. Default value of 1.
The default caller ID phone number.
The countries to which calls are allowed, in ISO 3166-1 alpha-2 format. Required.
The IP addresses allowed to make calls, in CIDR format. Required.
When termination settings are disabled, outbound calls can not be made.
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionget_voice_connector_termination_health(**kwargs)¶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.
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionget_waiter(waiter_name)¶Returns an object that can wait for some condition.
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'
)
[REQUIRED]
The Amazon Chime account ID.
[REQUIRED]
The user email addresses to which to send the email invitation.
dict
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.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionlist_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
)
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',
],
'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.
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.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionlist_app_instance_admins(**kwargs)¶Returns a list of the administrators in the AppInstance .
See also: AWS API Documentation
Request Syntax
response = client.list_app_instance_admins(
AppInstanceArn='string',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The ARN of the AppInstance .
dict
Response Syntax
{
'AppInstanceArn': 'string',
'AppInstanceAdmins': [
{
'Admin': {
'Arn': 'string',
'Name': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
AppInstanceArn (string) --
The ARN of the AppInstance .
AppInstanceAdmins (list) --
The information for each administrator.
(dict) --
Summary of the details of an AppInstanceAdmin .
Admin (dict) --
The details of the AppInstanceAdmin .
Arn (string) --
The ARN in an Identity.
Name (string) --
The name in an Identity.
NextToken (string) --
The token returned from previous API requests until the number of administrators is reached.
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionlist_app_instance_users(**kwargs)¶List all AppInstanceUsers created under a single AppInstance .
See also: AWS API Documentation
Request Syntax
response = client.list_app_instance_users(
AppInstanceArn='string',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The ARN of the AppInstance .
dict
Response Syntax
{
'AppInstanceArn': 'string',
'AppInstanceUsers': [
{
'AppInstanceUserArn': 'string',
'Name': 'string',
'Metadata': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
AppInstanceArn (string) --
The ARN of the AppInstance .
AppInstanceUsers (list) --
The information for each requested AppInstanceUser .
(dict) --
Summary of the details of an AppInstanceUser .
AppInstanceUserArn (string) --
The ARN of the AppInstanceUser .
Name (string) --
The name of an AppInstanceUser .
Metadata (string) --
The metadata of the AppInstanceUser .
NextToken (string) --
The token passed by previous API calls until all requested users are returned.
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionlist_app_instances(**kwargs)¶Lists all Amazon Chime AppInstance s created under a single AWS account.
See also: AWS API Documentation
Request Syntax
response = client.list_app_instances(
MaxResults=123,
NextToken='string'
)
AppInstance s that you want to return.AppInstance s.dict
Response Syntax
{
'AppInstances': [
{
'AppInstanceArn': 'string',
'Name': 'string',
'Metadata': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
AppInstances (list) --
The information for each AppInstance .
(dict) --
Summary of the data for an AppInstance .
AppInstanceArn (string) --
The AppInstance ARN.
Name (string) --
The name of the AppInstance .
Metadata (string) --
The metadata of the AppInstance .
NextToken (string) --
The token passed by previous API requests until the maximum number of AppInstance s is reached.
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionLists the tags applied to an Amazon Chime SDK attendee resource.
See also: AWS API Documentation
Request Syntax
response = client.list_attendee_tags(
MeetingId='string',
AttendeeId='string'
)
[REQUIRED]
The Amazon Chime SDK meeting ID.
[REQUIRED]
The Amazon Chime SDK attendee ID.
dict
Response Syntax
{
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) --
Tags (list) --
A list of tag key-value pairs.
(dict) --
Describes a tag applied to a resource.
Key (string) --
The key of the tag.
Value (string) --
The value of the tag.
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionlist_attendees(**kwargs)¶Lists the attendees for the specified Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide .
See also: AWS API Documentation
Request Syntax
response = client.list_attendees(
MeetingId='string',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The Amazon Chime SDK meeting ID.
dict
Response Syntax
{
'Attendees': [
{
'ExternalUserId': 'string',
'AttendeeId': 'string',
'JoinToken': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Attendees (list) --
The Amazon Chime SDK attendee information.
(dict) --
An Amazon Chime SDK meeting attendee. Includes a unique AttendeeId and JoinToken . The JoinToken allows a client to authenticate and join as the specified attendee. The JoinToken expires when the meeting ends or when DeleteAttendee is called. After that, the attendee is unable to join the meeting.
We recommend securely transferring each JoinToken from your server application to the client so that no other client has access to the token except for the one authorized to represent the attendee.
ExternalUserId (string) --
The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.
AttendeeId (string) --
The Amazon Chime SDK attendee ID.
JoinToken (string) --
The join token used by the Amazon Chime SDK attendee.
NextToken (string) --
The token to use to retrieve the next page of results.
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionlist_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'
)
[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.
Exceptions
Chime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ThrottledClientExceptionlist_channel_bans(**kwargs)¶Lists all the users banned from a particular channel.
Note
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
See also: AWS API Documentation
Request Syntax
response = client.list_channel_bans(
ChannelArn='string',
MaxResults=123,
NextToken='string',
ChimeBearer='string'
)
[REQUIRED]
The ARN of the channel.
AppInstanceUserArn of the user that makes the API call.dict
Response Syntax
{
'ChannelArn': 'string',
'NextToken': 'string',
'ChannelBans': [
{
'Member': {
'Arn': 'string',
'Name': 'string'
}
},
]
}
Response Structure
(dict) --
ChannelArn (string) --
The ARN of the channel.
NextToken (string) --
The token passed by previous API calls until all requested bans are returned.
ChannelBans (list) --
The information for each requested ban.
(dict) --
Summary of the details of a ChannelBan .
Member (dict) --
The member being banned from a channel.
Arn (string) --
The ARN in an Identity.
Name (string) --
The name in an Identity.
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionlist_channel_memberships(**kwargs)¶Lists all channel memberships in a channel.
Note
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
See also: AWS API Documentation
Request Syntax
response = client.list_channel_memberships(
ChannelArn='string',
Type='DEFAULT'|'HIDDEN',
MaxResults=123,
NextToken='string',
ChimeBearer='string'
)
[REQUIRED]
The maximum number of channel memberships that you want returned.
DEFAULT or HIDDEN . Default members are always returned as part of ListChannelMemberships . Hidden members are only returned if the type filter in ListChannelMemberships equals HIDDEN . Otherwise hidden members are not returned.AppInstanceUserArn of the user that makes the API call.dict
Response Syntax
{
'ChannelArn': 'string',
'ChannelMemberships': [
{
'Member': {
'Arn': 'string',
'Name': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ChannelArn (string) --
The ARN of the channel.
ChannelMemberships (list) --
The information for the requested channel memberships.
(dict) --
Summary of the details of a ChannelMembership .
Member (dict) --
A member's summary data.
Arn (string) --
The ARN in an Identity.
Name (string) --
The name in an Identity.
NextToken (string) --
The token passed by previous API calls until all requested channel memberships are returned.
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionlist_channel_memberships_for_app_instance_user(**kwargs)¶Lists all channels that a particular AppInstanceUser is a part of. Only an AppInstanceAdmin can call the API with a user ARN that is not their own.
Note
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
See also: AWS API Documentation
Request Syntax
response = client.list_channel_memberships_for_app_instance_user(
AppInstanceUserArn='string',
MaxResults=123,
NextToken='string',
ChimeBearer='string'
)
AppInstanceUser sAppInstanceUserArn of the user that makes the API call.dict
Response Syntax
{
'ChannelMemberships': [
{
'ChannelSummary': {
'Name': 'string',
'ChannelArn': 'string',
'Mode': 'UNRESTRICTED'|'RESTRICTED',
'Privacy': 'PUBLIC'|'PRIVATE',
'Metadata': 'string',
'LastMessageTimestamp': datetime(2015, 1, 1)
},
'AppInstanceUserMembershipSummary': {
'Type': 'DEFAULT'|'HIDDEN',
'ReadMarkerTimestamp': datetime(2015, 1, 1)
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ChannelMemberships (list) --
The token passed by previous API calls until all requested users are returned.
(dict) --
Summary of the channel membership details of an AppInstanceUser .
ChannelSummary (dict) --
Summary of the details of a Channel .
Name (string) --
The name of the channel.
ChannelArn (string) --
The ARN of the channel.
Mode (string) --
The mode of the channel.
Privacy (string) --
The privacy setting of the channel.
Metadata (string) --
The metadata of the channel.
LastMessageTimestamp (datetime) --
The time at which the last message in a channel was sent.
AppInstanceUserMembershipSummary (dict) --
Summary of the membership details of an AppInstanceUser .
Type (string) --
The type of ChannelMembership .
ReadMarkerTimestamp (datetime) --
The time at which a message was last read.
NextToken (string) --
The token passed by previous API calls until all requested users are returned.
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionlist_channel_messages(**kwargs)¶List all the messages in a channel. Returns a paginated list of ChannelMessages . By default, sorted by creation timestamp in descending order.
Note
Redacted messages appear in the results as empty, since they are only redacted, not deleted. Deleted messages do not appear in the results. This action always returns the latest version of an edited message.
Also, the x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
See also: AWS API Documentation
Request Syntax
response = client.list_channel_messages(
ChannelArn='string',
SortOrder='ASCENDING'|'DESCENDING',
NotBefore=datetime(2015, 1, 1),
NotAfter=datetime(2015, 1, 1),
MaxResults=123,
NextToken='string',
ChimeBearer='string'
)
[REQUIRED]
The ARN of the channel.
AppInstanceUserArn of the user that makes the API call.dict
Response Syntax
{
'ChannelArn': 'string',
'NextToken': 'string',
'ChannelMessages': [
{
'MessageId': 'string',
'Content': 'string',
'Metadata': 'string',
'Type': 'STANDARD'|'CONTROL',
'CreatedTimestamp': datetime(2015, 1, 1),
'LastUpdatedTimestamp': datetime(2015, 1, 1),
'LastEditedTimestamp': datetime(2015, 1, 1),
'Sender': {
'Arn': 'string',
'Name': 'string'
},
'Redacted': True|False
},
]
}
Response Structure
(dict) --
ChannelArn (string) --
The ARN of the channel containing the requested messages.
NextToken (string) --
The token passed by previous API calls until all requested messages are returned.
ChannelMessages (list) --
The information about, and content of, each requested message.
(dict) --
Summary of the messages in a Channel .
MessageId (string) --
The ID of the message.
Content (string) --
The content of the message.
Metadata (string) --
The metadata of the message.
Type (string) --
The type of message.
CreatedTimestamp (datetime) --
The time at which the message summary was created.
LastUpdatedTimestamp (datetime) --
The time at which a message was last updated.
LastEditedTimestamp (datetime) --
The time at which a message was last edited.
Sender (dict) --
The message sender.
Arn (string) --
The ARN in an Identity.
Name (string) --
The name in an Identity.
Redacted (boolean) --
Indicates whether a message was redacted.
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionlist_channel_moderators(**kwargs)¶Lists all the moderators for a channel.
Note
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
See also: AWS API Documentation
Request Syntax
response = client.list_channel_moderators(
ChannelArn='string',
MaxResults=123,
NextToken='string',
ChimeBearer='string'
)
[REQUIRED]
The ARN of the channel.
AppInstanceUserArn of the user that makes the API call.dict
Response Syntax
{
'ChannelArn': 'string',
'NextToken': 'string',
'ChannelModerators': [
{
'Moderator': {
'Arn': 'string',
'Name': 'string'
}
},
]
}
Response Structure
(dict) --
ChannelArn (string) --
The ARN of the channel.
NextToken (string) --
The token passed by previous API calls until all requested moderators are returned.
ChannelModerators (list) --
The information about and names of each moderator.
(dict) --
Summary of the details of a ChannelModerator .
Moderator (dict) --
The data for a moderator.
Arn (string) --
The ARN in an Identity.
Name (string) --
The name in an Identity.
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionlist_channels(**kwargs)¶Lists all Channels created under a single Chime App as a paginated list. You can specify filters to narrow results.
Functionality & restrictions
PUBLIC to retrieve all public channels in the account.AppInstanceAdmin can set privacy = PRIVATE to list the private channels in an account.Note
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
See also: AWS API Documentation
Request Syntax
response = client.list_channels(
AppInstanceArn='string',
Privacy='PUBLIC'|'PRIVATE',
MaxResults=123,
NextToken='string',
ChimeBearer='string'
)
[REQUIRED]
The ARN of the AppInstance .
PUBLIC retrieves all the public channels. PRIVATE retrieves private channels. Only an AppInstanceAdmin can retrieve private channels.AppInstanceUserArn of the user that makes the API call.dict
Response Syntax
{
'Channels': [
{
'Name': 'string',
'ChannelArn': 'string',
'Mode': 'UNRESTRICTED'|'RESTRICTED',
'Privacy': 'PUBLIC'|'PRIVATE',
'Metadata': 'string',
'LastMessageTimestamp': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Channels (list) --
The information about each channel.
(dict) --
Summary of the details of a Channel .
Name (string) --
The name of the channel.
ChannelArn (string) --
The ARN of the channel.
Mode (string) --
The mode of the channel.
Privacy (string) --
The privacy setting of the channel.
Metadata (string) --
The metadata of the channel.
LastMessageTimestamp (datetime) --
The time at which the last message in a channel was sent.
NextToken (string) --
The token returned from previous API requests until the number of channels is reached.
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionlist_channels_moderated_by_app_instance_user(**kwargs)¶A list of the channels moderated by an AppInstanceUser .
Note
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
See also: AWS API Documentation
Request Syntax
response = client.list_channels_moderated_by_app_instance_user(
AppInstanceUserArn='string',
MaxResults=123,
NextToken='string',
ChimeBearer='string'
)
AppInstanceUserArn of the user that makes the API call.dict
Response Syntax
{
'Channels': [
{
'ChannelSummary': {
'Name': 'string',
'ChannelArn': 'string',
'Mode': 'UNRESTRICTED'|'RESTRICTED',
'Privacy': 'PUBLIC'|'PRIVATE',
'Metadata': 'string',
'LastMessageTimestamp': datetime(2015, 1, 1)
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Channels (list) --
The moderated channels in the request.
(dict) --
Summary of the details of a moderated channel.
ChannelSummary (dict) --
Summary of the details of a Channel .
Name (string) --
The name of the channel.
ChannelArn (string) --
The ARN of the channel.
Mode (string) --
The mode of the channel.
Privacy (string) --
The privacy setting of the channel.
Metadata (string) --
The metadata of the channel.
LastMessageTimestamp (datetime) --
The time at which the last message in a channel was sent.
NextToken (string) --
The token returned from previous API requests until the number of channels moderated by the user is reached.
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionlist_media_capture_pipelines(**kwargs)¶Returns a list of media capture pipelines.
See also: AWS API Documentation
Request Syntax
response = client.list_media_capture_pipelines(
NextToken='string',
MaxResults=123
)
dict
Response Syntax
{
'MediaCapturePipelines': [
{
'MediaPipelineId': 'string',
'SourceType': 'ChimeSdkMeeting',
'SourceArn': 'string',
'Status': 'Initializing'|'InProgress'|'Failed'|'Stopping'|'Stopped',
'SinkType': 'S3Bucket',
'SinkArn': 'string',
'CreatedTimestamp': datetime(2015, 1, 1),
'UpdatedTimestamp': datetime(2015, 1, 1),
'ChimeSdkMeetingConfiguration': {
'SourceConfiguration': {
'SelectedVideoStreams': {
'AttendeeIds': [
'string',
],
'ExternalUserIds': [
'string',
]
}
},
'ArtifactsConfiguration': {
'Audio': {
'MuxType': 'AudioOnly'|'AudioWithActiveSpeakerVideo'
},
'Video': {
'State': 'Enabled'|'Disabled',
'MuxType': 'VideoOnly'
},
'Content': {
'State': 'Enabled'|'Disabled',
'MuxType': 'ContentOnly'
}
}
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
MediaCapturePipelines (list) --
The media capture pipeline objects in the list.
(dict) --
A media capture pipeline object consisting of an ID, source type, source ARN, a sink type, a sink ARN, and a configuration object.
MediaPipelineId (string) --
The ID of a media capture pipeline.
SourceType (string) --
Source type from which media artifacts are saved. You must use ChimeMeeting .
SourceArn (string) --
ARN of the source from which the media artifacts will be saved.
Status (string) --
The status of the media capture pipeline.
SinkType (string) --
Destination type to which the media artifacts are saved. You must use an S3 Bucket.
SinkArn (string) --
ARN of the destination to which the media artifacts are saved.
CreatedTimestamp (datetime) --
The time at which the capture pipeline was created, in ISO 8601 format.
UpdatedTimestamp (datetime) --
The time at which the capture pipeline was updated, in ISO 8601 format.
ChimeSdkMeetingConfiguration (dict) --
The configuration for a specified media capture pipeline. SourceType must be ChimeSdkMeeting .
SourceConfiguration (dict) --
The source configuration for a specified media capture pipline.
SelectedVideoStreams (dict) --
The selected video streams to capture for a specified media capture pipeline. The number of video streams can't exceed 25.
AttendeeIds (list) --
The attendee IDs of the streams selected for a media capture pipeline.
ExternalUserIds (list) --
The external user IDs of the streams selected for a media capture pipeline.
ArtifactsConfiguration (dict) --
The configuration for the artifacts in an Amazon Chime SDK meeting.
Audio (dict) --
The configuration for the audio artifacts.
MuxType (string) --
The MUX type of the audio artifact configuration object.
Video (dict) --
The configuration for the video artifacts.
State (string) --
Indicates whether the video artifact is enabled or disabled.
MuxType (string) --
The MUX type of the video artifact configuration object.
Content (dict) --
The configuration for the content artifacts.
State (string) --
Indicates whether the content artifact is enabled or disabled.
MuxType (string) --
The MUX type of the artifact configuration.
NextToken (string) --
The token used to retrieve the next page of results.
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionLists the tags applied to an Amazon Chime SDK meeting resource.
See also: AWS API Documentation
Request Syntax
response = client.list_meeting_tags(
MeetingId='string'
)
[REQUIRED]
The Amazon Chime SDK meeting ID.
{
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
A list of tag key-value pairs.
Describes a tag applied to a resource.
The key of the tag.
The value of the tag.
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionlist_meetings(**kwargs)¶Lists up to 100 active Amazon Chime SDK meetings. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide .
See also: AWS API Documentation
Request Syntax
response = client.list_meetings(
NextToken='string',
MaxResults=123
)
dict
Response Syntax
{
'Meetings': [
{
'MeetingId': 'string',
'ExternalMeetingId': 'string',
'MediaPlacement': {
'AudioHostUrl': 'string',
'AudioFallbackUrl': 'string',
'ScreenDataUrl': 'string',
'ScreenSharingUrl': 'string',
'ScreenViewingUrl': 'string',
'SignalingUrl': 'string',
'TurnControlUrl': 'string',
'EventIngestionUrl': 'string'
},
'MediaRegion': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Meetings (list) --
The Amazon Chime SDK meeting information.
(dict) --
A meeting created using the Amazon Chime SDK.
MeetingId (string) --
The Amazon Chime SDK meeting ID.
ExternalMeetingId (string) --
The external meeting ID.
MediaPlacement (dict) --
The media placement for the meeting.
AudioHostUrl (string) --
The audio host URL.
AudioFallbackUrl (string) --
The audio fallback URL.
ScreenDataUrl (string) --
The screen data URL.
ScreenSharingUrl (string) --
The screen sharing URL.
ScreenViewingUrl (string) --
The screen viewing URL.
SignalingUrl (string) --
The signaling URL.
TurnControlUrl (string) --
The turn control URL.
EventIngestionUrl (string) --
The event ingestion URL to which you send client meeting events.
MediaRegion (string) --
The Region in which you create the meeting. Available values: af-south-1 , ap-northeast-1 , ap-northeast-2 , ap-south-1 , ap-southeast-1 , ap-southeast-2 , ca-central-1 , eu-central-1 , eu-north-1 , eu-south-1 , eu-west-1 , eu-west-2 , eu-west-3 , sa-east-1 , us-east-1 , us-east-2 , us-west-1 , us-west-2 .
NextToken (string) --
The token to use to retrieve the next page of results.
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionlist_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
)
dict
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.UnauthorizedClientExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionlist_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'
)
dict
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.UnauthorizedClientExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionlist_proxy_sessions(**kwargs)¶Lists the proxy sessions for the specified Amazon Chime Voice Connector.
See also: AWS API Documentation
Request Syntax
response = client.list_proxy_sessions(
VoiceConnectorId='string',
Status='Open'|'InProgress'|'Closed',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The Amazon Chime voice connector ID.
dict
Response Syntax
{
'ProxySessions': [
{
'VoiceConnectorId': 'string',
'ProxySessionId': 'string',
'Name': 'string',
'Status': 'Open'|'InProgress'|'Closed',
'ExpiryMinutes': 123,
'Capabilities': [
'Voice'|'SMS',
],
'CreatedTimestamp': datetime(2015, 1, 1),
'UpdatedTimestamp': datetime(2015, 1, 1),
'EndedTimestamp': datetime(2015, 1, 1),
'Participants': [
{
'PhoneNumber': 'string',
'ProxyPhoneNumber': 'string'
},
],
'NumberSelectionBehavior': 'PreferSticky'|'AvoidSticky',
'GeoMatchLevel': 'Country'|'AreaCode',
'GeoMatchParams': {
'Country': 'string',
'AreaCode': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ProxySessions (list) --
The proxy session details.
(dict) --
The proxy session for an Amazon Chime Voice Connector.
VoiceConnectorId (string) --
The Amazon Chime voice connector ID.
ProxySessionId (string) --
The proxy session ID.
Name (string) --
The name of the proxy session.
Status (string) --
The status of the proxy session.
ExpiryMinutes (integer) --
The number of minutes allowed for the proxy session.
Capabilities (list) --
The proxy session capabilities.
CreatedTimestamp (datetime) --
The created time stamp, in ISO 8601 format.
UpdatedTimestamp (datetime) --
The updated time stamp, in ISO 8601 format.
EndedTimestamp (datetime) --
The ended time stamp, in ISO 8601 format.
Participants (list) --
The proxy session participants.
(dict) --
The phone number and proxy phone number for a participant in an Amazon Chime Voice Connector proxy session.
PhoneNumber (string) --
The participant's phone number.
ProxyPhoneNumber (string) --
The participant's proxy phone number.
NumberSelectionBehavior (string) --
The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.
GeoMatchLevel (string) --
The preference for matching the country or area code of the proxy phone number with that of the first participant.
GeoMatchParams (dict) --
The country and area code for the proxy phone number.
Country (string) --
The country.
AreaCode (string) --
The area code.
NextToken (string) --
The token to use to retrieve the next page of results.
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionlist_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'
)
[REQUIRED]
The Amazon Chime account ID.
[REQUIRED]
The room ID.
dict
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.NotFoundExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionlist_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'
)
[REQUIRED]
The Amazon Chime account ID.
dict
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.NotFoundExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionlist_sip_media_applications(**kwargs)¶Lists the SIP media applications under the administrator's AWS account.
See also: AWS API Documentation
Request Syntax
response = client.list_sip_media_applications(
MaxResults=123,
NextToken='string'
)
dict
Response Syntax
{
'SipMediaApplications': [
{
'SipMediaApplicationId': 'string',
'AwsRegion': 'string',
'Name': 'string',
'Endpoints': [
{
'LambdaArn': 'string'
},
],
'CreatedTimestamp': datetime(2015, 1, 1),
'UpdatedTimestamp': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
SipMediaApplications (list) --
List of SIP media applications and application details.
(dict) --
The details of the SIP media application, including name and endpoints. An AWS account can have multiple SIP media applications.
SipMediaApplicationId (string) --
The SIP media application ID.
AwsRegion (string) --
The AWS Region in which the SIP media application is created.
Name (string) --
The name of the SIP media application.
Endpoints (list) --
List of endpoints for SIP media application. Currently, only one endpoint per SIP media application is permitted.
(dict) --
The endpoint assigned to the SIP media application.
LambdaArn (string) --
Valid Amazon Resource Name (ARN) of the Lambda function. The function must be created in the same AWS Region as the SIP media application.
CreatedTimestamp (datetime) --
The SIP media application creation timestamp, in ISO 8601 format.
UpdatedTimestamp (datetime) --
The SIP media application updated timestamp, in ISO 8601 format.
NextToken (string) --
The token to use to retrieve the next page of results.
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionlist_sip_rules(**kwargs)¶Lists the SIP rules under the administrator's AWS account.
See also: AWS API Documentation
Request Syntax
response = client.list_sip_rules(
SipMediaApplicationId='string',
MaxResults=123,
NextToken='string'
)
dict
Response Syntax
{
'SipRules': [
{
'SipRuleId': 'string',
'Name': 'string',
'Disabled': True|False,
'TriggerType': 'ToPhoneNumber'|'RequestUriHostname',
'TriggerValue': 'string',
'TargetApplications': [
{
'SipMediaApplicationId': 'string',
'Priority': 123,
'AwsRegion': 'string'
},
],
'CreatedTimestamp': datetime(2015, 1, 1),
'UpdatedTimestamp': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
SipRules (list) --
List of SIP rules and rule details.
(dict) --
The SIP rule details, including name, triggers, and target applications. An AWS account can have multiple SIP rules.
SipRuleId (string) --
The SIP rule ID.
Name (string) --
The name of the SIP rule.
Disabled (boolean) --
Indicates whether the SIP rule is enabled or disabled. You must disable a rule before you can delete it.
TriggerType (string) --
The type of trigger assigned to the SIP rule in TriggerValue , currently RequestUriHostname or ToPhoneNumber .
TriggerValue (string) --
If TriggerType is RequestUriHostname , then the value can be the outbound host name of the Amazon Chime Voice Connector. If TriggerType is ToPhoneNumber , then the value can be a customer-owned phone number in E164 format. SipRule is triggered when a SIP rule requests host name or ToPhoneNumber matches in the incoming SIP request.
TargetApplications (list) --
Target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.
(dict) --
Target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.
SipMediaApplicationId (string) --
The SIP media application ID.
Priority (integer) --
Priority of the SIP media application in the target list.
AwsRegion (string) --
The AWS Region of the target application.
CreatedTimestamp (datetime) --
The time at which the SIP rule was created, in ISO 8601 format.
UpdatedTimestamp (datetime) --
The time at which the SIP rule was last updated, in ISO 8601 format.
NextToken (string) --
The token to use to retrieve the next page of results.
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionlist_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'
)
[REQUIRED]
The phone number product type.
{
'PhoneNumberCountries': [
{
'CountryCode': 'string',
'SupportedPhoneNumberTypes': [
'Local'|'TollFree',
]
},
]
}
Response Structure
The supported phone number countries.
The phone number country.
The phone number country code. Format: ISO 3166-1 alpha-2.
The supported phone number types.
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.AccessDeniedExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionLists the tags applied to an Amazon Chime SDK meeting resource.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
ResourceARN='string'
)
[REQUIRED]
The resource ARN.
{
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
A list of tag-key value pairs.
Describes a tag applied to a resource.
The key of the tag.
The value of the tag.
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionlist_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'
)
[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',
'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.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionlist_voice_connector_groups(**kwargs)¶Lists the Amazon Chime Voice Connector groups for the administrator's AWS account.
See also: AWS API Documentation
Request Syntax
response = client.list_voice_connector_groups(
NextToken='string',
MaxResults=123
)
dict
Response Syntax
{
'VoiceConnectorGroups': [
{
'VoiceConnectorGroupId': 'string',
'Name': 'string',
'VoiceConnectorItems': [
{
'VoiceConnectorId': 'string',
'Priority': 123
},
],
'CreatedTimestamp': datetime(2015, 1, 1),
'UpdatedTimestamp': datetime(2015, 1, 1),
'VoiceConnectorGroupArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
VoiceConnectorGroups (list) --
The details of the Amazon Chime Voice Connector groups.
(dict) --
The Amazon Chime Voice Connector group configuration, including associated Amazon Chime Voice Connectors. You can include Amazon Chime Voice Connectors from different AWS Regions in your group. This creates a fault tolerant mechanism for fallback in case of availability events.
VoiceConnectorGroupId (string) --
The Amazon Chime Voice Connector group ID.
Name (string) --
The name of the Amazon Chime Voice Connector group.
VoiceConnectorItems (list) --
The Amazon Chime Voice Connectors to which to route inbound calls.
(dict) --
For Amazon Chime Voice Connector groups, the Amazon Chime Voice Connectors to which to route inbound calls. Includes priority configuration settings. Limit: 3 VoiceConnectorItems per Amazon Chime Voice Connector group.
VoiceConnectorId (string) --
The Amazon Chime Voice Connector ID.
Priority (integer) --
The priority associated with the Amazon Chime Voice Connector, with 1 being the highest priority. Higher priority Amazon Chime Voice Connectors are attempted first.
CreatedTimestamp (datetime) --
The Amazon Chime Voice Connector group creation time stamp, in ISO 8601 format.
UpdatedTimestamp (datetime) --
The updated Amazon Chime Voice Connector group time stamp, in ISO 8601 format.
VoiceConnectorGroupArn (string) --
The ARN of the specified Amazon Chime Voice Connector group.
NextToken (string) --
The token to use to retrieve the next page of results.
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionlist_voice_connector_termination_credentials(**kwargs)¶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.
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionlist_voice_connectors(**kwargs)¶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',
'AwsRegion': 'us-east-1'|'us-west-2',
'Name': 'string',
'OutboundHostName': 'string',
'RequireEncryption': True|False,
'CreatedTimestamp': datetime(2015, 1, 1),
'UpdatedTimestamp': datetime(2015, 1, 1),
'VoiceConnectorArn': 'string'
},
],
'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.
AwsRegion (string) --
The AWS Region in which the Amazon Chime Voice Connector is created. Default: us-east-1 .
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.
VoiceConnectorArn (string) --
The ARN of the specified Amazon Chime Voice Connector.
NextToken (string) --
The token to use to retrieve the next page of results.
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionlogout_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'
)
[REQUIRED]
The Amazon Chime account ID.
[REQUIRED]
The user ID.
dict
Response Syntax
{}
Response Structure
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionput_app_instance_retention_settings(**kwargs)¶Sets the amount of time in days that a given AppInstance retains data.
See also: AWS API Documentation
Request Syntax
response = client.put_app_instance_retention_settings(
AppInstanceArn='string',
AppInstanceRetentionSettings={
'ChannelRetentionSettings': {
'RetentionDays': 123
}
}
)
[REQUIRED]
The ARN of the AppInstance .
[REQUIRED]
The time in days to retain data. Data type: number.
The length of time in days to retain the messages in a channel.
The time in days to retain the messages in a channel.
dict
Response Syntax
{
'AppInstanceRetentionSettings': {
'ChannelRetentionSettings': {
'RetentionDays': 123
}
},
'InitiateDeletionTimestamp': datetime(2015, 1, 1)
}
Response Structure
(dict) --
AppInstanceRetentionSettings (dict) --
The time in days to retain data. Data type: number.
ChannelRetentionSettings (dict) --
The length of time in days to retain the messages in a channel.
RetentionDays (integer) --
The time in days to retain the messages in a channel.
InitiateDeletionTimestamp (datetime) --
The time at which the API deletes data.
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.ConflictExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionput_app_instance_streaming_configurations(**kwargs)¶The data streaming configurations of an AppInstance .
See also: AWS API Documentation
Request Syntax
response = client.put_app_instance_streaming_configurations(
AppInstanceArn='string',
AppInstanceStreamingConfigurations=[
{
'AppInstanceDataType': 'Channel'|'ChannelMessage',
'ResourceArn': 'string'
},
]
)
[REQUIRED]
The ARN of the AppInstance .
[REQUIRED]
The streaming configurations set for an AppInstance .
The details of the streaming configuration of an AppInstance .
The type of data to be streamed.
The resource ARN.
dict
Response Syntax
{
'AppInstanceStreamingConfigurations': [
{
'AppInstanceDataType': 'Channel'|'ChannelMessage',
'ResourceArn': 'string'
},
]
}
Response Structure
(dict) --
AppInstanceStreamingConfigurations (list) --
The streaming configurations of an AppInstance .
(dict) --
The details of the streaming configuration of an AppInstance .
AppInstanceDataType (string) --
The type of data to be streamed.
ResourceArn (string) --
The resource ARN.
Exceptions
Chime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionput_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'
)
[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.
Exceptions
Chime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ResourceLimitExceededExceptionChime.Client.exceptions.NotFoundExceptionput_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
}
}
)
[REQUIRED]
The Amazon Chime account ID.
[REQUIRED]
The retention settings.
The chat room retention settings.
The number of days for which to retain chat-room messages.
The chat conversation retention settings.
The number of days for which to retain conversation messages.
dict
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.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.ConflictExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionput_sip_media_application_logging_configuration(**kwargs)¶Updates the logging configuration for the specified SIP media application.
See also: AWS API Documentation
Request Syntax
response = client.put_sip_media_application_logging_configuration(
SipMediaApplicationId='string',
SipMediaApplicationLoggingConfiguration={
'EnableSipMediaApplicationMessageLogs': True|False
}
)
[REQUIRED]
The SIP media application ID.
The actual logging configuration.
Enables application message logs for the SIP media application.
dict
Response Syntax
{
'SipMediaApplicationLoggingConfiguration': {
'EnableSipMediaApplicationMessageLogs': True|False
}
}
Response Structure
(dict) --
SipMediaApplicationLoggingConfiguration (dict) --
Logging configuration of the SIP media application.
EnableSipMediaApplicationMessageLogs (boolean) --
Enables application message logs for the SIP media application.
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionput_voice_connector_emergency_calling_configuration(**kwargs)¶Puts emergency calling configuration details to the specified Amazon Chime Voice Connector, such as emergency phone numbers and calling countries. Origination and termination settings must be enabled for the Amazon Chime Voice Connector before emergency calling can be configured.
See also: AWS API Documentation
Request Syntax
response = client.put_voice_connector_emergency_calling_configuration(
VoiceConnectorId='string',
EmergencyCallingConfiguration={
'DNIS': [
{
'EmergencyPhoneNumber': 'string',
'TestPhoneNumber': 'string',
'CallingCountry': 'string'
},
]
}
)
[REQUIRED]
The Amazon Chime Voice Connector ID.
[REQUIRED]
The emergency calling configuration details.
The Dialed Number Identification Service (DNIS) emergency calling configuration details.
The Dialed Number Identification Service (DNIS) emergency calling configuration details associated with an Amazon Chime Voice Connector's emergency calling configuration.
The DNIS phone number to route emergency calls to, in E.164 format.
The DNIS phone number to route test emergency calls to, in E.164 format.
The country from which emergency calls are allowed, in ISO 3166-1 alpha-2 format.
dict
Response Syntax
{
'EmergencyCallingConfiguration': {
'DNIS': [
{
'EmergencyPhoneNumber': 'string',
'TestPhoneNumber': 'string',
'CallingCountry': 'string'
},
]
}
}
Response Structure
(dict) --
EmergencyCallingConfiguration (dict) --
The emergency calling configuration details.
DNIS (list) --
The Dialed Number Identification Service (DNIS) emergency calling configuration details.
(dict) --
The Dialed Number Identification Service (DNIS) emergency calling configuration details associated with an Amazon Chime Voice Connector's emergency calling configuration.
EmergencyPhoneNumber (string) --
The DNIS phone number to route emergency calls to, in E.164 format.
TestPhoneNumber (string) --
The DNIS phone number to route test emergency calls to, in E.164 format.
CallingCountry (string) --
The country from which emergency calls are allowed, in ISO 3166-1 alpha-2 format.
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionput_voice_connector_logging_configuration(**kwargs)¶Adds a logging configuration for the specified Amazon Chime Voice Connector. The logging configuration specifies whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.
See also: AWS API Documentation
Request Syntax
response = client.put_voice_connector_logging_configuration(
VoiceConnectorId='string',
LoggingConfiguration={
'EnableSIPLogs': True|False,
'EnableMediaMetricLogs': True|False
}
)
[REQUIRED]
The Amazon Chime Voice Connector ID.
[REQUIRED]
The logging configuration details to add.
When true, enables SIP message logs for sending to Amazon CloudWatch Logs.
Boolean that enables the logging of Voice Connector metrics to Cloudwatch.
dict
Response Syntax
{
'LoggingConfiguration': {
'EnableSIPLogs': True|False,
'EnableMediaMetricLogs': True|False
}
}
Response Structure
(dict) --
LoggingConfiguration (dict) --
The updated logging configuration details.
EnableSIPLogs (boolean) --
When true, enables SIP message logs for sending to Amazon CloudWatch Logs.
EnableMediaMetricLogs (boolean) --
Boolean that enables the logging of Voice Connector metrics to Cloudwatch.
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionput_voice_connector_origination(**kwargs)¶Adds origination settings for the specified Amazon Chime Voice Connector.
Note
If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to turning off origination settings.
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. This parameter is not required, but you must specify this parameter or Disabled .
Origination routes define call distribution properties for your SIP hosts to receive inbound calls using your Amazon Chime Voice Connector. Limit: Ten origination routes for each Amazon Chime Voice Connector.
Note
The parameters listed below are not required, but you must use at least one.
The FQDN 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 redistributed among them based on their relative weight.
When origination settings are disabled, inbound calls are not enabled for your Amazon Chime Voice Connector. This parameter is not required, but you must specify this parameter or Routes .
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. This parameter is not required, but you must specify this parameter or Disabled .
(dict) --
Origination routes define call distribution properties for your SIP hosts to receive inbound calls using your Amazon Chime Voice Connector. Limit: Ten origination routes for each Amazon Chime Voice Connector.
Note
The parameters listed below are not required, but you must use at least one.
Host (string) --
The FQDN 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 redistributed 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. This parameter is not required, but you must specify this parameter or Routes .
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionput_voice_connector_proxy(**kwargs)¶Puts the specified proxy configuration to the specified Amazon Chime Voice Connector.
See also: AWS API Documentation
Request Syntax
response = client.put_voice_connector_proxy(
VoiceConnectorId='string',
DefaultSessionExpiryMinutes=123,
PhoneNumberPoolCountries=[
'string',
],
FallBackPhoneNumber='string',
Disabled=True|False
)
[REQUIRED]
The Amazon Chime voice connector ID.
[REQUIRED]
The default number of minutes allowed for proxy sessions.
[REQUIRED]
The countries for proxy phone numbers to be selected from.
dict
Response Syntax
{
'Proxy': {
'DefaultSessionExpiryMinutes': 123,
'Disabled': True|False,
'FallBackPhoneNumber': 'string',
'PhoneNumberCountries': [
'string',
]
}
}
Response Structure
(dict) --
Proxy (dict) --
The proxy configuration details.
DefaultSessionExpiryMinutes (integer) --
The default number of minutes allowed for proxy sessions.
Disabled (boolean) --
When true, stops proxy sessions from being created on the specified Amazon Chime Voice Connector.
FallBackPhoneNumber (string) --
The phone number to route calls to after a proxy session expires.
PhoneNumberCountries (list) --
The countries for proxy phone numbers to be selected from.
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.AccessDeniedExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionput_voice_connector_streaming_configuration(**kwargs)¶Adds a streaming configuration for the specified Amazon Chime Voice Connector. The streaming configuration specifies whether media streaming is enabled for sending to Kinesis. It also sets the retention period, in hours, for the Amazon Kinesis data.
See also: AWS API Documentation
Request Syntax
response = client.put_voice_connector_streaming_configuration(
VoiceConnectorId='string',
StreamingConfiguration={
'DataRetentionInHours': 123,
'Disabled': True|False,
'StreamingNotificationTargets': [
{
'NotificationTarget': 'EventBridge'|'SNS'|'SQS'
},
]
}
)
[REQUIRED]
The Amazon Chime Voice Connector ID.
[REQUIRED]
The streaming configuration details to add.
The retention period, in hours, for the Amazon Kinesis data.
When true, media streaming to Amazon Kinesis is turned off.
The streaming notification targets.
The targeted recipient for a streaming configuration notification.
The streaming notification target.
dict
Response Syntax
{
'StreamingConfiguration': {
'DataRetentionInHours': 123,
'Disabled': True|False,
'StreamingNotificationTargets': [
{
'NotificationTarget': 'EventBridge'|'SNS'|'SQS'
},
]
}
}
Response Structure
(dict) --
StreamingConfiguration (dict) --
The updated streaming configuration details.
DataRetentionInHours (integer) --
The retention period, in hours, for the Amazon Kinesis data.
Disabled (boolean) --
When true, media streaming to Amazon Kinesis is turned off.
StreamingNotificationTargets (list) --
The streaming notification targets.
(dict) --
The targeted recipient for a streaming configuration notification.
NotificationTarget (string) --
The streaming notification target.
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionput_voice_connector_termination(**kwargs)¶Adds termination settings for the specified Amazon Chime Voice Connector.
Note
If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to turning off termination settings.
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 quota. Default value of 1.
The default caller ID phone number.
The countries to which calls are allowed, in ISO 3166-1 alpha-2 format. Required.
The IP addresses allowed to make calls, in CIDR format. Required.
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 quota. Default value of 1.
DefaultPhoneNumber (string) --
The default caller ID phone number.
CallingRegions (list) --
The countries to which calls are allowed, in ISO 3166-1 alpha-2 format. Required.
CidrAllowedList (list) --
The IP addresses allowed to make calls, in CIDR format. Required.
Disabled (boolean) --
When termination settings are disabled, outbound calls can not be made.
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.AccessDeniedExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionput_voice_connector_termination_credentials(**kwargs)¶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
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionredact_channel_message(**kwargs)¶Redacts message content, but not metadata. The message exists in the back end, but the action returns null content, and the state shows as redacted.
Note
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
See also: AWS API Documentation
Request Syntax
response = client.redact_channel_message(
ChannelArn='string',
MessageId='string',
ChimeBearer='string'
)
[REQUIRED]
The ARN of the channel containing the messages that you want to redact.
[REQUIRED]
The ID of the message being redacted.
AppInstanceUserArn of the user that makes the API call.dict
Response Syntax
{
'ChannelArn': 'string',
'MessageId': 'string'
}
Response Structure
(dict) --
ChannelArn (string) --
The ARN of the channel containing the messages that you want to redact.
MessageId (string) --
The ID of the message being redacted.
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionredact_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'
)
[REQUIRED]
The Amazon Chime account ID.
[REQUIRED]
The conversation ID.
[REQUIRED]
The message ID.
dict
Response Syntax
{}
Response Structure
Exceptions
Chime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionredact_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'
)
[REQUIRED]
The Amazon Chime account ID.
[REQUIRED]
The room ID.
[REQUIRED]
The message ID.
dict
Response Syntax
{}
Response Structure
Exceptions
Chime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionregenerate_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'
)
[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.
Exceptions
Chime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ThrottledClientExceptionreset_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'
)
[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',
'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.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionrestore_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'
)
[REQUIRED]
The phone number.
{
'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
The phone number details.
The phone number ID.
The phone number, in E.164 format.
The phone number country. Format: ISO 3166-1 alpha-2.
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, Amazon Chime Voice Connector ID, or Amazon Chime Voice Connector group ID.
Contains the ID for the entity specified in Name.
Defines the association with an Amazon Chime account ID, user ID, Amazon Chime Voice Connector ID, or Amazon Chime Voice Connector group ID.
The timestamp of the phone number association, in ISO 8601 format.
The outbound calling name associated with the phone number.
The outbound calling name status.
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.
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ResourceLimitExceededExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionsearch_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'
)
City . Only applies to the US.dict
Response Syntax
{
'E164PhoneNumbers': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) --
E164PhoneNumbers (list) --
List of phone numbers, in E.164 format.
NextToken (string) --
The token used to retrieve the next page of search results.
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.AccessDeniedExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionsend_channel_message(**kwargs)¶Sends a message to a particular channel that the member is a part of.
Note
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
Also, STANDARD messages can contain 4KB of data and the 1KB of metadata. CONTROL messages can contain 30 bytes of data and no metadata.
See also: AWS API Documentation
Request Syntax
response = client.send_channel_message(
ChannelArn='string',
Content='string',
Type='STANDARD'|'CONTROL',
Persistence='PERSISTENT'|'NON_PERSISTENT',
Metadata='string',
ClientRequestToken='string',
ChimeBearer='string'
)
[REQUIRED]
The ARN of the channel.
[REQUIRED]
The content of the message.
[REQUIRED]
The type of message, STANDARD or CONTROL .
[REQUIRED]
Boolean that controls whether the message is persisted on the back end. Required.
[REQUIRED]
The Idempotency token for each client request.
This field is autopopulated if not provided.
AppInstanceUserArn of the user that makes the API call.dict
Response Syntax
{
'ChannelArn': 'string',
'MessageId': 'string'
}
Response Structure
(dict) --
ChannelArn (string) --
The ARN of the channel.
MessageId (string) --
The ID string assigned to each message.
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ConflictExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionstart_meeting_transcription(**kwargs)¶Starts transcription for the specified meetingId .
See also: AWS API Documentation
Request Syntax
response = client.start_meeting_transcription(
MeetingId='string',
TranscriptionConfiguration={
'EngineTranscribeSettings': {
'LanguageCode': 'en-US'|'en-GB'|'es-US'|'fr-CA'|'fr-FR'|'en-AU'|'it-IT'|'de-DE'|'pt-BR'|'ja-JP'|'ko-KR'|'zh-CN',
'VocabularyFilterMethod': 'remove'|'mask'|'tag',
'VocabularyFilterName': 'string',
'VocabularyName': 'string',
'Region': 'us-east-2'|'us-east-1'|'us-west-2'|'ap-northeast-2'|'ap-southeast-2'|'ap-northeast-1'|'ca-central-1'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'sa-east-1'|'auto',
'EnablePartialResultsStabilization': True|False,
'PartialResultsStability': 'low'|'medium'|'high',
'ContentIdentificationType': 'PII',
'ContentRedactionType': 'PII',
'PiiEntityTypes': 'string',
'LanguageModelName': 'string'
},
'EngineTranscribeMedicalSettings': {
'LanguageCode': 'en-US',
'Specialty': 'PRIMARYCARE'|'CARDIOLOGY'|'NEUROLOGY'|'ONCOLOGY'|'RADIOLOGY'|'UROLOGY',
'Type': 'CONVERSATION'|'DICTATION',
'VocabularyName': 'string',
'Region': 'us-east-1'|'us-east-2'|'us-west-2'|'ap-southeast-2'|'ca-central-1'|'eu-west-1'|'auto',
'ContentIdentificationType': 'PHI'
}
}
)
[REQUIRED]
The unique ID of the meeting being transcribed.
[REQUIRED]
The configuration for the current transcription operation. Must contain EngineTranscribeSettings or EngineTranscribeMedicalSettings .
The transcription configuration settings passed to Amazon Transcribe.
The language code specified for the Amazon Transcribe engine.
The filtering method passed to Amazon Transcribe.
The name of the vocabulary filter passed to Amazon Transcribe.
The name of the vocabulary passed to Amazon Transcribe.
The AWS Region passed to Amazon Transcribe. If you don't specify a Region, Amazon Chime uses the meeting's Region.
Generates partial transcription results that are less likely to change as meeting attendees speak. It does so by only allowing the last few words from the partial results to change.
The stabity level of a partial results transcription. Determines how stable you want the transcription results to be. A higher level means the transcription results are less likely to change.
Set this field to PII to identify personally identifiable information in the transcription output.
Set this field to PII to redact personally identifiable information in the transcription output. Content redaction is performed only upon complete transcription of the audio segments.
Lists the PII entity types you want to identify or redact. To specify entity types, you must enable ContentIdentificationType or ContentRedactionType .
PIIEntityTypesmust be comma-separated. The available values are:BANK_ACCOUNT_NUMBER,BANK_ROUTING, CREDIT_DEBIT_NUMBER,CREDIT_DEBIT_CVV,CREDIT_DEBIT_EXPIRY,PIN,ADDRESS,NAME,PHONE,SSN, andALL.
PiiEntityTypesis an optional parameter with a default value ofALL.
The name of the language model used during transcription.
The transcription configuration settings passed to Amazon Transcribe Medical.
The language code specified for the Amazon Transcribe Medical engine.
The specialty specified for the Amazon Transcribe Medical engine.
The type of transcription.
The name of the vocabulary passed to Amazon Transcribe Medical.
The AWS Region passed to Amazon Transcribe Medical. If you don't specify a Region, Amazon Chime uses the meeting's Region.
Set this field to PHI to identify personal health information in the transcription output.
dict
Response Syntax
{}
Response Structure
Exceptions
Chime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ResourceLimitExceededExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.UnprocessableEntityExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionstop_meeting_transcription(**kwargs)¶Stops transcription for the specified meetingId .
See also: AWS API Documentation
Request Syntax
response = client.stop_meeting_transcription(
MeetingId='string'
)
[REQUIRED]
The unique ID of the meeting for which you stop transcription.
{}
Response Structure
Exceptions
Chime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.UnprocessableEntityExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptiontag_attendee(**kwargs)¶Applies the specified tags to the specified Amazon Chime SDK attendee.
See also: AWS API Documentation
Request Syntax
response = client.tag_attendee(
MeetingId='string',
AttendeeId='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The Amazon Chime SDK meeting ID.
[REQUIRED]
The Amazon Chime SDK attendee ID.
[REQUIRED]
The tag key-value pairs.
Describes a tag applied to a resource.
The key of the tag.
The value of the tag.
None
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ResourceLimitExceededExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptiontag_meeting(**kwargs)¶Applies the specified tags to the specified Amazon Chime SDK meeting.
See also: AWS API Documentation
Request Syntax
response = client.tag_meeting(
MeetingId='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The Amazon Chime SDK meeting ID.
[REQUIRED]
The tag key-value pairs.
Describes a tag applied to a resource.
The key of the tag.
The value of the tag.
None
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ResourceLimitExceededExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptiontag_resource(**kwargs)¶Applies the specified tags to the specified Amazon Chime SDK meeting resource.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
ResourceARN='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The resource ARN.
[REQUIRED]
The tag key-value pairs.
Describes a tag applied to a resource.
The key of the tag.
The value of the tag.
None
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionuntag_attendee(**kwargs)¶Untags the specified tags from the specified Amazon Chime SDK attendee.
See also: AWS API Documentation
Request Syntax
response = client.untag_attendee(
MeetingId='string',
AttendeeId='string',
TagKeys=[
'string',
]
)
[REQUIRED]
The Amazon Chime SDK meeting ID.
[REQUIRED]
The Amazon Chime SDK attendee ID.
[REQUIRED]
The tag keys.
None
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionuntag_meeting(**kwargs)¶Untags the specified tags from the specified Amazon Chime SDK meeting.
See also: AWS API Documentation
Request Syntax
response = client.untag_meeting(
MeetingId='string',
TagKeys=[
'string',
]
)
[REQUIRED]
The Amazon Chime SDK meeting ID.
[REQUIRED]
The tag keys.
None
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionuntag_resource(**kwargs)¶Untags the specified tags from the specified Amazon Chime SDK meeting resource.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
ResourceARN='string',
TagKeys=[
'string',
]
)
[REQUIRED]
The resource ARN.
[REQUIRED]
The tag keys.
None
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionupdate_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'
)
[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',
],
'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.
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.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionupdate_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
}
)
[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
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.ConflictExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionupdate_app_instance(**kwargs)¶Updates AppInstance metadata.
See also: AWS API Documentation
Request Syntax
response = client.update_app_instance(
AppInstanceArn='string',
Name='string',
Metadata='string'
)
[REQUIRED]
The ARN of the AppInstance .
[REQUIRED]
The name that you want to change.
dict
Response Syntax
{
'AppInstanceArn': 'string'
}
Response Structure
(dict) --
AppInstanceArn (string) --
The ARN of the AppInstance .
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ConflictExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionupdate_app_instance_user(**kwargs)¶Updates the details of an AppInstanceUser . You can update names and metadata.
See also: AWS API Documentation
Request Syntax
response = client.update_app_instance_user(
AppInstanceUserArn='string',
Name='string',
Metadata='string'
)
[REQUIRED]
The ARN of the AppInstanceUser .
[REQUIRED]
The name of the AppInstanceUser .
AppInstanceUser .dict
Response Syntax
{
'AppInstanceUserArn': 'string'
}
Response Structure
(dict) --
AppInstanceUserArn (string) --
The ARN of the AppInstanceUser .
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ConflictExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionupdate_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
)
[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.
Exceptions
Chime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ThrottledClientExceptionupdate_channel(**kwargs)¶Update a channel's attributes.
Restriction : You can't change a channel's privacy.
Note
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
See also: AWS API Documentation
Request Syntax
response = client.update_channel(
ChannelArn='string',
Name='string',
Mode='UNRESTRICTED'|'RESTRICTED',
Metadata='string',
ChimeBearer='string'
)
[REQUIRED]
The ARN of the channel.
[REQUIRED]
The name of the channel.
[REQUIRED]
The mode of the update request.
AppInstanceUserArn of the user that makes the API call.dict
Response Syntax
{
'ChannelArn': 'string'
}
Response Structure
(dict) --
ChannelArn (string) --
The ARN of the channel.
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.ConflictExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionupdate_channel_message(**kwargs)¶Updates the content of a message.
Note
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
See also: AWS API Documentation
Request Syntax
response = client.update_channel_message(
ChannelArn='string',
MessageId='string',
Content='string',
Metadata='string',
ChimeBearer='string'
)
[REQUIRED]
The ARN of the channel.
[REQUIRED]
The ID string of the message being updated.
AppInstanceUserArn of the user that makes the API call.dict
Response Syntax
{
'ChannelArn': 'string',
'MessageId': 'string'
}
Response Structure
(dict) --
ChannelArn (string) --
The ARN of the channel.
MessageId (string) --
The ID string of the message being updated.
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ConflictExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionupdate_channel_read_marker(**kwargs)¶The details of the time when a user last read messages in a channel.
Note
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
See also: AWS API Documentation
Request Syntax
response = client.update_channel_read_marker(
ChannelArn='string',
ChimeBearer='string'
)
[REQUIRED]
The ARN of the channel.
AppInstanceUserArn of the user that makes the API call.dict
Response Syntax
{
'ChannelArn': 'string'
}
Response Structure
(dict) --
ChannelArn (string) --
The ARN of the channel.
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.ConflictExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionupdate_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'
}
)
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.
None
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionupdate_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'
)
[REQUIRED]
The phone number ID.
dict
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.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ConflictExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionupdate_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'
)
[REQUIRED]
The default outbound calling name for the account.
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionupdate_proxy_session(**kwargs)¶Updates the specified proxy session details, such as voice or SMS capabilities.
See also: AWS API Documentation
Request Syntax
response = client.update_proxy_session(
VoiceConnectorId='string',
ProxySessionId='string',
Capabilities=[
'Voice'|'SMS',
],
ExpiryMinutes=123
)
[REQUIRED]
The Amazon Chime voice connector ID.
[REQUIRED]
The proxy session ID.
[REQUIRED]
The proxy session capabilities.
dict
Response Syntax
{
'ProxySession': {
'VoiceConnectorId': 'string',
'ProxySessionId': 'string',
'Name': 'string',
'Status': 'Open'|'InProgress'|'Closed',
'ExpiryMinutes': 123,
'Capabilities': [
'Voice'|'SMS',
],
'CreatedTimestamp': datetime(2015, 1, 1),
'UpdatedTimestamp': datetime(2015, 1, 1),
'EndedTimestamp': datetime(2015, 1, 1),
'Participants': [
{
'PhoneNumber': 'string',
'ProxyPhoneNumber': 'string'
},
],
'NumberSelectionBehavior': 'PreferSticky'|'AvoidSticky',
'GeoMatchLevel': 'Country'|'AreaCode',
'GeoMatchParams': {
'Country': 'string',
'AreaCode': 'string'
}
}
}
Response Structure
(dict) --
ProxySession (dict) --
The proxy session details.
VoiceConnectorId (string) --
The Amazon Chime voice connector ID.
ProxySessionId (string) --
The proxy session ID.
Name (string) --
The name of the proxy session.
Status (string) --
The status of the proxy session.
ExpiryMinutes (integer) --
The number of minutes allowed for the proxy session.
Capabilities (list) --
The proxy session capabilities.
CreatedTimestamp (datetime) --
The created time stamp, in ISO 8601 format.
UpdatedTimestamp (datetime) --
The updated time stamp, in ISO 8601 format.
EndedTimestamp (datetime) --
The ended time stamp, in ISO 8601 format.
Participants (list) --
The proxy session participants.
(dict) --
The phone number and proxy phone number for a participant in an Amazon Chime Voice Connector proxy session.
PhoneNumber (string) --
The participant's phone number.
ProxyPhoneNumber (string) --
The participant's proxy phone number.
NumberSelectionBehavior (string) --
The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.
GeoMatchLevel (string) --
The preference for matching the country or area code of the proxy phone number with that of the first participant.
GeoMatchParams (dict) --
The country and area code for the proxy phone number.
Country (string) --
The country.
AreaCode (string) --
The area code.
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionupdate_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'
)
[REQUIRED]
The Amazon Chime account ID.
[REQUIRED]
The room ID.
dict
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.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionupdate_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'
)
[REQUIRED]
The Amazon Chime account ID.
[REQUIRED]
The room ID.
[REQUIRED]
The member ID.
dict
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.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionupdate_sip_media_application(**kwargs)¶Updates the details of the specified SIP media application.
See also: AWS API Documentation
Request Syntax
response = client.update_sip_media_application(
SipMediaApplicationId='string',
Name='string',
Endpoints=[
{
'LambdaArn': 'string'
},
]
)
[REQUIRED]
The SIP media application ID.
The new set of endpoints for the specified SIP media application.
The endpoint assigned to the SIP media application.
Valid Amazon Resource Name (ARN) of the Lambda function. The function must be created in the same AWS Region as the SIP media application.
dict
Response Syntax
{
'SipMediaApplication': {
'SipMediaApplicationId': 'string',
'AwsRegion': 'string',
'Name': 'string',
'Endpoints': [
{
'LambdaArn': 'string'
},
],
'CreatedTimestamp': datetime(2015, 1, 1),
'UpdatedTimestamp': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
SipMediaApplication (dict) --
The updated SIP media application details.
SipMediaApplicationId (string) --
The SIP media application ID.
AwsRegion (string) --
The AWS Region in which the SIP media application is created.
Name (string) --
The name of the SIP media application.
Endpoints (list) --
List of endpoints for SIP media application. Currently, only one endpoint per SIP media application is permitted.
(dict) --
The endpoint assigned to the SIP media application.
LambdaArn (string) --
Valid Amazon Resource Name (ARN) of the Lambda function. The function must be created in the same AWS Region as the SIP media application.
CreatedTimestamp (datetime) --
The SIP media application creation timestamp, in ISO 8601 format.
UpdatedTimestamp (datetime) --
The SIP media application updated timestamp, in ISO 8601 format.
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ConflictExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionupdate_sip_media_application_call(**kwargs)¶Invokes the AWS Lambda function associated with the SIP media application and transaction ID in an update request. The Lambda function can then return a new set of actions.
See also: AWS API Documentation
Request Syntax
response = client.update_sip_media_application_call(
SipMediaApplicationId='string',
TransactionId='string',
Arguments={
'string': 'string'
}
)
[REQUIRED]
The ID of the SIP media application handling the call.
[REQUIRED]
The ID of the call transaction.
[REQUIRED]
Arguments made available to the Lambda function as part of the CALL_UPDATE_REQUESTED event. Can contain 0-20 key-value pairs.
dict
Response Syntax
{
'SipMediaApplicationCall': {
'TransactionId': 'string'
}
}
Response Structure
(dict) --
SipMediaApplicationCall (dict) --
A Call instance for a SIP media application.
TransactionId (string) --
The transaction ID of a call.
Exceptions
Chime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.ResourceLimitExceededExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionupdate_sip_rule(**kwargs)¶Updates the details of the specified SIP rule.
See also: AWS API Documentation
Request Syntax
response = client.update_sip_rule(
SipRuleId='string',
Name='string',
Disabled=True|False,
TargetApplications=[
{
'SipMediaApplicationId': 'string',
'Priority': 123,
'AwsRegion': 'string'
},
]
)
[REQUIRED]
The SIP rule ID.
[REQUIRED]
The new name for the specified SIP rule.
The new value of the list of target applications.
Target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.
The SIP media application ID.
Priority of the SIP media application in the target list.
The AWS Region of the target application.
dict
Response Syntax
{
'SipRule': {
'SipRuleId': 'string',
'Name': 'string',
'Disabled': True|False,
'TriggerType': 'ToPhoneNumber'|'RequestUriHostname',
'TriggerValue': 'string',
'TargetApplications': [
{
'SipMediaApplicationId': 'string',
'Priority': 123,
'AwsRegion': 'string'
},
],
'CreatedTimestamp': datetime(2015, 1, 1),
'UpdatedTimestamp': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
SipRule (dict) --
Updated SIP rule details.
SipRuleId (string) --
The SIP rule ID.
Name (string) --
The name of the SIP rule.
Disabled (boolean) --
Indicates whether the SIP rule is enabled or disabled. You must disable a rule before you can delete it.
TriggerType (string) --
The type of trigger assigned to the SIP rule in TriggerValue , currently RequestUriHostname or ToPhoneNumber .
TriggerValue (string) --
If TriggerType is RequestUriHostname , then the value can be the outbound host name of the Amazon Chime Voice Connector. If TriggerType is ToPhoneNumber , then the value can be a customer-owned phone number in E164 format. SipRule is triggered when a SIP rule requests host name or ToPhoneNumber matches in the incoming SIP request.
TargetApplications (list) --
Target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.
(dict) --
Target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.
SipMediaApplicationId (string) --
The SIP media application ID.
Priority (integer) --
Priority of the SIP media application in the target list.
AwsRegion (string) --
The AWS Region of the target application.
CreatedTimestamp (datetime) --
The time at which the SIP rule was created, in ISO 8601 format.
UpdatedTimestamp (datetime) --
The time at which the SIP rule was last updated, in ISO 8601 format.
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ConflictExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ResourceLimitExceededExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionupdate_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'
}
)
[REQUIRED]
The Amazon Chime account ID.
[REQUIRED]
The user ID.
The Alexa for Business metadata.
Starts or stops Alexa for Business.
The ARN of the room resource.
dict
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.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionupdate_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
}
}
)
[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
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionupdate_voice_connector(**kwargs)¶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',
'AwsRegion': 'us-east-1'|'us-west-2',
'Name': 'string',
'OutboundHostName': 'string',
'RequireEncryption': True|False,
'CreatedTimestamp': datetime(2015, 1, 1),
'UpdatedTimestamp': datetime(2015, 1, 1),
'VoiceConnectorArn': 'string'
}
}
Response Structure
(dict) --
VoiceConnector (dict) --
The updated Amazon Chime Voice Connector details.
VoiceConnectorId (string) --
The Amazon Chime Voice Connector ID.
AwsRegion (string) --
The AWS Region in which the Amazon Chime Voice Connector is created. Default: us-east-1 .
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.
VoiceConnectorArn (string) --
The ARN of the specified Amazon Chime Voice Connector.
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionupdate_voice_connector_group(**kwargs)¶Updates details of the specified Amazon Chime Voice Connector group, such as the name and Amazon Chime Voice Connector priority ranking.
See also: AWS API Documentation
Request Syntax
response = client.update_voice_connector_group(
VoiceConnectorGroupId='string',
Name='string',
VoiceConnectorItems=[
{
'VoiceConnectorId': 'string',
'Priority': 123
},
]
)
[REQUIRED]
The Amazon Chime Voice Connector group ID.
[REQUIRED]
The name of the Amazon Chime Voice Connector group.
[REQUIRED]
The VoiceConnectorItems to associate with the group.
For Amazon Chime Voice Connector groups, the Amazon Chime Voice Connectors to which to route inbound calls. Includes priority configuration settings. Limit: 3 VoiceConnectorItems per Amazon Chime Voice Connector group.
The Amazon Chime Voice Connector ID.
The priority associated with the Amazon Chime Voice Connector, with 1 being the highest priority. Higher priority Amazon Chime Voice Connectors are attempted first.
dict
Response Syntax
{
'VoiceConnectorGroup': {
'VoiceConnectorGroupId': 'string',
'Name': 'string',
'VoiceConnectorItems': [
{
'VoiceConnectorId': 'string',
'Priority': 123
},
],
'CreatedTimestamp': datetime(2015, 1, 1),
'UpdatedTimestamp': datetime(2015, 1, 1),
'VoiceConnectorGroupArn': 'string'
}
}
Response Structure
(dict) --
VoiceConnectorGroup (dict) --
The updated Amazon Chime Voice Connector group details.
VoiceConnectorGroupId (string) --
The Amazon Chime Voice Connector group ID.
Name (string) --
The name of the Amazon Chime Voice Connector group.
VoiceConnectorItems (list) --
The Amazon Chime Voice Connectors to which to route inbound calls.
(dict) --
For Amazon Chime Voice Connector groups, the Amazon Chime Voice Connectors to which to route inbound calls. Includes priority configuration settings. Limit: 3 VoiceConnectorItems per Amazon Chime Voice Connector group.
VoiceConnectorId (string) --
The Amazon Chime Voice Connector ID.
Priority (integer) --
The priority associated with the Amazon Chime Voice Connector, with 1 being the highest priority. Higher priority Amazon Chime Voice Connectors are attempted first.
CreatedTimestamp (datetime) --
The Amazon Chime Voice Connector group creation time stamp, in ISO 8601 format.
UpdatedTimestamp (datetime) --
The updated Amazon Chime Voice Connector group time stamp, in ISO 8601 format.
VoiceConnectorGroupArn (string) --
The ARN of the specified Amazon Chime Voice Connector group.
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ConflictExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionvalidate_e911_address(**kwargs)¶Validates an address to be used for 911 calls made with Amazon Chime Voice Connectors. You can use validated addresses in a Presence Information Data Format Location Object file that you include in SIP requests. That helps ensure that addresses are routed to the appropriate Public Safety Answering Point.
See also: AWS API Documentation
Request Syntax
response = client.validate_e911_address(
AwsAccountId='string',
StreetNumber='string',
StreetInfo='string',
City='string',
State='string',
Country='string',
PostalCode='string'
)
[REQUIRED]
The AWS account ID.
[REQUIRED]
The address street number, such as 200 or 2121 .
[REQUIRED]
The address street information, such as 8th Avenue .
[REQUIRED]
The address city, such as Portland .
[REQUIRED]
The address state, such as ME .
[REQUIRED]
The address country, such as US .
[REQUIRED]
The address postal code, such as 04352 .
dict
Response Syntax
{
'ValidationResult': 123,
'AddressExternalId': 'string',
'Address': {
'streetName': 'string',
'streetSuffix': 'string',
'postDirectional': 'string',
'preDirectional': 'string',
'streetNumber': 'string',
'city': 'string',
'state': 'string',
'postalCode': 'string',
'postalCodePlus4': 'string',
'country': 'string'
},
'CandidateAddressList': [
{
'streetInfo': 'string',
'streetNumber': 'string',
'city': 'string',
'state': 'string',
'postalCode': 'string',
'postalCodePlus4': 'string',
'country': 'string'
},
]
}
Response Structure
(dict) --
ValidationResult (integer) --
Number indicating the result of address validation. 0 means the address was perfect as is and successfully validated. 1 means the address was corrected. 2 means the address sent was not close enough and was not validated.
AddressExternalId (string) --
The ID that represents the address.
Address (dict) --
The validated address.
streetName (string) --
The address street, such as 8th Avenue .
streetSuffix (string) --
The address suffix, such as the N in 8th Avenue N .
postDirectional (string) --
An address suffix location, such as the S. Unit A in Central Park S. Unit A .
preDirectional (string) --
An address prefix location, such as the N in N. Third St. .
streetNumber (string) --
The numeric portion of an address.
city (string) --
The city of an address.
state (string) --
The state of an address.
postalCode (string) --
The postal code of an address.
postalCodePlus4 (string) --
The Zip + 4 or postal code + 4 of an address.
country (string) --
The country of an address.
CandidateAddressList (list) --
The list of address suggestions.
(dict) --
A suggested address.
streetInfo (string) --
The street information of a candidate address
streetNumber (string) --
The numeric portion of a candidate address.
city (string) --
The city of a candidate address.
state (string) --
The state of a candidate address.
postalCode (string) --
The postal code of a candidate address.
postalCodePlus4 (string) --
The Zip + 4 or postal code + 4 of a candidate address.
country (string) --
The country of a candidate address.
Exceptions
Chime.Client.exceptions.UnauthorizedClientExceptionChime.Client.exceptions.NotFoundExceptionChime.Client.exceptions.ForbiddenExceptionChime.Client.exceptions.BadRequestExceptionChime.Client.exceptions.ThrottledClientExceptionChime.Client.exceptions.ServiceUnavailableExceptionChime.Client.exceptions.ServiceFailureExceptionThe available paginators are:
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'
}
)
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',
],
'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.
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.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'
}
)
[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',
'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.