@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonChimeSDKMeetingsAsync extends AmazonChimeSDKMeetings
AsyncHandler
can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonChimeSDKMeetingsAsync
instead.
The Amazon Chime SDK meetings APIs in this section allow software developers to create Amazon Chime SDK meetings, set the AWS Regions for meetings, create and manage users, and send and receive meeting notifications. For more information about the meeting APIs, see Amazon Chime SDK meetings.
ENDPOINT_PREFIX
batchCreateAttendee, batchUpdateAttendeeCapabilitiesExcept, createAttendee, createMeeting, createMeetingWithAttendees, deleteAttendee, deleteMeeting, getAttendee, getCachedResponseMetadata, getMeeting, listAttendees, listTagsForResource, shutdown, startMeetingTranscription, stopMeetingTranscription, tagResource, untagResource, updateAttendeeCapabilities
Future<BatchCreateAttendeeResult> batchCreateAttendeeAsync(BatchCreateAttendeeRequest batchCreateAttendeeRequest)
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.
batchCreateAttendeeRequest
- Future<BatchCreateAttendeeResult> batchCreateAttendeeAsync(BatchCreateAttendeeRequest batchCreateAttendeeRequest, AsyncHandler<BatchCreateAttendeeRequest,BatchCreateAttendeeResult> asyncHandler)
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.
batchCreateAttendeeRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<BatchUpdateAttendeeCapabilitiesExceptResult> batchUpdateAttendeeCapabilitiesExceptAsync(BatchUpdateAttendeeCapabilitiesExceptRequest batchUpdateAttendeeCapabilitiesExceptRequest)
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.
batchUpdateAttendeeCapabilitiesExceptRequest
- Future<BatchUpdateAttendeeCapabilitiesExceptResult> batchUpdateAttendeeCapabilitiesExceptAsync(BatchUpdateAttendeeCapabilitiesExceptRequest batchUpdateAttendeeCapabilitiesExceptRequest, AsyncHandler<BatchUpdateAttendeeCapabilitiesExceptRequest,BatchUpdateAttendeeCapabilitiesExceptResult> asyncHandler)
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.
batchUpdateAttendeeCapabilitiesExceptRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateAttendeeResult> createAttendeeAsync(CreateAttendeeRequest createAttendeeRequest)
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.
createAttendeeRequest
- Future<CreateAttendeeResult> createAttendeeAsync(CreateAttendeeRequest createAttendeeRequest, AsyncHandler<CreateAttendeeRequest,CreateAttendeeResult> asyncHandler)
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.
createAttendeeRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateMeetingResult> createMeetingAsync(CreateMeetingRequest createMeetingRequest)
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.
createMeetingRequest
- Future<CreateMeetingResult> createMeetingAsync(CreateMeetingRequest createMeetingRequest, AsyncHandler<CreateMeetingRequest,CreateMeetingResult> asyncHandler)
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.
createMeetingRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateMeetingWithAttendeesResult> createMeetingWithAttendeesAsync(CreateMeetingWithAttendeesRequest createMeetingWithAttendeesRequest)
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.
createMeetingWithAttendeesRequest
- Future<CreateMeetingWithAttendeesResult> createMeetingWithAttendeesAsync(CreateMeetingWithAttendeesRequest createMeetingWithAttendeesRequest, AsyncHandler<CreateMeetingWithAttendeesRequest,CreateMeetingWithAttendeesResult> asyncHandler)
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.
createMeetingWithAttendeesRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteAttendeeResult> deleteAttendeeAsync(DeleteAttendeeRequest deleteAttendeeRequest)
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.
deleteAttendeeRequest
- Future<DeleteAttendeeResult> deleteAttendeeAsync(DeleteAttendeeRequest deleteAttendeeRequest, AsyncHandler<DeleteAttendeeRequest,DeleteAttendeeResult> asyncHandler)
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.
deleteAttendeeRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteMeetingResult> deleteMeetingAsync(DeleteMeetingRequest deleteMeetingRequest)
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.
deleteMeetingRequest
- Future<DeleteMeetingResult> deleteMeetingAsync(DeleteMeetingRequest deleteMeetingRequest, AsyncHandler<DeleteMeetingRequest,DeleteMeetingResult> asyncHandler)
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.
deleteMeetingRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetAttendeeResult> getAttendeeAsync(GetAttendeeRequest getAttendeeRequest)
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.
getAttendeeRequest
- Future<GetAttendeeResult> getAttendeeAsync(GetAttendeeRequest getAttendeeRequest, AsyncHandler<GetAttendeeRequest,GetAttendeeResult> asyncHandler)
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.
getAttendeeRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetMeetingResult> getMeetingAsync(GetMeetingRequest getMeetingRequest)
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.
getMeetingRequest
- Future<GetMeetingResult> getMeetingAsync(GetMeetingRequest getMeetingRequest, AsyncHandler<GetMeetingRequest,GetMeetingResult> asyncHandler)
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.
getMeetingRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListAttendeesResult> listAttendeesAsync(ListAttendeesRequest listAttendeesRequest)
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.
listAttendeesRequest
- Future<ListAttendeesResult> listAttendeesAsync(ListAttendeesRequest listAttendeesRequest, AsyncHandler<ListAttendeesRequest,ListAttendeesResult> asyncHandler)
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.
listAttendeesRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)
Returns a list of the tags available for the specified resource.
listTagsForResourceRequest
- Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
Returns a list of the tags available for the specified resource.
listTagsForResourceRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StartMeetingTranscriptionResult> startMeetingTranscriptionAsync(StartMeetingTranscriptionRequest startMeetingTranscriptionRequest)
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.
startMeetingTranscriptionRequest
- Future<StartMeetingTranscriptionResult> startMeetingTranscriptionAsync(StartMeetingTranscriptionRequest startMeetingTranscriptionRequest, AsyncHandler<StartMeetingTranscriptionRequest,StartMeetingTranscriptionResult> asyncHandler)
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.
startMeetingTranscriptionRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StopMeetingTranscriptionResult> stopMeetingTranscriptionAsync(StopMeetingTranscriptionRequest stopMeetingTranscriptionRequest)
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.
stopMeetingTranscriptionRequest
- Future<StopMeetingTranscriptionResult> stopMeetingTranscriptionAsync(StopMeetingTranscriptionRequest stopMeetingTranscriptionRequest, AsyncHandler<StopMeetingTranscriptionRequest,StopMeetingTranscriptionResult> asyncHandler)
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.
stopMeetingTranscriptionRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest)
The resource that supports tags.
tagResourceRequest
- Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
The resource that supports tags.
tagResourceRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest)
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
untagResourceRequest
- Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
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
untagResourceRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateAttendeeCapabilitiesResult> updateAttendeeCapabilitiesAsync(UpdateAttendeeCapabilitiesRequest updateAttendeeCapabilitiesRequest)
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.
updateAttendeeCapabilitiesRequest
- Future<UpdateAttendeeCapabilitiesResult> updateAttendeeCapabilitiesAsync(UpdateAttendeeCapabilitiesRequest updateAttendeeCapabilitiesRequest, AsyncHandler<UpdateAttendeeCapabilitiesRequest,UpdateAttendeeCapabilitiesResult> asyncHandler)
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.
updateAttendeeCapabilitiesRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.