Expand description
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 some server-side API actions to use with the Amazon Chime SDK. 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 API
-
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.
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.
If you’re using the service, you’re probably looking for ChimeClient and Chime.
Structs§
- Account
The Amazon Chime account details. An AWS account can have multiple Amazon Chime accounts.
- Account
Settings Settings related to the Amazon Chime account. This includes settings that start or stop remote control of shared screens, or start or stop the dial-out option in the Amazon Chime web application. For more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide.
- Alexa
ForBusiness Metadata The Alexa for Business metadata associated with an Amazon Chime user, used to integrate Alexa for Business with a device.
- Associate
Phone Number With User Request - Associate
Phone Number With User Response - Associate
Phone Numbers With Voice Connector Group Request - Associate
Phone Numbers With Voice Connector Group Response - Associate
Phone Numbers With Voice Connector Request - Associate
Phone Numbers With Voice Connector Response - Associate
Signin Delegate Groups With Account Request - Associate
Signin Delegate Groups With Account Response - Attendee
An Amazon Chime SDK meeting attendee. Includes a unique
AttendeeIdandJoinToken. TheJoinTokenallows a client to authenticate and join as the specified attendee. TheJoinTokenexpires when the meeting ends or when DeleteAttendee is called. After that, the attendee is unable to join the meeting.We recommend securely transferring each
JoinTokenfrom 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.- Batch
Create Attendee Request - Batch
Create Attendee Response - Batch
Create Room Membership Request - Batch
Create Room Membership Response - Batch
Delete Phone Number Request - Batch
Delete Phone Number Response - Batch
Suspend User Request - Batch
Suspend User Response - Batch
Unsuspend User Request - Batch
Unsuspend User Response - Batch
Update Phone Number Request - Batch
Update Phone Number Response - Batch
Update User Request - Batch
Update User Response - Bot
A resource that allows Enterprise account administrators to configure an interface to receive events from Amazon Chime.
- Business
Calling Settings The Amazon Chime Business Calling settings for the administrator's AWS account. Includes any Amazon S3 buckets designated for storing call detail records.
- Chime
Client - A client for the Amazon Chime API.
- Chime
Create Attendee Error 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.
- Conversation
Retention Settings The retention settings that determine how long to retain chat conversation messages for an Amazon Chime Enterprise account.
- Create
Account Request - Create
Account Response - Create
Attendee Request - Create
Attendee Request Item The Amazon Chime SDK attendee fields to create, used with the BatchCreateAttendee action.
- Create
Attendee Response - Create
BotRequest - Create
BotResponse - Create
Meeting Request - Create
Meeting Response - Create
Meeting With Attendees Request - Create
Meeting With Attendees Response - Create
Phone Number Order Request - Create
Phone Number Order Response - Create
Proxy Session Request - Create
Proxy Session Response - Create
Room Membership Request - Create
Room Membership Response - Create
Room Request - Create
Room Response - Create
User Request - Create
User Response - Create
Voice Connector Group Request - Create
Voice Connector Group Response - Create
Voice Connector Request - Create
Voice Connector Response - Credential
The SIP credentials used to authenticate requests to your Amazon Chime Voice Connector.
- DNIS
Emergency Calling Configuration The Dialed Number Identification Service (DNIS) emergency calling configuration details associated with an Amazon Chime Voice Connector's emergency calling configuration.
- Delete
Account Request - Delete
Account Response - Delete
Attendee Request - Delete
Events Configuration Request - Delete
Meeting Request - Delete
Phone Number Request - Delete
Proxy Session Request - Delete
Room Membership Request - Delete
Room Request - Delete
Voice Connector Emergency Calling Configuration Request - Delete
Voice Connector Group Request - Delete
Voice Connector Origination Request - Delete
Voice Connector Proxy Request - Delete
Voice Connector Request - Delete
Voice Connector Streaming Configuration Request - Delete
Voice Connector Termination Credentials Request - Delete
Voice Connector Termination Request - Disassociate
Phone Number From User Request - Disassociate
Phone Number From User Response - Disassociate
Phone Numbers From Voice Connector Group Request - Disassociate
Phone Numbers From Voice Connector Group Response - Disassociate
Phone Numbers From Voice Connector Request - Disassociate
Phone Numbers From Voice Connector Response - Disassociate
Signin Delegate Groups From Account Request - Disassociate
Signin Delegate Groups From Account Response - Emergency
Calling Configuration The emergency calling configuration details associated with an Amazon Chime Voice Connector.
- Events
Configuration The configuration that allows a bot to receive outgoing events. Can be either an HTTPS endpoint or a Lambda function ARN.
- GeoMatch
Params The country and area code for a proxy phone number in a proxy phone session.
- GetAccount
Request - GetAccount
Response - GetAccount
Settings Request - GetAccount
Settings Response - GetAttendee
Request - GetAttendee
Response - GetBot
Request - GetBot
Response - GetEvents
Configuration Request - GetEvents
Configuration Response - GetGlobal
Settings Response - GetMeeting
Request - GetMeeting
Response - GetPhone
Number Order Request - GetPhone
Number Order Response - GetPhone
Number Request - GetPhone
Number Response - GetPhone
Number Settings Response - GetProxy
Session Request - GetProxy
Session Response - GetRetention
Settings Request - GetRetention
Settings Response - GetRoom
Request - GetRoom
Response - GetUser
Request - GetUser
Response - GetUser
Settings Request - GetUser
Settings Response - GetVoice
Connector Emergency Calling Configuration Request - GetVoice
Connector Emergency Calling Configuration Response - GetVoice
Connector Group Request - GetVoice
Connector Group Response - GetVoice
Connector Logging Configuration Request - GetVoice
Connector Logging Configuration Response - GetVoice
Connector Origination Request - GetVoice
Connector Origination Response - GetVoice
Connector Proxy Request - GetVoice
Connector Proxy Response - GetVoice
Connector Request - GetVoice
Connector Response - GetVoice
Connector Streaming Configuration Request - GetVoice
Connector Streaming Configuration Response - GetVoice
Connector Termination Health Request - GetVoice
Connector Termination Health Response - GetVoice
Connector Termination Request - GetVoice
Connector Termination Response - Invite
Invitation object returned after emailing users to invite them to join the Amazon Chime
Teamaccount.- Invite
Users Request - Invite
Users Response - List
Accounts Request - List
Accounts Response - List
Attendee Tags Request - List
Attendee Tags Response - List
Attendees Request - List
Attendees Response - List
Bots Request - List
Bots Response - List
Meeting Tags Request - List
Meeting Tags Response - List
Meetings Request - List
Meetings Response - List
Phone Number Orders Request - List
Phone Number Orders Response - List
Phone Numbers Request - List
Phone Numbers Response - List
Proxy Sessions Request - List
Proxy Sessions Response - List
Room Memberships Request - List
Room Memberships Response - List
Rooms Request - List
Rooms Response - List
Tags ForResource Request - List
Tags ForResource Response - List
Users Request - List
Users Response - List
Voice Connector Groups Request - List
Voice Connector Groups Response - List
Voice Connector Termination Credentials Request - List
Voice Connector Termination Credentials Response - List
Voice Connectors Request - List
Voice Connectors Response - Logging
Configuration The logging configuration associated with an Amazon Chime Voice Connector. Specifies whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.
- Logout
User Request - Logout
User Response - Media
Placement A set of endpoints used by clients to connect to the media service group for a Amazon Chime SDK meeting.
- Meeting
A meeting created using the Amazon Chime SDK.
- Meeting
Notification Configuration The configuration for resource targets to receive notifications when Amazon Chime SDK meeting and attendee events occur. The Amazon Chime SDK supports resource targets located in the US East (N. Virginia) AWS Region (
us-east-1).- Member
The member details, such as email address, name, member ID, and member type.
- Member
Error The list of errors returned when a member action results in an error.
- Membership
Item Membership details, such as member ID and member role.
- Ordered
Phone Number A phone number for which an order has been placed.
- Origination
Origination settings enable your SIP hosts to receive inbound calls using your Amazon Chime Voice Connector.
- Origination
Route 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.
- Participant
The phone number and proxy phone number for a participant in an Amazon Chime Voice Connector proxy session.
- Phone
Number A phone number used for Amazon Chime Business Calling or an Amazon Chime Voice Connector.
- Phone
Number Association 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.
- Phone
Number Capabilities The phone number capabilities for Amazon Chime Business Calling phone numbers, such as enabled inbound and outbound calling and text messaging.
- Phone
Number Error 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.
- Phone
Number Order The details of a phone number order created for Amazon Chime.
- Proxy
The proxy configuration for an Amazon Chime Voice Connector.
- Proxy
Session The proxy session for an Amazon Chime Voice Connector.
- PutEvents
Configuration Request - PutEvents
Configuration Response - PutRetention
Settings Request - PutRetention
Settings Response - PutVoice
Connector Emergency Calling Configuration Request - PutVoice
Connector Emergency Calling Configuration Response - PutVoice
Connector Logging Configuration Request - PutVoice
Connector Logging Configuration Response - PutVoice
Connector Origination Request - PutVoice
Connector Origination Response - PutVoice
Connector Proxy Request - PutVoice
Connector Proxy Response - PutVoice
Connector Streaming Configuration Request - PutVoice
Connector Streaming Configuration Response - PutVoice
Connector Termination Credentials Request - PutVoice
Connector Termination Request - PutVoice
Connector Termination Response - Redact
Conversation Message Request - Redact
Conversation Message Response - Redact
Room Message Request - Redact
Room Message Response - Regenerate
Security Token Request - Regenerate
Security Token Response - Reset
PersonalPIN Request - Reset
PersonalPIN Response - Restore
Phone Number Request - Restore
Phone Number Response - Retention
Settings The retention settings for an Amazon Chime Enterprise account that determine how long to retain items such as chat room messages and chat conversation messages.
- Room
The Amazon Chime chat room details.
- Room
Membership The room membership details.
- Room
Retention Settings The retention settings that determine how long to retain chat room messages for an Amazon Chime Enterprise account.
- Search
Available Phone Numbers Request - Search
Available Phone Numbers Response - Signin
Delegate Group An Active Directory (AD) group whose members are granted permission to act as delegates.
- Streaming
Configuration The streaming configuration associated with an Amazon Chime Voice Connector. Specifies whether media streaming is enabled for sending to Amazon Kinesis, and shows the retention period for the Amazon Kinesis data, in hours.
- Streaming
Notification Target The targeted recipient for a streaming configuration notification.
- Tag
Describes a tag applied to a resource.
- TagAttendee
Request - TagMeeting
Request - TagResource
Request - Telephony
Settings Settings that allow management of telephony permissions for an Amazon Chime user, such as inbound and outbound calling and text messaging.
- Termination
Termination settings enable your SIP hosts to make outbound calls using your Amazon Chime Voice Connector.
- Termination
Health The termination health details, including the source IP address and timestamp of the last successful SIP
OPTIONSmessage from your SIP infrastructure.- Untag
Attendee Request - Untag
Meeting Request - Untag
Resource Request - Update
Account Request - Update
Account Response - Update
Account Settings Request - Update
Account Settings Response - Update
BotRequest - Update
BotResponse - Update
Global Settings Request - Update
Phone Number Request - Update
Phone Number Request Item The phone number ID, product type, or calling name fields to update, used with the BatchUpdatePhoneNumber and UpdatePhoneNumber actions.
- Update
Phone Number Response - Update
Phone Number Settings Request - Update
Proxy Session Request - Update
Proxy Session Response - Update
Room Membership Request - Update
Room Membership Response - Update
Room Request - Update
Room Response - Update
User Request - Update
User Request Item The user ID and user fields to update, used with the BatchUpdateUser action.
- Update
User Response - Update
User Settings Request - Update
Voice Connector Group Request - Update
Voice Connector Group Response - Update
Voice Connector Request - Update
Voice Connector Response - User
The user on the Amazon Chime account.
- User
Error 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.
- User
Settings Settings associated with an Amazon Chime user, including inbound and outbound calling and text messaging.
- Voice
Connector The Amazon Chime Voice Connector configuration, including outbound host name and encryption settings.
- Voice
Connector Group 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.
- Voice
Connector Item For Amazon Chime Voice Connector groups, the Amazon Chime Voice Connectors to which to route inbound calls. Includes priority configuration settings. Limit: 3
VoiceConnectorItemsper Amazon Chime Voice Connector group.- Voice
Connector Settings The Amazon Chime Voice Connector settings. Includes any Amazon S3 buckets designated for storing call detail records.
Enums§
- Associate
Phone Number With User Error - Errors returned by AssociatePhoneNumberWithUser
- Associate
Phone Numbers With Voice Connector Error - Errors returned by AssociatePhoneNumbersWithVoiceConnector
- Associate
Phone Numbers With Voice Connector Group Error - Errors returned by AssociatePhoneNumbersWithVoiceConnectorGroup
- Associate
Signin Delegate Groups With Account Error - Errors returned by AssociateSigninDelegateGroupsWithAccount
- Batch
Create Attendee Error - Errors returned by BatchCreateAttendee
- Batch
Create Room Membership Error - Errors returned by BatchCreateRoomMembership
- Batch
Delete Phone Number Error - Errors returned by BatchDeletePhoneNumber
- Batch
Suspend User Error - Errors returned by BatchSuspendUser
- Batch
Unsuspend User Error - Errors returned by BatchUnsuspendUser
- Batch
Update Phone Number Error - Errors returned by BatchUpdatePhoneNumber
- Batch
Update User Error - Errors returned by BatchUpdateUser
- Create
Account Error - Errors returned by CreateAccount
- Create
Attendee Error - Errors returned by CreateAttendee
- Create
BotError - Errors returned by CreateBot
- Create
Meeting Error - Errors returned by CreateMeeting
- Create
Meeting With Attendees Error - Errors returned by CreateMeetingWithAttendees
- Create
Phone Number Order Error - Errors returned by CreatePhoneNumberOrder
- Create
Proxy Session Error - Errors returned by CreateProxySession
- Create
Room Error - Errors returned by CreateRoom
- Create
Room Membership Error - Errors returned by CreateRoomMembership
- Create
User Error - Errors returned by CreateUser
- Create
Voice Connector Error - Errors returned by CreateVoiceConnector
- Create
Voice Connector Group Error - Errors returned by CreateVoiceConnectorGroup
- Delete
Account Error - Errors returned by DeleteAccount
- Delete
Attendee Error - Errors returned by DeleteAttendee
- Delete
Events Configuration Error - Errors returned by DeleteEventsConfiguration
- Delete
Meeting Error - Errors returned by DeleteMeeting
- Delete
Phone Number Error - Errors returned by DeletePhoneNumber
- Delete
Proxy Session Error - Errors returned by DeleteProxySession
- Delete
Room Error - Errors returned by DeleteRoom
- Delete
Room Membership Error - Errors returned by DeleteRoomMembership
- Delete
Voice Connector Emergency Calling Configuration Error - Errors returned by DeleteVoiceConnectorEmergencyCallingConfiguration
- Delete
Voice Connector Error - Errors returned by DeleteVoiceConnector
- Delete
Voice Connector Group Error - Errors returned by DeleteVoiceConnectorGroup
- Delete
Voice Connector Origination Error - Errors returned by DeleteVoiceConnectorOrigination
- Delete
Voice Connector Proxy Error - Errors returned by DeleteVoiceConnectorProxy
- Delete
Voice Connector Streaming Configuration Error - Errors returned by DeleteVoiceConnectorStreamingConfiguration
- Delete
Voice Connector Termination Credentials Error - Errors returned by DeleteVoiceConnectorTerminationCredentials
- Delete
Voice Connector Termination Error - Errors returned by DeleteVoiceConnectorTermination
- Disassociate
Phone Number From User Error - Errors returned by DisassociatePhoneNumberFromUser
- Disassociate
Phone Numbers From Voice Connector Error - Errors returned by DisassociatePhoneNumbersFromVoiceConnector
- Disassociate
Phone Numbers From Voice Connector Group Error - Errors returned by DisassociatePhoneNumbersFromVoiceConnectorGroup
- Disassociate
Signin Delegate Groups From Account Error - Errors returned by DisassociateSigninDelegateGroupsFromAccount
- GetAccount
Error - Errors returned by GetAccount
- GetAccount
Settings Error - Errors returned by GetAccountSettings
- GetAttendee
Error - Errors returned by GetAttendee
- GetBot
Error - Errors returned by GetBot
- GetEvents
Configuration Error - Errors returned by GetEventsConfiguration
- GetGlobal
Settings Error - Errors returned by GetGlobalSettings
- GetMeeting
Error - Errors returned by GetMeeting
- GetPhone
Number Error - Errors returned by GetPhoneNumber
- GetPhone
Number Order Error - Errors returned by GetPhoneNumberOrder
- GetPhone
Number Settings Error - Errors returned by GetPhoneNumberSettings
- GetProxy
Session Error - Errors returned by GetProxySession
- GetRetention
Settings Error - Errors returned by GetRetentionSettings
- GetRoom
Error - Errors returned by GetRoom
- GetUser
Error - Errors returned by GetUser
- GetUser
Settings Error - Errors returned by GetUserSettings
- GetVoice
Connector Emergency Calling Configuration Error - Errors returned by GetVoiceConnectorEmergencyCallingConfiguration
- GetVoice
Connector Error - Errors returned by GetVoiceConnector
- GetVoice
Connector Group Error - Errors returned by GetVoiceConnectorGroup
- GetVoice
Connector Logging Configuration Error - Errors returned by GetVoiceConnectorLoggingConfiguration
- GetVoice
Connector Origination Error - Errors returned by GetVoiceConnectorOrigination
- GetVoice
Connector Proxy Error - Errors returned by GetVoiceConnectorProxy
- GetVoice
Connector Streaming Configuration Error - Errors returned by GetVoiceConnectorStreamingConfiguration
- GetVoice
Connector Termination Error - Errors returned by GetVoiceConnectorTermination
- GetVoice
Connector Termination Health Error - Errors returned by GetVoiceConnectorTerminationHealth
- Invite
Users Error - Errors returned by InviteUsers
- List
Accounts Error - Errors returned by ListAccounts
- List
Attendee Tags Error - Errors returned by ListAttendeeTags
- List
Attendees Error - Errors returned by ListAttendees
- List
Bots Error - Errors returned by ListBots
- List
Meeting Tags Error - Errors returned by ListMeetingTags
- List
Meetings Error - Errors returned by ListMeetings
- List
Phone Number Orders Error - Errors returned by ListPhoneNumberOrders
- List
Phone Numbers Error - Errors returned by ListPhoneNumbers
- List
Proxy Sessions Error - Errors returned by ListProxySessions
- List
Room Memberships Error - Errors returned by ListRoomMemberships
- List
Rooms Error - Errors returned by ListRooms
- List
Tags ForResource Error - Errors returned by ListTagsForResource
- List
Users Error - Errors returned by ListUsers
- List
Voice Connector Groups Error - Errors returned by ListVoiceConnectorGroups
- List
Voice Connector Termination Credentials Error - Errors returned by ListVoiceConnectorTerminationCredentials
- List
Voice Connectors Error - Errors returned by ListVoiceConnectors
- Logout
User Error - Errors returned by LogoutUser
- PutEvents
Configuration Error - Errors returned by PutEventsConfiguration
- PutRetention
Settings Error - Errors returned by PutRetentionSettings
- PutVoice
Connector Emergency Calling Configuration Error - Errors returned by PutVoiceConnectorEmergencyCallingConfiguration
- PutVoice
Connector Logging Configuration Error - Errors returned by PutVoiceConnectorLoggingConfiguration
- PutVoice
Connector Origination Error - Errors returned by PutVoiceConnectorOrigination
- PutVoice
Connector Proxy Error - Errors returned by PutVoiceConnectorProxy
- PutVoice
Connector Streaming Configuration Error - Errors returned by PutVoiceConnectorStreamingConfiguration
- PutVoice
Connector Termination Credentials Error - Errors returned by PutVoiceConnectorTerminationCredentials
- PutVoice
Connector Termination Error - Errors returned by PutVoiceConnectorTermination
- Redact
Conversation Message Error - Errors returned by RedactConversationMessage
- Redact
Room Message Error - Errors returned by RedactRoomMessage
- Regenerate
Security Token Error - Errors returned by RegenerateSecurityToken
- Reset
PersonalPIN Error - Errors returned by ResetPersonalPIN
- Restore
Phone Number Error - Errors returned by RestorePhoneNumber
- Search
Available Phone Numbers Error - Errors returned by SearchAvailablePhoneNumbers
- TagAttendee
Error - Errors returned by TagAttendee
- TagMeeting
Error - Errors returned by TagMeeting
- TagResource
Error - Errors returned by TagResource
- Untag
Attendee Error - Errors returned by UntagAttendee
- Untag
Meeting Error - Errors returned by UntagMeeting
- Untag
Resource Error - Errors returned by UntagResource
- Update
Account Error - Errors returned by UpdateAccount
- Update
Account Settings Error - Errors returned by UpdateAccountSettings
- Update
BotError - Errors returned by UpdateBot
- Update
Global Settings Error - Errors returned by UpdateGlobalSettings
- Update
Phone Number Error - Errors returned by UpdatePhoneNumber
- Update
Phone Number Settings Error - Errors returned by UpdatePhoneNumberSettings
- Update
Proxy Session Error - Errors returned by UpdateProxySession
- Update
Room Error - Errors returned by UpdateRoom
- Update
Room Membership Error - Errors returned by UpdateRoomMembership
- Update
User Error - Errors returned by UpdateUser
- Update
User Settings Error - Errors returned by UpdateUserSettings
- Update
Voice Connector Error - Errors returned by UpdateVoiceConnector
- Update
Voice Connector Group Error - Errors returned by UpdateVoiceConnectorGroup
Traits§
- Chime
- Trait representing the capabilities of the Amazon Chime API. Amazon Chime clients implement this trait.