CreateMeetingWithAttendees
Creates a new Amazon Chime SDK meeting in the specified media Region, with attendees. For more information about specifying media Regions, see Available Regions and Using meeting Regions, both 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.
Note
If you use this API in conjuction with the AudioFeatures and VideoFeatures APIs, and you don't specify the
MeetingFeatures.Content.MaxResolution or MeetingFeatures.Video.MaxResolution parameters, the following defaults are used:
-
Content.MaxResolution: FHD
-
Video.MaxResolution: HD
Request Syntax
POST /meetings?operation=create-attendees HTTP/1.1
Content-type: application/json
{
"Attendees": [
{
"Capabilities": {
"Audio": "string",
"Content": "string",
"Video": "string"
},
"ExternalUserId": "string"
}
],
"ClientRequestToken": "string",
"ExternalMeetingId": "string",
"MediaRegion": "string",
"MeetingFeatures": {
"Attendee": {
"MaxCount": number
},
"Audio": {
"EchoReduction": "string"
},
"Content": {
"MaxResolution": "string"
},
"Video": {
"MaxResolution": "string"
}
},
"MeetingHostId": "string",
"NotificationsConfiguration": {
"LambdaFunctionArn": "string",
"SnsTopicArn": "string",
"SqsQueueArn": "string"
},
"PrimaryMeetingId": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"TenantIds": [ "string" ]
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- Attendees
-
The attendee information, including attendees' IDs and join tokens.
Type: Array of CreateAttendeeRequestItem objects
Array Members: Minimum number of 1 item. Maximum number of 20 items.
Required: Yes
- 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.
Pattern:
[-_&@+=,(){}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*Values that begin with
aws:are reserved. You can't configure a value that uses this prefix. Case insensitive.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
- PrimaryMeetingId
-
When specified, replicates the media from the primary meeting to the new meeting.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 64.
Required: No
- Tags
-
The tags in the request.
Type: Array of Tag objects
Array Members: Minimum number of 0 items. Maximum number of 50 items.
Required: No
- TenantIds
-
A consistent and opaque identifier, created and maintained by the builder to represent a segment of their users.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 5 items.
Length Constraints: Minimum length of 2. Maximum length of 256.
Pattern:
^(?!.*?(.)\1{3})[-_!@#$a-zA-Z0-9]*$Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"Attendees": [
{
"AttendeeId": "string",
"Capabilities": {
"Audio": "string",
"Content": "string",
"Video": "string"
},
"ExternalUserId": "string",
"JoinToken": "string"
}
],
"Errors": [
{
"ErrorCode": "string",
"ErrorMessage": "string",
"ExternalUserId": "string"
}
],
"Meeting": {
"ExternalMeetingId": "string",
"MediaPlacement": {
"AudioFallbackUrl": "string",
"AudioHostUrl": "string",
"EventIngestionUrl": "string",
"ScreenDataUrl": "string",
"ScreenSharingUrl": "string",
"ScreenViewingUrl": "string",
"SignalingUrl": "string",
"TurnControlUrl": "string"
},
"MediaRegion": "string",
"MeetingArn": "string",
"MeetingFeatures": {
"Attendee": {
"MaxCount": number
},
"Audio": {
"EchoReduction": "string"
},
"Content": {
"MaxResolution": "string"
},
"Video": {
"MaxResolution": "string"
}
},
"MeetingHostId": "string",
"MeetingId": "string",
"PrimaryMeetingId": "string",
"TenantIds": [ "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.
- Attendees
-
The attendee information, including attendees' IDs and join tokens.
Type: Array of Attendee objects
- Errors
-
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.
Type: Array of CreateAttendeeError objects
- 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
- ConflictException
-
Multiple instances of the same request have been made simultaneously.
HTTP Status Code: 409
- ForbiddenException
-
The client is permanently forbidden from making the request.
HTTP Status Code: 403
- LimitExceededException
-
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
- ThrottlingException
-
The number of customer requests exceeds the request rate limit.
HTTP Status Code: 429
- 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:
