meetings

Creates, updates, deletes, gets or lists a meetings resource.

Overview

Name	`meetings`
Type	Resource
Id	`aws.chime_sdk_meetings.meetings`

Fields

The following fields are returned by SELECT queries:

get_meeting

Name	Datatype	Description
`external_meeting_id`	`string`	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.
`media_placement`	`object`	The media placement for the meeting.
`media_region`	`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. Available values in Amazon Web Services GovCloud (US) Regions: us-gov-east-1, us-gov-west-1.
`meeting_arn`	`string`	The ARN of the meeting. (pattern: <code>^arn:.*</code>)
`meeting_features`	`object`	The configuration settings of the features available to a meeting.
`meeting_host_id`	`string`	Reserved.
`meeting_id`	`string`	The Amazon Chime SDK meeting ID. (pattern: <code>[a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}</code>)
`primary_meeting_id`	`string`	When specified, replicates the media from the primary meeting to this meeting.
`tenant_ids`	`array`	Array of strings.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Description
`get_meeting`	`select`	`meeting_id`, `region`	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.
`create_meeting`	`insert`	`region`, `ClientRequestToken`, `MediaRegion`, `ExternalMeetingId`	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
`delete_meeting`	`delete`	`meeting_id`, `region`	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.
`batch_create_attendee`	`exec`	`meeting_id`, `region`	Creates up to 100 attendees for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
`batch_update_attendee_capabilities_except`	`exec`	`meeting_id`, `region`, `ExcludedAttendeeIds`, `Capabilities`	Updates AttendeeCapabilities except the capabilities listed in an ExcludedAttendeeIds table. You use the capabilities with a set of values that control what the capabilities can do, such as SendReceive data. For more information about those values, see . When using capabilities, be aware of these corner cases: If you specify MeetingFeatures:Video:MaxResolution:None when you create a meeting, all API requests that include SendReceive, Send, or Receive for AttendeeCapabilities:Video will be rejected with ValidationError 400. If you specify MeetingFeatures:Content:MaxResolution:None when you create a meeting, all API requests that include SendReceive, Send, or Receive for AttendeeCapabilities:Content will be rejected with ValidationError 400. You can't set content capabilities to SendReceive or Receive unless you also set video capabilities to SendReceive or Receive. If you don't set the video capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set your video capability to receive and you set your content capability to not receive. If meeting features is defined as Video:MaxResolution:None but Content:MaxResolution is defined as something other than None and attendee capabilities are not defined in the API request, then the default attendee video capability is set to Receive and attendee content capability is set to SendReceive. This is because content SendReceive requires video to be at least Receive. When you change an audio capability from None or Receive to Send or SendReceive , and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants. When you change a video or content capability from None or Receive to Send or SendReceive , and if the attendee turned on their video or content streams, remote attendees can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.
`start_meeting_transcription`	`exec`	`meeting_id`, `region`, `TranscriptionConfiguration`	Starts transcription for the specified meetingId. For more information, refer to Using Amazon Chime SDK live transcription in the Amazon Chime SDK Developer Guide. If you specify an invalid configuration, a TranscriptFailed event will be sent with the contents of the BadRequestException generated by Amazon Transcribe. For more information on each parameter and which combinations are valid, refer to the StartStreamTranscription API in the Amazon Transcribe Developer Guide. By default, Amazon Transcribe may use and store audio content processed by the service to develop and improve Amazon Web Services AI/ML services as further described in section 50 of the Amazon Web Services Service Terms. Using Amazon Transcribe may be subject to federal and state laws or regulations regarding the recording or interception of electronic communications. It is your and your end users’ responsibility to comply with all applicable laws regarding the recording, including properly notifying all participants in a recorded session or communication that the session or communication is being recorded, and obtaining all necessary consents. You can opt out from Amazon Web Services using audio content to develop and improve AWS AI/ML services by configuring an AI services opt out policy using Amazon Web Services Organizations.
`stop_meeting_transcription`	`exec`	`meeting_id`, `region`	Stops transcription for the specified meetingId. For more information, refer to Using Amazon Chime SDK live transcription in the Amazon Chime SDK Developer Guide. By default, Amazon Transcribe may use and store audio content processed by the service to develop and improve Amazon Web Services AI/ML services as further described in section 50 of the Amazon Web Services Service Terms. Using Amazon Transcribe may be subject to federal and state laws or regulations regarding the recording or interception of electronic communications. It is your and your end users’ responsibility to comply with all applicable laws regarding the recording, including properly notifying all participants in a recorded session or communication that the session or communication is being recorded, and obtaining all necessary consents. You can opt out from Amazon Web Services using audio content to develop and improve Amazon Web Services AI/ML services by configuring an AI services opt out policy using Amazon Web Services Organizations.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`meeting_id`	`string`	The unique ID of the meeting for which you stop transcription.
`region`	`string`	AWS region (default: us-east-1)

`SELECT` examples

get_meeting

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.

SELECT
external_meeting_id,
media_placement,
media_region,
meeting_arn,
meeting_features,
meeting_host_id,
meeting_id,
primary_meeting_id,
tenant_ids
FROM aws.chime_sdk_meetings.meetings
WHERE meeting_id = '{{ meeting_id }}' -- required
AND region = '{{ region }}' -- required
;

`INSERT` examples

create_meeting
Manifest

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

INSERT INTO aws.chime_sdk_meetings.meetings (
ClientRequestToken,
MediaRegion,
MeetingHostId,
ExternalMeetingId,
NotificationsConfiguration,
MeetingFeatures,
PrimaryMeetingId,
TenantIds,
Tags,
MediaPlacementNetworkType,
region
)
SELECT 
'{{ ClientRequestToken }}' /* required */,
'{{ MediaRegion }}' /* required */,
'{{ MeetingHostId }}',
'{{ ExternalMeetingId }}' /* required */,
'{{ NotificationsConfiguration }}',
'{{ MeetingFeatures }}',
'{{ PrimaryMeetingId }}',
'{{ TenantIds }}',
'{{ Tags }}',
'{{ MediaPlacementNetworkType }}',
'{{ region }}'
RETURNING
meeting
;

# Description fields are for documentation purposes
- name: meetings
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the meetings resource.
  - name: ClientRequestToken
    value: "{{ ClientRequestToken }}"
  - name: MediaRegion
    value: "{{ MediaRegion }}"
  - name: MeetingHostId
    value: "{{ MeetingHostId }}"
  - name: ExternalMeetingId
    value: "{{ ExternalMeetingId }}"
  - name: NotificationsConfiguration
    description: |
      The configuration for resource targets to receive notifications when meeting and attendee events occur.
    value:
      LambdaFunctionArn: "{{ LambdaFunctionArn }}"
      SnsTopicArn: "{{ SnsTopicArn }}"
      SqsQueueArn: "{{ SqsQueueArn }}"
  - name: MeetingFeatures
    description: |
      The configuration settings of the features available to a meeting.
    value:
      Audio:
        EchoReduction: "{{ EchoReduction }}"
      Video:
        MaxResolution: "{{ MaxResolution }}"
      Content:
        MaxResolution: "{{ MaxResolution }}"
      Attendee:
        MaxCount: {{ MaxCount }}
  - name: PrimaryMeetingId
    value: "{{ PrimaryMeetingId }}"
  - name: TenantIds
    value:
      - "{{ TenantIds }}"
  - name: Tags
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: MediaPlacementNetworkType
    value: "{{ MediaPlacementNetworkType }}"
    valid_values: ['Ipv4Only', 'DualStack']

`DELETE` examples

delete_meeting

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.

DELETE FROM aws.chime_sdk_meetings.meetings
WHERE meeting_id = '{{ meeting_id }}' --required
AND region = '{{ region }}' --required
;

Lifecycle Methods

batch_create_attendee
batch_update_attendee_capabilities_except
start_meeting_transcription
stop_meeting_transcription

Creates up to 100 attendees for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.

EXEC aws.chime_sdk_meetings.meetings.batch_create_attendee 
@meeting_id='{{ meeting_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"Attendees": "{{ Attendees }}"
}'
;

Updates AttendeeCapabilities except the capabilities listed in an ExcludedAttendeeIds table. You use the capabilities with a set of values that control what the capabilities can do, such as SendReceive data. For more information about those values, see . When using capabilities, be aware of these corner cases: If you specify MeetingFeatures:Video:MaxResolution:None when you create a meeting, all API requests that include SendReceive, Send, or Receive for AttendeeCapabilities:Video will be rejected with ValidationError 400. If you specify MeetingFeatures:Content:MaxResolution:None when you create a meeting, all API requests that include SendReceive, Send, or Receive for AttendeeCapabilities:Content will be rejected with ValidationError 400. You can't set content capabilities to SendReceive or Receive unless you also set video capabilities to SendReceive or Receive. If you don't set the video capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set your video capability to receive and you set your content capability to not receive. If meeting features is defined as Video:MaxResolution:None but Content:MaxResolution is defined as something other than None and attendee capabilities are not defined in the API request, then the default attendee video capability is set to Receive and attendee content capability is set to SendReceive. This is because content SendReceive requires video to be at least Receive. When you change an audio capability from None or Receive to Send or SendReceive , and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants. When you change a video or content capability from None or Receive to Send or SendReceive , and if the attendee turned on their video or content streams, remote attendees can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.

EXEC aws.chime_sdk_meetings.meetings.batch_update_attendee_capabilities_except 
@meeting_id='{{ meeting_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"ExcludedAttendeeIds": "{{ ExcludedAttendeeIds }}", 
"Capabilities": "{{ Capabilities }}"
}'
;

Starts transcription for the specified meetingId. For more information, refer to Using Amazon Chime SDK live transcription in the Amazon Chime SDK Developer Guide. If you specify an invalid configuration, a TranscriptFailed event will be sent with the contents of the BadRequestException generated by Amazon Transcribe. For more information on each parameter and which combinations are valid, refer to the StartStreamTranscription API in the Amazon Transcribe Developer Guide. By default, Amazon Transcribe may use and store audio content processed by the service to develop and improve Amazon Web Services AI/ML services as further described in section 50 of the Amazon Web Services Service Terms. Using Amazon Transcribe may be subject to federal and state laws or regulations regarding the recording or interception of electronic communications. It is your and your end users’ responsibility to comply with all applicable laws regarding the recording, including properly notifying all participants in a recorded session or communication that the session or communication is being recorded, and obtaining all necessary consents. You can opt out from Amazon Web Services using audio content to develop and improve AWS AI/ML services by configuring an AI services opt out policy using Amazon Web Services Organizations.

EXEC aws.chime_sdk_meetings.meetings.start_meeting_transcription 
@meeting_id='{{ meeting_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"TranscriptionConfiguration": "{{ TranscriptionConfiguration }}"
}'
;

Stops transcription for the specified meetingId. For more information, refer to Using Amazon Chime SDK live transcription in the Amazon Chime SDK Developer Guide. By default, Amazon Transcribe may use and store audio content processed by the service to develop and improve Amazon Web Services AI/ML services as further described in section 50 of the Amazon Web Services Service Terms. Using Amazon Transcribe may be subject to federal and state laws or regulations regarding the recording or interception of electronic communications. It is your and your end users’ responsibility to comply with all applicable laws regarding the recording, including properly notifying all participants in a recorded session or communication that the session or communication is being recorded, and obtaining all necessary consents. You can opt out from Amazon Web Services using audio content to develop and improve Amazon Web Services AI/ML services by configuring an AI services opt out policy using Amazon Web Services Organizations.

EXEC aws.chime_sdk_meetings.meetings.stop_meeting_transcription 
@meeting_id='{{ meeting_id }}' --required, 
@region='{{ region }}' --required
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

DELETE examples​

Lifecycle Methods​