@aws-sdk/client-workmail 3.315.0 → 3.316.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -80,677 +80,526 @@ import { UpdateMobileDeviceAccessRuleCommandInput, UpdateMobileDeviceAccessRuleC
80
80
  import { UpdatePrimaryEmailAddressCommandInput, UpdatePrimaryEmailAddressCommandOutput } from "./commands/UpdatePrimaryEmailAddressCommand";
81
81
  import { UpdateResourceCommandInput, UpdateResourceCommandOutput } from "./commands/UpdateResourceCommand";
82
82
  import { WorkMailClient } from "./WorkMailClient";
83
- /**
84
- * @public
85
- * <p>WorkMail is a secure, managed business email and calendaring service with support for
86
- * existing desktop and mobile email clients. You can access your email, contacts, and
87
- * calendars using Microsoft Outlook, your browser, or other native iOS and Android email
88
- * applications. You can integrate WorkMail with your existing corporate directory and control
89
- * both the keys that encrypt your data and the location in which your data is
90
- * stored.</p>
91
- * <p>The WorkMail API is designed for the following scenarios:</p>
92
- * <ul>
93
- * <li>
94
- * <p>Listing and describing organizations</p>
95
- * </li>
96
- * </ul>
97
- * <ul>
98
- * <li>
99
- * <p>Managing users</p>
100
- * </li>
101
- * </ul>
102
- * <ul>
103
- * <li>
104
- * <p>Managing groups</p>
105
- * </li>
106
- * </ul>
107
- * <ul>
108
- * <li>
109
- * <p>Managing resources</p>
110
- * </li>
111
- * </ul>
112
- * <p>All WorkMail API operations are Amazon-authenticated and certificate-signed. They not
113
- * only require the use of the AWS SDK, but also allow for the exclusive use of AWS Identity and Access Management
114
- * users and roles to help facilitate access, trust, and permission policies. By creating a
115
- * role and allowing an IAM user to access the WorkMail site, the IAM user gains full
116
- * administrative visibility into the entire WorkMail organization (or as set in the IAM
117
- * policy). This includes, but is not limited to, the ability to create, update, and delete
118
- * users, groups, and resources. This allows developers to perform the scenarios listed above,
119
- * as well as give users the ability to grant access on a selective basis using the IAM
120
- * model.</p>
121
- */
122
- export declare class WorkMail extends WorkMailClient {
83
+ export interface WorkMail {
123
84
  /**
124
- * @public
125
- * <p>Adds a member (user or group) to the resource's set of delegates.</p>
85
+ * @see {@link AssociateDelegateToResourceCommand}
126
86
  */
127
87
  associateDelegateToResource(args: AssociateDelegateToResourceCommandInput, options?: __HttpHandlerOptions): Promise<AssociateDelegateToResourceCommandOutput>;
128
88
  associateDelegateToResource(args: AssociateDelegateToResourceCommandInput, cb: (err: any, data?: AssociateDelegateToResourceCommandOutput) => void): void;
129
89
  associateDelegateToResource(args: AssociateDelegateToResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateDelegateToResourceCommandOutput) => void): void;
130
90
  /**
131
- * @public
132
- * <p>Adds a member (user or group) to the group's set.</p>
91
+ * @see {@link AssociateMemberToGroupCommand}
133
92
  */
134
93
  associateMemberToGroup(args: AssociateMemberToGroupCommandInput, options?: __HttpHandlerOptions): Promise<AssociateMemberToGroupCommandOutput>;
135
94
  associateMemberToGroup(args: AssociateMemberToGroupCommandInput, cb: (err: any, data?: AssociateMemberToGroupCommandOutput) => void): void;
136
95
  associateMemberToGroup(args: AssociateMemberToGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateMemberToGroupCommandOutput) => void): void;
137
96
  /**
138
- * @public
139
- * <p>Assumes an impersonation role for the given WorkMail organization. This method returns an
140
- * authentication token you can use to make impersonated calls.</p>
97
+ * @see {@link AssumeImpersonationRoleCommand}
141
98
  */
142
99
  assumeImpersonationRole(args: AssumeImpersonationRoleCommandInput, options?: __HttpHandlerOptions): Promise<AssumeImpersonationRoleCommandOutput>;
143
100
  assumeImpersonationRole(args: AssumeImpersonationRoleCommandInput, cb: (err: any, data?: AssumeImpersonationRoleCommandOutput) => void): void;
144
101
  assumeImpersonationRole(args: AssumeImpersonationRoleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssumeImpersonationRoleCommandOutput) => void): void;
145
102
  /**
146
- * @public
147
- * <p>Cancels a mailbox export job.</p>
148
- * <note>
149
- * <p>If the mailbox export job is near completion, it might not be possible to cancel
150
- * it.</p>
151
- * </note>
103
+ * @see {@link CancelMailboxExportJobCommand}
152
104
  */
153
105
  cancelMailboxExportJob(args: CancelMailboxExportJobCommandInput, options?: __HttpHandlerOptions): Promise<CancelMailboxExportJobCommandOutput>;
154
106
  cancelMailboxExportJob(args: CancelMailboxExportJobCommandInput, cb: (err: any, data?: CancelMailboxExportJobCommandOutput) => void): void;
155
107
  cancelMailboxExportJob(args: CancelMailboxExportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelMailboxExportJobCommandOutput) => void): void;
156
108
  /**
157
- * @public
158
- * <p>Adds an alias to the set of a given member (user or group) of WorkMail.</p>
109
+ * @see {@link CreateAliasCommand}
159
110
  */
160
111
  createAlias(args: CreateAliasCommandInput, options?: __HttpHandlerOptions): Promise<CreateAliasCommandOutput>;
161
112
  createAlias(args: CreateAliasCommandInput, cb: (err: any, data?: CreateAliasCommandOutput) => void): void;
162
113
  createAlias(args: CreateAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAliasCommandOutput) => void): void;
163
114
  /**
164
- * @public
165
- * <p>Creates an <code>AvailabilityConfiguration</code> for the given WorkMail organization and domain.</p>
115
+ * @see {@link CreateAvailabilityConfigurationCommand}
166
116
  */
167
117
  createAvailabilityConfiguration(args: CreateAvailabilityConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<CreateAvailabilityConfigurationCommandOutput>;
168
118
  createAvailabilityConfiguration(args: CreateAvailabilityConfigurationCommandInput, cb: (err: any, data?: CreateAvailabilityConfigurationCommandOutput) => void): void;
169
119
  createAvailabilityConfiguration(args: CreateAvailabilityConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAvailabilityConfigurationCommandOutput) => void): void;
170
120
  /**
171
- * @public
172
- * <p>Creates a group that can be used in WorkMail by calling the <a>RegisterToWorkMail</a> operation.</p>
121
+ * @see {@link CreateGroupCommand}
173
122
  */
174
123
  createGroup(args: CreateGroupCommandInput, options?: __HttpHandlerOptions): Promise<CreateGroupCommandOutput>;
175
124
  createGroup(args: CreateGroupCommandInput, cb: (err: any, data?: CreateGroupCommandOutput) => void): void;
176
125
  createGroup(args: CreateGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGroupCommandOutput) => void): void;
177
126
  /**
178
- * @public
179
- * <p>Creates an impersonation role for the given WorkMail organization.</p>
180
- * <p>
181
- * <i>Idempotency</i> ensures that an API request completes no more than one
182
- * time. With an idempotent request, if the original request completes successfully, any
183
- * subsequent retries also complete successfully without performing any further
184
- * actions.</p>
127
+ * @see {@link CreateImpersonationRoleCommand}
185
128
  */
186
129
  createImpersonationRole(args: CreateImpersonationRoleCommandInput, options?: __HttpHandlerOptions): Promise<CreateImpersonationRoleCommandOutput>;
187
130
  createImpersonationRole(args: CreateImpersonationRoleCommandInput, cb: (err: any, data?: CreateImpersonationRoleCommandOutput) => void): void;
188
131
  createImpersonationRole(args: CreateImpersonationRoleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateImpersonationRoleCommandOutput) => void): void;
189
132
  /**
190
- * @public
191
- * <p>Creates a new mobile device access rule for the specified WorkMail organization.</p>
133
+ * @see {@link CreateMobileDeviceAccessRuleCommand}
192
134
  */
193
135
  createMobileDeviceAccessRule(args: CreateMobileDeviceAccessRuleCommandInput, options?: __HttpHandlerOptions): Promise<CreateMobileDeviceAccessRuleCommandOutput>;
194
136
  createMobileDeviceAccessRule(args: CreateMobileDeviceAccessRuleCommandInput, cb: (err: any, data?: CreateMobileDeviceAccessRuleCommandOutput) => void): void;
195
137
  createMobileDeviceAccessRule(args: CreateMobileDeviceAccessRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateMobileDeviceAccessRuleCommandOutput) => void): void;
196
138
  /**
197
- * @public
198
- * <p>Creates a new WorkMail organization. Optionally, you can choose to associate an existing AWS Directory Service directory with your organization. If an AWS Directory Service directory ID is specified, the organization alias must match the directory alias. If you choose not to associate an existing directory with your organization, then we create a new WorkMail directory for you. For more information, see <a href="https://docs.aws.amazon.com/workmail/latest/adminguide/add_new_organization.html">Adding an organization</a> in the <i>WorkMail Administrator Guide</i>.</p>
199
- * <p>You can associate multiple email domains with an organization, then choose your
200
- * default email domain from the WorkMail console. You can also associate a domain that is managed
201
- * in an Amazon Route 53 public hosted zone. For more information, see <a href="https://docs.aws.amazon.com/workmail/latest/adminguide/add_domain.html">Adding a
202
- * domain</a> and <a href="https://docs.aws.amazon.com/workmail/latest/adminguide/default_domain.html">Choosing the default domain</a>
203
- * in the <i>WorkMail Administrator Guide</i>.</p>
204
- * <p>Optionally, you can use a customer managed key from AWS Key Management Service (AWS
205
- * KMS) to encrypt email for your organization. If you don't associate an AWS KMS key, WorkMail
206
- * creates a default, AWS managed key for you.</p>
139
+ * @see {@link CreateOrganizationCommand}
207
140
  */
208
141
  createOrganization(args: CreateOrganizationCommandInput, options?: __HttpHandlerOptions): Promise<CreateOrganizationCommandOutput>;
209
142
  createOrganization(args: CreateOrganizationCommandInput, cb: (err: any, data?: CreateOrganizationCommandOutput) => void): void;
210
143
  createOrganization(args: CreateOrganizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateOrganizationCommandOutput) => void): void;
211
144
  /**
212
- * @public
213
- * <p>Creates a new WorkMail resource.</p>
145
+ * @see {@link CreateResourceCommand}
214
146
  */
215
147
  createResource(args: CreateResourceCommandInput, options?: __HttpHandlerOptions): Promise<CreateResourceCommandOutput>;
216
148
  createResource(args: CreateResourceCommandInput, cb: (err: any, data?: CreateResourceCommandOutput) => void): void;
217
149
  createResource(args: CreateResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateResourceCommandOutput) => void): void;
218
150
  /**
219
- * @public
220
- * <p>Creates a user who can be used in WorkMail by calling the <a>RegisterToWorkMail</a> operation.</p>
151
+ * @see {@link CreateUserCommand}
221
152
  */
222
153
  createUser(args: CreateUserCommandInput, options?: __HttpHandlerOptions): Promise<CreateUserCommandOutput>;
223
154
  createUser(args: CreateUserCommandInput, cb: (err: any, data?: CreateUserCommandOutput) => void): void;
224
155
  createUser(args: CreateUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateUserCommandOutput) => void): void;
225
156
  /**
226
- * @public
227
- * <p>Deletes an access control rule for the specified WorkMail organization.</p>
228
- * <note>
229
- * <p>Deleting already deleted and non-existing rules does not produce an error. In those cases, the service sends back an HTTP 200 response with an empty HTTP body.</p>
230
- * </note>
157
+ * @see {@link DeleteAccessControlRuleCommand}
231
158
  */
232
159
  deleteAccessControlRule(args: DeleteAccessControlRuleCommandInput, options?: __HttpHandlerOptions): Promise<DeleteAccessControlRuleCommandOutput>;
233
160
  deleteAccessControlRule(args: DeleteAccessControlRuleCommandInput, cb: (err: any, data?: DeleteAccessControlRuleCommandOutput) => void): void;
234
161
  deleteAccessControlRule(args: DeleteAccessControlRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAccessControlRuleCommandOutput) => void): void;
235
162
  /**
236
- * @public
237
- * <p>Remove one or more specified aliases from a set of aliases for a given
238
- * user.</p>
163
+ * @see {@link DeleteAliasCommand}
239
164
  */
240
165
  deleteAlias(args: DeleteAliasCommandInput, options?: __HttpHandlerOptions): Promise<DeleteAliasCommandOutput>;
241
166
  deleteAlias(args: DeleteAliasCommandInput, cb: (err: any, data?: DeleteAliasCommandOutput) => void): void;
242
167
  deleteAlias(args: DeleteAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAliasCommandOutput) => void): void;
243
168
  /**
244
- * @public
245
- * <p>Deletes the <code>AvailabilityConfiguration</code> for the given WorkMail organization and domain.</p>
169
+ * @see {@link DeleteAvailabilityConfigurationCommand}
246
170
  */
247
171
  deleteAvailabilityConfiguration(args: DeleteAvailabilityConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<DeleteAvailabilityConfigurationCommandOutput>;
248
172
  deleteAvailabilityConfiguration(args: DeleteAvailabilityConfigurationCommandInput, cb: (err: any, data?: DeleteAvailabilityConfigurationCommandOutput) => void): void;
249
173
  deleteAvailabilityConfiguration(args: DeleteAvailabilityConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAvailabilityConfigurationCommandOutput) => void): void;
250
174
  /**
251
- * @public
252
- * <p>Deletes the email monitoring configuration for a specified organization.</p>
175
+ * @see {@link DeleteEmailMonitoringConfigurationCommand}
253
176
  */
254
177
  deleteEmailMonitoringConfiguration(args: DeleteEmailMonitoringConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<DeleteEmailMonitoringConfigurationCommandOutput>;
255
178
  deleteEmailMonitoringConfiguration(args: DeleteEmailMonitoringConfigurationCommandInput, cb: (err: any, data?: DeleteEmailMonitoringConfigurationCommandOutput) => void): void;
256
179
  deleteEmailMonitoringConfiguration(args: DeleteEmailMonitoringConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEmailMonitoringConfigurationCommandOutput) => void): void;
257
180
  /**
258
- * @public
259
- * <p>Deletes a group from WorkMail.</p>
181
+ * @see {@link DeleteGroupCommand}
260
182
  */
261
183
  deleteGroup(args: DeleteGroupCommandInput, options?: __HttpHandlerOptions): Promise<DeleteGroupCommandOutput>;
262
184
  deleteGroup(args: DeleteGroupCommandInput, cb: (err: any, data?: DeleteGroupCommandOutput) => void): void;
263
185
  deleteGroup(args: DeleteGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteGroupCommandOutput) => void): void;
264
186
  /**
265
- * @public
266
- * <p>Deletes an impersonation role for the given WorkMail organization.</p>
187
+ * @see {@link DeleteImpersonationRoleCommand}
267
188
  */
268
189
  deleteImpersonationRole(args: DeleteImpersonationRoleCommandInput, options?: __HttpHandlerOptions): Promise<DeleteImpersonationRoleCommandOutput>;
269
190
  deleteImpersonationRole(args: DeleteImpersonationRoleCommandInput, cb: (err: any, data?: DeleteImpersonationRoleCommandOutput) => void): void;
270
191
  deleteImpersonationRole(args: DeleteImpersonationRoleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteImpersonationRoleCommandOutput) => void): void;
271
192
  /**
272
- * @public
273
- * <p>Deletes permissions granted to a member (user or group).</p>
193
+ * @see {@link DeleteMailboxPermissionsCommand}
274
194
  */
275
195
  deleteMailboxPermissions(args: DeleteMailboxPermissionsCommandInput, options?: __HttpHandlerOptions): Promise<DeleteMailboxPermissionsCommandOutput>;
276
196
  deleteMailboxPermissions(args: DeleteMailboxPermissionsCommandInput, cb: (err: any, data?: DeleteMailboxPermissionsCommandOutput) => void): void;
277
197
  deleteMailboxPermissions(args: DeleteMailboxPermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMailboxPermissionsCommandOutput) => void): void;
278
198
  /**
279
- * @public
280
- * <p>Deletes the mobile device access override for the given WorkMail organization, user, and device.</p>
281
- * <note>
282
- * <p>Deleting already deleted and non-existing overrides does not produce an error. In those cases, the service sends back an HTTP 200 response with an empty HTTP body.</p>
283
- * </note>
199
+ * @see {@link DeleteMobileDeviceAccessOverrideCommand}
284
200
  */
285
201
  deleteMobileDeviceAccessOverride(args: DeleteMobileDeviceAccessOverrideCommandInput, options?: __HttpHandlerOptions): Promise<DeleteMobileDeviceAccessOverrideCommandOutput>;
286
202
  deleteMobileDeviceAccessOverride(args: DeleteMobileDeviceAccessOverrideCommandInput, cb: (err: any, data?: DeleteMobileDeviceAccessOverrideCommandOutput) => void): void;
287
203
  deleteMobileDeviceAccessOverride(args: DeleteMobileDeviceAccessOverrideCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMobileDeviceAccessOverrideCommandOutput) => void): void;
288
204
  /**
289
- * @public
290
- * <p>Deletes a mobile device access rule for the specified WorkMail organization.</p>
291
- * <note>
292
- * <p>Deleting already deleted and non-existing rules does not produce an error. In those cases, the service sends back an HTTP 200 response with an empty HTTP body.</p>
293
- * </note>
205
+ * @see {@link DeleteMobileDeviceAccessRuleCommand}
294
206
  */
295
207
  deleteMobileDeviceAccessRule(args: DeleteMobileDeviceAccessRuleCommandInput, options?: __HttpHandlerOptions): Promise<DeleteMobileDeviceAccessRuleCommandOutput>;
296
208
  deleteMobileDeviceAccessRule(args: DeleteMobileDeviceAccessRuleCommandInput, cb: (err: any, data?: DeleteMobileDeviceAccessRuleCommandOutput) => void): void;
297
209
  deleteMobileDeviceAccessRule(args: DeleteMobileDeviceAccessRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMobileDeviceAccessRuleCommandOutput) => void): void;
298
210
  /**
299
- * @public
300
- * <p>Deletes an WorkMail organization and all underlying AWS resources managed by WorkMail as part of the organization. You can choose whether to delete the associated directory. For more information, see <a href="https://docs.aws.amazon.com/workmail/latest/adminguide/remove_organization.html">Removing an organization</a> in the <i>WorkMail Administrator Guide</i>.</p>
211
+ * @see {@link DeleteOrganizationCommand}
301
212
  */
302
213
  deleteOrganization(args: DeleteOrganizationCommandInput, options?: __HttpHandlerOptions): Promise<DeleteOrganizationCommandOutput>;
303
214
  deleteOrganization(args: DeleteOrganizationCommandInput, cb: (err: any, data?: DeleteOrganizationCommandOutput) => void): void;
304
215
  deleteOrganization(args: DeleteOrganizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteOrganizationCommandOutput) => void): void;
305
216
  /**
306
- * @public
307
- * <p>Deletes the specified resource.</p>
217
+ * @see {@link DeleteResourceCommand}
308
218
  */
309
219
  deleteResource(args: DeleteResourceCommandInput, options?: __HttpHandlerOptions): Promise<DeleteResourceCommandOutput>;
310
220
  deleteResource(args: DeleteResourceCommandInput, cb: (err: any, data?: DeleteResourceCommandOutput) => void): void;
311
221
  deleteResource(args: DeleteResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteResourceCommandOutput) => void): void;
312
222
  /**
313
- * @public
314
- * <p>Deletes the specified retention policy from the specified organization.</p>
223
+ * @see {@link DeleteRetentionPolicyCommand}
315
224
  */
316
225
  deleteRetentionPolicy(args: DeleteRetentionPolicyCommandInput, options?: __HttpHandlerOptions): Promise<DeleteRetentionPolicyCommandOutput>;
317
226
  deleteRetentionPolicy(args: DeleteRetentionPolicyCommandInput, cb: (err: any, data?: DeleteRetentionPolicyCommandOutput) => void): void;
318
227
  deleteRetentionPolicy(args: DeleteRetentionPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRetentionPolicyCommandOutput) => void): void;
319
228
  /**
320
- * @public
321
- * <p>Deletes a user from WorkMail and all subsequent systems. Before you can delete a
322
- * user, the user state must be <code>DISABLED</code>. Use the <a>DescribeUser</a>
323
- * action to confirm the user state.</p>
324
- * <p>Deleting a user is permanent and cannot be undone. WorkMail archives user mailboxes for
325
- * 30 days before they are permanently removed.</p>
229
+ * @see {@link DeleteUserCommand}
326
230
  */
327
231
  deleteUser(args: DeleteUserCommandInput, options?: __HttpHandlerOptions): Promise<DeleteUserCommandOutput>;
328
232
  deleteUser(args: DeleteUserCommandInput, cb: (err: any, data?: DeleteUserCommandOutput) => void): void;
329
233
  deleteUser(args: DeleteUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteUserCommandOutput) => void): void;
330
234
  /**
331
- * @public
332
- * <p>Mark a user, group, or resource as no longer used in WorkMail. This action
333
- * disassociates the mailbox and schedules it for clean-up. WorkMail keeps mailboxes for 30 days
334
- * before they are permanently removed. The functionality in the console is
335
- * <i>Disable</i>.</p>
235
+ * @see {@link DeregisterFromWorkMailCommand}
336
236
  */
337
237
  deregisterFromWorkMail(args: DeregisterFromWorkMailCommandInput, options?: __HttpHandlerOptions): Promise<DeregisterFromWorkMailCommandOutput>;
338
238
  deregisterFromWorkMail(args: DeregisterFromWorkMailCommandInput, cb: (err: any, data?: DeregisterFromWorkMailCommandOutput) => void): void;
339
239
  deregisterFromWorkMail(args: DeregisterFromWorkMailCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeregisterFromWorkMailCommandOutput) => void): void;
340
240
  /**
341
- * @public
342
- * <p>Removes a domain from WorkMail, stops email routing to WorkMail, and removes the authorization allowing WorkMail use. SES keeps the domain because other applications may use it. You must first
343
- * remove any email address used by WorkMail entities before you remove the domain.</p>
241
+ * @see {@link DeregisterMailDomainCommand}
344
242
  */
345
243
  deregisterMailDomain(args: DeregisterMailDomainCommandInput, options?: __HttpHandlerOptions): Promise<DeregisterMailDomainCommandOutput>;
346
244
  deregisterMailDomain(args: DeregisterMailDomainCommandInput, cb: (err: any, data?: DeregisterMailDomainCommandOutput) => void): void;
347
245
  deregisterMailDomain(args: DeregisterMailDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeregisterMailDomainCommandOutput) => void): void;
348
246
  /**
349
- * @public
350
- * <p>Describes the current email monitoring configuration for a specified organization.</p>
247
+ * @see {@link DescribeEmailMonitoringConfigurationCommand}
351
248
  */
352
249
  describeEmailMonitoringConfiguration(args: DescribeEmailMonitoringConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<DescribeEmailMonitoringConfigurationCommandOutput>;
353
250
  describeEmailMonitoringConfiguration(args: DescribeEmailMonitoringConfigurationCommandInput, cb: (err: any, data?: DescribeEmailMonitoringConfigurationCommandOutput) => void): void;
354
251
  describeEmailMonitoringConfiguration(args: DescribeEmailMonitoringConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEmailMonitoringConfigurationCommandOutput) => void): void;
355
252
  /**
356
- * @public
357
- * <p>Returns the data available for the group.</p>
253
+ * @see {@link DescribeGroupCommand}
358
254
  */
359
255
  describeGroup(args: DescribeGroupCommandInput, options?: __HttpHandlerOptions): Promise<DescribeGroupCommandOutput>;
360
256
  describeGroup(args: DescribeGroupCommandInput, cb: (err: any, data?: DescribeGroupCommandOutput) => void): void;
361
257
  describeGroup(args: DescribeGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeGroupCommandOutput) => void): void;
362
258
  /**
363
- * @public
364
- * <p>Lists the settings in a DMARC policy for a specified organization.</p>
259
+ * @see {@link DescribeInboundDmarcSettingsCommand}
365
260
  */
366
261
  describeInboundDmarcSettings(args: DescribeInboundDmarcSettingsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeInboundDmarcSettingsCommandOutput>;
367
262
  describeInboundDmarcSettings(args: DescribeInboundDmarcSettingsCommandInput, cb: (err: any, data?: DescribeInboundDmarcSettingsCommandOutput) => void): void;
368
263
  describeInboundDmarcSettings(args: DescribeInboundDmarcSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeInboundDmarcSettingsCommandOutput) => void): void;
369
264
  /**
370
- * @public
371
- * <p>Describes the current status of a mailbox export job.</p>
265
+ * @see {@link DescribeMailboxExportJobCommand}
372
266
  */
373
267
  describeMailboxExportJob(args: DescribeMailboxExportJobCommandInput, options?: __HttpHandlerOptions): Promise<DescribeMailboxExportJobCommandOutput>;
374
268
  describeMailboxExportJob(args: DescribeMailboxExportJobCommandInput, cb: (err: any, data?: DescribeMailboxExportJobCommandOutput) => void): void;
375
269
  describeMailboxExportJob(args: DescribeMailboxExportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeMailboxExportJobCommandOutput) => void): void;
376
270
  /**
377
- * @public
378
- * <p>Provides more information regarding a given organization based on its
379
- * identifier.</p>
271
+ * @see {@link DescribeOrganizationCommand}
380
272
  */
381
273
  describeOrganization(args: DescribeOrganizationCommandInput, options?: __HttpHandlerOptions): Promise<DescribeOrganizationCommandOutput>;
382
274
  describeOrganization(args: DescribeOrganizationCommandInput, cb: (err: any, data?: DescribeOrganizationCommandOutput) => void): void;
383
275
  describeOrganization(args: DescribeOrganizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeOrganizationCommandOutput) => void): void;
384
276
  /**
385
- * @public
386
- * <p>Returns the data available for the resource.</p>
277
+ * @see {@link DescribeResourceCommand}
387
278
  */
388
279
  describeResource(args: DescribeResourceCommandInput, options?: __HttpHandlerOptions): Promise<DescribeResourceCommandOutput>;
389
280
  describeResource(args: DescribeResourceCommandInput, cb: (err: any, data?: DescribeResourceCommandOutput) => void): void;
390
281
  describeResource(args: DescribeResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeResourceCommandOutput) => void): void;
391
282
  /**
392
- * @public
393
- * <p>Provides information regarding the user.</p>
283
+ * @see {@link DescribeUserCommand}
394
284
  */
395
285
  describeUser(args: DescribeUserCommandInput, options?: __HttpHandlerOptions): Promise<DescribeUserCommandOutput>;
396
286
  describeUser(args: DescribeUserCommandInput, cb: (err: any, data?: DescribeUserCommandOutput) => void): void;
397
287
  describeUser(args: DescribeUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeUserCommandOutput) => void): void;
398
288
  /**
399
- * @public
400
- * <p>Removes a member from the resource's set of delegates.</p>
289
+ * @see {@link DisassociateDelegateFromResourceCommand}
401
290
  */
402
291
  disassociateDelegateFromResource(args: DisassociateDelegateFromResourceCommandInput, options?: __HttpHandlerOptions): Promise<DisassociateDelegateFromResourceCommandOutput>;
403
292
  disassociateDelegateFromResource(args: DisassociateDelegateFromResourceCommandInput, cb: (err: any, data?: DisassociateDelegateFromResourceCommandOutput) => void): void;
404
293
  disassociateDelegateFromResource(args: DisassociateDelegateFromResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateDelegateFromResourceCommandOutput) => void): void;
405
294
  /**
406
- * @public
407
- * <p>Removes a member from a group.</p>
295
+ * @see {@link DisassociateMemberFromGroupCommand}
408
296
  */
409
297
  disassociateMemberFromGroup(args: DisassociateMemberFromGroupCommandInput, options?: __HttpHandlerOptions): Promise<DisassociateMemberFromGroupCommandOutput>;
410
298
  disassociateMemberFromGroup(args: DisassociateMemberFromGroupCommandInput, cb: (err: any, data?: DisassociateMemberFromGroupCommandOutput) => void): void;
411
299
  disassociateMemberFromGroup(args: DisassociateMemberFromGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateMemberFromGroupCommandOutput) => void): void;
412
300
  /**
413
- * @public
414
- * <p>Gets the effects of an organization's access control rules as they apply to a
415
- * specified IPv4 address, access protocol action, and user ID or impersonation role ID. You must provide either the user ID or impersonation role ID. Impersonation role ID can only be used with Action EWS.</p>
301
+ * @see {@link GetAccessControlEffectCommand}
416
302
  */
417
303
  getAccessControlEffect(args: GetAccessControlEffectCommandInput, options?: __HttpHandlerOptions): Promise<GetAccessControlEffectCommandOutput>;
418
304
  getAccessControlEffect(args: GetAccessControlEffectCommandInput, cb: (err: any, data?: GetAccessControlEffectCommandOutput) => void): void;
419
305
  getAccessControlEffect(args: GetAccessControlEffectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAccessControlEffectCommandOutput) => void): void;
420
306
  /**
421
- * @public
422
- * <p>Gets the default retention policy details for the specified organization.</p>
307
+ * @see {@link GetDefaultRetentionPolicyCommand}
423
308
  */
424
309
  getDefaultRetentionPolicy(args: GetDefaultRetentionPolicyCommandInput, options?: __HttpHandlerOptions): Promise<GetDefaultRetentionPolicyCommandOutput>;
425
310
  getDefaultRetentionPolicy(args: GetDefaultRetentionPolicyCommandInput, cb: (err: any, data?: GetDefaultRetentionPolicyCommandOutput) => void): void;
426
311
  getDefaultRetentionPolicy(args: GetDefaultRetentionPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDefaultRetentionPolicyCommandOutput) => void): void;
427
312
  /**
428
- * @public
429
- * <p>Gets the impersonation role details for the given WorkMail organization.</p>
313
+ * @see {@link GetImpersonationRoleCommand}
430
314
  */
431
315
  getImpersonationRole(args: GetImpersonationRoleCommandInput, options?: __HttpHandlerOptions): Promise<GetImpersonationRoleCommandOutput>;
432
316
  getImpersonationRole(args: GetImpersonationRoleCommandInput, cb: (err: any, data?: GetImpersonationRoleCommandOutput) => void): void;
433
317
  getImpersonationRole(args: GetImpersonationRoleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetImpersonationRoleCommandOutput) => void): void;
434
318
  /**
435
- * @public
436
- * <p>Tests whether the given impersonation role can impersonate a target user.</p>
319
+ * @see {@link GetImpersonationRoleEffectCommand}
437
320
  */
438
321
  getImpersonationRoleEffect(args: GetImpersonationRoleEffectCommandInput, options?: __HttpHandlerOptions): Promise<GetImpersonationRoleEffectCommandOutput>;
439
322
  getImpersonationRoleEffect(args: GetImpersonationRoleEffectCommandInput, cb: (err: any, data?: GetImpersonationRoleEffectCommandOutput) => void): void;
440
323
  getImpersonationRoleEffect(args: GetImpersonationRoleEffectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetImpersonationRoleEffectCommandOutput) => void): void;
441
324
  /**
442
- * @public
443
- * <p>Requests a user's mailbox details for a specified organization and user.</p>
325
+ * @see {@link GetMailboxDetailsCommand}
444
326
  */
445
327
  getMailboxDetails(args: GetMailboxDetailsCommandInput, options?: __HttpHandlerOptions): Promise<GetMailboxDetailsCommandOutput>;
446
328
  getMailboxDetails(args: GetMailboxDetailsCommandInput, cb: (err: any, data?: GetMailboxDetailsCommandOutput) => void): void;
447
329
  getMailboxDetails(args: GetMailboxDetailsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMailboxDetailsCommandOutput) => void): void;
448
330
  /**
449
- * @public
450
- * <p>Gets details for a mail domain, including domain records required to configure your domain with recommended security.</p>
331
+ * @see {@link GetMailDomainCommand}
451
332
  */
452
333
  getMailDomain(args: GetMailDomainCommandInput, options?: __HttpHandlerOptions): Promise<GetMailDomainCommandOutput>;
453
334
  getMailDomain(args: GetMailDomainCommandInput, cb: (err: any, data?: GetMailDomainCommandOutput) => void): void;
454
335
  getMailDomain(args: GetMailDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMailDomainCommandOutput) => void): void;
455
336
  /**
456
- * @public
457
- * <p>Simulates the effect of the mobile device access rules for the given attributes of a sample access event. Use this method to test the effects of the current set of mobile device access
458
- * rules for the WorkMail organization for a particular user's attributes.</p>
337
+ * @see {@link GetMobileDeviceAccessEffectCommand}
459
338
  */
460
339
  getMobileDeviceAccessEffect(args: GetMobileDeviceAccessEffectCommandInput, options?: __HttpHandlerOptions): Promise<GetMobileDeviceAccessEffectCommandOutput>;
461
340
  getMobileDeviceAccessEffect(args: GetMobileDeviceAccessEffectCommandInput, cb: (err: any, data?: GetMobileDeviceAccessEffectCommandOutput) => void): void;
462
341
  getMobileDeviceAccessEffect(args: GetMobileDeviceAccessEffectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMobileDeviceAccessEffectCommandOutput) => void): void;
463
342
  /**
464
- * @public
465
- * <p>Gets the mobile device access override for the given WorkMail organization, user, and device.</p>
343
+ * @see {@link GetMobileDeviceAccessOverrideCommand}
466
344
  */
467
345
  getMobileDeviceAccessOverride(args: GetMobileDeviceAccessOverrideCommandInput, options?: __HttpHandlerOptions): Promise<GetMobileDeviceAccessOverrideCommandOutput>;
468
346
  getMobileDeviceAccessOverride(args: GetMobileDeviceAccessOverrideCommandInput, cb: (err: any, data?: GetMobileDeviceAccessOverrideCommandOutput) => void): void;
469
347
  getMobileDeviceAccessOverride(args: GetMobileDeviceAccessOverrideCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMobileDeviceAccessOverrideCommandOutput) => void): void;
470
348
  /**
471
- * @public
472
- * <p>Lists the access control rules for the specified organization.</p>
349
+ * @see {@link ListAccessControlRulesCommand}
473
350
  */
474
351
  listAccessControlRules(args: ListAccessControlRulesCommandInput, options?: __HttpHandlerOptions): Promise<ListAccessControlRulesCommandOutput>;
475
352
  listAccessControlRules(args: ListAccessControlRulesCommandInput, cb: (err: any, data?: ListAccessControlRulesCommandOutput) => void): void;
476
353
  listAccessControlRules(args: ListAccessControlRulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAccessControlRulesCommandOutput) => void): void;
477
354
  /**
478
- * @public
479
- * <p>Creates a paginated call to list the aliases associated with a given
480
- * entity.</p>
355
+ * @see {@link ListAliasesCommand}
481
356
  */
482
357
  listAliases(args: ListAliasesCommandInput, options?: __HttpHandlerOptions): Promise<ListAliasesCommandOutput>;
483
358
  listAliases(args: ListAliasesCommandInput, cb: (err: any, data?: ListAliasesCommandOutput) => void): void;
484
359
  listAliases(args: ListAliasesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAliasesCommandOutput) => void): void;
485
360
  /**
486
- * @public
487
- * <p>List all the <code>AvailabilityConfiguration</code>'s for the given WorkMail organization.</p>
361
+ * @see {@link ListAvailabilityConfigurationsCommand}
488
362
  */
489
363
  listAvailabilityConfigurations(args: ListAvailabilityConfigurationsCommandInput, options?: __HttpHandlerOptions): Promise<ListAvailabilityConfigurationsCommandOutput>;
490
364
  listAvailabilityConfigurations(args: ListAvailabilityConfigurationsCommandInput, cb: (err: any, data?: ListAvailabilityConfigurationsCommandOutput) => void): void;
491
365
  listAvailabilityConfigurations(args: ListAvailabilityConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAvailabilityConfigurationsCommandOutput) => void): void;
492
366
  /**
493
- * @public
494
- * <p>Returns an overview of the members of a group. Users and groups can be members of a
495
- * group.</p>
367
+ * @see {@link ListGroupMembersCommand}
496
368
  */
497
369
  listGroupMembers(args: ListGroupMembersCommandInput, options?: __HttpHandlerOptions): Promise<ListGroupMembersCommandOutput>;
498
370
  listGroupMembers(args: ListGroupMembersCommandInput, cb: (err: any, data?: ListGroupMembersCommandOutput) => void): void;
499
371
  listGroupMembers(args: ListGroupMembersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGroupMembersCommandOutput) => void): void;
500
372
  /**
501
- * @public
502
- * <p>Returns summaries of the organization's groups.</p>
373
+ * @see {@link ListGroupsCommand}
503
374
  */
504
375
  listGroups(args: ListGroupsCommandInput, options?: __HttpHandlerOptions): Promise<ListGroupsCommandOutput>;
505
376
  listGroups(args: ListGroupsCommandInput, cb: (err: any, data?: ListGroupsCommandOutput) => void): void;
506
377
  listGroups(args: ListGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGroupsCommandOutput) => void): void;
507
378
  /**
508
- * @public
509
- * <p>Lists all the impersonation roles for the given WorkMail organization.</p>
379
+ * @see {@link ListImpersonationRolesCommand}
510
380
  */
511
381
  listImpersonationRoles(args: ListImpersonationRolesCommandInput, options?: __HttpHandlerOptions): Promise<ListImpersonationRolesCommandOutput>;
512
382
  listImpersonationRoles(args: ListImpersonationRolesCommandInput, cb: (err: any, data?: ListImpersonationRolesCommandOutput) => void): void;
513
383
  listImpersonationRoles(args: ListImpersonationRolesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListImpersonationRolesCommandOutput) => void): void;
514
384
  /**
515
- * @public
516
- * <p>Lists the mailbox export jobs started for the specified organization within the last
517
- * seven days.</p>
385
+ * @see {@link ListMailboxExportJobsCommand}
518
386
  */
519
387
  listMailboxExportJobs(args: ListMailboxExportJobsCommandInput, options?: __HttpHandlerOptions): Promise<ListMailboxExportJobsCommandOutput>;
520
388
  listMailboxExportJobs(args: ListMailboxExportJobsCommandInput, cb: (err: any, data?: ListMailboxExportJobsCommandOutput) => void): void;
521
389
  listMailboxExportJobs(args: ListMailboxExportJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMailboxExportJobsCommandOutput) => void): void;
522
390
  /**
523
- * @public
524
- * <p>Lists the mailbox permissions associated with a user, group, or resource
525
- * mailbox.</p>
391
+ * @see {@link ListMailboxPermissionsCommand}
526
392
  */
527
393
  listMailboxPermissions(args: ListMailboxPermissionsCommandInput, options?: __HttpHandlerOptions): Promise<ListMailboxPermissionsCommandOutput>;
528
394
  listMailboxPermissions(args: ListMailboxPermissionsCommandInput, cb: (err: any, data?: ListMailboxPermissionsCommandOutput) => void): void;
529
395
  listMailboxPermissions(args: ListMailboxPermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMailboxPermissionsCommandOutput) => void): void;
530
396
  /**
531
- * @public
532
- * <p>Lists the mail domains in a given WorkMail organization.</p>
397
+ * @see {@link ListMailDomainsCommand}
533
398
  */
534
399
  listMailDomains(args: ListMailDomainsCommandInput, options?: __HttpHandlerOptions): Promise<ListMailDomainsCommandOutput>;
535
400
  listMailDomains(args: ListMailDomainsCommandInput, cb: (err: any, data?: ListMailDomainsCommandOutput) => void): void;
536
401
  listMailDomains(args: ListMailDomainsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMailDomainsCommandOutput) => void): void;
537
402
  /**
538
- * @public
539
- * <p>Lists all the mobile device access overrides for any given combination of WorkMail organization, user, or device.</p>
403
+ * @see {@link ListMobileDeviceAccessOverridesCommand}
540
404
  */
541
405
  listMobileDeviceAccessOverrides(args: ListMobileDeviceAccessOverridesCommandInput, options?: __HttpHandlerOptions): Promise<ListMobileDeviceAccessOverridesCommandOutput>;
542
406
  listMobileDeviceAccessOverrides(args: ListMobileDeviceAccessOverridesCommandInput, cb: (err: any, data?: ListMobileDeviceAccessOverridesCommandOutput) => void): void;
543
407
  listMobileDeviceAccessOverrides(args: ListMobileDeviceAccessOverridesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMobileDeviceAccessOverridesCommandOutput) => void): void;
544
408
  /**
545
- * @public
546
- * <p>Lists the mobile device access rules for the specified WorkMail organization.</p>
409
+ * @see {@link ListMobileDeviceAccessRulesCommand}
547
410
  */
548
411
  listMobileDeviceAccessRules(args: ListMobileDeviceAccessRulesCommandInput, options?: __HttpHandlerOptions): Promise<ListMobileDeviceAccessRulesCommandOutput>;
549
412
  listMobileDeviceAccessRules(args: ListMobileDeviceAccessRulesCommandInput, cb: (err: any, data?: ListMobileDeviceAccessRulesCommandOutput) => void): void;
550
413
  listMobileDeviceAccessRules(args: ListMobileDeviceAccessRulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMobileDeviceAccessRulesCommandOutput) => void): void;
551
414
  /**
552
- * @public
553
- * <p>Returns summaries of the customer's organizations.</p>
415
+ * @see {@link ListOrganizationsCommand}
554
416
  */
555
417
  listOrganizations(args: ListOrganizationsCommandInput, options?: __HttpHandlerOptions): Promise<ListOrganizationsCommandOutput>;
556
418
  listOrganizations(args: ListOrganizationsCommandInput, cb: (err: any, data?: ListOrganizationsCommandOutput) => void): void;
557
419
  listOrganizations(args: ListOrganizationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListOrganizationsCommandOutput) => void): void;
558
420
  /**
559
- * @public
560
- * <p>Lists the delegates associated with a resource. Users and groups can be resource
561
- * delegates and answer requests on behalf of the resource.</p>
421
+ * @see {@link ListResourceDelegatesCommand}
562
422
  */
563
423
  listResourceDelegates(args: ListResourceDelegatesCommandInput, options?: __HttpHandlerOptions): Promise<ListResourceDelegatesCommandOutput>;
564
424
  listResourceDelegates(args: ListResourceDelegatesCommandInput, cb: (err: any, data?: ListResourceDelegatesCommandOutput) => void): void;
565
425
  listResourceDelegates(args: ListResourceDelegatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListResourceDelegatesCommandOutput) => void): void;
566
426
  /**
567
- * @public
568
- * <p>Returns summaries of the organization's resources.</p>
427
+ * @see {@link ListResourcesCommand}
569
428
  */
570
429
  listResources(args: ListResourcesCommandInput, options?: __HttpHandlerOptions): Promise<ListResourcesCommandOutput>;
571
430
  listResources(args: ListResourcesCommandInput, cb: (err: any, data?: ListResourcesCommandOutput) => void): void;
572
431
  listResources(args: ListResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListResourcesCommandOutput) => void): void;
573
432
  /**
574
- * @public
575
- * <p>Lists the tags applied to an WorkMail organization resource.</p>
433
+ * @see {@link ListTagsForResourceCommand}
576
434
  */
577
435
  listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
578
436
  listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
579
437
  listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
580
438
  /**
581
- * @public
582
- * <p>Returns summaries of the organization's users.</p>
439
+ * @see {@link ListUsersCommand}
583
440
  */
584
441
  listUsers(args: ListUsersCommandInput, options?: __HttpHandlerOptions): Promise<ListUsersCommandOutput>;
585
442
  listUsers(args: ListUsersCommandInput, cb: (err: any, data?: ListUsersCommandOutput) => void): void;
586
443
  listUsers(args: ListUsersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListUsersCommandOutput) => void): void;
587
444
  /**
588
- * @public
589
- * <p>Adds a new access control rule for the specified organization. The rule allows or
590
- * denies access to the organization for the specified IPv4 addresses, access protocol
591
- * actions, user IDs and impersonation IDs. Adding a new rule with the same name as an existing rule replaces
592
- * the older rule.</p>
445
+ * @see {@link PutAccessControlRuleCommand}
593
446
  */
594
447
  putAccessControlRule(args: PutAccessControlRuleCommandInput, options?: __HttpHandlerOptions): Promise<PutAccessControlRuleCommandOutput>;
595
448
  putAccessControlRule(args: PutAccessControlRuleCommandInput, cb: (err: any, data?: PutAccessControlRuleCommandOutput) => void): void;
596
449
  putAccessControlRule(args: PutAccessControlRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutAccessControlRuleCommandOutput) => void): void;
597
450
  /**
598
- * @public
599
- * <p>Creates or updates the email monitoring configuration for a specified organization.</p>
451
+ * @see {@link PutEmailMonitoringConfigurationCommand}
600
452
  */
601
453
  putEmailMonitoringConfiguration(args: PutEmailMonitoringConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<PutEmailMonitoringConfigurationCommandOutput>;
602
454
  putEmailMonitoringConfiguration(args: PutEmailMonitoringConfigurationCommandInput, cb: (err: any, data?: PutEmailMonitoringConfigurationCommandOutput) => void): void;
603
455
  putEmailMonitoringConfiguration(args: PutEmailMonitoringConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutEmailMonitoringConfigurationCommandOutput) => void): void;
604
456
  /**
605
- * @public
606
- * <p>Enables or disables a DMARC policy for a given organization.</p>
457
+ * @see {@link PutInboundDmarcSettingsCommand}
607
458
  */
608
459
  putInboundDmarcSettings(args: PutInboundDmarcSettingsCommandInput, options?: __HttpHandlerOptions): Promise<PutInboundDmarcSettingsCommandOutput>;
609
460
  putInboundDmarcSettings(args: PutInboundDmarcSettingsCommandInput, cb: (err: any, data?: PutInboundDmarcSettingsCommandOutput) => void): void;
610
461
  putInboundDmarcSettings(args: PutInboundDmarcSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutInboundDmarcSettingsCommandOutput) => void): void;
611
462
  /**
612
- * @public
613
- * <p>Sets permissions for a user, group, or resource. This replaces any pre-existing
614
- * permissions.</p>
463
+ * @see {@link PutMailboxPermissionsCommand}
615
464
  */
616
465
  putMailboxPermissions(args: PutMailboxPermissionsCommandInput, options?: __HttpHandlerOptions): Promise<PutMailboxPermissionsCommandOutput>;
617
466
  putMailboxPermissions(args: PutMailboxPermissionsCommandInput, cb: (err: any, data?: PutMailboxPermissionsCommandOutput) => void): void;
618
467
  putMailboxPermissions(args: PutMailboxPermissionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutMailboxPermissionsCommandOutput) => void): void;
619
468
  /**
620
- * @public
621
- * <p>Creates or updates a mobile device access override for the given WorkMail organization, user, and device.</p>
469
+ * @see {@link PutMobileDeviceAccessOverrideCommand}
622
470
  */
623
471
  putMobileDeviceAccessOverride(args: PutMobileDeviceAccessOverrideCommandInput, options?: __HttpHandlerOptions): Promise<PutMobileDeviceAccessOverrideCommandOutput>;
624
472
  putMobileDeviceAccessOverride(args: PutMobileDeviceAccessOverrideCommandInput, cb: (err: any, data?: PutMobileDeviceAccessOverrideCommandOutput) => void): void;
625
473
  putMobileDeviceAccessOverride(args: PutMobileDeviceAccessOverrideCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutMobileDeviceAccessOverrideCommandOutput) => void): void;
626
474
  /**
627
- * @public
628
- * <p>Puts a retention policy to the specified organization.</p>
475
+ * @see {@link PutRetentionPolicyCommand}
629
476
  */
630
477
  putRetentionPolicy(args: PutRetentionPolicyCommandInput, options?: __HttpHandlerOptions): Promise<PutRetentionPolicyCommandOutput>;
631
478
  putRetentionPolicy(args: PutRetentionPolicyCommandInput, cb: (err: any, data?: PutRetentionPolicyCommandOutput) => void): void;
632
479
  putRetentionPolicy(args: PutRetentionPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutRetentionPolicyCommandOutput) => void): void;
633
480
  /**
634
- * @public
635
- * <p>Registers a new domain in WorkMail and SES, and configures it for use by WorkMail. Emails received by SES for this domain are routed to the specified WorkMail organization, and WorkMail has
636
- * permanent permission to use the specified domain for sending your users' emails.</p>
481
+ * @see {@link RegisterMailDomainCommand}
637
482
  */
638
483
  registerMailDomain(args: RegisterMailDomainCommandInput, options?: __HttpHandlerOptions): Promise<RegisterMailDomainCommandOutput>;
639
484
  registerMailDomain(args: RegisterMailDomainCommandInput, cb: (err: any, data?: RegisterMailDomainCommandOutput) => void): void;
640
485
  registerMailDomain(args: RegisterMailDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterMailDomainCommandOutput) => void): void;
641
486
  /**
642
- * @public
643
- * <p>Registers an existing and disabled user, group, or resource for WorkMail use by
644
- * associating a mailbox and calendaring capabilities. It performs no change if the user,
645
- * group, or resource is enabled and fails if the user, group, or resource is deleted. This
646
- * operation results in the accumulation of costs. For more information, see <a href="https://aws.amazon.com/workmail/pricing">Pricing</a>. The equivalent console
647
- * functionality for this operation is <i>Enable</i>.</p>
648
- * <p>Users can either be created by calling the <a>CreateUser</a> API operation
649
- * or they can be synchronized from your directory. For more information, see <a>DeregisterFromWorkMail</a>.</p>
487
+ * @see {@link RegisterToWorkMailCommand}
650
488
  */
651
489
  registerToWorkMail(args: RegisterToWorkMailCommandInput, options?: __HttpHandlerOptions): Promise<RegisterToWorkMailCommandOutput>;
652
490
  registerToWorkMail(args: RegisterToWorkMailCommandInput, cb: (err: any, data?: RegisterToWorkMailCommandOutput) => void): void;
653
491
  registerToWorkMail(args: RegisterToWorkMailCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterToWorkMailCommandOutput) => void): void;
654
492
  /**
655
- * @public
656
- * <p>Allows the administrator to reset the password for a user.</p>
493
+ * @see {@link ResetPasswordCommand}
657
494
  */
658
495
  resetPassword(args: ResetPasswordCommandInput, options?: __HttpHandlerOptions): Promise<ResetPasswordCommandOutput>;
659
496
  resetPassword(args: ResetPasswordCommandInput, cb: (err: any, data?: ResetPasswordCommandOutput) => void): void;
660
497
  resetPassword(args: ResetPasswordCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResetPasswordCommandOutput) => void): void;
661
498
  /**
662
- * @public
663
- * <p>Starts a mailbox export job to export MIME-format email messages and calendar items
664
- * from the specified mailbox to the specified Amazon Simple Storage Service (Amazon S3)
665
- * bucket. For more information, see <a href="https://docs.aws.amazon.com/workmail/latest/adminguide/mail-export.html">Exporting mailbox content</a> in
666
- * the <i>WorkMail Administrator Guide</i>.</p>
499
+ * @see {@link StartMailboxExportJobCommand}
667
500
  */
668
501
  startMailboxExportJob(args: StartMailboxExportJobCommandInput, options?: __HttpHandlerOptions): Promise<StartMailboxExportJobCommandOutput>;
669
502
  startMailboxExportJob(args: StartMailboxExportJobCommandInput, cb: (err: any, data?: StartMailboxExportJobCommandOutput) => void): void;
670
503
  startMailboxExportJob(args: StartMailboxExportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartMailboxExportJobCommandOutput) => void): void;
671
504
  /**
672
- * @public
673
- * <p>Applies the specified tags to the specified WorkMailorganization
674
- * resource.</p>
505
+ * @see {@link TagResourceCommand}
675
506
  */
676
507
  tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
677
508
  tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
678
509
  tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
679
510
  /**
680
- * @public
681
- * <p>Performs a test on an availability provider to ensure that access is allowed. For EWS, it verifies the provided credentials can be used to successfully log in. For Lambda, it verifies that the Lambda function can be invoked and that the resource access
682
- * policy was configured to deny anonymous access. An anonymous invocation is one done without providing either a <code>SourceArn</code> or <code>SourceAccount</code> header.</p>
683
- * <note>
684
- * <p>The request must contain either one provider definition (<code>EwsProvider</code> or
685
- * <code>LambdaProvider</code>) or the <code>DomainName</code> parameter. If the
686
- * <code>DomainName</code> parameter is provided, the configuration stored under the
687
- * <code>DomainName</code> will be tested.</p>
688
- * </note>
511
+ * @see {@link TestAvailabilityConfigurationCommand}
689
512
  */
690
513
  testAvailabilityConfiguration(args: TestAvailabilityConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<TestAvailabilityConfigurationCommandOutput>;
691
514
  testAvailabilityConfiguration(args: TestAvailabilityConfigurationCommandInput, cb: (err: any, data?: TestAvailabilityConfigurationCommandOutput) => void): void;
692
515
  testAvailabilityConfiguration(args: TestAvailabilityConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TestAvailabilityConfigurationCommandOutput) => void): void;
693
516
  /**
694
- * @public
695
- * <p>Untags the specified tags from the specified WorkMail organization
696
- * resource.</p>
517
+ * @see {@link UntagResourceCommand}
697
518
  */
698
519
  untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
699
520
  untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
700
521
  untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
701
522
  /**
702
- * @public
703
- * <p>Updates an existing <code>AvailabilityConfiguration</code> for the given WorkMail
704
- * organization and domain.</p>
523
+ * @see {@link UpdateAvailabilityConfigurationCommand}
705
524
  */
706
525
  updateAvailabilityConfiguration(args: UpdateAvailabilityConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<UpdateAvailabilityConfigurationCommandOutput>;
707
526
  updateAvailabilityConfiguration(args: UpdateAvailabilityConfigurationCommandInput, cb: (err: any, data?: UpdateAvailabilityConfigurationCommandOutput) => void): void;
708
527
  updateAvailabilityConfiguration(args: UpdateAvailabilityConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAvailabilityConfigurationCommandOutput) => void): void;
709
528
  /**
710
- * @public
711
- * <p>Updates the default mail domain for an organization. The default mail domain is used by the WorkMail AWS Console to suggest an email address when enabling a mail user. You can only have one default domain.</p>
529
+ * @see {@link UpdateDefaultMailDomainCommand}
712
530
  */
713
531
  updateDefaultMailDomain(args: UpdateDefaultMailDomainCommandInput, options?: __HttpHandlerOptions): Promise<UpdateDefaultMailDomainCommandOutput>;
714
532
  updateDefaultMailDomain(args: UpdateDefaultMailDomainCommandInput, cb: (err: any, data?: UpdateDefaultMailDomainCommandOutput) => void): void;
715
533
  updateDefaultMailDomain(args: UpdateDefaultMailDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDefaultMailDomainCommandOutput) => void): void;
716
534
  /**
717
- * @public
718
- * <p>Updates an impersonation role for the given WorkMail organization.</p>
535
+ * @see {@link UpdateImpersonationRoleCommand}
719
536
  */
720
537
  updateImpersonationRole(args: UpdateImpersonationRoleCommandInput, options?: __HttpHandlerOptions): Promise<UpdateImpersonationRoleCommandOutput>;
721
538
  updateImpersonationRole(args: UpdateImpersonationRoleCommandInput, cb: (err: any, data?: UpdateImpersonationRoleCommandOutput) => void): void;
722
539
  updateImpersonationRole(args: UpdateImpersonationRoleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateImpersonationRoleCommandOutput) => void): void;
723
540
  /**
724
- * @public
725
- * <p>Updates a user's current mailbox quota for a specified organization and
726
- * user.</p>
541
+ * @see {@link UpdateMailboxQuotaCommand}
727
542
  */
728
543
  updateMailboxQuota(args: UpdateMailboxQuotaCommandInput, options?: __HttpHandlerOptions): Promise<UpdateMailboxQuotaCommandOutput>;
729
544
  updateMailboxQuota(args: UpdateMailboxQuotaCommandInput, cb: (err: any, data?: UpdateMailboxQuotaCommandOutput) => void): void;
730
545
  updateMailboxQuota(args: UpdateMailboxQuotaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateMailboxQuotaCommandOutput) => void): void;
731
546
  /**
732
- * @public
733
- * <p>Updates a mobile device access rule for the specified WorkMail organization.</p>
547
+ * @see {@link UpdateMobileDeviceAccessRuleCommand}
734
548
  */
735
549
  updateMobileDeviceAccessRule(args: UpdateMobileDeviceAccessRuleCommandInput, options?: __HttpHandlerOptions): Promise<UpdateMobileDeviceAccessRuleCommandOutput>;
736
550
  updateMobileDeviceAccessRule(args: UpdateMobileDeviceAccessRuleCommandInput, cb: (err: any, data?: UpdateMobileDeviceAccessRuleCommandOutput) => void): void;
737
551
  updateMobileDeviceAccessRule(args: UpdateMobileDeviceAccessRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateMobileDeviceAccessRuleCommandOutput) => void): void;
738
552
  /**
739
- * @public
740
- * <p>Updates the primary email for a user, group, or resource. The current email is moved
741
- * into the list of aliases (or swapped between an existing alias and the current primary
742
- * email), and the email provided in the input is promoted as the primary.</p>
553
+ * @see {@link UpdatePrimaryEmailAddressCommand}
743
554
  */
744
555
  updatePrimaryEmailAddress(args: UpdatePrimaryEmailAddressCommandInput, options?: __HttpHandlerOptions): Promise<UpdatePrimaryEmailAddressCommandOutput>;
745
556
  updatePrimaryEmailAddress(args: UpdatePrimaryEmailAddressCommandInput, cb: (err: any, data?: UpdatePrimaryEmailAddressCommandOutput) => void): void;
746
557
  updatePrimaryEmailAddress(args: UpdatePrimaryEmailAddressCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePrimaryEmailAddressCommandOutput) => void): void;
747
558
  /**
748
- * @public
749
- * <p>Updates data for the resource. To have the latest information, it must be preceded by
750
- * a <a>DescribeResource</a> call. The dataset in the request should be the one
751
- * expected when performing another <code>DescribeResource</code> call.</p>
559
+ * @see {@link UpdateResourceCommand}
752
560
  */
753
561
  updateResource(args: UpdateResourceCommandInput, options?: __HttpHandlerOptions): Promise<UpdateResourceCommandOutput>;
754
562
  updateResource(args: UpdateResourceCommandInput, cb: (err: any, data?: UpdateResourceCommandOutput) => void): void;
755
563
  updateResource(args: UpdateResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateResourceCommandOutput) => void): void;
756
564
  }
565
+ /**
566
+ * @public
567
+ * <p>WorkMail is a secure, managed business email and calendaring service with support for
568
+ * existing desktop and mobile email clients. You can access your email, contacts, and
569
+ * calendars using Microsoft Outlook, your browser, or other native iOS and Android email
570
+ * applications. You can integrate WorkMail with your existing corporate directory and control
571
+ * both the keys that encrypt your data and the location in which your data is
572
+ * stored.</p>
573
+ * <p>The WorkMail API is designed for the following scenarios:</p>
574
+ * <ul>
575
+ * <li>
576
+ * <p>Listing and describing organizations</p>
577
+ * </li>
578
+ * </ul>
579
+ * <ul>
580
+ * <li>
581
+ * <p>Managing users</p>
582
+ * </li>
583
+ * </ul>
584
+ * <ul>
585
+ * <li>
586
+ * <p>Managing groups</p>
587
+ * </li>
588
+ * </ul>
589
+ * <ul>
590
+ * <li>
591
+ * <p>Managing resources</p>
592
+ * </li>
593
+ * </ul>
594
+ * <p>All WorkMail API operations are Amazon-authenticated and certificate-signed. They not
595
+ * only require the use of the AWS SDK, but also allow for the exclusive use of AWS Identity and Access Management
596
+ * users and roles to help facilitate access, trust, and permission policies. By creating a
597
+ * role and allowing an IAM user to access the WorkMail site, the IAM user gains full
598
+ * administrative visibility into the entire WorkMail organization (or as set in the IAM
599
+ * policy). This includes, but is not limited to, the ability to create, update, and delete
600
+ * users, groups, and resources. This allows developers to perform the scenarios listed above,
601
+ * as well as give users the ability to grant access on a selective basis using the IAM
602
+ * model.</p>
603
+ */
604
+ export declare class WorkMail extends WorkMailClient implements WorkMail {
605
+ }