com.amazonaws.services.chimesdkmeetings

Class AmazonChimeSDKMeetingsClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.chimesdkmeetings.AmazonChimeSDKMeetingsClient

All Implemented Interfaces:

AmazonChimeSDKMeetings

Direct Known Subclasses:

AmazonChimeSDKMeetingsAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonChimeSDKMeetingsClient
extends AmazonWebServiceClient
implements AmazonChimeSDKMeetings

Client for accessing Amazon Chime SDK Meetings. All service calls made using this client are blocking, and will not return until the service call completes.

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.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.chimesdkmeetings.AmazonChimeSDKMeetings

ENDPOINT_PREFIX

Method Summary

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.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

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

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static AmazonChimeSDKMeetingsClientBuilder builder()

batchCreateAttendee

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.

Specified by:

batchCreateAttendee in interface AmazonChimeSDKMeetings

Parameters:

batchCreateAttendeeRequest -

Returns:

Result of the BatchCreateAttendee operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

batchUpdateAttendeeCapabilitiesExcept

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:

• 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.

Specified by:

batchUpdateAttendeeCapabilitiesExcept in interface AmazonChimeSDKMeetings

Parameters:

batchUpdateAttendeeCapabilitiesExceptRequest -

Returns:

Result of the BatchUpdateAttendeeCapabilitiesExcept operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createAttendee

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.

Specified by:

createAttendee in interface AmazonChimeSDKMeetings

Parameters:

createAttendeeRequest -

Returns:

Result of the CreateAttendee operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createMeeting

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.

Specified by:

createMeeting in interface AmazonChimeSDKMeetings

Parameters:

createMeetingRequest -

Returns:

Result of the CreateMeeting operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createMeetingWithAttendees

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.

Specified by:

createMeetingWithAttendees in interface AmazonChimeSDKMeetings

Parameters:

createMeetingWithAttendeesRequest -

Returns:

Result of the CreateMeetingWithAttendees operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteAttendee

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.

Specified by:

deleteAttendee in interface AmazonChimeSDKMeetings

Parameters:

deleteAttendeeRequest -

Returns:

Result of the DeleteAttendee operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteMeeting

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.

Specified by:

deleteMeeting in interface AmazonChimeSDKMeetings

Parameters:

deleteMeetingRequest -

Returns:

Result of the DeleteMeeting operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getAttendee

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.

Specified by:

getAttendee in interface AmazonChimeSDKMeetings

Parameters:

getAttendeeRequest -

Returns:

Result of the GetAttendee operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getMeeting

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.

Specified by:

getMeeting in interface AmazonChimeSDKMeetings

Parameters:

getMeetingRequest -

Returns:

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.

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.

See Also:

AWS API Documentation

listAttendees

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.

Specified by:

listAttendees in interface AmazonChimeSDKMeetings

Parameters:

listAttendeesRequest -

Returns:

Result of the ListAttendees operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Returns a list of the tags available for the specified resource.

Specified by:

listTagsForResource in interface AmazonChimeSDKMeetings

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

ResourceNotFoundException - The resource that you want to tag couldn't be found.

See Also:

AWS API Documentation

startMeetingTranscription

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.

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.

Specified by:

startMeetingTranscription in interface AmazonChimeSDKMeetings

Parameters:

startMeetingTranscriptionRequest -

Returns:

Result of the StartMeetingTranscription operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

stopMeetingTranscription

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.

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.

Specified by:

stopMeetingTranscription in interface AmazonChimeSDKMeetings

Parameters:

stopMeetingTranscriptionRequest -

Returns:

Result of the StopMeetingTranscription operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

The resource that supports tags.

Specified by:

tagResource in interface AmazonChimeSDKMeetings

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

BadRequestException - The input parameters don't match the service's restrictions.

ResourceNotFoundException - The resource that you want to tag couldn't be found.

TooManyTagsException - Too many tags were added to the specified resource.

See Also:

AWS API Documentation

untagResource

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 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

Specified by:

untagResource in interface AmazonChimeSDKMeetings

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

BadRequestException - The input parameters don't match the service's restrictions.

ResourceNotFoundException - The resource that you want to tag couldn't be found.

See Also:

AWS API Documentation

updateAttendeeCapabilities

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:

• 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.

Specified by:

updateAttendeeCapabilities in interface AmazonChimeSDKMeetings

Parameters:

updateAttendeeCapabilitiesRequest -

Returns:

Result of the UpdateAttendeeCapabilities operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getCachedResponseMetadata

public 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. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

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.

Specified by:

getCachedResponseMetadata in interface AmazonChimeSDKMeetings

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AmazonChimeSDKMeetings

Overrides:

shutdown in class AmazonWebServiceClient