AWS SDK for C++AWS SDK for C++ Version 1.11.440 |
#include <ChimeClient.h>
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
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.
Definition at line 62 of file ChimeClient.h.
Definition at line 65 of file ChimeClient.h.
Definition at line 69 of file ChimeClient.h.
Definition at line 70 of file ChimeClient.h.
Aws::Chime::ChimeClientConfiguration()
,
nullptr
Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
nullptr
,
Aws::Chime::ChimeClientConfiguration()
Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
nullptr
,
Aws::Chime::ChimeClientConfiguration()
Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, the default http client factory will be used
Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, the default http client factory will be used
nullptr
An Async wrapper for AssociatePhoneNumberWithUser that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 141 of file ChimeClient.h.
A Callable wrapper for AssociatePhoneNumberWithUser that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 132 of file ChimeClient.h.
Associates the specified sign-in delegate groups with the specified Amazon Chime account.
nullptr
An Async wrapper for AssociateSigninDelegateGroupsWithAccount that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 167 of file ChimeClient.h.
A Callable wrapper for AssociateSigninDelegateGroupsWithAccount that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 158 of file ChimeClient.h.
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.
nullptr
An Async wrapper for BatchCreateRoomMembership that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 195 of file ChimeClient.h.
A Callable wrapper for BatchCreateRoomMembership that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 186 of file ChimeClient.h.
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.
nullptr
An Async wrapper for BatchDeletePhoneNumber that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 223 of file ChimeClient.h.
A Callable wrapper for BatchDeletePhoneNumber that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 214 of file ChimeClient.h.
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.
nullptr
An Async wrapper for BatchSuspendUser that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 262 of file ChimeClient.h.
A Callable wrapper for BatchSuspendUser that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 253 of file ChimeClient.h.
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.
nullptr
An Async wrapper for BatchUnsuspendUser that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 296 of file ChimeClient.h.
A Callable wrapper for BatchUnsuspendUser that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 287 of file ChimeClient.h.
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.
nullptr
An Async wrapper for BatchUpdatePhoneNumber that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 328 of file ChimeClient.h.
A Callable wrapper for BatchUpdatePhoneNumber that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 319 of file ChimeClient.h.
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.
nullptr
An Async wrapper for BatchUpdateUser that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 356 of file ChimeClient.h.
A Callable wrapper for BatchUpdateUser that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 347 of file ChimeClient.h.
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.
nullptr
An Async wrapper for CreateAccount that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 386 of file ChimeClient.h.
A Callable wrapper for CreateAccount that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 377 of file ChimeClient.h.
nullptr
An Async wrapper for CreateBot that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 412 of file ChimeClient.h.
A Callable wrapper for CreateBot that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 403 of file ChimeClient.h.
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.
nullptr
An Async wrapper for CreateMeetingDialOut that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 444 of file ChimeClient.h.
A Callable wrapper for CreateMeetingDialOut that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 435 of file ChimeClient.h.
nullptr
An Async wrapper for CreatePhoneNumberOrder that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 472 of file ChimeClient.h.
A Callable wrapper for CreatePhoneNumberOrder that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 463 of file ChimeClient.h.
nullptr
An Async wrapper for CreateRoom that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 498 of file ChimeClient.h.
A Callable wrapper for CreateRoom that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 489 of file ChimeClient.h.
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.
nullptr
An Async wrapper for CreateRoomMembership that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 526 of file ChimeClient.h.
A Callable wrapper for CreateRoomMembership that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 517 of file ChimeClient.h.
nullptr
An Async wrapper for CreateUser that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 552 of file ChimeClient.h.
A Callable wrapper for CreateUser that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 543 of file ChimeClient.h.
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.
nullptr
An Async wrapper for DeleteAccount that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 586 of file ChimeClient.h.
A Callable wrapper for DeleteAccount that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 577 of file ChimeClient.h.
Deletes the events configuration that allows a bot to receive outgoing events.
nullptr
An Async wrapper for DeleteEventsConfiguration that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 612 of file ChimeClient.h.
A Callable wrapper for DeleteEventsConfiguration that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 603 of file ChimeClient.h.
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.
nullptr
An Async wrapper for DeletePhoneNumber that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 641 of file ChimeClient.h.
A Callable wrapper for DeletePhoneNumber that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 632 of file ChimeClient.h.
nullptr
An Async wrapper for DeleteRoom that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 667 of file ChimeClient.h.
A Callable wrapper for DeleteRoom that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 658 of file ChimeClient.h.
Removes a member from a chat room in an Amazon Chime Enterprise account.
nullptr
An Async wrapper for DeleteRoomMembership that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 693 of file ChimeClient.h.
A Callable wrapper for DeleteRoomMembership that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 684 of file ChimeClient.h.
Disassociates the primary provisioned phone number from the specified Amazon Chime user.
nullptr
An Async wrapper for DisassociatePhoneNumberFromUser that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 719 of file ChimeClient.h.
A Callable wrapper for DisassociatePhoneNumberFromUser that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 710 of file ChimeClient.h.
Disassociates the specified sign-in delegate groups from the specified Amazon Chime account.
nullptr
An Async wrapper for DisassociateSigninDelegateGroupsFromAccount that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 745 of file ChimeClient.h.
A Callable wrapper for DisassociateSigninDelegateGroupsFromAccount that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 736 of file ChimeClient.h.
Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.
nullptr
An Async wrapper for GetAccount that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 771 of file ChimeClient.h.
A Callable wrapper for GetAccount that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 762 of file ChimeClient.h.
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.
nullptr
An Async wrapper for GetAccountSettings that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 800 of file ChimeClient.h.
A Callable wrapper for GetAccountSettings that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 791 of file ChimeClient.h.
Retrieves details for the specified bot, such as bot email address, bot type, status, and display name.
nullptr
An Async wrapper for GetBot that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 826 of file ChimeClient.h.
A Callable wrapper for GetBot that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 817 of file ChimeClient.h.
Gets details for an events configuration that allows a bot to receive outgoing events, such as an HTTPS endpoint or Lambda function ARN.
nullptr
An Async wrapper for GetEventsConfiguration that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 853 of file ChimeClient.h.
A Callable wrapper for GetEventsConfiguration that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 844 of file ChimeClient.h.
{}
)
const
nullptr
,
{}
An Async wrapper for GetGlobalSettings that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 880 of file ChimeClient.h.
{}
)
const
A Callable wrapper for GetGlobalSettings that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 871 of file ChimeClient.h.
Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.
nullptr
An Async wrapper for GetPhoneNumber that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 906 of file ChimeClient.h.
A Callable wrapper for GetPhoneNumber that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 897 of file ChimeClient.h.
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.
nullptr
An Async wrapper for GetPhoneNumberOrder that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 933 of file ChimeClient.h.
A Callable wrapper for GetPhoneNumberOrder that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 924 of file ChimeClient.h.
{}
)
const
Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.
nullptr
,
{}
An Async wrapper for GetPhoneNumberSettings that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 959 of file ChimeClient.h.
{}
)
const
A Callable wrapper for GetPhoneNumberSettings that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 950 of file ChimeClient.h.
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.
nullptr
An Async wrapper for GetRetentionSettings that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 988 of file ChimeClient.h.
A Callable wrapper for GetRetentionSettings that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 979 of file ChimeClient.h.
Retrieves room details, such as the room name, for a room in an Amazon Chime Enterprise account.
nullptr
An Async wrapper for GetRoom that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1014 of file ChimeClient.h.
A Callable wrapper for GetRoom that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1005 of file ChimeClient.h.
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.
nullptr
An Async wrapper for GetUser that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1042 of file ChimeClient.h.
A Callable wrapper for GetUser that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1033 of file ChimeClient.h.
Retrieves settings for the specified user ID, such as any associated phone number settings.
nullptr
An Async wrapper for GetUserSettings that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1068 of file ChimeClient.h.
A Callable wrapper for GetUserSettings that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1059 of file ChimeClient.h.
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.
nullptr
An Async wrapper for InviteUsers that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1095 of file ChimeClient.h.
A Callable wrapper for InviteUsers that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1086 of file ChimeClient.h.
{}
)
const
nullptr
,
{}
An Async wrapper for ListAccounts that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1123 of file ChimeClient.h.
{}
)
const
A Callable wrapper for ListAccounts that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1114 of file ChimeClient.h.
Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.
nullptr
An Async wrapper for ListBots that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1149 of file ChimeClient.h.
A Callable wrapper for ListBots that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1140 of file ChimeClient.h.
{}
)
const
Lists the phone number orders for the administrator's Amazon Chime account.
nullptr
,
{}
An Async wrapper for ListPhoneNumberOrders that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1175 of file ChimeClient.h.
{}
)
const
A Callable wrapper for ListPhoneNumberOrders that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1166 of file ChimeClient.h.
{}
)
const
nullptr
,
{}
An Async wrapper for ListPhoneNumbers that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1202 of file ChimeClient.h.
{}
)
const
A Callable wrapper for ListPhoneNumbers that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1193 of file ChimeClient.h.
Lists the membership details for the specified room in an Amazon Chime Enterprise account, such as the members' IDs, email addresses, and names.
nullptr
An Async wrapper for ListRoomMemberships that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1229 of file ChimeClient.h.
A Callable wrapper for ListRoomMemberships that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1220 of file ChimeClient.h.
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.
nullptr
An Async wrapper for ListRooms that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1256 of file ChimeClient.h.
A Callable wrapper for ListRooms that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1247 of file ChimeClient.h.
nullptr
An Async wrapper for ListSupportedPhoneNumberCountries that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1281 of file ChimeClient.h.
A Callable wrapper for ListSupportedPhoneNumberCountries that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1272 of file ChimeClient.h.
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.
nullptr
An Async wrapper for ListUsers that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1308 of file ChimeClient.h.
A Callable wrapper for ListUsers that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1299 of file ChimeClient.h.
Logs out the specified user from all of the devices they are currently logged into.
nullptr
An Async wrapper for LogoutUser that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1334 of file ChimeClient.h.
A Callable wrapper for LogoutUser that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1325 of file ChimeClient.h.
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.
nullptr
An Async wrapper for PutEventsConfiguration that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1361 of file ChimeClient.h.
A Callable wrapper for PutEventsConfiguration that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1352 of file ChimeClient.h.
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.
nullptr
An Async wrapper for PutRetentionSettings that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1397 of file ChimeClient.h.
A Callable wrapper for PutRetentionSettings that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1388 of file ChimeClient.h.
Redacts the specified message from the specified Amazon Chime conversation.
nullptr
An Async wrapper for RedactConversationMessage that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1423 of file ChimeClient.h.
A Callable wrapper for RedactConversationMessage that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1414 of file ChimeClient.h.
nullptr
An Async wrapper for RedactRoomMessage that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1449 of file ChimeClient.h.
A Callable wrapper for RedactRoomMessage that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1440 of file ChimeClient.h.
nullptr
An Async wrapper for RegenerateSecurityToken that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1474 of file ChimeClient.h.
A Callable wrapper for RegenerateSecurityToken that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1465 of file ChimeClient.h.
Resets the personal meeting PIN for the specified user on an Amazon Chime account. Returns the User object with the updated personal meeting PIN.
nullptr
An Async wrapper for ResetPersonalPIN that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1501 of file ChimeClient.h.
A Callable wrapper for ResetPersonalPIN that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1492 of file ChimeClient.h.
Moves a phone number from the Deletion queue back into the phone number Inventory.
nullptr
An Async wrapper for RestorePhoneNumber that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1527 of file ChimeClient.h.
A Callable wrapper for RestorePhoneNumber that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1518 of file ChimeClient.h.
{}
)
const
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.
nullptr
,
{}
An Async wrapper for SearchAvailablePhoneNumbers that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1557 of file ChimeClient.h.
{}
)
const
A Callable wrapper for SearchAvailablePhoneNumbers that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1548 of file ChimeClient.h.
Updates account details for the specified Amazon Chime account. Currently, only account name and default license updates are supported for this action.
nullptr
An Async wrapper for UpdateAccount that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1584 of file ChimeClient.h.
A Callable wrapper for UpdateAccount that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1575 of file ChimeClient.h.
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.
nullptr
An Async wrapper for UpdateAccountSettings that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1614 of file ChimeClient.h.
A Callable wrapper for UpdateAccountSettings that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1605 of file ChimeClient.h.
Updates the status of the specified bot, such as starting or stopping the bot from running in your Amazon Chime Enterprise account.
nullptr
An Async wrapper for UpdateBot that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1640 of file ChimeClient.h.
A Callable wrapper for UpdateBot that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1631 of file ChimeClient.h.
{}
)
const
nullptr
,
{}
An Async wrapper for UpdateGlobalSettings that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1667 of file ChimeClient.h.
{}
)
const
A Callable wrapper for UpdateGlobalSettings that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1658 of file ChimeClient.h.
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.
nullptr
An Async wrapper for UpdatePhoneNumber that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1700 of file ChimeClient.h.
A Callable wrapper for UpdatePhoneNumber that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1691 of file ChimeClient.h.
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.
nullptr
An Async wrapper for UpdatePhoneNumberSettings that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1728 of file ChimeClient.h.
A Callable wrapper for UpdatePhoneNumberSettings that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1719 of file ChimeClient.h.
Updates room details, such as the room name, for a room in an Amazon Chime Enterprise account.
nullptr
An Async wrapper for UpdateRoom that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1754 of file ChimeClient.h.
A Callable wrapper for UpdateRoom that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1745 of file ChimeClient.h.
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.
nullptr
An Async wrapper for UpdateRoomMembership that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1782 of file ChimeClient.h.
A Callable wrapper for UpdateRoomMembership that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1773 of file ChimeClient.h.
Updates user details for a specified user ID. Currently, only LicenseType
updates are supported for this action.
nullptr
An Async wrapper for UpdateUser that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1809 of file ChimeClient.h.
A Callable wrapper for UpdateUser that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1800 of file ChimeClient.h.
Updates the settings for the specified user, such as phone number settings.
nullptr
An Async wrapper for UpdateUserSettings that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1835 of file ChimeClient.h.
A Callable wrapper for UpdateUserSettings that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1826 of file ChimeClient.h.
Definition at line 1842 of file ChimeClient.h.