chime-2018-05-01 library Null safety

Classes

Account
The Amazon Chime account details. An AWS account can have multiple Amazon Chime accounts.
AccountSettings
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.
AlexaForBusinessMetadata
The Alexa for Business metadata associated with an Amazon Chime user, used to integrate Alexa for Business with a device.
AppInstance
An instance of a Chime messaging application.
AppInstanceAdmin
Promotes a user to the administrator role for the duration of an app instance.
AppInstanceAdminSummary
The identity and metadata of an administrator.
AppInstanceRetentionSettings
The length of time in days to retain messages.
AppInstanceStreamingConfiguration
The streaming configuration of an app instance.
AppInstanceSummary
The summary data for an app instance.
AppInstanceUser
The app instance user.
AppInstanceUserMembershipSummary
Lists the channels to which app instance users belong.
AppInstanceUserSummary
The app instance user summary data .
AssociatePhoneNumbersWithVoiceConnectorGroupResponse
AssociatePhoneNumbersWithVoiceConnectorResponse
AssociatePhoneNumberWithUserResponse
AssociateSigninDelegateGroupsWithAccountResponse
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.
AwsClientCredentials
AWS credentials.
BatchCreateAttendeeResponse
BatchCreateRoomMembershipResponse
BatchDeletePhoneNumberResponse
BatchSuspendUserResponse
BatchUnsuspendUserResponse
BatchUpdatePhoneNumberResponse
BatchUpdateUserResponse
Bot
A resource that allows Enterprise account administrators to configure an interface to receive events from Amazon Chime.
BusinessCallingSettings
The Amazon Chime Business Calling settings for the administrator's AWS account. Includes any Amazon S3 buckets designated for storing call detail records.
Channel
Creates a channel.
ChannelBan
Bans a user from a channel.
ChannelBanSummary
The summary data for the channel ban.
ChannelMembership
Creates a channel member.
ChannelMembershipForAppInstanceUserSummary
Returns the channel membership summary data for an app instance.
ChannelMembershipSummary
The summary data of a channel membership.
ChannelMessage
Creates a message in a channel.
ChannelMessageSummary
A summary of the messages in a channel.
ChannelModeratedByAppInstanceUserSummary
Returns the summary data for a moderated channel.
ChannelModerator
Creates a moderator on a channel.
ChannelModeratorSummary
Summary data of the moderators in a channel.
ChannelRetentionSettings
The retention settings for a channel.
ChannelSummary
The summary data for a channel.
Chime
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.
ConversationRetentionSettings
The retention settings that determine how long to retain chat conversation messages for an Amazon Chime Enterprise account.
CreateAccountResponse
CreateAppInstanceAdminResponse
CreateAppInstanceResponse
CreateAppInstanceUserResponse
CreateAttendeeError
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.
CreateAttendeeRequestItem
The Amazon Chime SDK attendee fields to create, used with the BatchCreateAttendee action.
CreateAttendeeResponse
CreateBotResponse
CreateChannelBanResponse
CreateChannelMembershipResponse
CreateChannelModeratorResponse
CreateChannelResponse
CreateMeetingDialOutResponse
CreateMeetingResponse
CreateMeetingWithAttendeesResponse
CreatePhoneNumberOrderResponse
CreateProxySessionResponse
CreateRoomMembershipResponse
CreateRoomResponse
CreateSipMediaApplicationCallResponse
CreateSipMediaApplicationResponse
CreateSipRuleResponse
CreateUserResponse
CreateVoiceConnectorGroupResponse
CreateVoiceConnectorResponse
Credential
The SIP credentials used to authenticate requests to your Amazon Chime Voice Connector.
DeleteAccountResponse
DescribeAppInstanceAdminResponse
DescribeAppInstanceResponse
DescribeAppInstanceUserResponse
DescribeChannelBanResponse
DescribeChannelMembershipForAppInstanceUserResponse
DescribeChannelMembershipResponse
DescribeChannelModeratedByAppInstanceUserResponse
DescribeChannelModeratorResponse
DescribeChannelResponse
DisassociatePhoneNumberFromUserResponse
DisassociatePhoneNumbersFromVoiceConnectorGroupResponse
DisassociatePhoneNumbersFromVoiceConnectorResponse
DisassociateSigninDelegateGroupsFromAccountResponse
DNISEmergencyCallingConfiguration
The Dialed Number Identification Service (DNIS) emergency calling configuration details associated with an Amazon Chime Voice Connector's emergency calling configuration.
EmergencyCallingConfiguration
The emergency calling configuration details associated with an Amazon Chime Voice Connector.
EventsConfiguration
The configuration that allows a bot to receive outgoing events. Can be either an HTTPS endpoint or a Lambda function ARN.
GeoMatchParams
The country and area code for a proxy phone number in a proxy phone session.
GetAccountResponse
GetAccountSettingsResponse
GetAppInstanceRetentionSettingsResponse
GetAppInstanceStreamingConfigurationsResponse
GetAttendeeResponse
GetBotResponse
GetChannelMessageResponse
GetEventsConfigurationResponse
GetGlobalSettingsResponse
GetMeetingResponse
GetMessagingSessionEndpointResponse
GetPhoneNumberOrderResponse
GetPhoneNumberResponse
GetPhoneNumberSettingsResponse
GetProxySessionResponse
GetRetentionSettingsResponse
GetRoomResponse
GetSipMediaApplicationLoggingConfigurationResponse
GetSipMediaApplicationResponse
GetSipRuleResponse
GetUserResponse
GetUserSettingsResponse
GetVoiceConnectorEmergencyCallingConfigurationResponse
GetVoiceConnectorGroupResponse
GetVoiceConnectorLoggingConfigurationResponse
GetVoiceConnectorOriginationResponse
GetVoiceConnectorProxyResponse
GetVoiceConnectorResponse
GetVoiceConnectorStreamingConfigurationResponse
GetVoiceConnectorTerminationHealthResponse
GetVoiceConnectorTerminationResponse
Identity
The ARN and name of a user.
Invite
Invitation object returned after emailing users to invite them to join the Amazon Chime Team account.
InviteUsersResponse
ListAccountsResponse
ListAppInstanceAdminsResponse
ListAppInstancesResponse
ListAppInstanceUsersResponse
ListAttendeesResponse
ListAttendeeTagsResponse
ListBotsResponse
ListChannelBansResponse
ListChannelMembershipsForAppInstanceUserResponse
ListChannelMembershipsResponse
ListChannelMessagesResponse
ListChannelModeratorsResponse
ListChannelsModeratedByAppInstanceUserResponse
ListChannelsResponse
ListMeetingsResponse
ListMeetingTagsResponse
ListPhoneNumberOrdersResponse
ListPhoneNumbersResponse
ListProxySessionsResponse
ListRoomMembershipsResponse
ListRoomsResponse
ListSipMediaApplicationsResponse
ListSipRulesResponse
ListTagsForResourceResponse
ListUsersResponse
ListVoiceConnectorGroupsResponse
ListVoiceConnectorsResponse
ListVoiceConnectorTerminationCredentialsResponse
LoggingConfiguration
The logging configuration associated with an Amazon Chime Voice Connector. Specifies whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.
LogoutUserResponse
MediaPlacement
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.
MeetingNotificationConfiguration
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.
MemberError
The list of errors returned when a member action results in an error.
MembershipItem
Membership details, such as member ID and member role.
MessagingSessionEndpoint
The endpoint of a meeting session.
OrderedPhoneNumber
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.
OriginationRoute
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.
PhoneNumber
A phone number used for Amazon Chime Business Calling or an Amazon Chime Voice Connector.
PhoneNumberAssociation
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.
PhoneNumberCapabilities
The phone number capabilities for Amazon Chime Business Calling phone numbers, such as enabled inbound and outbound calling and text messaging.
PhoneNumberError
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.
PhoneNumberOrder
The details of a phone number order created for Amazon Chime.
Proxy
The proxy configuration for an Amazon Chime Voice Connector.
ProxySession
The proxy session for an Amazon Chime Voice Connector.
PutAppInstanceRetentionSettingsResponse
PutAppInstanceStreamingConfigurationsResponse
PutEventsConfigurationResponse
PutRetentionSettingsResponse
PutSipMediaApplicationLoggingConfigurationResponse
PutVoiceConnectorEmergencyCallingConfigurationResponse
PutVoiceConnectorLoggingConfigurationResponse
PutVoiceConnectorOriginationResponse
PutVoiceConnectorProxyResponse
PutVoiceConnectorStreamingConfigurationResponse
PutVoiceConnectorTerminationResponse
RedactChannelMessageResponse
RedactConversationMessageResponse
RedactRoomMessageResponse
RegenerateSecurityTokenResponse
ResetPersonalPINResponse
RestorePhoneNumberResponse
RetentionSettings
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.
RoomMembership
The room membership details.
RoomRetentionSettings
The retention settings that determine how long to retain chat room messages for an Amazon Chime Enterprise account.
SearchAvailablePhoneNumbersResponse
SendChannelMessageResponse
SigninDelegateGroup
An Active Directory (AD) group whose members are granted permission to act as delegates.
SipMediaApplication
The SIP media application details, including name and endpoints. An AWS account can have multiple SIP media applications.
SipMediaApplicationCall
A Call instance for a SIP media application.
SipMediaApplicationEndpoint
Endpoints to specify as part of a SIP media application.
SipMediaApplicationLoggingConfiguration
Logging configuration of the SIP media application.
SipRule
The SIP rule details, including name, triggers, and target applications. An AWS account can have multiple SIP rules.
SipRuleTargetApplication
Target SIP media application along with other details like priority and AWS Region to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.
StreamingConfiguration
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.
StreamingNotificationTarget
The targeted recipient for a streaming configuration notification.
Tag
Describes a tag applied to a resource.
TelephonySettings
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.
TerminationHealth
The termination health details, including the source IP address and timestamp of the last successful SIP OPTIONS message from your SIP infrastructure.
UpdateAccountResponse
UpdateAccountSettingsResponse
UpdateAppInstanceResponse
UpdateAppInstanceUserResponse
UpdateBotResponse
UpdateChannelMessageResponse
UpdateChannelReadMarkerResponse
UpdateChannelResponse
UpdatePhoneNumberRequestItem
The phone number ID, product type, or calling name fields to update, used with the BatchUpdatePhoneNumber and UpdatePhoneNumber actions.
UpdatePhoneNumberResponse
UpdateProxySessionResponse
UpdateRoomMembershipResponse
UpdateRoomResponse
UpdateSipMediaApplicationResponse
UpdateSipRuleResponse
UpdateUserRequestItem
The user ID and user fields to update, used with the BatchUpdateUser action.
UpdateUserResponse
UpdateVoiceConnectorGroupResponse
UpdateVoiceConnectorResponse
User
The user on the Amazon Chime account.
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.
UserSettings
Settings associated with an Amazon Chime user, including inbound and outbound calling and text messaging.
VoiceConnector
The Amazon Chime Voice Connector configuration, including outbound host name and encryption settings.
VoiceConnectorGroup
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.
VoiceConnectorItem
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.
VoiceConnectorSettings
The Amazon Chime Voice Connector settings. Includes any Amazon S3 buckets designated for storing call detail records.

Enums

AccountType
AppInstanceDataType
BotType
CallingNameStatus
Capability
ChannelMembershipType
ChannelMessagePersistenceType
ChannelMessageType
ChannelMode
ChannelPrivacy
EmailStatus
ErrorCode
GeoMatchLevel
InviteStatus
License
MemberType
NotificationTarget
NumberSelectionBehavior
OrderedPhoneNumberStatus
OriginationRouteProtocol
PhoneNumberAssociationName
PhoneNumberOrderStatus
PhoneNumberProductType
PhoneNumberStatus
PhoneNumberType
ProxySessionStatus
RegistrationStatus
RoomMembershipRole
SipRuleTriggerType
SortOrder
UserType
VoiceConnectorAwsRegion

Exceptions / Errors

AccessDeniedException
BadRequestException
ConflictException
ForbiddenException
NotFoundException
ResourceLimitExceededException
ServiceFailureException
ServiceUnavailableException
ThrottledClientException
UnauthorizedClientException
UnprocessableEntityException