Interface ChimeSdkMeetingsClient
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
builder()
method.
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
FieldsModifier and TypeFieldDescriptionstatic final StringValue for looking up the service's metadata from theServiceMetadataProvider.static final String -
Method Summary
Modifier and TypeMethodDescriptiondefault BatchCreateAttendeeResponsebatchCreateAttendee(Consumer<BatchCreateAttendeeRequest.Builder> batchCreateAttendeeRequest) Creates up to 100 attendees for an active Amazon Chime SDK meeting.default BatchCreateAttendeeResponsebatchCreateAttendee(BatchCreateAttendeeRequest batchCreateAttendeeRequest) Creates up to 100 attendees for an active Amazon Chime SDK meeting.batchUpdateAttendeeCapabilitiesExcept(Consumer<BatchUpdateAttendeeCapabilitiesExceptRequest.Builder> batchUpdateAttendeeCapabilitiesExceptRequest) UpdatesAttendeeCapabilitiesexcept the capabilities listed in anExcludedAttendeeIdstable.batchUpdateAttendeeCapabilitiesExcept(BatchUpdateAttendeeCapabilitiesExceptRequest batchUpdateAttendeeCapabilitiesExceptRequest) UpdatesAttendeeCapabilitiesexcept the capabilities listed in anExcludedAttendeeIdstable.builder()Create a builder that can be used to configure and create aChimeSdkMeetingsClient.static ChimeSdkMeetingsClientcreate()Create aChimeSdkMeetingsClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CreateAttendeeResponsecreateAttendee(Consumer<CreateAttendeeRequest.Builder> createAttendeeRequest) Creates a new attendee for an active Amazon Chime SDK meeting.default CreateAttendeeResponsecreateAttendee(CreateAttendeeRequest createAttendeeRequest) Creates a new attendee for an active Amazon Chime SDK meeting.default CreateMeetingResponsecreateMeeting(Consumer<CreateMeetingRequest.Builder> createMeetingRequest) Creates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees.default CreateMeetingResponsecreateMeeting(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 DeleteAttendeeResponsedeleteAttendee(Consumer<DeleteAttendeeRequest.Builder> deleteAttendeeRequest) Deletes an attendee from the specified Amazon Chime SDK meeting and deletes theirJoinToken.default DeleteAttendeeResponsedeleteAttendee(DeleteAttendeeRequest deleteAttendeeRequest) Deletes an attendee from the specified Amazon Chime SDK meeting and deletes theirJoinToken.default DeleteMeetingResponsedeleteMeeting(Consumer<DeleteMeetingRequest.Builder> deleteMeetingRequest) Deletes the specified Amazon Chime SDK meeting.default DeleteMeetingResponsedeleteMeeting(DeleteMeetingRequest deleteMeetingRequest) Deletes the specified Amazon Chime SDK meeting.default GetAttendeeResponsegetAttendee(Consumer<GetAttendeeRequest.Builder> getAttendeeRequest) Gets the Amazon Chime SDK attendee details for a specified meeting ID and attendee ID.default GetAttendeeResponsegetAttendee(GetAttendeeRequest getAttendeeRequest) Gets the Amazon Chime SDK attendee details for a specified meeting ID and attendee ID.default GetMeetingResponsegetMeeting(Consumer<GetMeetingRequest.Builder> getMeetingRequest) Gets the Amazon Chime SDK meeting details for the specified meeting ID.default GetMeetingResponsegetMeeting(GetMeetingRequest getMeetingRequest) Gets the Amazon Chime SDK meeting details for the specified meeting ID.default ListAttendeesResponselistAttendees(Consumer<ListAttendeesRequest.Builder> listAttendeesRequest) Lists the attendees for the specified Amazon Chime SDK meeting.default ListAttendeesResponselistAttendees(ListAttendeesRequest listAttendeesRequest) Lists the attendees for the specified Amazon Chime SDK meeting.default ListAttendeesIterablelistAttendeesPaginator(Consumer<ListAttendeesRequest.Builder> listAttendeesRequest) This is a variant oflistAttendees(software.amazon.awssdk.services.chimesdkmeetings.model.ListAttendeesRequest)operation.default ListAttendeesIterablelistAttendeesPaginator(ListAttendeesRequest listAttendeesRequest) This is a variant oflistAttendees(software.amazon.awssdk.services.chimesdkmeetings.model.ListAttendeesRequest)operation.default ListTagsForResourceResponselistTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Returns a list of the tags available for the specified resource.default ListTagsForResourceResponselistTagsForResource(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., ClientOverrideConfigurationstatic ServiceMetadatastartMeetingTranscription(Consumer<StartMeetingTranscriptionRequest.Builder> startMeetingTranscriptionRequest) Starts transcription for the specifiedmeetingId.startMeetingTranscription(StartMeetingTranscriptionRequest startMeetingTranscriptionRequest) Starts transcription for the specifiedmeetingId.default StopMeetingTranscriptionResponsestopMeetingTranscription(Consumer<StopMeetingTranscriptionRequest.Builder> stopMeetingTranscriptionRequest) Stops transcription for the specifiedmeetingId.default StopMeetingTranscriptionResponsestopMeetingTranscription(StopMeetingTranscriptionRequest stopMeetingTranscriptionRequest) Stops transcription for the specifiedmeetingId.default TagResourceResponsetagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) The resource that supports tags.default TagResourceResponsetagResource(TagResourceRequest tagResourceRequest) The resource that supports tags.default UntagResourceResponseuntagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes the specified tags from the specified resources.default UntagResourceResponseuntagResource(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
closeMethods 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 BatchCreateAttendeeResponse batchCreateAttendee(BatchCreateAttendeeRequest batchCreateAttendeeRequest) throws BadRequestException, ForbiddenException, NotFoundException, UnauthorizedException, UnprocessableEntityException, LimitExceededException, ServiceUnavailableException, ServiceFailureException, ThrottlingException, AwsServiceException, SdkClientException, ChimeSdkMeetingsException 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:
- Result of the BatchCreateAttendee operation returned by the service.
- See Also:
-
batchCreateAttendee
default BatchCreateAttendeeResponse batchCreateAttendee(Consumer<BatchCreateAttendeeRequest.Builder> batchCreateAttendeeRequest) throws BadRequestException, ForbiddenException, NotFoundException, UnauthorizedException, UnprocessableEntityException, LimitExceededException, ServiceUnavailableException, ServiceFailureException, ThrottlingException, AwsServiceException, SdkClientException, ChimeSdkMeetingsException 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.Builderavoiding the need to create one manually viaBatchCreateAttendeeRequest.builder()- Parameters:
batchCreateAttendeeRequest- AConsumerthat will call methods onBatchCreateAttendeeRequest.Builderto create a request.- Returns:
- Result of the BatchCreateAttendee operation returned by the service.
- See Also:
-
batchUpdateAttendeeCapabilitiesExcept
default BatchUpdateAttendeeCapabilitiesExceptResponse batchUpdateAttendeeCapabilitiesExcept(BatchUpdateAttendeeCapabilitiesExceptRequest batchUpdateAttendeeCapabilitiesExceptRequest) throws BadRequestException, ConflictException, UnauthorizedException, NotFoundException, ForbiddenException, ServiceUnavailableException, ServiceFailureException, ThrottlingException, AwsServiceException, SdkClientException, ChimeSdkMeetingsException Updates
AttendeeCapabilitiesexcept the capabilities listed in anExcludedAttendeeIdstable.You use the capabilities with a set of values that control what the capabilities can do, such as
SendReceivedata. For more information about those values, see .When using capabilities, be aware of these corner cases:
-
If you specify
MeetingFeatures:Video:MaxResolution:Nonewhen you create a meeting, all API requests that includeSendReceive,Send, orReceiveforAttendeeCapabilities:Videowill be rejected withValidationError 400. -
If you specify
MeetingFeatures:Content:MaxResolution:Nonewhen you create a meeting, all API requests that includeSendReceive,Send, orReceiveforAttendeeCapabilities:Contentwill be rejected withValidationError 400. -
You can't set
contentcapabilities toSendReceiveorReceiveunless you also setvideocapabilities toSendReceiveorReceive. If you don't set thevideocapability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set yourvideocapability to receive and you set yourcontentcapability to not receive. -
When you change an
audiocapability fromNoneorReceivetoSendorSendReceive, and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants. -
When you change a
videoorcontentcapability fromNoneorReceivetoSendorSendReceive, 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:
- Result of the BatchUpdateAttendeeCapabilitiesExcept operation returned by the service.
- See Also:
-
-
batchUpdateAttendeeCapabilitiesExcept
default BatchUpdateAttendeeCapabilitiesExceptResponse batchUpdateAttendeeCapabilitiesExcept(Consumer<BatchUpdateAttendeeCapabilitiesExceptRequest.Builder> batchUpdateAttendeeCapabilitiesExceptRequest) throws BadRequestException, ConflictException, UnauthorizedException, NotFoundException, ForbiddenException, ServiceUnavailableException, ServiceFailureException, ThrottlingException, AwsServiceException, SdkClientException, ChimeSdkMeetingsException Updates
AttendeeCapabilitiesexcept the capabilities listed in anExcludedAttendeeIdstable.You use the capabilities with a set of values that control what the capabilities can do, such as
SendReceivedata. For more information about those values, see .When using capabilities, be aware of these corner cases:
-
If you specify
MeetingFeatures:Video:MaxResolution:Nonewhen you create a meeting, all API requests that includeSendReceive,Send, orReceiveforAttendeeCapabilities:Videowill be rejected withValidationError 400. -
If you specify
MeetingFeatures:Content:MaxResolution:Nonewhen you create a meeting, all API requests that includeSendReceive,Send, orReceiveforAttendeeCapabilities:Contentwill be rejected withValidationError 400. -
You can't set
contentcapabilities toSendReceiveorReceiveunless you also setvideocapabilities toSendReceiveorReceive. If you don't set thevideocapability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set yourvideocapability to receive and you set yourcontentcapability to not receive. -
When you change an
audiocapability fromNoneorReceivetoSendorSendReceive, and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants. -
When you change a
videoorcontentcapability fromNoneorReceivetoSendorSendReceive, 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.Builderavoiding the need to create one manually viaBatchUpdateAttendeeCapabilitiesExceptRequest.builder()- Parameters:
batchUpdateAttendeeCapabilitiesExceptRequest- AConsumerthat will call methods onBatchUpdateAttendeeCapabilitiesExceptRequest.Builderto create a request.- Returns:
- Result of the BatchUpdateAttendeeCapabilitiesExcept operation returned by the service.
- See Also:
-
-
createAttendee
default CreateAttendeeResponse createAttendee(CreateAttendeeRequest createAttendeeRequest) throws BadRequestException, ForbiddenException, NotFoundException, UnauthorizedException, UnprocessableEntityException, LimitExceededException, ServiceUnavailableException, ServiceFailureException, ThrottlingException, AwsServiceException, SdkClientException, ChimeSdkMeetingsException 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:
- Result of the CreateAttendee operation returned by the service.
- See Also:
-
createAttendee
default CreateAttendeeResponse createAttendee(Consumer<CreateAttendeeRequest.Builder> createAttendeeRequest) throws BadRequestException, ForbiddenException, NotFoundException, UnauthorizedException, UnprocessableEntityException, LimitExceededException, ServiceUnavailableException, ServiceFailureException, ThrottlingException, AwsServiceException, SdkClientException, ChimeSdkMeetingsException 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.Builderavoiding the need to create one manually viaCreateAttendeeRequest.builder()- Parameters:
createAttendeeRequest- AConsumerthat will call methods onCreateAttendeeRequest.Builderto create a request.- Returns:
- Result of the CreateAttendee operation returned by the service.
- See Also:
-
createMeeting
default CreateMeetingResponse createMeeting(CreateMeetingRequest createMeetingRequest) throws BadRequestException, ConflictException, ForbiddenException, UnauthorizedException, ThrottlingException, ServiceFailureException, ServiceUnavailableException, LimitExceededException, AwsServiceException, SdkClientException, ChimeSdkMeetingsException 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:
- Result of the CreateMeeting operation returned by the service.
- See Also:
-
createMeeting
default CreateMeetingResponse createMeeting(Consumer<CreateMeetingRequest.Builder> createMeetingRequest) throws BadRequestException, ConflictException, ForbiddenException, UnauthorizedException, ThrottlingException, ServiceFailureException, ServiceUnavailableException, LimitExceededException, AwsServiceException, SdkClientException, ChimeSdkMeetingsException 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.Builderavoiding the need to create one manually viaCreateMeetingRequest.builder()- Parameters:
createMeetingRequest- AConsumerthat will call methods onCreateMeetingRequest.Builderto create a request.- Returns:
- Result of the CreateMeeting operation returned by the service.
- See Also:
-
createMeetingWithAttendees
default CreateMeetingWithAttendeesResponse createMeetingWithAttendees(CreateMeetingWithAttendeesRequest createMeetingWithAttendeesRequest) throws BadRequestException, ConflictException, ForbiddenException, UnauthorizedException, ThrottlingException, ServiceFailureException, ServiceUnavailableException, LimitExceededException, AwsServiceException, SdkClientException, ChimeSdkMeetingsException 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:
- Result of the CreateMeetingWithAttendees operation returned by the service.
- See Also:
-
createMeetingWithAttendees
default CreateMeetingWithAttendeesResponse createMeetingWithAttendees(Consumer<CreateMeetingWithAttendeesRequest.Builder> createMeetingWithAttendeesRequest) throws BadRequestException, ConflictException, ForbiddenException, UnauthorizedException, ThrottlingException, ServiceFailureException, ServiceUnavailableException, LimitExceededException, AwsServiceException, SdkClientException, ChimeSdkMeetingsException 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.Builderavoiding the need to create one manually viaCreateMeetingWithAttendeesRequest.builder()- Parameters:
createMeetingWithAttendeesRequest- AConsumerthat will call methods onCreateMeetingWithAttendeesRequest.Builderto create a request.- Returns:
- Result of the CreateMeetingWithAttendees operation returned by the service.
- See Also:
-
deleteAttendee
default DeleteAttendeeResponse deleteAttendee(DeleteAttendeeRequest deleteAttendeeRequest) throws BadRequestException, ForbiddenException, NotFoundException, UnauthorizedException, ServiceUnavailableException, ServiceFailureException, ThrottlingException, AwsServiceException, SdkClientException, ChimeSdkMeetingsException 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:
- Result of the DeleteAttendee operation returned by the service.
- See Also:
-
deleteAttendee
default DeleteAttendeeResponse deleteAttendee(Consumer<DeleteAttendeeRequest.Builder> deleteAttendeeRequest) throws BadRequestException, ForbiddenException, NotFoundException, UnauthorizedException, ServiceUnavailableException, ServiceFailureException, ThrottlingException, AwsServiceException, SdkClientException, ChimeSdkMeetingsException 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.Builderavoiding the need to create one manually viaDeleteAttendeeRequest.builder()- Parameters:
deleteAttendeeRequest- AConsumerthat will call methods onDeleteAttendeeRequest.Builderto create a request.- Returns:
- Result of the DeleteAttendee operation returned by the service.
- See Also:
-
deleteMeeting
default DeleteMeetingResponse deleteMeeting(DeleteMeetingRequest deleteMeetingRequest) throws BadRequestException, ForbiddenException, UnauthorizedException, NotFoundException, ServiceUnavailableException, ServiceFailureException, ThrottlingException, AwsServiceException, SdkClientException, ChimeSdkMeetingsException 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:
- Result of the DeleteMeeting operation returned by the service.
- See Also:
-
deleteMeeting
default DeleteMeetingResponse deleteMeeting(Consumer<DeleteMeetingRequest.Builder> deleteMeetingRequest) throws BadRequestException, ForbiddenException, UnauthorizedException, NotFoundException, ServiceUnavailableException, ServiceFailureException, ThrottlingException, AwsServiceException, SdkClientException, ChimeSdkMeetingsException 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.Builderavoiding the need to create one manually viaDeleteMeetingRequest.builder()- Parameters:
deleteMeetingRequest- AConsumerthat will call methods onDeleteMeetingRequest.Builderto create a request.- Returns:
- Result of the DeleteMeeting operation returned by the service.
- See Also:
-
getAttendee
default GetAttendeeResponse getAttendee(GetAttendeeRequest getAttendeeRequest) throws BadRequestException, ForbiddenException, NotFoundException, UnauthorizedException, ServiceUnavailableException, ServiceFailureException, ThrottlingException, AwsServiceException, SdkClientException, ChimeSdkMeetingsException 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:
- Result of the GetAttendee operation returned by the service.
- See Also:
-
getAttendee
default GetAttendeeResponse getAttendee(Consumer<GetAttendeeRequest.Builder> getAttendeeRequest) throws BadRequestException, ForbiddenException, NotFoundException, UnauthorizedException, ServiceUnavailableException, ServiceFailureException, ThrottlingException, AwsServiceException, SdkClientException, ChimeSdkMeetingsException 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.Builderavoiding the need to create one manually viaGetAttendeeRequest.builder()- Parameters:
getAttendeeRequest- AConsumerthat will call methods onGetAttendeeRequest.Builderto create a request.- Returns:
- Result of the GetAttendee operation returned by the service.
- See Also:
-
getMeeting
default GetMeetingResponse getMeeting(GetMeetingRequest getMeetingRequest) throws NotFoundException, BadRequestException, ForbiddenException, UnauthorizedException, ServiceUnavailableException, ServiceFailureException, ThrottlingException, AwsServiceException, SdkClientException, ChimeSdkMeetingsException 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:
- Result of the GetMeeting operation returned by the service.
- See Also:
-
getMeeting
default GetMeetingResponse getMeeting(Consumer<GetMeetingRequest.Builder> getMeetingRequest) throws NotFoundException, BadRequestException, ForbiddenException, UnauthorizedException, ServiceUnavailableException, ServiceFailureException, ThrottlingException, AwsServiceException, SdkClientException, ChimeSdkMeetingsException 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.Builderavoiding the need to create one manually viaGetMeetingRequest.builder()- Parameters:
getMeetingRequest- AConsumerthat will call methods onGetMeetingRequest.Builderto create a request.- Returns:
- Result of the GetMeeting operation returned by the service.
- See Also:
-
listAttendees
default ListAttendeesResponse listAttendees(ListAttendeesRequest listAttendeesRequest) throws BadRequestException, ForbiddenException, NotFoundException, UnauthorizedException, ServiceUnavailableException, ServiceFailureException, ThrottlingException, AwsServiceException, SdkClientException, ChimeSdkMeetingsException 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:
- Result of the ListAttendees operation returned by the service.
- See Also:
-
listAttendees
default ListAttendeesResponse listAttendees(Consumer<ListAttendeesRequest.Builder> listAttendeesRequest) throws BadRequestException, ForbiddenException, NotFoundException, UnauthorizedException, ServiceUnavailableException, ServiceFailureException, ThrottlingException, AwsServiceException, SdkClientException, ChimeSdkMeetingsException 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.Builderavoiding the need to create one manually viaListAttendeesRequest.builder()- Parameters:
listAttendeesRequest- AConsumerthat will call methods onListAttendeesRequest.Builderto create a request.- Returns:
- Result of the ListAttendees operation returned by the service.
- See Also:
-
listAttendeesPaginator
default ListAttendeesIterable listAttendeesPaginator(ListAttendeesRequest listAttendeesRequest) throws BadRequestException, ForbiddenException, NotFoundException, UnauthorizedException, ServiceUnavailableException, ServiceFailureException, ThrottlingException, AwsServiceException, SdkClientException, ChimeSdkMeetingsException This is a variant of
listAttendees(software.amazon.awssdk.services.chimesdkmeetings.model.ListAttendeesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.chimesdkmeetings.paginators.ListAttendeesIterable responses = client.listAttendeesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.chimesdkmeetings.paginators.ListAttendeesIterable responses = client .listAttendeesPaginator(request); for (software.amazon.awssdk.services.chimesdkmeetings.model.ListAttendeesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.chimesdkmeetings.paginators.ListAttendeesIterable responses = client.listAttendeesPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listAttendeesPaginator
default ListAttendeesIterable listAttendeesPaginator(Consumer<ListAttendeesRequest.Builder> listAttendeesRequest) throws BadRequestException, ForbiddenException, NotFoundException, UnauthorizedException, ServiceUnavailableException, ServiceFailureException, ThrottlingException, AwsServiceException, SdkClientException, ChimeSdkMeetingsException This is a variant of
listAttendees(software.amazon.awssdk.services.chimesdkmeetings.model.ListAttendeesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.chimesdkmeetings.paginators.ListAttendeesIterable responses = client.listAttendeesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.chimesdkmeetings.paginators.ListAttendeesIterable responses = client .listAttendeesPaginator(request); for (software.amazon.awssdk.services.chimesdkmeetings.model.ListAttendeesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.chimesdkmeetings.paginators.ListAttendeesIterable responses = client.listAttendeesPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListAttendeesRequest.builder()- Parameters:
listAttendeesRequest- AConsumerthat will call methods onListAttendeesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws BadRequestException, ForbiddenException, UnauthorizedException, LimitExceededException, ServiceUnavailableException, ServiceFailureException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ChimeSdkMeetingsException Returns a list of the tags available for the specified resource.
- Parameters:
listTagsForResourceRequest-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws BadRequestException, ForbiddenException, UnauthorizedException, LimitExceededException, ServiceUnavailableException, ServiceFailureException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ChimeSdkMeetingsException Returns a list of the tags available for the specified resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
startMeetingTranscription
default StartMeetingTranscriptionResponse startMeetingTranscription(StartMeetingTranscriptionRequest startMeetingTranscriptionRequest) throws NotFoundException, ForbiddenException, BadRequestException, UnauthorizedException, LimitExceededException, UnprocessableEntityException, ThrottlingException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMeetingsException 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
TranscriptFailedevent will be sent with the contents of theBadRequestExceptiongenerated 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:
- Result of the StartMeetingTranscription operation returned by the service.
- See Also:
-
startMeetingTranscription
default StartMeetingTranscriptionResponse startMeetingTranscription(Consumer<StartMeetingTranscriptionRequest.Builder> startMeetingTranscriptionRequest) throws NotFoundException, ForbiddenException, BadRequestException, UnauthorizedException, LimitExceededException, UnprocessableEntityException, ThrottlingException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMeetingsException 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
TranscriptFailedevent will be sent with the contents of theBadRequestExceptiongenerated 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.Builderavoiding the need to create one manually viaStartMeetingTranscriptionRequest.builder()- Parameters:
startMeetingTranscriptionRequest- AConsumerthat will call methods onStartMeetingTranscriptionRequest.Builderto create a request.- Returns:
- Result of the StartMeetingTranscription operation returned by the service.
- See Also:
-
stopMeetingTranscription
default StopMeetingTranscriptionResponse stopMeetingTranscription(StopMeetingTranscriptionRequest stopMeetingTranscriptionRequest) throws ForbiddenException, NotFoundException, BadRequestException, UnauthorizedException, UnprocessableEntityException, ThrottlingException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMeetingsException 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:
- Result of the StopMeetingTranscription operation returned by the service.
- See Also:
-
stopMeetingTranscription
default StopMeetingTranscriptionResponse stopMeetingTranscription(Consumer<StopMeetingTranscriptionRequest.Builder> stopMeetingTranscriptionRequest) throws ForbiddenException, NotFoundException, BadRequestException, UnauthorizedException, UnprocessableEntityException, ThrottlingException, ServiceUnavailableException, ServiceFailureException, AwsServiceException, SdkClientException, ChimeSdkMeetingsException 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.Builderavoiding the need to create one manually viaStopMeetingTranscriptionRequest.builder()- Parameters:
stopMeetingTranscriptionRequest- AConsumerthat will call methods onStopMeetingTranscriptionRequest.Builderto create a request.- Returns:
- Result of the StopMeetingTranscription operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws BadRequestException, ForbiddenException, UnauthorizedException, LimitExceededException, ServiceUnavailableException, ServiceFailureException, ThrottlingException, ResourceNotFoundException, TooManyTagsException, AwsServiceException, SdkClientException, ChimeSdkMeetingsException The resource that supports tags.
- Parameters:
tagResourceRequest-- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws BadRequestException, ForbiddenException, UnauthorizedException, LimitExceededException, ServiceUnavailableException, ServiceFailureException, ThrottlingException, ResourceNotFoundException, TooManyTagsException, AwsServiceException, SdkClientException, ChimeSdkMeetingsException The resource that supports tags.
This is a convenience which creates an instance of the
TagResourceRequest.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws BadRequestException, ForbiddenException, UnauthorizedException, LimitExceededException, ServiceUnavailableException, ServiceFailureException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ChimeSdkMeetingsException 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:UntagResourcespermission 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 theUntagResourcesoperation, you must have both of the following permissions:tag:UntagResourceChimeSDKMeetings:DeleteTags- Parameters:
untagResourceRequest-- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws BadRequestException, ForbiddenException, UnauthorizedException, LimitExceededException, ServiceUnavailableException, ServiceFailureException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ChimeSdkMeetingsException 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:UntagResourcespermission 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 theUntagResourcesoperation, you must have both of the following permissions:tag:UntagResourceChimeSDKMeetings:DeleteTags
This is a convenience which creates an instance of the
UntagResourceRequest.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
-
updateAttendeeCapabilities
default UpdateAttendeeCapabilitiesResponse updateAttendeeCapabilities(UpdateAttendeeCapabilitiesRequest updateAttendeeCapabilitiesRequest) throws BadRequestException, ConflictException, UnauthorizedException, NotFoundException, ForbiddenException, ServiceUnavailableException, ServiceFailureException, ThrottlingException, AwsServiceException, SdkClientException, ChimeSdkMeetingsException 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
SendReceivedata. For more information about those values, see .When using capabilities, be aware of these corner cases:
-
If you specify
MeetingFeatures:Video:MaxResolution:Nonewhen you create a meeting, all API requests that includeSendReceive,Send, orReceiveforAttendeeCapabilities:Videowill be rejected withValidationError 400. -
If you specify
MeetingFeatures:Content:MaxResolution:Nonewhen you create a meeting, all API requests that includeSendReceive,Send, orReceiveforAttendeeCapabilities:Contentwill be rejected withValidationError 400. -
You can't set
contentcapabilities toSendReceiveorReceiveunless you also setvideocapabilities toSendReceiveorReceive. If you don't set thevideocapability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set yourvideocapability to receive and you set yourcontentcapability to not receive. -
When you change an
audiocapability fromNoneorReceivetoSendorSendReceive, and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants. -
When you change a
videoorcontentcapability fromNoneorReceivetoSendorSendReceive, 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:
- Result of the UpdateAttendeeCapabilities operation returned by the service.
- See Also:
-
-
updateAttendeeCapabilities
default UpdateAttendeeCapabilitiesResponse updateAttendeeCapabilities(Consumer<UpdateAttendeeCapabilitiesRequest.Builder> updateAttendeeCapabilitiesRequest) throws BadRequestException, ConflictException, UnauthorizedException, NotFoundException, ForbiddenException, ServiceUnavailableException, ServiceFailureException, ThrottlingException, AwsServiceException, SdkClientException, ChimeSdkMeetingsException 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
SendReceivedata. For more information about those values, see .When using capabilities, be aware of these corner cases:
-
If you specify
MeetingFeatures:Video:MaxResolution:Nonewhen you create a meeting, all API requests that includeSendReceive,Send, orReceiveforAttendeeCapabilities:Videowill be rejected withValidationError 400. -
If you specify
MeetingFeatures:Content:MaxResolution:Nonewhen you create a meeting, all API requests that includeSendReceive,Send, orReceiveforAttendeeCapabilities:Contentwill be rejected withValidationError 400. -
You can't set
contentcapabilities toSendReceiveorReceiveunless you also setvideocapabilities toSendReceiveorReceive. If you don't set thevideocapability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set yourvideocapability to receive and you set yourcontentcapability to not receive. -
When you change an
audiocapability fromNoneorReceivetoSendorSendReceive, and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants. -
When you change a
videoorcontentcapability fromNoneorReceivetoSendorSendReceive, 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.Builderavoiding the need to create one manually viaUpdateAttendeeCapabilitiesRequest.builder()- Parameters:
updateAttendeeCapabilitiesRequest- AConsumerthat will call methods onUpdateAttendeeCapabilitiesRequest.Builderto create a request.- Returns:
- Result of the UpdateAttendeeCapabilities operation returned by the service.
- See Also:
-
-
create
Create aChimeSdkMeetingsClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aChimeSdkMeetingsClient. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClientThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient- Returns:
- SdkServiceClientConfiguration
-