batch_update_attendee_capabilities_except
async
¶
batch_update_attendee_capabilities_except(
meeting_id: GuidString,
excluded_attendee_ids: AttendeeIdsList,
capabilities: AttendeeCapabilities,
*,
config_overrides: Optional[AsyncChimeSDKMeetingsClientConfig] = None,
) -> None
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:Nonewhen you create a meeting, all API requests that includeSendReceive,Send, orReceiveforAttendeeCapabilities:Videowill be rejected withValidationError 400. -
If you specify
MeetingFeatures:Content:MaxResolution:Nonewhen you create a meeting, all API requests that includeSendReceive,Send, orReceiveforAttendeeCapabilities:Contentwill be rejected withValidationError 400. -
You can't set
contentcapabilities toSendReceiveorReceiveunless you also setvideocapabilities toSendReceiveorReceive. If you don't set thevideocapability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set yourvideocapability to receive and you set yourcontentcapability to not receive. -
If meeting features is defined as
Video:MaxResolution:NonebutContent:MaxResolutionis defined as something other thanNoneand attendee capabilities are not defined in the API request, then the default attendee video capability is set toReceiveand attendee content capability is set toSendReceive. This is because contentSendReceiverequires video to be at leastReceive. -
When you change an
audiocapability fromNoneorReceivetoSendorSendReceive, and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants. -
When you change a
videoorcontentcapability fromNoneorReceivetoSendorSendReceive, 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.
Parameters:
-
meeting_id(GuidString) –The ID of the meeting associated with the update request.
-
excluded_attendee_ids(AttendeeIdsList) –The
AttendeeIDsthat you want to exclude from one or more capabilities. -
capabilities(AttendeeCapabilities) –The capabilities (
audio,video, orcontent) that you want to update.
Raises:
-
BadRequestException–The input parameters don't match the service's restrictions.
-
ConflictException–Multiple instances of the same request have been made simultaneously.
-
ForbiddenException–The client is permanently forbidden from making the request.
-
NotFoundException–One or more of the resources in the request does not exist in the system.
-
ServiceFailureException–The service encountered an unexpected error.
-
ServiceUnavailableException–The service is currently unavailable.
-
ThrottlingException–The number of customer requests exceeds the request rate limit.
-
UnauthorizedException–The user isn't authorized to request a resource.
-
UnknownServiceError–The service returned an error code this client does not model.