Every API here is available over the APIs.io API and to AI agents over MCP.
openapi: 3.1.0
info:
title: Amazon Chime SDK Meetings Meetings API
version: '2021-07-15'
description: Generated from AWS's published Smithy model for Amazon Chime SDK Meetings. 4 operation(s).
contact:
name: Amazon Web Services
url: https://aws.amazon.com/contact-us/
license:
name: Apache 2.0
identifier: Apache-2.0
url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://meetings-chime.{region}.amazonaws.com
variables:
region:
default: us-east-1
security:
- sigv4: []
paths:
/meetings:
post:
operationId: CreateMeeting
summary: 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 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. If you use this API in conjuction with the and 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'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateMeetingResponse'
'400':
description: BadRequestException; LimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
'409':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'403':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
'500':
description: ServiceFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceFailureException'
'503':
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailableException'
'429':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'401':
description: UnauthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateMeetingRequest'
tags:
- Meetings
/meetings?operation=create-attendees:
post:
operationId: CreateMeetingWithAttendees
summary: 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 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. If you use this API in conjuction with the and 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'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateMeetingWithAttendeesResponse'
'400':
description: BadRequestException; LimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
'409':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'403':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
'500':
description: ServiceFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceFailureException'
'503':
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailableException'
'429':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'401':
description: UnauthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateMeetingWithAttendeesRequest'
tags:
- Meetings
/meetings/{MeetingId}:
delete:
operationId: DeleteMeeting
summary: Delete Meeting
description: Deletes the specified Amazon Chime SDK meeting. The operation deletes all attendees, disconnects all clients,
and prevents new clients from joining the meeting. For more information about the Amazon Chime SDK, see Using the
Amazon Chime SDK in the Amazon Chime Developer Guide.
responses:
'200':
description: Success
content:
application/json:
schema:
type: string
'400':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
'403':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
'404':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
'500':
description: ServiceFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceFailureException'
'503':
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailableException'
'429':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'401':
description: UnauthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteMeetingRequest'
tags:
- Meetings
get:
operationId: GetMeeting
summary: Get Meeting
description: Gets the Amazon Chime SDK meeting details for the specified meeting ID. For more information about the
Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetMeetingResponse'
'400':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
'403':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
'404':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
'500':
description: ServiceFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceFailureException'
'503':
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailableException'
'429':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'401':
description: UnauthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GetMeetingRequest'
tags:
- Meetings
components:
securitySchemes:
sigv4:
type: apiKey
in: header
name: Authorization
description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
x-aws-sigv4:
signingName: chime
schemas:
Attendee:
type: object
properties:
ExternalUserId:
type: string
description: 'The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed
by a builder application. 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.'
AttendeeId:
type: string
description: The Amazon Chime SDK attendee ID.
JoinToken:
type: string
description: The join token used by the Amazon Chime SDK attendee.
Capabilities:
$ref: '#/components/schemas/AttendeeCapabilities'
AttendeeCapabilities:
type: object
properties:
Audio:
type: string
enum:
- SendReceive
- Send
- Receive
- None
description: The audio capability assigned to an attendee.
Video:
type: string
enum:
- SendReceive
- Send
- Receive
- None
description: The video capability assigned to an attendee.
Content:
type: string
enum:
- SendReceive
- Send
- Receive
- None
description: The content capability assigned to an attendee.
required:
- Audio
- Video
- Content
AttendeeFeatures:
type: object
properties:
MaxCount:
type: integer
description: The maximum number of attendees allowed into the meeting.
AudioFeatures:
type: object
properties:
EchoReduction:
type: string
enum:
- AVAILABLE
- UNAVAILABLE
description: Makes echo reduction available to clients who connect to the meeting.
BadRequestException:
type: object
properties:
Code:
type: string
Message:
type: string
RequestId:
type: string
description: The request id associated with the call responsible for the exception.
ConflictException:
type: object
properties:
Code:
type: string
Message:
type: string
RequestId:
type: string
description: The ID of the request involved in the conflict.
ContentFeatures:
type: object
properties:
MaxResolution:
type: string
enum:
- None
- FHD
- UHD
description: The maximum resolution for the meeting content. Defaults to FHD. To use UHD, you must also provide
a MeetingFeatures:Attendee:MaxCount value and override the default size limit of 250 attendees.
CreateAttendeeError:
type: object
properties:
ExternalUserId:
type: string
description: 'The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed
by a builder application. 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.'
ErrorCode:
type: string
description: The error code.
ErrorMessage:
type: string
description: The error message.
CreateAttendeeRequestItem:
type: object
properties:
ExternalUserId:
type: string
description: 'The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed
by a builder application. 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.'
Capabilities:
$ref: '#/components/schemas/AttendeeCapabilities'
required:
- ExternalUserId
CreateMeetingRequest:
type: object
properties:
ClientRequestToken:
type: string
description: The unique identifier for the client request. Use a different token for different meetings.
MediaRegion:
type: string
description: '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 Amazon Web Services GovCloud
(US) Regions: us-gov-east-1, us-gov-west-1.'
MeetingHostId:
type: string
description: Reserved.
ExternalMeetingId:
type: string
description: '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.'
NotificationsConfiguration:
$ref: '#/components/schemas/NotificationsConfiguration'
MeetingFeatures:
$ref: '#/components/schemas/MeetingFeaturesConfiguration'
PrimaryMeetingId:
type: string
description: When specified, replicates the media from the primary meeting to the new meeting.
TenantIds:
type: array
items:
type: string
description: A consistent and opaque identifier, created and maintained by the builder to represent a segment of
their users.
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: 'Applies one or more tags to an Amazon Chime SDK meeting. Note the following: Not all resources have
tags. For a list of services with resources that support tagging using this operation, see Services that support
the Resource Groups Tagging API. If the resource doesn''t yet support this operation, the resource''s service
might support tagging using its own API operations. For more information, refer to the documentation for that
service. Each resource can have up to 50 tags. For other limits, see Tag Naming and Usage Conventions in the AWS
General Reference. You can only tag resources that are l'
MediaPlacementNetworkType:
type: string
enum:
- Ipv4Only
- DualStack
description: The type of network for the media placement. Either IPv4 only or dual-stack (IPv4 and IPv6).
required:
- ClientRequestToken
- MediaRegion
- ExternalMeetingId
CreateMeetingResponse:
type: object
properties:
Meeting:
$ref: '#/components/schemas/Meeting'
CreateMeetingWithAttendeesRequest:
type: object
properties:
ClientRequestToken:
type: string
description: The unique identifier for the client request. Use a different token for different meetings.
MediaRegion:
type: string
description: '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 Amazon Web Services GovCloud
(US) Regions: us-gov-east-1, us-gov-west-1.'
MeetingHostId:
type: string
description: Reserved.
ExternalMeetingId:
type: string
description: '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.'
MeetingFeatures:
$ref: '#/components/schemas/MeetingFeaturesConfiguration'
NotificationsConfiguration:
$ref: '#/components/schemas/NotificationsConfiguration'
Attendees:
type: array
items:
$ref: '#/components/schemas/CreateAttendeeRequestItem'
description: The attendee information, including attendees' IDs and join tokens.
PrimaryMeetingId:
type: string
description: When specified, replicates the media from the primary meeting to the new meeting.
TenantIds:
type: array
items:
type: string
description: A consistent and opaque identifier, created and maintained by the builder to represent a segment of
their users.
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: The tags in the request.
MediaPlacementNetworkType:
type: string
enum:
- Ipv4Only
- DualStack
description: The type of network for the media placement. Either IPv4 only or dual-stack (IPv4 and IPv6).
required:
- ClientRequestToken
- MediaRegion
- ExternalMeetingId
- Attendees
CreateMeetingWithAttendeesResponse:
type: object
properties:
Meeting:
$ref: '#/components/schemas/Meeting'
Attendees:
type: array
items:
$ref: '#/components/schemas/Attendee'
description: The attendee information, including attendees' IDs and join tokens.
Errors:
type: array
items:
$ref: '#/components/schemas/CreateAttendeeError'
description: 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.
DeleteMeetingRequest:
type: object
properties:
MeetingId:
type: string
description: The Amazon Chime SDK meeting ID.
required:
- MeetingId
ForbiddenException:
type: object
properties:
Code:
type: string
Message:
type: string
RequestId:
type: string
description: The request id associated with the call responsible for the exception.
GetMeetingRequest:
type: object
properties:
MeetingId:
type: string
description: The Amazon Chime SDK meeting ID.
required:
- MeetingId
GetMeetingResponse:
type: object
properties:
Meeting:
$ref: '#/components/schemas/Meeting'
MediaPlacement:
type: object
properties:
AudioHostUrl:
type: string
description: The audio host URL.
AudioFallbackUrl:
type: string
description: The audio fallback URL.
SignalingUrl:
type: string
description: The signaling URL.
TurnControlUrl:
type: string
description: The turn control URL. This parameter is deprecated and no longer used by the Amazon Chime SDK.
ScreenDataUrl:
type: string
description: The screen data URL. This parameter is deprecated and no longer used by the Amazon Chime SDK.
ScreenViewingUrl:
type: string
description: The screen viewing URL. This parameter is deprecated and no longer used by the Amazon Chime SDK.
ScreenSharingUrl:
type: string
description: The screen sharing URL. This parameter is deprecated and no longer used by the Amazon Chime SDK.
EventIngestionUrl:
type: string
description: The event ingestion URL.
Meeting:
type: object
properties:
MeetingId:
type: string
description: The Amazon Chime SDK meeting ID.
MeetingHostId:
type: string
description: Reserved.
ExternalMeetingId:
type: string
description: '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.'
MediaRegion:
type: string
description: '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. Available values in Amazon Web Services GovCloud
(US) Regions: us-gov-east-1, us-gov-west-1.'
MediaPlacement:
$ref: '#/components/schemas/MediaPlacement'
MeetingFeatures:
$ref: '#/components/schemas/MeetingFeaturesConfiguration'
PrimaryMeetingId:
type: string
description: When specified, replicates the media from the primary meeting to this meeting.
TenantIds:
type: array
items:
type: string
description: Array of strings.
MeetingArn:
type: string
description: The ARN of the meeting.
MeetingFeaturesConfiguration:
type: object
properties:
Audio:
$ref: '#/components/schemas/AudioFeatures'
Video:
$ref: '#/components/schemas/VideoFeatures'
Content:
$ref: '#/components/schemas/ContentFeatures'
Attendee:
$ref: '#/components/schemas/AttendeeFeatures'
NotFoundException:
type: object
properties:
Code:
type: string
Message:
type: string
RequestId:
type: string
description: The request ID associated with the call responsible for the exception.
NotificationsConfiguration:
type: object
properties:
LambdaFunctionArn:
type: string
description: The ARN of the Amazon Web Services Lambda function in the notifications configuration.
SnsTopicArn:
type: string
description: The ARN of the SNS topic.
SqsQueueArn:
type: string
description: The ARN of the SQS queue.
ServiceFailureException:
type: object
properties:
Code:
type: string
Message:
type: string
RequestId:
type: string
description: The ID of the failed request.
ServiceUnavailableException:
type: object
properties:
Code:
type: string
Message:
type: string
RequestId:
type: string
description: The request id associated with the call responsible for the exception.
RetryAfterSeconds:
type: string
description: The number of seconds the caller should wait before retrying.
Tag:
type: object
properties:
Key:
type: string
description: The tag's key.
Value:
type: string
description: The tag's value.
required:
- Key
- Value
ThrottlingException:
type: object
properties:
Code:
type: string
Message:
type: string
RequestId:
type: string
description: The ID of the request that exceeded the throttling limit.
UnauthorizedException:
type: object
properties:
Code:
type: string
Message:
type: string
RequestId:
type: string
description: The request id associated with the call responsible for the exception.
VideoFeatures:
type: object
properties:
MaxResolution:
type: string
enum:
- None
- HD
- FHD
description: The maximum video resolution for the meeting. Applies to all attendees. Defaults to HD. To use FHD,
you must also provide a MeetingFeatures:Attendee:MaxCount value and override the default size limit of 250 attendees.
x-provenance:
method: harvested
publisher: Amazon Web Services
source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/chime-sdk-meetings/service/2021-07-15/chime-sdk-meetings-2021-07-15.json
note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)