UNPKG

101 kBTypeScriptView Raw
1import {Request} from '../lib/request';
2import {Response} from '../lib/response';
3import {AWSError} from '../lib/error';
4import {Service} from '../lib/service';
5import {ServiceConfigurationOptions} from '../lib/service';
6import {ConfigBase as Config} from '../lib/config';
7interface Blob {}
8declare class Chime extends Service {
9 /**
10 * Constructs a service object. This object has one method for each API operation.
11 */
12 constructor(options?: Chime.Types.ClientConfiguration)
13 config: Config & Chime.Types.ClientConfiguration;
14 /**
15 * Associates a phone number with the specified Amazon Chime user.
16 */
17 associatePhoneNumberWithUser(params: Chime.Types.AssociatePhoneNumberWithUserRequest, callback?: (err: AWSError, data: Chime.Types.AssociatePhoneNumberWithUserResponse) => void): Request<Chime.Types.AssociatePhoneNumberWithUserResponse, AWSError>;
18 /**
19 * Associates a phone number with the specified Amazon Chime user.
20 */
21 associatePhoneNumberWithUser(callback?: (err: AWSError, data: Chime.Types.AssociatePhoneNumberWithUserResponse) => void): Request<Chime.Types.AssociatePhoneNumberWithUserResponse, AWSError>;
22 /**
23 * Associates phone numbers with the specified Amazon Chime Voice Connector.
24 */
25 associatePhoneNumbersWithVoiceConnector(params: Chime.Types.AssociatePhoneNumbersWithVoiceConnectorRequest, callback?: (err: AWSError, data: Chime.Types.AssociatePhoneNumbersWithVoiceConnectorResponse) => void): Request<Chime.Types.AssociatePhoneNumbersWithVoiceConnectorResponse, AWSError>;
26 /**
27 * Associates phone numbers with the specified Amazon Chime Voice Connector.
28 */
29 associatePhoneNumbersWithVoiceConnector(callback?: (err: AWSError, data: Chime.Types.AssociatePhoneNumbersWithVoiceConnectorResponse) => void): Request<Chime.Types.AssociatePhoneNumbersWithVoiceConnectorResponse, AWSError>;
30 /**
31 * Associates phone numbers with the specified Amazon Chime Voice Connector group.
32 */
33 associatePhoneNumbersWithVoiceConnectorGroup(params: Chime.Types.AssociatePhoneNumbersWithVoiceConnectorGroupRequest, callback?: (err: AWSError, data: Chime.Types.AssociatePhoneNumbersWithVoiceConnectorGroupResponse) => void): Request<Chime.Types.AssociatePhoneNumbersWithVoiceConnectorGroupResponse, AWSError>;
34 /**
35 * Associates phone numbers with the specified Amazon Chime Voice Connector group.
36 */
37 associatePhoneNumbersWithVoiceConnectorGroup(callback?: (err: AWSError, data: Chime.Types.AssociatePhoneNumbersWithVoiceConnectorGroupResponse) => void): Request<Chime.Types.AssociatePhoneNumbersWithVoiceConnectorGroupResponse, AWSError>;
38 /**
39 * 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.
40 */
41 batchDeletePhoneNumber(params: Chime.Types.BatchDeletePhoneNumberRequest, callback?: (err: AWSError, data: Chime.Types.BatchDeletePhoneNumberResponse) => void): Request<Chime.Types.BatchDeletePhoneNumberResponse, AWSError>;
42 /**
43 * 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.
44 */
45 batchDeletePhoneNumber(callback?: (err: AWSError, data: Chime.Types.BatchDeletePhoneNumberResponse) => void): Request<Chime.Types.BatchDeletePhoneNumberResponse, AWSError>;
46 /**
47 * 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 dissasociated 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.
48 */
49 batchSuspendUser(params: Chime.Types.BatchSuspendUserRequest, callback?: (err: AWSError, data: Chime.Types.BatchSuspendUserResponse) => void): Request<Chime.Types.BatchSuspendUserResponse, AWSError>;
50 /**
51 * 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 dissasociated 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.
52 */
53 batchSuspendUser(callback?: (err: AWSError, data: Chime.Types.BatchSuspendUserResponse) => void): Request<Chime.Types.BatchSuspendUserResponse, AWSError>;
54 /**
55 * Removes the suspension from up to 50 previously suspended users for the specified Amazon Chime EnterpriseLWA account. Only users on EnterpriseLWA accounts can be unsuspended using this action. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide. Previously suspended users who are unsuspended using this action are returned to Registered status. Users who are not previously suspended are ignored.
56 */
57 batchUnsuspendUser(params: Chime.Types.BatchUnsuspendUserRequest, callback?: (err: AWSError, data: Chime.Types.BatchUnsuspendUserResponse) => void): Request<Chime.Types.BatchUnsuspendUserResponse, AWSError>;
58 /**
59 * Removes the suspension from up to 50 previously suspended users for the specified Amazon Chime EnterpriseLWA account. Only users on EnterpriseLWA accounts can be unsuspended using this action. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide. Previously suspended users who are unsuspended using this action are returned to Registered status. Users who are not previously suspended are ignored.
60 */
61 batchUnsuspendUser(callback?: (err: AWSError, data: Chime.Types.BatchUnsuspendUserResponse) => void): Request<Chime.Types.BatchUnsuspendUserResponse, AWSError>;
62 /**
63 * Updates phone number product types or calling names. You can update one attribute at a time for each UpdatePhoneNumberRequestItem. For example, you can update either the product type or the calling name. For product types, choose from Amazon Chime Business Calling and Amazon Chime Voice Connector. For toll-free numbers, you must use the Amazon Chime Voice Connector product type. Updates to outbound calling names can take up to 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update.
64 */
65 batchUpdatePhoneNumber(params: Chime.Types.BatchUpdatePhoneNumberRequest, callback?: (err: AWSError, data: Chime.Types.BatchUpdatePhoneNumberResponse) => void): Request<Chime.Types.BatchUpdatePhoneNumberResponse, AWSError>;
66 /**
67 * Updates phone number product types or calling names. You can update one attribute at a time for each UpdatePhoneNumberRequestItem. For example, you can update either the product type or the calling name. For product types, choose from Amazon Chime Business Calling and Amazon Chime Voice Connector. For toll-free numbers, you must use the Amazon Chime Voice Connector product type. Updates to outbound calling names can take up to 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update.
68 */
69 batchUpdatePhoneNumber(callback?: (err: AWSError, data: Chime.Types.BatchUpdatePhoneNumberResponse) => void): Request<Chime.Types.BatchUpdatePhoneNumberResponse, AWSError>;
70 /**
71 * 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.
72 */
73 batchUpdateUser(params: Chime.Types.BatchUpdateUserRequest, callback?: (err: AWSError, data: Chime.Types.BatchUpdateUserResponse) => void): Request<Chime.Types.BatchUpdateUserResponse, AWSError>;
74 /**
75 * 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.
76 */
77 batchUpdateUser(callback?: (err: AWSError, data: Chime.Types.BatchUpdateUserResponse) => void): Request<Chime.Types.BatchUpdateUserResponse, AWSError>;
78 /**
79 * 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.
80 */
81 createAccount(params: Chime.Types.CreateAccountRequest, callback?: (err: AWSError, data: Chime.Types.CreateAccountResponse) => void): Request<Chime.Types.CreateAccountResponse, AWSError>;
82 /**
83 * 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.
84 */
85 createAccount(callback?: (err: AWSError, data: Chime.Types.CreateAccountResponse) => void): Request<Chime.Types.CreateAccountResponse, AWSError>;
86 /**
87 * Creates a bot for an Amazon Chime Enterprise account.
88 */
89 createBot(params: Chime.Types.CreateBotRequest, callback?: (err: AWSError, data: Chime.Types.CreateBotResponse) => void): Request<Chime.Types.CreateBotResponse, AWSError>;
90 /**
91 * Creates a bot for an Amazon Chime Enterprise account.
92 */
93 createBot(callback?: (err: AWSError, data: Chime.Types.CreateBotResponse) => void): Request<Chime.Types.CreateBotResponse, AWSError>;
94 /**
95 * Creates an order for phone numbers to be provisioned. Choose from Amazon Chime Business Calling and Amazon Chime Voice Connector product types. For toll-free numbers, you must use the Amazon Chime Voice Connector product type.
96 */
97 createPhoneNumberOrder(params: Chime.Types.CreatePhoneNumberOrderRequest, callback?: (err: AWSError, data: Chime.Types.CreatePhoneNumberOrderResponse) => void): Request<Chime.Types.CreatePhoneNumberOrderResponse, AWSError>;
98 /**
99 * Creates an order for phone numbers to be provisioned. Choose from Amazon Chime Business Calling and Amazon Chime Voice Connector product types. For toll-free numbers, you must use the Amazon Chime Voice Connector product type.
100 */
101 createPhoneNumberOrder(callback?: (err: AWSError, data: Chime.Types.CreatePhoneNumberOrderResponse) => void): Request<Chime.Types.CreatePhoneNumberOrderResponse, AWSError>;
102 /**
103 * 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.
104 */
105 createVoiceConnector(params: Chime.Types.CreateVoiceConnectorRequest, callback?: (err: AWSError, data: Chime.Types.CreateVoiceConnectorResponse) => void): Request<Chime.Types.CreateVoiceConnectorResponse, AWSError>;
106 /**
107 * 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.
108 */
109 createVoiceConnector(callback?: (err: AWSError, data: Chime.Types.CreateVoiceConnectorResponse) => void): Request<Chime.Types.CreateVoiceConnectorResponse, AWSError>;
110 /**
111 * Creates an Amazon Chime Voice Connector group under the administrator's AWS account. You can associate up to three existing 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.
112 */
113 createVoiceConnectorGroup(params: Chime.Types.CreateVoiceConnectorGroupRequest, callback?: (err: AWSError, data: Chime.Types.CreateVoiceConnectorGroupResponse) => void): Request<Chime.Types.CreateVoiceConnectorGroupResponse, AWSError>;
114 /**
115 * Creates an Amazon Chime Voice Connector group under the administrator's AWS account. You can associate up to three existing 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.
116 */
117 createVoiceConnectorGroup(callback?: (err: AWSError, data: Chime.Types.CreateVoiceConnectorGroupResponse) => void): Request<Chime.Types.CreateVoiceConnectorGroupResponse, AWSError>;
118 /**
119 * Deletes the specified Amazon Chime account. You must suspend all users before deleting a Team account. You can use the BatchSuspendUser action to do so. For EnterpriseLWA and EnterpriseAD accounts, you must release the claimed domains for your Amazon Chime account before deletion. As soon as you release the domain, all users under that account are suspended. Deleted accounts appear in your Disabled accounts list for 90 days. To restore a deleted account from your Disabled accounts list, you must contact AWS Support. After 90 days, deleted accounts are permanently removed from your Disabled accounts list.
120 */
121 deleteAccount(params: Chime.Types.DeleteAccountRequest, callback?: (err: AWSError, data: Chime.Types.DeleteAccountResponse) => void): Request<Chime.Types.DeleteAccountResponse, AWSError>;
122 /**
123 * Deletes the specified Amazon Chime account. You must suspend all users before deleting a Team account. You can use the BatchSuspendUser action to do so. For EnterpriseLWA and EnterpriseAD accounts, you must release the claimed domains for your Amazon Chime account before deletion. As soon as you release the domain, all users under that account are suspended. Deleted accounts appear in your Disabled accounts list for 90 days. To restore a deleted account from your Disabled accounts list, you must contact AWS Support. After 90 days, deleted accounts are permanently removed from your Disabled accounts list.
124 */
125 deleteAccount(callback?: (err: AWSError, data: Chime.Types.DeleteAccountResponse) => void): Request<Chime.Types.DeleteAccountResponse, AWSError>;
126 /**
127 * Deletes the events configuration that allows a bot to receive outgoing events.
128 */
129 deleteEventsConfiguration(params: Chime.Types.DeleteEventsConfigurationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
130 /**
131 * Deletes the events configuration that allows a bot to receive outgoing events.
132 */
133 deleteEventsConfiguration(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
134 /**
135 * 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.
136 */
137 deletePhoneNumber(params: Chime.Types.DeletePhoneNumberRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
138 /**
139 * 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.
140 */
141 deletePhoneNumber(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
142 /**
143 * 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.
144 */
145 deleteVoiceConnector(params: Chime.Types.DeleteVoiceConnectorRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
146 /**
147 * 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.
148 */
149 deleteVoiceConnector(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
150 /**
151 * 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.
152 */
153 deleteVoiceConnectorGroup(params: Chime.Types.DeleteVoiceConnectorGroupRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
154 /**
155 * 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.
156 */
157 deleteVoiceConnectorGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
158 /**
159 * Deletes the origination settings for the specified Amazon Chime Voice Connector.
160 */
161 deleteVoiceConnectorOrigination(params: Chime.Types.DeleteVoiceConnectorOriginationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
162 /**
163 * Deletes the origination settings for the specified Amazon Chime Voice Connector.
164 */
165 deleteVoiceConnectorOrigination(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
166 /**
167 * Deletes the streaming configuration for the specified Amazon Chime Voice Connector.
168 */
169 deleteVoiceConnectorStreamingConfiguration(params: Chime.Types.DeleteVoiceConnectorStreamingConfigurationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
170 /**
171 * Deletes the streaming configuration for the specified Amazon Chime Voice Connector.
172 */
173 deleteVoiceConnectorStreamingConfiguration(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
174 /**
175 * Deletes the termination settings for the specified Amazon Chime Voice Connector.
176 */
177 deleteVoiceConnectorTermination(params: Chime.Types.DeleteVoiceConnectorTerminationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
178 /**
179 * Deletes the termination settings for the specified Amazon Chime Voice Connector.
180 */
181 deleteVoiceConnectorTermination(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
182 /**
183 * Deletes the specified SIP credentials used by your equipment to authenticate during call termination.
184 */
185 deleteVoiceConnectorTerminationCredentials(params: Chime.Types.DeleteVoiceConnectorTerminationCredentialsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
186 /**
187 * Deletes the specified SIP credentials used by your equipment to authenticate during call termination.
188 */
189 deleteVoiceConnectorTerminationCredentials(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
190 /**
191 * Disassociates the primary provisioned phone number from the specified Amazon Chime user.
192 */
193 disassociatePhoneNumberFromUser(params: Chime.Types.DisassociatePhoneNumberFromUserRequest, callback?: (err: AWSError, data: Chime.Types.DisassociatePhoneNumberFromUserResponse) => void): Request<Chime.Types.DisassociatePhoneNumberFromUserResponse, AWSError>;
194 /**
195 * Disassociates the primary provisioned phone number from the specified Amazon Chime user.
196 */
197 disassociatePhoneNumberFromUser(callback?: (err: AWSError, data: Chime.Types.DisassociatePhoneNumberFromUserResponse) => void): Request<Chime.Types.DisassociatePhoneNumberFromUserResponse, AWSError>;
198 /**
199 * Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector.
200 */
201 disassociatePhoneNumbersFromVoiceConnector(params: Chime.Types.DisassociatePhoneNumbersFromVoiceConnectorRequest, callback?: (err: AWSError, data: Chime.Types.DisassociatePhoneNumbersFromVoiceConnectorResponse) => void): Request<Chime.Types.DisassociatePhoneNumbersFromVoiceConnectorResponse, AWSError>;
202 /**
203 * Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector.
204 */
205 disassociatePhoneNumbersFromVoiceConnector(callback?: (err: AWSError, data: Chime.Types.DisassociatePhoneNumbersFromVoiceConnectorResponse) => void): Request<Chime.Types.DisassociatePhoneNumbersFromVoiceConnectorResponse, AWSError>;
206 /**
207 * Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector group.
208 */
209 disassociatePhoneNumbersFromVoiceConnectorGroup(params: Chime.Types.DisassociatePhoneNumbersFromVoiceConnectorGroupRequest, callback?: (err: AWSError, data: Chime.Types.DisassociatePhoneNumbersFromVoiceConnectorGroupResponse) => void): Request<Chime.Types.DisassociatePhoneNumbersFromVoiceConnectorGroupResponse, AWSError>;
210 /**
211 * Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector group.
212 */
213 disassociatePhoneNumbersFromVoiceConnectorGroup(callback?: (err: AWSError, data: Chime.Types.DisassociatePhoneNumbersFromVoiceConnectorGroupResponse) => void): Request<Chime.Types.DisassociatePhoneNumbersFromVoiceConnectorGroupResponse, AWSError>;
214 /**
215 * Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.
216 */
217 getAccount(params: Chime.Types.GetAccountRequest, callback?: (err: AWSError, data: Chime.Types.GetAccountResponse) => void): Request<Chime.Types.GetAccountResponse, AWSError>;
218 /**
219 * Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.
220 */
221 getAccount(callback?: (err: AWSError, data: Chime.Types.GetAccountResponse) => void): Request<Chime.Types.GetAccountResponse, AWSError>;
222 /**
223 * Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dial out settings. For more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide.
224 */
225 getAccountSettings(params: Chime.Types.GetAccountSettingsRequest, callback?: (err: AWSError, data: Chime.Types.GetAccountSettingsResponse) => void): Request<Chime.Types.GetAccountSettingsResponse, AWSError>;
226 /**
227 * Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dial out settings. For more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide.
228 */
229 getAccountSettings(callback?: (err: AWSError, data: Chime.Types.GetAccountSettingsResponse) => void): Request<Chime.Types.GetAccountSettingsResponse, AWSError>;
230 /**
231 * Retrieves details for the specified bot, such as bot email address, bot type, status, and display name.
232 */
233 getBot(params: Chime.Types.GetBotRequest, callback?: (err: AWSError, data: Chime.Types.GetBotResponse) => void): Request<Chime.Types.GetBotResponse, AWSError>;
234 /**
235 * Retrieves details for the specified bot, such as bot email address, bot type, status, and display name.
236 */
237 getBot(callback?: (err: AWSError, data: Chime.Types.GetBotResponse) => void): Request<Chime.Types.GetBotResponse, AWSError>;
238 /**
239 * Gets details for an events configuration that allows a bot to receive outgoing events, such as an HTTPS endpoint or Lambda function ARN.
240 */
241 getEventsConfiguration(params: Chime.Types.GetEventsConfigurationRequest, callback?: (err: AWSError, data: Chime.Types.GetEventsConfigurationResponse) => void): Request<Chime.Types.GetEventsConfigurationResponse, AWSError>;
242 /**
243 * Gets details for an events configuration that allows a bot to receive outgoing events, such as an HTTPS endpoint or Lambda function ARN.
244 */
245 getEventsConfiguration(callback?: (err: AWSError, data: Chime.Types.GetEventsConfigurationResponse) => void): Request<Chime.Types.GetEventsConfigurationResponse, AWSError>;
246 /**
247 * Retrieves global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.
248 */
249 getGlobalSettings(callback?: (err: AWSError, data: Chime.Types.GetGlobalSettingsResponse) => void): Request<Chime.Types.GetGlobalSettingsResponse, AWSError>;
250 /**
251 * Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.
252 */
253 getPhoneNumber(params: Chime.Types.GetPhoneNumberRequest, callback?: (err: AWSError, data: Chime.Types.GetPhoneNumberResponse) => void): Request<Chime.Types.GetPhoneNumberResponse, AWSError>;
254 /**
255 * Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.
256 */
257 getPhoneNumber(callback?: (err: AWSError, data: Chime.Types.GetPhoneNumberResponse) => void): Request<Chime.Types.GetPhoneNumberResponse, AWSError>;
258 /**
259 * Retrieves details for the specified phone number order, such as order creation timestamp, phone numbers in E.164 format, product type, and order status.
260 */
261 getPhoneNumberOrder(params: Chime.Types.GetPhoneNumberOrderRequest, callback?: (err: AWSError, data: Chime.Types.GetPhoneNumberOrderResponse) => void): Request<Chime.Types.GetPhoneNumberOrderResponse, AWSError>;
262 /**
263 * Retrieves details for the specified phone number order, such as order creation timestamp, phone numbers in E.164 format, product type, and order status.
264 */
265 getPhoneNumberOrder(callback?: (err: AWSError, data: Chime.Types.GetPhoneNumberOrderResponse) => void): Request<Chime.Types.GetPhoneNumberOrderResponse, AWSError>;
266 /**
267 * Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.
268 */
269 getPhoneNumberSettings(callback?: (err: AWSError, data: Chime.Types.GetPhoneNumberSettingsResponse) => void): Request<Chime.Types.GetPhoneNumberSettingsResponse, AWSError>;
270 /**
271 * 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.
272 */
273 getUser(params: Chime.Types.GetUserRequest, callback?: (err: AWSError, data: Chime.Types.GetUserResponse) => void): Request<Chime.Types.GetUserResponse, AWSError>;
274 /**
275 * 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.
276 */
277 getUser(callback?: (err: AWSError, data: Chime.Types.GetUserResponse) => void): Request<Chime.Types.GetUserResponse, AWSError>;
278 /**
279 * Retrieves settings for the specified user ID, such as any associated phone number settings.
280 */
281 getUserSettings(params: Chime.Types.GetUserSettingsRequest, callback?: (err: AWSError, data: Chime.Types.GetUserSettingsResponse) => void): Request<Chime.Types.GetUserSettingsResponse, AWSError>;
282 /**
283 * Retrieves settings for the specified user ID, such as any associated phone number settings.
284 */
285 getUserSettings(callback?: (err: AWSError, data: Chime.Types.GetUserSettingsResponse) => void): Request<Chime.Types.GetUserSettingsResponse, AWSError>;
286 /**
287 * Retrieves details for the specified Amazon Chime Voice Connector, such as timestamps, name, outbound host, and encryption requirements.
288 */
289 getVoiceConnector(params: Chime.Types.GetVoiceConnectorRequest, callback?: (err: AWSError, data: Chime.Types.GetVoiceConnectorResponse) => void): Request<Chime.Types.GetVoiceConnectorResponse, AWSError>;
290 /**
291 * Retrieves details for the specified Amazon Chime Voice Connector, such as timestamps, name, outbound host, and encryption requirements.
292 */
293 getVoiceConnector(callback?: (err: AWSError, data: Chime.Types.GetVoiceConnectorResponse) => void): Request<Chime.Types.GetVoiceConnectorResponse, AWSError>;
294 /**
295 * Retrieves details for the specified Amazon Chime Voice Connector group, such as timestamps, name, and associated VoiceConnectorItems.
296 */
297 getVoiceConnectorGroup(params: Chime.Types.GetVoiceConnectorGroupRequest, callback?: (err: AWSError, data: Chime.Types.GetVoiceConnectorGroupResponse) => void): Request<Chime.Types.GetVoiceConnectorGroupResponse, AWSError>;
298 /**
299 * Retrieves details for the specified Amazon Chime Voice Connector group, such as timestamps, name, and associated VoiceConnectorItems.
300 */
301 getVoiceConnectorGroup(callback?: (err: AWSError, data: Chime.Types.GetVoiceConnectorGroupResponse) => void): Request<Chime.Types.GetVoiceConnectorGroupResponse, AWSError>;
302 /**
303 * 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.
304 */
305 getVoiceConnectorLoggingConfiguration(params: Chime.Types.GetVoiceConnectorLoggingConfigurationRequest, callback?: (err: AWSError, data: Chime.Types.GetVoiceConnectorLoggingConfigurationResponse) => void): Request<Chime.Types.GetVoiceConnectorLoggingConfigurationResponse, AWSError>;
306 /**
307 * 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.
308 */
309 getVoiceConnectorLoggingConfiguration(callback?: (err: AWSError, data: Chime.Types.GetVoiceConnectorLoggingConfigurationResponse) => void): Request<Chime.Types.GetVoiceConnectorLoggingConfigurationResponse, AWSError>;
310 /**
311 * Retrieves origination setting details for the specified Amazon Chime Voice Connector.
312 */
313 getVoiceConnectorOrigination(params: Chime.Types.GetVoiceConnectorOriginationRequest, callback?: (err: AWSError, data: Chime.Types.GetVoiceConnectorOriginationResponse) => void): Request<Chime.Types.GetVoiceConnectorOriginationResponse, AWSError>;
314 /**
315 * Retrieves origination setting details for the specified Amazon Chime Voice Connector.
316 */
317 getVoiceConnectorOrigination(callback?: (err: AWSError, data: Chime.Types.GetVoiceConnectorOriginationResponse) => void): Request<Chime.Types.GetVoiceConnectorOriginationResponse, AWSError>;
318 /**
319 * Retrieves the streaming configuration details for the specified Amazon Chime Voice Connector. Shows whether media streaming is enabled for sending to Amazon Kinesis, and shows the retention period for the Amazon Kinesis data, in hours.
320 */
321 getVoiceConnectorStreamingConfiguration(params: Chime.Types.GetVoiceConnectorStreamingConfigurationRequest, callback?: (err: AWSError, data: Chime.Types.GetVoiceConnectorStreamingConfigurationResponse) => void): Request<Chime.Types.GetVoiceConnectorStreamingConfigurationResponse, AWSError>;
322 /**
323 * Retrieves the streaming configuration details for the specified Amazon Chime Voice Connector. Shows whether media streaming is enabled for sending to Amazon Kinesis, and shows the retention period for the Amazon Kinesis data, in hours.
324 */
325 getVoiceConnectorStreamingConfiguration(callback?: (err: AWSError, data: Chime.Types.GetVoiceConnectorStreamingConfigurationResponse) => void): Request<Chime.Types.GetVoiceConnectorStreamingConfigurationResponse, AWSError>;
326 /**
327 * Retrieves termination setting details for the specified Amazon Chime Voice Connector.
328 */
329 getVoiceConnectorTermination(params: Chime.Types.GetVoiceConnectorTerminationRequest, callback?: (err: AWSError, data: Chime.Types.GetVoiceConnectorTerminationResponse) => void): Request<Chime.Types.GetVoiceConnectorTerminationResponse, AWSError>;
330 /**
331 * Retrieves termination setting details for the specified Amazon Chime Voice Connector.
332 */
333 getVoiceConnectorTermination(callback?: (err: AWSError, data: Chime.Types.GetVoiceConnectorTerminationResponse) => void): Request<Chime.Types.GetVoiceConnectorTerminationResponse, AWSError>;
334 /**
335 * Retrieves information about the last time a SIP OPTIONS ping was received from your SIP infrastructure for the specified Amazon Chime Voice Connector.
336 */
337 getVoiceConnectorTerminationHealth(params: Chime.Types.GetVoiceConnectorTerminationHealthRequest, callback?: (err: AWSError, data: Chime.Types.GetVoiceConnectorTerminationHealthResponse) => void): Request<Chime.Types.GetVoiceConnectorTerminationHealthResponse, AWSError>;
338 /**
339 * Retrieves information about the last time a SIP OPTIONS ping was received from your SIP infrastructure for the specified Amazon Chime Voice Connector.
340 */
341 getVoiceConnectorTerminationHealth(callback?: (err: AWSError, data: Chime.Types.GetVoiceConnectorTerminationHealthResponse) => void): Request<Chime.Types.GetVoiceConnectorTerminationHealthResponse, AWSError>;
342 /**
343 * Sends email invites to as many as 50 users, inviting them to the specified Amazon Chime Team account. Only Team account types are currently supported for this action.
344 */
345 inviteUsers(params: Chime.Types.InviteUsersRequest, callback?: (err: AWSError, data: Chime.Types.InviteUsersResponse) => void): Request<Chime.Types.InviteUsersResponse, AWSError>;
346 /**
347 * Sends email invites to as many as 50 users, inviting them to the specified Amazon Chime Team account. Only Team account types are currently supported for this action.
348 */
349 inviteUsers(callback?: (err: AWSError, data: Chime.Types.InviteUsersResponse) => void): Request<Chime.Types.InviteUsersResponse, AWSError>;
350 /**
351 * 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.
352 */
353 listAccounts(params: Chime.Types.ListAccountsRequest, callback?: (err: AWSError, data: Chime.Types.ListAccountsResponse) => void): Request<Chime.Types.ListAccountsResponse, AWSError>;
354 /**
355 * 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.
356 */
357 listAccounts(callback?: (err: AWSError, data: Chime.Types.ListAccountsResponse) => void): Request<Chime.Types.ListAccountsResponse, AWSError>;
358 /**
359 * Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.
360 */
361 listBots(params: Chime.Types.ListBotsRequest, callback?: (err: AWSError, data: Chime.Types.ListBotsResponse) => void): Request<Chime.Types.ListBotsResponse, AWSError>;
362 /**
363 * Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.
364 */
365 listBots(callback?: (err: AWSError, data: Chime.Types.ListBotsResponse) => void): Request<Chime.Types.ListBotsResponse, AWSError>;
366 /**
367 * Lists the phone number orders for the administrator's Amazon Chime account.
368 */
369 listPhoneNumberOrders(params: Chime.Types.ListPhoneNumberOrdersRequest, callback?: (err: AWSError, data: Chime.Types.ListPhoneNumberOrdersResponse) => void): Request<Chime.Types.ListPhoneNumberOrdersResponse, AWSError>;
370 /**
371 * Lists the phone number orders for the administrator's Amazon Chime account.
372 */
373 listPhoneNumberOrders(callback?: (err: AWSError, data: Chime.Types.ListPhoneNumberOrdersResponse) => void): Request<Chime.Types.ListPhoneNumberOrdersResponse, AWSError>;
374 /**
375 * Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, Amazon Chime Voice Connector, or Amazon Chime Voice Connector group.
376 */
377 listPhoneNumbers(params: Chime.Types.ListPhoneNumbersRequest, callback?: (err: AWSError, data: Chime.Types.ListPhoneNumbersResponse) => void): Request<Chime.Types.ListPhoneNumbersResponse, AWSError>;
378 /**
379 * Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, Amazon Chime Voice Connector, or Amazon Chime Voice Connector group.
380 */
381 listPhoneNumbers(callback?: (err: AWSError, data: Chime.Types.ListPhoneNumbersResponse) => void): Request<Chime.Types.ListPhoneNumbersResponse, AWSError>;
382 /**
383 * 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.
384 */
385 listUsers(params: Chime.Types.ListUsersRequest, callback?: (err: AWSError, data: Chime.Types.ListUsersResponse) => void): Request<Chime.Types.ListUsersResponse, AWSError>;
386 /**
387 * 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.
388 */
389 listUsers(callback?: (err: AWSError, data: Chime.Types.ListUsersResponse) => void): Request<Chime.Types.ListUsersResponse, AWSError>;
390 /**
391 * Lists the Amazon Chime Voice Connector groups for the administrator's AWS account.
392 */
393 listVoiceConnectorGroups(params: Chime.Types.ListVoiceConnectorGroupsRequest, callback?: (err: AWSError, data: Chime.Types.ListVoiceConnectorGroupsResponse) => void): Request<Chime.Types.ListVoiceConnectorGroupsResponse, AWSError>;
394 /**
395 * Lists the Amazon Chime Voice Connector groups for the administrator's AWS account.
396 */
397 listVoiceConnectorGroups(callback?: (err: AWSError, data: Chime.Types.ListVoiceConnectorGroupsResponse) => void): Request<Chime.Types.ListVoiceConnectorGroupsResponse, AWSError>;
398 /**
399 * Lists the SIP credentials for the specified Amazon Chime Voice Connector.
400 */
401 listVoiceConnectorTerminationCredentials(params: Chime.Types.ListVoiceConnectorTerminationCredentialsRequest, callback?: (err: AWSError, data: Chime.Types.ListVoiceConnectorTerminationCredentialsResponse) => void): Request<Chime.Types.ListVoiceConnectorTerminationCredentialsResponse, AWSError>;
402 /**
403 * Lists the SIP credentials for the specified Amazon Chime Voice Connector.
404 */
405 listVoiceConnectorTerminationCredentials(callback?: (err: AWSError, data: Chime.Types.ListVoiceConnectorTerminationCredentialsResponse) => void): Request<Chime.Types.ListVoiceConnectorTerminationCredentialsResponse, AWSError>;
406 /**
407 * Lists the Amazon Chime Voice Connectors for the administrator's AWS account.
408 */
409 listVoiceConnectors(params: Chime.Types.ListVoiceConnectorsRequest, callback?: (err: AWSError, data: Chime.Types.ListVoiceConnectorsResponse) => void): Request<Chime.Types.ListVoiceConnectorsResponse, AWSError>;
410 /**
411 * Lists the Amazon Chime Voice Connectors for the administrator's AWS account.
412 */
413 listVoiceConnectors(callback?: (err: AWSError, data: Chime.Types.ListVoiceConnectorsResponse) => void): Request<Chime.Types.ListVoiceConnectorsResponse, AWSError>;
414 /**
415 * Logs out the specified user from all of the devices they are currently logged into.
416 */
417 logoutUser(params: Chime.Types.LogoutUserRequest, callback?: (err: AWSError, data: Chime.Types.LogoutUserResponse) => void): Request<Chime.Types.LogoutUserResponse, AWSError>;
418 /**
419 * Logs out the specified user from all of the devices they are currently logged into.
420 */
421 logoutUser(callback?: (err: AWSError, data: Chime.Types.LogoutUserResponse) => void): Request<Chime.Types.LogoutUserResponse, AWSError>;
422 /**
423 * 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.
424 */
425 putEventsConfiguration(params: Chime.Types.PutEventsConfigurationRequest, callback?: (err: AWSError, data: Chime.Types.PutEventsConfigurationResponse) => void): Request<Chime.Types.PutEventsConfigurationResponse, AWSError>;
426 /**
427 * 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.
428 */
429 putEventsConfiguration(callback?: (err: AWSError, data: Chime.Types.PutEventsConfigurationResponse) => void): Request<Chime.Types.PutEventsConfigurationResponse, AWSError>;
430 /**
431 * 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.
432 */
433 putVoiceConnectorLoggingConfiguration(params: Chime.Types.PutVoiceConnectorLoggingConfigurationRequest, callback?: (err: AWSError, data: Chime.Types.PutVoiceConnectorLoggingConfigurationResponse) => void): Request<Chime.Types.PutVoiceConnectorLoggingConfigurationResponse, AWSError>;
434 /**
435 * 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.
436 */
437 putVoiceConnectorLoggingConfiguration(callback?: (err: AWSError, data: Chime.Types.PutVoiceConnectorLoggingConfigurationResponse) => void): Request<Chime.Types.PutVoiceConnectorLoggingConfigurationResponse, AWSError>;
438 /**
439 * Adds origination settings for the specified Amazon Chime Voice Connector.
440 */
441 putVoiceConnectorOrigination(params: Chime.Types.PutVoiceConnectorOriginationRequest, callback?: (err: AWSError, data: Chime.Types.PutVoiceConnectorOriginationResponse) => void): Request<Chime.Types.PutVoiceConnectorOriginationResponse, AWSError>;
442 /**
443 * Adds origination settings for the specified Amazon Chime Voice Connector.
444 */
445 putVoiceConnectorOrigination(callback?: (err: AWSError, data: Chime.Types.PutVoiceConnectorOriginationResponse) => void): Request<Chime.Types.PutVoiceConnectorOriginationResponse, AWSError>;
446 /**
447 * Adds a streaming configuration for the specified Amazon Chime Voice Connector. The streaming configuration specifies whether media streaming is enabled for sending to Amazon Kinesis, and sets the retention period for the Amazon Kinesis data, in hours.
448 */
449 putVoiceConnectorStreamingConfiguration(params: Chime.Types.PutVoiceConnectorStreamingConfigurationRequest, callback?: (err: AWSError, data: Chime.Types.PutVoiceConnectorStreamingConfigurationResponse) => void): Request<Chime.Types.PutVoiceConnectorStreamingConfigurationResponse, AWSError>;
450 /**
451 * Adds a streaming configuration for the specified Amazon Chime Voice Connector. The streaming configuration specifies whether media streaming is enabled for sending to Amazon Kinesis, and sets the retention period for the Amazon Kinesis data, in hours.
452 */
453 putVoiceConnectorStreamingConfiguration(callback?: (err: AWSError, data: Chime.Types.PutVoiceConnectorStreamingConfigurationResponse) => void): Request<Chime.Types.PutVoiceConnectorStreamingConfigurationResponse, AWSError>;
454 /**
455 * Adds termination settings for the specified Amazon Chime Voice Connector.
456 */
457 putVoiceConnectorTermination(params: Chime.Types.PutVoiceConnectorTerminationRequest, callback?: (err: AWSError, data: Chime.Types.PutVoiceConnectorTerminationResponse) => void): Request<Chime.Types.PutVoiceConnectorTerminationResponse, AWSError>;
458 /**
459 * Adds termination settings for the specified Amazon Chime Voice Connector.
460 */
461 putVoiceConnectorTermination(callback?: (err: AWSError, data: Chime.Types.PutVoiceConnectorTerminationResponse) => void): Request<Chime.Types.PutVoiceConnectorTerminationResponse, AWSError>;
462 /**
463 * Adds termination SIP credentials for the specified Amazon Chime Voice Connector.
464 */
465 putVoiceConnectorTerminationCredentials(params: Chime.Types.PutVoiceConnectorTerminationCredentialsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
466 /**
467 * Adds termination SIP credentials for the specified Amazon Chime Voice Connector.
468 */
469 putVoiceConnectorTerminationCredentials(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
470 /**
471 * Regenerates the security token for a bot.
472 */
473 regenerateSecurityToken(params: Chime.Types.RegenerateSecurityTokenRequest, callback?: (err: AWSError, data: Chime.Types.RegenerateSecurityTokenResponse) => void): Request<Chime.Types.RegenerateSecurityTokenResponse, AWSError>;
474 /**
475 * Regenerates the security token for a bot.
476 */
477 regenerateSecurityToken(callback?: (err: AWSError, data: Chime.Types.RegenerateSecurityTokenResponse) => void): Request<Chime.Types.RegenerateSecurityTokenResponse, AWSError>;
478 /**
479 * Resets the personal meeting PIN for the specified user on an Amazon Chime account. Returns the User object with the updated personal meeting PIN.
480 */
481 resetPersonalPIN(params: Chime.Types.ResetPersonalPINRequest, callback?: (err: AWSError, data: Chime.Types.ResetPersonalPINResponse) => void): Request<Chime.Types.ResetPersonalPINResponse, AWSError>;
482 /**
483 * Resets the personal meeting PIN for the specified user on an Amazon Chime account. Returns the User object with the updated personal meeting PIN.
484 */
485 resetPersonalPIN(callback?: (err: AWSError, data: Chime.Types.ResetPersonalPINResponse) => void): Request<Chime.Types.ResetPersonalPINResponse, AWSError>;
486 /**
487 * Moves a phone number from the Deletion queue back into the phone number Inventory.
488 */
489 restorePhoneNumber(params: Chime.Types.RestorePhoneNumberRequest, callback?: (err: AWSError, data: Chime.Types.RestorePhoneNumberResponse) => void): Request<Chime.Types.RestorePhoneNumberResponse, AWSError>;
490 /**
491 * Moves a phone number from the Deletion queue back into the phone number Inventory.
492 */
493 restorePhoneNumber(callback?: (err: AWSError, data: Chime.Types.RestorePhoneNumberResponse) => void): Request<Chime.Types.RestorePhoneNumberResponse, AWSError>;
494 /**
495 * Searches phone numbers that can be ordered.
496 */
497 searchAvailablePhoneNumbers(params: Chime.Types.SearchAvailablePhoneNumbersRequest, callback?: (err: AWSError, data: Chime.Types.SearchAvailablePhoneNumbersResponse) => void): Request<Chime.Types.SearchAvailablePhoneNumbersResponse, AWSError>;
498 /**
499 * Searches phone numbers that can be ordered.
500 */
501 searchAvailablePhoneNumbers(callback?: (err: AWSError, data: Chime.Types.SearchAvailablePhoneNumbersResponse) => void): Request<Chime.Types.SearchAvailablePhoneNumbersResponse, AWSError>;
502 /**
503 * Updates account details for the specified Amazon Chime account. Currently, only account name updates are supported for this action.
504 */
505 updateAccount(params: Chime.Types.UpdateAccountRequest, callback?: (err: AWSError, data: Chime.Types.UpdateAccountResponse) => void): Request<Chime.Types.UpdateAccountResponse, AWSError>;
506 /**
507 * Updates account details for the specified Amazon Chime account. Currently, only account name updates are supported for this action.
508 */
509 updateAccount(callback?: (err: AWSError, data: Chime.Types.UpdateAccountResponse) => void): Request<Chime.Types.UpdateAccountResponse, AWSError>;
510 /**
511 * 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.
512 */
513 updateAccountSettings(params: Chime.Types.UpdateAccountSettingsRequest, callback?: (err: AWSError, data: Chime.Types.UpdateAccountSettingsResponse) => void): Request<Chime.Types.UpdateAccountSettingsResponse, AWSError>;
514 /**
515 * 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.
516 */
517 updateAccountSettings(callback?: (err: AWSError, data: Chime.Types.UpdateAccountSettingsResponse) => void): Request<Chime.Types.UpdateAccountSettingsResponse, AWSError>;
518 /**
519 * Updates the status of the specified bot, such as starting or stopping the bot from running in your Amazon Chime Enterprise account.
520 */
521 updateBot(params: Chime.Types.UpdateBotRequest, callback?: (err: AWSError, data: Chime.Types.UpdateBotResponse) => void): Request<Chime.Types.UpdateBotResponse, AWSError>;
522 /**
523 * Updates the status of the specified bot, such as starting or stopping the bot from running in your Amazon Chime Enterprise account.
524 */
525 updateBot(callback?: (err: AWSError, data: Chime.Types.UpdateBotResponse) => void): Request<Chime.Types.UpdateBotResponse, AWSError>;
526 /**
527 * Updates global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.
528 */
529 updateGlobalSettings(params: Chime.Types.UpdateGlobalSettingsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
530 /**
531 * Updates global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.
532 */
533 updateGlobalSettings(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
534 /**
535 * Updates phone number details, such as product type or calling name, for the specified phone number ID. You can update one phone number detail at a time. For example, you can update either the product type or the calling name in one action. For toll-free numbers, you must use the Amazon Chime Voice Connector product type. Updates to outbound calling names can take up to 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update.
536 */
537 updatePhoneNumber(params: Chime.Types.UpdatePhoneNumberRequest, callback?: (err: AWSError, data: Chime.Types.UpdatePhoneNumberResponse) => void): Request<Chime.Types.UpdatePhoneNumberResponse, AWSError>;
538 /**
539 * Updates phone number details, such as product type or calling name, for the specified phone number ID. You can update one phone number detail at a time. For example, you can update either the product type or the calling name in one action. For toll-free numbers, you must use the Amazon Chime Voice Connector product type. Updates to outbound calling names can take up to 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update.
540 */
541 updatePhoneNumber(callback?: (err: AWSError, data: Chime.Types.UpdatePhoneNumberResponse) => void): Request<Chime.Types.UpdatePhoneNumberResponse, AWSError>;
542 /**
543 * 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 be updated.
544 */
545 updatePhoneNumberSettings(params: Chime.Types.UpdatePhoneNumberSettingsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
546 /**
547 * 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 be updated.
548 */
549 updatePhoneNumberSettings(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
550 /**
551 * Updates user details for a specified user ID. Currently, only LicenseType updates are supported for this action.
552 */
553 updateUser(params: Chime.Types.UpdateUserRequest, callback?: (err: AWSError, data: Chime.Types.UpdateUserResponse) => void): Request<Chime.Types.UpdateUserResponse, AWSError>;
554 /**
555 * Updates user details for a specified user ID. Currently, only LicenseType updates are supported for this action.
556 */
557 updateUser(callback?: (err: AWSError, data: Chime.Types.UpdateUserResponse) => void): Request<Chime.Types.UpdateUserResponse, AWSError>;
558 /**
559 * Updates the settings for the specified user, such as phone number settings.
560 */
561 updateUserSettings(params: Chime.Types.UpdateUserSettingsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
562 /**
563 * Updates the settings for the specified user, such as phone number settings.
564 */
565 updateUserSettings(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
566 /**
567 * Updates details for the specified Amazon Chime Voice Connector.
568 */
569 updateVoiceConnector(params: Chime.Types.UpdateVoiceConnectorRequest, callback?: (err: AWSError, data: Chime.Types.UpdateVoiceConnectorResponse) => void): Request<Chime.Types.UpdateVoiceConnectorResponse, AWSError>;
570 /**
571 * Updates details for the specified Amazon Chime Voice Connector.
572 */
573 updateVoiceConnector(callback?: (err: AWSError, data: Chime.Types.UpdateVoiceConnectorResponse) => void): Request<Chime.Types.UpdateVoiceConnectorResponse, AWSError>;
574 /**
575 * Updates details for the specified Amazon Chime Voice Connector group, such as the name and Amazon Chime Voice Connector priority ranking.
576 */
577 updateVoiceConnectorGroup(params: Chime.Types.UpdateVoiceConnectorGroupRequest, callback?: (err: AWSError, data: Chime.Types.UpdateVoiceConnectorGroupResponse) => void): Request<Chime.Types.UpdateVoiceConnectorGroupResponse, AWSError>;
578 /**
579 * Updates details for the specified Amazon Chime Voice Connector group, such as the name and Amazon Chime Voice Connector priority ranking.
580 */
581 updateVoiceConnectorGroup(callback?: (err: AWSError, data: Chime.Types.UpdateVoiceConnectorGroupResponse) => void): Request<Chime.Types.UpdateVoiceConnectorGroupResponse, AWSError>;
582}
583declare namespace Chime {
584 export interface Account {
585 /**
586 * The AWS account ID.
587 */
588 AwsAccountId: String;
589 /**
590 * The Amazon Chime account ID.
591 */
592 AccountId: String;
593 /**
594 * The Amazon Chime account name.
595 */
596 Name: String;
597 /**
598 * The Amazon Chime account type. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.
599 */
600 AccountType?: AccountType;
601 /**
602 * The Amazon Chime account creation timestamp, in ISO 8601 format.
603 */
604 CreatedTimestamp?: Iso8601Timestamp;
605 /**
606 * The default license for the Amazon Chime account.
607 */
608 DefaultLicense?: License;
609 /**
610 * Supported licenses for the Amazon Chime account.
611 */
612 SupportedLicenses?: LicenseList;
613 }
614 export type AccountList = Account[];
615 export type AccountName = string;
616 export interface AccountSettings {
617 /**
618 * Setting that stops or starts remote control of shared screens during meetings.
619 */
620 DisableRemoteControl?: Boolean;
621 /**
622 * Setting that allows meeting participants to choose the Call me at a phone number option. For more information, see Join a Meeting without the Amazon Chime App.
623 */
624 EnableDialOut?: Boolean;
625 }
626 export type AccountType = "Team"|"EnterpriseDirectory"|"EnterpriseLWA"|"EnterpriseOIDC"|string;
627 export interface AssociatePhoneNumberWithUserRequest {
628 /**
629 * The Amazon Chime account ID.
630 */
631 AccountId: String;
632 /**
633 * The user ID.
634 */
635 UserId: String;
636 /**
637 * The phone number, in E.164 format.
638 */
639 E164PhoneNumber: E164PhoneNumber;
640 }
641 export interface AssociatePhoneNumberWithUserResponse {
642 }
643 export interface AssociatePhoneNumbersWithVoiceConnectorGroupRequest {
644 /**
645 * The Amazon Chime Voice Connector group ID.
646 */
647 VoiceConnectorGroupId: NonEmptyString;
648 /**
649 * List of phone numbers, in E.164 format.
650 */
651 E164PhoneNumbers?: E164PhoneNumberList;
652 /**
653 * If true, associates the provided phone numbers with the provided Amazon Chime Voice Connector Group and removes any previously existing associations. If false, does not associate any phone numbers that have previously existing associations.
654 */
655 ForceAssociate?: NullableBoolean;
656 }
657 export interface AssociatePhoneNumbersWithVoiceConnectorGroupResponse {
658 /**
659 * If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.
660 */
661 PhoneNumberErrors?: PhoneNumberErrorList;
662 }
663 export interface AssociatePhoneNumbersWithVoiceConnectorRequest {
664 /**
665 * The Amazon Chime Voice Connector ID.
666 */
667 VoiceConnectorId: NonEmptyString;
668 /**
669 * List of phone numbers, in E.164 format.
670 */
671 E164PhoneNumbers?: E164PhoneNumberList;
672 /**
673 * If true, associates the provided phone numbers with the provided Amazon Chime Voice Connector and removes any previously existing associations. If false, does not associate any phone numbers that have previously existing associations.
674 */
675 ForceAssociate?: NullableBoolean;
676 }
677 export interface AssociatePhoneNumbersWithVoiceConnectorResponse {
678 /**
679 * If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.
680 */
681 PhoneNumberErrors?: PhoneNumberErrorList;
682 }
683 export interface BatchDeletePhoneNumberRequest {
684 /**
685 * List of phone number IDs.
686 */
687 PhoneNumberIds: NonEmptyStringList;
688 }
689 export interface BatchDeletePhoneNumberResponse {
690 /**
691 * If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.
692 */
693 PhoneNumberErrors?: PhoneNumberErrorList;
694 }
695 export interface BatchSuspendUserRequest {
696 /**
697 * The Amazon Chime account ID.
698 */
699 AccountId: NonEmptyString;
700 /**
701 * The request containing the user IDs to suspend.
702 */
703 UserIdList: UserIdList;
704 }
705 export interface BatchSuspendUserResponse {
706 /**
707 * If the BatchSuspendUser action fails for one or more of the user IDs in the request, a list of the user IDs is returned, along with error codes and error messages.
708 */
709 UserErrors?: UserErrorList;
710 }
711 export interface BatchUnsuspendUserRequest {
712 /**
713 * The Amazon Chime account ID.
714 */
715 AccountId: NonEmptyString;
716 /**
717 * The request containing the user IDs to unsuspend.
718 */
719 UserIdList: UserIdList;
720 }
721 export interface BatchUnsuspendUserResponse {
722 /**
723 * If the BatchUnsuspendUser action fails for one or more of the user IDs in the request, a list of the user IDs is returned, along with error codes and error messages.
724 */
725 UserErrors?: UserErrorList;
726 }
727 export interface BatchUpdatePhoneNumberRequest {
728 /**
729 * The request containing the phone number IDs and product types or calling names to update.
730 */
731 UpdatePhoneNumberRequestItems: UpdatePhoneNumberRequestItemList;
732 }
733 export interface BatchUpdatePhoneNumberResponse {
734 /**
735 * If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.
736 */
737 PhoneNumberErrors?: PhoneNumberErrorList;
738 }
739 export interface BatchUpdateUserRequest {
740 /**
741 * The Amazon Chime account ID.
742 */
743 AccountId: NonEmptyString;
744 /**
745 * The request containing the user IDs and details to update.
746 */
747 UpdateUserRequestItems: UpdateUserRequestItemList;
748 }
749 export interface BatchUpdateUserResponse {
750 /**
751 * If the BatchUpdateUser action fails for one or more of the user IDs in the request, a list of the user IDs is returned, along with error codes and error messages.
752 */
753 UserErrors?: UserErrorList;
754 }
755 export type Boolean = boolean;
756 export interface Bot {
757 /**
758 * The bot ID.
759 */
760 BotId?: String;
761 /**
762 * The unique ID for the bot user.
763 */
764 UserId?: String;
765 /**
766 * The bot display name.
767 */
768 DisplayName?: SensitiveString;
769 /**
770 * The bot type.
771 */
772 BotType?: BotType;
773 /**
774 * When true, the bot is stopped from running in your account.
775 */
776 Disabled?: NullableBoolean;
777 /**
778 * The bot creation timestamp, in ISO 8601 format.
779 */
780 CreatedTimestamp?: Iso8601Timestamp;
781 /**
782 * The updated bot timestamp, in ISO 8601 format.
783 */
784 UpdatedTimestamp?: Iso8601Timestamp;
785 /**
786 * The bot email address.
787 */
788 BotEmail?: SensitiveString;
789 /**
790 * The security token used to authenticate Amazon Chime with the outgoing event endpoint.
791 */
792 SecurityToken?: SensitiveString;
793 }
794 export type BotList = Bot[];
795 export type BotType = "ChatBot"|string;
796 export interface BusinessCallingSettings {
797 /**
798 * The Amazon S3 bucket designated for call detail record storage.
799 */
800 CdrBucket?: String;
801 }
802 export type CallingName = string;
803 export type CallingNameStatus = "Unassigned"|"UpdateInProgress"|"UpdateSucceeded"|"UpdateFailed"|string;
804 export type CallingRegion = string;
805 export type CallingRegionList = CallingRegion[];
806 export type CpsLimit = number;
807 export interface CreateAccountRequest {
808 /**
809 * The name of the Amazon Chime account.
810 */
811 Name: AccountName;
812 }
813 export interface CreateAccountResponse {
814 /**
815 * The Amazon Chime account details.
816 */
817 Account?: Account;
818 }
819 export interface CreateBotRequest {
820 /**
821 * The Amazon Chime account ID.
822 */
823 AccountId: NonEmptyString;
824 /**
825 * The bot display name.
826 */
827 DisplayName: SensitiveString;
828 /**
829 * The domain of the Amazon Chime Enterprise account.
830 */
831 Domain?: NonEmptyString;
832 }
833 export interface CreateBotResponse {
834 /**
835 * The bot details.
836 */
837 Bot?: Bot;
838 }
839 export interface CreatePhoneNumberOrderRequest {
840 /**
841 * The phone number product type.
842 */
843 ProductType: PhoneNumberProductType;
844 /**
845 * List of phone numbers, in E.164 format.
846 */
847 E164PhoneNumbers: E164PhoneNumberList;
848 }
849 export interface CreatePhoneNumberOrderResponse {
850 /**
851 * The phone number order details.
852 */
853 PhoneNumberOrder?: PhoneNumberOrder;
854 }
855 export interface CreateVoiceConnectorGroupRequest {
856 /**
857 * The name of the Amazon Chime Voice Connector group.
858 */
859 Name: VoiceConnectorGroupName;
860 /**
861 * The Amazon Chime Voice Connectors to route inbound calls to.
862 */
863 VoiceConnectorItems?: VoiceConnectorItemList;
864 }
865 export interface CreateVoiceConnectorGroupResponse {
866 /**
867 * The Amazon Chime Voice Connector group details.
868 */
869 VoiceConnectorGroup?: VoiceConnectorGroup;
870 }
871 export interface CreateVoiceConnectorRequest {
872 /**
873 * The name of the Amazon Chime Voice Connector.
874 */
875 Name: VoiceConnectorName;
876 /**
877 * The AWS Region in which the Amazon Chime Voice Connector is created. Default value: us-east-1.
878 */
879 AwsRegion?: VoiceConnectorAwsRegion;
880 /**
881 * When enabled, requires encryption for the Amazon Chime Voice Connector.
882 */
883 RequireEncryption: Boolean;
884 }
885 export interface CreateVoiceConnectorResponse {
886 /**
887 * The Amazon Chime Voice Connector details.
888 */
889 VoiceConnector?: VoiceConnector;
890 }
891 export interface Credential {
892 /**
893 * The RFC2617 compliant user name associated with the SIP credentials, in US-ASCII format.
894 */
895 Username?: SensitiveString;
896 /**
897 * The RFC2617 compliant password associated with the SIP credentials, in US-ASCII format.
898 */
899 Password?: SensitiveString;
900 }
901 export type CredentialList = Credential[];
902 export type DataRetentionInHours = number;
903 export interface DeleteAccountRequest {
904 /**
905 * The Amazon Chime account ID.
906 */
907 AccountId: NonEmptyString;
908 }
909 export interface DeleteAccountResponse {
910 }
911 export interface DeleteEventsConfigurationRequest {
912 /**
913 * The Amazon Chime account ID.
914 */
915 AccountId: NonEmptyString;
916 /**
917 * The bot ID.
918 */
919 BotId: NonEmptyString;
920 }
921 export interface DeletePhoneNumberRequest {
922 /**
923 * The phone number ID.
924 */
925 PhoneNumberId: String;
926 }
927 export interface DeleteVoiceConnectorGroupRequest {
928 /**
929 * The Amazon Chime Voice Connector group ID.
930 */
931 VoiceConnectorGroupId: NonEmptyString;
932 }
933 export interface DeleteVoiceConnectorOriginationRequest {
934 /**
935 * The Amazon Chime Voice Connector ID.
936 */
937 VoiceConnectorId: NonEmptyString;
938 }
939 export interface DeleteVoiceConnectorRequest {
940 /**
941 * The Amazon Chime Voice Connector ID.
942 */
943 VoiceConnectorId: NonEmptyString;
944 }
945 export interface DeleteVoiceConnectorStreamingConfigurationRequest {
946 /**
947 * The Amazon Chime Voice Connector ID.
948 */
949 VoiceConnectorId: NonEmptyString;
950 }
951 export interface DeleteVoiceConnectorTerminationCredentialsRequest {
952 /**
953 * The Amazon Chime Voice Connector ID.
954 */
955 VoiceConnectorId: NonEmptyString;
956 /**
957 * The RFC2617 compliant username associated with the SIP credentials, in US-ASCII format.
958 */
959 Usernames?: SensitiveStringList;
960 }
961 export interface DeleteVoiceConnectorTerminationRequest {
962 /**
963 * The Amazon Chime Voice Connector ID.
964 */
965 VoiceConnectorId: NonEmptyString;
966 }
967 export interface DisassociatePhoneNumberFromUserRequest {
968 /**
969 * The Amazon Chime account ID.
970 */
971 AccountId: String;
972 /**
973 * The user ID.
974 */
975 UserId: String;
976 }
977 export interface DisassociatePhoneNumberFromUserResponse {
978 }
979 export interface DisassociatePhoneNumbersFromVoiceConnectorGroupRequest {
980 /**
981 * The Amazon Chime Voice Connector group ID.
982 */
983 VoiceConnectorGroupId: NonEmptyString;
984 /**
985 * List of phone numbers, in E.164 format.
986 */
987 E164PhoneNumbers?: E164PhoneNumberList;
988 }
989 export interface DisassociatePhoneNumbersFromVoiceConnectorGroupResponse {
990 /**
991 * If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.
992 */
993 PhoneNumberErrors?: PhoneNumberErrorList;
994 }
995 export interface DisassociatePhoneNumbersFromVoiceConnectorRequest {
996 /**
997 * The Amazon Chime Voice Connector ID.
998 */
999 VoiceConnectorId: NonEmptyString;
1000 /**
1001 * List of phone numbers, in E.164 format.
1002 */
1003 E164PhoneNumbers?: E164PhoneNumberList;
1004 }
1005 export interface DisassociatePhoneNumbersFromVoiceConnectorResponse {
1006 /**
1007 * If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.
1008 */
1009 PhoneNumberErrors?: PhoneNumberErrorList;
1010 }
1011 export type E164PhoneNumber = string;
1012 export type E164PhoneNumberList = E164PhoneNumber[];
1013 export type EmailAddress = string;
1014 export type EmailStatus = "NotSent"|"Sent"|"Failed"|string;
1015 export type ErrorCode = "BadRequest"|"Conflict"|"Forbidden"|"NotFound"|"PreconditionFailed"|"ResourceLimitExceeded"|"ServiceFailure"|"AccessDenied"|"ServiceUnavailable"|"Throttled"|"Unauthorized"|"Unprocessable"|"VoiceConnectorGroupAssociationsExist"|"PhoneNumberAssociationsExist"|string;
1016 export interface EventsConfiguration {
1017 /**
1018 * The bot ID.
1019 */
1020 BotId?: String;
1021 /**
1022 * HTTPS endpoint that allows a bot to receive outgoing events.
1023 */
1024 OutboundEventsHTTPSEndpoint?: SensitiveString;
1025 /**
1026 * Lambda function ARN that allows a bot to receive outgoing events.
1027 */
1028 LambdaFunctionArn?: SensitiveString;
1029 }
1030 export interface GetAccountRequest {
1031 /**
1032 * The Amazon Chime account ID.
1033 */
1034 AccountId: NonEmptyString;
1035 }
1036 export interface GetAccountResponse {
1037 /**
1038 * The Amazon Chime account details.
1039 */
1040 Account?: Account;
1041 }
1042 export interface GetAccountSettingsRequest {
1043 /**
1044 * The Amazon Chime account ID.
1045 */
1046 AccountId: NonEmptyString;
1047 }
1048 export interface GetAccountSettingsResponse {
1049 /**
1050 * The Amazon Chime account settings.
1051 */
1052 AccountSettings?: AccountSettings;
1053 }
1054 export interface GetBotRequest {
1055 /**
1056 * The Amazon Chime account ID.
1057 */
1058 AccountId: NonEmptyString;
1059 /**
1060 * The bot ID.
1061 */
1062 BotId: NonEmptyString;
1063 }
1064 export interface GetBotResponse {
1065 /**
1066 * The chat bot details.
1067 */
1068 Bot?: Bot;
1069 }
1070 export interface GetEventsConfigurationRequest {
1071 /**
1072 * The Amazon Chime account ID.
1073 */
1074 AccountId: NonEmptyString;
1075 /**
1076 * The bot ID.
1077 */
1078 BotId: NonEmptyString;
1079 }
1080 export interface GetEventsConfigurationResponse {
1081 /**
1082 * The events configuration details.
1083 */
1084 EventsConfiguration?: EventsConfiguration;
1085 }
1086 export interface GetGlobalSettingsResponse {
1087 /**
1088 * The Amazon Chime Business Calling settings.
1089 */
1090 BusinessCalling?: BusinessCallingSettings;
1091 /**
1092 * The Amazon Chime Voice Connector settings.
1093 */
1094 VoiceConnector?: VoiceConnectorSettings;
1095 }
1096 export interface GetPhoneNumberOrderRequest {
1097 /**
1098 * The ID for the phone number order.
1099 */
1100 PhoneNumberOrderId: GuidString;
1101 }
1102 export interface GetPhoneNumberOrderResponse {
1103 /**
1104 * The phone number order details.
1105 */
1106 PhoneNumberOrder?: PhoneNumberOrder;
1107 }
1108 export interface GetPhoneNumberRequest {
1109 /**
1110 * The phone number ID.
1111 */
1112 PhoneNumberId: String;
1113 }
1114 export interface GetPhoneNumberResponse {
1115 /**
1116 * The phone number details.
1117 */
1118 PhoneNumber?: PhoneNumber;
1119 }
1120 export interface GetPhoneNumberSettingsResponse {
1121 /**
1122 * The default outbound calling name for the account.
1123 */
1124 CallingName?: CallingName;
1125 /**
1126 * The updated outbound calling name timestamp, in ISO 8601 format.
1127 */
1128 CallingNameUpdatedTimestamp?: Iso8601Timestamp;
1129 }
1130 export interface GetUserRequest {
1131 /**
1132 * The Amazon Chime account ID.
1133 */
1134 AccountId: NonEmptyString;
1135 /**
1136 * The user ID.
1137 */
1138 UserId: NonEmptyString;
1139 }
1140 export interface GetUserResponse {
1141 /**
1142 * The user details.
1143 */
1144 User?: User;
1145 }
1146 export interface GetUserSettingsRequest {
1147 /**
1148 * The Amazon Chime account ID.
1149 */
1150 AccountId: String;
1151 /**
1152 * The user ID.
1153 */
1154 UserId: String;
1155 }
1156 export interface GetUserSettingsResponse {
1157 /**
1158 * The user settings.
1159 */
1160 UserSettings?: UserSettings;
1161 }
1162 export interface GetVoiceConnectorGroupRequest {
1163 /**
1164 * The Amazon Chime Voice Connector group ID.
1165 */
1166 VoiceConnectorGroupId: NonEmptyString;
1167 }
1168 export interface GetVoiceConnectorGroupResponse {
1169 /**
1170 * The Amazon Chime Voice Connector group details.
1171 */
1172 VoiceConnectorGroup?: VoiceConnectorGroup;
1173 }
1174 export interface GetVoiceConnectorLoggingConfigurationRequest {
1175 /**
1176 * The Amazon Chime Voice Connector ID.
1177 */
1178 VoiceConnectorId: NonEmptyString;
1179 }
1180 export interface GetVoiceConnectorLoggingConfigurationResponse {
1181 /**
1182 * The logging configuration details.
1183 */
1184 LoggingConfiguration?: LoggingConfiguration;
1185 }
1186 export interface GetVoiceConnectorOriginationRequest {
1187 /**
1188 * The Amazon Chime Voice Connector ID.
1189 */
1190 VoiceConnectorId: NonEmptyString;
1191 }
1192 export interface GetVoiceConnectorOriginationResponse {
1193 /**
1194 * The origination setting details.
1195 */
1196 Origination?: Origination;
1197 }
1198 export interface GetVoiceConnectorRequest {
1199 /**
1200 * The Amazon Chime Voice Connector ID.
1201 */
1202 VoiceConnectorId: NonEmptyString;
1203 }
1204 export interface GetVoiceConnectorResponse {
1205 /**
1206 * The Amazon Chime Voice Connector details.
1207 */
1208 VoiceConnector?: VoiceConnector;
1209 }
1210 export interface GetVoiceConnectorStreamingConfigurationRequest {
1211 /**
1212 * The Amazon Chime Voice Connector ID.
1213 */
1214 VoiceConnectorId: NonEmptyString;
1215 }
1216 export interface GetVoiceConnectorStreamingConfigurationResponse {
1217 /**
1218 * The streaming configuration details.
1219 */
1220 StreamingConfiguration?: StreamingConfiguration;
1221 }
1222 export interface GetVoiceConnectorTerminationHealthRequest {
1223 /**
1224 * The Amazon Chime Voice Connector ID.
1225 */
1226 VoiceConnectorId: NonEmptyString;
1227 }
1228 export interface GetVoiceConnectorTerminationHealthResponse {
1229 /**
1230 * The termination health details.
1231 */
1232 TerminationHealth?: TerminationHealth;
1233 }
1234 export interface GetVoiceConnectorTerminationRequest {
1235 /**
1236 * The Amazon Chime Voice Connector ID.
1237 */
1238 VoiceConnectorId: NonEmptyString;
1239 }
1240 export interface GetVoiceConnectorTerminationResponse {
1241 /**
1242 * The termination setting details.
1243 */
1244 Termination?: Termination;
1245 }
1246 export type GuidString = string;
1247 export interface Invite {
1248 /**
1249 * The invite ID.
1250 */
1251 InviteId?: String;
1252 /**
1253 * The status of the invite.
1254 */
1255 Status?: InviteStatus;
1256 /**
1257 * The email address to which the invite is sent.
1258 */
1259 EmailAddress?: EmailAddress;
1260 /**
1261 * The status of the invite email.
1262 */
1263 EmailStatus?: EmailStatus;
1264 }
1265 export type InviteList = Invite[];
1266 export type InviteStatus = "Pending"|"Accepted"|"Failed"|string;
1267 export interface InviteUsersRequest {
1268 /**
1269 * The Amazon Chime account ID.
1270 */
1271 AccountId: NonEmptyString;
1272 /**
1273 * The user email addresses to which to send the invite.
1274 */
1275 UserEmailList: UserEmailList;
1276 }
1277 export interface InviteUsersResponse {
1278 /**
1279 * The invite details.
1280 */
1281 Invites?: InviteList;
1282 }
1283 export type Iso8601Timestamp = Date;
1284 export type License = "Basic"|"Plus"|"Pro"|"ProTrial"|string;
1285 export type LicenseList = License[];
1286 export interface ListAccountsRequest {
1287 /**
1288 * Amazon Chime account name prefix with which to filter results.
1289 */
1290 Name?: AccountName;
1291 /**
1292 * User email address with which to filter results.
1293 */
1294 UserEmail?: EmailAddress;
1295 /**
1296 * The token to use to retrieve the next page of results.
1297 */
1298 NextToken?: String;
1299 /**
1300 * The maximum number of results to return in a single call. Defaults to 100.
1301 */
1302 MaxResults?: ProfileServiceMaxResults;
1303 }
1304 export interface ListAccountsResponse {
1305 /**
1306 * List of Amazon Chime accounts and account details.
1307 */
1308 Accounts?: AccountList;
1309 /**
1310 * The token to use to retrieve the next page of results.
1311 */
1312 NextToken?: String;
1313 }
1314 export interface ListBotsRequest {
1315 /**
1316 * The Amazon Chime account ID.
1317 */
1318 AccountId: NonEmptyString;
1319 /**
1320 * The maximum number of results to return in a single call. Default is 10.
1321 */
1322 MaxResults?: ResultMax;
1323 /**
1324 * The token to use to retrieve the next page of results.
1325 */
1326 NextToken?: String;
1327 }
1328 export interface ListBotsResponse {
1329 /**
1330 * List of bots and bot details.
1331 */
1332 Bots?: BotList;
1333 /**
1334 * The token to use to retrieve the next page of results.
1335 */
1336 NextToken?: String;
1337 }
1338 export interface ListPhoneNumberOrdersRequest {
1339 /**
1340 * The token to use to retrieve the next page of results.
1341 */
1342 NextToken?: String;
1343 /**
1344 * The maximum number of results to return in a single call.
1345 */
1346 MaxResults?: ResultMax;
1347 }
1348 export interface ListPhoneNumberOrdersResponse {
1349 /**
1350 * The phone number order details.
1351 */
1352 PhoneNumberOrders?: PhoneNumberOrderList;
1353 /**
1354 * The token to use to retrieve the next page of results.
1355 */
1356 NextToken?: String;
1357 }
1358 export interface ListPhoneNumbersRequest {
1359 /**
1360 * The phone number status.
1361 */
1362 Status?: PhoneNumberStatus;
1363 /**
1364 * The phone number product type.
1365 */
1366 ProductType?: PhoneNumberProductType;
1367 /**
1368 * The filter to use to limit the number of results.
1369 */
1370 FilterName?: PhoneNumberAssociationName;
1371 /**
1372 * The value to use for the filter.
1373 */
1374 FilterValue?: String;
1375 /**
1376 * The maximum number of results to return in a single call.
1377 */
1378 MaxResults?: ResultMax;
1379 /**
1380 * The token to use to retrieve the next page of results.
1381 */
1382 NextToken?: String;
1383 }
1384 export interface ListPhoneNumbersResponse {
1385 /**
1386 * The phone number details.
1387 */
1388 PhoneNumbers?: PhoneNumberList;
1389 /**
1390 * The token to use to retrieve the next page of results.
1391 */
1392 NextToken?: String;
1393 }
1394 export interface ListUsersRequest {
1395 /**
1396 * The Amazon Chime account ID.
1397 */
1398 AccountId: NonEmptyString;
1399 /**
1400 * Optional. The user email address used to filter results. Maximum 1.
1401 */
1402 UserEmail?: EmailAddress;
1403 /**
1404 * The maximum number of results to return in a single call. Defaults to 100.
1405 */
1406 MaxResults?: ProfileServiceMaxResults;
1407 /**
1408 * The token to use to retrieve the next page of results.
1409 */
1410 NextToken?: String;
1411 }
1412 export interface ListUsersResponse {
1413 /**
1414 * List of users and user details.
1415 */
1416 Users?: UserList;
1417 /**
1418 * The token to use to retrieve the next page of results.
1419 */
1420 NextToken?: String;
1421 }
1422 export interface ListVoiceConnectorGroupsRequest {
1423 /**
1424 * The token to use to retrieve the next page of results.
1425 */
1426 NextToken?: String;
1427 /**
1428 * The maximum number of results to return in a single call.
1429 */
1430 MaxResults?: ResultMax;
1431 }
1432 export interface ListVoiceConnectorGroupsResponse {
1433 /**
1434 * The details of the Amazon Chime Voice Connector groups.
1435 */
1436 VoiceConnectorGroups?: VoiceConnectorGroupList;
1437 /**
1438 * The token to use to retrieve the next page of results.
1439 */
1440 NextToken?: String;
1441 }
1442 export interface ListVoiceConnectorTerminationCredentialsRequest {
1443 /**
1444 * The Amazon Chime Voice Connector ID.
1445 */
1446 VoiceConnectorId: NonEmptyString;
1447 }
1448 export interface ListVoiceConnectorTerminationCredentialsResponse {
1449 /**
1450 * A list of user names.
1451 */
1452 Usernames?: SensitiveStringList;
1453 }
1454 export interface ListVoiceConnectorsRequest {
1455 /**
1456 * The token to use to retrieve the next page of results.
1457 */
1458 NextToken?: String;
1459 /**
1460 * The maximum number of results to return in a single call.
1461 */
1462 MaxResults?: ResultMax;
1463 }
1464 export interface ListVoiceConnectorsResponse {
1465 /**
1466 * The details of the Amazon Chime Voice Connectors.
1467 */
1468 VoiceConnectors?: VoiceConnectorList;
1469 /**
1470 * The token to use to retrieve the next page of results.
1471 */
1472 NextToken?: String;
1473 }
1474 export interface LoggingConfiguration {
1475 /**
1476 * When true, enables SIP message logs for sending to Amazon CloudWatch Logs.
1477 */
1478 EnableSIPLogs?: Boolean;
1479 }
1480 export interface LogoutUserRequest {
1481 /**
1482 * The Amazon Chime account ID.
1483 */
1484 AccountId: NonEmptyString;
1485 /**
1486 * The user ID.
1487 */
1488 UserId: NonEmptyString;
1489 }
1490 export interface LogoutUserResponse {
1491 }
1492 export type NonEmptyString = string;
1493 export type NonEmptyStringList = String[];
1494 export type NullableBoolean = boolean;
1495 export interface OrderedPhoneNumber {
1496 /**
1497 * The phone number, in E.164 format.
1498 */
1499 E164PhoneNumber?: E164PhoneNumber;
1500 /**
1501 * The phone number status.
1502 */
1503 Status?: OrderedPhoneNumberStatus;
1504 }
1505 export type OrderedPhoneNumberList = OrderedPhoneNumber[];
1506 export type OrderedPhoneNumberStatus = "Processing"|"Acquired"|"Failed"|string;
1507 export interface Origination {
1508 /**
1509 * The call distribution properties defined for your SIP hosts. Valid range: Minimum value of 1. Maximum value of 20.
1510 */
1511 Routes?: OriginationRouteList;
1512 /**
1513 * When origination settings are disabled, inbound calls are not enabled for your Amazon Chime Voice Connector.
1514 */
1515 Disabled?: Boolean;
1516 }
1517 export interface OriginationRoute {
1518 /**
1519 * The FQDN or IP address to contact for origination traffic.
1520 */
1521 Host?: String;
1522 /**
1523 * The designated origination route port. Defaults to 5060.
1524 */
1525 Port?: Port;
1526 /**
1527 * The protocol to use for the origination route. Encryption-enabled Amazon Chime Voice Connectors use TCP protocol by default.
1528 */
1529 Protocol?: OriginationRouteProtocol;
1530 /**
1531 * The priority associated with the host, with 1 being the highest priority. Higher priority hosts are attempted first.
1532 */
1533 Priority?: OriginationRoutePriority;
1534 /**
1535 * The weight associated with the host. If hosts are equal in priority, calls are distributed among them based on their relative weight.
1536 */
1537 Weight?: OriginationRouteWeight;
1538 }
1539 export type OriginationRouteList = OriginationRoute[];
1540 export type OriginationRoutePriority = number;
1541 export type OriginationRouteProtocol = "TCP"|"UDP"|string;
1542 export type OriginationRouteWeight = number;
1543 export interface PhoneNumber {
1544 /**
1545 * The phone number ID.
1546 */
1547 PhoneNumberId?: String;
1548 /**
1549 * The phone number, in E.164 format.
1550 */
1551 E164PhoneNumber?: E164PhoneNumber;
1552 /**
1553 * The phone number type.
1554 */
1555 Type?: PhoneNumberType;
1556 /**
1557 * The phone number product type.
1558 */
1559 ProductType?: PhoneNumberProductType;
1560 /**
1561 * The phone number status.
1562 */
1563 Status?: PhoneNumberStatus;
1564 /**
1565 * The phone number capabilities.
1566 */
1567 Capabilities?: PhoneNumberCapabilities;
1568 /**
1569 * The phone number associations.
1570 */
1571 Associations?: PhoneNumberAssociationList;
1572 /**
1573 * The outbound calling name associated with the phone number.
1574 */
1575 CallingName?: CallingName;
1576 /**
1577 * The outbound calling name status.
1578 */
1579 CallingNameStatus?: CallingNameStatus;
1580 /**
1581 * The phone number creation timestamp, in ISO 8601 format.
1582 */
1583 CreatedTimestamp?: Iso8601Timestamp;
1584 /**
1585 * The updated phone number timestamp, in ISO 8601 format.
1586 */
1587 UpdatedTimestamp?: Iso8601Timestamp;
1588 /**
1589 * The deleted phone number timestamp, in ISO 8601 format.
1590 */
1591 DeletionTimestamp?: Iso8601Timestamp;
1592 }
1593 export interface PhoneNumberAssociation {
1594 /**
1595 * Contains the ID for the entity specified in Name.
1596 */
1597 Value?: String;
1598 /**
1599 * Defines the association with an Amazon Chime account ID, user ID, Amazon Chime Voice Connector ID, or Amazon Chime Voice Connector group ID.
1600 */
1601 Name?: PhoneNumberAssociationName;
1602 /**
1603 * The timestamp of the phone number association, in ISO 8601 format.
1604 */
1605 AssociatedTimestamp?: Iso8601Timestamp;
1606 }
1607 export type PhoneNumberAssociationList = PhoneNumberAssociation[];
1608 export type PhoneNumberAssociationName = "AccountId"|"UserId"|"VoiceConnectorId"|"VoiceConnectorGroupId"|string;
1609 export interface PhoneNumberCapabilities {
1610 /**
1611 * Allows or denies inbound calling for the specified phone number.
1612 */
1613 InboundCall?: NullableBoolean;
1614 /**
1615 * Allows or denies outbound calling for the specified phone number.
1616 */
1617 OutboundCall?: NullableBoolean;
1618 /**
1619 * Allows or denies inbound SMS messaging for the specified phone number.
1620 */
1621 InboundSMS?: NullableBoolean;
1622 /**
1623 * Allows or denies outbound SMS messaging for the specified phone number.
1624 */
1625 OutboundSMS?: NullableBoolean;
1626 /**
1627 * Allows or denies inbound MMS messaging for the specified phone number.
1628 */
1629 InboundMMS?: NullableBoolean;
1630 /**
1631 * Allows or denies outbound MMS messaging for the specified phone number.
1632 */
1633 OutboundMMS?: NullableBoolean;
1634 }
1635 export interface PhoneNumberError {
1636 /**
1637 * The phone number ID for which the action failed.
1638 */
1639 PhoneNumberId?: NonEmptyString;
1640 /**
1641 * The error code.
1642 */
1643 ErrorCode?: ErrorCode;
1644 /**
1645 * The error message.
1646 */
1647 ErrorMessage?: String;
1648 }
1649 export type PhoneNumberErrorList = PhoneNumberError[];
1650 export type PhoneNumberList = PhoneNumber[];
1651 export type PhoneNumberMaxResults = number;
1652 export interface PhoneNumberOrder {
1653 /**
1654 * The phone number order ID.
1655 */
1656 PhoneNumberOrderId?: GuidString;
1657 /**
1658 * The phone number order product type.
1659 */
1660 ProductType?: PhoneNumberProductType;
1661 /**
1662 * The status of the phone number order.
1663 */
1664 Status?: PhoneNumberOrderStatus;
1665 /**
1666 * The ordered phone number details, such as the phone number in E.164 format and the phone number status.
1667 */
1668 OrderedPhoneNumbers?: OrderedPhoneNumberList;
1669 /**
1670 * The phone number order creation timestamp, in ISO 8601 format.
1671 */
1672 CreatedTimestamp?: Iso8601Timestamp;
1673 /**
1674 * The updated phone number order timestamp, in ISO 8601 format.
1675 */
1676 UpdatedTimestamp?: Iso8601Timestamp;
1677 }
1678 export type PhoneNumberOrderList = PhoneNumberOrder[];
1679 export type PhoneNumberOrderStatus = "Processing"|"Successful"|"Failed"|"Partial"|string;
1680 export type PhoneNumberProductType = "BusinessCalling"|"VoiceConnector"|string;
1681 export type PhoneNumberStatus = "AcquireInProgress"|"AcquireFailed"|"Unassigned"|"Assigned"|"ReleaseInProgress"|"DeleteInProgress"|"ReleaseFailed"|"DeleteFailed"|string;
1682 export type PhoneNumberType = "Local"|"TollFree"|string;
1683 export type Port = number;
1684 export type ProfileServiceMaxResults = number;
1685 export interface PutEventsConfigurationRequest {
1686 /**
1687 * The Amazon Chime account ID.
1688 */
1689 AccountId: NonEmptyString;
1690 /**
1691 * The bot ID.
1692 */
1693 BotId: NonEmptyString;
1694 /**
1695 * HTTPS endpoint that allows the bot to receive outgoing events.
1696 */
1697 OutboundEventsHTTPSEndpoint?: SensitiveString;
1698 /**
1699 * Lambda function ARN that allows the bot to receive outgoing events.
1700 */
1701 LambdaFunctionArn?: SensitiveString;
1702 }
1703 export interface PutEventsConfigurationResponse {
1704 EventsConfiguration?: EventsConfiguration;
1705 }
1706 export interface PutVoiceConnectorLoggingConfigurationRequest {
1707 /**
1708 * The Amazon Chime Voice Connector ID.
1709 */
1710 VoiceConnectorId: NonEmptyString;
1711 /**
1712 * The logging configuration details to add.
1713 */
1714 LoggingConfiguration: LoggingConfiguration;
1715 }
1716 export interface PutVoiceConnectorLoggingConfigurationResponse {
1717 /**
1718 * The updated logging configuration details.
1719 */
1720 LoggingConfiguration?: LoggingConfiguration;
1721 }
1722 export interface PutVoiceConnectorOriginationRequest {
1723 /**
1724 * The Amazon Chime Voice Connector ID.
1725 */
1726 VoiceConnectorId: NonEmptyString;
1727 /**
1728 * The origination setting details to add.
1729 */
1730 Origination: Origination;
1731 }
1732 export interface PutVoiceConnectorOriginationResponse {
1733 /**
1734 * The updated origination setting details.
1735 */
1736 Origination?: Origination;
1737 }
1738 export interface PutVoiceConnectorStreamingConfigurationRequest {
1739 /**
1740 * The Amazon Chime Voice Connector ID.
1741 */
1742 VoiceConnectorId: NonEmptyString;
1743 /**
1744 * The streaming configuration details to add.
1745 */
1746 StreamingConfiguration: StreamingConfiguration;
1747 }
1748 export interface PutVoiceConnectorStreamingConfigurationResponse {
1749 /**
1750 * The updated streaming configuration details.
1751 */
1752 StreamingConfiguration?: StreamingConfiguration;
1753 }
1754 export interface PutVoiceConnectorTerminationCredentialsRequest {
1755 /**
1756 * The Amazon Chime Voice Connector ID.
1757 */
1758 VoiceConnectorId: NonEmptyString;
1759 /**
1760 * The termination SIP credentials.
1761 */
1762 Credentials?: CredentialList;
1763 }
1764 export interface PutVoiceConnectorTerminationRequest {
1765 /**
1766 * The Amazon Chime Voice Connector ID.
1767 */
1768 VoiceConnectorId: NonEmptyString;
1769 /**
1770 * The termination setting details to add.
1771 */
1772 Termination: Termination;
1773 }
1774 export interface PutVoiceConnectorTerminationResponse {
1775 /**
1776 * The updated termination setting details.
1777 */
1778 Termination?: Termination;
1779 }
1780 export interface RegenerateSecurityTokenRequest {
1781 /**
1782 * The Amazon Chime account ID.
1783 */
1784 AccountId: NonEmptyString;
1785 /**
1786 * The bot ID.
1787 */
1788 BotId: NonEmptyString;
1789 }
1790 export interface RegenerateSecurityTokenResponse {
1791 Bot?: Bot;
1792 }
1793 export type RegistrationStatus = "Unregistered"|"Registered"|"Suspended"|string;
1794 export interface ResetPersonalPINRequest {
1795 /**
1796 * The Amazon Chime account ID.
1797 */
1798 AccountId: NonEmptyString;
1799 /**
1800 * The user ID.
1801 */
1802 UserId: NonEmptyString;
1803 }
1804 export interface ResetPersonalPINResponse {
1805 /**
1806 * The user details and new personal meeting PIN.
1807 */
1808 User?: User;
1809 }
1810 export interface RestorePhoneNumberRequest {
1811 /**
1812 * The phone number.
1813 */
1814 PhoneNumberId: NonEmptyString;
1815 }
1816 export interface RestorePhoneNumberResponse {
1817 /**
1818 * The phone number details.
1819 */
1820 PhoneNumber?: PhoneNumber;
1821 }
1822 export type ResultMax = number;
1823 export interface SearchAvailablePhoneNumbersRequest {
1824 /**
1825 * The area code used to filter results.
1826 */
1827 AreaCode?: String;
1828 /**
1829 * The city used to filter results.
1830 */
1831 City?: String;
1832 /**
1833 * The country used to filter results.
1834 */
1835 Country?: String;
1836 /**
1837 * The state used to filter results.
1838 */
1839 State?: String;
1840 /**
1841 * The toll-free prefix that you use to filter results.
1842 */
1843 TollFreePrefix?: TollFreePrefix;
1844 /**
1845 * The maximum number of results to return in a single call.
1846 */
1847 MaxResults?: PhoneNumberMaxResults;
1848 /**
1849 * The token to use to retrieve the next page of results.
1850 */
1851 NextToken?: String;
1852 }
1853 export interface SearchAvailablePhoneNumbersResponse {
1854 /**
1855 * List of phone numbers, in E.164 format.
1856 */
1857 E164PhoneNumbers?: E164PhoneNumberList;
1858 }
1859 export type SensitiveString = string;
1860 export type SensitiveStringList = SensitiveString[];
1861 export interface StreamingConfiguration {
1862 /**
1863 * The retention period for the Amazon Kinesis data, in hours.
1864 */
1865 DataRetentionInHours: DataRetentionInHours;
1866 /**
1867 * When true, media streaming to Amazon Kinesis is turned off.
1868 */
1869 Disabled?: Boolean;
1870 }
1871 export type String = string;
1872 export type StringList = String[];
1873 export interface TelephonySettings {
1874 /**
1875 * Allows or denies inbound calling.
1876 */
1877 InboundCalling: Boolean;
1878 /**
1879 * Allows or denies outbound calling.
1880 */
1881 OutboundCalling: Boolean;
1882 /**
1883 * Allows or denies SMS messaging.
1884 */
1885 SMS: Boolean;
1886 }
1887 export interface Termination {
1888 /**
1889 * The limit on calls per second. Max value based on account service limit. Default value of 1.
1890 */
1891 CpsLimit?: CpsLimit;
1892 /**
1893 * The default caller ID phone number.
1894 */
1895 DefaultPhoneNumber?: E164PhoneNumber;
1896 /**
1897 * The countries to which calls are allowed, in ISO 3166-1 alpha-2 format. Required.
1898 */
1899 CallingRegions?: CallingRegionList;
1900 /**
1901 * The IP addresses allowed to make calls, in CIDR format. Required.
1902 */
1903 CidrAllowedList?: StringList;
1904 /**
1905 * When termination settings are disabled, outbound calls can not be made.
1906 */
1907 Disabled?: Boolean;
1908 }
1909 export interface TerminationHealth {
1910 /**
1911 * The timestamp, in ISO 8601 format.
1912 */
1913 Timestamp?: Iso8601Timestamp;
1914 /**
1915 * The source IP address.
1916 */
1917 Source?: String;
1918 }
1919 export type TollFreePrefix = string;
1920 export interface UpdateAccountRequest {
1921 /**
1922 * The Amazon Chime account ID.
1923 */
1924 AccountId: NonEmptyString;
1925 /**
1926 * The new name for the specified Amazon Chime account.
1927 */
1928 Name?: AccountName;
1929 }
1930 export interface UpdateAccountResponse {
1931 /**
1932 * The updated Amazon Chime account details.
1933 */
1934 Account?: Account;
1935 }
1936 export interface UpdateAccountSettingsRequest {
1937 /**
1938 * The Amazon Chime account ID.
1939 */
1940 AccountId: NonEmptyString;
1941 /**
1942 * The Amazon Chime account settings to update.
1943 */
1944 AccountSettings: AccountSettings;
1945 }
1946 export interface UpdateAccountSettingsResponse {
1947 }
1948 export interface UpdateBotRequest {
1949 /**
1950 * The Amazon Chime account ID.
1951 */
1952 AccountId: NonEmptyString;
1953 /**
1954 * The bot ID.
1955 */
1956 BotId: NonEmptyString;
1957 /**
1958 * When true, stops the specified bot from running in your account.
1959 */
1960 Disabled?: NullableBoolean;
1961 }
1962 export interface UpdateBotResponse {
1963 /**
1964 * The updated bot details.
1965 */
1966 Bot?: Bot;
1967 }
1968 export interface UpdateGlobalSettingsRequest {
1969 /**
1970 * The Amazon Chime Business Calling settings.
1971 */
1972 BusinessCalling: BusinessCallingSettings;
1973 /**
1974 * The Amazon Chime Voice Connector settings.
1975 */
1976 VoiceConnector: VoiceConnectorSettings;
1977 }
1978 export interface UpdatePhoneNumberRequest {
1979 /**
1980 * The phone number ID.
1981 */
1982 PhoneNumberId: String;
1983 /**
1984 * The product type.
1985 */
1986 ProductType?: PhoneNumberProductType;
1987 /**
1988 * The outbound calling name associated with the phone number.
1989 */
1990 CallingName?: CallingName;
1991 }
1992 export interface UpdatePhoneNumberRequestItem {
1993 /**
1994 * The phone number ID to update.
1995 */
1996 PhoneNumberId: NonEmptyString;
1997 /**
1998 * The product type to update.
1999 */
2000 ProductType?: PhoneNumberProductType;
2001 /**
2002 * The outbound calling name to update.
2003 */
2004 CallingName?: CallingName;
2005 }
2006 export type UpdatePhoneNumberRequestItemList = UpdatePhoneNumberRequestItem[];
2007 export interface UpdatePhoneNumberResponse {
2008 /**
2009 * The updated phone number details.
2010 */
2011 PhoneNumber?: PhoneNumber;
2012 }
2013 export interface UpdatePhoneNumberSettingsRequest {
2014 /**
2015 * The default outbound calling name for the account.
2016 */
2017 CallingName: CallingName;
2018 }
2019 export interface UpdateUserRequest {
2020 /**
2021 * The Amazon Chime account ID.
2022 */
2023 AccountId: NonEmptyString;
2024 /**
2025 * The user ID.
2026 */
2027 UserId: NonEmptyString;
2028 /**
2029 * The user license type to update. This must be a supported license type for the Amazon Chime account that the user belongs to.
2030 */
2031 LicenseType?: License;
2032 }
2033 export interface UpdateUserRequestItem {
2034 /**
2035 * The user ID.
2036 */
2037 UserId: NonEmptyString;
2038 /**
2039 * The user license type.
2040 */
2041 LicenseType?: License;
2042 }
2043 export type UpdateUserRequestItemList = UpdateUserRequestItem[];
2044 export interface UpdateUserResponse {
2045 /**
2046 * The updated user details.
2047 */
2048 User?: User;
2049 }
2050 export interface UpdateUserSettingsRequest {
2051 /**
2052 * The Amazon Chime account ID.
2053 */
2054 AccountId: String;
2055 /**
2056 * The user ID.
2057 */
2058 UserId: String;
2059 /**
2060 * The user settings to update.
2061 */
2062 UserSettings: UserSettings;
2063 }
2064 export interface UpdateVoiceConnectorGroupRequest {
2065 /**
2066 * The Amazon Chime Voice Connector group ID.
2067 */
2068 VoiceConnectorGroupId: NonEmptyString;
2069 /**
2070 * The name of the Amazon Chime Voice Connector group.
2071 */
2072 Name: VoiceConnectorGroupName;
2073 /**
2074 * The VoiceConnectorItems to associate with the group.
2075 */
2076 VoiceConnectorItems: VoiceConnectorItemList;
2077 }
2078 export interface UpdateVoiceConnectorGroupResponse {
2079 /**
2080 * The updated Amazon Chime Voice Connector group details.
2081 */
2082 VoiceConnectorGroup?: VoiceConnectorGroup;
2083 }
2084 export interface UpdateVoiceConnectorRequest {
2085 /**
2086 * The Amazon Chime Voice Connector ID.
2087 */
2088 VoiceConnectorId: NonEmptyString;
2089 /**
2090 * The name of the Amazon Chime Voice Connector.
2091 */
2092 Name: VoiceConnectorName;
2093 /**
2094 * When enabled, requires encryption for the Amazon Chime Voice Connector.
2095 */
2096 RequireEncryption: Boolean;
2097 }
2098 export interface UpdateVoiceConnectorResponse {
2099 /**
2100 * The updated Amazon Chime Voice Connector details.
2101 */
2102 VoiceConnector?: VoiceConnector;
2103 }
2104 export interface User {
2105 /**
2106 * The user ID.
2107 */
2108 UserId: String;
2109 /**
2110 * The Amazon Chime account ID.
2111 */
2112 AccountId?: String;
2113 /**
2114 * The primary email address of the user.
2115 */
2116 PrimaryEmail?: EmailAddress;
2117 /**
2118 * The primary phone number associated with the user.
2119 */
2120 PrimaryProvisionedNumber?: SensitiveString;
2121 /**
2122 * The display name of the user.
2123 */
2124 DisplayName?: SensitiveString;
2125 /**
2126 * The license type for the user.
2127 */
2128 LicenseType?: License;
2129 /**
2130 * The user registration status.
2131 */
2132 UserRegistrationStatus?: RegistrationStatus;
2133 /**
2134 * The user invite status.
2135 */
2136 UserInvitationStatus?: InviteStatus;
2137 /**
2138 * Date and time when the user is registered, in ISO 8601 format.
2139 */
2140 RegisteredOn?: Iso8601Timestamp;
2141 /**
2142 * Date and time when the user is invited to the Amazon Chime account, in ISO 8601 format.
2143 */
2144 InvitedOn?: Iso8601Timestamp;
2145 /**
2146 * The user's personal meeting PIN.
2147 */
2148 PersonalPIN?: String;
2149 }
2150 export type UserEmailList = EmailAddress[];
2151 export interface UserError {
2152 /**
2153 * The user ID for which the action failed.
2154 */
2155 UserId?: NonEmptyString;
2156 /**
2157 * The error code.
2158 */
2159 ErrorCode?: ErrorCode;
2160 /**
2161 * The error message.
2162 */
2163 ErrorMessage?: String;
2164 }
2165 export type UserErrorList = UserError[];
2166 export type UserIdList = NonEmptyString[];
2167 export type UserList = User[];
2168 export interface UserSettings {
2169 /**
2170 * The telephony settings associated with the user.
2171 */
2172 Telephony: TelephonySettings;
2173 }
2174 export interface VoiceConnector {
2175 /**
2176 * The Amazon Chime Voice Connector ID.
2177 */
2178 VoiceConnectorId?: NonEmptyString;
2179 /**
2180 * The AWS Region in which the Amazon Chime Voice Connector is created. Default: us-east-1.
2181 */
2182 AwsRegion?: VoiceConnectorAwsRegion;
2183 /**
2184 * The name of the Amazon Chime Voice Connector.
2185 */
2186 Name?: VoiceConnectorName;
2187 /**
2188 * The outbound host name for the Amazon Chime Voice Connector.
2189 */
2190 OutboundHostName?: String;
2191 /**
2192 * Designates whether encryption is required for the Amazon Chime Voice Connector.
2193 */
2194 RequireEncryption?: Boolean;
2195 /**
2196 * The Amazon Chime Voice Connector creation timestamp, in ISO 8601 format.
2197 */
2198 CreatedTimestamp?: Iso8601Timestamp;
2199 /**
2200 * The updated Amazon Chime Voice Connector timestamp, in ISO 8601 format.
2201 */
2202 UpdatedTimestamp?: Iso8601Timestamp;
2203 }
2204 export type VoiceConnectorAwsRegion = "us-east-1"|"us-west-2"|string;
2205 export interface VoiceConnectorGroup {
2206 /**
2207 * The Amazon Chime Voice Connector group ID.
2208 */
2209 VoiceConnectorGroupId?: NonEmptyString;
2210 /**
2211 * The name of the Amazon Chime Voice Connector group.
2212 */
2213 Name?: VoiceConnectorGroupName;
2214 /**
2215 * The Amazon Chime Voice Connectors to which to route inbound calls.
2216 */
2217 VoiceConnectorItems?: VoiceConnectorItemList;
2218 /**
2219 * The Amazon Chime Voice Connector group creation timestamp, in ISO 8601 format.
2220 */
2221 CreatedTimestamp?: Iso8601Timestamp;
2222 /**
2223 * The updated Amazon Chime Voice Connector group timestamp, in ISO 8601 format.
2224 */
2225 UpdatedTimestamp?: Iso8601Timestamp;
2226 }
2227 export type VoiceConnectorGroupList = VoiceConnectorGroup[];
2228 export type VoiceConnectorGroupName = string;
2229 export interface VoiceConnectorItem {
2230 /**
2231 * The Amazon Chime Voice Connector ID.
2232 */
2233 VoiceConnectorId: NonEmptyString;
2234 /**
2235 * The priority associated with the Amazon Chime Voice Connector, with 1 being the highest priority. Higher priority Amazon Chime Voice Connectors are attempted first.
2236 */
2237 Priority: VoiceConnectorItemPriority;
2238 }
2239 export type VoiceConnectorItemList = VoiceConnectorItem[];
2240 export type VoiceConnectorItemPriority = number;
2241 export type VoiceConnectorList = VoiceConnector[];
2242 export type VoiceConnectorName = string;
2243 export interface VoiceConnectorSettings {
2244 /**
2245 * The Amazon S3 bucket designated for call detail record storage.
2246 */
2247 CdrBucket?: String;
2248 }
2249 /**
2250 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
2251 */
2252 export type apiVersion = "2018-05-01"|"latest"|string;
2253 export interface ClientApiVersions {
2254 /**
2255 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
2256 */
2257 apiVersion?: apiVersion;
2258 }
2259 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
2260 /**
2261 * Contains interfaces for use with the Chime client.
2262 */
2263 export import Types = Chime;
2264}
2265export = Chime;