attendees

Creates, updates, deletes, gets or lists an attendees resource.

Overview

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

Fields

The following fields are returned by SELECT queries:

get_attendee
list_attendees

Name	Datatype	Description
`attendee_id`	`string`	The Amazon Chime SDK attendee ID. (pattern: <code>[a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}</code>)
`capabilities`	`object`	The capabilities assigned to an attendee: audio, video, or content. 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.
`external_user_id`	`string`	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.
`join_token`	`string`	The join token used by the Amazon Chime SDK attendee.

Name	Datatype	Description
`attendees`	`array`	The Amazon Chime SDK attendee information.
`next_token`	`string`	The token to use to retrieve the next page of results.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get_attendee`	`select`	`meeting_id`, `attendee_id`, `region`		Gets the Amazon Chime SDK attendee details for a specified meeting ID and attendee ID. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
`list_attendees`	`select`	`meeting_id`, `region`	`next-token`, `max-results`	Lists the attendees for the specified Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
`create_meeting_with_attendees`	`insert`	`region`, `ClientRequestToken`, `MediaRegion`, `ExternalMeetingId`		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
`create_attendee`	`insert`	`meeting_id`, `region`, `ExternalUserId`		Creates a new attendee 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.
`update_attendee_capabilities`	`update`	`meeting_id`, `attendee_id`, `region`, `Capabilities`		The capabilities that you want to update. 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.
`delete_attendee`	`delete`	`meeting_id`, `attendee_id`, `region`		Deletes an attendee from the specified Amazon Chime SDK meeting and deletes their JoinToken. Attendees are automatically deleted when a Amazon Chime SDK meeting is deleted. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.

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
`attendee_id`	`string`	The Amazon Chime SDK attendee ID.
`meeting_id`	`string`	The Amazon Chime SDK meeting ID.
`region`	`string`	AWS region (default: us-east-1)
`max-results`	`integer`	The maximum number of results to return in a single call.
`next-token`	`string`	The token to use to retrieve the next page of results.

`SELECT` examples

get_attendee
list_attendees

Gets the Amazon Chime SDK attendee details for a specified meeting ID and attendee ID. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.

SELECT
attendee_id,
capabilities,
external_user_id,
join_token
FROM aws.chime_sdk_meetings.attendees
WHERE meeting_id = '{{ meeting_id }}' -- required
AND attendee_id = '{{ attendee_id }}' -- required
AND region = '{{ region }}' -- required
;

Lists the attendees for the specified Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.

SELECT
attendees,
next_token
FROM aws.chime_sdk_meetings.attendees
WHERE meeting_id = '{{ meeting_id }}' -- required
AND region = '{{ region }}' -- required
AND `next-token` = '{{ next-token }}'
AND `max-results` = '{{ max-results }}'
;

`INSERT` examples

create_meeting_with_attendees
create_attendee
Manifest

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

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

Creates a new attendee 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.

INSERT INTO aws.chime_sdk_meetings.attendees (
ExternalUserId,
Capabilities,
meeting_id,
region
)
SELECT 
'{{ ExternalUserId }}' /* required */,
'{{ Capabilities }}',
'{{ meeting_id }}',
'{{ region }}'
RETURNING
attendee
;

# Description fields are for documentation purposes
- name: attendees
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the attendees resource.
  - name: meeting_id
    value: "{{ meeting_id }}"
    description: Required parameter for the attendees resource.
  - name: ClientRequestToken
    value: "{{ ClientRequestToken }}"
  - name: MediaRegion
    value: "{{ MediaRegion }}"
  - name: MeetingHostId
    value: "{{ MeetingHostId }}"
  - name: ExternalMeetingId
    value: "{{ ExternalMeetingId }}"
  - 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: NotificationsConfiguration
    description: |
      The configuration for resource targets to receive notifications when meeting and attendee events occur.
    value:
      LambdaFunctionArn: "{{ LambdaFunctionArn }}"
      SnsTopicArn: "{{ SnsTopicArn }}"
      SqsQueueArn: "{{ SqsQueueArn }}"
  - name: Attendees
    value:
      - ExternalUserId: "{{ ExternalUserId }}"
        Capabilities:
          Audio: "{{ Audio }}"
          Video: "{{ Video }}"
          Content: "{{ Content }}"
  - name: PrimaryMeetingId
    value: "{{ PrimaryMeetingId }}"
  - name: TenantIds
    value:
      - "{{ TenantIds }}"
  - name: Tags
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: MediaPlacementNetworkType
    value: "{{ MediaPlacementNetworkType }}"
    valid_values: ['Ipv4Only', 'DualStack']
  - name: ExternalUserId
    value: "{{ ExternalUserId }}"
  - name: Capabilities
    description: |
      The media capabilities of an attendee: audio, video, or content. You use the capabilities with a set of values that control what the capabilities can do, such as SendReceive data. For more information, refer to and . 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 an attendee unmutes their microphone, audio flows 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 the attendee turns 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.
    value:
      Audio: "{{ Audio }}"
      Video: "{{ Video }}"
      Content: "{{ Content }}"

`UPDATE` examples

update_attendee_capabilities

The capabilities that you want to update. 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.

UPDATE aws.chime_sdk_meetings.attendees
SET 
Capabilities = '{{ Capabilities }}'
WHERE 
meeting_id = '{{ meeting_id }}' --required
AND attendee_id = '{{ attendee_id }}' --required
AND region = '{{ region }}' --required
AND Capabilities = '{{ Capabilities }}' --required
RETURNING
attendee;

`DELETE` examples

delete_attendee

Deletes an attendee from the specified Amazon Chime SDK meeting and deletes their JoinToken. Attendees are automatically deleted when a Amazon Chime SDK meeting is deleted. 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.attendees
WHERE meeting_id = '{{ meeting_id }}' --required
AND attendee_id = '{{ attendee_id }}' --required
AND region = '{{ region }}' --required
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​