chimesdkmeetings/aws.sdk.kotlin.services.chimesdkmeetings/ChimeSdkMeetingsClient

ChimeSdkMeetingsClient

interface ChimeSdkMeetingsClient : SdkClient

The Amazon Chime SDK meetings APIs in this section allow software developers to create Amazon Chime SDK meetings, set the Amazon Web Services Regions for meetings, create and manage users, and send and receive meeting notifications. For more information about the meeting APIs, see Amazon Chime SDK meetings.

Properties

Link copied to clipboard
abstract override val config: ChimeSdkMeetingsClient.Config

ChimeSdkMeetingsClient's configuration

Functions

Link copied to clipboard
abstract suspend fun batchCreateAttendee(input: BatchCreateAttendeeRequest): BatchCreateAttendeeResponse

Creates up to 100 attendees 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 Developer Guide.

Link copied to clipboard
abstract suspend fun batchUpdateAttendeeCapabilitiesExcept(input: BatchUpdateAttendeeCapabilitiesExceptRequest): BatchUpdateAttendeeCapabilitiesExceptResponse

Updates AttendeeCapabilities except the capabilities listed in an ExcludedAttendeeIds table.

Link copied to clipboard
abstract suspend fun createAttendee(input: CreateAttendeeRequest): 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 Developer Guide.

Link copied to clipboard
abstract suspend fun createMeeting(input: CreateMeetingRequest): 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 Developer Guide. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.

Link copied to clipboard
abstract suspend fun createMeetingWithAttendees(input: CreateMeetingWithAttendeesRequest): 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 Developer Guide. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.

Link copied to clipboard
abstract suspend fun deleteAttendee(input: DeleteAttendeeRequest): 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 Developer Guide.

Link copied to clipboard
abstract suspend fun deleteMeeting(input: DeleteMeetingRequest): 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 Developer Guide.

Link copied to clipboard
abstract suspend fun getAttendee(input: GetAttendeeRequest): 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 Developer Guide.

Link copied to clipboard
abstract suspend fun getMeeting(input: GetMeetingRequest): GetMeetingResponse

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

Link copied to clipboard
abstract suspend fun listAttendees(input: ListAttendeesRequest): 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 Developer Guide.

Link copied to clipboard
abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

Returns a list of the tags available for the specified resource.

Link copied to clipboard
abstract suspend fun startMeetingTranscription(input: StartMeetingTranscriptionRequest): 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
abstract suspend fun stopMeetingTranscription(input: StopMeetingTranscriptionRequest): StopMeetingTranscriptionResponse

Stops 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
abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

The resource that supports tags.

Link copied to clipboard
abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

Removes the specified tags from the specified resources. When you specify a tag key, the action removes both that key and its associated value. The operation succeeds even if you attempt to remove tags from a resource that were already removed. Note the following:

Link copied to clipboard
abstract suspend fun updateAttendeeCapabilities(input: UpdateAttendeeCapabilitiesRequest): UpdateAttendeeCapabilitiesResponse

The capabilities that you want to update.

Inherited functions

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

Creates up to 100 attendees 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 Developer Guide.

Link copied to clipboard
inline suspend fun ChimeSdkMeetingsClient.batchUpdateAttendeeCapabilitiesExcept(crossinline block: BatchUpdateAttendeeCapabilitiesExceptRequest.Builder.() -> Unit): BatchUpdateAttendeeCapabilitiesExceptResponse

Updates AttendeeCapabilities except the capabilities listed in an ExcludedAttendeeIds table.

Link copied to clipboard
expect abstract fun close()
Link copied to clipboard
inline suspend fun ChimeSdkMeetingsClient.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 Developer Guide.

Link copied to clipboard
inline suspend fun ChimeSdkMeetingsClient.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 Developer Guide. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.

Link copied to clipboard
inline suspend fun ChimeSdkMeetingsClient.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 Developer Guide. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.

Link copied to clipboard
inline suspend fun ChimeSdkMeetingsClient.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 Developer Guide.

Link copied to clipboard
inline suspend fun ChimeSdkMeetingsClient.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 Developer Guide.

Link copied to clipboard
inline suspend fun ChimeSdkMeetingsClient.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 Developer Guide.

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

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

Link copied to clipboard
inline suspend fun ChimeSdkMeetingsClient.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 Developer Guide.

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

Returns a list of the tags available for the specified resource.

Link copied to clipboard
inline suspend fun ChimeSdkMeetingsClient.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 ChimeSdkMeetingsClient.stopMeetingTranscription(crossinline block: StopMeetingTranscriptionRequest.Builder.() -> Unit): StopMeetingTranscriptionResponse

Stops 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 ChimeSdkMeetingsClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

The resource that supports tags.

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

Removes the specified tags from the specified resources. When you specify a tag key, the action removes both that key and its associated value. The operation succeeds even if you attempt to remove tags from a resource that were already removed. Note the following:

Link copied to clipboard
inline suspend fun ChimeSdkMeetingsClient.updateAttendeeCapabilities(crossinline block: UpdateAttendeeCapabilitiesRequest.Builder.() -> Unit): UpdateAttendeeCapabilitiesResponse

The capabilities that you want to update.

Link copied to clipboard
fun ChimeSdkMeetingsClient.withConfig(block: ChimeSdkMeetingsClient.Config.Builder.() -> Unit): ChimeSdkMeetingsClient

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.