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
chimeand REST endpoint
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.
Some APIs require complex or nested arguments. These exist in
The other modules within this crate are not required for normal usage.
Client and fluent builders for calling the service.
Configuration for the service.
Errors that can occur when calling the service.
Input structures for operations.
Generated accessors for nested fields
Base Middleware Stack
Data structures used by operation inputs/outputs.
All operations that this crate can perform.
Output structures for operations.
Paginators for the service
Re-exported types from supporting crates.
App name that can be configured with an AWS SDK client to become part of the user agent string.
Client for Amazon Chime
AWS SDK Credentials
The region to send requests to.
Retry configuration for requests.
All possible error types for this service.
Crate version number.