@aws-sdk/client-workmail 3.321.1 → 3.326.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.
Files changed (81) hide show
  1. package/dist-types/commands/AssociateDelegateToResourceCommand.d.ts +4 -0
  2. package/dist-types/commands/AssociateMemberToGroupCommand.d.ts +4 -0
  3. package/dist-types/commands/AssumeImpersonationRoleCommand.d.ts +7 -0
  4. package/dist-types/commands/CancelMailboxExportJobCommand.d.ts +4 -0
  5. package/dist-types/commands/CreateAliasCommand.d.ts +4 -0
  6. package/dist-types/commands/CreateAvailabilityConfigurationCommand.d.ts +4 -0
  7. package/dist-types/commands/CreateGroupCommand.d.ts +6 -0
  8. package/dist-types/commands/CreateImpersonationRoleCommand.d.ts +6 -0
  9. package/dist-types/commands/CreateMobileDeviceAccessRuleCommand.d.ts +6 -0
  10. package/dist-types/commands/CreateOrganizationCommand.d.ts +6 -0
  11. package/dist-types/commands/CreateResourceCommand.d.ts +6 -0
  12. package/dist-types/commands/CreateUserCommand.d.ts +6 -0
  13. package/dist-types/commands/DeleteAccessControlRuleCommand.d.ts +4 -0
  14. package/dist-types/commands/DeleteAliasCommand.d.ts +4 -0
  15. package/dist-types/commands/DeleteAvailabilityConfigurationCommand.d.ts +4 -0
  16. package/dist-types/commands/DeleteEmailMonitoringConfigurationCommand.d.ts +4 -0
  17. package/dist-types/commands/DeleteGroupCommand.d.ts +4 -0
  18. package/dist-types/commands/DeleteImpersonationRoleCommand.d.ts +4 -0
  19. package/dist-types/commands/DeleteMailboxPermissionsCommand.d.ts +4 -0
  20. package/dist-types/commands/DeleteMobileDeviceAccessOverrideCommand.d.ts +4 -0
  21. package/dist-types/commands/DeleteMobileDeviceAccessRuleCommand.d.ts +4 -0
  22. package/dist-types/commands/DeleteOrganizationCommand.d.ts +7 -0
  23. package/dist-types/commands/DeleteResourceCommand.d.ts +4 -0
  24. package/dist-types/commands/DeleteRetentionPolicyCommand.d.ts +4 -0
  25. package/dist-types/commands/DeleteUserCommand.d.ts +4 -0
  26. package/dist-types/commands/DeregisterFromWorkMailCommand.d.ts +4 -0
  27. package/dist-types/commands/DeregisterMailDomainCommand.d.ts +4 -0
  28. package/dist-types/commands/DescribeEmailMonitoringConfigurationCommand.d.ts +7 -0
  29. package/dist-types/commands/DescribeGroupCommand.d.ts +11 -0
  30. package/dist-types/commands/DescribeInboundDmarcSettingsCommand.d.ts +6 -0
  31. package/dist-types/commands/DescribeMailboxExportJobCommand.d.ts +17 -0
  32. package/dist-types/commands/DescribeOrganizationCommand.d.ts +14 -0
  33. package/dist-types/commands/DescribeResourceCommand.d.ts +17 -0
  34. package/dist-types/commands/DescribeUserCommand.d.ts +13 -0
  35. package/dist-types/commands/DisassociateDelegateFromResourceCommand.d.ts +4 -0
  36. package/dist-types/commands/DisassociateMemberFromGroupCommand.d.ts +4 -0
  37. package/dist-types/commands/GetAccessControlEffectCommand.d.ts +9 -0
  38. package/dist-types/commands/GetDefaultRetentionPolicyCommand.d.ts +15 -0
  39. package/dist-types/commands/GetImpersonationRoleCommand.d.ts +25 -0
  40. package/dist-types/commands/GetImpersonationRoleEffectCommand.d.ts +13 -0
  41. package/dist-types/commands/GetMailDomainCommand.d.ts +16 -0
  42. package/dist-types/commands/GetMailboxDetailsCommand.d.ts +7 -0
  43. package/dist-types/commands/GetMobileDeviceAccessEffectCommand.d.ts +12 -0
  44. package/dist-types/commands/GetMobileDeviceAccessOverrideCommand.d.ts +11 -0
  45. package/dist-types/commands/ListAccessControlRulesCommand.d.ts +38 -0
  46. package/dist-types/commands/ListAliasesCommand.d.ts +9 -0
  47. package/dist-types/commands/ListAvailabilityConfigurationsCommand.d.ts +21 -0
  48. package/dist-types/commands/ListGroupMembersCommand.d.ts +16 -0
  49. package/dist-types/commands/ListGroupsCommand.d.ts +16 -0
  50. package/dist-types/commands/ListImpersonationRolesCommand.d.ts +15 -0
  51. package/dist-types/commands/ListMailDomainsCommand.d.ts +12 -0
  52. package/dist-types/commands/ListMailboxExportJobsCommand.d.ts +19 -0
  53. package/dist-types/commands/ListMailboxPermissionsCommand.d.ts +15 -0
  54. package/dist-types/commands/ListMobileDeviceAccessOverridesCommand.d.ts +16 -0
  55. package/dist-types/commands/ListMobileDeviceAccessRulesCommand.d.ts +39 -0
  56. package/dist-types/commands/ListOrganizationsCommand.d.ts +15 -0
  57. package/dist-types/commands/ListResourceDelegatesCommand.d.ts +12 -0
  58. package/dist-types/commands/ListResourcesCommand.d.ts +17 -0
  59. package/dist-types/commands/ListTagsForResourceCommand.d.ts +11 -0
  60. package/dist-types/commands/ListUsersCommand.d.ts +18 -0
  61. package/dist-types/commands/PutAccessControlRuleCommand.d.ts +4 -0
  62. package/dist-types/commands/PutEmailMonitoringConfigurationCommand.d.ts +4 -0
  63. package/dist-types/commands/PutInboundDmarcSettingsCommand.d.ts +4 -0
  64. package/dist-types/commands/PutMailboxPermissionsCommand.d.ts +4 -0
  65. package/dist-types/commands/PutMobileDeviceAccessOverrideCommand.d.ts +4 -0
  66. package/dist-types/commands/PutRetentionPolicyCommand.d.ts +4 -0
  67. package/dist-types/commands/RegisterMailDomainCommand.d.ts +4 -0
  68. package/dist-types/commands/RegisterToWorkMailCommand.d.ts +4 -0
  69. package/dist-types/commands/ResetPasswordCommand.d.ts +4 -0
  70. package/dist-types/commands/StartMailboxExportJobCommand.d.ts +6 -0
  71. package/dist-types/commands/TagResourceCommand.d.ts +4 -0
  72. package/dist-types/commands/TestAvailabilityConfigurationCommand.d.ts +7 -0
  73. package/dist-types/commands/UntagResourceCommand.d.ts +4 -0
  74. package/dist-types/commands/UpdateAvailabilityConfigurationCommand.d.ts +4 -0
  75. package/dist-types/commands/UpdateDefaultMailDomainCommand.d.ts +4 -0
  76. package/dist-types/commands/UpdateImpersonationRoleCommand.d.ts +4 -0
  77. package/dist-types/commands/UpdateMailboxQuotaCommand.d.ts +4 -0
  78. package/dist-types/commands/UpdateMobileDeviceAccessRuleCommand.d.ts +4 -0
  79. package/dist-types/commands/UpdatePrimaryEmailAddressCommand.d.ts +4 -0
  80. package/dist-types/commands/UpdateResourceCommand.d.ts +4 -0
  81. package/package.json +16 -16
@@ -33,6 +33,8 @@ export interface AssociateDelegateToResourceCommandOutput extends AssociateDeleg
33
33
  * };
34
34
  * const command = new AssociateDelegateToResourceCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // {};
37
+ *
36
38
  * ```
37
39
  *
38
40
  * @param AssociateDelegateToResourceCommandInput - {@link AssociateDelegateToResourceCommandInput}
@@ -60,6 +62,8 @@ export interface AssociateDelegateToResourceCommandOutput extends AssociateDeleg
60
62
  * <p>The organization must have a valid state to perform certain
61
63
  * operations on the organization or its members.</p>
62
64
  *
65
+ * @throws {@link WorkMailServiceException}
66
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
63
67
  *
64
68
  */
65
69
  export declare class AssociateDelegateToResourceCommand extends $Command<AssociateDelegateToResourceCommandInput, AssociateDelegateToResourceCommandOutput, WorkMailClientResolvedConfig> {
@@ -33,6 +33,8 @@ export interface AssociateMemberToGroupCommandOutput extends AssociateMemberToGr
33
33
  * };
34
34
  * const command = new AssociateMemberToGroupCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // {};
37
+ *
36
38
  * ```
37
39
  *
38
40
  * @param AssociateMemberToGroupCommandInput - {@link AssociateMemberToGroupCommandInput}
@@ -69,6 +71,8 @@ export interface AssociateMemberToGroupCommandOutput extends AssociateMemberToGr
69
71
  * @throws {@link UnsupportedOperationException} (client fault)
70
72
  * <p>You can't perform a write operation against a read-only directory.</p>
71
73
  *
74
+ * @throws {@link WorkMailServiceException}
75
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
72
76
  *
73
77
  */
74
78
  export declare class AssociateMemberToGroupCommand extends $Command<AssociateMemberToGroupCommandInput, AssociateMemberToGroupCommandOutput, WorkMailClientResolvedConfig> {
@@ -33,6 +33,11 @@ export interface AssumeImpersonationRoleCommandOutput extends AssumeImpersonatio
33
33
  * };
34
34
  * const command = new AssumeImpersonationRoleCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // AssumeImpersonationRoleResponse
37
+ * // Token: "STRING_VALUE",
38
+ * // ExpiresIn: Number("long"),
39
+ * // };
40
+ *
36
41
  * ```
37
42
  *
38
43
  * @param AssumeImpersonationRoleCommandInput - {@link AssumeImpersonationRoleCommandInput}
@@ -55,6 +60,8 @@ export interface AssumeImpersonationRoleCommandOutput extends AssumeImpersonatio
55
60
  * @throws {@link ResourceNotFoundException} (client fault)
56
61
  * <p>The resource cannot be found.</p>
57
62
  *
63
+ * @throws {@link WorkMailServiceException}
64
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
58
65
  *
59
66
  */
60
67
  export declare class AssumeImpersonationRoleCommand extends $Command<AssumeImpersonationRoleCommandInput, AssumeImpersonationRoleCommandOutput, WorkMailClientResolvedConfig> {
@@ -37,6 +37,8 @@ export interface CancelMailboxExportJobCommandOutput extends CancelMailboxExport
37
37
  * };
38
38
  * const command = new CancelMailboxExportJobCommand(input);
39
39
  * const response = await client.send(command);
40
+ * // {};
41
+ *
40
42
  * ```
41
43
  *
42
44
  * @param CancelMailboxExportJobCommandInput - {@link CancelMailboxExportJobCommandInput}
@@ -60,6 +62,8 @@ export interface CancelMailboxExportJobCommandOutput extends CancelMailboxExport
60
62
  * <p>The organization must have a valid state to perform certain
61
63
  * operations on the organization or its members.</p>
62
64
  *
65
+ * @throws {@link WorkMailServiceException}
66
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
63
67
  *
64
68
  */
65
69
  export declare class CancelMailboxExportJobCommand extends $Command<CancelMailboxExportJobCommandInput, CancelMailboxExportJobCommandOutput, WorkMailClientResolvedConfig> {
@@ -33,6 +33,8 @@ export interface CreateAliasCommandOutput extends CreateAliasResponse, __Metadat
33
33
  * };
34
34
  * const command = new CreateAliasCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // {};
37
+ *
36
38
  * ```
37
39
  *
38
40
  * @param CreateAliasCommandInput - {@link CreateAliasCommandInput}
@@ -74,6 +76,8 @@ export interface CreateAliasCommandOutput extends CreateAliasResponse, __Metadat
74
76
  * <p>The organization must have a valid state to perform certain
75
77
  * operations on the organization or its members.</p>
76
78
  *
79
+ * @throws {@link WorkMailServiceException}
80
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
77
81
  *
78
82
  */
79
83
  export declare class CreateAliasCommand extends $Command<CreateAliasCommandInput, CreateAliasCommandOutput, WorkMailClientResolvedConfig> {
@@ -41,6 +41,8 @@ export interface CreateAvailabilityConfigurationCommandOutput extends CreateAvai
41
41
  * };
42
42
  * const command = new CreateAvailabilityConfigurationCommand(input);
43
43
  * const response = await client.send(command);
44
+ * // {};
45
+ *
44
46
  * ```
45
47
  *
46
48
  * @param CreateAvailabilityConfigurationCommandInput - {@link CreateAvailabilityConfigurationCommandInput}
@@ -66,6 +68,8 @@ export interface CreateAvailabilityConfigurationCommandOutput extends CreateAvai
66
68
  * <p>The organization must have a valid state to perform certain
67
69
  * operations on the organization or its members.</p>
68
70
  *
71
+ * @throws {@link WorkMailServiceException}
72
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
69
73
  *
70
74
  */
71
75
  export declare class CreateAvailabilityConfigurationCommand extends $Command<CreateAvailabilityConfigurationCommandInput, CreateAvailabilityConfigurationCommandOutput, WorkMailClientResolvedConfig> {
@@ -32,6 +32,10 @@ export interface CreateGroupCommandOutput extends CreateGroupResponse, __Metadat
32
32
  * };
33
33
  * const command = new CreateGroupCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // CreateGroupResponse
36
+ * // GroupId: "STRING_VALUE",
37
+ * // };
38
+ *
35
39
  * ```
36
40
  *
37
41
  * @param CreateGroupCommandInput - {@link CreateGroupCommandInput}
@@ -66,6 +70,8 @@ export interface CreateGroupCommandOutput extends CreateGroupResponse, __Metadat
66
70
  * @throws {@link UnsupportedOperationException} (client fault)
67
71
  * <p>You can't perform a write operation against a read-only directory.</p>
68
72
  *
73
+ * @throws {@link WorkMailServiceException}
74
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
69
75
  *
70
76
  */
71
77
  export declare class CreateGroupCommand extends $Command<CreateGroupCommandInput, CreateGroupCommandOutput, WorkMailClientResolvedConfig> {
@@ -54,6 +54,10 @@ export interface CreateImpersonationRoleCommandOutput extends CreateImpersonatio
54
54
  * };
55
55
  * const command = new CreateImpersonationRoleCommand(input);
56
56
  * const response = await client.send(command);
57
+ * // { // CreateImpersonationRoleResponse
58
+ * // ImpersonationRoleId: "STRING_VALUE",
59
+ * // };
60
+ *
57
61
  * ```
58
62
  *
59
63
  * @param CreateImpersonationRoleCommandInput - {@link CreateImpersonationRoleCommandInput}
@@ -84,6 +88,8 @@ export interface CreateImpersonationRoleCommandOutput extends CreateImpersonatio
84
88
  * <p>The organization must have a valid state to perform certain
85
89
  * operations on the organization or its members.</p>
86
90
  *
91
+ * @throws {@link WorkMailServiceException}
92
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
87
93
  *
88
94
  */
89
95
  export declare class CreateImpersonationRoleCommand extends $Command<CreateImpersonationRoleCommandInput, CreateImpersonationRoleCommandOutput, WorkMailClientResolvedConfig> {
@@ -59,6 +59,10 @@ export interface CreateMobileDeviceAccessRuleCommandOutput extends CreateMobileD
59
59
  * };
60
60
  * const command = new CreateMobileDeviceAccessRuleCommand(input);
61
61
  * const response = await client.send(command);
62
+ * // { // CreateMobileDeviceAccessRuleResponse
63
+ * // MobileDeviceAccessRuleId: "STRING_VALUE",
64
+ * // };
65
+ *
62
66
  * ```
63
67
  *
64
68
  * @param CreateMobileDeviceAccessRuleCommandInput - {@link CreateMobileDeviceAccessRuleCommandInput}
@@ -81,6 +85,8 @@ export interface CreateMobileDeviceAccessRuleCommandOutput extends CreateMobileD
81
85
  * <p>The organization must have a valid state to perform certain
82
86
  * operations on the organization or its members.</p>
83
87
  *
88
+ * @throws {@link WorkMailServiceException}
89
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
84
90
  *
85
91
  */
86
92
  export declare class CreateMobileDeviceAccessRuleCommand extends $Command<CreateMobileDeviceAccessRuleCommandInput, CreateMobileDeviceAccessRuleCommandOutput, WorkMailClientResolvedConfig> {
@@ -49,6 +49,10 @@ export interface CreateOrganizationCommandOutput extends CreateOrganizationRespo
49
49
  * };
50
50
  * const command = new CreateOrganizationCommand(input);
51
51
  * const response = await client.send(command);
52
+ * // { // CreateOrganizationResponse
53
+ * // OrganizationId: "STRING_VALUE",
54
+ * // };
55
+ *
52
56
  * ```
53
57
  *
54
58
  * @param CreateOrganizationCommandInput - {@link CreateOrganizationCommandInput}
@@ -72,6 +76,8 @@ export interface CreateOrganizationCommandOutput extends CreateOrganizationRespo
72
76
  * @throws {@link NameAvailabilityException} (client fault)
73
77
  * <p>The user, group, or resource name isn't unique in WorkMail.</p>
74
78
  *
79
+ * @throws {@link WorkMailServiceException}
80
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
75
81
  *
76
82
  */
77
83
  export declare class CreateOrganizationCommand extends $Command<CreateOrganizationCommandInput, CreateOrganizationCommandOutput, WorkMailClientResolvedConfig> {
@@ -33,6 +33,10 @@ export interface CreateResourceCommandOutput extends CreateResourceResponse, __M
33
33
  * };
34
34
  * const command = new CreateResourceCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // CreateResourceResponse
37
+ * // ResourceId: "STRING_VALUE",
38
+ * // };
39
+ *
36
40
  * ```
37
41
  *
38
42
  * @param CreateResourceCommandInput - {@link CreateResourceCommandInput}
@@ -64,6 +68,8 @@ export interface CreateResourceCommandOutput extends CreateResourceResponse, __M
64
68
  * @throws {@link ReservedNameException} (client fault)
65
69
  * <p>This user, group, or resource name is not allowed in WorkMail.</p>
66
70
  *
71
+ * @throws {@link WorkMailServiceException}
72
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
67
73
  *
68
74
  */
69
75
  export declare class CreateResourceCommand extends $Command<CreateResourceCommandInput, CreateResourceCommandOutput, WorkMailClientResolvedConfig> {
@@ -34,6 +34,10 @@ export interface CreateUserCommandOutput extends CreateUserResponse, __MetadataB
34
34
  * };
35
35
  * const command = new CreateUserCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // CreateUserResponse
38
+ * // UserId: "STRING_VALUE",
39
+ * // };
40
+ *
37
41
  * ```
38
42
  *
39
43
  * @param CreateUserCommandInput - {@link CreateUserCommandInput}
@@ -72,6 +76,8 @@ export interface CreateUserCommandOutput extends CreateUserResponse, __MetadataB
72
76
  * @throws {@link UnsupportedOperationException} (client fault)
73
77
  * <p>You can't perform a write operation against a read-only directory.</p>
74
78
  *
79
+ * @throws {@link WorkMailServiceException}
80
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
75
81
  *
76
82
  */
77
83
  export declare class CreateUserCommand extends $Command<CreateUserCommandInput, CreateUserCommandOutput, WorkMailClientResolvedConfig> {
@@ -35,6 +35,8 @@ export interface DeleteAccessControlRuleCommandOutput extends DeleteAccessContro
35
35
  * };
36
36
  * const command = new DeleteAccessControlRuleCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // {};
39
+ *
38
40
  * ```
39
41
  *
40
42
  * @param DeleteAccessControlRuleCommandInput - {@link DeleteAccessControlRuleCommandInput}
@@ -51,6 +53,8 @@ export interface DeleteAccessControlRuleCommandOutput extends DeleteAccessContro
51
53
  * <p>The organization must have a valid state to perform certain
52
54
  * operations on the organization or its members.</p>
53
55
  *
56
+ * @throws {@link WorkMailServiceException}
57
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
54
58
  *
55
59
  */
56
60
  export declare class DeleteAccessControlRuleCommand extends $Command<DeleteAccessControlRuleCommandInput, DeleteAccessControlRuleCommandOutput, WorkMailClientResolvedConfig> {
@@ -34,6 +34,8 @@ export interface DeleteAliasCommandOutput extends DeleteAliasResponse, __Metadat
34
34
  * };
35
35
  * const command = new DeleteAliasCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // {};
38
+ *
37
39
  * ```
38
40
  *
39
41
  * @param DeleteAliasCommandInput - {@link DeleteAliasCommandInput}
@@ -61,6 +63,8 @@ export interface DeleteAliasCommandOutput extends DeleteAliasResponse, __Metadat
61
63
  * <p>The organization must have a valid state to perform certain
62
64
  * operations on the organization or its members.</p>
63
65
  *
66
+ * @throws {@link WorkMailServiceException}
67
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
64
68
  *
65
69
  */
66
70
  export declare class DeleteAliasCommand extends $Command<DeleteAliasCommandInput, DeleteAliasCommandOutput, WorkMailClientResolvedConfig> {
@@ -32,6 +32,8 @@ export interface DeleteAvailabilityConfigurationCommandOutput extends DeleteAvai
32
32
  * };
33
33
  * const command = new DeleteAvailabilityConfigurationCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // {};
36
+ *
35
37
  * ```
36
38
  *
37
39
  * @param DeleteAvailabilityConfigurationCommandInput - {@link DeleteAvailabilityConfigurationCommandInput}
@@ -48,6 +50,8 @@ export interface DeleteAvailabilityConfigurationCommandOutput extends DeleteAvai
48
50
  * <p>The organization must have a valid state to perform certain
49
51
  * operations on the organization or its members.</p>
50
52
  *
53
+ * @throws {@link WorkMailServiceException}
54
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
51
55
  *
52
56
  */
53
57
  export declare class DeleteAvailabilityConfigurationCommand extends $Command<DeleteAvailabilityConfigurationCommandInput, DeleteAvailabilityConfigurationCommandOutput, WorkMailClientResolvedConfig> {
@@ -31,6 +31,8 @@ export interface DeleteEmailMonitoringConfigurationCommandOutput extends DeleteE
31
31
  * };
32
32
  * const command = new DeleteEmailMonitoringConfigurationCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // {};
35
+ *
34
36
  * ```
35
37
  *
36
38
  * @param DeleteEmailMonitoringConfigurationCommandInput - {@link DeleteEmailMonitoringConfigurationCommandInput}
@@ -50,6 +52,8 @@ export interface DeleteEmailMonitoringConfigurationCommandOutput extends DeleteE
50
52
  * <p>The organization must have a valid state to perform certain
51
53
  * operations on the organization or its members.</p>
52
54
  *
55
+ * @throws {@link WorkMailServiceException}
56
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
53
57
  *
54
58
  */
55
59
  export declare class DeleteEmailMonitoringConfigurationCommand extends $Command<DeleteEmailMonitoringConfigurationCommandInput, DeleteEmailMonitoringConfigurationCommandOutput, WorkMailClientResolvedConfig> {
@@ -32,6 +32,8 @@ export interface DeleteGroupCommandOutput extends DeleteGroupResponse, __Metadat
32
32
  * };
33
33
  * const command = new DeleteGroupCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // {};
36
+ *
35
37
  * ```
36
38
  *
37
39
  * @param DeleteGroupCommandInput - {@link DeleteGroupCommandInput}
@@ -64,6 +66,8 @@ export interface DeleteGroupCommandOutput extends DeleteGroupResponse, __Metadat
64
66
  * @throws {@link UnsupportedOperationException} (client fault)
65
67
  * <p>You can't perform a write operation against a read-only directory.</p>
66
68
  *
69
+ * @throws {@link WorkMailServiceException}
70
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
67
71
  *
68
72
  */
69
73
  export declare class DeleteGroupCommand extends $Command<DeleteGroupCommandInput, DeleteGroupCommandOutput, WorkMailClientResolvedConfig> {
@@ -32,6 +32,8 @@ export interface DeleteImpersonationRoleCommandOutput extends DeleteImpersonatio
32
32
  * };
33
33
  * const command = new DeleteImpersonationRoleCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // {};
36
+ *
35
37
  * ```
36
38
  *
37
39
  * @param DeleteImpersonationRoleCommandInput - {@link DeleteImpersonationRoleCommandInput}
@@ -51,6 +53,8 @@ export interface DeleteImpersonationRoleCommandOutput extends DeleteImpersonatio
51
53
  * <p>The organization must have a valid state to perform certain
52
54
  * operations on the organization or its members.</p>
53
55
  *
56
+ * @throws {@link WorkMailServiceException}
57
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
54
58
  *
55
59
  */
56
60
  export declare class DeleteImpersonationRoleCommand extends $Command<DeleteImpersonationRoleCommandInput, DeleteImpersonationRoleCommandOutput, WorkMailClientResolvedConfig> {
@@ -33,6 +33,8 @@ export interface DeleteMailboxPermissionsCommandOutput extends DeleteMailboxPerm
33
33
  * };
34
34
  * const command = new DeleteMailboxPermissionsCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // {};
37
+ *
36
38
  * ```
37
39
  *
38
40
  * @param DeleteMailboxPermissionsCommandInput - {@link DeleteMailboxPermissionsCommandInput}
@@ -60,6 +62,8 @@ export interface DeleteMailboxPermissionsCommandOutput extends DeleteMailboxPerm
60
62
  * <p>The organization must have a valid state to perform certain
61
63
  * operations on the organization or its members.</p>
62
64
  *
65
+ * @throws {@link WorkMailServiceException}
66
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
63
67
  *
64
68
  */
65
69
  export declare class DeleteMailboxPermissionsCommand extends $Command<DeleteMailboxPermissionsCommandInput, DeleteMailboxPermissionsCommandOutput, WorkMailClientResolvedConfig> {
@@ -36,6 +36,8 @@ export interface DeleteMobileDeviceAccessOverrideCommandOutput extends DeleteMob
36
36
  * };
37
37
  * const command = new DeleteMobileDeviceAccessOverrideCommand(input);
38
38
  * const response = await client.send(command);
39
+ * // {};
40
+ *
39
41
  * ```
40
42
  *
41
43
  * @param DeleteMobileDeviceAccessOverrideCommandInput - {@link DeleteMobileDeviceAccessOverrideCommandInput}
@@ -59,6 +61,8 @@ export interface DeleteMobileDeviceAccessOverrideCommandOutput extends DeleteMob
59
61
  * <p>The organization must have a valid state to perform certain
60
62
  * operations on the organization or its members.</p>
61
63
  *
64
+ * @throws {@link WorkMailServiceException}
65
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
62
66
  *
63
67
  */
64
68
  export declare class DeleteMobileDeviceAccessOverrideCommand extends $Command<DeleteMobileDeviceAccessOverrideCommandInput, DeleteMobileDeviceAccessOverrideCommandOutput, WorkMailClientResolvedConfig> {
@@ -35,6 +35,8 @@ export interface DeleteMobileDeviceAccessRuleCommandOutput extends DeleteMobileD
35
35
  * };
36
36
  * const command = new DeleteMobileDeviceAccessRuleCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // {};
39
+ *
38
40
  * ```
39
41
  *
40
42
  * @param DeleteMobileDeviceAccessRuleCommandInput - {@link DeleteMobileDeviceAccessRuleCommandInput}
@@ -54,6 +56,8 @@ export interface DeleteMobileDeviceAccessRuleCommandOutput extends DeleteMobileD
54
56
  * <p>The organization must have a valid state to perform certain
55
57
  * operations on the organization or its members.</p>
56
58
  *
59
+ * @throws {@link WorkMailServiceException}
60
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
57
61
  *
58
62
  */
59
63
  export declare class DeleteMobileDeviceAccessRuleCommand extends $Command<DeleteMobileDeviceAccessRuleCommandInput, DeleteMobileDeviceAccessRuleCommandOutput, WorkMailClientResolvedConfig> {
@@ -33,6 +33,11 @@ export interface DeleteOrganizationCommandOutput extends DeleteOrganizationRespo
33
33
  * };
34
34
  * const command = new DeleteOrganizationCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // DeleteOrganizationResponse
37
+ * // OrganizationId: "STRING_VALUE",
38
+ * // State: "STRING_VALUE",
39
+ * // };
40
+ *
36
41
  * ```
37
42
  *
38
43
  * @param DeleteOrganizationCommandInput - {@link DeleteOrganizationCommandInput}
@@ -52,6 +57,8 @@ export interface DeleteOrganizationCommandOutput extends DeleteOrganizationRespo
52
57
  * <p>The organization must have a valid state to perform certain
53
58
  * operations on the organization or its members.</p>
54
59
  *
60
+ * @throws {@link WorkMailServiceException}
61
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
55
62
  *
56
63
  */
57
64
  export declare class DeleteOrganizationCommand extends $Command<DeleteOrganizationCommandInput, DeleteOrganizationCommandOutput, WorkMailClientResolvedConfig> {
@@ -32,6 +32,8 @@ export interface DeleteResourceCommandOutput extends DeleteResourceResponse, __M
32
32
  * };
33
33
  * const command = new DeleteResourceCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // {};
36
+ *
35
37
  * ```
36
38
  *
37
39
  * @param DeleteResourceCommandInput - {@link DeleteResourceCommandInput}
@@ -55,6 +57,8 @@ export interface DeleteResourceCommandOutput extends DeleteResourceResponse, __M
55
57
  * <p>The organization must have a valid state to perform certain
56
58
  * operations on the organization or its members.</p>
57
59
  *
60
+ * @throws {@link WorkMailServiceException}
61
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
58
62
  *
59
63
  */
60
64
  export declare class DeleteResourceCommand extends $Command<DeleteResourceCommandInput, DeleteResourceCommandOutput, WorkMailClientResolvedConfig> {
@@ -32,6 +32,8 @@ export interface DeleteRetentionPolicyCommandOutput extends DeleteRetentionPolic
32
32
  * };
33
33
  * const command = new DeleteRetentionPolicyCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // {};
36
+ *
35
37
  * ```
36
38
  *
37
39
  * @param DeleteRetentionPolicyCommandInput - {@link DeleteRetentionPolicyCommandInput}
@@ -51,6 +53,8 @@ export interface DeleteRetentionPolicyCommandOutput extends DeleteRetentionPolic
51
53
  * <p>The organization must have a valid state to perform certain
52
54
  * operations on the organization or its members.</p>
53
55
  *
56
+ * @throws {@link WorkMailServiceException}
57
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
54
58
  *
55
59
  */
56
60
  export declare class DeleteRetentionPolicyCommand extends $Command<DeleteRetentionPolicyCommandInput, DeleteRetentionPolicyCommandOutput, WorkMailClientResolvedConfig> {
@@ -36,6 +36,8 @@ export interface DeleteUserCommandOutput extends DeleteUserResponse, __MetadataB
36
36
  * };
37
37
  * const command = new DeleteUserCommand(input);
38
38
  * const response = await client.send(command);
39
+ * // {};
40
+ *
39
41
  * ```
40
42
  *
41
43
  * @param DeleteUserCommandInput - {@link DeleteUserCommandInput}
@@ -68,6 +70,8 @@ export interface DeleteUserCommandOutput extends DeleteUserResponse, __MetadataB
68
70
  * @throws {@link UnsupportedOperationException} (client fault)
69
71
  * <p>You can't perform a write operation against a read-only directory.</p>
70
72
  *
73
+ * @throws {@link WorkMailServiceException}
74
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
71
75
  *
72
76
  */
73
77
  export declare class DeleteUserCommand extends $Command<DeleteUserCommandInput, DeleteUserCommandOutput, WorkMailClientResolvedConfig> {
@@ -35,6 +35,8 @@ export interface DeregisterFromWorkMailCommandOutput extends DeregisterFromWorkM
35
35
  * };
36
36
  * const command = new DeregisterFromWorkMailCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // {};
39
+ *
38
40
  * ```
39
41
  *
40
42
  * @param DeregisterFromWorkMailCommandInput - {@link DeregisterFromWorkMailCommandInput}
@@ -62,6 +64,8 @@ export interface DeregisterFromWorkMailCommandOutput extends DeregisterFromWorkM
62
64
  * <p>The organization must have a valid state to perform certain
63
65
  * operations on the organization or its members.</p>
64
66
  *
67
+ * @throws {@link WorkMailServiceException}
68
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
65
69
  *
66
70
  */
67
71
  export declare class DeregisterFromWorkMailCommand extends $Command<DeregisterFromWorkMailCommandInput, DeregisterFromWorkMailCommandOutput, WorkMailClientResolvedConfig> {
@@ -33,6 +33,8 @@ export interface DeregisterMailDomainCommandOutput extends DeregisterMailDomainR
33
33
  * };
34
34
  * const command = new DeregisterMailDomainCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // {};
37
+ *
36
38
  * ```
37
39
  *
38
40
  * @param DeregisterMailDomainCommandInput - {@link DeregisterMailDomainCommandInput}
@@ -59,6 +61,8 @@ export interface DeregisterMailDomainCommandOutput extends DeregisterMailDomainR
59
61
  * <p>The organization must have a valid state to perform certain
60
62
  * operations on the organization or its members.</p>
61
63
  *
64
+ * @throws {@link WorkMailServiceException}
65
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
62
66
  *
63
67
  */
64
68
  export declare class DeregisterMailDomainCommand extends $Command<DeregisterMailDomainCommandInput, DeregisterMailDomainCommandOutput, WorkMailClientResolvedConfig> {
@@ -31,6 +31,11 @@ export interface DescribeEmailMonitoringConfigurationCommandOutput extends Descr
31
31
  * };
32
32
  * const command = new DescribeEmailMonitoringConfigurationCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // DescribeEmailMonitoringConfigurationResponse
35
+ * // RoleArn: "STRING_VALUE",
36
+ * // LogGroupArn: "STRING_VALUE",
37
+ * // };
38
+ *
34
39
  * ```
35
40
  *
36
41
  * @param DescribeEmailMonitoringConfigurationCommandInput - {@link DescribeEmailMonitoringConfigurationCommandInput}
@@ -53,6 +58,8 @@ export interface DescribeEmailMonitoringConfigurationCommandOutput extends Descr
53
58
  * @throws {@link ResourceNotFoundException} (client fault)
54
59
  * <p>The resource cannot be found.</p>
55
60
  *
61
+ * @throws {@link WorkMailServiceException}
62
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
56
63
  *
57
64
  */
58
65
  export declare class DescribeEmailMonitoringConfigurationCommand extends $Command<DescribeEmailMonitoringConfigurationCommandInput, DescribeEmailMonitoringConfigurationCommandOutput, WorkMailClientResolvedConfig> {
@@ -32,6 +32,15 @@ export interface DescribeGroupCommandOutput extends DescribeGroupResponse, __Met
32
32
  * };
33
33
  * const command = new DescribeGroupCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // DescribeGroupResponse
36
+ * // GroupId: "STRING_VALUE",
37
+ * // Name: "STRING_VALUE",
38
+ * // Email: "STRING_VALUE",
39
+ * // State: "ENABLED" || "DISABLED" || "DELETED",
40
+ * // EnabledDate: new Date("TIMESTAMP"),
41
+ * // DisabledDate: new Date("TIMESTAMP"),
42
+ * // };
43
+ *
35
44
  * ```
36
45
  *
37
46
  * @param DescribeGroupCommandInput - {@link DescribeGroupCommandInput}
@@ -55,6 +64,8 @@ export interface DescribeGroupCommandOutput extends DescribeGroupResponse, __Met
55
64
  * <p>The organization must have a valid state to perform certain
56
65
  * operations on the organization or its members.</p>
57
66
  *
67
+ * @throws {@link WorkMailServiceException}
68
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
58
69
  *
59
70
  */
60
71
  export declare class DescribeGroupCommand extends $Command<DescribeGroupCommandInput, DescribeGroupCommandOutput, WorkMailClientResolvedConfig> {
@@ -31,6 +31,10 @@ export interface DescribeInboundDmarcSettingsCommandOutput extends DescribeInbou
31
31
  * };
32
32
  * const command = new DescribeInboundDmarcSettingsCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // DescribeInboundDmarcSettingsResponse
35
+ * // Enforced: true || false,
36
+ * // };
37
+ *
34
38
  * ```
35
39
  *
36
40
  * @param DescribeInboundDmarcSettingsCommandInput - {@link DescribeInboundDmarcSettingsCommandInput}
@@ -47,6 +51,8 @@ export interface DescribeInboundDmarcSettingsCommandOutput extends DescribeInbou
47
51
  * <p>The organization must have a valid state to perform certain
48
52
  * operations on the organization or its members.</p>
49
53
  *
54
+ * @throws {@link WorkMailServiceException}
55
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
50
56
  *
51
57
  */
52
58
  export declare class DescribeInboundDmarcSettingsCommand extends $Command<DescribeInboundDmarcSettingsCommandInput, DescribeInboundDmarcSettingsCommandOutput, WorkMailClientResolvedConfig> {
@@ -32,6 +32,21 @@ export interface DescribeMailboxExportJobCommandOutput extends DescribeMailboxEx
32
32
  * };
33
33
  * const command = new DescribeMailboxExportJobCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // DescribeMailboxExportJobResponse
36
+ * // EntityId: "STRING_VALUE",
37
+ * // Description: "STRING_VALUE",
38
+ * // RoleArn: "STRING_VALUE",
39
+ * // KmsKeyArn: "STRING_VALUE",
40
+ * // S3BucketName: "STRING_VALUE",
41
+ * // S3Prefix: "STRING_VALUE",
42
+ * // S3Path: "STRING_VALUE",
43
+ * // EstimatedProgress: Number("int"),
44
+ * // State: "RUNNING" || "COMPLETED" || "FAILED" || "CANCELLED",
45
+ * // ErrorInfo: "STRING_VALUE",
46
+ * // StartTime: new Date("TIMESTAMP"),
47
+ * // EndTime: new Date("TIMESTAMP"),
48
+ * // };
49
+ *
35
50
  * ```
36
51
  *
37
52
  * @param DescribeMailboxExportJobCommandInput - {@link DescribeMailboxExportJobCommandInput}
@@ -55,6 +70,8 @@ export interface DescribeMailboxExportJobCommandOutput extends DescribeMailboxEx
55
70
  * <p>The organization must have a valid state to perform certain
56
71
  * operations on the organization or its members.</p>
57
72
  *
73
+ * @throws {@link WorkMailServiceException}
74
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
58
75
  *
59
76
  */
60
77
  export declare class DescribeMailboxExportJobCommand extends $Command<DescribeMailboxExportJobCommandInput, DescribeMailboxExportJobCommandOutput, WorkMailClientResolvedConfig> {
@@ -32,6 +32,18 @@ export interface DescribeOrganizationCommandOutput extends DescribeOrganizationR
32
32
  * };
33
33
  * const command = new DescribeOrganizationCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // DescribeOrganizationResponse
36
+ * // OrganizationId: "STRING_VALUE",
37
+ * // Alias: "STRING_VALUE",
38
+ * // State: "STRING_VALUE",
39
+ * // DirectoryId: "STRING_VALUE",
40
+ * // DirectoryType: "STRING_VALUE",
41
+ * // DefaultMailDomain: "STRING_VALUE",
42
+ * // CompletedDate: new Date("TIMESTAMP"),
43
+ * // ErrorMessage: "STRING_VALUE",
44
+ * // ARN: "STRING_VALUE",
45
+ * // };
46
+ *
35
47
  * ```
36
48
  *
37
49
  * @param DescribeOrganizationCommandInput - {@link DescribeOrganizationCommandInput}
@@ -47,6 +59,8 @@ export interface DescribeOrganizationCommandOutput extends DescribeOrganizationR
47
59
  * <p>An operation received a valid organization identifier that either doesn't belong or
48
60
  * exist in the system.</p>
49
61
  *
62
+ * @throws {@link WorkMailServiceException}
63
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
50
64
  *
51
65
  */
52
66
  export declare class DescribeOrganizationCommand extends $Command<DescribeOrganizationCommandInput, DescribeOrganizationCommandOutput, WorkMailClientResolvedConfig> {