@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonChimeSDKMeetingsClient extends AmazonWebServiceClient implements AmazonChimeSDKMeetings
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.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
BatchCreateAttendeeResult |
batchCreateAttendee(BatchCreateAttendeeRequest request)
Creates up to 100 attendees for an active Amazon Chime SDK meeting.
|
BatchUpdateAttendeeCapabilitiesExceptResult |
batchUpdateAttendeeCapabilitiesExcept(BatchUpdateAttendeeCapabilitiesExceptRequest request)
Updates
AttendeeCapabilities except the capabilities listed in an ExcludedAttendeeIds
table. |
static AmazonChimeSDKMeetingsClientBuilder |
builder() |
CreateAttendeeResult |
createAttendee(CreateAttendeeRequest request)
Creates a new attendee for an active Amazon Chime SDK meeting.
|
CreateMeetingResult |
createMeeting(CreateMeetingRequest request)
Creates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees.
|
CreateMeetingWithAttendeesResult |
createMeetingWithAttendees(CreateMeetingWithAttendeesRequest request)
Creates a new Amazon Chime SDK meeting in the specified media Region, with attendees.
|
DeleteAttendeeResult |
deleteAttendee(DeleteAttendeeRequest request)
Deletes an attendee from the specified Amazon Chime SDK meeting and deletes their
JoinToken . |
DeleteMeetingResult |
deleteMeeting(DeleteMeetingRequest request)
Deletes the specified Amazon Chime SDK meeting.
|
GetAttendeeResult |
getAttendee(GetAttendeeRequest request)
Gets the Amazon Chime SDK attendee details for a specified meeting ID and attendee ID.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful, request, typically used for debugging issues
where a service isn't acting as expected.
|
GetMeetingResult |
getMeeting(GetMeetingRequest request)
Gets the Amazon Chime SDK meeting details for the specified meeting ID.
|
ListAttendeesResult |
listAttendees(ListAttendeesRequest request)
Lists the attendees for the specified Amazon Chime SDK meeting.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Returns a list of the tags available for the specified resource.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
StartMeetingTranscriptionResult |
startMeetingTranscription(StartMeetingTranscriptionRequest request)
Starts transcription for the specified
meetingId . |
StopMeetingTranscriptionResult |
stopMeetingTranscription(StopMeetingTranscriptionRequest request)
Stops transcription for the specified
meetingId . |
TagResourceResult |
tagResource(TagResourceRequest request)
The resource that supports tags.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes the specified tags from the specified resources.
|
UpdateAttendeeCapabilitiesResult |
updateAttendeeCapabilities(UpdateAttendeeCapabilitiesRequest request)
The capabilities that you want to update.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
public static AmazonChimeSDKMeetingsClientBuilder builder()
public BatchCreateAttendeeResult batchCreateAttendee(BatchCreateAttendeeRequest request)
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.
batchCreateAttendee
in interface AmazonChimeSDKMeetings
batchCreateAttendeeRequest
- 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.public BatchUpdateAttendeeCapabilitiesExceptResult batchUpdateAttendeeCapabilitiesExcept(BatchUpdateAttendeeCapabilitiesExceptRequest request)
Updates AttendeeCapabilities
except the capabilities listed in an ExcludedAttendeeIds
table.
You use the capabilities with a set of values that control what the capabilities can do, such as
SendReceive
data. For more information about those values, see .
When using capabilities, be aware of these corner cases:
If you specify MeetingFeatures:Video:MaxResolution:None
when you create a meeting, all API requests
that include SendReceive
, Send
, or Receive
for
AttendeeCapabilities:Video
will be rejected with ValidationError 400
.
If you specify MeetingFeatures:Content:MaxResolution:None
when you create a meeting, all API
requests that include SendReceive
, Send
, or Receive
for
AttendeeCapabilities:Content
will be rejected with ValidationError 400
.
You can't set content
capabilities to SendReceive
or Receive
unless you
also set video
capabilities to SendReceive
or Receive
. If you don't set
the video
capability to receive, the response will contain an HTTP 400 Bad Request status code.
However, you can set your video
capability to receive and you set your content
capability to not receive.
When you change an audio
capability from None
or Receive
to
Send
or SendReceive
, and if the attendee left their microphone unmuted, audio will
flow from the attendee to the other meeting participants.
When you change a video
or content
capability from None
or
Receive
to Send
or SendReceive
, and if the attendee turned on their video
or content streams, remote attendees can receive those streams, but only after media renegotiation between the
client and the Amazon Chime back-end server.
batchUpdateAttendeeCapabilitiesExcept
in interface AmazonChimeSDKMeetings
batchUpdateAttendeeCapabilitiesExceptRequest
- 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.public CreateAttendeeResult createAttendee(CreateAttendeeRequest request)
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.
createAttendee
in interface AmazonChimeSDKMeetings
createAttendeeRequest
- 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.public CreateMeetingResult createMeeting(CreateMeetingRequest request)
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.
createMeeting
in interface AmazonChimeSDKMeetings
createMeetingRequest
- 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.public CreateMeetingWithAttendeesResult createMeetingWithAttendees(CreateMeetingWithAttendeesRequest request)
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.
createMeetingWithAttendees
in interface AmazonChimeSDKMeetings
createMeetingWithAttendeesRequest
- 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.public DeleteAttendeeResult deleteAttendee(DeleteAttendeeRequest request)
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.
deleteAttendee
in interface AmazonChimeSDKMeetings
deleteAttendeeRequest
- 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.public DeleteMeetingResult deleteMeeting(DeleteMeetingRequest request)
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.
deleteMeeting
in interface AmazonChimeSDKMeetings
deleteMeetingRequest
- 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.public GetAttendeeResult getAttendee(GetAttendeeRequest request)
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.
getAttendee
in interface AmazonChimeSDKMeetings
getAttendeeRequest
- 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.public GetMeetingResult getMeeting(GetMeetingRequest request)
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.
getMeeting
in interface AmazonChimeSDKMeetings
getMeetingRequest
- 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.public ListAttendeesResult listAttendees(ListAttendeesRequest request)
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.
listAttendees
in interface AmazonChimeSDKMeetings
listAttendeesRequest
- 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.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Returns a list of the tags available for the specified resource.
listTagsForResource
in interface AmazonChimeSDKMeetings
listTagsForResourceRequest
- 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.public StartMeetingTranscriptionResult startMeetingTranscription(StartMeetingTranscriptionRequest request)
Starts transcription for the specified meetingId
. For more information, refer to Using Amazon Chime SDK live
transcription in the Amazon Chime SDK Developer Guide.
If you specify an invalid configuration, a TranscriptFailed
event will be sent with the contents of
the BadRequestException
generated by Amazon Transcribe. For more information on each parameter and
which combinations are valid, refer to the StartStreamTranscription API in the Amazon Transcribe Developer Guide.
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.
startMeetingTranscription
in interface AmazonChimeSDKMeetings
startMeetingTranscriptionRequest
- 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.public StopMeetingTranscriptionResult stopMeetingTranscription(StopMeetingTranscriptionRequest request)
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.
stopMeetingTranscription
in interface AmazonChimeSDKMeetings
stopMeetingTranscriptionRequest
- 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.public TagResourceResult tagResource(TagResourceRequest request)
The resource that supports tags.
tagResource
in interface AmazonChimeSDKMeetings
tagResourceRequest
- 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.public UntagResourceResult untagResource(UntagResourceRequest request)
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 the UntagResources
operation, you must have both of the following
permissions:
tag:UntagResource
ChimeSDKMeetings:DeleteTags
untagResource
in interface AmazonChimeSDKMeetings
untagResourceRequest
- 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.public UpdateAttendeeCapabilitiesResult updateAttendeeCapabilities(UpdateAttendeeCapabilitiesRequest request)
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 include SendReceive
, Send
, or Receive
for
AttendeeCapabilities:Video
will be rejected with ValidationError 400
.
If you specify MeetingFeatures:Content:MaxResolution:None
when you create a meeting, all API
requests that include SendReceive
, Send
, or Receive
for
AttendeeCapabilities:Content
will be rejected with ValidationError 400
.
You can't set content
capabilities to SendReceive
or Receive
unless you
also set video
capabilities to SendReceive
or Receive
. If you don't set
the video
capability to receive, the response will contain an HTTP 400 Bad Request status code.
However, you can set your video
capability to receive and you set your content
capability to not receive.
When you change an audio
capability from None
or Receive
to
Send
or SendReceive
, and if the attendee left their microphone unmuted, audio will
flow from the attendee to the other meeting participants.
When you change a video
or content
capability from None
or
Receive
to Send
or SendReceive
, and if the attendee turned on their video
or content streams, remote attendees can receive those streams, but only after media renegotiation between the
client and the Amazon Chime back-end server.
updateAttendeeCapabilities
in interface AmazonChimeSDKMeetings
updateAttendeeCapabilitiesRequest
- 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.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata
in interface AmazonChimeSDKMeetings
request
- The originally executed requestpublic void shutdown()
AmazonWebServiceClient
shutdown
in interface AmazonChimeSDKMeetings
shutdown
in class AmazonWebServiceClient