Package-level declarations

Types

Link copied to clipboard

You don't have permissions to perform the requested operation.

Link copied to clipboard
class Account

The Amazon Chime account details. An AWS account can have multiple Amazon Chime accounts.

Link copied to clipboard

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.

Link copied to clipboard
sealed class AccountStatus
Link copied to clipboard
sealed class AccountType
Link copied to clipboard
class Address

A validated address.

Link copied to clipboard

The Alexa for Business metadata associated with an Amazon Chime user, used to integrate Alexa for Business with a device.

Link copied to clipboard

The details of an AppInstance, an instance of an Amazon Chime SDK messaging application.

Link copied to clipboard

The details of an AppInstanceAdmin.

Link copied to clipboard

Summary of the details of an AppInstanceAdmin.

Link copied to clipboard
sealed class AppInstanceDataType
Link copied to clipboard

The details of the data-retention settings for an AppInstance.

Link copied to clipboard

The details of the streaming configuration of an AppInstance.

Link copied to clipboard

Summary of the data for an AppInstance.

Link copied to clipboard

The details of an AppInstanceUser.

Link copied to clipboard

Summary of the membership details of an AppInstanceUser.

Link copied to clipboard

Summary of the details of an AppInstanceUser.

Link copied to clipboard

The configuration for the artifacts.

Link copied to clipboard
sealed class ArtifactsState
Link copied to clipboard
class Attendee

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.

Link copied to clipboard

The audio artifact configuration object.

Link copied to clipboard
sealed class AudioMuxType
Link copied to clipboard

The input parameters don't match the service's restrictions.

Link copied to clipboard

The membership information, including member ARNs, the channel ARN, and membership types.

Link copied to clipboard

A list of failed member ARNs, error codes, and error messages.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class Bot

A resource that allows Enterprise account administrators to configure an interface to receive events from Amazon Chime.

Link copied to clipboard
sealed class BotType
Link copied to clipboard

The Amazon Chime Business Calling settings for the administrator's AWS account. Includes any Amazon S3 buckets designated for storing call detail records.

Link copied to clipboard
sealed class CallingNameStatus
Link copied to clipboard

A suggested address.

Link copied to clipboard
sealed class Capability
Link copied to clipboard
class Channel

The details of a channel.

Link copied to clipboard

The details of a channel ban.

Link copied to clipboard

Summary of the details of a ChannelBan.

Link copied to clipboard

The details of a channel member.

Summary of the channel membership details of an AppInstanceUser.

Link copied to clipboard

Summary of the details of a ChannelMembership.

Link copied to clipboard
Link copied to clipboard

The details of a message in a channel.

Link copied to clipboard
Link copied to clipboard

Summary of the messages in a Channel.

Link copied to clipboard
sealed class ChannelMessageType
Link copied to clipboard
sealed class ChannelMode
Link copied to clipboard

Summary of the details of a moderated channel.

Link copied to clipboard

The details of a channel moderator.

Link copied to clipboard

Summary of the details of a ChannelModerator.

Link copied to clipboard
sealed class ChannelPrivacy
Link copied to clipboard

The details of the retention settings for a channel.

Link copied to clipboard

Summary of the details of a Channel.

Link copied to clipboard

Base class for all service related exceptions thrown by the Chime client

Link copied to clipboard

The configuration object of the Amazon Chime SDK meeting for a specified media capture pipeline. SourceType must be ChimeSdkMeeting.

Link copied to clipboard

The request could not be processed because of conflict in the current state of the resource.

Link copied to clipboard

The content artifact object.

Link copied to clipboard
sealed class ContentMuxType
Link copied to clipboard

The retention settings that determine how long to retain conversation messages for an Amazon Chime Enterprise account.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

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.

Link copied to clipboard
Link copied to clipboard

The Amazon Chime SDK attendee fields to create, used with the BatchCreateAttendee action.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The SIP credentials used to authenticate requests to your Amazon Chime Voice Connector.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The Dialed Number Identification Service (DNIS) emergency calling configuration details associated with an Amazon Chime Voice Connector's emergency calling configuration.

Link copied to clipboard
sealed class EmailStatus
Link copied to clipboard

The emergency calling configuration details associated with an Amazon Chime Voice Connector.

Link copied to clipboard

Settings specific to the Amazon Transcribe Medical engine.

Link copied to clipboard

Settings specific for Amazon Transcribe as the live transcription engine.

Link copied to clipboard
sealed class ErrorCode
Link copied to clipboard

The configuration that allows a bot to receive outgoing events. Can be either an HTTPS endpoint or a Lambda function ARN.

Link copied to clipboard

The client is permanently forbidden from making the request.

Link copied to clipboard
sealed class GeoMatchLevel
Link copied to clipboard

The country and area code for a proxy phone number in a proxy phone session.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class Identity

The details of a user.

Link copied to clipboard
class Invite

Invitation object returned after emailing users to invite them to join the Amazon Chime Team account.

Link copied to clipboard
sealed class InviteStatus
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
sealed class License
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The logging configuration associated with an Amazon Chime Voice Connector. Specifies whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

A media capture pipeline object consisting of an ID, source type, source ARN, a sink type, a sink ARN, and a configuration object.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
sealed class MediaPipelineStatus
Link copied to clipboard

A set of endpoints used by clients to connect to the media service group for an Amazon Chime SDK meeting.

Link copied to clipboard
class Meeting

A meeting created using the Amazon Chime SDK.

Link copied to clipboard

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

Link copied to clipboard
class Member

The member details, such as email address, name, member ID, and member type.

Link copied to clipboard

The list of errors returned when a member action results in an error.

Link copied to clipboard

Membership details, such as member ID and member role.

Link copied to clipboard
sealed class MemberType
Link copied to clipboard

The websocket endpoint used to connect to Amazon Chime SDK messaging.

Link copied to clipboard

One or more of the resources in the request does not exist in the system.

Link copied to clipboard
sealed class NotificationTarget
Link copied to clipboard
Link copied to clipboard

A phone number for which an order has been placed.

Link copied to clipboard
Link copied to clipboard

Origination settings enable your SIP hosts to receive inbound calls using your Amazon Chime Voice Connector.

Link copied to clipboard

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.

Link copied to clipboard
Link copied to clipboard

The phone number and proxy phone number for a participant in an Amazon Chime Voice Connector proxy session.

Link copied to clipboard

A phone number used for Amazon Chime Business Calling or an Amazon Chime Voice Connector.

Link copied to clipboard

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.

Link copied to clipboard
Link copied to clipboard

The phone number capabilities for Amazon Chime Business Calling phone numbers, such as enabled inbound and outbound calling and text messaging.

Link copied to clipboard

The phone number country.

Link copied to clipboard

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.

Link copied to clipboard

The details of a phone number order created for Amazon Chime.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
sealed class PhoneNumberStatus
Link copied to clipboard
sealed class PhoneNumberType
Link copied to clipboard
class Proxy

The proxy configuration for an Amazon Chime Voice Connector.

Link copied to clipboard

The proxy session for an Amazon Chime Voice Connector.

Link copied to clipboard
sealed class ProxySessionStatus
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
sealed class RegistrationStatus
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The request exceeds the resource limit.

Link copied to clipboard
Link copied to clipboard

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.

Link copied to clipboard
class Room

The Amazon Chime chat room details.

Link copied to clipboard

The room membership details.

Link copied to clipboard
sealed class RoomMembershipRole
Link copied to clipboard

The retention settings that determine how long to retain chat-room messages for an Amazon Chime Enterprise account.

Link copied to clipboard

The video streams to capture for a specified media capture pipeline. The total number of video streams can't exceed 25.

Link copied to clipboard
Link copied to clipboard

The service encountered an unexpected error.

Link copied to clipboard

The service is currently unavailable.

Link copied to clipboard

An Active Directory (AD) group whose members are granted permission to act as delegates.

Link copied to clipboard

The details of the SIP media application, including name and endpoints. An AWS account can have multiple SIP media applications.

Link copied to clipboard

A Call instance for a SIP media application.

Link copied to clipboard

The endpoint assigned to the SIP media application.

Link copied to clipboard

Logging configuration of the SIP media application.

Link copied to clipboard
class SipRule

The SIP rule details, including name, triggers, and target applications. An AWS account can have multiple SIP rules.

Link copied to clipboard

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.

Link copied to clipboard
sealed class SipRuleTriggerType
Link copied to clipboard
sealed class SortOrder
Link copied to clipboard

Source configuration for a specified media capture pipeline.

Link copied to clipboard

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.

Link copied to clipboard

The targeted recipient for a streaming configuration notification.

Link copied to clipboard
class Tag

Describes a tag applied to a resource.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Settings that allow management of telephony permissions for an Amazon Chime user, such as inbound and outbound calling and text messaging.

Link copied to clipboard

Termination settings enable your SIP hosts to make outbound calls using your Amazon Chime Voice Connector.

Link copied to clipboard

The termination health details, including the source IP address and timestamp of the last successful SIP OPTIONS message from your SIP infrastructure.

Link copied to clipboard

The client exceeded its request rate limit.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
sealed class TranscribeRegion
Link copied to clipboard

The configuration for the current transcription operation. Must contain EngineTranscribeSettings or EngineTranscribeMedicalSettings.

Link copied to clipboard

The client is not currently authorized to make the request.

Link copied to clipboard

The request was well-formed but was unable to be followed due to semantic errors.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The phone number ID, product type, or calling name fields to update, used with the BatchUpdatePhoneNumber and UpdatePhoneNumber actions.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The user ID and user fields to update, used with the BatchUpdateUser action.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class User

The user on the Amazon Chime account.

Link copied to clipboard
class UserError

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.

Link copied to clipboard

Settings associated with an Amazon Chime user, including inbound and outbound calling and text messaging.

Link copied to clipboard
sealed class UserType
Link copied to clipboard

The video artifact configuration object.

Link copied to clipboard
sealed class VideoMuxType
Link copied to clipboard

The Amazon Chime Voice Connector configuration, including outbound host name and encryption settings.

Link copied to clipboard
Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

The Amazon Chime Voice Connector settings. Includes any Amazon S3 buckets designated for storing call detail records.