[ aws . chime-sdk-meetings ]

create-attendee

Description

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 .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-attendee
--meeting-id <value>
--external-user-id <value>
[--capabilities <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--meeting-id (string)

The unique ID of the meeting.

--external-user-id (string)

The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.

--capabilities (structure)

The capabilities (audio , video , or content ) that you want to grant an attendee. If you don’t specify capabilities, all users have send and receive capabilities on all media channels by default.

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 | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

Attendee -> (structure)

The attendee information, including attendee ID and join token.

ExternalUserId -> (string)

The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.

AttendeeId -> (string)

The Amazon Chime SDK attendee ID.

JoinToken -> (string)

The join token used by the Amazon Chime SDK attendee.

Capabilities -> (structure)

The capabilities (audio, video, or content) assigned to an attendee.

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.