AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
[ aws . chime-sdk-meetings ]
Updates AttendeeCapabilities
except the capabilities listed in an ExcludedAttendeeIds
table.
SendReceive
data. For more information about those values, see .When using capabilities, be aware of these corner cases:
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
.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
.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.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.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.See also: AWS API Documentation
batch-update-attendee-capabilities-except
--meeting-id <value>
--excluded-attendee-ids <value>
--capabilities <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
--meeting-id
(string)
The ID of the meeting associated with the update request.
--excluded-attendee-ids
(list)
The
AttendeeIDs
that you want to exclude from one or more capabilities.(structure)
A structure that contains one or more attendee IDs.
AttendeeId -> (string)
A list of one or more attendee IDs.
Shorthand Syntax:
AttendeeId=string ...
JSON Syntax:
[
{
"AttendeeId": "string"
}
...
]
--capabilities
(structure)
The capabilities (
audio
,video
, orcontent
) that you want to update.Audio -> (string)
The audio capability assigned to an attendee.Video -> (string)
The video capability assigned to an attendee.Content -> (string)
The content capability assigned to an attendee.
Shorthand Syntax:
Audio=string,Video=string,Content=string
JSON Syntax:
{
"Audio": "SendReceive"|"Send"|"Receive"|"None",
"Video": "SendReceive"|"Send"|"Receive"|"None",
"Content": "SendReceive"|"Send"|"Receive"|"None"
}
--cli-input-json
(string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command's default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output
(string)
The formatting style for command output.
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
None