aws-elixir

View Source AWS.ChimeSDKMeetings (aws-elixir v1.0.4)

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.

Link to this section Summary

Functions

batch_create_attendee(client, meeting_id, input, options \\ [])

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

batch_update_attendee_capabilities_except(client, meeting_id, input, options \\ [])

Updates AttendeeCapabilities except the capabilities listed in an ExcludedAttendeeIds table.

create_attendee(client, meeting_id, input, options \\ [])

Creates a new attendee for an active Amazon Chime SDK meeting.

create_meeting(client, input, options \\ [])

Creates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees.

create_meeting_with_attendees(client, input, options \\ [])

Creates a new Amazon Chime SDK meeting in the specified media Region, with attendees.

delete_attendee(client, attendee_id, meeting_id, input, options \\ [])

Deletes an attendee from the specified Amazon Chime SDK meeting and deletes their JoinToken.

delete_meeting(client, meeting_id, input, options \\ [])

Deletes the specified Amazon Chime SDK meeting.

get_attendee(client, attendee_id, meeting_id, options \\ [])

Gets the Amazon Chime SDK attendee details for a specified meeting ID and attendee ID.

get_meeting(client, meeting_id, options \\ [])

Gets the Amazon Chime SDK meeting details for the specified meeting ID.

list_attendees(client, meeting_id, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the attendees for the specified Amazon Chime SDK meeting.

list_tags_for_resource(client, resource_arn, options \\ [])

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

metadata()
start_meeting_transcription(client, meeting_id, input, options \\ [])

Starts transcription for the specified meetingId.

stop_meeting_transcription(client, meeting_id, input, options \\ [])

Stops transcription for the specified meetingId.

tag_resource(client, input, options \\ [])

The resource that supports tags.

untag_resource(client, input, options \\ [])

Removes the specified tags from the specified resources.

update_attendee_capabilities(client, attendee_id, meeting_id, input, options \\ [])

The capabilities that you want to update.

Link to this section Functions

Link to this function

batch_create_attendee(client, meeting_id, input, options \\ [])

View Source

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 to this function

batch_update_attendee_capabilities_except(client, meeting_id, input, options \\ [])

View Source

Updates AttendeeCapabilities except the capabilities listed in an ExcludedAttendeeIds table.

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:

* If you specify MeetingFeatures:Video:MaxResolution:None when you create a meeting, all API requests that include SendReceive, Send, or Receive for AttendeeCapabilities:Video will be rejected with ValidationError 400.

* If you specify MeetingFeatures:Content:MaxResolution:None when you create a meeting, all API requests that include SendReceive, Send, or Receive for AttendeeCapabilities:Content will be rejected with ValidationError 400.

* 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 attendees can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.

Link to this function

create_attendee(client, meeting_id, input, options \\ [])

View Source

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 to this function

create_meeting(client, input, options \\ [])

View Source

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 to this function

create_meeting_with_attendees(client, input, options \\ [])

View Source

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 to this function

delete_attendee(client, attendee_id, meeting_id, input, options \\ [])

View Source

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 to this function

delete_meeting(client, meeting_id, input, options \\ [])

View Source

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 to this function

get_attendee(client, attendee_id, meeting_id, options \\ [])

View Source

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 to this function

get_meeting(client, meeting_id, options \\ [])

View Source

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 to this function

list_attendees(client, meeting_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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 to this function

list_tags_for_resource(client, resource_arn, options \\ [])

View Source

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

Link to this function

metadata()

View Source
Link to this function

start_meeting_transcription(client, meeting_id, input, options \\ [])

View Source

Starts transcription for the specified meetingId.

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

If you specify an invalid configuration, a TranscriptFailed event will be sent with the contents of the BadRequestException generated by Amazon Transcribe. For more information on each parameter and which combinations are valid, refer to the StartStreamTranscription API in the Amazon Transcribe Developer Guide.

By default, Amazon Transcribe may use and store audio content processed by the service to develop and improve Amazon Web Services AI/ML services as further described in section 50 of the Amazon Web Services Service Terms. Using Amazon Transcribe may be subject to federal and state laws or regulations regarding the recording or interception of electronic communications. It is your and your end users’ responsibility to comply with all applicable laws regarding the recording, including properly notifying all participants in a recorded session or communication that the session or communication is being recorded, and obtaining all necessary consents. You can opt out from Amazon Web Services using audio content to develop and improve AWS AI/ML services by configuring an AI services opt out policy using Amazon Web Services Organizations.

Link to this function

stop_meeting_transcription(client, meeting_id, input, options \\ [])

View Source

Stops transcription for the specified meetingId.

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

By default, Amazon Transcribe may use and store audio content processed by the service to develop and improve Amazon Web Services AI/ML services as further described in section 50 of the Amazon Web Services Service Terms. Using Amazon Transcribe may be subject to federal and state laws or regulations regarding the recording or interception of electronic communications. It is your and your end users’ responsibility to comply with all applicable laws regarding the recording, including properly notifying all participants in a recorded session or communication that the session or communication is being recorded, and obtaining all necessary consents. You can opt out from Amazon Web Services using audio content to develop and improve Amazon Web Services AI/ML services by configuring an AI services opt out policy using Amazon Web Services Organizations.

Link to this function

tag_resource(client, input, options \\ [])

View Source

The resource that supports tags.

Link to this function

untag_resource(client, input, options \\ [])

View Source

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 Amazon Web Services Region for the calling Amazon Web Services account.

minimum-permissions

 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

Link to this function

update_attendee_capabilities(client, attendee_id, meeting_id, input, options \\ [])

View Source

The capabilities that you want to update.

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:

* If you specify MeetingFeatures:Video:MaxResolution:None when you create a meeting, all API requests that include SendReceive, Send, or Receive for AttendeeCapabilities:Video will be rejected with ValidationError 400.

* If you specify MeetingFeatures:Content:MaxResolution:None when you create a meeting, all API requests that include SendReceive, Send, or Receive for AttendeeCapabilities:Content will be rejected with ValidationError 400.

* 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 attendees can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.