chime/aws.sdk.kotlin.services.chime

Package-level declarations

Types

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.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Inherited functions

associatePhoneNumberWithUser

inline suspend fun ChimeClient.associatePhoneNumberWithUser(crossinline block: AssociatePhoneNumberWithUserRequest.Builder.() -> Unit): AssociatePhoneNumberWithUserResponse

Associates a phone number with the specified Amazon Chime user.

associateSigninDelegateGroupsWithAccount

inline suspend fun ChimeClient.associateSigninDelegateGroupsWithAccount(crossinline block: AssociateSigninDelegateGroupsWithAccountRequest.Builder.() -> Unit): AssociateSigninDelegateGroupsWithAccountResponse

Associates the specified sign-in delegate groups with the specified Amazon Chime account.

batchCreateRoomMembership

inline suspend fun ChimeClient.batchCreateRoomMembership(crossinline block: BatchCreateRoomMembershipRequest.Builder.() -> Unit): BatchCreateRoomMembershipResponse

Adds up to 50 members to a chat room in an Amazon Chime Enterprise account. Members can be users or bots. The member role designates whether the member is a chat room administrator or a general chat room member.

batchDeletePhoneNumber

inline suspend fun ChimeClient.batchDeletePhoneNumber(crossinline block: BatchDeletePhoneNumberRequest.Builder.() -> Unit): BatchDeletePhoneNumberResponse

Moves phone numbers into the Deletion queue. Phone numbers must be disassociated from any users or Amazon Chime Voice Connectors before they can be deleted.

batchSuspendUser

inline suspend fun ChimeClient.batchSuspendUser(crossinline block: BatchSuspendUserRequest.Builder.() -> Unit): BatchSuspendUserResponse

Suspends up to 50 users from a Team or EnterpriseLWA Amazon Chime account. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.

batchUnsuspendUser

inline suspend fun ChimeClient.batchUnsuspendUser(crossinline block: BatchUnsuspendUserRequest.Builder.() -> Unit): BatchUnsuspendUserResponse

Removes the suspension from up to 50 previously suspended users for the specified Amazon Chime EnterpriseLWA account. Only users on EnterpriseLWA accounts can be unsuspended using this action. For more information about different account types, see Managing Your Amazon Chime Accounts in the account types, in the Amazon Chime Administration Guide.

batchUpdatePhoneNumber

inline suspend fun ChimeClient.batchUpdatePhoneNumber(crossinline block: BatchUpdatePhoneNumberRequest.Builder.() -> Unit): BatchUpdatePhoneNumberResponse

Updates phone number product types or calling names. You can update one attribute at a time for each UpdatePhoneNumberRequestItem. For example, you can update the product type or the calling name.

batchUpdateUser

inline suspend fun ChimeClient.batchUpdateUser(crossinline block: BatchUpdateUserRequest.Builder.() -> Unit): BatchUpdateUserResponse

Updates user details within the UpdateUserRequestItem object for up to 20 users for the specified Amazon Chime account. Currently, only LicenseType updates are supported for this action.

createAccount

inline suspend fun ChimeClient.createAccount(crossinline block: CreateAccountRequest.Builder.() -> Unit): CreateAccountResponse

Creates an Amazon Chime account under the administrator's AWS account. Only Team account types are currently supported for this action. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.

createBot

inline suspend fun ChimeClient.createBot(crossinline block: CreateBotRequest.Builder.() -> Unit): CreateBotResponse

Creates a bot for an Amazon Chime Enterprise account.

createMeetingDialOut

inline suspend fun ChimeClient.createMeetingDialOut(crossinline block: CreateMeetingDialOutRequest.Builder.() -> Unit): CreateMeetingDialOutResponse

Uses the join token and call metadata in a meeting request (From number, To number, and so forth) to initiate an outbound call to a public switched telephone network (PSTN) and join them into a Chime meeting. Also ensures that the From number belongs to the customer.

createPhoneNumberOrder

inline suspend fun ChimeClient.createPhoneNumberOrder(crossinline block: CreatePhoneNumberOrderRequest.Builder.() -> Unit): CreatePhoneNumberOrderResponse

Creates an order for phone numbers to be provisioned. For toll-free numbers, you cannot use the Amazon Chime Business Calling product type. For numbers outside the U.S., you must use the Amazon Chime SIP Media Application Dial-In product type.

createRoom

inline suspend fun ChimeClient.createRoom(crossinline block: CreateRoomRequest.Builder.() -> Unit): CreateRoomResponse

Creates a chat room for the specified Amazon Chime Enterprise account.

createRoomMembership

inline suspend fun ChimeClient.createRoomMembership(crossinline block: CreateRoomMembershipRequest.Builder.() -> Unit): CreateRoomMembershipResponse

Adds a member to a chat room in an Amazon Chime Enterprise account. A member can be either a user or a bot. The member role designates whether the member is a chat room administrator or a general chat room member.

createUser

inline suspend fun ChimeClient.createUser(crossinline block: CreateUserRequest.Builder.() -> Unit): CreateUserResponse

Creates a user under the specified Amazon Chime account.

deleteAccount

inline suspend fun ChimeClient.deleteAccount(crossinline block: DeleteAccountRequest.Builder.() -> Unit): DeleteAccountResponse

Deletes the specified Amazon Chime account. You must suspend all users before deleting Team account. You can use the BatchSuspendUser action to dodo.

deleteEventsConfiguration

inline suspend fun ChimeClient.deleteEventsConfiguration(crossinline block: DeleteEventsConfigurationRequest.Builder.() -> Unit): DeleteEventsConfigurationResponse

Deletes the events configuration that allows a bot to receive outgoing events.

deletePhoneNumber

inline suspend fun ChimeClient.deletePhoneNumber(crossinline block: DeletePhoneNumberRequest.Builder.() -> Unit): DeletePhoneNumberResponse

Moves the specified phone number into the Deletion queue. A phone number must be disassociated from any users or Amazon Chime Voice Connectors before it can be deleted.

deleteRoom

inline suspend fun ChimeClient.deleteRoom(crossinline block: DeleteRoomRequest.Builder.() -> Unit): DeleteRoomResponse

Deletes a chat room in an Amazon Chime Enterprise account.

deleteRoomMembership

inline suspend fun ChimeClient.deleteRoomMembership(crossinline block: DeleteRoomMembershipRequest.Builder.() -> Unit): DeleteRoomMembershipResponse

Removes a member from a chat room in an Amazon Chime Enterprise account.

disassociatePhoneNumberFromUser

inline suspend fun ChimeClient.disassociatePhoneNumberFromUser(crossinline block: DisassociatePhoneNumberFromUserRequest.Builder.() -> Unit): DisassociatePhoneNumberFromUserResponse

Disassociates the primary provisioned phone number from the specified Amazon Chime user.

disassociateSigninDelegateGroupsFromAccount

inline suspend fun ChimeClient.disassociateSigninDelegateGroupsFromAccount(crossinline block: DisassociateSigninDelegateGroupsFromAccountRequest.Builder.() -> Unit): DisassociateSigninDelegateGroupsFromAccountResponse

Disassociates the specified sign-in delegate groups from the specified Amazon Chime account.

getAccount

inline suspend fun ChimeClient.getAccount(crossinline block: GetAccountRequest.Builder.() -> Unit): GetAccountResponse

Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.

getAccountSettings

inline suspend fun ChimeClient.getAccountSettings(crossinline block: GetAccountSettingsRequest.Builder.() -> Unit): GetAccountSettingsResponse

Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dialout settings. For more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide.

getBot

inline suspend fun ChimeClient.getBot(crossinline block: GetBotRequest.Builder.() -> Unit): GetBotResponse

Retrieves details for the specified bot, such as bot email address, bot type, status, and display name.

getEventsConfiguration

inline suspend fun ChimeClient.getEventsConfiguration(crossinline block: GetEventsConfigurationRequest.Builder.() -> Unit): GetEventsConfigurationResponse

Gets details for an events configuration that allows a bot to receive outgoing events, such as an HTTPS endpoint or Lambda function ARN.

getGlobalSettings

inline suspend fun ChimeClient.getGlobalSettings(crossinline block: GetGlobalSettingsRequest.Builder.() -> Unit): GetGlobalSettingsResponse

Retrieves global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.

getPhoneNumber

inline suspend fun ChimeClient.getPhoneNumber(crossinline block: GetPhoneNumberRequest.Builder.() -> Unit): GetPhoneNumberResponse

Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.

getPhoneNumberOrder

inline suspend fun ChimeClient.getPhoneNumberOrder(crossinline block: GetPhoneNumberOrderRequest.Builder.() -> Unit): GetPhoneNumberOrderResponse

Retrieves details for the specified phone number order, such as the order creation timestamp, phone numbers in E.164 format, product type, and order status.

getPhoneNumberSettings

inline suspend fun ChimeClient.getPhoneNumberSettings(crossinline block: GetPhoneNumberSettingsRequest.Builder.() -> Unit): GetPhoneNumberSettingsResponse

Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.

getRetentionSettings

inline suspend fun ChimeClient.getRetentionSettings(crossinline block: GetRetentionSettingsRequest.Builder.() -> Unit): GetRetentionSettingsResponse

Gets the retention settings for the specified Amazon Chime Enterprise account. For more information about retention settings, see Managing Chat Retention Policies in the Amazon Chime Administration Guide.

getRoom

inline suspend fun ChimeClient.getRoom(crossinline block: GetRoomRequest.Builder.() -> Unit): GetRoomResponse

Retrieves room details, such as the room name, for a room in an Amazon Chime Enterprise account.

getUser

inline suspend fun ChimeClient.getUser(crossinline block: GetUserRequest.Builder.() -> Unit): GetUserResponse

Retrieves details for the specified user ID, such as primary email address, license type,and personal meeting PIN.

getUserSettings

inline suspend fun ChimeClient.getUserSettings(crossinline block: GetUserSettingsRequest.Builder.() -> Unit): GetUserSettingsResponse

Retrieves settings for the specified user ID, such as any associated phone number settings.

inviteUsers

inline suspend fun ChimeClient.inviteUsers(crossinline block: InviteUsersRequest.Builder.() -> Unit): InviteUsersResponse

Sends email to a maximum of 50 users, inviting them to the specified Amazon Chime Team account. Only Team account types are currently supported for this action.

listAccounts

inline suspend fun ChimeClient.listAccounts(crossinline block: ListAccountsRequest.Builder.() -> Unit): ListAccountsResponse

Lists the Amazon Chime accounts under the administrator's AWS account. You can filter accounts by account name prefix. To find out which Amazon Chime account a user belongs to, you can filter by the user's email address, which returns one account result.

listBots

inline suspend fun ChimeClient.listBots(crossinline block: ListBotsRequest.Builder.() -> Unit): ListBotsResponse

Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.

listPhoneNumberOrders

inline suspend fun ChimeClient.listPhoneNumberOrders(crossinline block: ListPhoneNumberOrdersRequest.Builder.() -> Unit): ListPhoneNumberOrdersResponse

Lists the phone number orders for the administrator's Amazon Chime account.

listPhoneNumbers

inline suspend fun ChimeClient.listPhoneNumbers(crossinline block: ListPhoneNumbersRequest.Builder.() -> Unit): ListPhoneNumbersResponse

Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, Amazon Chime Voice Connector, or Amazon Chime Voice Connector group.

listRoomMemberships

inline suspend fun ChimeClient.listRoomMemberships(crossinline block: ListRoomMembershipsRequest.Builder.() -> Unit): ListRoomMembershipsResponse

Lists the membership details for the specified room in an Amazon Chime Enterprise account, such as the members' IDs, email addresses, and names.

listRooms

inline suspend fun ChimeClient.listRooms(crossinline block: ListRoomsRequest.Builder.() -> Unit): ListRoomsResponse

Lists the room details for the specified Amazon Chime Enterprise account. Optionally, filter the results by a member ID (user ID or bot ID) to see a list of rooms that the member belongs to.

listSupportedPhoneNumberCountries

inline suspend fun ChimeClient.listSupportedPhoneNumberCountries(crossinline block: ListSupportedPhoneNumberCountriesRequest.Builder.() -> Unit): ListSupportedPhoneNumberCountriesResponse

Lists supported phone number countries.

listUsers

inline suspend fun ChimeClient.listUsers(crossinline block: ListUsersRequest.Builder.() -> Unit): ListUsersResponse

Lists the users that belong to the specified Amazon Chime account. You can specify an email address to list only the user that the email address belongs to.

logoutUser

inline suspend fun ChimeClient.logoutUser(crossinline block: LogoutUserRequest.Builder.() -> Unit): LogoutUserResponse

Logs out the specified user from all of the devices they are currently logged into.

putEventsConfiguration

inline suspend fun ChimeClient.putEventsConfiguration(crossinline block: PutEventsConfigurationRequest.Builder.() -> Unit): PutEventsConfigurationResponse

Creates an events configuration that allows a bot to receive outgoing events sent by Amazon Chime. Choose either an HTTPS endpoint or a Lambda function ARN. For more information, see Bot.

putRetentionSettings

inline suspend fun ChimeClient.putRetentionSettings(crossinline block: PutRetentionSettingsRequest.Builder.() -> Unit): PutRetentionSettingsResponse

Puts retention settings for the specified Amazon Chime Enterprise account. We recommend using AWS CloudTrail to monitor usage of this API for your account. For more information, see Logging Amazon Chime API Calls with AWS CloudTrail in the Amazon Chime Administration Guide.

redactConversationMessage

inline suspend fun ChimeClient.redactConversationMessage(crossinline block: RedactConversationMessageRequest.Builder.() -> Unit): RedactConversationMessageResponse

Redacts the specified message from the specified Amazon Chime conversation.

redactRoomMessage

inline suspend fun ChimeClient.redactRoomMessage(crossinline block: RedactRoomMessageRequest.Builder.() -> Unit): RedactRoomMessageResponse

Redacts the specified message from the specified Amazon Chime channel.

regenerateSecurityToken

inline suspend fun ChimeClient.regenerateSecurityToken(crossinline block: RegenerateSecurityTokenRequest.Builder.() -> Unit): RegenerateSecurityTokenResponse

Regenerates the security token for a bot.

resetPersonalPin

inline suspend fun ChimeClient.resetPersonalPin(crossinline block: ResetPersonalPinRequest.Builder.() -> Unit): ResetPersonalPinResponse

Resets the personal meeting PIN for the specified user on an Amazon Chime account. Returns the User object with the updated personal meeting PIN.

restorePhoneNumber

inline suspend fun ChimeClient.restorePhoneNumber(crossinline block: RestorePhoneNumberRequest.Builder.() -> Unit): RestorePhoneNumberResponse

Moves a phone number from the Deletion queue back into the phone number Inventory.

searchAvailablePhoneNumbers

inline suspend fun ChimeClient.searchAvailablePhoneNumbers(crossinline block: SearchAvailablePhoneNumbersRequest.Builder.() -> Unit): SearchAvailablePhoneNumbersResponse

Searches for phone numbers that can be ordered. For US numbers, provide at least one of the following search filters: AreaCode, City, State, or TollFreePrefix. If you provide City, you must also provide State. Numbers outside the US only support the PhoneNumberType filter, which you must use.

updateAccount

inline suspend fun ChimeClient.updateAccount(crossinline block: UpdateAccountRequest.Builder.() -> Unit): UpdateAccountResponse

Updates account details for the specified Amazon Chime account. Currently, only account name and default license updates are supported for this action.

updateAccountSettings

inline suspend fun ChimeClient.updateAccountSettings(crossinline block: UpdateAccountSettingsRequest.Builder.() -> Unit): UpdateAccountSettingsResponse

Updates the settings for the specified Amazon Chime account. You can update settings for remote control of shared screens, or for the dial-out option. For more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide.

updateBot

inline suspend fun ChimeClient.updateBot(crossinline block: UpdateBotRequest.Builder.() -> Unit): UpdateBotResponse

Updates the status of the specified bot, such as starting or stopping the bot from running in your Amazon Chime Enterprise account.

updateGlobalSettings

inline suspend fun ChimeClient.updateGlobalSettings(crossinline block: UpdateGlobalSettingsRequest.Builder.() -> Unit): UpdateGlobalSettingsResponse

Updates global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.

updatePhoneNumber

inline suspend fun ChimeClient.updatePhoneNumber(crossinline block: UpdatePhoneNumberRequest.Builder.() -> Unit): UpdatePhoneNumberResponse

Updates phone number details, such as product type or calling name, for the specified phone number ID. You can update one phone number detail at a time. For example, you can update either the product type or the calling name in one action.

updatePhoneNumberSettings

inline suspend fun ChimeClient.updatePhoneNumberSettings(crossinline block: UpdatePhoneNumberSettingsRequest.Builder.() -> Unit): UpdatePhoneNumberSettingsResponse

Updates the phone number settings for the administrator's AWS account, such as the default outbound calling name. You can update the default outbound calling name once every seven days. Outbound calling names can take up to 72 hours to update.

updateRoom

inline suspend fun ChimeClient.updateRoom(crossinline block: UpdateRoomRequest.Builder.() -> Unit): UpdateRoomResponse

Updates room details, such as the room name, for a room in an Amazon Chime Enterprise account.

updateRoomMembership

inline suspend fun ChimeClient.updateRoomMembership(crossinline block: UpdateRoomMembershipRequest.Builder.() -> Unit): UpdateRoomMembershipResponse

Updates room membership details, such as the member role, for a room in an Amazon Chime Enterprise account. The member role designates whether the member is a chat room administrator or a general chat room member. The member role can be updated only for user IDs.

updateUser

inline suspend fun ChimeClient.updateUser(crossinline block: UpdateUserRequest.Builder.() -> Unit): UpdateUserResponse

Updates user details for a specified user ID. Currently, only LicenseType updates are supported for this action.

updateUserSettings

inline suspend fun ChimeClient.updateUserSettings(crossinline block: UpdateUserSettingsRequest.Builder.() -> Unit): UpdateUserSettingsResponse

Updates the settings for the specified user, such as phone number settings.

withConfig

fun ChimeClient.withConfig(block: ChimeClient.Config.Builder.() -> Unit): ChimeClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.