/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.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. *
*
*
* Most of these APIs are no longer supported and will not be updated. We recommend using the latest versions in
* the Amazon Chime SDK API
* reference, in the Amazon Chime SDK.
*
* Using the latest versions requires migrating to dedicated namespaces. For more information, refer to Migrating from the Amazon
* Chime namespace in the Amazon Chime SDK Developer Guide.
*
* The Amazon Chime application programming interface (API) is designed so administrators can 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. *
** You can use an AWS SDK, the AWS Command Line Interface (AWS CLI), or the REST API to make API calls for Amazon Chime. * We recommend using an AWS SDK or the AWS CLI. The page for each API action contains a See Also section that * includes links to information about using the action with a language-specific AWS SDK or the AWS CLI. *
** 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. *
** 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. *
** 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. * @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. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, AssociatePhoneNumbersWithVoiceConnector, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** Associates phone numbers with the specified Amazon Chime Voice Connector group. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, AssociatePhoneNumbersWithVoiceConnectorGroup, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** 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. * @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. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, * BatchCreateAttendee, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the * Amazon Chime SDK Developer Guide. *
* * @param batchCreateAttendeeRequest * @return Result of the BatchCreateAttendee operation returned by the service. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ForbiddenException * The client is permanently forbidden from making the request. * @throws NotFoundException * One or more of the resources in the request does not exist in the system. * @throws 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 */ @Deprecated BatchCreateAttendeeResult batchCreateAttendee(BatchCreateAttendeeRequest batchCreateAttendeeRequest); /** ** Adds a specified number of users to a channel. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, BatchCreateChannelMembership, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** Adds up to 50 members to a chat room in an Amazon Chime Enterprise account. Members can be 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. * @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. * @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. * @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 account types, 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.
*
* Updates phone number product types or calling names. You can update one attribute at a time for each
* UpdatePhoneNumberRequestItem
. For example, you can update the product type or the calling name.
*
* For toll-free numbers, you cannot use the Amazon Chime Business Calling product type. For numbers outside the * U.S., you must use the Amazon Chime SIP Media Application Dial-In 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. * @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.
*
* 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.
*
* Creates an Amazon Chime SDK messaging AppInstance
under an AWS account. Only SDK messaging customers
* use this API. CreateAppInstance
supports idempotency behavior as described in the AWS API Standard.
*
* This API is is no longer supported and will not be updated. We recommend using the latest version, * CreateAppInstance, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
*
* Promotes an AppInstanceUser
to an AppInstanceAdmin
. The promoted user can perform the
* following actions.
*
* This API is is no longer supported and will not be updated. We recommend using the latest version, * CreateAppInstanceAdmin, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
*
* ChannelModerator
actions across all channels in the AppInstance
.
*
* DeleteChannelMessage
actions.
*
* Only an AppInstanceUser
can be promoted to an AppInstanceAdmin
role.
*
* Creates a user under an Amazon Chime AppInstance
. The request consists of a unique
* appInstanceUserId
and Name
for that user.
*
* This API is is no longer supported and will not be updated. We recommend using the latest version, * CreateAppInstanceUser, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** 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 SDK Developer Guide. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, CreateAttendee * , in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** 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. * @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 channel to which you can add users and send messages. *
** Restriction: You can't change a channel's privacy. *
*
* The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
* user that makes the API call as the value in the header.
*
* This API is is no longer supported and will not be updated. We recommend using the latest version, CreateChannel * , in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
*
* Permanently bans a member from a channel. Moderators can't add banned members to a channel. To undo a ban, you
* first have to DeleteChannelBan
, and then CreateChannelMembership
. Bans are cleaned up
* when you delete users or channels.
*
* If you ban a user who is already part of a channel, that user is automatically kicked from the channel. *
*
* The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
* user that makes the API call as the value in the header.
*
* This API is is no longer supported and will not be updated. We recommend using the latest version, * CreateChannelBan, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
*
* Adds a user to a channel. The InvitedBy
response field is derived from the request header. A channel
* member can:
*
* List messages *
** Send messages *
** Receive messages *
** Edit their own messages *
** Leave the channel *
** Privacy settings impact this action as follows: *
** Public Channels: You do not need to be a member to list messages, but you must be a member to send messages. *
** Private Channels: You must be a member to list or send messages. *
*
* The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
* user that makes the API call as the value in the header.
*
* This API is is no longer supported and will not be updated. We recommend using the latest version, * CreateChannelMembership, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
*
* Creates a new ChannelModerator
. A channel moderator can:
*
* Add and remove other members of the channel. *
** Add and remove other moderators of the channel. *
** Add and remove user bans for the channel. *
** Redact messages in the channel. *
** List messages in the channel. *
*
* The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
* user that makes the API call as the value in the header.
*
* This API is is no longer supported and will not be updated. We recommend using the latest version, * CreateChannelModerator, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** Creates a media capture pipeline. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, CreateMediaCapturePipeline, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** 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 SDK Developer Guide . For more information about the Amazon Chime SDK, see * Using the Amazon Chime SDK in the * Amazon Chime SDK Developer Guide. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, CreateMeeting * , in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** Uses the join token and call metadata in a meeting request (From number, To number, and so forth) to initiate an * outbound call to a public switched telephone network (PSTN) and join them into a Chime meeting. Also ensures that * the From number belongs to the customer. *
*
* To play welcome audio or implement an interactive voice response (IVR), use the
* CreateSipMediaApplicationCall
action with the corresponding SIP media application ID.
*
* This API is is not available in a dedicated namespace. *
** 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 SDK Developer Guide . For more information about the Amazon Chime SDK, see * Using the Amazon Chime SDK in the * Amazon Chime SDK Developer Guide . *
** This API is is no longer supported and will not be updated. We recommend using the latest version, CreateMeetingWithAttendees, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** Creates an order for phone numbers to be provisioned. For toll-free numbers, you cannot use the Amazon Chime * Business Calling product type. For numbers outside the U.S., you must use the Amazon Chime SIP Media Application * Dial-In 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. * @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. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, * CreateProxySession, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** 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. * @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. * @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 SIP media application. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, * CreateSipMediaApplication, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
*
* Creates an outbound call to a phone number from the phone number specified in the request, and it invokes the
* endpoint of the specified sipMediaApplicationId
.
*
* This API is is no longer supported and will not be updated. We recommend using the latest version, CreateSipMediaApplicationCall, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** Creates a SIP rule which can be used to run a SIP media application as a target for a specific trigger type. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, CreateSipRule, * in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** 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. * @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. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, * CreateVoiceConnector, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
*
* 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. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, * CreateVoiceConnectorGroup, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
*
* Deletes the specified Amazon Chime account. You must suspend all users before deleting Team
account.
* You can use the BatchSuspendUser action to dodo.
*
* 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 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.
*
* Deletes an AppInstance
and all associated data asynchronously.
*
* This API is is no longer supported and will not be updated. We recommend using the latest version, * DeleteAppInstance, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
*
* Demotes an AppInstanceAdmin
to an AppInstanceUser
. This action does not delete the
* user.
*
* This API is is no longer supported and will not be updated. We recommend using the latest version, * DeleteAppInstanceAdmin, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
*
* Deletes the streaming configurations of an AppInstance
.
*
* This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteAppInstanceStreamingConfigurations, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
*
* Deletes an AppInstanceUser
.
*
* This API is is no longer supported and will not be updated. We recommend using the latest version, * DeleteAppInstanceUser, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
*
* 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 SDK Developer Guide.
*
* This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteAttendee * , in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** Immediately makes a channel and its memberships inaccessible and marks them for deletion. This is an irreversible * process. *
*
* The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
* user that makes the API call as the value in the header.
*
* This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteChannel * , in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** Removes a user from a channel's ban list. *
*
* The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
* user that makes the API call as the value in the header.
*
* This API is is no longer supported and will not be updated. We recommend using the latest version, * DeleteChannelBan, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** Removes a member from a channel. *
*
* The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
* user that makes the API call as the value in the header.
*
* This API is is no longer supported and will not be updated. We recommend using the latest version, * DeleteChannelMembership, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
*
* Deletes a channel message. Only admins can perform this action. Deletion makes messages inaccessible immediately.
* A background process deletes any revisions created by UpdateChannelMessage
.
*
* The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
* user that makes the API call as the value in the header.
*
* This API is is no longer supported and will not be updated. We recommend using the latest version, * DeleteChannelMessage, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** Deletes a channel moderator. *
*
* The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
* user that makes the API call as the value in the header.
*
* This API is is no longer supported and will not be updated. We recommend using the latest version, * DeleteChannelModerator, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** 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. * @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 media capture pipeline. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteMediaCapturePipeline, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** Deletes the specified Amazon Chime SDK meeting. The operation deletes all attendees, disconnects all clients, and * prevents new clients from joining the meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the * Amazon Chime SDK Developer Guide. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteMeeting * , in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** 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. * @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. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, * DeleteProxySession, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** 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. * @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. * @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 a SIP media application. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, * DeleteSipMediaApplication, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** Deletes a SIP rule. You must disable a SIP rule before you can delete it. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteSipRule, * in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** 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. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, * DeleteVoiceConnector, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** Deletes the emergency calling configuration details from the specified Amazon Chime Voice Connector. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteVoiceConnectorEmergencyCallingConfiguration, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
*
* 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.
*
* This API is is no longer supported and will not be updated. We recommend using the latest version, * DeleteVoiceConnectorGroup, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** 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. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteVoiceConnectorOrigination, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** Deletes the proxy configuration from the specified Amazon Chime Voice Connector. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, * DeleteVoiceProxy, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** Deletes the streaming configuration for the specified Amazon Chime Voice Connector. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteVoiceConnectorStreamingConfiguration, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** 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. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteVoiceConnectorTermination, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** Deletes the specified SIP credentials used by your equipment to authenticate during call termination. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, DeleteVoiceConnectorTerminationCredentials, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
*
* Returns the full details of an AppInstance
.
*
* This API is is no longer supported and will not be updated. We recommend using the latest version, * DescribeAppInstance, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
*
* Returns the full details of an AppInstanceAdmin
.
*
* This API is is no longer supported and will not be updated. We recommend using the latest version, * DescribeAppInstanceAdmin, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
*
* Returns the full details of an AppInstanceUser
.
*
* This API is is no longer supported and will not be updated. We recommend using the latest version, * DescribeAppInstanceUser, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
*
* Returns the full details of a channel in an Amazon Chime AppInstance
.
*
* The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
* user that makes the API call as the value in the header.
*
* This API is is no longer supported and will not be updated. We recommend using the latest version, * DescribeChannel, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** Returns the full details of a channel ban. *
*
* The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
* user that makes the API call as the value in the header.
*
* This API is is no longer supported and will not be updated. We recommend using the latest version, * DescribeChannelBan, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** Returns the full details of a user's channel membership. *
*
* The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
* user that makes the API call as the value in the header.
*
* This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeChannelMembership, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
*
* Returns the details of a channel based on the membership of the specified AppInstanceUser
.
*
* The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
* user that makes the API call as the value in the header.
*
* This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeChannelMembershipForAppInstanceUser, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
*
* Returns the full details of a channel moderated by the specified AppInstanceUser
.
*
* The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
* user that makes the API call as the value in the header.
*
* This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeChannelModeratedByAppInstanceUser, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** Returns the full details of a single ChannelModerator. *
*
* The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
* user that makes the API call as the value in the header.
*
* This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeChannelModerator, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** 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. * @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. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, DisassociatePhoneNumbersFromVoiceConnector, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector group. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, DisassociatePhoneNumbersFromVoiceConnectorGroup, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** 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. * @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. * @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 dialout * 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. * @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 retention settings for an AppInstance
.
*
* This API is is no longer supported and will not be updated. We recommend using the latest version, GetMessagingRetentionSettings, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
*
* Gets the streaming settings for an AppInstance
.
*
* This API is is no longer supported and will not be updated. We recommend using the latest version, GetMessagingStreamingConfigurations, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** 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 SDK Developer Guide. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, GetAttendee, * in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** 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. * @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 the full details of a channel message. *
*
* The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn
of the user that
* makes the API call as the value in the header.
*
* This API is is no longer supported and will not be updated. We recommend using the latest version, * GetChannelMessage, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** 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. * @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. * @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 an existing media capture pipeline. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, GetMediaCapturePipeline, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, GetMeeting, in * the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** 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 SDK 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. * @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 */ @Deprecated GetMeetingResult getMeeting(GetMeetingRequest getMeetingRequest); /** ** The details of the endpoint for the messaging session. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, GetMessagingSessionEndpoint, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** 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. * @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 the 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. * @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. * @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. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, GetProxySession * , in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** 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. * @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. * @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 the information for a SIP media application, including name, AWS Region, and endpoints. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, * GetSipMediaApplication, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** Returns the logging configuration for the specified SIP media application. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, GetSipMediaApplicationLoggingConfiguration, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** Retrieves the details of a SIP rule, such as the rule ID, name, triggers, and target endpoints. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, GetSipRule, * in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** 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. * @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. * @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. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, * GetVoiceConnector, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** Gets the emergency calling configuration details for the specified Amazon Chime Voice Connector. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnectorEmergencyCallingConfiguration, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
*
* Retrieves details for the specified Amazon Chime Voice Connector group, such as timestamps,name, and associated
* VoiceConnectorItems
.
*
* This API is is no longer supported and will not be updated. We recommend using the latest version, * GetVoiceConnectorGroup, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** 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. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnectorLoggingConfiguration, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** Retrieves origination setting details for the specified Amazon Chime Voice Connector. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnectorOrigination, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** Gets the proxy configuration details for the specified Amazon Chime Voice Connector. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, * GetVoiceConnectorProxy, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** 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. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnectorStreamingConfiguration, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** Retrieves termination setting details for the specified Amazon Chime Voice Connector. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnectorTermination, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnectorTerminationHealth, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
*
* Retrieves information about the last time a SIP OPTIONS
ping was received from your SIP
* infrastructure for the specified Amazon Chime Voice Connector.
*
* 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.
*
* 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. * @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); /** *
* Returns a list of the administrators in the AppInstance
.
*
* This API is is no longer supported and will not be updated. We recommend using the latest version, * ListAppInstanceAdmins, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
*
* List all AppInstanceUsers
created under a single AppInstance
.
*
* This API is is no longer supported and will not be updated. We recommend using the latest version, * ListAppInstanceUsers, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
*
* Lists all Amazon Chime AppInstance
s created under a single AWS account.
*
* This API is is no longer supported and will not be updated. We recommend using the latest version, * ListAppInstances, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** Lists the tags applied to an Amazon Chime SDK attendee resource. *
** ListAttendeeTags is not supported in the Amazon Chime SDK Meetings Namespace. Update your application to remove * calls to this API. *
** 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 SDK Developer Guide. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, ListAttendees * , in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** 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. * @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 all the users banned from a particular channel. *
*
* The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
* user that makes the API call as the value in the header.
*
* This API is is no longer supported and will not be updated. We recommend using the latest version, * ListChannelBans, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** Lists all channel memberships in a channel. *
*
* The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
* user that makes the API call as the value in the header.
*
* This API is is no longer supported and will not be updated. We recommend using the latest version, * ListChannelMemberships, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
*
* Lists all channels that a particular AppInstanceUser
is a part of. Only an
* AppInstanceAdmin
can call the API with a user ARN that is not their own.
*
* The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
* user that makes the API call as the value in the header.
*
* This API is is no longer supported and will not be updated. We recommend using the latest version, ListChannelMembershipsForAppInstanceUser, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
*
* List all the messages in a channel. Returns a paginated list of ChannelMessages
. By default, sorted
* by creation timestamp in descending order.
*
* Redacted messages appear in the results as empty, since they are only redacted, not deleted. Deleted messages do * not appear in the results. This action always returns the latest version of an edited message. *
*
* Also, the x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn
of the user
* that makes the API call as the value in the header.
*
* This API is is no longer supported and will not be updated. We recommend using the latest version, * ListChannelMessages, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** Lists all the moderators for a channel. *
*
* The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
* user that makes the API call as the value in the header.
*
* This API is is no longer supported and will not be updated. We recommend using the latest version, * ListChannelModerators, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** Lists all Channels created under a single Chime App as a paginated list. You can specify filters to narrow * results. *
** Functionality & restrictions *
*
* Use privacy = PUBLIC
to retrieve all public channels in the account.
*
* Only an AppInstanceAdmin
can set privacy = PRIVATE
to list the private channels in an
* account.
*
* The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
* user that makes the API call as the value in the header.
*
* This API is is no longer supported and will not be updated. We recommend using the latest version, ListChannels * , in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
*
* A list of the channels moderated by an AppInstanceUser
.
*
* The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
* user that makes the API call as the value in the header.
*
* This API is is no longer supported and will not be updated. We recommend using the latest version, ListChannelsModeratedByAppInstanceUser, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** Returns a list of media capture pipelines. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, ListMediaCapturePipelines, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** Lists the tags applied to an Amazon Chime SDK meeting resource. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, * ListTagsForResource, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** Lists up to 100 active Amazon Chime SDK meetings. *
** ListMeetings is not supported in the Amazon Chime SDK Meetings Namespace. Update your application to remove calls * to this API. *
** For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the * Amazon Chime SDK 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. * @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 */ @Deprecated 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. * @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. * @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. * @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. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, * ListProxySessions, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** 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. * @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. * @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 SIP media applications under the administrator's AWS account. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, * ListSipMediaApplications, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** Lists the SIP rules under the administrator's AWS account. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, ListSipRules, * in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** Lists supported phone number countries. *
* * @param listSupportedPhoneNumberCountriesRequest * @return Result of the ListSupportedPhoneNumberCountries operation returned by the service. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ForbiddenException * The client is permanently forbidden from making the request. * @throws 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.ListSupportedPhoneNumberCountries * @see AWS API Documentation */ ListSupportedPhoneNumberCountriesResult listSupportedPhoneNumberCountries(ListSupportedPhoneNumberCountriesRequest listSupportedPhoneNumberCountriesRequest); /** ** Lists the tags applied to an Amazon Chime SDK meeting and messaging resources. *
** This API is is no longer supported and will not be updated. We recommend using the applicable latest * version in the Amazon Chime SDK. *
** For meetings: ListTagsForResource. *
** For messaging: ListTagsForResource. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** 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. * @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. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, * ListVoiceConnectorGroups, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** Lists the SIP credentials for the specified Amazon Chime Voice Connector. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, ListVoiceConnectorTerminationCredentials, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** Lists the Amazon Chime Voice Connectors for the administrator's AWS account. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, * ListVoiceConnectors, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** 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. * @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); /** *
* Sets the amount of time in days that a given AppInstance
retains data.
*
* This API is is no longer supported and will not be updated. We recommend using the latest version, PutAppInstanceRetentionSettings, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
*
* The data streaming configurations of an AppInstance
.
*
* This API is is no longer supported and will not be updated. We recommend using the latest version, PutMessagingStreamingConfigurations, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** 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. * @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. * @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); /** ** Updates the logging configuration for the specified SIP media application. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, PutSipMediaApplicationLoggingConfiguration, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** 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. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, PutVoiceConnectorEmergencyCallingConfiguration, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** 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. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, PutVoiceConnectorLoggingConfiguration, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** 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. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, PutVoiceConnectorOrigination, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** Puts the specified proxy configuration to the specified Amazon Chime Voice Connector. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, * PutVoiceConnectorProxy, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** Adds a streaming configuration for the specified Amazon Chime Voice Connector. The streaming configuration * specifies whether media streaming is enabled for sending to Kinesis. It also sets the retention period, in hours, * for the Amazon Kinesis data. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, PutVoiceConnectorStreamingConfiguration, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** 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. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, PutVoiceConnectorTermination, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** Adds termination SIP credentials for the specified Amazon Chime Voice Connector. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, PutVoiceConnectorTerminationCredentials, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** Redacts message content, but not metadata. The message exists in the back end, but the action returns null * content, and the state shows as redacted. *
*
* The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
* user that makes the API call as the value in the header.
*
* This API is is no longer supported and will not be updated. We recommend using the latest version, * RedactChannelMessage, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** 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. * @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 channel. *
* * @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. * @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. * @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. * @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. * @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 for phone numbers that can be ordered. For US numbers, provide at least one of the following search
* filters: AreaCode
, City
, State
, or TollFreePrefix
. If you
* provide City
, you must also provide State
. Numbers outside the US only support the
* PhoneNumberType
filter, which you must use.
*
* Sends a message to a particular channel that the member is a part of. *
*
* The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
* user that makes the API call as the value in the header.
*
* Also, STANDARD
messages can contain 4KB of data and the 1KB of metadata. CONTROL
* messages can contain 30 bytes of data and no metadata.
*
* This API is is no longer supported and will not be updated. We recommend using the latest version, * SendChannelMessage, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
*
* Starts transcription for the specified meetingId
. For more information, refer to Using Amazon Chime SDK live
* transcription in the Amazon Chime SDK Developer Guide.
*
* If you specify an invalid configuration, a TranscriptFailed
event will be sent with the contents of
* the BadRequestException
generated by Amazon Transcribe. For more information on each parameter and
* which combinations are valid, refer to the StartStreamTranscription API in the Amazon Transcribe Developer Guide.
*
* Amazon Chime SDK live transcription is powered by Amazon Transcribe. Use of Amazon Transcribe is subject to the * AWS Service Terms, including the terms specific to the AWS * Machine Learning and Artificial Intelligence Services. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, * StartMeetingTranscription, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
*
* Stops transcription for the specified meetingId
.
*
* This API is is no longer supported and will not be updated. We recommend using the latest version, * StopMeetingTranscription, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** Applies the specified tags to the specified Amazon Chime attendee. *
** TagAttendee is not supported in the Amazon Chime SDK Meetings Namespace. Update your application to remove calls * to this API. *
** Applies the specified tags to the specified Amazon Chime SDK meeting. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, TagResource, * in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** Applies the specified tags to the specified Amazon Chime SDK meeting resource. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, TagResource, * in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** Untags the specified tags from the specified Amazon Chime SDK attendee. *
** UntagAttendee is not supported in the Amazon Chime SDK Meetings Namespace. Update your application to remove * calls to this API. *
** Untags the specified tags from the specified Amazon Chime SDK meeting. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, UntagResource * , in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** Untags the specified tags from the specified Amazon Chime SDK meeting resource. *
** Applies the specified tags to the specified Amazon Chime SDK meeting resource. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, UntagResource * , in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** Updates account details for the specified Amazon Chime account. Currently, only account name and default license * 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. * @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. * @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 AppInstance
metadata.
*
* This API is is no longer supported and will not be updated. We recommend using the latest version, * UpdateAppInstance, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
*
* Updates the details of an AppInstanceUser
. You can update names and metadata.
*
* This API is is no longer supported and will not be updated. We recommend using the latest version, * UpdateAppInstanceUser, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** 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. * @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); /** ** Update a channel's attributes. *
** Restriction: You can't change a channel's privacy. *
*
* The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
* user that makes the API call as the value in the header.
*
* This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateChannel * , in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** Updates the content of a message. *
*
* The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
* user that makes the API call as the value in the header.
*
* This API is is no longer supported and will not be updated. We recommend using the latest version, * UpdateChannelMessage, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** The details of the time when a user last read messages in a channel. *
*
* The x-amz-chime-bearer
request header is mandatory. Use the AppInstanceUserArn
of the
* user that makes the API call as the value in the header.
*
* This API is is no longer supported and will not be updated. We recommend using the latest version, * UpdateChannelReadMarker, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** 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. * @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 cannot use the Amazon Chime Business Calling product type. For numbers outside the * U.S., you must use the Amazon Chime SIP Media Application Dial-In product type. *
** Updates to outbound calling names can take 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. * @throws BadRequestException * The input parameters don't match the service's restrictions. * @throws ThrottledClientException * The client exceeded its request rate limit. * @throws ConflictException * The request could not be processed because of conflict in the current state of the resource. * @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. * @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. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, * UpdateProxySession, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** 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. * @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. * @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 the details of the specified SIP media application. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, * UpdateSipMediaApplication, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** Invokes the AWS Lambda function associated with the SIP media application and transaction ID in an update * request. The Lambda function can then return a new set of actions. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateSipMediaApplicationCall, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** Updates the details of the specified SIP rule. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateSipRule, * in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
*
* Updates user details for a specified user ID. Currently, only LicenseType
updates are supported for
* this action.
*
* 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. * @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. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, * UpdateVoiceConnector, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** Updates details of the specified Amazon Chime Voice Connector group, such as the name and Amazon Chime Voice * Connector priority ranking. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, * UpdateVoiceConnectorGroup, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** Validates an address to be used for 911 calls made with Amazon Chime Voice Connectors. You can use validated * addresses in a Presence Information Data Format Location Object file that you include in SIP requests. That helps * ensure that addresses are routed to the appropriate Public Safety Answering Point. *
** This API is is no longer supported and will not be updated. We recommend using the latest version, * ValidateE911Address, in the Amazon Chime SDK. *
** Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon * Chime namespace in the Amazon Chime SDK Developer Guide. *
** 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); }