@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonChimeSDKMeetings
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonChimeSDKMeetings instead.
The Amazon Chime SDK meetings APIs in this section allow software developers to create Amazon Chime SDK meetings, set the AWS Regions for meetings, create and manage users, and send and receive meeting notifications. For more information about the meeting APIs, see Amazon Chime SDK meetings.
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| Modifier and Type | Method and Description |
|---|---|
BatchCreateAttendeeResult |
batchCreateAttendee(BatchCreateAttendeeRequest batchCreateAttendeeRequest)
Creates up to 100 attendees for an active Amazon Chime SDK meeting.
|
BatchUpdateAttendeeCapabilitiesExceptResult |
batchUpdateAttendeeCapabilitiesExcept(BatchUpdateAttendeeCapabilitiesExceptRequest batchUpdateAttendeeCapabilitiesExceptRequest)
Updates
AttendeeCapabilities except the capabilities listed in an ExcludedAttendeeIds
table. |
CreateAttendeeResult |
createAttendee(CreateAttendeeRequest createAttendeeRequest)
Creates a new attendee for an active Amazon Chime SDK meeting.
|
CreateMeetingResult |
createMeeting(CreateMeetingRequest createMeetingRequest)
Creates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees.
|
CreateMeetingWithAttendeesResult |
createMeetingWithAttendees(CreateMeetingWithAttendeesRequest createMeetingWithAttendeesRequest)
Creates a new Amazon Chime SDK meeting in the specified media Region, with attendees.
|
DeleteAttendeeResult |
deleteAttendee(DeleteAttendeeRequest deleteAttendeeRequest)
Deletes an attendee from the specified Amazon Chime SDK meeting and deletes their
JoinToken. |
DeleteMeetingResult |
deleteMeeting(DeleteMeetingRequest deleteMeetingRequest)
Deletes the specified Amazon Chime SDK meeting.
|
GetAttendeeResult |
getAttendee(GetAttendeeRequest getAttendeeRequest)
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 getMeetingRequest)
Gets the Amazon Chime SDK meeting details for the specified meeting ID.
|
ListAttendeesResult |
listAttendees(ListAttendeesRequest listAttendeesRequest)
Lists the attendees for the specified Amazon Chime SDK meeting.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartMeetingTranscriptionResult |
startMeetingTranscription(StartMeetingTranscriptionRequest startMeetingTranscriptionRequest)
Starts transcription for the specified
meetingId. |
StopMeetingTranscriptionResult |
stopMeetingTranscription(StopMeetingTranscriptionRequest stopMeetingTranscriptionRequest)
Stops transcription for the specified
meetingId. |
UpdateAttendeeCapabilitiesResult |
updateAttendeeCapabilities(UpdateAttendeeCapabilitiesRequest updateAttendeeCapabilitiesRequest)
The capabilties that you want to update.
|
static final String ENDPOINT_PREFIX
BatchCreateAttendeeResult 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.
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.BatchUpdateAttendeeCapabilitiesExceptResult batchUpdateAttendeeCapabilitiesExcept(BatchUpdateAttendeeCapabilitiesExceptRequest batchUpdateAttendeeCapabilitiesExceptRequest)
Updates AttendeeCapabilities except the capabilities listed in an ExcludedAttendeeIds
table.
You use the capabilities with a set of values that control what the capabilities can do, such as
SendReceive data. For more information about those values, see .
When using capabilities, be aware of these corner cases:
You can't set content capabilities to SendReceive or Receive unless you
also set video capabilities to SendReceive or Receive. If you don't set
the video capability to receive, the response will contain an HTTP 400 Bad Request status code.
However, you can set your video capability to receive and you set your content
capability to not receive.
When you change an audio capability from None or Receive to
Send or SendReceive , and if the attendee left their microphone unmuted, audio will
flow from the attendee to the other meeting participants.
When you change a video or content capability from None or
Receive to Send or SendReceive , and if the attendee turned on their video
or content streams, remote attendess can receive those streams, but only after media renegotiation between the
client and the Amazon Chime back-end server.
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.CreateAttendeeResult 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.
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.CreateMeetingResult 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.
createMeetingRequest - 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.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.CreateMeetingWithAttendeesResult 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.
createMeetingWithAttendeesRequest - 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.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.DeleteAttendeeResult 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.
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.DeleteMeetingResult 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.
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.GetAttendeeResult getAttendee(GetAttendeeRequest getAttendeeRequest)
Gets the Amazon Chime SDK attendee details for a specified meeting ID and attendee ID. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
getAttendeeRequest - 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.GetMeetingResult getMeeting(GetMeetingRequest getMeetingRequest)
Gets the Amazon Chime SDK meeting details for the specified meeting ID. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
getMeetingRequest - 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.ListAttendeesResult 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.
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.StartMeetingTranscriptionResult startMeetingTranscription(StartMeetingTranscriptionRequest startMeetingTranscriptionRequest)
Starts transcription for the specified meetingId.
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.StopMeetingTranscriptionResult stopMeetingTranscription(StopMeetingTranscriptionRequest stopMeetingTranscriptionRequest)
Stops transcription for the specified meetingId.
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.UpdateAttendeeCapabilitiesResult updateAttendeeCapabilities(UpdateAttendeeCapabilitiesRequest updateAttendeeCapabilitiesRequest)
The capabilties that you want to update.
You use the capabilities with a set of values that control what the capabilities can do, such as
SendReceive data. For more information about those values, see .
When using capabilities, be aware of these corner cases:
You can't set content capabilities to SendReceive or Receive unless you
also set video capabilities to SendReceive or Receive. If you don't set
the video capability to receive, the response will contain an HTTP 400 Bad Request status code.
However, you can set your video capability to receive and you set your content
capability to not receive.
When you change an audio capability from None or Receive to
Send or SendReceive , and if the attendee left their microphone unmuted, audio will
flow from the attendee to the other meeting participants.
When you change a video or content capability from None or
Receive to Send or SendReceive , and if the attendee turned on their video
or content streams, remote attendess can receive those streams, but only after media renegotiation between the
client and the Amazon Chime back-end server.
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.void shutdown()
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 a request.
request - The originally executed request.Copyright © 2022. All rights reserved.