BatchUpdateAttendeeCapabilitiesExcept - Amazon Chime SDK

BatchUpdateAttendeeCapabilitiesExcept

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 AttendeeCapabilities.

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.

Request Syntax

PUT /meetings/MeetingId/attendees/capabilities?operation=batch-update-except HTTP/1.1 Content-type: application/json { "Capabilities": { "Audio": "string", "Content": "string", "Video": "string" }, "ExcludedAttendeeIds": [ { "AttendeeId": "string" } ] }

URI Request Parameters

The request uses the following URI parameters.

MeetingId

The ID of the meeting associated with the update request.

Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

Required: Yes

Request Body

The request accepts the following data in JSON format.

Capabilities

The capabilities (audio, video, or content) that you want to update.

Type: AttendeeCapabilities object

Required: Yes

ExcludedAttendeeIds

The AttendeeIDs that you want to exclude from one or more capabilities.

Type: Array of AttendeeIdItem objects

Array Members: Minimum number of 1 item. Maximum number of 250 items.

Required: Yes

Response Syntax

HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ConflictException

Multiple instances of the same request have been made simultaneously.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

UnauthorizedException

The user isn't authorized to request a resource.

HTTP Status Code: 401

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: