[ aws . chime-sdk-meetings ]

create-meeting-with-attendees

Description

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 .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-meeting-with-attendees
[--client-request-token <value>]
--media-region <value>
[--meeting-host-id <value>]
--external-meeting-id <value>
[--meeting-features <value>]
[--notifications-configuration <value>]
--attendees <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--client-request-token (string)

The unique identifier for the client request. Use a different token for different meetings.

--media-region (string)

The Region in which to create the meeting.

--meeting-host-id (string)

Reserved.

--external-meeting-id (string)

The external meeting ID.

--meeting-features (structure)

Lists the audio and video features enabled for a meeting, such as echo reduction.

Audio -> (structure)

The configuration settings for the audio features available to a meeting.

EchoReduction -> (string)

Makes echo reduction available to clients who connect to the meeting.

Shorthand Syntax:

Audio={EchoReduction=string}

JSON Syntax:

{
  "Audio": {
    "EchoReduction": "AVAILABLE"|"UNAVAILABLE"
  }
}

--notifications-configuration (structure)

The configuration for resource targets to receive notifications when meeting and attendee events occur.

LambdaFunctionArn -> (string)

The ARN of the AWS Lambda function in the notifications configuration.

SnsTopicArn -> (string)

The ARN of the SNS topic.

SqsQueueArn -> (string)

The ARN of the SQS queue.

Shorthand Syntax:

LambdaFunctionArn=string,SnsTopicArn=string,SqsQueueArn=string

JSON Syntax:

{
  "LambdaFunctionArn": "string",
  "SnsTopicArn": "string",
  "SqsQueueArn": "string"
}

--attendees (list)

The attendee information, including attendees’ IDs and join tokens.

(structure)

The Amazon Chime SDK attendee fields to create, used with the BatchCreateAttendee action.

ExternalUserId -> (string)

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

Shorthand Syntax:

ExternalUserId=string ...

JSON Syntax:

[
  {
    "ExternalUserId": "string"
  }
  ...
]

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

Meeting -> (structure)

The meeting information, including the meeting ID and MediaPlacement .

MeetingId -> (string)

The Amazon Chime SDK meeting ID.

MeetingHostId -> (string)

Reserved.

ExternalMeetingId -> (string)

The external meeting ID.

MediaRegion -> (string)

The Region in which you create the meeting. Available values: af-south-1 , ap-northeast-1 , ap-northeast-2 , ap-south-1 , ap-southeast-1 , ap-southeast-2 , ca-central-1 , eu-central-1 , eu-north-1 , eu-south-1 , eu-west-1 , eu-west-2 , eu-west-3 , sa-east-1 , us-east-1 , us-east-2 , us-west-1 , us-west-2 .

MediaPlacement -> (structure)

The media placement for the meeting.

AudioHostUrl -> (string)

The audio host URL.

AudioFallbackUrl -> (string)

The audio fallback URL.

SignalingUrl -> (string)

The signaling URL.

TurnControlUrl -> (string)

The turn control URL.

ScreenDataUrl -> (string)

The screen data URL.

ScreenViewingUrl -> (string)

The screen viewing URL.

ScreenSharingUrl -> (string)

The screen sharing URL.

EventIngestionUrl -> (string)

The event ingestion URL.

MeetingFeatures -> (structure)

The features available to a meeting, such as Amazon Voice Focus.

Audio -> (structure)

The configuration settings for the audio features available to a meeting.

EchoReduction -> (string)

Makes echo reduction available to clients who connect to the meeting.

Attendees -> (list)

The attendee information, including attendees’ IDs and join tokens.

(structure)

An Amazon Chime SDK meeting attendee. Includes a unique AttendeeId and JoinToken . The JoinToken allows a client to authenticate and join as the specified attendee. The JoinToken expires when the meeting ends, or when DeleteAttendee is called. After that, the attendee is unable to join the meeting.

We recommend securely transferring each JoinToken from your server application to the client so that no other client has access to the token except for the one authorized to represent the attendee.

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.

Errors -> (list)

If the action fails for one or more of the attendees in the request, a list of the attendees is returned, along with error codes and error messages.

(structure)

The list of errors returned when errors are encountered during the BatchCreateAttendee and CreateAttendee actions. This includes external user IDs, error codes, and error messages.

ExternalUserId -> (string)

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

ErrorCode -> (string)

The error code.

ErrorMessage -> (string)

The error message.