Chime Sdk Meetings
This page documents function available when using the Chime_Sdk_Meetings module, created with @service Chime_Sdk_Meetings.
Index
Main.Chime_Sdk_Meetings.batch_create_attendeeMain.Chime_Sdk_Meetings.batch_update_attendee_capabilities_exceptMain.Chime_Sdk_Meetings.create_attendeeMain.Chime_Sdk_Meetings.create_meetingMain.Chime_Sdk_Meetings.create_meeting_with_attendeesMain.Chime_Sdk_Meetings.delete_attendeeMain.Chime_Sdk_Meetings.delete_meetingMain.Chime_Sdk_Meetings.get_attendeeMain.Chime_Sdk_Meetings.get_meetingMain.Chime_Sdk_Meetings.list_attendeesMain.Chime_Sdk_Meetings.list_tags_for_resourceMain.Chime_Sdk_Meetings.start_meeting_transcriptionMain.Chime_Sdk_Meetings.stop_meeting_transcriptionMain.Chime_Sdk_Meetings.tag_resourceMain.Chime_Sdk_Meetings.untag_resourceMain.Chime_Sdk_Meetings.update_attendee_capabilities
Documentation
Main.Chime_Sdk_Meetings.batch_create_attendee — Methodbatch_create_attendee(attendees, meeting_id)
batch_create_attendee(attendees, meeting_id, params::Dict{String,<:Any})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.
Arguments
attendees: The attendee information, including attendees' IDs and join tokens.meeting_id: The Amazon Chime SDK ID of the meeting to which you're adding attendees.
Main.Chime_Sdk_Meetings.batch_update_attendee_capabilities_except — Methodbatch_update_attendee_capabilities_except(capabilities, excluded_attendee_ids, meeting_id)
batch_update_attendee_capabilities_except(capabilities, excluded_attendee_ids, meeting_id, params::Dict{String,<:Any})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: 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. 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.
Arguments
capabilities: The capabilities (audio, video, or content) that you want to update.excluded_attendee_ids: The AttendeeIDs that you want to exclude from one or more capabilities.meeting_id: The ID of the meeting associated with the update request.
Main.Chime_Sdk_Meetings.create_attendee — Methodcreate_attendee(external_user_id, meeting_id)
create_attendee(external_user_id, meeting_id, params::Dict{String,<:Any})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.
Arguments
external_user_id: 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.meeting_id: The unique ID of the meeting.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"Capabilities": The capabilities (audio, video, or content) that you want to grant an attendee. If you don't specify capabilities, all users have send and receive capabilities on all media channels by default. 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: 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. 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.
Main.Chime_Sdk_Meetings.create_meeting — Methodcreate_meeting(client_request_token, external_meeting_id, media_region)
create_meeting(client_request_token, external_meeting_id, media_region, params::Dict{String,<:Any})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 Developer Guide. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
Arguments
client_request_token: The unique identifier for the client request. Use a different token for different meetings.external_meeting_id: 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_region: 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.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"MeetingFeatures": Lists the audio and video features enabled for a meeting, such as echo reduction."MeetingHostId": Reserved."NotificationsConfiguration": The configuration for resource targets to receive notifications when meeting and attendee events occur."PrimaryMeetingId": When specified, replicates the media from the primary meeting to the new meeting."Tags": 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 located in the specified AWS Region for the AWS account. To add tags to a resource, you need the necessary permissions for the service that the resource belongs to as well as permissions for adding tags. For more information, see the documentation for each service. Do not store personally identifiable information (PII) or other confidential or sensitive information in tags. We use tags to provide you with billing and administration services. Tags are not intended to be used for private or sensitive data. Minimum permissions In addition to the tag:TagResources permission required by this operation, you must also have the tagging permission defined by the service that created the resource. For example, to tag a ChimeSDKMeetings instance using the TagResources operation, you must have both of the following permissions: tag:TagResources ChimeSDKMeetings:CreateTags Some services might have specific requirements for tagging some resources. For example, to tag an Amazon S3 bucket, you must also have the s3:GetBucketTagging permission. If the expected minimum permissions don't work, check the documentation for that service's tagging APIs for more information."TenantIds": A consistent and opaque identifier, created and maintained by the builder to represent a segment of their users.
Main.Chime_Sdk_Meetings.create_meeting_with_attendees — Methodcreate_meeting_with_attendees(attendees, client_request_token, external_meeting_id, media_region)
create_meeting_with_attendees(attendees, client_request_token, external_meeting_id, media_region, params::Dict{String,<:Any})Creates a new Amazon Chime SDK meeting in the specified media Region, with attendees. For more information about specifying media Regions, see Amazon Chime SDK Media Regions in the Amazon Chime Developer Guide. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
Arguments
attendees: The attendee information, including attendees' IDs and join tokens.client_request_token: The unique identifier for the client request. Use a different token for different meetings.external_meeting_id: 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_region: 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.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"MeetingFeatures": Lists the audio and video features enabled for a meeting, such as echo reduction."MeetingHostId": Reserved."NotificationsConfiguration": The configuration for resource targets to receive notifications when meeting and attendee events occur."PrimaryMeetingId": When specified, replicates the media from the primary meeting to the new meeting."Tags": The tags in the request."TenantIds": A consistent and opaque identifier, created and maintained by the builder to represent a segment of their users.
Main.Chime_Sdk_Meetings.delete_attendee — Methoddelete_attendee(attendee_id, meeting_id)
delete_attendee(attendee_id, meeting_id, params::Dict{String,<:Any})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.
Arguments
attendee_id: The Amazon Chime SDK attendee ID.meeting_id: The Amazon Chime SDK meeting ID.
Main.Chime_Sdk_Meetings.delete_meeting — Methoddelete_meeting(meeting_id)
delete_meeting(meeting_id, params::Dict{String,<:Any})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.
Arguments
meeting_id: The Amazon Chime SDK meeting ID.
Main.Chime_Sdk_Meetings.get_attendee — Methodget_attendee(attendee_id, meeting_id)
get_attendee(attendee_id, meeting_id, params::Dict{String,<:Any})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.
Arguments
attendee_id: The Amazon Chime SDK attendee ID.meeting_id: The Amazon Chime SDK meeting ID.
Main.Chime_Sdk_Meetings.get_meeting — Methodget_meeting(meeting_id)
get_meeting(meeting_id, params::Dict{String,<:Any})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.
Arguments
meeting_id: The Amazon Chime SDK meeting ID.
Main.Chime_Sdk_Meetings.list_attendees — Methodlist_attendees(meeting_id)
list_attendees(meeting_id, params::Dict{String,<:Any})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.
Arguments
meeting_id: The Amazon Chime SDK meeting ID.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"max-results": The maximum number of results to return in a single call."next-token": The token to use to retrieve the next page of results.
Main.Chime_Sdk_Meetings.list_tags_for_resource — Methodlist_tags_for_resource(arn)
list_tags_for_resource(arn, params::Dict{String,<:Any})Returns a list of the tags available for the specified resource.
Arguments
arn: The ARN of the resource.
Main.Chime_Sdk_Meetings.start_meeting_transcription — Methodstart_meeting_transcription(meeting_id, transcription_configuration)
start_meeting_transcription(meeting_id, transcription_configuration, params::Dict{String,<:Any})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. Amazon Chime SDK live transcription is powered by Amazon Transcribe. Use of Amazon Transcribe is subject to the AWS Service Terms, including the terms specific to the AWS Machine Learning and Artificial Intelligence Services.
Arguments
meeting_id: The unique ID of the meeting being transcribed.transcription_configuration: The configuration for the current transcription operation. Must contain EngineTranscribeSettings or EngineTranscribeMedicalSettings.
Main.Chime_Sdk_Meetings.stop_meeting_transcription — Methodstop_meeting_transcription(meeting_id)
stop_meeting_transcription(meeting_id, params::Dict{String,<:Any})Stops transcription for the specified meetingId. For more information, refer to Using Amazon Chime SDK live transcription in the Amazon Chime SDK Developer Guide. Amazon Chime SDK live transcription is powered by Amazon Transcribe. Use of Amazon Transcribe is subject to the AWS Service Terms, including the terms specific to the AWS Machine Learning and Artificial Intelligence Services.
Arguments
meeting_id: The unique ID of the meeting for which you stop transcription.
Main.Chime_Sdk_Meetings.tag_resource — Methodtag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})The resource that supports tags.
Arguments
resource_arn: The ARN of the resource.tags: Lists the requested tags.
Main.Chime_Sdk_Meetings.untag_resource — Methoduntag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})Removes the specified tags from the specified resources. When you specify a tag key, the action removes both that key and its associated value. The operation succeeds even if you attempt to remove tags from a resource that were already removed. Note the following: To remove tags from a resource, you need the necessary permissions for the service that the resource belongs to as well as permissions for removing tags. For more information, see the documentation for the service whose resource you want to untag. You can only tag resources that are located in the specified AWS Region for the calling AWS account. Minimum permissions In addition to the tag:UntagResources permission required by this operation, you must also have the remove tags permission defined by the service that created the resource. For example, to remove the tags from an Amazon EC2 instance using the UntagResources operation, you must have both of the following permissions: tag:UntagResource ChimeSDKMeetings:DeleteTags
Arguments
resource_arn: The ARN of the resource that you're removing tags from.tag_keys: The tag keys being removed from the resources.
Main.Chime_Sdk_Meetings.update_attendee_capabilities — Methodupdate_attendee_capabilities(attendee_id, capabilities, meeting_id)
update_attendee_capabilities(attendee_id, capabilities, meeting_id, params::Dict{String,<:Any})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: 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. 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.
Arguments
attendee_id: The ID of the attendee associated with the update request.capabilities: The capabilities that you want to update.meeting_id: The ID of the meeting associated with the update request.