Chime#
Client#
- class Chime.Client#
A low-level client representing Amazon Chime
Warning
Most of these APIs are no longer supported and will not be updated. We recommend using the latest versions in the Amazon Chime SDK API reference, in the Amazon Chime SDK.
Using the latest versions requires migrating to dedicated namespaces. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
The Amazon Chime application programming interface (API) is designed so administrators can perform key tasks, such as creating and managing Amazon Chime accounts, users, and Voice Connectors. This guide provides detailed information about the Amazon Chime API, including operations, types, inputs and outputs, and error codes.
You can use an AWS SDK, the AWS Command Line Interface (AWS CLI), or the REST API to make API calls for Amazon Chime. We recommend using an AWS SDK or the AWS CLI. The page for each API action contains a See Also section that includes links to information about using the action with a language-specific AWS SDK or the AWS CLI.
Using an AWS SDK
You don’t need to write code to calculate a signature for request authentication. The SDK clients authenticate your requests by using access keys that you provide. For more information about AWS SDKs, see the AWS Developer Center.
Using the AWS CLI
Use your access keys with the AWS CLI to make API calls. For information about setting up the AWS CLI, see Installing the AWS Command Line Interface in the AWS Command Line Interface User Guide. For a list of available Amazon Chime commands, see the Amazon Chime commands in the AWS CLI Command Reference.
Using REST APIs
If you use REST to make API calls, you must authenticate your request by providing a signature. Amazon Chime supports Signature Version 4. For more information, see Signature Version 4 Signing Process in the Amazon Web Services General Reference.
When making REST API calls, use the service name
chimeand REST endpointhttps://service---chime---aws.amazon.com.rproxy.goskope.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
Client Exceptions#
Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.
The available client exceptions are:
Paginators#
Paginators are available on a client instance via the get_paginator method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide.
The available paginators are: