AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Classes

NameDescription
Class AccountStatus

Constants used for properties of type AccountStatus.

Class AccountType

Constants used for properties of type AccountType.

Class AmazonChimeClient

Implementation for accessing Chime

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 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.

Class AmazonChimeConfig

Configuration for accessing Amazon Chime service

Class AmazonChimeDefaultConfiguration

Configuration for accessing Amazon Chime service

Class AmazonChimeException

Common exception for the Chime service.

Class AmazonChimeRequest

Base class for Chime operation requests.

Class AppInstanceDataType

Constants used for properties of type AppInstanceDataType.

Class ArtifactsState

Constants used for properties of type ArtifactsState.

Class AudioMuxType

Constants used for properties of type AudioMuxType.

Class BotType

Constants used for properties of type BotType.

Class CallingNameStatus

Constants used for properties of type CallingNameStatus.

Class Capability

Constants used for properties of type Capability.

Class ChannelMembershipType

Constants used for properties of type ChannelMembershipType.

Class ChannelMessagePersistenceType

Constants used for properties of type ChannelMessagePersistenceType.

Class ChannelMessageType

Constants used for properties of type ChannelMessageType.

Class ChannelMode

Constants used for properties of type ChannelMode.

Class ChannelPrivacy

Constants used for properties of type ChannelPrivacy.

Class ContentMuxType

Constants used for properties of type ContentMuxType.

Class EmailStatus

Constants used for properties of type EmailStatus.

Class ErrorCode

Constants used for properties of type ErrorCode.

Class GeoMatchLevel

Constants used for properties of type GeoMatchLevel.

Class InviteStatus

Constants used for properties of type InviteStatus.

Class License

Constants used for properties of type License.

Class MediaPipelineSinkType

Constants used for properties of type MediaPipelineSinkType.

Class MediaPipelineSourceType

Constants used for properties of type MediaPipelineSourceType.

Class MediaPipelineStatus

Constants used for properties of type MediaPipelineStatus.

Class MemberType

Constants used for properties of type MemberType.

Class NotificationTarget

Constants used for properties of type NotificationTarget.

Class NumberSelectionBehavior

Constants used for properties of type NumberSelectionBehavior.

Class OrderedPhoneNumberStatus

Constants used for properties of type OrderedPhoneNumberStatus.

Class OriginationRouteProtocol

Constants used for properties of type OriginationRouteProtocol.

Class PhoneNumberAssociationName

Constants used for properties of type PhoneNumberAssociationName.

Class PhoneNumberOrderStatus

Constants used for properties of type PhoneNumberOrderStatus.

Class PhoneNumberProductType

Constants used for properties of type PhoneNumberProductType.

Class PhoneNumberStatus

Constants used for properties of type PhoneNumberStatus.

Class PhoneNumberType

Constants used for properties of type PhoneNumberType.

Class ProxySessionStatus

Constants used for properties of type ProxySessionStatus.

Class RegistrationStatus

Constants used for properties of type RegistrationStatus.

Class RoomMembershipRole

Constants used for properties of type RoomMembershipRole.

Class SipRuleTriggerType

Constants used for properties of type SipRuleTriggerType.

Class SortOrder

Constants used for properties of type SortOrder.

Class TranscribeContentIdentificationType

Constants used for properties of type TranscribeContentIdentificationType.

Class TranscribeContentRedactionType

Constants used for properties of type TranscribeContentRedactionType.

Class TranscribeLanguageCode

Constants used for properties of type TranscribeLanguageCode.

Class TranscribeMedicalContentIdentificationType

Constants used for properties of type TranscribeMedicalContentIdentificationType.

Class TranscribeMedicalLanguageCode

Constants used for properties of type TranscribeMedicalLanguageCode.

Class TranscribeMedicalRegion

Constants used for properties of type TranscribeMedicalRegion.

Class TranscribeMedicalSpecialty

Constants used for properties of type TranscribeMedicalSpecialty.

Class TranscribeMedicalType

Constants used for properties of type TranscribeMedicalType.

Class TranscribePartialResultsStability

Constants used for properties of type TranscribePartialResultsStability.

Class TranscribeRegion

Constants used for properties of type TranscribeRegion.

Class TranscribeVocabularyFilterMethod

Constants used for properties of type TranscribeVocabularyFilterMethod.

Class UserType

Constants used for properties of type UserType.

Class VideoMuxType

Constants used for properties of type VideoMuxType.

Class VoiceConnectorAwsRegion

Constants used for properties of type VoiceConnectorAwsRegion.

Interfaces

NameDescription
Interface IAmazonChime

Interface for accessing Chime

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 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.