Class: Aws::ChimeSDKMeetings::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::ChimeSDKMeetings::Client
- Includes:
- Aws::ClientStubs
- Defined in:
- gems/aws-sdk-chimesdkmeetings/lib/aws-sdk-chimesdkmeetings/client.rb
Overview
An API client for ChimeSDKMeetings. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::ChimeSDKMeetings::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#batch_create_attendee(params = {}) ⇒ Types::BatchCreateAttendeeResponse
Creates up to 100 attendees for an active Amazon Chime SDK meeting.
-
#batch_update_attendee_capabilities_except(params = {}) ⇒ Struct
Updates
AttendeeCapabilities
except the capabilities listed in anExcludedAttendeeIds
table. -
#create_attendee(params = {}) ⇒ Types::CreateAttendeeResponse
Creates a new attendee for an active Amazon Chime SDK meeting.
-
#create_meeting(params = {}) ⇒ Types::CreateMeetingResponse
Creates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees.
-
#create_meeting_with_attendees(params = {}) ⇒ Types::CreateMeetingWithAttendeesResponse
Creates a new Amazon Chime SDK meeting in the specified media Region, with attendees.
-
#delete_attendee(params = {}) ⇒ Struct
Deletes an attendee from the specified Amazon Chime SDK meeting and deletes their
JoinToken
. -
#delete_meeting(params = {}) ⇒ Struct
Deletes the specified Amazon Chime SDK meeting.
-
#get_attendee(params = {}) ⇒ Types::GetAttendeeResponse
Gets the Amazon Chime SDK attendee details for a specified meeting ID and attendee ID.
-
#get_meeting(params = {}) ⇒ Types::GetMeetingResponse
Gets the Amazon Chime SDK meeting details for the specified meeting ID.
-
#list_attendees(params = {}) ⇒ Types::ListAttendeesResponse
Lists the attendees for the specified Amazon Chime SDK meeting.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Returns a list of the tags available for the specified resource.
-
#start_meeting_transcription(params = {}) ⇒ Struct
Starts transcription for the specified
meetingId
. -
#stop_meeting_transcription(params = {}) ⇒ Struct
Stops transcription for the specified
meetingId
. -
#tag_resource(params = {}) ⇒ Struct
The resource that supports tags.
-
#untag_resource(params = {}) ⇒ Struct
Removes the specified tags from the specified resources.
-
#update_attendee_capabilities(params = {}) ⇒ Types::UpdateAttendeeCapabilitiesResponse
The capabilties that you want to update.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from Aws::ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
365 366 367 |
# File 'gems/aws-sdk-chimesdkmeetings/lib/aws-sdk-chimesdkmeetings/client.rb', line 365 def initialize(*args) super end |
Instance Method Details
#batch_create_attendee(params = {}) ⇒ Types::BatchCreateAttendeeResponse
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.
425 426 427 428 |
# File 'gems/aws-sdk-chimesdkmeetings/lib/aws-sdk-chimesdkmeetings/client.rb', line 425 def batch_create_attendee(params = {}, = {}) req = build_request(:batch_create_attendee, params) req.send_request() end |
#batch_update_attendee_capabilities_except(params = {}) ⇒ Struct
Updates AttendeeCapabilities
except the capabilities listed in an
ExcludedAttendeeIds
table.
SendReceive
data. For more information
about those values, see .
When using capabilities, be aware of these corner cases:
You can't set
content
capabilities toSendReceive
orReceive
unless you also setvideo
capabilities toSendReceive
orReceive
. If you don't set thevideo
capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set yourvideo
capability to receive and you set yourcontent
capability to not receive.When you change an
audio
capability fromNone
orReceive
toSend
orSendReceive
, and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants.When you change a
video
orcontent
capability fromNone
orReceive
toSend
orSendReceive
, and if the attendee turned on their video or content streams, remote attendess can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.
492 493 494 495 |
# File 'gems/aws-sdk-chimesdkmeetings/lib/aws-sdk-chimesdkmeetings/client.rb', line 492 def batch_update_attendee_capabilities_except(params = {}, = {}) req = build_request(:batch_update_attendee_capabilities_except, params) req.send_request() end |
#create_attendee(params = {}) ⇒ Types::CreateAttendeeResponse
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.
577 578 579 580 |
# File 'gems/aws-sdk-chimesdkmeetings/lib/aws-sdk-chimesdkmeetings/client.rb', line 577 def create_attendee(params = {}, = {}) req = build_request(:create_attendee, params) req.send_request() end |
#create_meeting(params = {}) ⇒ Types::CreateMeetingResponse
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.
746 747 748 749 |
# File 'gems/aws-sdk-chimesdkmeetings/lib/aws-sdk-chimesdkmeetings/client.rb', line 746 def create_meeting(params = {}, = {}) req = build_request(:create_meeting, params) req.send_request() end |
#create_meeting_with_attendees(params = {}) ⇒ Types::CreateMeetingWithAttendeesResponse
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.
892 893 894 895 |
# File 'gems/aws-sdk-chimesdkmeetings/lib/aws-sdk-chimesdkmeetings/client.rb', line 892 def create_meeting_with_attendees(params = {}, = {}) req = build_request(:create_meeting_with_attendees, params) req.send_request() end |
#delete_attendee(params = {}) ⇒ Struct
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.
926 927 928 929 |
# File 'gems/aws-sdk-chimesdkmeetings/lib/aws-sdk-chimesdkmeetings/client.rb', line 926 def delete_attendee(params = {}, = {}) req = build_request(:delete_attendee, params) req.send_request() end |
#delete_meeting(params = {}) ⇒ Struct
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.
956 957 958 959 |
# File 'gems/aws-sdk-chimesdkmeetings/lib/aws-sdk-chimesdkmeetings/client.rb', line 956 def delete_meeting(params = {}, = {}) req = build_request(:delete_meeting, params) req.send_request() end |
#get_attendee(params = {}) ⇒ Types::GetAttendeeResponse
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.
999 1000 1001 1002 |
# File 'gems/aws-sdk-chimesdkmeetings/lib/aws-sdk-chimesdkmeetings/client.rb', line 999 def get_attendee(params = {}, = {}) req = build_request(:get_attendee, params) req.send_request() end |
#get_meeting(params = {}) ⇒ Types::GetMeetingResponse
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.
1049 1050 1051 1052 |
# File 'gems/aws-sdk-chimesdkmeetings/lib/aws-sdk-chimesdkmeetings/client.rb', line 1049 def get_meeting(params = {}, = {}) req = build_request(:get_meeting, params) req.send_request() end |
#list_attendees(params = {}) ⇒ Types::ListAttendeesResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1101 1102 1103 1104 |
# File 'gems/aws-sdk-chimesdkmeetings/lib/aws-sdk-chimesdkmeetings/client.rb', line 1101 def list_attendees(params = {}, = {}) req = build_request(:list_attendees, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Returns a list of the tags available for the specified resource.
1131 1132 1133 1134 |
# File 'gems/aws-sdk-chimesdkmeetings/lib/aws-sdk-chimesdkmeetings/client.rb', line 1131 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#start_meeting_transcription(params = {}) ⇒ Struct
Starts 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.
1196 1197 1198 1199 |
# File 'gems/aws-sdk-chimesdkmeetings/lib/aws-sdk-chimesdkmeetings/client.rb', line 1196 def start_meeting_transcription(params = {}, = {}) req = build_request(:start_meeting_transcription, params) req.send_request() end |
#stop_meeting_transcription(params = {}) ⇒ Struct
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.
1230 1231 1232 1233 |
# File 'gems/aws-sdk-chimesdkmeetings/lib/aws-sdk-chimesdkmeetings/client.rb', line 1230 def stop_meeting_transcription(params = {}, = {}) req = build_request(:stop_meeting_transcription, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
The resource that supports tags.
1261 1262 1263 1264 |
# File 'gems/aws-sdk-chimesdkmeetings/lib/aws-sdk-chimesdkmeetings/client.rb', line 1261 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
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
1310 1311 1312 1313 |
# File 'gems/aws-sdk-chimesdkmeetings/lib/aws-sdk-chimesdkmeetings/client.rb', line 1310 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_attendee_capabilities(params = {}) ⇒ Types::UpdateAttendeeCapabilitiesResponse
The capabilties that you want to update.
SendReceive
data. For more information
about those values, see .
When using capabilities, be aware of these corner cases:
You can't set
content
capabilities toSendReceive
orReceive
unless you also setvideo
capabilities toSendReceive
orReceive
. If you don't set thevideo
capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set yourvideo
capability to receive and you set yourcontent
capability to not receive.When you change an
audio
capability fromNone
orReceive
toSend
orSendReceive
, and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants.When you change a
video
orcontent
capability fromNone
orReceive
toSend
orSendReceive
, and if the attendee turned on their video or content streams, remote attendess can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.
1381 1382 1383 1384 |
# File 'gems/aws-sdk-chimesdkmeetings/lib/aws-sdk-chimesdkmeetings/client.rb', line 1381 def update_attendee_capabilities(params = {}, = {}) req = build_request(:update_attendee_capabilities, params) req.send_request() end |