/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.chimesdkmeetings; import javax.annotation.Generated; import com.amazonaws.*; import com.amazonaws.regions.*; import com.amazonaws.services.chimesdkmeetings.model.*; /** * Interface for accessing Amazon Chime SDK Meetings. *
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.chimesdkmeetings.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. *
*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public interface AmazonChimeSDKMeetings { /** * The region metadata service name for computing region endpoints. You can use this value to retrieve metadata * (such as supported regions) of the service. * * @see RegionUtils#getRegionsForService(String) */ String ENDPOINT_PREFIX = "meetings-chime"; /** ** 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. *
* * @param batchCreateAttendeeRequest * @return Result of the BatchCreateAttendee operation returned by the service. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ForbiddenException * The client is permanently forbidden from making the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws UnauthorizedException * The user isn't authorized to request a resource. * @throws UnprocessableEntityException * The request was well-formed but was unable to be followed due to semantic errors. * @throws LimitExceededException * The request exceeds the resource limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @throws ThrottlingException * The number of customer requests exceeds the request rate limit. * @sample AmazonChimeSDKMeetings.BatchCreateAttendee * @see AWS API Documentation */ BatchCreateAttendeeResult batchCreateAttendee(BatchCreateAttendeeRequest batchCreateAttendeeRequest); /** *
* Updates AttendeeCapabilities
except the capabilities listed in an ExcludedAttendeeIds
* table.
*
* You use the capabilities with a set of values that control what the capabilities can do, such as
* SendReceive
data. For more information about those values, see .
*
* When using capabilities, be aware of these corner cases: *
*
* You can't set content
capabilities to SendReceive
or Receive
unless you
* also set video
capabilities to SendReceive
or Receive
. If you don't set
* the video
capability to receive, the response will contain an HTTP 400 Bad Request status code.
* However, you can set your video
capability to receive and you set your content
* capability to not receive.
*
* When you change an audio
capability from None
or Receive
to
* Send
or SendReceive
, and if the attendee left their microphone unmuted, audio will
* flow from the attendee to the other meeting participants.
*
* When you change a video
or content
capability from None
or
* Receive
to Send
or SendReceive
, and if the attendee turned on their video
* or content streams, remote attendees can receive those streams, but only after media renegotiation between the
* client and the Amazon Chime back-end server.
*
* 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. *
* * @param createAttendeeRequest * @return Result of the CreateAttendee operation returned by the service. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ForbiddenException * The client is permanently forbidden from making the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws UnauthorizedException * The user isn't authorized to request a resource. * @throws UnprocessableEntityException * The request was well-formed but was unable to be followed due to semantic errors. * @throws LimitExceededException * The request exceeds the resource limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @throws ThrottlingException * The number of customer requests exceeds the request rate limit. * @sample AmazonChimeSDKMeetings.CreateAttendee * @see AWS API Documentation */ CreateAttendeeResult createAttendee(CreateAttendeeRequest createAttendeeRequest); /** ** 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. *
* * @param createMeetingRequest * @return Result of the CreateMeeting operation returned by the service. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ForbiddenException * The client is permanently forbidden from making the request. * @throws UnauthorizedException * The user isn't authorized to request a resource. * @throws ThrottlingException * The number of customer requests exceeds the request rate limit. * @throws ServiceFailureException * The service encountered an unexpected error. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws LimitExceededException * The request exceeds the resource limit. * @sample AmazonChimeSDKMeetings.CreateMeeting * @see AWS API Documentation */ CreateMeetingResult createMeeting(CreateMeetingRequest createMeetingRequest); /** ** 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. *
* * @param createMeetingWithAttendeesRequest * @return Result of the CreateMeetingWithAttendees operation returned by the service. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ForbiddenException * The client is permanently forbidden from making the request. * @throws UnauthorizedException * The user isn't authorized to request a resource. * @throws ThrottlingException * The number of customer requests exceeds the request rate limit. * @throws ServiceFailureException * The service encountered an unexpected error. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws LimitExceededException * The request exceeds the resource limit. * @sample AmazonChimeSDKMeetings.CreateMeetingWithAttendees * @see AWS API Documentation */ CreateMeetingWithAttendeesResult createMeetingWithAttendees(CreateMeetingWithAttendeesRequest createMeetingWithAttendeesRequest); /** *
* 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.
*
* 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. *
* * @param deleteMeetingRequest * @return Result of the DeleteMeeting operation returned by the service. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ForbiddenException * The client is permanently forbidden from making the request. * @throws UnauthorizedException * The user isn't authorized to request a resource. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @throws ThrottlingException * The number of customer requests exceeds the request rate limit. * @sample AmazonChimeSDKMeetings.DeleteMeeting * @see AWS API Documentation */ DeleteMeetingResult deleteMeeting(DeleteMeetingRequest deleteMeetingRequest); /** ** 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. *
* * @param getAttendeeRequest * @return Result of the GetAttendee operation returned by the service. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ForbiddenException * The client is permanently forbidden from making the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws UnauthorizedException * The user isn't authorized to request a resource. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @throws ThrottlingException * The number of customer requests exceeds the request rate limit. * @sample AmazonChimeSDKMeetings.GetAttendee * @see AWS * API Documentation */ GetAttendeeResult getAttendee(GetAttendeeRequest getAttendeeRequest); /** ** 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. *
* * @param getMeetingRequest * @return Result of the GetMeeting operation returned by the service. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ForbiddenException * The client is permanently forbidden from making the request. * @throws UnauthorizedException * The user isn't authorized to request a resource. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @throws ThrottlingException * The number of customer requests exceeds the request rate limit. * @sample AmazonChimeSDKMeetings.GetMeeting * @see AWS * API Documentation */ GetMeetingResult getMeeting(GetMeetingRequest getMeetingRequest); /** ** 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. *
* * @param listAttendeesRequest * @return Result of the ListAttendees operation returned by the service. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ForbiddenException * The client is permanently forbidden from making the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws UnauthorizedException * The user isn't authorized to request a resource. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @throws ThrottlingException * The number of customer requests exceeds the request rate limit. * @sample AmazonChimeSDKMeetings.ListAttendees * @see AWS API Documentation */ ListAttendeesResult listAttendees(ListAttendeesRequest listAttendeesRequest); /** ** Returns a list of the tags available for the specified resource. *
* * @param listTagsForResourceRequest * @return Result of the ListTagsForResource operation returned by the service. * @throws ResourceNotFoundException * The resource that you want to tag couldn't be found. * @sample AmazonChimeSDKMeetings.ListTagsForResource * @see AWS API Documentation */ ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest); /** *
* Starts transcription for the specified meetingId
. For more information, refer to Using Amazon Chime SDK live
* transcription in the Amazon Chime SDK Developer Guide.
*
* If you specify an invalid configuration, a TranscriptFailed
event will be sent with the contents of
* the BadRequestException
generated by Amazon Transcribe. For more information on each parameter and
* which combinations are valid, refer to the StartStreamTranscription API in the Amazon Transcribe Developer Guide.
*
* Amazon Chime SDK live transcription is powered by Amazon Transcribe. Use of Amazon Transcribe is subject to the * AWS Service Terms, including the terms specific to the AWS * Machine Learning and Artificial Intelligence Services. *
*
* Stops transcription for the specified meetingId
. For more information, refer to Using Amazon Chime SDK live
* transcription in the Amazon Chime SDK Developer Guide.
*
* Amazon Chime SDK live transcription is powered by Amazon Transcribe. Use of Amazon Transcribe is subject to the * AWS Service Terms, including the terms specific to the AWS * Machine Learning and Artificial Intelligence Services. *
** The resource that supports tags. *
* * @param tagResourceRequest * @return Result of the TagResource operation returned by the service. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ResourceNotFoundException * The resource that you want to tag couldn't be found. * @throws TooManyTagsException * Too many tags were added to the specified resource. * @sample AmazonChimeSDKMeetings.TagResource * @see AWS * API Documentation */ TagResourceResult tagResource(TagResourceRequest tagResourceRequest); /** ** Removes the specified tags from the specified resources. When you specify a tag key, the action removes both that * key and its associated value. The operation succeeds even if you attempt to remove tags from a resource that were * already removed. Note the following: *
** To remove tags from a resource, you need the necessary permissions for the service that the resource belongs to * as well as permissions for removing tags. For more information, see the documentation for the service whose * resource you want to untag. *
** You can only tag resources that are located in the specified AWS Region for the calling AWS account. *
** Minimum permissions *
*
* In addition to the tag:UntagResources
permission required by this operation, you must also have the
* remove tags permission defined by the service that created the resource. For example, to remove the tags from an
* Amazon EC2 instance using the UntagResources
operation, you must have both of the following
* permissions:
*
* tag:UntagResource
*
* ChimeSDKMeetings:DeleteTags
*
* The capabilities that you want to update. *
*
* You use the capabilities with a set of values that control what the capabilities can do, such as
* SendReceive
data. For more information about those values, see .
*
* When using capabilities, be aware of these corner cases: *
*
* You can't set content
capabilities to SendReceive
or Receive
unless you
* also set video
capabilities to SendReceive
or Receive
. If you don't set
* the video
capability to receive, the response will contain an HTTP 400 Bad Request status code.
* However, you can set your video
capability to receive and you set your content
* capability to not receive.
*
* When you change an audio
capability from None
or Receive
to
* Send
or SendReceive
, and if the attendee left their microphone unmuted, audio will
* flow from the attendee to the other meeting participants.
*
* When you change a video
or content
capability from None
or
* Receive
to Send
or SendReceive
, and if the attendee turned on their video
* or content streams, remote attendees can receive those streams, but only after media renegotiation between the
* client and the Amazon Chime back-end server.
*
* 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. * * @param request * The originally executed request. * * @return The response metadata for the specified request, or null if none is available. */ ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request); }