com.amazonaws.services.chime.AmazonChime Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-chime Show documentation

The AWS Java SDK for Amazon Chime module holds the client classes that are used for communicating with Amazon Chime Service

There is a newer version: 1.12.780

Show newest version

/* * Copyright 2015-2020 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.chime; import javax.annotation.Generated; import com.amazonaws.*; import com.amazonaws.regions.*; import com.amazonaws.services.chime.model.*; /** * Interface for accessing Amazon Chime. * * Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.chime.AbstractAmazonChime} instead. * * * * The Amazon Chime API (application programming interface) is designed for developers to perform key tasks, such as * creating and managing Amazon Chime accounts, users, and Voice Connectors. This guide provides detailed information * about the Amazon Chime API, including operations, types, inputs and outputs, and error codes. It also includes some * server-side API actions to use with the Amazon Chime SDK. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon * Chime Developer Guide. * * * You can use an AWS SDK, the AWS Command Line Interface (AWS CLI), or the REST API to make API calls. We recommend * using an AWS SDK or the AWS CLI. Each API operation includes links to information about using it with a * language-specific AWS SDK or the AWS CLI. * * * Using an AWS SDK * * * You don't need to write code to calculate a signature for request authentication. The SDK clients authenticate your * requests by using access keys that you provide. For more information about AWS SDKs, see the AWS Developer Center. * * * Using the AWS CLI * * * Use your access keys with the AWS CLI to make API calls. For information about setting up the AWS CLI, see Installing the AWS Command Line Interface * in the AWS Command Line Interface User Guide. For a list of available Amazon Chime commands, see the Amazon Chime commands in the AWS CLI * Command Reference. * * * Using REST API * * * If you use REST to make API calls, you must authenticate your request by providing a signature. Amazon Chime supports * signature version 4. For more information, see Signature Version 4 Signing Process * in the Amazon Web Services General Reference. * * * When making REST API calls, use the service name chime and REST endpoint * https://service.chime.aws.amazon.com. * * * * * Administrative permissions are controlled using AWS Identity and Access Management (IAM). For more information, see * Identity and Access Management for Amazon * Chime in the Amazon Chime Administration Guide. * */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public interface AmazonChime { /** * 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 = "chime"; /** * * Associates a phone number with the specified Amazon Chime user. * * * @param associatePhoneNumberWithUserRequest * @return Result of the AssociatePhoneNumberWithUser operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws AccessDeniedException * You don't have permissions to perform the requested operation. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.AssociatePhoneNumberWithUser * @see AWS API Documentation */ AssociatePhoneNumberWithUserResult associatePhoneNumberWithUser(AssociatePhoneNumberWithUserRequest associatePhoneNumberWithUserRequest); /** * * Associates phone numbers with the specified Amazon Chime Voice Connector. * * * @param associatePhoneNumbersWithVoiceConnectorRequest * @return Result of the AssociatePhoneNumbersWithVoiceConnector operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws AccessDeniedException * You don't have permissions to perform the requested operation. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.AssociatePhoneNumbersWithVoiceConnector * @see AWS API Documentation */ AssociatePhoneNumbersWithVoiceConnectorResult associatePhoneNumbersWithVoiceConnector( AssociatePhoneNumbersWithVoiceConnectorRequest associatePhoneNumbersWithVoiceConnectorRequest); /** * * Associates phone numbers with the specified Amazon Chime Voice Connector group. * * * @param associatePhoneNumbersWithVoiceConnectorGroupRequest * @return Result of the AssociatePhoneNumbersWithVoiceConnectorGroup operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws AccessDeniedException * You don't have permissions to perform the requested operation. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.AssociatePhoneNumbersWithVoiceConnectorGroup * @see AWS API Documentation */ AssociatePhoneNumbersWithVoiceConnectorGroupResult associatePhoneNumbersWithVoiceConnectorGroup( AssociatePhoneNumbersWithVoiceConnectorGroupRequest associatePhoneNumbersWithVoiceConnectorGroupRequest); /** * * Associates the specified sign-in delegate groups with the specified Amazon Chime account. * * * @param associateSigninDelegateGroupsWithAccountRequest * @return Result of the AssociateSigninDelegateGroupsWithAccount operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.AssociateSigninDelegateGroupsWithAccount * @see AWS API Documentation */ AssociateSigninDelegateGroupsWithAccountResult associateSigninDelegateGroupsWithAccount( AssociateSigninDelegateGroupsWithAccountRequest associateSigninDelegateGroupsWithAccountRequest); /** * * Creates up to 100 new 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. For example, when a user tries to create an * account from an unsupported Region. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ResourceLimitExceededException * The request exceeds the resource limit. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.BatchCreateAttendee * @see AWS API * Documentation */ BatchCreateAttendeeResult batchCreateAttendee(BatchCreateAttendeeRequest batchCreateAttendeeRequest); /** * * Adds up to 50 members to a chat room in an Amazon Chime Enterprise account. Members can be either users or bots. * The member role designates whether the member is a chat room administrator or a general chat room member. * * * @param batchCreateRoomMembershipRequest * @return Result of the BatchCreateRoomMembership operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @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. For example, when a user tries to create an * account from an unsupported Region. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.BatchCreateRoomMembership * @see AWS API Documentation */ BatchCreateRoomMembershipResult batchCreateRoomMembership(BatchCreateRoomMembershipRequest batchCreateRoomMembershipRequest); /** * * Moves phone numbers into the Deletion queue. Phone numbers must be disassociated from any users or Amazon * Chime Voice Connectors before they can be deleted. * * * Phone numbers remain in the Deletion queue for 7 days before they are deleted permanently. * * * @param batchDeletePhoneNumberRequest * @return Result of the BatchDeletePhoneNumber operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.BatchDeletePhoneNumber * @see AWS * API Documentation */ BatchDeletePhoneNumberResult batchDeletePhoneNumber(BatchDeletePhoneNumberRequest batchDeletePhoneNumberRequest); /** * * Suspends up to 50 users from a Team or EnterpriseLWA Amazon Chime account. For more * information about different account types, see Managing Your Amazon Chime * Accounts in the Amazon Chime Administration Guide. * * * Users suspended from a Team account are disassociated from the account, but they can continue to use * Amazon Chime as free users. To remove the suspension from suspended Team account users, invite them * to the Team account again. You can use the InviteUsers action to do so. * * * Users suspended from an EnterpriseLWA account are immediately signed out of Amazon Chime and can no * longer sign in. To remove the suspension from suspended EnterpriseLWA account users, use the * BatchUnsuspendUser action. * * * To sign out users without suspending them, use the LogoutUser action. * * * @param batchSuspendUserRequest * @return Result of the BatchSuspendUser operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.BatchSuspendUser * @see AWS API * Documentation */ BatchSuspendUserResult batchSuspendUser(BatchSuspendUserRequest batchSuspendUserRequest); /** * * Removes the suspension from up to 50 previously suspended users for the specified Amazon Chime * EnterpriseLWA account. Only users on EnterpriseLWA accounts can be unsuspended using * this action. For more information about different account types, see Managing Your Amazon Chime * Accounts in the Amazon Chime Administration Guide. * * * Previously suspended users who are unsuspended using this action are returned to Registered status. * Users who are not previously suspended are ignored. * * * @param batchUnsuspendUserRequest * @return Result of the BatchUnsuspendUser operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.BatchUnsuspendUser * @see AWS API * Documentation */ BatchUnsuspendUserResult batchUnsuspendUser(BatchUnsuspendUserRequest batchUnsuspendUserRequest); /** * * Updates phone number product types or calling names. You can update one attribute at a time for each * UpdatePhoneNumberRequestItem. For example, you can update either the product type or the calling * name. * * * For product types, choose from Amazon Chime Business Calling and Amazon Chime Voice Connector. For toll-free * numbers, you must use the Amazon Chime Voice Connector product type. * * * Updates to outbound calling names can take up to 72 hours to complete. Pending updates to outbound calling names * must be complete before you can request another update. * * * @param batchUpdatePhoneNumberRequest * @return Result of the BatchUpdatePhoneNumber operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.BatchUpdatePhoneNumber * @see AWS * API Documentation */ BatchUpdatePhoneNumberResult batchUpdatePhoneNumber(BatchUpdatePhoneNumberRequest batchUpdatePhoneNumberRequest); /** * * Updates user details within the UpdateUserRequestItem object for up to 20 users for the specified Amazon * Chime account. Currently, only LicenseType updates are supported for this action. * * * @param batchUpdateUserRequest * @return Result of the BatchUpdateUser operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.BatchUpdateUser * @see AWS API * Documentation */ BatchUpdateUserResult batchUpdateUser(BatchUpdateUserRequest batchUpdateUserRequest); /** * * Creates an Amazon Chime account under the administrator's AWS account. Only Team account types are * currently supported for this action. For more information about different account types, see Managing Your Amazon Chime * Accounts in the Amazon Chime Administration Guide. * * * @param createAccountRequest * @return Result of the CreateAccount operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.CreateAccount * @see AWS API * Documentation */ CreateAccountResult createAccount(CreateAccountRequest createAccountRequest); /** * * 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. For example, when a user tries to create an * account from an unsupported Region. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ResourceLimitExceededException * The request exceeds the resource limit. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.CreateAttendee * @see AWS API * Documentation */ CreateAttendeeResult createAttendee(CreateAttendeeRequest createAttendeeRequest); /** * * Creates a bot for an Amazon Chime Enterprise account. * * * @param createBotRequest * @return Result of the CreateBot operation returned by the service. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws ResourceLimitExceededException * The request exceeds the resource limit. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ThrottledClientException * The client exceeded its request rate limit. * @sample AmazonChime.CreateBot * @see AWS API * Documentation */ CreateBotResult createBot(CreateBotRequest createBotRequest); /** * * 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. For example, when a user tries to create an * account from an unsupported Region. * @throws ResourceLimitExceededException * The request exceeds the resource limit. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.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. For example, when a user tries to create an * account from an unsupported Region. * @throws ResourceLimitExceededException * The request exceeds the resource limit. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.CreateMeetingWithAttendees * @see AWS API Documentation */ CreateMeetingWithAttendeesResult createMeetingWithAttendees(CreateMeetingWithAttendeesRequest createMeetingWithAttendeesRequest); /** * * Creates an order for phone numbers to be provisioned. Choose from Amazon Chime Business Calling and Amazon Chime * Voice Connector product types. For toll-free numbers, you must use the Amazon Chime Voice Connector product type. * * * @param createPhoneNumberOrderRequest * @return Result of the CreatePhoneNumberOrder 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. For example, when a user tries to create an * account from an unsupported Region. * @throws AccessDeniedException * You don't have permissions to perform the requested operation. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ResourceLimitExceededException * The request exceeds the resource limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.CreatePhoneNumberOrder * @see AWS * API Documentation */ CreatePhoneNumberOrderResult createPhoneNumberOrder(CreatePhoneNumberOrderRequest createPhoneNumberOrderRequest); /** * * Creates a proxy session on the specified Amazon Chime Voice Connector for the specified participant phone * numbers. * * * @param createProxySessionRequest * @return Result of the CreateProxySession operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.CreateProxySession * @see AWS API * Documentation */ CreateProxySessionResult createProxySession(CreateProxySessionRequest createProxySessionRequest); /** * * Creates a chat room for the specified Amazon Chime Enterprise account. * * * @param createRoomRequest * @return Result of the CreateRoom 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. For example, when a user tries to create an * account from an unsupported Region. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws ResourceLimitExceededException * The request exceeds the resource limit. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.CreateRoom * @see AWS API * Documentation */ CreateRoomResult createRoom(CreateRoomRequest createRoomRequest); /** * * Adds a member to a chat room in an Amazon Chime Enterprise account. A member can be either a user or a bot. The * member role designates whether the member is a chat room administrator or a general chat room member. * * * @param createRoomMembershipRequest * @return Result of the CreateRoomMembership operation returned by the service. * @throws ConflictException * The request could not be processed because of conflict in the current state of the resource. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @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. For example, when a user tries to create an * account from an unsupported Region. * @throws ResourceLimitExceededException * The request exceeds the resource limit. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.CreateRoomMembership * @see AWS API * Documentation */ CreateRoomMembershipResult createRoomMembership(CreateRoomMembershipRequest createRoomMembershipRequest); /** * * Creates a user under the specified Amazon Chime account. * * * @param createUserRequest * @return Result of the CreateUser operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ConflictException * The request could not be processed because of conflict in the current state of the resource. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.CreateUser * @see AWS API * Documentation */ CreateUserResult createUser(CreateUserRequest createUserRequest); /** * * Creates an Amazon Chime Voice Connector under the administrator's AWS account. You can choose to create an Amazon * Chime Voice Connector in a specific AWS Region. * * * Enabling CreateVoiceConnectorRequest$RequireEncryption configures your Amazon Chime Voice Connector to use * TLS transport for SIP signaling and Secure RTP (SRTP) for media. Inbound calls use TLS transport, and unencrypted * outbound calls are blocked. * * * @param createVoiceConnectorRequest * @return Result of the CreateVoiceConnector 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. For example, when a user tries to create an * account from an unsupported Region. * @throws AccessDeniedException * You don't have permissions to perform the requested operation. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ResourceLimitExceededException * The request exceeds the resource limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.CreateVoiceConnector * @see AWS API * Documentation */ CreateVoiceConnectorResult createVoiceConnector(CreateVoiceConnectorRequest createVoiceConnectorRequest); /** * * Creates an Amazon Chime Voice Connector group under the administrator's AWS account. You can associate Amazon * Chime Voice Connectors with the Amazon Chime Voice Connector group by including VoiceConnectorItems * in the request. * * * You can include Amazon Chime Voice Connectors from different AWS Regions in your group. This creates a fault * tolerant mechanism for fallback in case of availability events. * * * @param createVoiceConnectorGroupRequest * @return Result of the CreateVoiceConnectorGroup 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. For example, when a user tries to create an * account from an unsupported Region. * @throws AccessDeniedException * You don't have permissions to perform the requested operation. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ResourceLimitExceededException * The request exceeds the resource limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.CreateVoiceConnectorGroup * @see AWS API Documentation */ CreateVoiceConnectorGroupResult createVoiceConnectorGroup(CreateVoiceConnectorGroupRequest createVoiceConnectorGroupRequest); /** * * Deletes the specified Amazon Chime account. You must suspend all users before deleting a Team * account. You can use the BatchSuspendUser action to do so. * * * For EnterpriseLWA and EnterpriseAD accounts, you must release the claimed domains for * your Amazon Chime account before deletion. As soon as you release the domain, all users under that account are * suspended. * * * Deleted accounts appear in your Disabled accounts list for 90 days. To restore a deleted account * from your Disabled accounts list, you must contact AWS Support. * * * After 90 days, deleted accounts are permanently removed from your Disabled accounts list. * * * @param deleteAccountRequest * @return Result of the DeleteAccount operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws UnprocessableEntityException * The request was well-formed but was unable to be followed due to semantic errors. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.DeleteAccount * @see AWS API * Documentation */ DeleteAccountResult deleteAccount(DeleteAccountRequest deleteAccountRequest); /** * * 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. * * * @param deleteAttendeeRequest * @return Result of the DeleteAttendee 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. For example, when a user tries to create an * account from an unsupported Region. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.DeleteAttendee * @see AWS API * Documentation */ DeleteAttendeeResult deleteAttendee(DeleteAttendeeRequest deleteAttendeeRequest); /** * * Deletes the events configuration that allows a bot to receive outgoing events. * * * @param deleteEventsConfigurationRequest * @return Result of the DeleteEventsConfiguration operation returned by the service. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws ResourceLimitExceededException * The request exceeds the resource limit. * @sample AmazonChime.DeleteEventsConfiguration * @see AWS API Documentation */ DeleteEventsConfigurationResult deleteEventsConfiguration(DeleteEventsConfigurationRequest deleteEventsConfigurationRequest); /** * * Deletes the specified Amazon Chime SDK meeting. When a meeting is deleted, its attendees are also deleted and * clients can no longer join it. 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. For example, when a user tries to create an * account from an unsupported Region. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.DeleteMeeting * @see AWS API * Documentation */ DeleteMeetingResult deleteMeeting(DeleteMeetingRequest deleteMeetingRequest); /** * * Moves the specified phone number into the Deletion queue. A phone number must be disassociated from any * users or Amazon Chime Voice Connectors before it can be deleted. * * * Deleted phone numbers remain in the Deletion queue for 7 days before they are deleted permanently. * * * @param deletePhoneNumberRequest * @return Result of the DeletePhoneNumber operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.DeletePhoneNumber * @see AWS API * Documentation */ DeletePhoneNumberResult deletePhoneNumber(DeletePhoneNumberRequest deletePhoneNumberRequest); /** * * Deletes the specified proxy session from the specified Amazon Chime Voice Connector. * * * @param deleteProxySessionRequest * @return Result of the DeleteProxySession operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.DeleteProxySession * @see AWS API * Documentation */ DeleteProxySessionResult deleteProxySession(DeleteProxySessionRequest deleteProxySessionRequest); /** * * Deletes a chat room in an Amazon Chime Enterprise account. * * * @param deleteRoomRequest * @return Result of the DeleteRoom 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. For example, when a user tries to create an * account from an unsupported Region. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.DeleteRoom * @see AWS API * Documentation */ DeleteRoomResult deleteRoom(DeleteRoomRequest deleteRoomRequest); /** * * Removes a member from a chat room in an Amazon Chime Enterprise account. * * * @param deleteRoomMembershipRequest * @return Result of the DeleteRoomMembership operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @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. For example, when a user tries to create an * account from an unsupported Region. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.DeleteRoomMembership * @see AWS API * Documentation */ DeleteRoomMembershipResult deleteRoomMembership(DeleteRoomMembershipRequest deleteRoomMembershipRequest); /** * * Deletes the specified Amazon Chime Voice Connector. Any phone numbers associated with the Amazon Chime Voice * Connector must be disassociated from it before it can be deleted. * * * @param deleteVoiceConnectorRequest * @return Result of the DeleteVoiceConnector operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ConflictException * The request could not be processed because of conflict in the current state of the resource. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.DeleteVoiceConnector * @see AWS API * Documentation */ DeleteVoiceConnectorResult deleteVoiceConnector(DeleteVoiceConnectorRequest deleteVoiceConnectorRequest); /** * * Deletes the emergency calling configuration details from the specified Amazon Chime Voice Connector. * * * @param deleteVoiceConnectorEmergencyCallingConfigurationRequest * @return Result of the DeleteVoiceConnectorEmergencyCallingConfiguration operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.DeleteVoiceConnectorEmergencyCallingConfiguration * @see AWS API Documentation */ DeleteVoiceConnectorEmergencyCallingConfigurationResult deleteVoiceConnectorEmergencyCallingConfiguration( DeleteVoiceConnectorEmergencyCallingConfigurationRequest deleteVoiceConnectorEmergencyCallingConfigurationRequest); /** * * Deletes the specified Amazon Chime Voice Connector group. Any VoiceConnectorItems and phone numbers * associated with the group must be removed before it can be deleted. * * * @param deleteVoiceConnectorGroupRequest * @return Result of the DeleteVoiceConnectorGroup operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ConflictException * The request could not be processed because of conflict in the current state of the resource. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.DeleteVoiceConnectorGroup * @see AWS API Documentation */ DeleteVoiceConnectorGroupResult deleteVoiceConnectorGroup(DeleteVoiceConnectorGroupRequest deleteVoiceConnectorGroupRequest); /** * * Deletes the origination settings for the specified Amazon Chime Voice Connector. * * * * If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to deleting the * origination settings. * * * * @param deleteVoiceConnectorOriginationRequest * @return Result of the DeleteVoiceConnectorOrigination operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.DeleteVoiceConnectorOrigination * @see AWS API Documentation */ DeleteVoiceConnectorOriginationResult deleteVoiceConnectorOrigination(DeleteVoiceConnectorOriginationRequest deleteVoiceConnectorOriginationRequest); /** * * Deletes the proxy configuration from the specified Amazon Chime Voice Connector. * * * @param deleteVoiceConnectorProxyRequest * @return Result of the DeleteVoiceConnectorProxy operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.DeleteVoiceConnectorProxy * @see AWS API Documentation */ DeleteVoiceConnectorProxyResult deleteVoiceConnectorProxy(DeleteVoiceConnectorProxyRequest deleteVoiceConnectorProxyRequest); /** * * Deletes the streaming configuration for the specified Amazon Chime Voice Connector. * * * @param deleteVoiceConnectorStreamingConfigurationRequest * @return Result of the DeleteVoiceConnectorStreamingConfiguration operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.DeleteVoiceConnectorStreamingConfiguration * @see AWS API Documentation */ DeleteVoiceConnectorStreamingConfigurationResult deleteVoiceConnectorStreamingConfiguration( DeleteVoiceConnectorStreamingConfigurationRequest deleteVoiceConnectorStreamingConfigurationRequest); /** * * Deletes the termination settings for the specified Amazon Chime Voice Connector. * * * * If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to deleting the * termination settings. * * * * @param deleteVoiceConnectorTerminationRequest * @return Result of the DeleteVoiceConnectorTermination operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.DeleteVoiceConnectorTermination * @see AWS API Documentation */ DeleteVoiceConnectorTerminationResult deleteVoiceConnectorTermination(DeleteVoiceConnectorTerminationRequest deleteVoiceConnectorTerminationRequest); /** * * Deletes the specified SIP credentials used by your equipment to authenticate during call termination. * * * @param deleteVoiceConnectorTerminationCredentialsRequest * @return Result of the DeleteVoiceConnectorTerminationCredentials operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.DeleteVoiceConnectorTerminationCredentials * @see AWS API Documentation */ DeleteVoiceConnectorTerminationCredentialsResult deleteVoiceConnectorTerminationCredentials( DeleteVoiceConnectorTerminationCredentialsRequest deleteVoiceConnectorTerminationCredentialsRequest); /** * * Disassociates the primary provisioned phone number from the specified Amazon Chime user. * * * @param disassociatePhoneNumberFromUserRequest * @return Result of the DisassociatePhoneNumberFromUser operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.DisassociatePhoneNumberFromUser * @see AWS API Documentation */ DisassociatePhoneNumberFromUserResult disassociatePhoneNumberFromUser(DisassociatePhoneNumberFromUserRequest disassociatePhoneNumberFromUserRequest); /** * * Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector. * * * @param disassociatePhoneNumbersFromVoiceConnectorRequest * @return Result of the DisassociatePhoneNumbersFromVoiceConnector operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.DisassociatePhoneNumbersFromVoiceConnector * @see AWS API Documentation */ DisassociatePhoneNumbersFromVoiceConnectorResult disassociatePhoneNumbersFromVoiceConnector( DisassociatePhoneNumbersFromVoiceConnectorRequest disassociatePhoneNumbersFromVoiceConnectorRequest); /** * * Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector group. * * * @param disassociatePhoneNumbersFromVoiceConnectorGroupRequest * @return Result of the DisassociatePhoneNumbersFromVoiceConnectorGroup operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.DisassociatePhoneNumbersFromVoiceConnectorGroup * @see AWS API Documentation */ DisassociatePhoneNumbersFromVoiceConnectorGroupResult disassociatePhoneNumbersFromVoiceConnectorGroup( DisassociatePhoneNumbersFromVoiceConnectorGroupRequest disassociatePhoneNumbersFromVoiceConnectorGroupRequest); /** * * Disassociates the specified sign-in delegate groups from the specified Amazon Chime account. * * * @param disassociateSigninDelegateGroupsFromAccountRequest * @return Result of the DisassociateSigninDelegateGroupsFromAccount operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.DisassociateSigninDelegateGroupsFromAccount * @see AWS API Documentation */ DisassociateSigninDelegateGroupsFromAccountResult disassociateSigninDelegateGroupsFromAccount( DisassociateSigninDelegateGroupsFromAccountRequest disassociateSigninDelegateGroupsFromAccountRequest); /** * * Retrieves details for the specified Amazon Chime account, such as account type and supported licenses. * * * @param getAccountRequest * @return Result of the GetAccount operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.GetAccount * @see AWS API * Documentation */ GetAccountResult getAccount(GetAccountRequest getAccountRequest); /** * * Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dial out * settings. For more information about these settings, see Use the Policies Page in the Amazon Chime * Administration Guide. * * * @param getAccountSettingsRequest * @return Result of the GetAccountSettings operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @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. For example, when a user tries to create an * account from an unsupported Region. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.GetAccountSettings * @see AWS API * Documentation */ GetAccountSettingsResult getAccountSettings(GetAccountSettingsRequest getAccountSettingsRequest); /** * * 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. For example, when a user tries to create an * account from an unsupported Region. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.GetAttendee * @see AWS API * Documentation */ GetAttendeeResult getAttendee(GetAttendeeRequest getAttendeeRequest); /** * * Retrieves details for the specified bot, such as bot email address, bot type, status, and display name. * * * @param getBotRequest * @return Result of the GetBot operation returned by the service. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @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 ThrottledClientException * The client exceeded its request rate limit. * @sample AmazonChime.GetBot * @see AWS API * Documentation */ GetBotResult getBot(GetBotRequest getBotRequest); /** * * Gets details for an events configuration that allows a bot to receive outgoing events, such as an HTTPS endpoint * or Lambda function ARN. * * * @param getEventsConfigurationRequest * @return Result of the GetEventsConfiguration operation returned by the service. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws ResourceLimitExceededException * The request exceeds the resource limit. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @sample AmazonChime.GetEventsConfiguration * @see AWS * API Documentation */ GetEventsConfigurationResult getEventsConfiguration(GetEventsConfigurationRequest getEventsConfigurationRequest); /** * * Retrieves global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon * Chime Voice Connector settings. * * * @param getGlobalSettingsRequest * @return Result of the GetGlobalSettings operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.GetGlobalSettings * @see AWS API * Documentation */ GetGlobalSettingsResult getGlobalSettings(GetGlobalSettingsRequest getGlobalSettingsRequest); /** * * 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 BadRequestException * The input parameters don't match the service's restrictions. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.GetMeeting * @see AWS API * Documentation */ GetMeetingResult getMeeting(GetMeetingRequest getMeetingRequest); /** * * Retrieves details for the specified phone number ID, such as associations, capabilities, and product type. * * * @param getPhoneNumberRequest * @return Result of the GetPhoneNumber operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.GetPhoneNumber * @see AWS API * Documentation */ GetPhoneNumberResult getPhoneNumber(GetPhoneNumberRequest getPhoneNumberRequest); /** * * Retrieves details for the specified phone number order, such as order creation timestamp, phone numbers in E.164 * format, product type, and order status. * * * @param getPhoneNumberOrderRequest * @return Result of the GetPhoneNumberOrder operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.GetPhoneNumberOrder * @see AWS API * Documentation */ GetPhoneNumberOrderResult getPhoneNumberOrder(GetPhoneNumberOrderRequest getPhoneNumberOrderRequest); /** * * Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling * name. * * * @param getPhoneNumberSettingsRequest * @return Result of the GetPhoneNumberSettings operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.GetPhoneNumberSettings * @see AWS * API Documentation */ GetPhoneNumberSettingsResult getPhoneNumberSettings(GetPhoneNumberSettingsRequest getPhoneNumberSettingsRequest); /** * * Gets the specified proxy session details for the specified Amazon Chime Voice Connector. * * * @param getProxySessionRequest * @return Result of the GetProxySession operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.GetProxySession * @see AWS API * Documentation */ GetProxySessionResult getProxySession(GetProxySessionRequest getProxySessionRequest); /** * * Gets the retention settings for the specified Amazon Chime Enterprise account. For more information about * retention settings, see Managing Chat * Retention Policies in the Amazon Chime Administration Guide. * * * @param getRetentionSettingsRequest * @return Result of the GetRetentionSettings operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @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. For example, when a user tries to create an * account from an unsupported Region. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.GetRetentionSettings * @see AWS API * Documentation */ GetRetentionSettingsResult getRetentionSettings(GetRetentionSettingsRequest getRetentionSettingsRequest); /** * * Retrieves room details, such as the room name, for a room in an Amazon Chime Enterprise account. * * * @param getRoomRequest * @return Result of the GetRoom 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. For example, when a user tries to create an * account from an unsupported Region. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.GetRoom * @see AWS API * Documentation */ GetRoomResult getRoom(GetRoomRequest getRoomRequest); /** * * Retrieves details for the specified user ID, such as primary email address, license type, and personal meeting * PIN. * * * To retrieve user details with an email address instead of a user ID, use the ListUsers action, and then * filter by email address. * * * @param getUserRequest * @return Result of the GetUser operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.GetUser * @see AWS API * Documentation */ GetUserResult getUser(GetUserRequest getUserRequest); /** * * Retrieves settings for the specified user ID, such as any associated phone number settings. * * * @param getUserSettingsRequest * @return Result of the GetUserSettings operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.GetUserSettings * @see AWS API * Documentation */ GetUserSettingsResult getUserSettings(GetUserSettingsRequest getUserSettingsRequest); /** * * Retrieves details for the specified Amazon Chime Voice Connector, such as timestamps, name, outbound host, and * encryption requirements. * * * @param getVoiceConnectorRequest * @return Result of the GetVoiceConnector operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.GetVoiceConnector * @see AWS API * Documentation */ GetVoiceConnectorResult getVoiceConnector(GetVoiceConnectorRequest getVoiceConnectorRequest); /** * * Gets the emergency calling configuration details for the specified Amazon Chime Voice Connector. * * * @param getVoiceConnectorEmergencyCallingConfigurationRequest * @return Result of the GetVoiceConnectorEmergencyCallingConfiguration operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.GetVoiceConnectorEmergencyCallingConfiguration * @see AWS API Documentation */ GetVoiceConnectorEmergencyCallingConfigurationResult getVoiceConnectorEmergencyCallingConfiguration( GetVoiceConnectorEmergencyCallingConfigurationRequest getVoiceConnectorEmergencyCallingConfigurationRequest); /** * * Retrieves details for the specified Amazon Chime Voice Connector group, such as timestamps, name, and associated * VoiceConnectorItems. * * * @param getVoiceConnectorGroupRequest * @return Result of the GetVoiceConnectorGroup operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.GetVoiceConnectorGroup * @see AWS * API Documentation */ GetVoiceConnectorGroupResult getVoiceConnectorGroup(GetVoiceConnectorGroupRequest getVoiceConnectorGroupRequest); /** * * Retrieves the logging configuration details for the specified Amazon Chime Voice Connector. Shows whether SIP * message logs are enabled for sending to Amazon CloudWatch Logs. * * * @param getVoiceConnectorLoggingConfigurationRequest * @return Result of the GetVoiceConnectorLoggingConfiguration operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.GetVoiceConnectorLoggingConfiguration * @see AWS API Documentation */ GetVoiceConnectorLoggingConfigurationResult getVoiceConnectorLoggingConfiguration( GetVoiceConnectorLoggingConfigurationRequest getVoiceConnectorLoggingConfigurationRequest); /** * * Retrieves origination setting details for the specified Amazon Chime Voice Connector. * * * @param getVoiceConnectorOriginationRequest * @return Result of the GetVoiceConnectorOrigination operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.GetVoiceConnectorOrigination * @see AWS API Documentation */ GetVoiceConnectorOriginationResult getVoiceConnectorOrigination(GetVoiceConnectorOriginationRequest getVoiceConnectorOriginationRequest); /** * * Gets the proxy configuration details for the specified Amazon Chime Voice Connector. * * * @param getVoiceConnectorProxyRequest * @return Result of the GetVoiceConnectorProxy operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.GetVoiceConnectorProxy * @see AWS * API Documentation */ GetVoiceConnectorProxyResult getVoiceConnectorProxy(GetVoiceConnectorProxyRequest getVoiceConnectorProxyRequest); /** * * Retrieves the streaming configuration details for the specified Amazon Chime Voice Connector. Shows whether media * streaming is enabled for sending to Amazon Kinesis. It also shows the retention period, in hours, for the Amazon * Kinesis data. * * * @param getVoiceConnectorStreamingConfigurationRequest * @return Result of the GetVoiceConnectorStreamingConfiguration operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.GetVoiceConnectorStreamingConfiguration * @see AWS API Documentation */ GetVoiceConnectorStreamingConfigurationResult getVoiceConnectorStreamingConfiguration( GetVoiceConnectorStreamingConfigurationRequest getVoiceConnectorStreamingConfigurationRequest); /** * * Retrieves termination setting details for the specified Amazon Chime Voice Connector. * * * @param getVoiceConnectorTerminationRequest * @return Result of the GetVoiceConnectorTermination operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.GetVoiceConnectorTermination * @see AWS API Documentation */ GetVoiceConnectorTerminationResult getVoiceConnectorTermination(GetVoiceConnectorTerminationRequest getVoiceConnectorTerminationRequest); /** * * Retrieves information about the last time a SIP OPTIONS ping was received from your SIP * infrastructure for the specified Amazon Chime Voice Connector. * * * @param getVoiceConnectorTerminationHealthRequest * @return Result of the GetVoiceConnectorTerminationHealth operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.GetVoiceConnectorTerminationHealth * @see AWS API Documentation */ GetVoiceConnectorTerminationHealthResult getVoiceConnectorTerminationHealth( GetVoiceConnectorTerminationHealthRequest getVoiceConnectorTerminationHealthRequest); /** * * Sends email to a maximum of 50 users, inviting them to the specified Amazon Chime Team account. Only * Team account types are currently supported for this action. * * * @param inviteUsersRequest * @return Result of the InviteUsers operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.InviteUsers * @see AWS API * Documentation */ InviteUsersResult inviteUsers(InviteUsersRequest inviteUsersRequest); /** * * Lists the Amazon Chime accounts under the administrator's AWS account. You can filter accounts by account name * prefix. To find out which Amazon Chime account a user belongs to, you can filter by the user's email address, * which returns one account result. * * * @param listAccountsRequest * @return Result of the ListAccounts operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.ListAccounts * @see AWS API * Documentation */ ListAccountsResult listAccounts(ListAccountsRequest listAccountsRequest); /** * * Lists the tags applied to an Amazon Chime SDK attendee resource. * * * @param listAttendeeTagsRequest * @return Result of the ListAttendeeTags 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. For example, when a user tries to create an * account from an unsupported Region. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.ListAttendeeTags * @see AWS API * Documentation */ ListAttendeeTagsResult listAttendeeTags(ListAttendeeTagsRequest listAttendeeTagsRequest); /** * * 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. For example, when a user tries to create an * account from an unsupported Region. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.ListAttendees * @see AWS API * Documentation */ ListAttendeesResult listAttendees(ListAttendeesRequest listAttendeesRequest); /** * * Lists the bots associated with the administrator's Amazon Chime Enterprise account ID. * * * @param listBotsRequest * @return Result of the ListBots operation returned by the service. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ThrottledClientException * The client exceeded its request rate limit. * @sample AmazonChime.ListBots * @see AWS API * Documentation */ ListBotsResult listBots(ListBotsRequest listBotsRequest); /** * * Lists the tags applied to an Amazon Chime SDK meeting resource. * * * @param listMeetingTagsRequest * @return Result of the ListMeetingTags 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. For example, when a user tries to create an * account from an unsupported Region. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.ListMeetingTags * @see AWS API * Documentation */ ListMeetingTagsResult listMeetingTags(ListMeetingTagsRequest listMeetingTagsRequest); /** * * Lists up to 100 active Amazon Chime SDK meetings. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the * Amazon Chime Developer Guide. * * * @param listMeetingsRequest * @return Result of the ListMeetings 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. For example, when a user tries to create an * account from an unsupported Region. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.ListMeetings * @see AWS API * Documentation */ ListMeetingsResult listMeetings(ListMeetingsRequest listMeetingsRequest); /** * * Lists the phone number orders for the administrator's Amazon Chime account. * * * @param listPhoneNumberOrdersRequest * @return Result of the ListPhoneNumberOrders operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.ListPhoneNumberOrders * @see AWS * API Documentation */ ListPhoneNumberOrdersResult listPhoneNumberOrders(ListPhoneNumberOrdersRequest listPhoneNumberOrdersRequest); /** * * Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, Amazon Chime Voice Connector, * or Amazon Chime Voice Connector group. * * * @param listPhoneNumbersRequest * @return Result of the ListPhoneNumbers operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.ListPhoneNumbers * @see AWS API * Documentation */ ListPhoneNumbersResult listPhoneNumbers(ListPhoneNumbersRequest listPhoneNumbersRequest); /** * * Lists the proxy sessions for the specified Amazon Chime Voice Connector. * * * @param listProxySessionsRequest * @return Result of the ListProxySessions operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.ListProxySessions * @see AWS API * Documentation */ ListProxySessionsResult listProxySessions(ListProxySessionsRequest listProxySessionsRequest); /** * * Lists the membership details for the specified room in an Amazon Chime Enterprise account, such as the members' * IDs, email addresses, and names. * * * @param listRoomMembershipsRequest * @return Result of the ListRoomMemberships 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. For example, when a user tries to create an * account from an unsupported Region. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.ListRoomMemberships * @see AWS API * Documentation */ ListRoomMembershipsResult listRoomMemberships(ListRoomMembershipsRequest listRoomMembershipsRequest); /** * * Lists the room details for the specified Amazon Chime Enterprise account. Optionally, filter the results by a * member ID (user ID or bot ID) to see a list of rooms that the member belongs to. * * * @param listRoomsRequest * @return Result of the ListRooms 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. For example, when a user tries to create an * account from an unsupported Region. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.ListRooms * @see AWS API * Documentation */ ListRoomsResult listRooms(ListRoomsRequest listRoomsRequest); /** * * Lists the tags applied to an Amazon Chime SDK meeting resource. * * * @param listTagsForResourceRequest * @return Result of the ListTagsForResource 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. For example, when a user tries to create an * account from an unsupported Region. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.ListTagsForResource * @see AWS API * Documentation */ ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest); /** * * Lists the users that belong to the specified Amazon Chime account. You can specify an email address to list only * the user that the email address belongs to. * * * @param listUsersRequest * @return Result of the ListUsers operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.ListUsers * @see AWS API * Documentation */ ListUsersResult listUsers(ListUsersRequest listUsersRequest); /** * * Lists the Amazon Chime Voice Connector groups for the administrator's AWS account. * * * @param listVoiceConnectorGroupsRequest * @return Result of the ListVoiceConnectorGroups operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.ListVoiceConnectorGroups * @see AWS * API Documentation */ ListVoiceConnectorGroupsResult listVoiceConnectorGroups(ListVoiceConnectorGroupsRequest listVoiceConnectorGroupsRequest); /** * * Lists the SIP credentials for the specified Amazon Chime Voice Connector. * * * @param listVoiceConnectorTerminationCredentialsRequest * @return Result of the ListVoiceConnectorTerminationCredentials operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.ListVoiceConnectorTerminationCredentials * @see AWS API Documentation */ ListVoiceConnectorTerminationCredentialsResult listVoiceConnectorTerminationCredentials( ListVoiceConnectorTerminationCredentialsRequest listVoiceConnectorTerminationCredentialsRequest); /** * * Lists the Amazon Chime Voice Connectors for the administrator's AWS account. * * * @param listVoiceConnectorsRequest * @return Result of the ListVoiceConnectors operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.ListVoiceConnectors * @see AWS API * Documentation */ ListVoiceConnectorsResult listVoiceConnectors(ListVoiceConnectorsRequest listVoiceConnectorsRequest); /** * * Logs out the specified user from all of the devices they are currently logged into. * * * @param logoutUserRequest * @return Result of the LogoutUser operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.LogoutUser * @see AWS API * Documentation */ LogoutUserResult logoutUser(LogoutUserRequest logoutUserRequest); /** * * Creates an events configuration that allows a bot to receive outgoing events sent by Amazon Chime. Choose either * an HTTPS endpoint or a Lambda function ARN. For more information, see Bot. * * * @param putEventsConfigurationRequest * @return Result of the PutEventsConfiguration operation returned by the service. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws ResourceLimitExceededException * The request exceeds the resource limit. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @sample AmazonChime.PutEventsConfiguration * @see AWS * API Documentation */ PutEventsConfigurationResult putEventsConfiguration(PutEventsConfigurationRequest putEventsConfigurationRequest); /** * * Puts retention settings for the specified Amazon Chime Enterprise account. We recommend using AWS CloudTrail to * monitor usage of this API for your account. For more information, see Logging Amazon Chime API Calls with AWS * CloudTrail in the Amazon Chime Administration Guide. * * * To turn off existing retention settings, remove the number of days from the corresponding RetentionDays * field in the RetentionSettings object. For more information about retention settings, see Managing Chat Retention Policies in * the Amazon Chime Administration Guide. * * * @param putRetentionSettingsRequest * @return Result of the PutRetentionSettings operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @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. For example, when a user tries to create an * account from an unsupported Region. * @throws ConflictException * The request could not be processed because of conflict in the current state of the resource. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.PutRetentionSettings * @see AWS API * Documentation */ PutRetentionSettingsResult putRetentionSettings(PutRetentionSettingsRequest putRetentionSettingsRequest); /** * * Puts emergency calling configuration details to the specified Amazon Chime Voice Connector, such as emergency * phone numbers and calling countries. Origination and termination settings must be enabled for the Amazon Chime * Voice Connector before emergency calling can be configured. * * * @param putVoiceConnectorEmergencyCallingConfigurationRequest * @return Result of the PutVoiceConnectorEmergencyCallingConfiguration operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.PutVoiceConnectorEmergencyCallingConfiguration * @see AWS API Documentation */ PutVoiceConnectorEmergencyCallingConfigurationResult putVoiceConnectorEmergencyCallingConfiguration( PutVoiceConnectorEmergencyCallingConfigurationRequest putVoiceConnectorEmergencyCallingConfigurationRequest); /** * * Adds a logging configuration for the specified Amazon Chime Voice Connector. The logging configuration specifies * whether SIP message logs are enabled for sending to Amazon CloudWatch Logs. * * * @param putVoiceConnectorLoggingConfigurationRequest * @return Result of the PutVoiceConnectorLoggingConfiguration operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.PutVoiceConnectorLoggingConfiguration * @see AWS API Documentation */ PutVoiceConnectorLoggingConfigurationResult putVoiceConnectorLoggingConfiguration( PutVoiceConnectorLoggingConfigurationRequest putVoiceConnectorLoggingConfigurationRequest); /** * * Adds origination settings for the specified Amazon Chime Voice Connector. * * * * If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to turning off * origination settings. * * * * @param putVoiceConnectorOriginationRequest * @return Result of the PutVoiceConnectorOrigination operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.PutVoiceConnectorOrigination * @see AWS API Documentation */ PutVoiceConnectorOriginationResult putVoiceConnectorOrigination(PutVoiceConnectorOriginationRequest putVoiceConnectorOriginationRequest); /** * * Puts the specified proxy configuration to the specified Amazon Chime Voice Connector. * * * @param putVoiceConnectorProxyRequest * @return Result of the PutVoiceConnectorProxy operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws AccessDeniedException * You don't have permissions to perform the requested operation. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.PutVoiceConnectorProxy * @see AWS * API Documentation */ PutVoiceConnectorProxyResult putVoiceConnectorProxy(PutVoiceConnectorProxyRequest putVoiceConnectorProxyRequest); /** * * Adds a streaming configuration for the specified Amazon Chime Voice Connector. The streaming configuration * specifies whether media streaming is enabled for sending to Amazon Kinesis. It also sets the retention period, in * hours, for the Amazon Kinesis data. * * * @param putVoiceConnectorStreamingConfigurationRequest * @return Result of the PutVoiceConnectorStreamingConfiguration operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.PutVoiceConnectorStreamingConfiguration * @see AWS API Documentation */ PutVoiceConnectorStreamingConfigurationResult putVoiceConnectorStreamingConfiguration( PutVoiceConnectorStreamingConfigurationRequest putVoiceConnectorStreamingConfigurationRequest); /** * * Adds termination settings for the specified Amazon Chime Voice Connector. * * * * If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to turning off * termination settings. * * * * @param putVoiceConnectorTerminationRequest * @return Result of the PutVoiceConnectorTermination operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws AccessDeniedException * You don't have permissions to perform the requested operation. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.PutVoiceConnectorTermination * @see AWS API Documentation */ PutVoiceConnectorTerminationResult putVoiceConnectorTermination(PutVoiceConnectorTerminationRequest putVoiceConnectorTerminationRequest); /** * * Adds termination SIP credentials for the specified Amazon Chime Voice Connector. * * * @param putVoiceConnectorTerminationCredentialsRequest * @return Result of the PutVoiceConnectorTerminationCredentials operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.PutVoiceConnectorTerminationCredentials * @see AWS API Documentation */ PutVoiceConnectorTerminationCredentialsResult putVoiceConnectorTerminationCredentials( PutVoiceConnectorTerminationCredentialsRequest putVoiceConnectorTerminationCredentialsRequest); /** * * Redacts the specified message from the specified Amazon Chime conversation. * * * @param redactConversationMessageRequest * @return Result of the RedactConversationMessage operation returned by the service. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.RedactConversationMessage * @see AWS API Documentation */ RedactConversationMessageResult redactConversationMessage(RedactConversationMessageRequest redactConversationMessageRequest); /** * * Redacts the specified message from the specified Amazon Chime chat room. * * * @param redactRoomMessageRequest * @return Result of the RedactRoomMessage operation returned by the service. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.RedactRoomMessage * @see AWS API * Documentation */ RedactRoomMessageResult redactRoomMessage(RedactRoomMessageRequest redactRoomMessageRequest); /** * * Regenerates the security token for a bot. * * * @param regenerateSecurityTokenRequest * @return Result of the RegenerateSecurityToken operation returned by the service. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ThrottledClientException * The client exceeded its request rate limit. * @sample AmazonChime.RegenerateSecurityToken * @see AWS * API Documentation */ RegenerateSecurityTokenResult regenerateSecurityToken(RegenerateSecurityTokenRequest regenerateSecurityTokenRequest); /** * * Resets the personal meeting PIN for the specified user on an Amazon Chime account. Returns the User object * with the updated personal meeting PIN. * * * @param resetPersonalPINRequest * @return Result of the ResetPersonalPIN operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.ResetPersonalPIN * @see AWS API * Documentation */ ResetPersonalPINResult resetPersonalPIN(ResetPersonalPINRequest resetPersonalPINRequest); /** * * Moves a phone number from the Deletion queue back into the phone number Inventory. * * * @param restorePhoneNumberRequest * @return Result of the RestorePhoneNumber operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ResourceLimitExceededException * The request exceeds the resource limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.RestorePhoneNumber * @see AWS API * Documentation */ RestorePhoneNumberResult restorePhoneNumber(RestorePhoneNumberRequest restorePhoneNumberRequest); /** * * Searches phone numbers that can be ordered. * * * @param searchAvailablePhoneNumbersRequest * @return Result of the SearchAvailablePhoneNumbers 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. For example, when a user tries to create an * account from an unsupported Region. * @throws AccessDeniedException * You don't have permissions to perform the requested operation. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.SearchAvailablePhoneNumbers * @see AWS API Documentation */ SearchAvailablePhoneNumbersResult searchAvailablePhoneNumbers(SearchAvailablePhoneNumbersRequest searchAvailablePhoneNumbersRequest); /** * * Applies the specified tags to the specified Amazon Chime SDK attendee. * * * @param tagAttendeeRequest * @return Result of the TagAttendee 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. For example, when a user tries to create an * account from an unsupported Region. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ResourceLimitExceededException * The request exceeds the resource limit. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.TagAttendee * @see AWS API * Documentation */ TagAttendeeResult tagAttendee(TagAttendeeRequest tagAttendeeRequest); /** * * Applies the specified tags to the specified Amazon Chime SDK meeting. * * * @param tagMeetingRequest * @return Result of the TagMeeting 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. For example, when a user tries to create an * account from an unsupported Region. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ResourceLimitExceededException * The request exceeds the resource limit. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.TagMeeting * @see AWS API * Documentation */ TagMeetingResult tagMeeting(TagMeetingRequest tagMeetingRequest); /** * * Applies the specified tags to the specified Amazon Chime SDK meeting resource. * * * @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 ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.TagResource * @see AWS API * Documentation */ TagResourceResult tagResource(TagResourceRequest tagResourceRequest); /** * * Untags the specified tags from the specified Amazon Chime SDK attendee. * * * @param untagAttendeeRequest * @return Result of the UntagAttendee 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. For example, when a user tries to create an * account from an unsupported Region. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.UntagAttendee * @see AWS API * Documentation */ UntagAttendeeResult untagAttendee(UntagAttendeeRequest untagAttendeeRequest); /** * * Untags the specified tags from the specified Amazon Chime SDK meeting. * * * @param untagMeetingRequest * @return Result of the UntagMeeting 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. For example, when a user tries to create an * account from an unsupported Region. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.UntagMeeting * @see AWS API * Documentation */ UntagMeetingResult untagMeeting(UntagMeetingRequest untagMeetingRequest); /** * * Untags the specified tags from the specified Amazon Chime SDK meeting resource. * * * @param untagResourceRequest * @return Result of the UntagResource 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. For example, when a user tries to create an * account from an unsupported Region. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.UntagResource * @see AWS API * Documentation */ UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest); /** * * Updates account details for the specified Amazon Chime account. Currently, only account name updates are * supported for this action. * * * @param updateAccountRequest * @return Result of the UpdateAccount operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.UpdateAccount * @see AWS API * Documentation */ UpdateAccountResult updateAccount(UpdateAccountRequest updateAccountRequest); /** * * Updates the settings for the specified Amazon Chime account. You can update settings for remote control of shared * screens, or for the dial-out option. For more information about these settings, see Use the Policies Page in the Amazon Chime * Administration Guide. * * * @param updateAccountSettingsRequest * @return Result of the UpdateAccountSettings operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @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. For example, when a user tries to create an * account from an unsupported Region. * @throws ConflictException * The request could not be processed because of conflict in the current state of the resource. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.UpdateAccountSettings * @see AWS * API Documentation */ UpdateAccountSettingsResult updateAccountSettings(UpdateAccountSettingsRequest updateAccountSettingsRequest); /** * * Updates the status of the specified bot, such as starting or stopping the bot from running in your Amazon Chime * Enterprise account. * * * @param updateBotRequest * @return Result of the UpdateBot operation returned by the service. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ThrottledClientException * The client exceeded its request rate limit. * @sample AmazonChime.UpdateBot * @see AWS API * Documentation */ UpdateBotResult updateBot(UpdateBotRequest updateBotRequest); /** * * Updates global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon * Chime Voice Connector settings. * * * @param updateGlobalSettingsRequest * @return Result of the UpdateGlobalSettings operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.UpdateGlobalSettings * @see AWS API * Documentation */ UpdateGlobalSettingsResult updateGlobalSettings(UpdateGlobalSettingsRequest updateGlobalSettingsRequest); /** * * Updates phone number details, such as product type or calling name, for the specified phone number ID. You can * update one phone number detail at a time. For example, you can update either the product type or the calling name * in one action. * * * For toll-free numbers, you must use the Amazon Chime Voice Connector product type. * * * Updates to outbound calling names can take up to 72 hours to complete. Pending updates to outbound calling names * must be complete before you can request another update. * * * @param updatePhoneNumberRequest * @return Result of the UpdatePhoneNumber operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.UpdatePhoneNumber * @see AWS API * Documentation */ UpdatePhoneNumberResult updatePhoneNumber(UpdatePhoneNumberRequest updatePhoneNumberRequest); /** * * Updates the phone number settings for the administrator's AWS account, such as the default outbound calling name. * You can update the default outbound calling name once every seven days. Outbound calling names can take up to 72 * hours to update. * * * @param updatePhoneNumberSettingsRequest * @return Result of the UpdatePhoneNumberSettings operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.UpdatePhoneNumberSettings * @see AWS API Documentation */ UpdatePhoneNumberSettingsResult updatePhoneNumberSettings(UpdatePhoneNumberSettingsRequest updatePhoneNumberSettingsRequest); /** * * Updates the specified proxy session details, such as voice or SMS capabilities. * * * @param updateProxySessionRequest * @return Result of the UpdateProxySession operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.UpdateProxySession * @see AWS API * Documentation */ UpdateProxySessionResult updateProxySession(UpdateProxySessionRequest updateProxySessionRequest); /** * * Updates room details, such as the room name, for a room in an Amazon Chime Enterprise account. * * * @param updateRoomRequest * @return Result of the UpdateRoom 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. For example, when a user tries to create an * account from an unsupported Region. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.UpdateRoom * @see AWS API * Documentation */ UpdateRoomResult updateRoom(UpdateRoomRequest updateRoomRequest); /** * * Updates room membership details, such as the member role, for a room in an Amazon Chime Enterprise account. The * member role designates whether the member is a chat room administrator or a general chat room member. The member * role can be updated only for user IDs. * * * @param updateRoomMembershipRequest * @return Result of the UpdateRoomMembership operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @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. For example, when a user tries to create an * account from an unsupported Region. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.UpdateRoomMembership * @see AWS API * Documentation */ UpdateRoomMembershipResult updateRoomMembership(UpdateRoomMembershipRequest updateRoomMembershipRequest); /** * * Updates user details for a specified user ID. Currently, only LicenseType updates are supported for * this action. * * * @param updateUserRequest * @return Result of the UpdateUser operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.UpdateUser * @see AWS API * Documentation */ UpdateUserResult updateUser(UpdateUserRequest updateUserRequest); /** * * Updates the settings for the specified user, such as phone number settings. * * * @param updateUserSettingsRequest * @return Result of the UpdateUserSettings operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.UpdateUserSettings * @see AWS API * Documentation */ UpdateUserSettingsResult updateUserSettings(UpdateUserSettingsRequest updateUserSettingsRequest); /** * * Updates details for the specified Amazon Chime Voice Connector. * * * @param updateVoiceConnectorRequest * @return Result of the UpdateVoiceConnector operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.UpdateVoiceConnector * @see AWS API * Documentation */ UpdateVoiceConnectorResult updateVoiceConnector(UpdateVoiceConnectorRequest updateVoiceConnectorRequest); /** * * Updates details for the specified Amazon Chime Voice Connector group, such as the name and Amazon Chime Voice * Connector priority ranking. * * * @param updateVoiceConnectorGroupRequest * @return Result of the UpdateVoiceConnectorGroup operation returned by the service. * @throws UnauthorizedClientException * The client is not currently authorized to make the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws ForbiddenException * The client is permanently forbidden from making the request. For example, when a user tries to create an * account from an unsupported Region. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ConflictException * The request could not be processed because of conflict in the current state of the resource. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ServiceUnavailableException * The service is currently unavailable. * @throws ServiceFailureException * The service encountered an unexpected error. * @sample AmazonChime.UpdateVoiceConnectorGroup * @see AWS API Documentation */ UpdateVoiceConnectorGroupResult updateVoiceConnectorGroup(UpdateVoiceConnectorGroupRequest updateVoiceConnectorGroupRequest); /** * Shuts down this client object, releasing any resources that might be held open. This is an optional method, and * callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client * has been shutdown, it should not be used to make any more requests. */ void shutdown(); /** * 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 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); }