Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

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 SDK Developer Guide . For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.

Important

This API is no longer supported and will not be updated. We recommend using the latest version, CreateMeeting, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Request Syntax


POST /meetings HTTP/1.1
Content-type: application/json

{
   "ClientRequestToken": "string",
   "ExternalMeetingId": "string",
   "MediaRegion": "string",
   "MeetingHostId": "string",
   "NotificationsConfiguration": { 
      "SnsTopicArn": "string",
      "SqsQueueArn": "string"
   },
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "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: No

MediaRegion

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 .

Type: String

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: MeetingNotificationConfiguration object

Required: No

Tags

The tag key-value pairs.

Type: Array of Tag objects

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Required: No

Response Syntax


HTTP/1.1 201
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",
      "MeetingId": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 201 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

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401