create-meeting¶
Description¶
Creates a new Amazon Chime SDK meeting in the specified media Region with no initial 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
[--client-request-token <value>]
[--external-meeting-id <value>]
[--meeting-host-id <value>]
[--media-region <value>]
[--tags <value>]
[--notifications-configuration <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.
--external-meeting-id (string)
The external meeting ID.
--meeting-host-id (string)
Reserved.
--media-region (string)
The Region in which to create the meeting. Default:
us-east-1.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.
--tags (list)
The tag key-value pairs.
(structure)
Describes a tag applied to a resource.
Key -> (string)
The key of the tag.
Value -> (string)
The value of the tag.
Shorthand Syntax:
Key=string,Value=string ...
JSON Syntax:
[
{
"Key": "string",
"Value": "string"
}
...
]
--notifications-configuration (structure)
The configuration for resource targets to receive notifications when meeting and attendee events occur.
SnsTopicArn -> (string)
The SNS topic ARN.
SqsQueueArn -> (string)
The SQS queue ARN.
Shorthand Syntax:
SnsTopicArn=string,SqsQueueArn=string
JSON Syntax:
{
"SnsTopicArn": "string",
"SqsQueueArn": "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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
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.
ExternalMeetingId -> (string)
The external meeting ID.
MediaPlacement -> (structure)
The media placement for the meeting.
AudioHostUrl -> (string)
The audio host URL.
AudioFallbackUrl -> (string)
The audio fallback URL.
ScreenDataUrl -> (string)
The screen data URL.
ScreenSharingUrl -> (string)
The screen sharing URL.
ScreenViewingUrl -> (string)
The screen viewing URL.
SignalingUrl -> (string)
The signaling URL.
TurnControlUrl -> (string)
The turn control URL.
EventIngestionUrl -> (string)
The event ingestion URL to which you send client meeting events.
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.