Interface ChimeSdkMeetingsAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any
invalid reference
SdkAsyncHttpClient
The Amazon Chime SDK meetings APIs in this section allow software developers to create Amazon Chime SDK meetings, set the Amazon Web Services 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.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionbatchCreateAttendee
(Consumer<BatchCreateAttendeeRequest.Builder> batchCreateAttendeeRequest) Creates up to 100 attendees for an active Amazon Chime SDK meeting.batchCreateAttendee
(BatchCreateAttendeeRequest batchCreateAttendeeRequest) Creates up to 100 attendees for an active Amazon Chime SDK meeting.batchUpdateAttendeeCapabilitiesExcept
(Consumer<BatchUpdateAttendeeCapabilitiesExceptRequest.Builder> batchUpdateAttendeeCapabilitiesExceptRequest) UpdatesAttendeeCapabilities
except the capabilities listed in anExcludedAttendeeIds
table.batchUpdateAttendeeCapabilitiesExcept
(BatchUpdateAttendeeCapabilitiesExceptRequest batchUpdateAttendeeCapabilitiesExceptRequest) UpdatesAttendeeCapabilities
except the capabilities listed in anExcludedAttendeeIds
table.builder()
Create a builder that can be used to configure and create aChimeSdkMeetingsAsyncClient
.static ChimeSdkMeetingsAsyncClient
create()
Create aChimeSdkMeetingsAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CompletableFuture
<CreateAttendeeResponse> createAttendee
(Consumer<CreateAttendeeRequest.Builder> createAttendeeRequest) Creates a new attendee for an active Amazon Chime SDK meeting.default CompletableFuture
<CreateAttendeeResponse> createAttendee
(CreateAttendeeRequest createAttendeeRequest) Creates a new attendee for an active Amazon Chime SDK meeting.default CompletableFuture
<CreateMeetingResponse> createMeeting
(Consumer<CreateMeetingRequest.Builder> createMeetingRequest) Creates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees.default CompletableFuture
<CreateMeetingResponse> createMeeting
(CreateMeetingRequest createMeetingRequest) Creates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees.createMeetingWithAttendees
(Consumer<CreateMeetingWithAttendeesRequest.Builder> createMeetingWithAttendeesRequest) Creates a new Amazon Chime SDK meeting in the specified media Region, with attendees.createMeetingWithAttendees
(CreateMeetingWithAttendeesRequest createMeetingWithAttendeesRequest) Creates a new Amazon Chime SDK meeting in the specified media Region, with attendees.default CompletableFuture
<DeleteAttendeeResponse> deleteAttendee
(Consumer<DeleteAttendeeRequest.Builder> deleteAttendeeRequest) Deletes an attendee from the specified Amazon Chime SDK meeting and deletes theirJoinToken
.default CompletableFuture
<DeleteAttendeeResponse> deleteAttendee
(DeleteAttendeeRequest deleteAttendeeRequest) Deletes an attendee from the specified Amazon Chime SDK meeting and deletes theirJoinToken
.default CompletableFuture
<DeleteMeetingResponse> deleteMeeting
(Consumer<DeleteMeetingRequest.Builder> deleteMeetingRequest) Deletes the specified Amazon Chime SDK meeting.default CompletableFuture
<DeleteMeetingResponse> deleteMeeting
(DeleteMeetingRequest deleteMeetingRequest) Deletes the specified Amazon Chime SDK meeting.default CompletableFuture
<GetAttendeeResponse> getAttendee
(Consumer<GetAttendeeRequest.Builder> getAttendeeRequest) Gets the Amazon Chime SDK attendee details for a specified meeting ID and attendee ID.default CompletableFuture
<GetAttendeeResponse> getAttendee
(GetAttendeeRequest getAttendeeRequest) Gets the Amazon Chime SDK attendee details for a specified meeting ID and attendee ID.default CompletableFuture
<GetMeetingResponse> getMeeting
(Consumer<GetMeetingRequest.Builder> getMeetingRequest) Gets the Amazon Chime SDK meeting details for the specified meeting ID.default CompletableFuture
<GetMeetingResponse> getMeeting
(GetMeetingRequest getMeetingRequest) Gets the Amazon Chime SDK meeting details for the specified meeting ID.default CompletableFuture
<ListAttendeesResponse> listAttendees
(Consumer<ListAttendeesRequest.Builder> listAttendeesRequest) Lists the attendees for the specified Amazon Chime SDK meeting.default CompletableFuture
<ListAttendeesResponse> listAttendees
(ListAttendeesRequest listAttendeesRequest) Lists the attendees for the specified Amazon Chime SDK meeting.default ListAttendeesPublisher
listAttendeesPaginator
(Consumer<ListAttendeesRequest.Builder> listAttendeesRequest) This is a variant oflistAttendees(software.amazon.awssdk.services.chimesdkmeetings.model.ListAttendeesRequest)
operation.default ListAttendeesPublisher
listAttendeesPaginator
(ListAttendeesRequest listAttendeesRequest) This is a variant oflistAttendees(software.amazon.awssdk.services.chimesdkmeetings.model.ListAttendeesRequest)
operation.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Returns a list of the tags available for the specified resource.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Returns a list of the tags available for the specified resource.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstartMeetingTranscription
(Consumer<StartMeetingTranscriptionRequest.Builder> startMeetingTranscriptionRequest) Starts transcription for the specifiedmeetingId
.startMeetingTranscription
(StartMeetingTranscriptionRequest startMeetingTranscriptionRequest) Starts transcription for the specifiedmeetingId
.stopMeetingTranscription
(Consumer<StopMeetingTranscriptionRequest.Builder> stopMeetingTranscriptionRequest) Stops transcription for the specifiedmeetingId
.stopMeetingTranscription
(StopMeetingTranscriptionRequest stopMeetingTranscriptionRequest) Stops transcription for the specifiedmeetingId
.default CompletableFuture
<TagResourceResponse> tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) The resource that supports tags.default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) The resource that supports tags.default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes the specified tags from the specified resources.default CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) Removes the specified tags from the specified resources.updateAttendeeCapabilities
(Consumer<UpdateAttendeeCapabilitiesRequest.Builder> updateAttendeeCapabilitiesRequest) The capabilities that you want to update.updateAttendeeCapabilities
(UpdateAttendeeCapabilitiesRequest updateAttendeeCapabilitiesRequest) The capabilities that you want to update.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
batchCreateAttendee
default CompletableFuture<BatchCreateAttendeeResponse> batchCreateAttendee(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.
- Parameters:
batchCreateAttendeeRequest
-- Returns:
- A Java Future containing the result of the BatchCreateAttendee operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- NotFoundException One or more of the resources in the request does not exist in the system.
- UnauthorizedException The user isn't authorized to request a resource.
- UnprocessableEntityException The request was well-formed but was unable to be followed due to semantic errors.
- LimitExceededException The request exceeds the resource limit.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- ThrottlingException The number of customer requests exceeds the request rate limit.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMeetingsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchCreateAttendee
default CompletableFuture<BatchCreateAttendeeResponse> batchCreateAttendee(Consumer<BatchCreateAttendeeRequest.Builder> 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.
This is a convenience which creates an instance of the
BatchCreateAttendeeRequest.Builder
avoiding the need to create one manually viaBatchCreateAttendeeRequest.builder()
- Parameters:
batchCreateAttendeeRequest
- AConsumer
that will call methods onBatchCreateAttendeeRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the BatchCreateAttendee operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- NotFoundException One or more of the resources in the request does not exist in the system.
- UnauthorizedException The user isn't authorized to request a resource.
- UnprocessableEntityException The request was well-formed but was unable to be followed due to semantic errors.
- LimitExceededException The request exceeds the resource limit.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- ThrottlingException The number of customer requests exceeds the request rate limit.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMeetingsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchUpdateAttendeeCapabilitiesExcept
default CompletableFuture<BatchUpdateAttendeeCapabilitiesExceptResponse> batchUpdateAttendeeCapabilitiesExcept(BatchUpdateAttendeeCapabilitiesExceptRequest batchUpdateAttendeeCapabilitiesExceptRequest) Updates
AttendeeCapabilities
except the capabilities listed in anExcludedAttendeeIds
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 includeSendReceive
,Send
, orReceive
forAttendeeCapabilities:Video
will be rejected withValidationError 400
. -
If you specify
MeetingFeatures:Content:MaxResolution:None
when you create a meeting, all API requests that includeSendReceive
,Send
, orReceive
forAttendeeCapabilities:Content
will be rejected withValidationError 400
. -
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 attendees can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.
- Parameters:
batchUpdateAttendeeCapabilitiesExceptRequest
-- Returns:
- A Java Future containing the result of the BatchUpdateAttendeeCapabilitiesExcept operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- BadRequestException The input parameters don't match the service's restrictions.
- ConflictException Multiple instances of the same request have been made simultaneously.
- UnauthorizedException The user isn't authorized to request a resource.
- NotFoundException One or more of the resources in the request does not exist in the system.
- ForbiddenException The client is permanently forbidden from making the request.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- ThrottlingException The number of customer requests exceeds the request rate limit.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMeetingsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
batchUpdateAttendeeCapabilitiesExcept
default CompletableFuture<BatchUpdateAttendeeCapabilitiesExceptResponse> batchUpdateAttendeeCapabilitiesExcept(Consumer<BatchUpdateAttendeeCapabilitiesExceptRequest.Builder> batchUpdateAttendeeCapabilitiesExceptRequest) Updates
AttendeeCapabilities
except the capabilities listed in anExcludedAttendeeIds
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 includeSendReceive
,Send
, orReceive
forAttendeeCapabilities:Video
will be rejected withValidationError 400
. -
If you specify
MeetingFeatures:Content:MaxResolution:None
when you create a meeting, all API requests that includeSendReceive
,Send
, orReceive
forAttendeeCapabilities:Content
will be rejected withValidationError 400
. -
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 attendees can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.
This is a convenience which creates an instance of the
BatchUpdateAttendeeCapabilitiesExceptRequest.Builder
avoiding the need to create one manually viaBatchUpdateAttendeeCapabilitiesExceptRequest.builder()
- Parameters:
batchUpdateAttendeeCapabilitiesExceptRequest
- AConsumer
that will call methods onBatchUpdateAttendeeCapabilitiesExceptRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the BatchUpdateAttendeeCapabilitiesExcept operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- BadRequestException The input parameters don't match the service's restrictions.
- ConflictException Multiple instances of the same request have been made simultaneously.
- UnauthorizedException The user isn't authorized to request a resource.
- NotFoundException One or more of the resources in the request does not exist in the system.
- ForbiddenException The client is permanently forbidden from making the request.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- ThrottlingException The number of customer requests exceeds the request rate limit.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMeetingsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createAttendee
default CompletableFuture<CreateAttendeeResponse> createAttendee(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.
- Parameters:
createAttendeeRequest
-- Returns:
- A Java Future containing the result of the CreateAttendee operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- NotFoundException One or more of the resources in the request does not exist in the system.
- UnauthorizedException The user isn't authorized to request a resource.
- UnprocessableEntityException The request was well-formed but was unable to be followed due to semantic errors.
- LimitExceededException The request exceeds the resource limit.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- ThrottlingException The number of customer requests exceeds the request rate limit.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMeetingsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createAttendee
default CompletableFuture<CreateAttendeeResponse> createAttendee(Consumer<CreateAttendeeRequest.Builder> 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.
This is a convenience which creates an instance of the
CreateAttendeeRequest.Builder
avoiding the need to create one manually viaCreateAttendeeRequest.builder()
- Parameters:
createAttendeeRequest
- AConsumer
that will call methods onCreateAttendeeRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateAttendee operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- NotFoundException One or more of the resources in the request does not exist in the system.
- UnauthorizedException The user isn't authorized to request a resource.
- UnprocessableEntityException The request was well-formed but was unable to be followed due to semantic errors.
- LimitExceededException The request exceeds the resource limit.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- ThrottlingException The number of customer requests exceeds the request rate limit.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMeetingsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createMeeting
default CompletableFuture<CreateMeetingResponse> createMeeting(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.
- Parameters:
createMeetingRequest
-- Returns:
- A Java Future containing the result of the CreateMeeting operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- BadRequestException The input parameters don't match the service's restrictions.
- ConflictException Multiple instances of the same request have been made simultaneously.
- ForbiddenException The client is permanently forbidden from making the request.
- UnauthorizedException The user isn't authorized to request a resource.
- ThrottlingException The number of customer requests exceeds the request rate limit.
- ServiceFailureException The service encountered an unexpected error.
- ServiceUnavailableException The service is currently unavailable.
- LimitExceededException The request exceeds the resource limit.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMeetingsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createMeeting
default CompletableFuture<CreateMeetingResponse> createMeeting(Consumer<CreateMeetingRequest.Builder> 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.
This is a convenience which creates an instance of the
CreateMeetingRequest.Builder
avoiding the need to create one manually viaCreateMeetingRequest.builder()
- Parameters:
createMeetingRequest
- AConsumer
that will call methods onCreateMeetingRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateMeeting operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- BadRequestException The input parameters don't match the service's restrictions.
- ConflictException Multiple instances of the same request have been made simultaneously.
- ForbiddenException The client is permanently forbidden from making the request.
- UnauthorizedException The user isn't authorized to request a resource.
- ThrottlingException The number of customer requests exceeds the request rate limit.
- ServiceFailureException The service encountered an unexpected error.
- ServiceUnavailableException The service is currently unavailable.
- LimitExceededException The request exceeds the resource limit.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMeetingsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createMeetingWithAttendees
default CompletableFuture<CreateMeetingWithAttendeesResponse> createMeetingWithAttendees(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.
- Parameters:
createMeetingWithAttendeesRequest
-- Returns:
- A Java Future containing the result of the CreateMeetingWithAttendees operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- BadRequestException The input parameters don't match the service's restrictions.
- ConflictException Multiple instances of the same request have been made simultaneously.
- ForbiddenException The client is permanently forbidden from making the request.
- UnauthorizedException The user isn't authorized to request a resource.
- ThrottlingException The number of customer requests exceeds the request rate limit.
- ServiceFailureException The service encountered an unexpected error.
- ServiceUnavailableException The service is currently unavailable.
- LimitExceededException The request exceeds the resource limit.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMeetingsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createMeetingWithAttendees
default CompletableFuture<CreateMeetingWithAttendeesResponse> createMeetingWithAttendees(Consumer<CreateMeetingWithAttendeesRequest.Builder> 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.
This is a convenience which creates an instance of the
CreateMeetingWithAttendeesRequest.Builder
avoiding the need to create one manually viaCreateMeetingWithAttendeesRequest.builder()
- Parameters:
createMeetingWithAttendeesRequest
- AConsumer
that will call methods onCreateMeetingWithAttendeesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateMeetingWithAttendees operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- BadRequestException The input parameters don't match the service's restrictions.
- ConflictException Multiple instances of the same request have been made simultaneously.
- ForbiddenException The client is permanently forbidden from making the request.
- UnauthorizedException The user isn't authorized to request a resource.
- ThrottlingException The number of customer requests exceeds the request rate limit.
- ServiceFailureException The service encountered an unexpected error.
- ServiceUnavailableException The service is currently unavailable.
- LimitExceededException The request exceeds the resource limit.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMeetingsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAttendee
default CompletableFuture<DeleteAttendeeResponse> deleteAttendee(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.- Parameters:
deleteAttendeeRequest
-- Returns:
- A Java Future containing the result of the DeleteAttendee operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- NotFoundException One or more of the resources in the request does not exist in the system.
- UnauthorizedException The user isn't authorized to request a resource.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- ThrottlingException The number of customer requests exceeds the request rate limit.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMeetingsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAttendee
default CompletableFuture<DeleteAttendeeResponse> deleteAttendee(Consumer<DeleteAttendeeRequest.Builder> 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.
This is a convenience which creates an instance of the
DeleteAttendeeRequest.Builder
avoiding the need to create one manually viaDeleteAttendeeRequest.builder()
- Parameters:
deleteAttendeeRequest
- AConsumer
that will call methods onDeleteAttendeeRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteAttendee operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- NotFoundException One or more of the resources in the request does not exist in the system.
- UnauthorizedException The user isn't authorized to request a resource.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- ThrottlingException The number of customer requests exceeds the request rate limit.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMeetingsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteMeeting
default CompletableFuture<DeleteMeetingResponse> deleteMeeting(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.
- Parameters:
deleteMeetingRequest
-- Returns:
- A Java Future containing the result of the DeleteMeeting operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- UnauthorizedException The user isn't authorized to request a resource.
- NotFoundException One or more of the resources in the request does not exist in the system.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- ThrottlingException The number of customer requests exceeds the request rate limit.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMeetingsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteMeeting
default CompletableFuture<DeleteMeetingResponse> deleteMeeting(Consumer<DeleteMeetingRequest.Builder> 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.
This is a convenience which creates an instance of the
DeleteMeetingRequest.Builder
avoiding the need to create one manually viaDeleteMeetingRequest.builder()
- Parameters:
deleteMeetingRequest
- AConsumer
that will call methods onDeleteMeetingRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteMeeting operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- UnauthorizedException The user isn't authorized to request a resource.
- NotFoundException One or more of the resources in the request does not exist in the system.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- ThrottlingException The number of customer requests exceeds the request rate limit.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMeetingsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAttendee
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.
- Parameters:
getAttendeeRequest
-- Returns:
- A Java Future containing the result of the GetAttendee operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- NotFoundException One or more of the resources in the request does not exist in the system.
- UnauthorizedException The user isn't authorized to request a resource.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- ThrottlingException The number of customer requests exceeds the request rate limit.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMeetingsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAttendee
default CompletableFuture<GetAttendeeResponse> getAttendee(Consumer<GetAttendeeRequest.Builder> 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.
This is a convenience which creates an instance of the
GetAttendeeRequest.Builder
avoiding the need to create one manually viaGetAttendeeRequest.builder()
- Parameters:
getAttendeeRequest
- AConsumer
that will call methods onGetAttendeeRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetAttendee operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- NotFoundException One or more of the resources in the request does not exist in the system.
- UnauthorizedException The user isn't authorized to request a resource.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- ThrottlingException The number of customer requests exceeds the request rate limit.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMeetingsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getMeeting
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.
- Parameters:
getMeetingRequest
-- Returns:
- A Java Future containing the result of the GetMeeting operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- NotFoundException One or more of the resources in the request does not exist in the system.
- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- UnauthorizedException The user isn't authorized to request a resource.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- ThrottlingException The number of customer requests exceeds the request rate limit.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMeetingsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getMeeting
default CompletableFuture<GetMeetingResponse> getMeeting(Consumer<GetMeetingRequest.Builder> 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.
This is a convenience which creates an instance of the
GetMeetingRequest.Builder
avoiding the need to create one manually viaGetMeetingRequest.builder()
- Parameters:
getMeetingRequest
- AConsumer
that will call methods onGetMeetingRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetMeeting operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- NotFoundException One or more of the resources in the request does not exist in the system.
- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- UnauthorizedException The user isn't authorized to request a resource.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- ThrottlingException The number of customer requests exceeds the request rate limit.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMeetingsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAttendees
default CompletableFuture<ListAttendeesResponse> listAttendees(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.
- Parameters:
listAttendeesRequest
-- Returns:
- A Java Future containing the result of the ListAttendees operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- NotFoundException One or more of the resources in the request does not exist in the system.
- UnauthorizedException The user isn't authorized to request a resource.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- ThrottlingException The number of customer requests exceeds the request rate limit.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMeetingsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAttendees
default CompletableFuture<ListAttendeesResponse> listAttendees(Consumer<ListAttendeesRequest.Builder> 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.
This is a convenience which creates an instance of the
ListAttendeesRequest.Builder
avoiding the need to create one manually viaListAttendeesRequest.builder()
- Parameters:
listAttendeesRequest
- AConsumer
that will call methods onListAttendeesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListAttendees operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- NotFoundException One or more of the resources in the request does not exist in the system.
- UnauthorizedException The user isn't authorized to request a resource.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- ThrottlingException The number of customer requests exceeds the request rate limit.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMeetingsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAttendeesPaginator
This is a variant of
listAttendees(software.amazon.awssdk.services.chimesdkmeetings.model.ListAttendeesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chimesdkmeetings.paginators.ListAttendeesPublisher publisher = client.listAttendeesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chimesdkmeetings.paginators.ListAttendeesPublisher publisher = client.listAttendeesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chimesdkmeetings.model.ListAttendeesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chimesdkmeetings.model.ListAttendeesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAttendees(software.amazon.awssdk.services.chimesdkmeetings.model.ListAttendeesRequest)
operation.- Parameters:
listAttendeesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- NotFoundException One or more of the resources in the request does not exist in the system.
- UnauthorizedException The user isn't authorized to request a resource.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- ThrottlingException The number of customer requests exceeds the request rate limit.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMeetingsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAttendeesPaginator
default ListAttendeesPublisher listAttendeesPaginator(Consumer<ListAttendeesRequest.Builder> listAttendeesRequest) This is a variant of
listAttendees(software.amazon.awssdk.services.chimesdkmeetings.model.ListAttendeesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chimesdkmeetings.paginators.ListAttendeesPublisher publisher = client.listAttendeesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chimesdkmeetings.paginators.ListAttendeesPublisher publisher = client.listAttendeesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chimesdkmeetings.model.ListAttendeesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chimesdkmeetings.model.ListAttendeesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAttendees(software.amazon.awssdk.services.chimesdkmeetings.model.ListAttendeesRequest)
operation.
This is a convenience which creates an instance of the
ListAttendeesRequest.Builder
avoiding the need to create one manually viaListAttendeesRequest.builder()
- Parameters:
listAttendeesRequest
- AConsumer
that will call methods onListAttendeesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- NotFoundException One or more of the resources in the request does not exist in the system.
- UnauthorizedException The user isn't authorized to request a resource.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- ThrottlingException The number of customer requests exceeds the request rate limit.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMeetingsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Returns a list of the tags available for the specified resource.
- Parameters:
listTagsForResourceRequest
-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- UnauthorizedException The user isn't authorized to request a resource.
- LimitExceededException The request exceeds the resource limit.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- ThrottlingException The number of customer requests exceeds the request rate limit.
- ResourceNotFoundException The resource that you want to tag couldn't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMeetingsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Returns a list of the tags available for the specified resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- UnauthorizedException The user isn't authorized to request a resource.
- LimitExceededException The request exceeds the resource limit.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- ThrottlingException The number of customer requests exceeds the request rate limit.
- ResourceNotFoundException The resource that you want to tag couldn't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMeetingsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startMeetingTranscription
default CompletableFuture<StartMeetingTranscriptionResponse> startMeetingTranscription(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 theBadRequestException
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.
- Parameters:
startMeetingTranscriptionRequest
-- Returns:
- A Java Future containing the result of the StartMeetingTranscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- NotFoundException One or more of the resources in the request does not exist in the system.
- ForbiddenException The client is permanently forbidden from making the request.
- BadRequestException The input parameters don't match the service's restrictions.
- UnauthorizedException The user isn't authorized to request a resource.
- LimitExceededException The request exceeds the resource limit.
- UnprocessableEntityException The request was well-formed but was unable to be followed due to semantic errors.
- ThrottlingException The number of customer requests exceeds the request rate limit.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMeetingsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startMeetingTranscription
default CompletableFuture<StartMeetingTranscriptionResponse> startMeetingTranscription(Consumer<StartMeetingTranscriptionRequest.Builder> 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 theBadRequestException
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.
This is a convenience which creates an instance of the
StartMeetingTranscriptionRequest.Builder
avoiding the need to create one manually viaStartMeetingTranscriptionRequest.builder()
- Parameters:
startMeetingTranscriptionRequest
- AConsumer
that will call methods onStartMeetingTranscriptionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartMeetingTranscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- NotFoundException One or more of the resources in the request does not exist in the system.
- ForbiddenException The client is permanently forbidden from making the request.
- BadRequestException The input parameters don't match the service's restrictions.
- UnauthorizedException The user isn't authorized to request a resource.
- LimitExceededException The request exceeds the resource limit.
- UnprocessableEntityException The request was well-formed but was unable to be followed due to semantic errors.
- ThrottlingException The number of customer requests exceeds the request rate limit.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMeetingsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopMeetingTranscription
default CompletableFuture<StopMeetingTranscriptionResponse> stopMeetingTranscription(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.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:
stopMeetingTranscriptionRequest
-- Returns:
- A Java Future containing the result of the StopMeetingTranscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ForbiddenException The client is permanently forbidden from making the request.
- NotFoundException One or more of the resources in the request does not exist in the system.
- BadRequestException The input parameters don't match the service's restrictions.
- UnauthorizedException The user isn't authorized to request a resource.
- UnprocessableEntityException The request was well-formed but was unable to be followed due to semantic errors.
- ThrottlingException The number of customer requests exceeds the request rate limit.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMeetingsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopMeetingTranscription
default CompletableFuture<StopMeetingTranscriptionResponse> stopMeetingTranscription(Consumer<StopMeetingTranscriptionRequest.Builder> 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.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.
This is a convenience which creates an instance of the
StopMeetingTranscriptionRequest.Builder
avoiding the need to create one manually viaStopMeetingTranscriptionRequest.builder()
- Parameters:
stopMeetingTranscriptionRequest
- AConsumer
that will call methods onStopMeetingTranscriptionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StopMeetingTranscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ForbiddenException The client is permanently forbidden from making the request.
- NotFoundException One or more of the resources in the request does not exist in the system.
- BadRequestException The input parameters don't match the service's restrictions.
- UnauthorizedException The user isn't authorized to request a resource.
- UnprocessableEntityException The request was well-formed but was unable to be followed due to semantic errors.
- ThrottlingException The number of customer requests exceeds the request rate limit.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMeetingsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
The resource that supports tags.
- Parameters:
tagResourceRequest
-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- UnauthorizedException The user isn't authorized to request a resource.
- LimitExceededException The request exceeds the resource limit.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- ThrottlingException The number of customer requests exceeds the request rate limit.
- ResourceNotFoundException The resource that you want to tag couldn't be found.
- TooManyTagsException Too many tags were added to the specified resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMeetingsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) The resource that supports tags.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- UnauthorizedException The user isn't authorized to request a resource.
- LimitExceededException The request exceeds the resource limit.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- ThrottlingException The number of customer requests exceeds the request rate limit.
- ResourceNotFoundException The resource that you want to tag couldn't be found.
- TooManyTagsException Too many tags were added to the specified resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMeetingsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(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 Amazon Web Services Region for the calling Amazon Web Services 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 theUntagResources
operation, you must have both of the following permissions:tag:UntagResource
ChimeSDKMeetings:DeleteTags
- Parameters:
untagResourceRequest
-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- UnauthorizedException The user isn't authorized to request a resource.
- LimitExceededException The request exceeds the resource limit.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- ThrottlingException The number of customer requests exceeds the request rate limit.
- ResourceNotFoundException The resource that you want to tag couldn't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMeetingsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> 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 Amazon Web Services Region for the calling Amazon Web Services 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 theUntagResources
operation, you must have both of the following permissions:tag:UntagResource
ChimeSDKMeetings:DeleteTags
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- UnauthorizedException The user isn't authorized to request a resource.
- LimitExceededException The request exceeds the resource limit.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- ThrottlingException The number of customer requests exceeds the request rate limit.
- ResourceNotFoundException The resource that you want to tag couldn't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMeetingsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
updateAttendeeCapabilities
default CompletableFuture<UpdateAttendeeCapabilitiesResponse> updateAttendeeCapabilities(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:
-
If you specify
MeetingFeatures:Video:MaxResolution:None
when you create a meeting, all API requests that includeSendReceive
,Send
, orReceive
forAttendeeCapabilities:Video
will be rejected withValidationError 400
. -
If you specify
MeetingFeatures:Content:MaxResolution:None
when you create a meeting, all API requests that includeSendReceive
,Send
, orReceive
forAttendeeCapabilities:Content
will be rejected withValidationError 400
. -
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 attendees can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.
- Parameters:
updateAttendeeCapabilitiesRequest
-- Returns:
- A Java Future containing the result of the UpdateAttendeeCapabilities operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- BadRequestException The input parameters don't match the service's restrictions.
- ConflictException Multiple instances of the same request have been made simultaneously.
- UnauthorizedException The user isn't authorized to request a resource.
- NotFoundException One or more of the resources in the request does not exist in the system.
- ForbiddenException The client is permanently forbidden from making the request.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- ThrottlingException The number of customer requests exceeds the request rate limit.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMeetingsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
updateAttendeeCapabilities
default CompletableFuture<UpdateAttendeeCapabilitiesResponse> updateAttendeeCapabilities(Consumer<UpdateAttendeeCapabilitiesRequest.Builder> 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:
-
If you specify
MeetingFeatures:Video:MaxResolution:None
when you create a meeting, all API requests that includeSendReceive
,Send
, orReceive
forAttendeeCapabilities:Video
will be rejected withValidationError 400
. -
If you specify
MeetingFeatures:Content:MaxResolution:None
when you create a meeting, all API requests that includeSendReceive
,Send
, orReceive
forAttendeeCapabilities:Content
will be rejected withValidationError 400
. -
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 attendees can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.
This is a convenience which creates an instance of the
UpdateAttendeeCapabilitiesRequest.Builder
avoiding the need to create one manually viaUpdateAttendeeCapabilitiesRequest.builder()
- Parameters:
updateAttendeeCapabilitiesRequest
- AConsumer
that will call methods onUpdateAttendeeCapabilitiesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateAttendeeCapabilities operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- BadRequestException The input parameters don't match the service's restrictions.
- ConflictException Multiple instances of the same request have been made simultaneously.
- UnauthorizedException The user isn't authorized to request a resource.
- NotFoundException One or more of the resources in the request does not exist in the system.
- ForbiddenException The client is permanently forbidden from making the request.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- ThrottlingException The number of customer requests exceeds the request rate limit.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMeetingsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aChimeSdkMeetingsAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aChimeSdkMeetingsAsyncClient
.
-