@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonChime
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
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.
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
static final String ENDPOINT_PREFIX
AssociatePhoneNumberWithUserResult associatePhoneNumberWithUser(AssociatePhoneNumberWithUserRequest associatePhoneNumberWithUserRequest)
Associates a phone number with the specified Amazon Chime user.
associatePhoneNumberWithUserRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.AccessDeniedException - You don't have permissions to perform the requested operation.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated AssociatePhoneNumbersWithVoiceConnectorResult associatePhoneNumbersWithVoiceConnector(AssociatePhoneNumbersWithVoiceConnectorRequest associatePhoneNumbersWithVoiceConnectorRequest)
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.
associatePhoneNumbersWithVoiceConnectorRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.AccessDeniedException - You don't have permissions to perform the requested operation.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated AssociatePhoneNumbersWithVoiceConnectorGroupResult associatePhoneNumbersWithVoiceConnectorGroup(AssociatePhoneNumbersWithVoiceConnectorGroupRequest associatePhoneNumbersWithVoiceConnectorGroupRequest)
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.
associatePhoneNumbersWithVoiceConnectorGroupRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.AccessDeniedException - You don't have permissions to perform the requested operation.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.AssociateSigninDelegateGroupsWithAccountResult associateSigninDelegateGroupsWithAccount(AssociateSigninDelegateGroupsWithAccountRequest associateSigninDelegateGroupsWithAccountRequest)
Associates the specified sign-in delegate groups with the specified Amazon Chime account.
associateSigninDelegateGroupsWithAccountRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated BatchCreateAttendeeResult batchCreateAttendee(BatchCreateAttendeeRequest batchCreateAttendeeRequest)
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.
batchCreateAttendeeRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.ResourceLimitExceededException - The request exceeds the resource limit.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated BatchCreateChannelMembershipResult batchCreateChannelMembership(BatchCreateChannelMembershipRequest batchCreateChannelMembershipRequest)
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.
batchCreateChannelMembershipRequest - ServiceFailureException - The service encountered an unexpected error.ServiceUnavailableException - The service is currently unavailable.UnauthorizedClientException - The client is not currently authorized to make the request.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.BatchCreateRoomMembershipResult batchCreateRoomMembership(BatchCreateRoomMembershipRequest batchCreateRoomMembershipRequest)
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.
batchCreateRoomMembershipRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.BatchDeletePhoneNumberResult batchDeletePhoneNumber(BatchDeletePhoneNumberRequest batchDeletePhoneNumberRequest)
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.
batchDeletePhoneNumberRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.BatchSuspendUserResult batchSuspendUser(BatchSuspendUserRequest batchSuspendUserRequest)
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.
batchSuspendUserRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.BatchUnsuspendUserResult batchUnsuspendUser(BatchUnsuspendUserRequest batchUnsuspendUserRequest)
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.
batchUnsuspendUserRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.BatchUpdatePhoneNumberResult batchUpdatePhoneNumber(BatchUpdatePhoneNumberRequest batchUpdatePhoneNumberRequest)
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.
batchUpdatePhoneNumberRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.BatchUpdateUserResult batchUpdateUser(BatchUpdateUserRequest batchUpdateUserRequest)
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.
batchUpdateUserRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.CreateAccountResult createAccount(CreateAccountRequest createAccountRequest)
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.
createAccountRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated CreateAppInstanceResult createAppInstance(CreateAppInstanceRequest createAppInstanceRequest)
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.
createAppInstanceRequest - BadRequestException - The input parameters don't match the service's restrictions.ConflictException - The request could not be processed because of conflict in the current state of the resource.ForbiddenException - The client is permanently forbidden from making the request.ResourceLimitExceededException - The request exceeds the resource limit.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated CreateAppInstanceAdminResult createAppInstanceAdmin(CreateAppInstanceAdminRequest createAppInstanceAdminRequest)
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.
createAppInstanceAdminRequest - BadRequestException - The input parameters don't match the service's restrictions.ConflictException - The request could not be processed because of conflict in the current state of the resource.ForbiddenException - The client is permanently forbidden from making the request.ResourceLimitExceededException - The request exceeds the resource limit.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated CreateAppInstanceUserResult createAppInstanceUser(CreateAppInstanceUserRequest createAppInstanceUserRequest)
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.
createAppInstanceUserRequest - BadRequestException - The input parameters don't match the service's restrictions.ConflictException - The request could not be processed because of conflict in the current state of the resource.ForbiddenException - The client is permanently forbidden from making the request.ResourceLimitExceededException - The request exceeds the resource limit.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated CreateAttendeeResult createAttendee(CreateAttendeeRequest createAttendeeRequest)
Creates a new attendee for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime 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.
createAttendeeRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.ResourceLimitExceededException - The request exceeds the resource limit.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.CreateBotResult createBot(CreateBotRequest createBotRequest)
Creates a bot for an Amazon Chime Enterprise account.
createBotRequest - ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.UnauthorizedClientException - The client is not currently authorized to make the request.ResourceLimitExceededException - The request exceeds the resource limit.NotFoundException - One or more of the resources in the request does not exist in the system.ThrottledClientException - The client exceeded its request rate limit.@Deprecated CreateChannelResult createChannel(CreateChannelRequest createChannelRequest)
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.
createChannelRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ConflictException - The request could not be processed because of conflict in the current state of the resource.ResourceLimitExceededException - The request exceeds the resource limit.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated CreateChannelBanResult createChannelBan(CreateChannelBanRequest createChannelBanRequest)
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.
createChannelBanRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ConflictException - The request could not be processed because of conflict in the current state of the resource.ResourceLimitExceededException - The request exceeds the resource limit.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated CreateChannelMembershipResult createChannelMembership(CreateChannelMembershipRequest createChannelMembershipRequest)
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.
createChannelMembershipRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ConflictException - The request could not be processed because of conflict in the current state of the resource.ResourceLimitExceededException - The request exceeds the resource limit.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated CreateChannelModeratorResult createChannelModerator(CreateChannelModeratorRequest createChannelModeratorRequest)
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.
createChannelModeratorRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ConflictException - The request could not be processed because of conflict in the current state of the resource.ResourceLimitExceededException - The request exceeds the resource limit.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated CreateMediaCapturePipelineResult createMediaCapturePipeline(CreateMediaCapturePipelineRequest createMediaCapturePipelineRequest)
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.
createMediaCapturePipelineRequest - ResourceLimitExceededException - The request exceeds the resource limit.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated CreateMeetingResult createMeeting(CreateMeetingRequest createMeetingRequest)
Creates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees. For more information about specifying media Regions, see Amazon Chime SDK Media Regions in the Amazon Chime 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.
createMeetingRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ResourceLimitExceededException - The request exceeds the resource limit.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.CreateMeetingDialOutResult createMeetingDialOut(CreateMeetingDialOutRequest createMeetingDialOutRequest)
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.
createMeetingDialOutRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ResourceLimitExceededException - The request exceeds the resource limit.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.AccessDeniedException - You don't have permissions to perform the requested operation.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated CreateMeetingWithAttendeesResult createMeetingWithAttendees(CreateMeetingWithAttendeesRequest createMeetingWithAttendeesRequest)
Creates a new Amazon Chime SDK meeting in the specified media Region, with attendees. For more information about specifying media Regions, see Amazon Chime SDK Media Regions in the Amazon Chime 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.
createMeetingWithAttendeesRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ResourceLimitExceededException - The request exceeds the resource limit.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.CreatePhoneNumberOrderResult createPhoneNumberOrder(CreatePhoneNumberOrderRequest createPhoneNumberOrderRequest)
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.
createPhoneNumberOrderRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.AccessDeniedException - You don't have permissions to perform the requested operation.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ResourceLimitExceededException - The request exceeds the resource limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated CreateProxySessionResult createProxySession(CreateProxySessionRequest createProxySessionRequest)
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.
createProxySessionRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.CreateRoomResult createRoom(CreateRoomRequest createRoomRequest)
Creates a chat room for the specified Amazon Chime Enterprise account.
createRoomRequest - NotFoundException - One or more of the resources in the request does not exist in the system.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ResourceLimitExceededException - The request exceeds the resource limit.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.CreateRoomMembershipResult createRoomMembership(CreateRoomMembershipRequest createRoomMembershipRequest)
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.
createRoomMembershipRequest - ConflictException - The request could not be processed because of conflict in the current state of the resource.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ResourceLimitExceededException - The request exceeds the resource limit.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated CreateSipMediaApplicationResult createSipMediaApplication(CreateSipMediaApplicationRequest createSipMediaApplicationRequest)
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.
createSipMediaApplicationRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.AccessDeniedException - You don't have permissions to perform the requested operation.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ResourceLimitExceededException - The request exceeds the resource limit.ConflictException - The request could not be processed because of conflict in the current state of the resource.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated CreateSipMediaApplicationCallResult createSipMediaApplicationCall(CreateSipMediaApplicationCallRequest createSipMediaApplicationCallRequest)
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.
createSipMediaApplicationCallRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ResourceLimitExceededException - The request exceeds the resource limit.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.AccessDeniedException - You don't have permissions to perform the requested operation.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated CreateSipRuleResult createSipRule(CreateSipRuleRequest createSipRuleRequest)
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.
createSipRuleRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.AccessDeniedException - You don't have permissions to perform the requested operation.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ResourceLimitExceededException - The request exceeds the resource limit.ConflictException - The request could not be processed because of conflict in the current state of the resource.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.CreateUserResult createUser(CreateUserRequest createUserRequest)
Creates a user under the specified Amazon Chime account.
createUserRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ConflictException - The request could not be processed because of conflict in the current state of the resource.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated CreateVoiceConnectorResult createVoiceConnector(CreateVoiceConnectorRequest createVoiceConnectorRequest)
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.
createVoiceConnectorRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.AccessDeniedException - You don't have permissions to perform the requested operation.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ResourceLimitExceededException - The request exceeds the resource limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated CreateVoiceConnectorGroupResult createVoiceConnectorGroup(CreateVoiceConnectorGroupRequest createVoiceConnectorGroupRequest)
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.
createVoiceConnectorGroupRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.AccessDeniedException - You don't have permissions to perform the requested operation.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ResourceLimitExceededException - The request exceeds the resource limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.DeleteAccountResult deleteAccount(DeleteAccountRequest deleteAccountRequest)
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.
deleteAccountRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.UnprocessableEntityException - The request was well-formed but was unable to be followed due to semantic errors.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated DeleteAppInstanceResult deleteAppInstance(DeleteAppInstanceRequest deleteAppInstanceRequest)
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.
deleteAppInstanceRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated DeleteAppInstanceAdminResult deleteAppInstanceAdmin(DeleteAppInstanceAdminRequest deleteAppInstanceAdminRequest)
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.
deleteAppInstanceAdminRequest - BadRequestException - The input parameters don't match the service's restrictions.ConflictException - The request could not be processed because of conflict in the current state of the resource.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated DeleteAppInstanceStreamingConfigurationsResult deleteAppInstanceStreamingConfigurations(DeleteAppInstanceStreamingConfigurationsRequest deleteAppInstanceStreamingConfigurationsRequest)
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.
deleteAppInstanceStreamingConfigurationsRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated DeleteAppInstanceUserResult deleteAppInstanceUser(DeleteAppInstanceUserRequest deleteAppInstanceUserRequest)
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.
deleteAppInstanceUserRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated DeleteAttendeeResult deleteAttendee(DeleteAttendeeRequest deleteAttendeeRequest)
Deletes an attendee from the specified Amazon Chime SDK meeting and deletes their JoinToken.
Attendees are automatically deleted when a Amazon Chime SDK meeting is deleted. For more information about the
Amazon Chime SDK, see Using the
Amazon Chime SDK in the Amazon Chime 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.
deleteAttendeeRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.NotFoundException - One or more of the resources in the request does not exist in the system.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated DeleteChannelResult deleteChannel(DeleteChannelRequest deleteChannelRequest)
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.
deleteChannelRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated DeleteChannelBanResult deleteChannelBan(DeleteChannelBanRequest deleteChannelBanRequest)
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.
deleteChannelBanRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated DeleteChannelMembershipResult deleteChannelMembership(DeleteChannelMembershipRequest deleteChannelMembershipRequest)
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.
deleteChannelMembershipRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ConflictException - The request could not be processed because of conflict in the current state of the resource.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated DeleteChannelMessageResult deleteChannelMessage(DeleteChannelMessageRequest deleteChannelMessageRequest)
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.
deleteChannelMessageRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated DeleteChannelModeratorResult deleteChannelModerator(DeleteChannelModeratorRequest deleteChannelModeratorRequest)
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.
deleteChannelModeratorRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.DeleteEventsConfigurationResult deleteEventsConfiguration(DeleteEventsConfigurationRequest deleteEventsConfigurationRequest)
Deletes the events configuration that allows a bot to receive outgoing events.
deleteEventsConfigurationRequest - ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.UnauthorizedClientException - The client is not currently authorized to make the request.ResourceLimitExceededException - The request exceeds the resource limit.@Deprecated DeleteMediaCapturePipelineResult deleteMediaCapturePipeline(DeleteMediaCapturePipelineRequest deleteMediaCapturePipelineRequest)
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.
deleteMediaCapturePipelineRequest - ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated DeleteMeetingResult deleteMeeting(DeleteMeetingRequest deleteMeetingRequest)
Deletes the specified Amazon Chime SDK meeting. The operation deletes all attendees, disconnects all clients, and prevents new clients from joining the meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime 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.
deleteMeetingRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.NotFoundException - One or more of the resources in the request does not exist in the system.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.DeletePhoneNumberResult deletePhoneNumber(DeletePhoneNumberRequest deletePhoneNumberRequest)
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.
deletePhoneNumberRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated DeleteProxySessionResult deleteProxySession(DeleteProxySessionRequest deleteProxySessionRequest)
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.
deleteProxySessionRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.DeleteRoomResult deleteRoom(DeleteRoomRequest deleteRoomRequest)
Deletes a chat room in an Amazon Chime Enterprise account.
deleteRoomRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.DeleteRoomMembershipResult deleteRoomMembership(DeleteRoomMembershipRequest deleteRoomMembershipRequest)
Removes a member from a chat room in an Amazon Chime Enterprise account.
deleteRoomMembershipRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated DeleteSipMediaApplicationResult deleteSipMediaApplication(DeleteSipMediaApplicationRequest deleteSipMediaApplicationRequest)
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.
deleteSipMediaApplicationRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ConflictException - The request could not be processed because of conflict in the current state of the resource.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated DeleteSipRuleResult deleteSipRule(DeleteSipRuleRequest deleteSipRuleRequest)
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.
deleteSipRuleRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ConflictException - The request could not be processed because of conflict in the current state of the resource.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated DeleteVoiceConnectorResult deleteVoiceConnector(DeleteVoiceConnectorRequest deleteVoiceConnectorRequest)
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.
deleteVoiceConnectorRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ConflictException - The request could not be processed because of conflict in the current state of the resource.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated DeleteVoiceConnectorEmergencyCallingConfigurationResult deleteVoiceConnectorEmergencyCallingConfiguration(DeleteVoiceConnectorEmergencyCallingConfigurationRequest deleteVoiceConnectorEmergencyCallingConfigurationRequest)
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.
deleteVoiceConnectorEmergencyCallingConfigurationRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated DeleteVoiceConnectorGroupResult deleteVoiceConnectorGroup(DeleteVoiceConnectorGroupRequest deleteVoiceConnectorGroupRequest)
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.
deleteVoiceConnectorGroupRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ConflictException - The request could not be processed because of conflict in the current state of the resource.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated DeleteVoiceConnectorOriginationResult deleteVoiceConnectorOrigination(DeleteVoiceConnectorOriginationRequest deleteVoiceConnectorOriginationRequest)
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.
deleteVoiceConnectorOriginationRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated DeleteVoiceConnectorProxyResult deleteVoiceConnectorProxy(DeleteVoiceConnectorProxyRequest deleteVoiceConnectorProxyRequest)
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.
deleteVoiceConnectorProxyRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated DeleteVoiceConnectorStreamingConfigurationResult deleteVoiceConnectorStreamingConfiguration(DeleteVoiceConnectorStreamingConfigurationRequest deleteVoiceConnectorStreamingConfigurationRequest)
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.
deleteVoiceConnectorStreamingConfigurationRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated DeleteVoiceConnectorTerminationResult deleteVoiceConnectorTermination(DeleteVoiceConnectorTerminationRequest deleteVoiceConnectorTerminationRequest)
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.
deleteVoiceConnectorTerminationRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated DeleteVoiceConnectorTerminationCredentialsResult deleteVoiceConnectorTerminationCredentials(DeleteVoiceConnectorTerminationCredentialsRequest deleteVoiceConnectorTerminationCredentialsRequest)
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.
deleteVoiceConnectorTerminationCredentialsRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated DescribeAppInstanceResult describeAppInstance(DescribeAppInstanceRequest describeAppInstanceRequest)
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.
describeAppInstanceRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated DescribeAppInstanceAdminResult describeAppInstanceAdmin(DescribeAppInstanceAdminRequest describeAppInstanceAdminRequest)
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.
describeAppInstanceAdminRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated DescribeAppInstanceUserResult describeAppInstanceUser(DescribeAppInstanceUserRequest describeAppInstanceUserRequest)
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.
describeAppInstanceUserRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated DescribeChannelResult describeChannel(DescribeChannelRequest describeChannelRequest)
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.
describeChannelRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated DescribeChannelBanResult describeChannelBan(DescribeChannelBanRequest describeChannelBanRequest)
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.
describeChannelBanRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated DescribeChannelMembershipResult describeChannelMembership(DescribeChannelMembershipRequest describeChannelMembershipRequest)
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.
describeChannelMembershipRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated DescribeChannelMembershipForAppInstanceUserResult describeChannelMembershipForAppInstanceUser(DescribeChannelMembershipForAppInstanceUserRequest describeChannelMembershipForAppInstanceUserRequest)
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.
describeChannelMembershipForAppInstanceUserRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated DescribeChannelModeratedByAppInstanceUserResult describeChannelModeratedByAppInstanceUser(DescribeChannelModeratedByAppInstanceUserRequest describeChannelModeratedByAppInstanceUserRequest)
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.
describeChannelModeratedByAppInstanceUserRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated DescribeChannelModeratorResult describeChannelModerator(DescribeChannelModeratorRequest describeChannelModeratorRequest)
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.
describeChannelModeratorRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.DisassociatePhoneNumberFromUserResult disassociatePhoneNumberFromUser(DisassociatePhoneNumberFromUserRequest disassociatePhoneNumberFromUserRequest)
Disassociates the primary provisioned phone number from the specified Amazon Chime user.
disassociatePhoneNumberFromUserRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated DisassociatePhoneNumbersFromVoiceConnectorResult disassociatePhoneNumbersFromVoiceConnector(DisassociatePhoneNumbersFromVoiceConnectorRequest disassociatePhoneNumbersFromVoiceConnectorRequest)
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.
disassociatePhoneNumbersFromVoiceConnectorRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated DisassociatePhoneNumbersFromVoiceConnectorGroupResult disassociatePhoneNumbersFromVoiceConnectorGroup(DisassociatePhoneNumbersFromVoiceConnectorGroupRequest disassociatePhoneNumbersFromVoiceConnectorGroupRequest)
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.
disassociatePhoneNumbersFromVoiceConnectorGroupRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.DisassociateSigninDelegateGroupsFromAccountResult disassociateSigninDelegateGroupsFromAccount(DisassociateSigninDelegateGroupsFromAccountRequest disassociateSigninDelegateGroupsFromAccountRequest)
Disassociates the specified sign-in delegate groups from the specified Amazon Chime account.
disassociateSigninDelegateGroupsFromAccountRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.GetAccountResult getAccount(GetAccountRequest getAccountRequest)
Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.
getAccountRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.GetAccountSettingsResult getAccountSettings(GetAccountSettingsRequest getAccountSettingsRequest)
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.
getAccountSettingsRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated GetAppInstanceRetentionSettingsResult getAppInstanceRetentionSettings(GetAppInstanceRetentionSettingsRequest getAppInstanceRetentionSettingsRequest)
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.
getAppInstanceRetentionSettingsRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated GetAppInstanceStreamingConfigurationsResult getAppInstanceStreamingConfigurations(GetAppInstanceStreamingConfigurationsRequest getAppInstanceStreamingConfigurationsRequest)
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.
getAppInstanceStreamingConfigurationsRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated GetAttendeeResult getAttendee(GetAttendeeRequest getAttendeeRequest)
Gets the Amazon Chime SDK attendee details for a specified meeting ID and attendee ID. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime 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.
getAttendeeRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.GetBotResult getBot(GetBotRequest getBotRequest)
Retrieves details for the specified bot, such as bot email address, bot type, status, and display name.
getBotRequest - ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.@Deprecated GetChannelMessageResult getChannelMessage(GetChannelMessageRequest getChannelMessageRequest)
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.
getChannelMessageRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.GetEventsConfigurationResult getEventsConfiguration(GetEventsConfigurationRequest getEventsConfigurationRequest)
Gets details for an events configuration that allows a bot to receive outgoing events, such as an HTTPS endpoint or Lambda function ARN.
getEventsConfigurationRequest - ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.UnauthorizedClientException - The client is not currently authorized to make the request.ResourceLimitExceededException - The request exceeds the resource limit.NotFoundException - One or more of the resources in the request does not exist in the system.GetGlobalSettingsResult getGlobalSettings(GetGlobalSettingsRequest getGlobalSettingsRequest)
Retrieves global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.
getGlobalSettingsRequest - UnauthorizedClientException - The client is not currently authorized to make the request.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated GetMediaCapturePipelineResult getMediaCapturePipeline(GetMediaCapturePipelineRequest getMediaCapturePipelineRequest)
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.
getMediaCapturePipelineRequest - NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated GetMeetingResult getMeeting(GetMeetingRequest getMeetingRequest)
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 .
getMeetingRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated GetMessagingSessionEndpointResult getMessagingSessionEndpoint(GetMessagingSessionEndpointRequest getMessagingSessionEndpointRequest)
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.
getMessagingSessionEndpointRequest - UnauthorizedClientException - The client is not currently authorized to make the request.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.GetPhoneNumberResult getPhoneNumber(GetPhoneNumberRequest getPhoneNumberRequest)
Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.
getPhoneNumberRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.GetPhoneNumberOrderResult getPhoneNumberOrder(GetPhoneNumberOrderRequest getPhoneNumberOrderRequest)
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.
getPhoneNumberOrderRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.GetPhoneNumberSettingsResult getPhoneNumberSettings(GetPhoneNumberSettingsRequest getPhoneNumberSettingsRequest)
Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.
getPhoneNumberSettingsRequest - UnauthorizedClientException - The client is not currently authorized to make the request.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated GetProxySessionResult getProxySession(GetProxySessionRequest getProxySessionRequest)
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.
getProxySessionRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.GetRetentionSettingsResult getRetentionSettings(GetRetentionSettingsRequest getRetentionSettingsRequest)
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.
getRetentionSettingsRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.GetRoomResult getRoom(GetRoomRequest getRoomRequest)
Retrieves room details, such as the room name, for a room in an Amazon Chime Enterprise account.
getRoomRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated GetSipMediaApplicationResult getSipMediaApplication(GetSipMediaApplicationRequest getSipMediaApplicationRequest)
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.
getSipMediaApplicationRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated GetSipMediaApplicationLoggingConfigurationResult getSipMediaApplicationLoggingConfiguration(GetSipMediaApplicationLoggingConfigurationRequest getSipMediaApplicationLoggingConfigurationRequest)
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.
getSipMediaApplicationLoggingConfigurationRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated GetSipRuleResult getSipRule(GetSipRuleRequest getSipRuleRequest)
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.
getSipRuleRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.GetUserResult getUser(GetUserRequest getUserRequest)
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.
getUserRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.GetUserSettingsResult getUserSettings(GetUserSettingsRequest getUserSettingsRequest)
Retrieves settings for the specified user ID, such as any associated phone number settings.
getUserSettingsRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated GetVoiceConnectorResult getVoiceConnector(GetVoiceConnectorRequest getVoiceConnectorRequest)
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.
getVoiceConnectorRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated GetVoiceConnectorEmergencyCallingConfigurationResult getVoiceConnectorEmergencyCallingConfiguration(GetVoiceConnectorEmergencyCallingConfigurationRequest getVoiceConnectorEmergencyCallingConfigurationRequest)
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.
getVoiceConnectorEmergencyCallingConfigurationRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated GetVoiceConnectorGroupResult getVoiceConnectorGroup(GetVoiceConnectorGroupRequest getVoiceConnectorGroupRequest)
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.
getVoiceConnectorGroupRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated GetVoiceConnectorLoggingConfigurationResult getVoiceConnectorLoggingConfiguration(GetVoiceConnectorLoggingConfigurationRequest getVoiceConnectorLoggingConfigurationRequest)
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.
getVoiceConnectorLoggingConfigurationRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated GetVoiceConnectorOriginationResult getVoiceConnectorOrigination(GetVoiceConnectorOriginationRequest getVoiceConnectorOriginationRequest)
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.
getVoiceConnectorOriginationRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated GetVoiceConnectorProxyResult getVoiceConnectorProxy(GetVoiceConnectorProxyRequest getVoiceConnectorProxyRequest)
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.
getVoiceConnectorProxyRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated GetVoiceConnectorStreamingConfigurationResult getVoiceConnectorStreamingConfiguration(GetVoiceConnectorStreamingConfigurationRequest getVoiceConnectorStreamingConfigurationRequest)
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.
getVoiceConnectorStreamingConfigurationRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated GetVoiceConnectorTerminationResult getVoiceConnectorTermination(GetVoiceConnectorTerminationRequest getVoiceConnectorTerminationRequest)
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.
getVoiceConnectorTerminationRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated GetVoiceConnectorTerminationHealthResult getVoiceConnectorTerminationHealth(GetVoiceConnectorTerminationHealthRequest getVoiceConnectorTerminationHealthRequest)
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.
getVoiceConnectorTerminationHealthRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.InviteUsersResult inviteUsers(InviteUsersRequest inviteUsersRequest)
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.
inviteUsersRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.ListAccountsResult listAccounts(ListAccountsRequest listAccountsRequest)
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.
listAccountsRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated ListAppInstanceAdminsResult listAppInstanceAdmins(ListAppInstanceAdminsRequest listAppInstanceAdminsRequest)
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.
listAppInstanceAdminsRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated ListAppInstanceUsersResult listAppInstanceUsers(ListAppInstanceUsersRequest listAppInstanceUsersRequest)
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.
listAppInstanceUsersRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated ListAppInstancesResult listAppInstances(ListAppInstancesRequest listAppInstancesRequest)
Lists all Amazon Chime AppInstances 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.
listAppInstancesRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated ListAttendeeTagsResult listAttendeeTags(ListAttendeeTagsRequest listAttendeeTagsRequest)
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.
listAttendeeTagsRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated ListAttendeesResult listAttendees(ListAttendeesRequest listAttendeesRequest)
Lists the attendees for the specified Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime 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.
listAttendeesRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.ListBotsResult listBots(ListBotsRequest listBotsRequest)
Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.
listBotsRequest - ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.BadRequestException - The input parameters don't match the service's restrictions.NotFoundException - One or more of the resources in the request does not exist in the system.ThrottledClientException - The client exceeded its request rate limit.@Deprecated ListChannelBansResult listChannelBans(ListChannelBansRequest listChannelBansRequest)
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.
listChannelBansRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated ListChannelMembershipsResult listChannelMemberships(ListChannelMembershipsRequest listChannelMembershipsRequest)
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.
listChannelMembershipsRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated ListChannelMembershipsForAppInstanceUserResult listChannelMembershipsForAppInstanceUser(ListChannelMembershipsForAppInstanceUserRequest listChannelMembershipsForAppInstanceUserRequest)
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.
listChannelMembershipsForAppInstanceUserRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated ListChannelMessagesResult listChannelMessages(ListChannelMessagesRequest listChannelMessagesRequest)
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.
listChannelMessagesRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated ListChannelModeratorsResult listChannelModerators(ListChannelModeratorsRequest listChannelModeratorsRequest)
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.
listChannelModeratorsRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated ListChannelsResult listChannels(ListChannelsRequest listChannelsRequest)
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.
listChannelsRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated ListChannelsModeratedByAppInstanceUserResult listChannelsModeratedByAppInstanceUser(ListChannelsModeratedByAppInstanceUserRequest listChannelsModeratedByAppInstanceUserRequest)
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.
listChannelsModeratedByAppInstanceUserRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated ListMediaCapturePipelinesResult listMediaCapturePipelines(ListMediaCapturePipelinesRequest listMediaCapturePipelinesRequest)
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.
listMediaCapturePipelinesRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated ListMeetingTagsResult listMeetingTags(ListMeetingTagsRequest listMeetingTagsRequest)
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.
listMeetingTagsRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated ListMeetingsResult listMeetings(ListMeetingsRequest listMeetingsRequest)
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.
listMeetingsRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.ListPhoneNumberOrdersResult listPhoneNumberOrders(ListPhoneNumberOrdersRequest listPhoneNumberOrdersRequest)
Lists the phone number orders for the administrator's Amazon Chime account.
listPhoneNumberOrdersRequest - UnauthorizedClientException - The client is not currently authorized to make the request.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.ListPhoneNumbersResult listPhoneNumbers(ListPhoneNumbersRequest listPhoneNumbersRequest)
Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, Amazon Chime Voice Connector, or Amazon Chime Voice Connector group.
listPhoneNumbersRequest - UnauthorizedClientException - The client is not currently authorized to make the request.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.NotFoundException - One or more of the resources in the request does not exist in the system.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated ListProxySessionsResult listProxySessions(ListProxySessionsRequest listProxySessionsRequest)
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.
listProxySessionsRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.ListRoomMembershipsResult listRoomMemberships(ListRoomMembershipsRequest listRoomMembershipsRequest)
Lists the membership details for the specified room in an Amazon Chime Enterprise account, such as the members' IDs, email addresses, and names.
listRoomMembershipsRequest - NotFoundException - One or more of the resources in the request does not exist in the system.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.ListRoomsResult listRooms(ListRoomsRequest listRoomsRequest)
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.
listRoomsRequest - NotFoundException - One or more of the resources in the request does not exist in the system.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated ListSipMediaApplicationsResult listSipMediaApplications(ListSipMediaApplicationsRequest listSipMediaApplicationsRequest)
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.
listSipMediaApplicationsRequest - UnauthorizedClientException - The client is not currently authorized to make the request.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated ListSipRulesResult listSipRules(ListSipRulesRequest listSipRulesRequest)
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.
listSipRulesRequest - UnauthorizedClientException - The client is not currently authorized to make the request.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.ListSupportedPhoneNumberCountriesResult listSupportedPhoneNumberCountries(ListSupportedPhoneNumberCountriesRequest listSupportedPhoneNumberCountriesRequest)
Lists supported phone number countries.
listSupportedPhoneNumberCountriesRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.AccessDeniedException - You don't have permissions to perform the requested operation.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
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.
listTagsForResourceRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.ListUsersResult listUsers(ListUsersRequest listUsersRequest)
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.
listUsersRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated ListVoiceConnectorGroupsResult listVoiceConnectorGroups(ListVoiceConnectorGroupsRequest listVoiceConnectorGroupsRequest)
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.
listVoiceConnectorGroupsRequest - UnauthorizedClientException - The client is not currently authorized to make the request.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated ListVoiceConnectorTerminationCredentialsResult listVoiceConnectorTerminationCredentials(ListVoiceConnectorTerminationCredentialsRequest listVoiceConnectorTerminationCredentialsRequest)
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.
listVoiceConnectorTerminationCredentialsRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated ListVoiceConnectorsResult listVoiceConnectors(ListVoiceConnectorsRequest listVoiceConnectorsRequest)
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.
listVoiceConnectorsRequest - UnauthorizedClientException - The client is not currently authorized to make the request.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.LogoutUserResult logoutUser(LogoutUserRequest logoutUserRequest)
Logs out the specified user from all of the devices they are currently logged into.
logoutUserRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated PutAppInstanceRetentionSettingsResult putAppInstanceRetentionSettings(PutAppInstanceRetentionSettingsRequest putAppInstanceRetentionSettingsRequest)
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.
putAppInstanceRetentionSettingsRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ConflictException - The request could not be processed because of conflict in the current state of the resource.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated PutAppInstanceStreamingConfigurationsResult putAppInstanceStreamingConfigurations(PutAppInstanceStreamingConfigurationsRequest putAppInstanceStreamingConfigurationsRequest)
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.
putAppInstanceStreamingConfigurationsRequest - NotFoundException - One or more of the resources in the request does not exist in the system.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.PutEventsConfigurationResult putEventsConfiguration(PutEventsConfigurationRequest putEventsConfigurationRequest)
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.
putEventsConfigurationRequest - ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.UnauthorizedClientException - The client is not currently authorized to make the request.ResourceLimitExceededException - The request exceeds the resource limit.NotFoundException - One or more of the resources in the request does not exist in the system.PutRetentionSettingsResult putRetentionSettings(PutRetentionSettingsRequest putRetentionSettingsRequest)
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.
putRetentionSettingsRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ConflictException - The request could not be processed because of conflict in the current state of the resource.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated PutSipMediaApplicationLoggingConfigurationResult putSipMediaApplicationLoggingConfiguration(PutSipMediaApplicationLoggingConfigurationRequest putSipMediaApplicationLoggingConfigurationRequest)
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.
putSipMediaApplicationLoggingConfigurationRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated PutVoiceConnectorEmergencyCallingConfigurationResult putVoiceConnectorEmergencyCallingConfiguration(PutVoiceConnectorEmergencyCallingConfigurationRequest putVoiceConnectorEmergencyCallingConfigurationRequest)
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.
putVoiceConnectorEmergencyCallingConfigurationRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated PutVoiceConnectorLoggingConfigurationResult putVoiceConnectorLoggingConfiguration(PutVoiceConnectorLoggingConfigurationRequest putVoiceConnectorLoggingConfigurationRequest)
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.
putVoiceConnectorLoggingConfigurationRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated PutVoiceConnectorOriginationResult putVoiceConnectorOrigination(PutVoiceConnectorOriginationRequest putVoiceConnectorOriginationRequest)
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.
putVoiceConnectorOriginationRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated PutVoiceConnectorProxyResult putVoiceConnectorProxy(PutVoiceConnectorProxyRequest putVoiceConnectorProxyRequest)
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.
putVoiceConnectorProxyRequest - UnauthorizedClientException - The client is not currently authorized to make the request.AccessDeniedException - You don't have permissions to perform the requested operation.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated PutVoiceConnectorStreamingConfigurationResult putVoiceConnectorStreamingConfiguration(PutVoiceConnectorStreamingConfigurationRequest putVoiceConnectorStreamingConfigurationRequest)
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.
putVoiceConnectorStreamingConfigurationRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated PutVoiceConnectorTerminationResult putVoiceConnectorTermination(PutVoiceConnectorTerminationRequest putVoiceConnectorTerminationRequest)
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.
putVoiceConnectorTerminationRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.AccessDeniedException - You don't have permissions to perform the requested operation.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated PutVoiceConnectorTerminationCredentialsResult putVoiceConnectorTerminationCredentials(PutVoiceConnectorTerminationCredentialsRequest putVoiceConnectorTerminationCredentialsRequest)
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.
putVoiceConnectorTerminationCredentialsRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated RedactChannelMessageResult redactChannelMessage(RedactChannelMessageRequest redactChannelMessageRequest)
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.
redactChannelMessageRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.RedactConversationMessageResult redactConversationMessage(RedactConversationMessageRequest redactConversationMessageRequest)
Redacts the specified message from the specified Amazon Chime conversation.
redactConversationMessageRequest - NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.BadRequestException - The input parameters don't match the service's restrictions.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.RedactRoomMessageResult redactRoomMessage(RedactRoomMessageRequest redactRoomMessageRequest)
Redacts the specified message from the specified Amazon Chime channel.
redactRoomMessageRequest - NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.BadRequestException - The input parameters don't match the service's restrictions.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.RegenerateSecurityTokenResult regenerateSecurityToken(RegenerateSecurityTokenRequest regenerateSecurityTokenRequest)
Regenerates the security token for a bot.
regenerateSecurityTokenRequest - ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ThrottledClientException - The client exceeded its request rate limit.ResetPersonalPINResult resetPersonalPIN(ResetPersonalPINRequest resetPersonalPINRequest)
Resets the personal meeting PIN for the specified user on an Amazon Chime account. Returns the User object with the updated personal meeting PIN.
resetPersonalPINRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.RestorePhoneNumberResult restorePhoneNumber(RestorePhoneNumberRequest restorePhoneNumberRequest)
Moves a phone number from the Deletion queue back into the phone number Inventory.
restorePhoneNumberRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ResourceLimitExceededException - The request exceeds the resource limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.SearchAvailablePhoneNumbersResult searchAvailablePhoneNumbers(SearchAvailablePhoneNumbersRequest searchAvailablePhoneNumbersRequest)
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.
searchAvailablePhoneNumbersRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.AccessDeniedException - You don't have permissions to perform the requested operation.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated SendChannelMessageResult sendChannelMessage(SendChannelMessageRequest sendChannelMessageRequest)
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.
sendChannelMessageRequest - BadRequestException - The input parameters don't match the service's restrictions.ConflictException - The request could not be processed because of conflict in the current state of the resource.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated StartMeetingTranscriptionResult startMeetingTranscription(StartMeetingTranscriptionRequest startMeetingTranscriptionRequest)
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.
startMeetingTranscriptionRequest - NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ResourceLimitExceededException - The request exceeds the resource limit.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.UnprocessableEntityException - The request was well-formed but was unable to be followed due to semantic errors.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated StopMeetingTranscriptionResult stopMeetingTranscription(StopMeetingTranscriptionRequest stopMeetingTranscriptionRequest)
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.
stopMeetingTranscriptionRequest - ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.UnprocessableEntityException - The request was well-formed but was unable to be followed due to semantic errors.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated TagAttendeeResult tagAttendee(TagAttendeeRequest tagAttendeeRequest)
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.
tagAttendeeRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.ResourceLimitExceededException - The request exceeds the resource limit.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated TagMeetingResult tagMeeting(TagMeetingRequest tagMeetingRequest)
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.
tagMeetingRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.ResourceLimitExceededException - The request exceeds the resource limit.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
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.
tagResourceRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated UntagAttendeeResult untagAttendee(UntagAttendeeRequest untagAttendeeRequest)
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.
untagAttendeeRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.NotFoundException - One or more of the resources in the request does not exist in the system.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated UntagMeetingResult untagMeeting(UntagMeetingRequest untagMeetingRequest)
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.
untagMeetingRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.NotFoundException - One or more of the resources in the request does not exist in the system.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
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.
untagResourceRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.UpdateAccountResult updateAccount(UpdateAccountRequest updateAccountRequest)
Updates account details for the specified Amazon Chime account. Currently, only account name and default license updates are supported for this action.
updateAccountRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.UpdateAccountSettingsResult updateAccountSettings(UpdateAccountSettingsRequest updateAccountSettingsRequest)
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.
updateAccountSettingsRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ConflictException - The request could not be processed because of conflict in the current state of the resource.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated UpdateAppInstanceResult updateAppInstance(UpdateAppInstanceRequest updateAppInstanceRequest)
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.
updateAppInstanceRequest - BadRequestException - The input parameters don't match the service's restrictions.ConflictException - The request could not be processed because of conflict in the current state of the resource.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated UpdateAppInstanceUserResult updateAppInstanceUser(UpdateAppInstanceUserRequest updateAppInstanceUserRequest)
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.
updateAppInstanceUserRequest - BadRequestException - The input parameters don't match the service's restrictions.ConflictException - The request could not be processed because of conflict in the current state of the resource.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.UpdateBotResult updateBot(UpdateBotRequest updateBotRequest)
Updates the status of the specified bot, such as starting or stopping the bot from running in your Amazon Chime Enterprise account.
updateBotRequest - ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ThrottledClientException - The client exceeded its request rate limit.@Deprecated UpdateChannelResult updateChannel(UpdateChannelRequest updateChannelRequest)
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.
updateChannelRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ConflictException - The request could not be processed because of conflict in the current state of the resource.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated UpdateChannelMessageResult updateChannelMessage(UpdateChannelMessageRequest updateChannelMessageRequest)
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.
updateChannelMessageRequest - BadRequestException - The input parameters don't match the service's restrictions.ConflictException - The request could not be processed because of conflict in the current state of the resource.ForbiddenException - The client is permanently forbidden from making the request.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated UpdateChannelReadMarkerResult updateChannelReadMarker(UpdateChannelReadMarkerRequest updateChannelReadMarkerRequest)
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.
updateChannelReadMarkerRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ConflictException - The request could not be processed because of conflict in the current state of the resource.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.UpdateGlobalSettingsResult updateGlobalSettings(UpdateGlobalSettingsRequest updateGlobalSettingsRequest)
Updates global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.
updateGlobalSettingsRequest - UnauthorizedClientException - The client is not currently authorized to make the request.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.UpdatePhoneNumberResult updatePhoneNumber(UpdatePhoneNumberRequest updatePhoneNumberRequest)
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.
updatePhoneNumberRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ConflictException - The request could not be processed because of conflict in the current state of the resource.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.UpdatePhoneNumberSettingsResult updatePhoneNumberSettings(UpdatePhoneNumberSettingsRequest updatePhoneNumberSettingsRequest)
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.
updatePhoneNumberSettingsRequest - UnauthorizedClientException - The client is not currently authorized to make the request.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated UpdateProxySessionResult updateProxySession(UpdateProxySessionRequest updateProxySessionRequest)
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.
updateProxySessionRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.UpdateRoomResult updateRoom(UpdateRoomRequest updateRoomRequest)
Updates room details, such as the room name, for a room in an Amazon Chime Enterprise account.
updateRoomRequest - BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.NotFoundException - One or more of the resources in the request does not exist in the system.UnauthorizedClientException - The client is not currently authorized to make the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.UpdateRoomMembershipResult updateRoomMembership(UpdateRoomMembershipRequest updateRoomMembershipRequest)
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.
updateRoomMembershipRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.BadRequestException - The input parameters don't match the service's restrictions.ForbiddenException - The client is permanently forbidden from making the request.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated UpdateSipMediaApplicationResult updateSipMediaApplication(UpdateSipMediaApplicationRequest updateSipMediaApplicationRequest)
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.
updateSipMediaApplicationRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ConflictException - The request could not be processed because of conflict in the current state of the resource.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated UpdateSipMediaApplicationCallResult updateSipMediaApplicationCall(UpdateSipMediaApplicationCallRequest updateSipMediaApplicationCallRequest)
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.
updateSipMediaApplicationCallRequest - BadRequestException - The input parameters don't match the service's restrictions.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.ResourceLimitExceededException - The request exceeds the resource limit.ThrottledClientException - The client exceeded its request rate limit.UnauthorizedClientException - The client is not currently authorized to make the request.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated UpdateSipRuleResult updateSipRule(UpdateSipRuleRequest updateSipRuleRequest)
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.
updateSipRuleRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ConflictException - The request could not be processed because of conflict in the current state of the resource.ThrottledClientException - The client exceeded its request rate limit.ResourceLimitExceededException - The request exceeds the resource limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.UpdateUserResult updateUser(UpdateUserRequest updateUserRequest)
Updates user details for a specified user ID. Currently, only LicenseType updates are supported for
this action.
updateUserRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.UpdateUserSettingsResult updateUserSettings(UpdateUserSettingsRequest updateUserSettingsRequest)
Updates the settings for the specified user, such as phone number settings.
updateUserSettingsRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated UpdateVoiceConnectorResult updateVoiceConnector(UpdateVoiceConnectorRequest updateVoiceConnectorRequest)
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.
updateVoiceConnectorRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated UpdateVoiceConnectorGroupResult updateVoiceConnectorGroup(UpdateVoiceConnectorGroupRequest updateVoiceConnectorGroupRequest)
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.
updateVoiceConnectorGroupRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ConflictException - The request could not be processed because of conflict in the current state of the resource.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.@Deprecated ValidateE911AddressResult validateE911Address(ValidateE911AddressRequest validateE911AddressRequest)
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.
validateE911AddressRequest - UnauthorizedClientException - The client is not currently authorized to make the request.NotFoundException - One or more of the resources in the request does not exist in the system.ForbiddenException - The client is permanently forbidden from making the request.BadRequestException - The input parameters don't match the service's restrictions.ThrottledClientException - The client exceeded its request rate limit.ServiceUnavailableException - The service is currently unavailable.ServiceFailureException - The service encountered an unexpected error.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request - The originally executed request.