@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonChimeClient extends AmazonWebServiceClient implements AmazonChime
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.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
public static AmazonChimeClientBuilder builder()
public AssociatePhoneNumberWithUserResult associatePhoneNumberWithUser(AssociatePhoneNumberWithUserRequest request)
Associates a phone number with the specified Amazon Chime user.
associatePhoneNumberWithUser
in interface AmazonChime
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 public AssociatePhoneNumbersWithVoiceConnectorResult associatePhoneNumbersWithVoiceConnector(AssociatePhoneNumbersWithVoiceConnectorRequest request)
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.
associatePhoneNumbersWithVoiceConnector
in interface AmazonChime
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 public AssociatePhoneNumbersWithVoiceConnectorGroupResult associatePhoneNumbersWithVoiceConnectorGroup(AssociatePhoneNumbersWithVoiceConnectorGroupRequest request)
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.
associatePhoneNumbersWithVoiceConnectorGroup
in interface AmazonChime
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.public AssociateSigninDelegateGroupsWithAccountResult associateSigninDelegateGroupsWithAccount(AssociateSigninDelegateGroupsWithAccountRequest request)
Associates the specified sign-in delegate groups with the specified Amazon Chime account.
associateSigninDelegateGroupsWithAccount
in interface AmazonChime
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 public BatchCreateAttendeeResult batchCreateAttendee(BatchCreateAttendeeRequest request)
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.
batchCreateAttendee
in interface AmazonChime
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 public BatchCreateChannelMembershipResult batchCreateChannelMembership(BatchCreateChannelMembershipRequest request)
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.
batchCreateChannelMembership
in interface AmazonChime
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.public BatchCreateRoomMembershipResult batchCreateRoomMembership(BatchCreateRoomMembershipRequest request)
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.
batchCreateRoomMembership
in interface AmazonChime
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.public BatchDeletePhoneNumberResult batchDeletePhoneNumber(BatchDeletePhoneNumberRequest request)
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.
batchDeletePhoneNumber
in interface AmazonChime
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.public BatchSuspendUserResult batchSuspendUser(BatchSuspendUserRequest request)
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.
batchSuspendUser
in interface AmazonChime
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.public BatchUnsuspendUserResult batchUnsuspendUser(BatchUnsuspendUserRequest request)
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.
batchUnsuspendUser
in interface AmazonChime
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.public BatchUpdatePhoneNumberResult batchUpdatePhoneNumber(BatchUpdatePhoneNumberRequest request)
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.
batchUpdatePhoneNumber
in interface AmazonChime
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.public BatchUpdateUserResult batchUpdateUser(BatchUpdateUserRequest request)
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.
batchUpdateUser
in interface AmazonChime
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.public CreateAccountResult createAccount(CreateAccountRequest request)
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.
createAccount
in interface AmazonChime
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 public CreateAppInstanceResult createAppInstance(CreateAppInstanceRequest request)
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.
createAppInstance
in interface AmazonChime
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 public CreateAppInstanceAdminResult createAppInstanceAdmin(CreateAppInstanceAdminRequest request)
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.
createAppInstanceAdmin
in interface AmazonChime
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 public CreateAppInstanceUserResult createAppInstanceUser(CreateAppInstanceUserRequest request)
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.
createAppInstanceUser
in interface AmazonChime
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 public CreateAttendeeResult createAttendee(CreateAttendeeRequest request)
Creates a new attendee for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime 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.
createAttendee
in interface AmazonChime
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.public CreateBotResult createBot(CreateBotRequest request)
Creates a bot for an Amazon Chime Enterprise account.
createBot
in interface AmazonChime
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 public CreateChannelResult createChannel(CreateChannelRequest request)
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.
createChannel
in interface AmazonChime
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 public CreateChannelBanResult createChannelBan(CreateChannelBanRequest request)
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.
createChannelBan
in interface AmazonChime
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 public CreateChannelMembershipResult createChannelMembership(CreateChannelMembershipRequest request)
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.
createChannelMembership
in interface AmazonChime
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 public CreateChannelModeratorResult createChannelModerator(CreateChannelModeratorRequest request)
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.
createChannelModerator
in interface AmazonChime
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 public CreateMediaCapturePipelineResult createMediaCapturePipeline(CreateMediaCapturePipelineRequest request)
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.
createMediaCapturePipeline
in interface AmazonChime
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 public CreateMeetingResult createMeeting(CreateMeetingRequest request)
Creates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees. For more information about specifying media Regions, see Amazon Chime SDK Media Regions in the Amazon Chime 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.
createMeeting
in interface AmazonChime
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.public CreateMeetingDialOutResult createMeetingDialOut(CreateMeetingDialOutRequest request)
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.
createMeetingDialOut
in interface AmazonChime
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 public CreateMeetingWithAttendeesResult createMeetingWithAttendees(CreateMeetingWithAttendeesRequest request)
Creates a new Amazon Chime SDK meeting in the specified media Region, with attendees. For more information about specifying media Regions, see Amazon Chime SDK Media Regions in the Amazon Chime 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.
createMeetingWithAttendees
in interface AmazonChime
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.public CreatePhoneNumberOrderResult createPhoneNumberOrder(CreatePhoneNumberOrderRequest request)
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.
createPhoneNumberOrder
in interface AmazonChime
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 public CreateProxySessionResult createProxySession(CreateProxySessionRequest request)
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.
createProxySession
in interface AmazonChime
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.public CreateRoomResult createRoom(CreateRoomRequest request)
Creates a chat room for the specified Amazon Chime Enterprise account.
createRoom
in interface AmazonChime
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.public CreateRoomMembershipResult createRoomMembership(CreateRoomMembershipRequest request)
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.
createRoomMembership
in interface AmazonChime
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 public CreateSipMediaApplicationResult createSipMediaApplication(CreateSipMediaApplicationRequest request)
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.
createSipMediaApplication
in interface AmazonChime
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 public CreateSipMediaApplicationCallResult createSipMediaApplicationCall(CreateSipMediaApplicationCallRequest request)
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.
createSipMediaApplicationCall
in interface AmazonChime
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 public CreateSipRuleResult createSipRule(CreateSipRuleRequest request)
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.
createSipRule
in interface AmazonChime
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.public CreateUserResult createUser(CreateUserRequest request)
Creates a user under the specified Amazon Chime account.
createUser
in interface AmazonChime
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 public CreateVoiceConnectorResult createVoiceConnector(CreateVoiceConnectorRequest request)
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.
createVoiceConnector
in interface AmazonChime
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 public CreateVoiceConnectorGroupResult createVoiceConnectorGroup(CreateVoiceConnectorGroupRequest request)
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.
createVoiceConnectorGroup
in interface AmazonChime
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.public DeleteAccountResult deleteAccount(DeleteAccountRequest request)
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.
deleteAccount
in interface AmazonChime
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 public DeleteAppInstanceResult deleteAppInstance(DeleteAppInstanceRequest request)
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.
deleteAppInstance
in interface AmazonChime
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 public DeleteAppInstanceAdminResult deleteAppInstanceAdmin(DeleteAppInstanceAdminRequest request)
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.
deleteAppInstanceAdmin
in interface AmazonChime
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 public DeleteAppInstanceStreamingConfigurationsResult deleteAppInstanceStreamingConfigurations(DeleteAppInstanceStreamingConfigurationsRequest request)
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.
deleteAppInstanceStreamingConfigurations
in interface AmazonChime
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 public DeleteAppInstanceUserResult deleteAppInstanceUser(DeleteAppInstanceUserRequest request)
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.
deleteAppInstanceUser
in interface AmazonChime
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 public DeleteAttendeeResult deleteAttendee(DeleteAttendeeRequest request)
Deletes an attendee from the specified Amazon Chime SDK meeting and deletes their JoinToken
.
Attendees are automatically deleted when a Amazon Chime SDK meeting is deleted. For more information about the
Amazon Chime SDK, see Using the
Amazon Chime SDK in the Amazon Chime 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.
deleteAttendee
in interface AmazonChime
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 public DeleteChannelResult deleteChannel(DeleteChannelRequest request)
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.
deleteChannel
in interface AmazonChime
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 public DeleteChannelBanResult deleteChannelBan(DeleteChannelBanRequest request)
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.
deleteChannelBan
in interface AmazonChime
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 public DeleteChannelMembershipResult deleteChannelMembership(DeleteChannelMembershipRequest request)
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.
deleteChannelMembership
in interface AmazonChime
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 public DeleteChannelMessageResult deleteChannelMessage(DeleteChannelMessageRequest request)
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.
deleteChannelMessage
in interface AmazonChime
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 public DeleteChannelModeratorResult deleteChannelModerator(DeleteChannelModeratorRequest request)
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.
deleteChannelModerator
in interface AmazonChime
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.public DeleteEventsConfigurationResult deleteEventsConfiguration(DeleteEventsConfigurationRequest request)
Deletes the events configuration that allows a bot to receive outgoing events.
deleteEventsConfiguration
in interface AmazonChime
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 public DeleteMediaCapturePipelineResult deleteMediaCapturePipeline(DeleteMediaCapturePipelineRequest request)
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.
deleteMediaCapturePipeline
in interface AmazonChime
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 public DeleteMeetingResult deleteMeeting(DeleteMeetingRequest request)
Deletes the specified Amazon Chime SDK meeting. The operation deletes all attendees, disconnects all clients, and prevents new clients from joining the meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime 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.
deleteMeeting
in interface AmazonChime
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.public DeletePhoneNumberResult deletePhoneNumber(DeletePhoneNumberRequest request)
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.
deletePhoneNumber
in interface AmazonChime
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 public DeleteProxySessionResult deleteProxySession(DeleteProxySessionRequest request)
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.
deleteProxySession
in interface AmazonChime
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.public DeleteRoomResult deleteRoom(DeleteRoomRequest request)
Deletes a chat room in an Amazon Chime Enterprise account.
deleteRoom
in interface AmazonChime
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.public DeleteRoomMembershipResult deleteRoomMembership(DeleteRoomMembershipRequest request)
Removes a member from a chat room in an Amazon Chime Enterprise account.
deleteRoomMembership
in interface AmazonChime
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 public DeleteSipMediaApplicationResult deleteSipMediaApplication(DeleteSipMediaApplicationRequest request)
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.
deleteSipMediaApplication
in interface AmazonChime
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 public DeleteSipRuleResult deleteSipRule(DeleteSipRuleRequest request)
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.
deleteSipRule
in interface AmazonChime
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 public DeleteVoiceConnectorResult deleteVoiceConnector(DeleteVoiceConnectorRequest request)
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.
deleteVoiceConnector
in interface AmazonChime
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 public DeleteVoiceConnectorEmergencyCallingConfigurationResult deleteVoiceConnectorEmergencyCallingConfiguration(DeleteVoiceConnectorEmergencyCallingConfigurationRequest request)
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.
deleteVoiceConnectorEmergencyCallingConfiguration
in interface AmazonChime
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 public DeleteVoiceConnectorGroupResult deleteVoiceConnectorGroup(DeleteVoiceConnectorGroupRequest request)
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.
deleteVoiceConnectorGroup
in interface AmazonChime
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 public DeleteVoiceConnectorOriginationResult deleteVoiceConnectorOrigination(DeleteVoiceConnectorOriginationRequest request)
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.
deleteVoiceConnectorOrigination
in interface AmazonChime
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 public DeleteVoiceConnectorProxyResult deleteVoiceConnectorProxy(DeleteVoiceConnectorProxyRequest request)
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.
deleteVoiceConnectorProxy
in interface AmazonChime
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 public DeleteVoiceConnectorStreamingConfigurationResult deleteVoiceConnectorStreamingConfiguration(DeleteVoiceConnectorStreamingConfigurationRequest request)
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.
deleteVoiceConnectorStreamingConfiguration
in interface AmazonChime
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 public DeleteVoiceConnectorTerminationResult deleteVoiceConnectorTermination(DeleteVoiceConnectorTerminationRequest request)
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.
deleteVoiceConnectorTermination
in interface AmazonChime
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 public DeleteVoiceConnectorTerminationCredentialsResult deleteVoiceConnectorTerminationCredentials(DeleteVoiceConnectorTerminationCredentialsRequest request)
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.
deleteVoiceConnectorTerminationCredentials
in interface AmazonChime
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 public DescribeAppInstanceResult describeAppInstance(DescribeAppInstanceRequest request)
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.
describeAppInstance
in interface AmazonChime
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 public DescribeAppInstanceAdminResult describeAppInstanceAdmin(DescribeAppInstanceAdminRequest request)
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.
describeAppInstanceAdmin
in interface AmazonChime
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 public DescribeAppInstanceUserResult describeAppInstanceUser(DescribeAppInstanceUserRequest request)
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.
describeAppInstanceUser
in interface AmazonChime
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 public DescribeChannelResult describeChannel(DescribeChannelRequest request)
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.
describeChannel
in interface AmazonChime
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 public DescribeChannelBanResult describeChannelBan(DescribeChannelBanRequest request)
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.
describeChannelBan
in interface AmazonChime
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 public DescribeChannelMembershipResult describeChannelMembership(DescribeChannelMembershipRequest request)
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.
describeChannelMembership
in interface AmazonChime
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 public DescribeChannelMembershipForAppInstanceUserResult describeChannelMembershipForAppInstanceUser(DescribeChannelMembershipForAppInstanceUserRequest request)
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.
describeChannelMembershipForAppInstanceUser
in interface AmazonChime
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 public DescribeChannelModeratedByAppInstanceUserResult describeChannelModeratedByAppInstanceUser(DescribeChannelModeratedByAppInstanceUserRequest request)
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.
describeChannelModeratedByAppInstanceUser
in interface AmazonChime
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 public DescribeChannelModeratorResult describeChannelModerator(DescribeChannelModeratorRequest request)
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.
describeChannelModerator
in interface AmazonChime
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.public DisassociatePhoneNumberFromUserResult disassociatePhoneNumberFromUser(DisassociatePhoneNumberFromUserRequest request)
Disassociates the primary provisioned phone number from the specified Amazon Chime user.
disassociatePhoneNumberFromUser
in interface AmazonChime
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 public DisassociatePhoneNumbersFromVoiceConnectorResult disassociatePhoneNumbersFromVoiceConnector(DisassociatePhoneNumbersFromVoiceConnectorRequest request)
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.
disassociatePhoneNumbersFromVoiceConnector
in interface AmazonChime
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 public DisassociatePhoneNumbersFromVoiceConnectorGroupResult disassociatePhoneNumbersFromVoiceConnectorGroup(DisassociatePhoneNumbersFromVoiceConnectorGroupRequest request)
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.
disassociatePhoneNumbersFromVoiceConnectorGroup
in interface AmazonChime
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.public DisassociateSigninDelegateGroupsFromAccountResult disassociateSigninDelegateGroupsFromAccount(DisassociateSigninDelegateGroupsFromAccountRequest request)
Disassociates the specified sign-in delegate groups from the specified Amazon Chime account.
disassociateSigninDelegateGroupsFromAccount
in interface AmazonChime
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.public GetAccountResult getAccount(GetAccountRequest request)
Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.
getAccount
in interface AmazonChime
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.public GetAccountSettingsResult getAccountSettings(GetAccountSettingsRequest request)
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.
getAccountSettings
in interface AmazonChime
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 public GetAppInstanceRetentionSettingsResult getAppInstanceRetentionSettings(GetAppInstanceRetentionSettingsRequest request)
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.
getAppInstanceRetentionSettings
in interface AmazonChime
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 public GetAppInstanceStreamingConfigurationsResult getAppInstanceStreamingConfigurations(GetAppInstanceStreamingConfigurationsRequest request)
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.
getAppInstanceStreamingConfigurations
in interface AmazonChime
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 public GetAttendeeResult getAttendee(GetAttendeeRequest request)
Gets the Amazon Chime SDK attendee details for a specified meeting ID and attendee ID. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime 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.
getAttendee
in interface AmazonChime
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.public GetBotResult getBot(GetBotRequest request)
Retrieves details for the specified bot, such as bot email address, bot type, status, and display name.
getBot
in interface AmazonChime
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 public GetChannelMessageResult getChannelMessage(GetChannelMessageRequest request)
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.
getChannelMessage
in interface AmazonChime
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.public GetEventsConfigurationResult getEventsConfiguration(GetEventsConfigurationRequest request)
Gets details for an events configuration that allows a bot to receive outgoing events, such as an HTTPS endpoint or Lambda function ARN.
getEventsConfiguration
in interface AmazonChime
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.public GetGlobalSettingsResult getGlobalSettings(GetGlobalSettingsRequest request)
Retrieves global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.
getGlobalSettings
in interface AmazonChime
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 public GetMediaCapturePipelineResult getMediaCapturePipeline(GetMediaCapturePipelineRequest request)
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.
getMediaCapturePipeline
in interface AmazonChime
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 public GetMeetingResult getMeeting(GetMeetingRequest request)
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 .
getMeeting
in interface AmazonChime
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 public GetMessagingSessionEndpointResult getMessagingSessionEndpoint(GetMessagingSessionEndpointRequest request)
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.
getMessagingSessionEndpoint
in interface AmazonChime
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.public GetPhoneNumberResult getPhoneNumber(GetPhoneNumberRequest request)
Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.
getPhoneNumber
in interface AmazonChime
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.public GetPhoneNumberOrderResult getPhoneNumberOrder(GetPhoneNumberOrderRequest request)
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.
getPhoneNumberOrder
in interface AmazonChime
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.public GetPhoneNumberSettingsResult getPhoneNumberSettings(GetPhoneNumberSettingsRequest request)
Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.
getPhoneNumberSettings
in interface AmazonChime
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 public GetProxySessionResult getProxySession(GetProxySessionRequest request)
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.
getProxySession
in interface AmazonChime
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.public GetRetentionSettingsResult getRetentionSettings(GetRetentionSettingsRequest request)
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.
getRetentionSettings
in interface AmazonChime
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.public GetRoomResult getRoom(GetRoomRequest request)
Retrieves room details, such as the room name, for a room in an Amazon Chime Enterprise account.
getRoom
in interface AmazonChime
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 public GetSipMediaApplicationResult getSipMediaApplication(GetSipMediaApplicationRequest request)
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.
getSipMediaApplication
in interface AmazonChime
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 public GetSipMediaApplicationLoggingConfigurationResult getSipMediaApplicationLoggingConfiguration(GetSipMediaApplicationLoggingConfigurationRequest request)
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.
getSipMediaApplicationLoggingConfiguration
in interface AmazonChime
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 public GetSipRuleResult getSipRule(GetSipRuleRequest request)
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.
getSipRule
in interface AmazonChime
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.public GetUserResult getUser(GetUserRequest request)
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.
getUser
in interface AmazonChime
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.public GetUserSettingsResult getUserSettings(GetUserSettingsRequest request)
Retrieves settings for the specified user ID, such as any associated phone number settings.
getUserSettings
in interface AmazonChime
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 public GetVoiceConnectorResult getVoiceConnector(GetVoiceConnectorRequest request)
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.
getVoiceConnector
in interface AmazonChime
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 public GetVoiceConnectorEmergencyCallingConfigurationResult getVoiceConnectorEmergencyCallingConfiguration(GetVoiceConnectorEmergencyCallingConfigurationRequest request)
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.
getVoiceConnectorEmergencyCallingConfiguration
in interface AmazonChime
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 public GetVoiceConnectorGroupResult getVoiceConnectorGroup(GetVoiceConnectorGroupRequest request)
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.
getVoiceConnectorGroup
in interface AmazonChime
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 public GetVoiceConnectorLoggingConfigurationResult getVoiceConnectorLoggingConfiguration(GetVoiceConnectorLoggingConfigurationRequest request)
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.
getVoiceConnectorLoggingConfiguration
in interface AmazonChime
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 public GetVoiceConnectorOriginationResult getVoiceConnectorOrigination(GetVoiceConnectorOriginationRequest request)
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.
getVoiceConnectorOrigination
in interface AmazonChime
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 public GetVoiceConnectorProxyResult getVoiceConnectorProxy(GetVoiceConnectorProxyRequest request)
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.
getVoiceConnectorProxy
in interface AmazonChime
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 public GetVoiceConnectorStreamingConfigurationResult getVoiceConnectorStreamingConfiguration(GetVoiceConnectorStreamingConfigurationRequest request)
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.
getVoiceConnectorStreamingConfiguration
in interface AmazonChime
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 public GetVoiceConnectorTerminationResult getVoiceConnectorTermination(GetVoiceConnectorTerminationRequest request)
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.
getVoiceConnectorTermination
in interface AmazonChime
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 public GetVoiceConnectorTerminationHealthResult getVoiceConnectorTerminationHealth(GetVoiceConnectorTerminationHealthRequest request)
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.
getVoiceConnectorTerminationHealth
in interface AmazonChime
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.public InviteUsersResult inviteUsers(InviteUsersRequest request)
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.
inviteUsers
in interface AmazonChime
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.public ListAccountsResult listAccounts(ListAccountsRequest request)
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.
listAccounts
in interface AmazonChime
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 public ListAppInstanceAdminsResult listAppInstanceAdmins(ListAppInstanceAdminsRequest request)
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.
listAppInstanceAdmins
in interface AmazonChime
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 public ListAppInstanceUsersResult listAppInstanceUsers(ListAppInstanceUsersRequest request)
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.
listAppInstanceUsers
in interface AmazonChime
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 public ListAppInstancesResult listAppInstances(ListAppInstancesRequest request)
Lists all Amazon Chime AppInstance
s created under a single AWS account.
This API is is no longer supported and will not be updated. We recommend using the latest version, ListAppInstances, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
listAppInstances
in interface AmazonChime
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 public ListAttendeeTagsResult listAttendeeTags(ListAttendeeTagsRequest request)
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.
listAttendeeTags
in interface AmazonChime
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 public ListAttendeesResult listAttendees(ListAttendeesRequest request)
Lists the attendees for the specified Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime 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.
listAttendees
in interface AmazonChime
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.public ListBotsResult listBots(ListBotsRequest request)
Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.
listBots
in interface AmazonChime
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 public ListChannelBansResult listChannelBans(ListChannelBansRequest request)
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.
listChannelBans
in interface AmazonChime
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 public ListChannelMembershipsResult listChannelMemberships(ListChannelMembershipsRequest request)
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.
listChannelMemberships
in interface AmazonChime
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 public ListChannelMembershipsForAppInstanceUserResult listChannelMembershipsForAppInstanceUser(ListChannelMembershipsForAppInstanceUserRequest request)
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.
listChannelMembershipsForAppInstanceUser
in interface AmazonChime
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 public ListChannelMessagesResult listChannelMessages(ListChannelMessagesRequest request)
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.
listChannelMessages
in interface AmazonChime
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 public ListChannelModeratorsResult listChannelModerators(ListChannelModeratorsRequest request)
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.
listChannelModerators
in interface AmazonChime
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 public ListChannelsResult listChannels(ListChannelsRequest request)
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.
listChannels
in interface AmazonChime
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 public ListChannelsModeratedByAppInstanceUserResult listChannelsModeratedByAppInstanceUser(ListChannelsModeratedByAppInstanceUserRequest request)
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.
listChannelsModeratedByAppInstanceUser
in interface AmazonChime
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 public ListMediaCapturePipelinesResult listMediaCapturePipelines(ListMediaCapturePipelinesRequest request)
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.
listMediaCapturePipelines
in interface AmazonChime
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 public ListMeetingTagsResult listMeetingTags(ListMeetingTagsRequest request)
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.
listMeetingTags
in interface AmazonChime
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 public ListMeetingsResult listMeetings(ListMeetingsRequest request)
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.
listMeetings
in interface AmazonChime
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.public ListPhoneNumberOrdersResult listPhoneNumberOrders(ListPhoneNumberOrdersRequest request)
Lists the phone number orders for the administrator's Amazon Chime account.
listPhoneNumberOrders
in interface AmazonChime
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.public ListPhoneNumbersResult listPhoneNumbers(ListPhoneNumbersRequest request)
Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, Amazon Chime Voice Connector, or Amazon Chime Voice Connector group.
listPhoneNumbers
in interface AmazonChime
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 public ListProxySessionsResult listProxySessions(ListProxySessionsRequest request)
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.
listProxySessions
in interface AmazonChime
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.public ListRoomMembershipsResult listRoomMemberships(ListRoomMembershipsRequest request)
Lists the membership details for the specified room in an Amazon Chime Enterprise account, such as the members' IDs, email addresses, and names.
listRoomMemberships
in interface AmazonChime
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.public ListRoomsResult listRooms(ListRoomsRequest request)
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.
listRooms
in interface AmazonChime
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 public ListSipMediaApplicationsResult listSipMediaApplications(ListSipMediaApplicationsRequest request)
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.
listSipMediaApplications
in interface AmazonChime
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 public ListSipRulesResult listSipRules(ListSipRulesRequest request)
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.
listSipRules
in interface AmazonChime
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.public ListSupportedPhoneNumberCountriesResult listSupportedPhoneNumberCountries(ListSupportedPhoneNumberCountriesRequest request)
Lists supported phone number countries.
listSupportedPhoneNumberCountries
in interface AmazonChime
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 public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
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.
listTagsForResource
in interface AmazonChime
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.public ListUsersResult listUsers(ListUsersRequest request)
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.
listUsers
in interface AmazonChime
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 public ListVoiceConnectorGroupsResult listVoiceConnectorGroups(ListVoiceConnectorGroupsRequest request)
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.
listVoiceConnectorGroups
in interface AmazonChime
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 public ListVoiceConnectorTerminationCredentialsResult listVoiceConnectorTerminationCredentials(ListVoiceConnectorTerminationCredentialsRequest request)
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.
listVoiceConnectorTerminationCredentials
in interface AmazonChime
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 public ListVoiceConnectorsResult listVoiceConnectors(ListVoiceConnectorsRequest request)
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.
listVoiceConnectors
in interface AmazonChime
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.public LogoutUserResult logoutUser(LogoutUserRequest request)
Logs out the specified user from all of the devices they are currently logged into.
logoutUser
in interface AmazonChime
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 public PutAppInstanceRetentionSettingsResult putAppInstanceRetentionSettings(PutAppInstanceRetentionSettingsRequest request)
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.
putAppInstanceRetentionSettings
in interface AmazonChime
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 public PutAppInstanceStreamingConfigurationsResult putAppInstanceStreamingConfigurations(PutAppInstanceStreamingConfigurationsRequest request)
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.
putAppInstanceStreamingConfigurations
in interface AmazonChime
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.public PutEventsConfigurationResult putEventsConfiguration(PutEventsConfigurationRequest request)
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.
putEventsConfiguration
in interface AmazonChime
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.public PutRetentionSettingsResult putRetentionSettings(PutRetentionSettingsRequest request)
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.
putRetentionSettings
in interface AmazonChime
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 public PutSipMediaApplicationLoggingConfigurationResult putSipMediaApplicationLoggingConfiguration(PutSipMediaApplicationLoggingConfigurationRequest request)
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.
putSipMediaApplicationLoggingConfiguration
in interface AmazonChime
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 public PutVoiceConnectorEmergencyCallingConfigurationResult putVoiceConnectorEmergencyCallingConfiguration(PutVoiceConnectorEmergencyCallingConfigurationRequest request)
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.
putVoiceConnectorEmergencyCallingConfiguration
in interface AmazonChime
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 public PutVoiceConnectorLoggingConfigurationResult putVoiceConnectorLoggingConfiguration(PutVoiceConnectorLoggingConfigurationRequest request)
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.
putVoiceConnectorLoggingConfiguration
in interface AmazonChime
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 public PutVoiceConnectorOriginationResult putVoiceConnectorOrigination(PutVoiceConnectorOriginationRequest request)
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.
putVoiceConnectorOrigination
in interface AmazonChime
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 public PutVoiceConnectorProxyResult putVoiceConnectorProxy(PutVoiceConnectorProxyRequest request)
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.
putVoiceConnectorProxy
in interface AmazonChime
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 public PutVoiceConnectorStreamingConfigurationResult putVoiceConnectorStreamingConfiguration(PutVoiceConnectorStreamingConfigurationRequest request)
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.
putVoiceConnectorStreamingConfiguration
in interface AmazonChime
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 public PutVoiceConnectorTerminationResult putVoiceConnectorTermination(PutVoiceConnectorTerminationRequest request)
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.
putVoiceConnectorTermination
in interface AmazonChime
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 public PutVoiceConnectorTerminationCredentialsResult putVoiceConnectorTerminationCredentials(PutVoiceConnectorTerminationCredentialsRequest request)
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.
putVoiceConnectorTerminationCredentials
in interface AmazonChime
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 public RedactChannelMessageResult redactChannelMessage(RedactChannelMessageRequest request)
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.
redactChannelMessage
in interface AmazonChime
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.public RedactConversationMessageResult redactConversationMessage(RedactConversationMessageRequest request)
Redacts the specified message from the specified Amazon Chime conversation.
redactConversationMessage
in interface AmazonChime
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.public RedactRoomMessageResult redactRoomMessage(RedactRoomMessageRequest request)
Redacts the specified message from the specified Amazon Chime channel.
redactRoomMessage
in interface AmazonChime
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.public RegenerateSecurityTokenResult regenerateSecurityToken(RegenerateSecurityTokenRequest request)
Regenerates the security token for a bot.
regenerateSecurityToken
in interface AmazonChime
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.public ResetPersonalPINResult resetPersonalPIN(ResetPersonalPINRequest request)
Resets the personal meeting PIN for the specified user on an Amazon Chime account. Returns the User object with the updated personal meeting PIN.
resetPersonalPIN
in interface AmazonChime
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.public RestorePhoneNumberResult restorePhoneNumber(RestorePhoneNumberRequest request)
Moves a phone number from the Deletion queue back into the phone number Inventory.
restorePhoneNumber
in interface AmazonChime
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.public SearchAvailablePhoneNumbersResult searchAvailablePhoneNumbers(SearchAvailablePhoneNumbersRequest request)
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.
searchAvailablePhoneNumbers
in interface AmazonChime
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 public SendChannelMessageResult sendChannelMessage(SendChannelMessageRequest request)
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.
sendChannelMessage
in interface AmazonChime
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 public StartMeetingTranscriptionResult startMeetingTranscription(StartMeetingTranscriptionRequest request)
Starts transcription for the specified meetingId
. For more information, refer to Using Amazon Chime SDK live
transcription in the Amazon Chime SDK Developer Guide.
If you specify an invalid configuration, a TranscriptFailed
event will be sent with the contents of
the BadRequestException
generated by Amazon Transcribe. For more information on each parameter and
which combinations are valid, refer to the StartStreamTranscription API in the Amazon Transcribe Developer Guide.
Amazon Chime SDK live transcription is powered by Amazon Transcribe. Use of Amazon Transcribe is subject to the AWS Service Terms, including the terms specific to the AWS Machine Learning and Artificial Intelligence Services.
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.
startMeetingTranscription
in interface AmazonChime
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 public StopMeetingTranscriptionResult stopMeetingTranscription(StopMeetingTranscriptionRequest request)
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.
stopMeetingTranscription
in interface AmazonChime
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 public TagAttendeeResult tagAttendee(TagAttendeeRequest request)
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.
tagAttendee
in interface AmazonChime
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 public TagMeetingResult tagMeeting(TagMeetingRequest request)
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.
tagMeeting
in interface AmazonChime
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 public TagResourceResult tagResource(TagResourceRequest request)
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.
tagResource
in interface AmazonChime
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 public UntagAttendeeResult untagAttendee(UntagAttendeeRequest request)
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.
untagAttendee
in interface AmazonChime
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 public UntagMeetingResult untagMeeting(UntagMeetingRequest request)
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.
untagMeeting
in interface AmazonChime
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 public UntagResourceResult untagResource(UntagResourceRequest request)
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.
untagResource
in interface AmazonChime
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.public UpdateAccountResult updateAccount(UpdateAccountRequest request)
Updates account details for the specified Amazon Chime account. Currently, only account name and default license updates are supported for this action.
updateAccount
in interface AmazonChime
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.public UpdateAccountSettingsResult updateAccountSettings(UpdateAccountSettingsRequest request)
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.
updateAccountSettings
in interface AmazonChime
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 public UpdateAppInstanceResult updateAppInstance(UpdateAppInstanceRequest request)
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.
updateAppInstance
in interface AmazonChime
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 public UpdateAppInstanceUserResult updateAppInstanceUser(UpdateAppInstanceUserRequest request)
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.
updateAppInstanceUser
in interface AmazonChime
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.public UpdateBotResult updateBot(UpdateBotRequest request)
Updates the status of the specified bot, such as starting or stopping the bot from running in your Amazon Chime Enterprise account.
updateBot
in interface AmazonChime
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 public UpdateChannelResult updateChannel(UpdateChannelRequest request)
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.
updateChannel
in interface AmazonChime
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 public UpdateChannelMessageResult updateChannelMessage(UpdateChannelMessageRequest request)
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.
updateChannelMessage
in interface AmazonChime
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 public UpdateChannelReadMarkerResult updateChannelReadMarker(UpdateChannelReadMarkerRequest request)
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.
updateChannelReadMarker
in interface AmazonChime
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.public UpdateGlobalSettingsResult updateGlobalSettings(UpdateGlobalSettingsRequest request)
Updates global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.
updateGlobalSettings
in interface AmazonChime
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.public UpdatePhoneNumberResult updatePhoneNumber(UpdatePhoneNumberRequest request)
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.
updatePhoneNumber
in interface AmazonChime
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.public UpdatePhoneNumberSettingsResult updatePhoneNumberSettings(UpdatePhoneNumberSettingsRequest request)
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.
updatePhoneNumberSettings
in interface AmazonChime
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 public UpdateProxySessionResult updateProxySession(UpdateProxySessionRequest request)
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.
updateProxySession
in interface AmazonChime
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.public UpdateRoomResult updateRoom(UpdateRoomRequest request)
Updates room details, such as the room name, for a room in an Amazon Chime Enterprise account.
updateRoom
in interface AmazonChime
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.public UpdateRoomMembershipResult updateRoomMembership(UpdateRoomMembershipRequest request)
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.
updateRoomMembership
in interface AmazonChime
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 public UpdateSipMediaApplicationResult updateSipMediaApplication(UpdateSipMediaApplicationRequest request)
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.
updateSipMediaApplication
in interface AmazonChime
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 public UpdateSipMediaApplicationCallResult updateSipMediaApplicationCall(UpdateSipMediaApplicationCallRequest request)
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.
updateSipMediaApplicationCall
in interface AmazonChime
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 public UpdateSipRuleResult updateSipRule(UpdateSipRuleRequest request)
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.
updateSipRule
in interface AmazonChime
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.public UpdateUserResult updateUser(UpdateUserRequest request)
Updates user details for a specified user ID. Currently, only LicenseType
updates are supported for
this action.
updateUser
in interface AmazonChime
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.public UpdateUserSettingsResult updateUserSettings(UpdateUserSettingsRequest request)
Updates the settings for the specified user, such as phone number settings.
updateUserSettings
in interface AmazonChime
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 public UpdateVoiceConnectorResult updateVoiceConnector(UpdateVoiceConnectorRequest request)
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.
updateVoiceConnector
in interface AmazonChime
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 public UpdateVoiceConnectorGroupResult updateVoiceConnectorGroup(UpdateVoiceConnectorGroupRequest request)
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.
updateVoiceConnectorGroup
in interface AmazonChime
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 public ValidateE911AddressResult validateE911Address(ValidateE911AddressRequest request)
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.
validateE911Address
in interface AmazonChime
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.public 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 the request.
getCachedResponseMetadata
in interface AmazonChime
request
- The originally executed requestpublic void shutdown()
AmazonWebServiceClient
shutdown
in interface AmazonChime
shutdown
in class AmazonWebServiceClient