CreateMeeting - Amazon Chime

CreateMeeting

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.

Request Syntax

POST /meetings HTTP/1.1 Content-type: application/json { "ClientRequestToken": "string", "ExternalMeetingId": "string", "MediaRegion": "string", "MeetingFeatures": { "Audio": { "EchoReduction": "string" } }, "MeetingHostId": "string", "NotificationsConfiguration": { "LambdaFunctionArn": "string", "SnsTopicArn": "string", "SqsQueueArn": "string" } }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

ClientRequestToken

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

Type: String

Length Constraints: Minimum length of 2. Maximum length of 64.

Pattern: [-_a-zA-Z0-9]*

Required: Yes

ExternalMeetingId

The external meeting ID.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 64.

Required: Yes

MediaRegion

The Region in which to 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.

Available values in AWS GovCloud (US) Regions: us-gov-east-1, us-gov-west-1.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 64.

Required: Yes

MeetingFeatures

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

Type: MeetingFeaturesConfiguration object

Required: No

MeetingHostId

Reserved.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 64.

Required: No

NotificationsConfiguration

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

Type: NotificationsConfiguration object

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "Meeting": { "ExternalMeetingId": "string", "MediaPlacement": { "AudioFallbackUrl": "string", "AudioHostUrl": "string", "EventIngestionUrl": "string", "ScreenDataUrl": "string", "ScreenSharingUrl": "string", "ScreenViewingUrl": "string", "SignalingUrl": "string", "TurnControlUrl": "string" }, "MediaRegion": "string", "MeetingFeatures": { "Audio": { "EchoReduction": "string" } }, "MeetingHostId": "string", "MeetingId": "string" } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Meeting

The meeting information, including the meeting ID and MediaPlacement.

Type: Meeting object

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

LimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

UnauthorizedException

The user isn't authorized to request a resource.

HTTP Status Code: 401

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: