chime/aws.sdk.kotlin.services.chime.model

Package-level declarations

Types

AccessDeniedException

class AccessDeniedException : ChimeException

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

Account

class Account

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

AccountSettings

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

AccountStatus

sealed class AccountStatus

AccountType

sealed class AccountType

AlexaForBusinessMetadata

class AlexaForBusinessMetadata

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

AssociatePhoneNumberWithUserRequest

class AssociatePhoneNumberWithUserRequest

AssociatePhoneNumberWithUserResponse

class AssociatePhoneNumberWithUserResponse

AssociateSigninDelegateGroupsWithAccountRequest

class AssociateSigninDelegateGroupsWithAccountRequest

AssociateSigninDelegateGroupsWithAccountResponse

class AssociateSigninDelegateGroupsWithAccountResponse

BadRequestException

class BadRequestException : ChimeException

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

BatchCreateRoomMembershipRequest

class BatchCreateRoomMembershipRequest

BatchCreateRoomMembershipResponse

class BatchCreateRoomMembershipResponse

BatchDeletePhoneNumberRequest

class BatchDeletePhoneNumberRequest

BatchDeletePhoneNumberResponse

class BatchDeletePhoneNumberResponse

BatchSuspendUserRequest

class BatchSuspendUserRequest

BatchSuspendUserResponse

class BatchSuspendUserResponse

BatchUnsuspendUserRequest

class BatchUnsuspendUserRequest

BatchUnsuspendUserResponse

class BatchUnsuspendUserResponse

BatchUpdatePhoneNumberRequest

class BatchUpdatePhoneNumberRequest

BatchUpdatePhoneNumberResponse

class BatchUpdatePhoneNumberResponse

BatchUpdateUserRequest

class BatchUpdateUserRequest

BatchUpdateUserResponse

class BatchUpdateUserResponse

Bot

class Bot

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

BotType

sealed class BotType

BusinessCallingSettings

class BusinessCallingSettings

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

CallingNameStatus

sealed class CallingNameStatus

ChimeException

open class ChimeException : AwsServiceException

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

ConflictException

class ConflictException : ChimeException

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

ConversationRetentionSettings

class ConversationRetentionSettings

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

CreateAccountRequest

class CreateAccountRequest

CreateAccountResponse

class CreateAccountResponse

CreateBotRequest

class CreateBotRequest

CreateBotResponse

class CreateBotResponse

CreateMeetingDialOutRequest

class CreateMeetingDialOutRequest

CreateMeetingDialOutResponse

class CreateMeetingDialOutResponse

CreatePhoneNumberOrderRequest

class CreatePhoneNumberOrderRequest

CreatePhoneNumberOrderResponse

class CreatePhoneNumberOrderResponse

CreateRoomMembershipRequest

class CreateRoomMembershipRequest

CreateRoomMembershipResponse

class CreateRoomMembershipResponse

CreateRoomRequest

class CreateRoomRequest

CreateRoomResponse

class CreateRoomResponse

CreateUserRequest

class CreateUserRequest

CreateUserResponse

class CreateUserResponse

DeleteAccountRequest

class DeleteAccountRequest

DeleteAccountResponse

class DeleteAccountResponse

DeleteEventsConfigurationRequest

class DeleteEventsConfigurationRequest

DeleteEventsConfigurationResponse

class DeleteEventsConfigurationResponse

DeletePhoneNumberRequest

class DeletePhoneNumberRequest

DeletePhoneNumberResponse

class DeletePhoneNumberResponse

DeleteRoomMembershipRequest

class DeleteRoomMembershipRequest

DeleteRoomMembershipResponse

class DeleteRoomMembershipResponse

DeleteRoomRequest

class DeleteRoomRequest

DeleteRoomResponse

class DeleteRoomResponse

DisassociatePhoneNumberFromUserRequest

class DisassociatePhoneNumberFromUserRequest

DisassociatePhoneNumberFromUserResponse

class DisassociatePhoneNumberFromUserResponse

DisassociateSigninDelegateGroupsFromAccountRequest

class DisassociateSigninDelegateGroupsFromAccountRequest

DisassociateSigninDelegateGroupsFromAccountResponse

class DisassociateSigninDelegateGroupsFromAccountResponse

EmailStatus

sealed class EmailStatus

ErrorCode

sealed class ErrorCode

EventsConfiguration

class EventsConfiguration

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

ForbiddenException

class ForbiddenException : ChimeException

The client is permanently forbidden from making the request.

GetAccountRequest

class GetAccountRequest

GetAccountResponse

class GetAccountResponse

GetAccountSettingsRequest

class GetAccountSettingsRequest

GetAccountSettingsResponse

class GetAccountSettingsResponse

GetBotRequest

class GetBotRequest

GetBotResponse

class GetBotResponse

GetEventsConfigurationRequest

class GetEventsConfigurationRequest

GetEventsConfigurationResponse

class GetEventsConfigurationResponse

GetGlobalSettingsRequest

class GetGlobalSettingsRequest

GetGlobalSettingsResponse

class GetGlobalSettingsResponse

GetPhoneNumberOrderRequest

class GetPhoneNumberOrderRequest

GetPhoneNumberOrderResponse

class GetPhoneNumberOrderResponse

GetPhoneNumberRequest

class GetPhoneNumberRequest

GetPhoneNumberResponse

class GetPhoneNumberResponse

GetPhoneNumberSettingsRequest

class GetPhoneNumberSettingsRequest

GetPhoneNumberSettingsResponse

class GetPhoneNumberSettingsResponse

GetRetentionSettingsRequest

class GetRetentionSettingsRequest

GetRetentionSettingsResponse

class GetRetentionSettingsResponse

GetRoomRequest

class GetRoomRequest

GetRoomResponse

class GetRoomResponse

GetUserRequest

class GetUserRequest

GetUserResponse

class GetUserResponse

GetUserSettingsRequest

class GetUserSettingsRequest

GetUserSettingsResponse

class GetUserSettingsResponse

Invite

class Invite

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

InviteStatus

sealed class InviteStatus

InviteUsersRequest

class InviteUsersRequest

InviteUsersResponse

class InviteUsersResponse

License

sealed class License

ListAccountsRequest

class ListAccountsRequest

ListAccountsResponse

class ListAccountsResponse

ListBotsRequest

class ListBotsRequest

ListBotsResponse

class ListBotsResponse

ListPhoneNumberOrdersRequest

class ListPhoneNumberOrdersRequest

ListPhoneNumberOrdersResponse

class ListPhoneNumberOrdersResponse

ListPhoneNumbersRequest

class ListPhoneNumbersRequest

ListPhoneNumbersResponse

class ListPhoneNumbersResponse

ListRoomMembershipsRequest

class ListRoomMembershipsRequest

ListRoomMembershipsResponse

class ListRoomMembershipsResponse

ListRoomsRequest

class ListRoomsRequest

ListRoomsResponse

class ListRoomsResponse

ListSupportedPhoneNumberCountriesRequest

class ListSupportedPhoneNumberCountriesRequest

ListSupportedPhoneNumberCountriesResponse

class ListSupportedPhoneNumberCountriesResponse

ListUsersRequest

class ListUsersRequest

ListUsersResponse

class ListUsersResponse

LogoutUserRequest

class LogoutUserRequest

LogoutUserResponse

class LogoutUserResponse

Member

class Member

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

MemberError

class MemberError

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

MembershipItem

class MembershipItem

Membership details, such as member ID and member role.

MemberType

sealed class MemberType

NotFoundException

class NotFoundException : ChimeException

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

OrderedPhoneNumber

class OrderedPhoneNumber

A phone number for which an order has been placed.

OrderedPhoneNumberStatus

sealed class OrderedPhoneNumberStatus

PhoneNumber

class PhoneNumber

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

PhoneNumberAssociation

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

PhoneNumberAssociationName

sealed class PhoneNumberAssociationName

PhoneNumberCapabilities

class PhoneNumberCapabilities

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

PhoneNumberCountry

class PhoneNumberCountry

The phone number country.

PhoneNumberError

class 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

class PhoneNumberOrder

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

PhoneNumberOrderStatus

sealed class PhoneNumberOrderStatus

PhoneNumberProductType

sealed class PhoneNumberProductType

PhoneNumberStatus

sealed class PhoneNumberStatus

PhoneNumberType

sealed class PhoneNumberType

PutEventsConfigurationRequest

class PutEventsConfigurationRequest

PutEventsConfigurationResponse

class PutEventsConfigurationResponse

PutRetentionSettingsRequest

class PutRetentionSettingsRequest

PutRetentionSettingsResponse

class PutRetentionSettingsResponse

RedactConversationMessageRequest

class RedactConversationMessageRequest

RedactConversationMessageResponse

class RedactConversationMessageResponse

RedactRoomMessageRequest

class RedactRoomMessageRequest

RedactRoomMessageResponse

class RedactRoomMessageResponse

RegenerateSecurityTokenRequest

class RegenerateSecurityTokenRequest

RegenerateSecurityTokenResponse

class RegenerateSecurityTokenResponse

RegistrationStatus

sealed class RegistrationStatus

ResetPersonalPinRequest

class ResetPersonalPinRequest

ResetPersonalPinResponse

class ResetPersonalPinResponse

ResourceLimitExceededException

class ResourceLimitExceededException : ChimeException

The request exceeds the resource limit.

RestorePhoneNumberRequest

class RestorePhoneNumberRequest

RestorePhoneNumberResponse

class RestorePhoneNumberResponse

RetentionSettings

class 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

class Room

The Amazon Chime chat room details.

RoomMembership

class RoomMembership

The room membership details.

RoomMembershipRole

sealed class RoomMembershipRole

RoomRetentionSettings

class RoomRetentionSettings

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

SearchAvailablePhoneNumbersRequest

class SearchAvailablePhoneNumbersRequest

SearchAvailablePhoneNumbersResponse

class SearchAvailablePhoneNumbersResponse

ServiceFailureException

class ServiceFailureException : ChimeException

The service encountered an unexpected error.

ServiceUnavailableException

class ServiceUnavailableException : ChimeException

The service is currently unavailable.

SigninDelegateGroup

class SigninDelegateGroup

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

TelephonySettings

class TelephonySettings

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

ThrottledClientException

class ThrottledClientException : ChimeException

The client exceeded its request rate limit.

UnauthorizedClientException

class UnauthorizedClientException : ChimeException

The client is not currently authorized to make the request.

UnprocessableEntityException

class UnprocessableEntityException : ChimeException

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

UpdateAccountRequest

class UpdateAccountRequest

UpdateAccountResponse

class UpdateAccountResponse

UpdateAccountSettingsRequest

class UpdateAccountSettingsRequest

UpdateAccountSettingsResponse

class UpdateAccountSettingsResponse

UpdateBotRequest

class UpdateBotRequest

UpdateBotResponse

class UpdateBotResponse

UpdateGlobalSettingsRequest

class UpdateGlobalSettingsRequest

UpdateGlobalSettingsResponse

class UpdateGlobalSettingsResponse

UpdatePhoneNumberRequest

class UpdatePhoneNumberRequest

UpdatePhoneNumberRequestItem

class UpdatePhoneNumberRequestItem

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

UpdatePhoneNumberResponse

class UpdatePhoneNumberResponse

UpdatePhoneNumberSettingsRequest

class UpdatePhoneNumberSettingsRequest

UpdatePhoneNumberSettingsResponse

class UpdatePhoneNumberSettingsResponse

UpdateRoomMembershipRequest

class UpdateRoomMembershipRequest

UpdateRoomMembershipResponse

class UpdateRoomMembershipResponse

UpdateRoomRequest

class UpdateRoomRequest

UpdateRoomResponse

class UpdateRoomResponse

UpdateUserRequest

class UpdateUserRequest

UpdateUserRequestItem

class UpdateUserRequestItem

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

UpdateUserResponse

class UpdateUserResponse

UpdateUserSettingsRequest

class UpdateUserSettingsRequest

UpdateUserSettingsResponse

class UpdateUserSettingsResponse

User

class User

The user on the Amazon Chime account.

UserError

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.

UserSettings

class UserSettings

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

UserType

sealed class UserType

VoiceConnectorSettings

class VoiceConnectorSettings

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