chime/aws.sdk.kotlin.services.chime

Package-level declarations

Types

Link copied to clipboard
interface ChimeClient : SdkClient

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

Link copied to clipboard
const val SdkVersion: String
Link copied to clipboard
Link copied to clipboard
const val ServiceId: String

Functions

Link copied to clipboard
inline suspend fun ChimeClient.associatePhoneNumbersWithVoiceConnector(crossinline block: AssociatePhoneNumbersWithVoiceConnectorRequest.Builder.() -> Unit): AssociatePhoneNumbersWithVoiceConnectorResponse

Associates phone numbers with the specified Amazon Chime Voice Connector.

inline suspend fun ChimeClient.associatePhoneNumbersWithVoiceConnectorGroup(crossinline block: AssociatePhoneNumbersWithVoiceConnectorGroupRequest.Builder.() -> Unit): AssociatePhoneNumbersWithVoiceConnectorGroupResponse

Associates phone numbers with the specified Amazon Chime Voice Connector group.

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

Associates a phone number with the specified Amazon Chime user.

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

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

Link copied to clipboard
inline suspend fun ChimeClient.batchCreateAttendee(crossinline block: BatchCreateAttendeeRequest.Builder.() -> Unit): BatchCreateAttendeeResponse

Creates up to 100 new attendees for an active Amazon Chime SDK meeting.

Link copied to clipboard
inline suspend fun ChimeClient.batchCreateChannelMembership(crossinline block: BatchCreateChannelMembershipRequest.Builder.() -> Unit): BatchCreateChannelMembershipResponse

Adds a specified number of users to a channel.

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
inline suspend fun ChimeClient.createAppInstance(crossinline block: CreateAppInstanceRequest.Builder.() -> Unit): CreateAppInstanceResponse

Creates an Amazon Chime SDK messaging AppInstance under an AWS account. Only SDK messaging customers use this API. CreateAppInstance supports idempotency behavior as described in the AWS API Standard.

Link copied to clipboard
inline suspend fun ChimeClient.createAppInstanceAdmin(crossinline block: CreateAppInstanceAdminRequest.Builder.() -> Unit): CreateAppInstanceAdminResponse

Promotes an AppInstanceUser to an AppInstanceAdmin. The promoted user can perform the following actions.

Link copied to clipboard
inline suspend fun ChimeClient.createAppInstanceUser(crossinline block: CreateAppInstanceUserRequest.Builder.() -> Unit): CreateAppInstanceUserResponse

Creates a user under an Amazon Chime AppInstance. The request consists of a unique appInstanceUserId and Name for that user.

Link copied to clipboard
inline suspend fun ChimeClient.createAttendee(crossinline block: CreateAttendeeRequest.Builder.() -> Unit): CreateAttendeeResponse

Creates a new attendee for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.

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

Creates a bot for an Amazon Chime Enterprise account.

Link copied to clipboard
inline suspend fun ChimeClient.createChannel(crossinline block: CreateChannelRequest.Builder.() -> Unit): CreateChannelResponse

Creates a channel to which you can add users and send messages.

Link copied to clipboard
inline suspend fun ChimeClient.createChannelBan(crossinline block: CreateChannelBanRequest.Builder.() -> Unit): CreateChannelBanResponse

Permanently bans a member from a channel. Moderators can't add banned members to a channel. To undo a ban, you first have to DeleteChannelBan, and then CreateChannelMembership. Bans are cleaned up when you delete users or channels.

Link copied to clipboard
inline suspend fun ChimeClient.createChannelMembership(crossinline block: CreateChannelMembershipRequest.Builder.() -> Unit): CreateChannelMembershipResponse

Adds a user to a channel. The InvitedBy response field is derived from the request header. A channel member can:

Link copied to clipboard
inline suspend fun ChimeClient.createChannelModerator(crossinline block: CreateChannelModeratorRequest.Builder.() -> Unit): CreateChannelModeratorResponse

Creates a new ChannelModerator. A channel moderator can:

Link copied to clipboard
inline suspend fun ChimeClient.createMediaCapturePipeline(crossinline block: CreateMediaCapturePipelineRequest.Builder.() -> Unit): CreateMediaCapturePipelineResponse

Creates a media capture pipeline.

Link copied to clipboard
inline suspend fun ChimeClient.createMeeting(crossinline block: CreateMeetingRequest.Builder.() -> Unit): CreateMeetingResponse

Creates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees. For more information about specifying media Regions, see Amazon Chime SDK Media Regions in the Amazon Chime SDK Developer Guide . For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.

Link copied to clipboard
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.

Link copied to clipboard
inline suspend fun ChimeClient.createMeetingWithAttendees(crossinline block: CreateMeetingWithAttendeesRequest.Builder.() -> Unit): CreateMeetingWithAttendeesResponse

Creates a new Amazon Chime SDK meeting in the specified media Region, with attendees. For more information about specifying media Regions, see Amazon Chime SDK Media Regions in the Amazon Chime SDK Developer Guide . For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide .

Link copied to clipboard
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.

Link copied to clipboard
inline suspend fun ChimeClient.createProxySession(crossinline block: CreateProxySessionRequest.Builder.() -> Unit): CreateProxySessionResponse

Creates a proxy session on the specified Amazon Chime Voice Connector for the specified participant phone numbers.

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

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

Link copied to clipboard
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.

Link copied to clipboard
inline suspend fun ChimeClient.createSipMediaApplication(crossinline block: CreateSipMediaApplicationRequest.Builder.() -> Unit): CreateSipMediaApplicationResponse

Creates a SIP media application.

Link copied to clipboard
inline suspend fun ChimeClient.createSipMediaApplicationCall(crossinline block: CreateSipMediaApplicationCallRequest.Builder.() -> Unit): CreateSipMediaApplicationCallResponse

Creates an outbound call to a phone number from the phone number specified in the request, and it invokes the endpoint of the specified sipMediaApplicationId.

Link copied to clipboard
inline suspend fun ChimeClient.createSipRule(crossinline block: CreateSipRuleRequest.Builder.() -> Unit): CreateSipRuleResponse

Creates a SIP rule which can be used to run a SIP media application as a target for a specific trigger type.

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

Creates a user under the specified Amazon Chime account.

Link copied to clipboard
inline suspend fun ChimeClient.createVoiceConnector(crossinline block: CreateVoiceConnectorRequest.Builder.() -> Unit): CreateVoiceConnectorResponse

Creates an Amazon Chime Voice Connector under the administrator's AWS account. You can choose to create an Amazon Chime Voice Connector in a specific AWS Region.

Link copied to clipboard
inline suspend fun ChimeClient.createVoiceConnectorGroup(crossinline block: CreateVoiceConnectorGroupRequest.Builder.() -> Unit): CreateVoiceConnectorGroupResponse

Creates an Amazon Chime Voice Connector group under the administrator's AWS account. You can associate Amazon Chime Voice Connectors with the Amazon Chime Voice Connector group by including VoiceConnectorItems in the request.

Link copied to clipboard
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.

Link copied to clipboard
inline suspend fun ChimeClient.deleteAppInstance(crossinline block: DeleteAppInstanceRequest.Builder.() -> Unit): DeleteAppInstanceResponse

Deletes an AppInstance and all associated data asynchronously.

Link copied to clipboard
inline suspend fun ChimeClient.deleteAppInstanceAdmin(crossinline block: DeleteAppInstanceAdminRequest.Builder.() -> Unit): DeleteAppInstanceAdminResponse

Demotes an AppInstanceAdmin to an AppInstanceUser. This action does not delete the user.

Link copied to clipboard
inline suspend fun ChimeClient.deleteAppInstanceStreamingConfigurations(crossinline block: DeleteAppInstanceStreamingConfigurationsRequest.Builder.() -> Unit): DeleteAppInstanceStreamingConfigurationsResponse

Deletes the streaming configurations of an AppInstance.

Link copied to clipboard
inline suspend fun ChimeClient.deleteAppInstanceUser(crossinline block: DeleteAppInstanceUserRequest.Builder.() -> Unit): DeleteAppInstanceUserResponse

Deletes an AppInstanceUser.

Link copied to clipboard
inline suspend fun ChimeClient.deleteAttendee(crossinline block: DeleteAttendeeRequest.Builder.() -> Unit): DeleteAttendeeResponse

Deletes an attendee from the specified Amazon Chime SDK meeting and deletes their JoinToken. Attendees are automatically deleted when a Amazon Chime SDK meeting is deleted. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.

Link copied to clipboard
inline suspend fun ChimeClient.deleteChannel(crossinline block: DeleteChannelRequest.Builder.() -> Unit): DeleteChannelResponse

Immediately makes a channel and its memberships inaccessible and marks them for deletion. This is an irreversible process.

Link copied to clipboard
inline suspend fun ChimeClient.deleteChannelBan(crossinline block: DeleteChannelBanRequest.Builder.() -> Unit): DeleteChannelBanResponse

Removes a user from a channel's ban list.

Link copied to clipboard
inline suspend fun ChimeClient.deleteChannelMembership(crossinline block: DeleteChannelMembershipRequest.Builder.() -> Unit): DeleteChannelMembershipResponse

Removes a member from a channel.

Link copied to clipboard
inline suspend fun ChimeClient.deleteChannelMessage(crossinline block: DeleteChannelMessageRequest.Builder.() -> Unit): DeleteChannelMessageResponse

Deletes a channel message. Only admins can perform this action. Deletion makes messages inaccessible immediately. A background process deletes any revisions created by UpdateChannelMessage.

Link copied to clipboard
inline suspend fun ChimeClient.deleteChannelModerator(crossinline block: DeleteChannelModeratorRequest.Builder.() -> Unit): DeleteChannelModeratorResponse

Deletes a channel moderator.

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

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

Link copied to clipboard
inline suspend fun ChimeClient.deleteMediaCapturePipeline(crossinline block: DeleteMediaCapturePipelineRequest.Builder.() -> Unit): DeleteMediaCapturePipelineResponse

Deletes the media capture pipeline.

Link copied to clipboard
inline suspend fun ChimeClient.deleteMeeting(crossinline block: DeleteMeetingRequest.Builder.() -> Unit): DeleteMeetingResponse

Deletes the specified Amazon Chime SDK meeting. The operation deletes all attendees, disconnects all clients, and prevents new clients from joining the meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.

Link copied to clipboard
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.

Link copied to clipboard
inline suspend fun ChimeClient.deleteProxySession(crossinline block: DeleteProxySessionRequest.Builder.() -> Unit): DeleteProxySessionResponse

Deletes the specified proxy session from the specified Amazon Chime Voice Connector.

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

Deletes a chat room in an Amazon Chime Enterprise account.

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

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

Link copied to clipboard
inline suspend fun ChimeClient.deleteSipMediaApplication(crossinline block: DeleteSipMediaApplicationRequest.Builder.() -> Unit): DeleteSipMediaApplicationResponse

Deletes a SIP media application.

Link copied to clipboard
inline suspend fun ChimeClient.deleteSipRule(crossinline block: DeleteSipRuleRequest.Builder.() -> Unit): DeleteSipRuleResponse

Deletes a SIP rule. You must disable a SIP rule before you can delete it.

Link copied to clipboard
inline suspend fun ChimeClient.deleteVoiceConnector(crossinline block: DeleteVoiceConnectorRequest.Builder.() -> Unit): DeleteVoiceConnectorResponse

Deletes the specified Amazon Chime Voice Connector. Any phone numbers associated with the Amazon Chime Voice Connector must be disassociated from it before it can be deleted.

inline suspend fun ChimeClient.deleteVoiceConnectorEmergencyCallingConfiguration(crossinline block: DeleteVoiceConnectorEmergencyCallingConfigurationRequest.Builder.() -> Unit): DeleteVoiceConnectorEmergencyCallingConfigurationResponse

Deletes the emergency calling configuration details from the specified Amazon Chime Voice Connector.

Link copied to clipboard
inline suspend fun ChimeClient.deleteVoiceConnectorGroup(crossinline block: DeleteVoiceConnectorGroupRequest.Builder.() -> Unit): DeleteVoiceConnectorGroupResponse

Deletes the specified Amazon Chime Voice Connector group. Any VoiceConnectorItems and phone numbers associated with the group must be removed before it can be deleted.

Link copied to clipboard
inline suspend fun ChimeClient.deleteVoiceConnectorOrigination(crossinline block: DeleteVoiceConnectorOriginationRequest.Builder.() -> Unit): DeleteVoiceConnectorOriginationResponse

Deletes the origination settings for the specified Amazon Chime Voice Connector.

Link copied to clipboard
inline suspend fun ChimeClient.deleteVoiceConnectorProxy(crossinline block: DeleteVoiceConnectorProxyRequest.Builder.() -> Unit): DeleteVoiceConnectorProxyResponse

Deletes the proxy configuration from the specified Amazon Chime Voice Connector.

inline suspend fun ChimeClient.deleteVoiceConnectorStreamingConfiguration(crossinline block: DeleteVoiceConnectorStreamingConfigurationRequest.Builder.() -> Unit): DeleteVoiceConnectorStreamingConfigurationResponse

Deletes the streaming configuration for the specified Amazon Chime Voice Connector.

Link copied to clipboard
inline suspend fun ChimeClient.deleteVoiceConnectorTermination(crossinline block: DeleteVoiceConnectorTerminationRequest.Builder.() -> Unit): DeleteVoiceConnectorTerminationResponse

Deletes the termination settings for the specified Amazon Chime Voice Connector.

inline suspend fun ChimeClient.deleteVoiceConnectorTerminationCredentials(crossinline block: DeleteVoiceConnectorTerminationCredentialsRequest.Builder.() -> Unit): DeleteVoiceConnectorTerminationCredentialsResponse

Deletes the specified SIP credentials used by your equipment to authenticate during call termination.

Link copied to clipboard
inline suspend fun ChimeClient.describeAppInstance(crossinline block: DescribeAppInstanceRequest.Builder.() -> Unit): DescribeAppInstanceResponse

Returns the full details of an AppInstance.

Link copied to clipboard
inline suspend fun ChimeClient.describeAppInstanceAdmin(crossinline block: DescribeAppInstanceAdminRequest.Builder.() -> Unit): DescribeAppInstanceAdminResponse

Returns the full details of an AppInstanceAdmin.

Link copied to clipboard
inline suspend fun ChimeClient.describeAppInstanceUser(crossinline block: DescribeAppInstanceUserRequest.Builder.() -> Unit): DescribeAppInstanceUserResponse

Returns the full details of an AppInstanceUser.

Link copied to clipboard
inline suspend fun ChimeClient.describeChannel(crossinline block: DescribeChannelRequest.Builder.() -> Unit): DescribeChannelResponse

Returns the full details of a channel in an Amazon Chime AppInstance.

Link copied to clipboard
inline suspend fun ChimeClient.describeChannelBan(crossinline block: DescribeChannelBanRequest.Builder.() -> Unit): DescribeChannelBanResponse

Returns the full details of a channel ban.

Link copied to clipboard
inline suspend fun ChimeClient.describeChannelMembership(crossinline block: DescribeChannelMembershipRequest.Builder.() -> Unit): DescribeChannelMembershipResponse

Returns the full details of a user's channel membership.

inline suspend fun ChimeClient.describeChannelMembershipForAppInstanceUser(crossinline block: DescribeChannelMembershipForAppInstanceUserRequest.Builder.() -> Unit): DescribeChannelMembershipForAppInstanceUserResponse

Returns the details of a channel based on the membership of the specified AppInstanceUser.

inline suspend fun ChimeClient.describeChannelModeratedByAppInstanceUser(crossinline block: DescribeChannelModeratedByAppInstanceUserRequest.Builder.() -> Unit): DescribeChannelModeratedByAppInstanceUserResponse

Returns the full details of a channel moderated by the specified AppInstanceUser.

Link copied to clipboard
inline suspend fun ChimeClient.describeChannelModerator(crossinline block: DescribeChannelModeratorRequest.Builder.() -> Unit): DescribeChannelModeratorResponse

Returns the full details of a single ChannelModerator.

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

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

inline suspend fun ChimeClient.disassociatePhoneNumbersFromVoiceConnector(crossinline block: DisassociatePhoneNumbersFromVoiceConnectorRequest.Builder.() -> Unit): DisassociatePhoneNumbersFromVoiceConnectorResponse

Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector.

inline suspend fun ChimeClient.disassociatePhoneNumbersFromVoiceConnectorGroup(crossinline block: DisassociatePhoneNumbersFromVoiceConnectorGroupRequest.Builder.() -> Unit): DisassociatePhoneNumbersFromVoiceConnectorGroupResponse

Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector group.

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

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

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
inline suspend fun ChimeClient.getAppInstanceRetentionSettings(crossinline block: GetAppInstanceRetentionSettingsRequest.Builder.() -> Unit): GetAppInstanceRetentionSettingsResponse

Gets the retention settings for an AppInstance.

Link copied to clipboard
Link copied to clipboard
inline suspend fun ChimeClient.getAttendee(crossinline block: GetAttendeeRequest.Builder.() -> Unit): GetAttendeeResponse

Gets the Amazon Chime SDK attendee details for a specified meeting ID and attendee ID. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.

Link copied to clipboard
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.

Link copied to clipboard
inline suspend fun ChimeClient.getChannelMessage(crossinline block: GetChannelMessageRequest.Builder.() -> Unit): GetChannelMessageResponse

Gets the full details of a channel message.

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
inline suspend fun ChimeClient.getMediaCapturePipeline(crossinline block: GetMediaCapturePipelineRequest.Builder.() -> Unit): GetMediaCapturePipelineResponse

Gets an existing media capture pipeline.

Link copied to clipboard
inline suspend fun ChimeClient.getMeeting(crossinline block: GetMeetingRequest.Builder.() -> Unit): GetMeetingResponse

This API is is no longer supported and will not be updated. We recommend using the latest version, GetMeeting, in the Amazon Chime SDK.

Link copied to clipboard
inline suspend fun ChimeClient.getMessagingSessionEndpoint(crossinline block: GetMessagingSessionEndpointRequest.Builder.() -> Unit): GetMessagingSessionEndpointResponse

The details of the endpoint for the messaging session.

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
inline suspend fun ChimeClient.getProxySession(crossinline block: GetProxySessionRequest.Builder.() -> Unit): GetProxySessionResponse

Gets the specified proxy session details for the specified Amazon Chime Voice Connector.

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
inline suspend fun ChimeClient.getSipMediaApplication(crossinline block: GetSipMediaApplicationRequest.Builder.() -> Unit): GetSipMediaApplicationResponse

Retrieves the information for a SIP media application, including name, AWS Region, and endpoints.

inline suspend fun ChimeClient.getSipMediaApplicationLoggingConfiguration(crossinline block: GetSipMediaApplicationLoggingConfigurationRequest.Builder.() -> Unit): GetSipMediaApplicationLoggingConfigurationResponse

Returns the logging configuration for the specified SIP media application.

Link copied to clipboard
inline suspend fun ChimeClient.getSipRule(crossinline block: GetSipRuleRequest.Builder.() -> Unit): GetSipRuleResponse

Retrieves the details of a SIP rule, such as the rule ID, name, triggers, and target endpoints.

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
inline suspend fun ChimeClient.getVoiceConnector(crossinline block: GetVoiceConnectorRequest.Builder.() -> Unit): GetVoiceConnectorResponse

Retrieves details for the specified Amazon Chime Voice Connector, such as timestamps,name, outbound host, and encryption requirements.

inline suspend fun ChimeClient.getVoiceConnectorEmergencyCallingConfiguration(crossinline block: GetVoiceConnectorEmergencyCallingConfigurationRequest.Builder.() -> Unit): GetVoiceConnectorEmergencyCallingConfigurationResponse

Gets the emergency calling configuration details for the specified Amazon Chime Voice Connector.

Link copied to clipboard
inline suspend fun ChimeClient.getVoiceConnectorGroup(crossinline block: GetVoiceConnectorGroupRequest.Builder.() -> Unit): GetVoiceConnectorGroupResponse

Retrieves details for the specified Amazon Chime Voice Connector group, such as timestamps,name, and associated VoiceConnectorItems.

Link copied to clipboard
inline suspend fun ChimeClient.getVoiceConnectorLoggingConfiguration(crossinline block: GetVoiceConnectorLoggingConfigurationRequest.Builder.() -> Unit): GetVoiceConnectorLoggingConfigurationResponse

Retrieves the logging configuration details for the specified Amazon Chime Voice Connector. Shows whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.

Link copied to clipboard
inline suspend fun ChimeClient.getVoiceConnectorOrigination(crossinline block: GetVoiceConnectorOriginationRequest.Builder.() -> Unit): GetVoiceConnectorOriginationResponse

Retrieves origination setting details for the specified Amazon Chime Voice Connector.

Link copied to clipboard
inline suspend fun ChimeClient.getVoiceConnectorProxy(crossinline block: GetVoiceConnectorProxyRequest.Builder.() -> Unit): GetVoiceConnectorProxyResponse

Gets the proxy configuration details for the specified Amazon Chime Voice Connector.

Link copied to clipboard
inline suspend fun ChimeClient.getVoiceConnectorStreamingConfiguration(crossinline block: GetVoiceConnectorStreamingConfigurationRequest.Builder.() -> Unit): GetVoiceConnectorStreamingConfigurationResponse

Retrieves the streaming configuration details for the specified Amazon Chime Voice Connector. Shows whether media streaming is enabled for sending to Amazon Kinesis. It also shows the retention period, in hours, for the Amazon Kinesis data.

Link copied to clipboard
inline suspend fun ChimeClient.getVoiceConnectorTermination(crossinline block: GetVoiceConnectorTerminationRequest.Builder.() -> Unit): GetVoiceConnectorTerminationResponse

Retrieves termination setting details for the specified Amazon Chime Voice Connector.

Link copied to clipboard
inline suspend fun ChimeClient.getVoiceConnectorTerminationHealth(crossinline block: GetVoiceConnectorTerminationHealthRequest.Builder.() -> Unit): GetVoiceConnectorTerminationHealthResponse

This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnectorTerminationHealth, in the Amazon Chime SDK.

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
inline suspend fun ChimeClient.listAppInstanceAdmins(crossinline block: ListAppInstanceAdminsRequest.Builder.() -> Unit): ListAppInstanceAdminsResponse

Returns a list of the administrators in the AppInstance.

Link copied to clipboard
inline suspend fun ChimeClient.listAppInstances(crossinline block: ListAppInstancesRequest.Builder.() -> Unit): ListAppInstancesResponse

Lists all Amazon Chime AppInstances created under a single AWS account.

Link copied to clipboard
inline suspend fun ChimeClient.listAppInstanceUsers(crossinline block: ListAppInstanceUsersRequest.Builder.() -> Unit): ListAppInstanceUsersResponse

List all AppInstanceUsers created under a single AppInstance.

Link copied to clipboard
inline suspend fun ChimeClient.listAttendees(crossinline block: ListAttendeesRequest.Builder.() -> Unit): ListAttendeesResponse

Lists the attendees for the specified Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.

Link copied to clipboard
inline suspend fun ChimeClient.listAttendeeTags(crossinline block: ListAttendeeTagsRequest.Builder.() -> Unit): ListAttendeeTagsResponse

Lists the tags applied to an Amazon Chime SDK attendee resource.

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

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

Link copied to clipboard
inline suspend fun ChimeClient.listChannelBans(crossinline block: ListChannelBansRequest.Builder.() -> Unit): ListChannelBansResponse

Lists all the users banned from a particular channel.

Link copied to clipboard
inline suspend fun ChimeClient.listChannelMemberships(crossinline block: ListChannelMembershipsRequest.Builder.() -> Unit): ListChannelMembershipsResponse

Lists all channel memberships in a channel.

Link copied to clipboard
inline suspend fun ChimeClient.listChannelMembershipsForAppInstanceUser(crossinline block: ListChannelMembershipsForAppInstanceUserRequest.Builder.() -> Unit): ListChannelMembershipsForAppInstanceUserResponse

Lists all channels that a particular AppInstanceUser is a part of. Only an AppInstanceAdmin can call the API with a user ARN that is not their own.

Link copied to clipboard
inline suspend fun ChimeClient.listChannelMessages(crossinline block: ListChannelMessagesRequest.Builder.() -> Unit): ListChannelMessagesResponse

List all the messages in a channel. Returns a paginated list of ChannelMessages. By default, sorted by creation timestamp in descending order.

Link copied to clipboard
inline suspend fun ChimeClient.listChannelModerators(crossinline block: ListChannelModeratorsRequest.Builder.() -> Unit): ListChannelModeratorsResponse

Lists all the moderators for a channel.

Link copied to clipboard
inline suspend fun ChimeClient.listChannels(crossinline block: ListChannelsRequest.Builder.() -> Unit): ListChannelsResponse

Lists all Channels created under a single Chime App as a paginated list. You can specify filters to narrow results.

Link copied to clipboard
inline suspend fun ChimeClient.listChannelsModeratedByAppInstanceUser(crossinline block: ListChannelsModeratedByAppInstanceUserRequest.Builder.() -> Unit): ListChannelsModeratedByAppInstanceUserResponse

A list of the channels moderated by an AppInstanceUser.

Link copied to clipboard
inline suspend fun ChimeClient.listMediaCapturePipelines(crossinline block: ListMediaCapturePipelinesRequest.Builder.() -> Unit): ListMediaCapturePipelinesResponse

Returns a list of media capture pipelines.

Link copied to clipboard
inline suspend fun ChimeClient.listMeetings(crossinline block: ListMeetingsRequest.Builder.() -> Unit): ListMeetingsResponse

Lists up to 100 active Amazon Chime SDK meetings.

Link copied to clipboard
inline suspend fun ChimeClient.listMeetingTags(crossinline block: ListMeetingTagsRequest.Builder.() -> Unit): ListMeetingTagsResponse

Lists the tags applied to an Amazon Chime SDK meeting resource.

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

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

Link copied to clipboard
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.

Link copied to clipboard
inline suspend fun ChimeClient.listProxySessions(crossinline block: ListProxySessionsRequest.Builder.() -> Unit): ListProxySessionsResponse

Lists the proxy sessions for the specified Amazon Chime Voice Connector.

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
inline suspend fun ChimeClient.listSipMediaApplications(crossinline block: ListSipMediaApplicationsRequest.Builder.() -> Unit): ListSipMediaApplicationsResponse

Lists the SIP media applications under the administrator's AWS account.

Link copied to clipboard
inline suspend fun ChimeClient.listSipRules(crossinline block: ListSipRulesRequest.Builder.() -> Unit): ListSipRulesResponse

Lists the SIP rules under the administrator's AWS account.

Link copied to clipboard
Link copied to clipboard
inline suspend fun ChimeClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Lists the tags applied to an Amazon Chime SDK meeting and messaging resources.

Link copied to clipboard
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.

Link copied to clipboard
inline suspend fun ChimeClient.listVoiceConnectorGroups(crossinline block: ListVoiceConnectorGroupsRequest.Builder.() -> Unit): ListVoiceConnectorGroupsResponse

Lists the Amazon Chime Voice Connector groups for the administrator's AWS account.

Link copied to clipboard
inline suspend fun ChimeClient.listVoiceConnectors(crossinline block: ListVoiceConnectorsRequest.Builder.() -> Unit): ListVoiceConnectorsResponse

Lists the Amazon Chime Voice Connectors for the administrator's AWS account.

Link copied to clipboard
inline suspend fun ChimeClient.listVoiceConnectorTerminationCredentials(crossinline block: ListVoiceConnectorTerminationCredentialsRequest.Builder.() -> Unit): ListVoiceConnectorTerminationCredentialsResponse

Lists the SIP credentials for the specified Amazon Chime Voice Connector.

Link copied to clipboard
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.

Link copied to clipboard
inline suspend fun ChimeClient.putAppInstanceRetentionSettings(crossinline block: PutAppInstanceRetentionSettingsRequest.Builder.() -> Unit): PutAppInstanceRetentionSettingsResponse

Sets the amount of time in days that a given AppInstance retains data.

Link copied to clipboard
inline suspend fun ChimeClient.putAppInstanceStreamingConfigurations(crossinline block: PutAppInstanceStreamingConfigurationsRequest.Builder.() -> Unit): PutAppInstanceStreamingConfigurationsResponse

The data streaming configurations of an AppInstance.

Link copied to clipboard
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.

Link copied to clipboard
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.

inline suspend fun ChimeClient.putSipMediaApplicationLoggingConfiguration(crossinline block: PutSipMediaApplicationLoggingConfigurationRequest.Builder.() -> Unit): PutSipMediaApplicationLoggingConfigurationResponse

Updates the logging configuration for the specified SIP media application.

inline suspend fun ChimeClient.putVoiceConnectorEmergencyCallingConfiguration(crossinline block: PutVoiceConnectorEmergencyCallingConfigurationRequest.Builder.() -> Unit): PutVoiceConnectorEmergencyCallingConfigurationResponse

Puts emergency calling configuration details to the specified Amazon Chime Voice Connector, such as emergency phone numbers and calling countries. Origination and termination settings must be enabled for the Amazon Chime Voice Connector before emergency calling can be configured.

Link copied to clipboard
inline suspend fun ChimeClient.putVoiceConnectorLoggingConfiguration(crossinline block: PutVoiceConnectorLoggingConfigurationRequest.Builder.() -> Unit): PutVoiceConnectorLoggingConfigurationResponse

Adds a logging configuration for the specified Amazon Chime Voice Connector. The logging configuration specifies whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.

Link copied to clipboard
inline suspend fun ChimeClient.putVoiceConnectorOrigination(crossinline block: PutVoiceConnectorOriginationRequest.Builder.() -> Unit): PutVoiceConnectorOriginationResponse

Adds origination settings for the specified Amazon Chime Voice Connector.

Link copied to clipboard
inline suspend fun ChimeClient.putVoiceConnectorProxy(crossinline block: PutVoiceConnectorProxyRequest.Builder.() -> Unit): PutVoiceConnectorProxyResponse

Puts the specified proxy configuration to the specified Amazon Chime Voice Connector.

Link copied to clipboard
inline suspend fun ChimeClient.putVoiceConnectorStreamingConfiguration(crossinline block: PutVoiceConnectorStreamingConfigurationRequest.Builder.() -> Unit): PutVoiceConnectorStreamingConfigurationResponse

Adds a streaming configuration for the specified Amazon Chime Voice Connector. The streaming configuration specifies whether media streaming is enabled for sending to Kinesis. It also sets the retention period, in hours, for the Amazon Kinesis data.

Link copied to clipboard
inline suspend fun ChimeClient.putVoiceConnectorTermination(crossinline block: PutVoiceConnectorTerminationRequest.Builder.() -> Unit): PutVoiceConnectorTerminationResponse

Adds termination settings for the specified Amazon Chime Voice Connector.

Link copied to clipboard
inline suspend fun ChimeClient.putVoiceConnectorTerminationCredentials(crossinline block: PutVoiceConnectorTerminationCredentialsRequest.Builder.() -> Unit): PutVoiceConnectorTerminationCredentialsResponse

Adds termination SIP credentials for the specified Amazon Chime Voice Connector.

Link copied to clipboard
inline suspend fun ChimeClient.redactChannelMessage(crossinline block: RedactChannelMessageRequest.Builder.() -> Unit): RedactChannelMessageResponse

Redacts message content, but not metadata. The message exists in the back end, but the action returns null content, and the state shows as redacted.

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

Redacts the specified message from the specified Amazon Chime conversation.

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

Redacts the specified message from the specified Amazon Chime channel.

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

Regenerates the security token for a bot.

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
inline suspend fun ChimeClient.sendChannelMessage(crossinline block: SendChannelMessageRequest.Builder.() -> Unit): SendChannelMessageResponse

Sends a message to a particular channel that the member is a part of.

Link copied to clipboard
inline suspend fun ChimeClient.startMeetingTranscription(crossinline block: StartMeetingTranscriptionRequest.Builder.() -> Unit): StartMeetingTranscriptionResponse

Starts transcription for the specified meetingId. For more information, refer to Using Amazon Chime SDK live transcription in the Amazon Chime SDK Developer Guide.

Link copied to clipboard
inline suspend fun ChimeClient.stopMeetingTranscription(crossinline block: StopMeetingTranscriptionRequest.Builder.() -> Unit): StopMeetingTranscriptionResponse

Stops transcription for the specified meetingId.

Link copied to clipboard
inline suspend fun ChimeClient.tagAttendee(crossinline block: TagAttendeeRequest.Builder.() -> Unit): TagAttendeeResponse

Applies the specified tags to the specified Amazon Chime attendee.

Link copied to clipboard
inline suspend fun ChimeClient.tagMeeting(crossinline block: TagMeetingRequest.Builder.() -> Unit): TagMeetingResponse

Applies the specified tags to the specified Amazon Chime SDK meeting.

Link copied to clipboard
inline suspend fun ChimeClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Applies the specified tags to the specified Amazon Chime SDK meeting resource.

Link copied to clipboard
inline suspend fun ChimeClient.untagAttendee(crossinline block: UntagAttendeeRequest.Builder.() -> Unit): UntagAttendeeResponse

Untags the specified tags from the specified Amazon Chime SDK attendee.

Link copied to clipboard
inline suspend fun ChimeClient.untagMeeting(crossinline block: UntagMeetingRequest.Builder.() -> Unit): UntagMeetingResponse

Untags the specified tags from the specified Amazon Chime SDK meeting.

Link copied to clipboard
inline suspend fun ChimeClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Untags the specified tags from the specified Amazon Chime SDK meeting resource.

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
inline suspend fun ChimeClient.updateAppInstance(crossinline block: UpdateAppInstanceRequest.Builder.() -> Unit): UpdateAppInstanceResponse

Updates AppInstance metadata.

Link copied to clipboard
inline suspend fun ChimeClient.updateAppInstanceUser(crossinline block: UpdateAppInstanceUserRequest.Builder.() -> Unit): UpdateAppInstanceUserResponse

Updates the details of an AppInstanceUser. You can update names and metadata.

Link copied to clipboard
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.

Link copied to clipboard
inline suspend fun ChimeClient.updateChannel(crossinline block: UpdateChannelRequest.Builder.() -> Unit): UpdateChannelResponse

Update a channel's attributes.

Link copied to clipboard
inline suspend fun ChimeClient.updateChannelMessage(crossinline block: UpdateChannelMessageRequest.Builder.() -> Unit): UpdateChannelMessageResponse

Updates the content of a message.

Link copied to clipboard
inline suspend fun ChimeClient.updateChannelReadMarker(crossinline block: UpdateChannelReadMarkerRequest.Builder.() -> Unit): UpdateChannelReadMarkerResponse

The details of the time when a user last read messages in a channel.

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
inline suspend fun ChimeClient.updateProxySession(crossinline block: UpdateProxySessionRequest.Builder.() -> Unit): UpdateProxySessionResponse

Updates the specified proxy session details, such as voice or SMS capabilities.

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
inline suspend fun ChimeClient.updateSipMediaApplication(crossinline block: UpdateSipMediaApplicationRequest.Builder.() -> Unit): UpdateSipMediaApplicationResponse

Updates the details of the specified SIP media application.

Link copied to clipboard
inline suspend fun ChimeClient.updateSipMediaApplicationCall(crossinline block: UpdateSipMediaApplicationCallRequest.Builder.() -> Unit): UpdateSipMediaApplicationCallResponse

Invokes the AWS Lambda function associated with the SIP media application and transaction ID in an update request. The Lambda function can then return a new set of actions.

Link copied to clipboard
inline suspend fun ChimeClient.updateSipRule(crossinline block: UpdateSipRuleRequest.Builder.() -> Unit): UpdateSipRuleResponse

Updates the details of the specified SIP rule.

Link copied to clipboard
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.

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

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

Link copied to clipboard
inline suspend fun ChimeClient.updateVoiceConnector(crossinline block: UpdateVoiceConnectorRequest.Builder.() -> Unit): UpdateVoiceConnectorResponse

Updates details for the specified Amazon Chime Voice Connector.

Link copied to clipboard
inline suspend fun ChimeClient.updateVoiceConnectorGroup(crossinline block: UpdateVoiceConnectorGroupRequest.Builder.() -> Unit): UpdateVoiceConnectorGroupResponse

Updates details of the specified Amazon Chime Voice Connector group, such as the name and Amazon Chime Voice Connector priority ranking.

Link copied to clipboard
inline suspend fun ChimeClient.validateE911Address(crossinline block: ValidateE911AddressRequest.Builder.() -> Unit): ValidateE911AddressResponse

Validates an address to be used for 911 calls made with Amazon Chime Voice Connectors. You can use validated addresses in a Presence Information Data Format Location Object file that you include in SIP requests. That helps ensure that addresses are routed to the appropriate Public Safety Answering Point.

Link copied to clipboard
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.