Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

ChimeSDKMeetings

import { ChimeSDKMeetings } from "https://aws-api.deno.dev/v0.4/services/chimesdkmeetings.ts?docs=full";
class ChimeSDKMeetings {
constructor(apiFactory: client.ApiFactory);
async batchCreateAttendee(params: BatchCreateAttendeeRequest, opts?: client.RequestOptions): Promise<BatchCreateAttendeeResponse>;
async batchUpdateAttendeeCapabilitiesExcept(params: BatchUpdateAttendeeCapabilitiesExceptRequest, opts?: client.RequestOptions): Promise<void>;
async createAttendee(params: CreateAttendeeRequest, opts?: client.RequestOptions): Promise<CreateAttendeeResponse>;
async createMeeting(params: CreateMeetingRequest, opts?: client.RequestOptions): Promise<CreateMeetingResponse>;
async createMeetingWithAttendees(params: CreateMeetingWithAttendeesRequest, opts?: client.RequestOptions): Promise<CreateMeetingWithAttendeesResponse>;
async deleteAttendee(params: DeleteAttendeeRequest, opts?: client.RequestOptions): Promise<void>;
async deleteMeeting(params: DeleteMeetingRequest, opts?: client.RequestOptions): Promise<void>;
async getAttendee(params: GetAttendeeRequest, opts?: client.RequestOptions): Promise<GetAttendeeResponse>;
async getMeeting(params: GetMeetingRequest, opts?: client.RequestOptions): Promise<GetMeetingResponse>;
async listAttendees(params: ListAttendeesRequest, opts?: client.RequestOptions): Promise<ListAttendeesResponse>;
async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>;
async startMeetingTranscription(params: StartMeetingTranscriptionRequest, opts?: client.RequestOptions): Promise<void>;
async stopMeetingTranscription(params: StopMeetingTranscriptionRequest, opts?: client.RequestOptions): Promise<void>;
async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;
async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;
async updateAttendeeCapabilities(params: UpdateAttendeeCapabilitiesRequest, opts?: client.RequestOptions): Promise<UpdateAttendeeCapabilitiesResponse>;
 
static ApiMetadata: client.ApiMetadata;
}

§Constructors

§
new ChimeSDKMeetings(apiFactory: client.ApiFactory)
[src]

§Methods

§
batchCreateAttendee(params: BatchCreateAttendeeRequest, opts?: client.RequestOptions): Promise<BatchCreateAttendeeResponse>
[src]

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.

§
batchUpdateAttendeeCapabilitiesExcept(params: BatchUpdateAttendeeCapabilitiesExceptRequest, opts?: client.RequestOptions): Promise<void>
[src]

Updates AttendeeCapabilities except the capabilities listed in an ExcludedAttendeeIds table.

Note: You use the capabilities with a set of values that control what the capabilities can do, such as SendReceive data. For more information about those values, see .

When using capabilities, be aware of these corner cases:

  • You can't set content capabilities to SendReceive or Receive unless you also set video capabilities to SendReceive or Receive. If you don't set the video capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set your video capability to receive and you set your content capability to not receive.
  • When you change an audio capability from None or Receive to Send or SendReceive , and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants.
  • When you change a video or content capability from None or Receive to Send or SendReceive , and if the attendee turned on their video or content streams, remote attendess can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.
§
createAttendee(params: CreateAttendeeRequest, opts?: client.RequestOptions): Promise<CreateAttendeeResponse>
[src]

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.

§
createMeeting(params: CreateMeetingRequest, opts?: client.RequestOptions): Promise<CreateMeetingResponse>
[src]

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.

§
createMeetingWithAttendees(params: CreateMeetingWithAttendeesRequest, opts?: client.RequestOptions): Promise<CreateMeetingWithAttendeesResponse>
[src]

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.

§
deleteAttendee(params: DeleteAttendeeRequest, opts?: client.RequestOptions): Promise<void>
[src]

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.

§
deleteMeeting(params: DeleteMeetingRequest, opts?: client.RequestOptions): Promise<void>
[src]

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.

§
getAttendee(params: GetAttendeeRequest, opts?: client.RequestOptions): Promise<GetAttendeeResponse>
[src]

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.

§
getMeeting(params: GetMeetingRequest, opts?: client.RequestOptions): Promise<GetMeetingResponse>
[src]

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.

§
listAttendees(params: ListAttendeesRequest, opts?: client.RequestOptions): Promise<ListAttendeesResponse>
[src]

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.

§
listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>
[src]

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

§
startMeetingTranscription(params: StartMeetingTranscriptionRequest, opts?: client.RequestOptions): Promise<void>
[src]

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

! IMPORTANT: ! Amazon Chime SDK live transcription is powered by Amazon Transcribe. ! Use of Amazon Transcribe is subject to the AWS Service Terms, including the terms specific to the AWS Machine Learning and Artificial Intelligence Services.

§
stopMeetingTranscription(params: StopMeetingTranscriptionRequest, opts?: client.RequestOptions): Promise<void>
[src]

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

! IMPORTANT: ! Amazon Chime SDK live transcription is powered by Amazon Transcribe. ! Use of Amazon Transcribe is subject to the AWS Service Terms, including the terms specific to the AWS Machine Learning and Artificial Intelligence Services.

§
tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>
[src]

The resource that supports tags.

§
untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>
[src]

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:

  • To remove tags from a resource, you need the necessary permissions for the service that the resource belongs to as well as permissions for removing tags. For more information, see the documentation for the service whose resource you want to untag.
  • You can only tag resources that are located in the specified AWS Region for the calling AWS account.

Minimum permissions

In addition to the tag:UntagResources permission required by this operation, you must also have the remove tags permission defined by the service that created the resource. For example, to remove the tags from an Amazon EC2 instance using the UntagResources operation, you must have both of the following permissions:

tag:UntagResource

ChimeSDKMeetings:DeleteTags
§
updateAttendeeCapabilities(params: UpdateAttendeeCapabilitiesRequest, opts?: client.RequestOptions): Promise<UpdateAttendeeCapabilitiesResponse>
[src]

The capabilties that you want to update.

Note: You use the capabilities with a set of values that control what the capabilities can do, such as SendReceive data. For more information about those values, see .

When using capabilities, be aware of these corner cases:

  • You can't set content capabilities to SendReceive or Receive unless you also set video capabilities to SendReceive or Receive. If you don't set the video capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set your video capability to receive and you set your content capability to not receive.
  • When you change an audio capability from None or Receive to Send or SendReceive , and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants.
  • When you change a video or content capability from None or Receive to Send or SendReceive , and if the attendee turned on their video or content streams, remote attendess can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.

§Static Properties