@aws-sdk/client-workmail 3.325.0 → 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 +3 -3
@@ -32,6 +32,21 @@ export interface DescribeResourceCommandOutput extends DescribeResourceResponse,
32
32
  * };
33
33
  * const command = new DescribeResourceCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // DescribeResourceResponse
36
+ * // ResourceId: "STRING_VALUE",
37
+ * // Email: "STRING_VALUE",
38
+ * // Name: "STRING_VALUE",
39
+ * // Type: "ROOM" || "EQUIPMENT",
40
+ * // BookingOptions: { // BookingOptions
41
+ * // AutoAcceptRequests: true || false,
42
+ * // AutoDeclineRecurringRequests: true || false,
43
+ * // AutoDeclineConflictingRequests: true || false,
44
+ * // },
45
+ * // State: "ENABLED" || "DISABLED" || "DELETED",
46
+ * // EnabledDate: new Date("TIMESTAMP"),
47
+ * // DisabledDate: new Date("TIMESTAMP"),
48
+ * // };
49
+ *
35
50
  * ```
36
51
  *
37
52
  * @param DescribeResourceCommandInput - {@link DescribeResourceCommandInput}
@@ -55,6 +70,8 @@ export interface DescribeResourceCommandOutput extends DescribeResourceResponse,
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 DescribeResourceCommand extends $Command<DescribeResourceCommandInput, DescribeResourceCommandOutput, WorkMailClientResolvedConfig> {
@@ -32,6 +32,17 @@ export interface DescribeUserCommandOutput extends DescribeUserResponse, __Metad
32
32
  * };
33
33
  * const command = new DescribeUserCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // DescribeUserResponse
36
+ * // UserId: "STRING_VALUE",
37
+ * // Name: "STRING_VALUE",
38
+ * // Email: "STRING_VALUE",
39
+ * // DisplayName: "STRING_VALUE",
40
+ * // State: "ENABLED" || "DISABLED" || "DELETED",
41
+ * // UserRole: "USER" || "RESOURCE" || "SYSTEM_USER",
42
+ * // EnabledDate: new Date("TIMESTAMP"),
43
+ * // DisabledDate: new Date("TIMESTAMP"),
44
+ * // };
45
+ *
35
46
  * ```
36
47
  *
37
48
  * @param DescribeUserCommandInput - {@link DescribeUserCommandInput}
@@ -55,6 +66,8 @@ export interface DescribeUserCommandOutput extends DescribeUserResponse, __Metad
55
66
  * <p>The organization must have a valid state to perform certain
56
67
  * operations on the organization or its members.</p>
57
68
  *
69
+ * @throws {@link WorkMailServiceException}
70
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
58
71
  *
59
72
  */
60
73
  export declare class DescribeUserCommand extends $Command<DescribeUserCommandInput, DescribeUserCommandOutput, WorkMailClientResolvedConfig> {
@@ -33,6 +33,8 @@ export interface DisassociateDelegateFromResourceCommandOutput extends Disassoci
33
33
  * };
34
34
  * const command = new DisassociateDelegateFromResourceCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // {};
37
+ *
36
38
  * ```
37
39
  *
38
40
  * @param DisassociateDelegateFromResourceCommandInput - {@link DisassociateDelegateFromResourceCommandInput}
@@ -60,6 +62,8 @@ export interface DisassociateDelegateFromResourceCommandOutput extends Disassoci
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 DisassociateDelegateFromResourceCommand extends $Command<DisassociateDelegateFromResourceCommandInput, DisassociateDelegateFromResourceCommandOutput, WorkMailClientResolvedConfig> {
@@ -33,6 +33,8 @@ export interface DisassociateMemberFromGroupCommandOutput extends DisassociateMe
33
33
  * };
34
34
  * const command = new DisassociateMemberFromGroupCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // {};
37
+ *
36
38
  * ```
37
39
  *
38
40
  * @param DisassociateMemberFromGroupCommandInput - {@link DisassociateMemberFromGroupCommandInput}
@@ -69,6 +71,8 @@ export interface DisassociateMemberFromGroupCommandOutput extends DisassociateMe
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 DisassociateMemberFromGroupCommand extends $Command<DisassociateMemberFromGroupCommandInput, DisassociateMemberFromGroupCommandOutput, WorkMailClientResolvedConfig> {
@@ -36,6 +36,13 @@ export interface GetAccessControlEffectCommandOutput extends GetAccessControlEff
36
36
  * };
37
37
  * const command = new GetAccessControlEffectCommand(input);
38
38
  * const response = await client.send(command);
39
+ * // { // GetAccessControlEffectResponse
40
+ * // Effect: "ALLOW" || "DENY",
41
+ * // MatchedRules: [ // AccessControlRuleNameList
42
+ * // "STRING_VALUE",
43
+ * // ],
44
+ * // };
45
+ *
39
46
  * ```
40
47
  *
41
48
  * @param GetAccessControlEffectCommandInput - {@link GetAccessControlEffectCommandInput}
@@ -62,6 +69,8 @@ export interface GetAccessControlEffectCommandOutput extends GetAccessControlEff
62
69
  * @throws {@link ResourceNotFoundException} (client fault)
63
70
  * <p>The resource cannot be found.</p>
64
71
  *
72
+ * @throws {@link WorkMailServiceException}
73
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
65
74
  *
66
75
  */
67
76
  export declare class GetAccessControlEffectCommand extends $Command<GetAccessControlEffectCommandInput, GetAccessControlEffectCommandOutput, WorkMailClientResolvedConfig> {
@@ -31,6 +31,19 @@ export interface GetDefaultRetentionPolicyCommandOutput extends GetDefaultRetent
31
31
  * };
32
32
  * const command = new GetDefaultRetentionPolicyCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // GetDefaultRetentionPolicyResponse
35
+ * // Id: "STRING_VALUE",
36
+ * // Name: "STRING_VALUE",
37
+ * // Description: "STRING_VALUE",
38
+ * // FolderConfigurations: [ // FolderConfigurations
39
+ * // { // FolderConfiguration
40
+ * // Name: "INBOX" || "DELETED_ITEMS" || "SENT_ITEMS" || "DRAFTS" || "JUNK_EMAIL", // required
41
+ * // Action: "NONE" || "DELETE" || "PERMANENTLY_DELETE", // required
42
+ * // Period: Number("int"),
43
+ * // },
44
+ * // ],
45
+ * // };
46
+ *
34
47
  * ```
35
48
  *
36
49
  * @param GetDefaultRetentionPolicyCommandInput - {@link GetDefaultRetentionPolicyCommandInput}
@@ -54,6 +67,8 @@ export interface GetDefaultRetentionPolicyCommandOutput extends GetDefaultRetent
54
67
  * <p>The organization must have a valid state to perform certain
55
68
  * operations on the organization or its members.</p>
56
69
  *
70
+ * @throws {@link WorkMailServiceException}
71
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
57
72
  *
58
73
  */
59
74
  export declare class GetDefaultRetentionPolicyCommand extends $Command<GetDefaultRetentionPolicyCommandInput, GetDefaultRetentionPolicyCommandOutput, WorkMailClientResolvedConfig> {
@@ -32,6 +32,29 @@ export interface GetImpersonationRoleCommandOutput extends GetImpersonationRoleR
32
32
  * };
33
33
  * const command = new GetImpersonationRoleCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // GetImpersonationRoleResponse
36
+ * // ImpersonationRoleId: "STRING_VALUE",
37
+ * // Name: "STRING_VALUE",
38
+ * // Type: "FULL_ACCESS" || "READ_ONLY",
39
+ * // Description: "STRING_VALUE",
40
+ * // Rules: [ // ImpersonationRuleList
41
+ * // { // ImpersonationRule
42
+ * // ImpersonationRuleId: "STRING_VALUE", // required
43
+ * // Name: "STRING_VALUE",
44
+ * // Description: "STRING_VALUE",
45
+ * // Effect: "ALLOW" || "DENY", // required
46
+ * // TargetUsers: [ // TargetUsers
47
+ * // "STRING_VALUE",
48
+ * // ],
49
+ * // NotTargetUsers: [
50
+ * // "STRING_VALUE",
51
+ * // ],
52
+ * // },
53
+ * // ],
54
+ * // DateCreated: new Date("TIMESTAMP"),
55
+ * // DateModified: new Date("TIMESTAMP"),
56
+ * // };
57
+ *
35
58
  * ```
36
59
  *
37
60
  * @param GetImpersonationRoleCommandInput - {@link GetImpersonationRoleCommandInput}
@@ -54,6 +77,8 @@ export interface GetImpersonationRoleCommandOutput extends GetImpersonationRoleR
54
77
  * @throws {@link ResourceNotFoundException} (client fault)
55
78
  * <p>The resource cannot be found.</p>
56
79
  *
80
+ * @throws {@link WorkMailServiceException}
81
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
57
82
  *
58
83
  */
59
84
  export declare class GetImpersonationRoleCommand extends $Command<GetImpersonationRoleCommandInput, GetImpersonationRoleCommandOutput, WorkMailClientResolvedConfig> {
@@ -33,6 +33,17 @@ export interface GetImpersonationRoleEffectCommandOutput extends GetImpersonatio
33
33
  * };
34
34
  * const command = new GetImpersonationRoleEffectCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // GetImpersonationRoleEffectResponse
37
+ * // Type: "FULL_ACCESS" || "READ_ONLY",
38
+ * // Effect: "ALLOW" || "DENY",
39
+ * // MatchedRules: [ // ImpersonationMatchedRuleList
40
+ * // { // ImpersonationMatchedRule
41
+ * // ImpersonationRuleId: "STRING_VALUE",
42
+ * // Name: "STRING_VALUE",
43
+ * // },
44
+ * // ],
45
+ * // };
46
+ *
36
47
  * ```
37
48
  *
38
49
  * @param GetImpersonationRoleEffectCommandInput - {@link GetImpersonationRoleEffectCommandInput}
@@ -63,6 +74,8 @@ export interface GetImpersonationRoleEffectCommandOutput extends GetImpersonatio
63
74
  * @throws {@link ResourceNotFoundException} (client fault)
64
75
  * <p>The resource cannot be found.</p>
65
76
  *
77
+ * @throws {@link WorkMailServiceException}
78
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
66
79
  *
67
80
  */
68
81
  export declare class GetImpersonationRoleEffectCommand extends $Command<GetImpersonationRoleEffectCommandInput, GetImpersonationRoleEffectCommandOutput, WorkMailClientResolvedConfig> {
@@ -32,6 +32,20 @@ export interface GetMailDomainCommandOutput extends GetMailDomainResponse, __Met
32
32
  * };
33
33
  * const command = new GetMailDomainCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // GetMailDomainResponse
36
+ * // Records: [ // DnsRecords
37
+ * // { // DnsRecord
38
+ * // Type: "STRING_VALUE",
39
+ * // Hostname: "STRING_VALUE",
40
+ * // Value: "STRING_VALUE",
41
+ * // },
42
+ * // ],
43
+ * // IsTestDomain: true || false,
44
+ * // IsDefault: true || false,
45
+ * // OwnershipVerificationStatus: "PENDING" || "VERIFIED" || "FAILED",
46
+ * // DkimVerificationStatus: "PENDING" || "VERIFIED" || "FAILED",
47
+ * // };
48
+ *
35
49
  * ```
36
50
  *
37
51
  * @param GetMailDomainCommandInput - {@link GetMailDomainCommandInput}
@@ -54,6 +68,8 @@ export interface GetMailDomainCommandOutput extends GetMailDomainResponse, __Met
54
68
  * <p>The organization must have a valid state to perform certain
55
69
  * operations on the organization or its members.</p>
56
70
  *
71
+ * @throws {@link WorkMailServiceException}
72
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
57
73
  *
58
74
  */
59
75
  export declare class GetMailDomainCommand extends $Command<GetMailDomainCommandInput, GetMailDomainCommandOutput, WorkMailClientResolvedConfig> {
@@ -32,6 +32,11 @@ export interface GetMailboxDetailsCommandOutput extends GetMailboxDetailsRespons
32
32
  * };
33
33
  * const command = new GetMailboxDetailsCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // GetMailboxDetailsResponse
36
+ * // MailboxQuota: Number("int"),
37
+ * // MailboxSize: Number("double"),
38
+ * // };
39
+ *
35
40
  * ```
36
41
  *
37
42
  * @param GetMailboxDetailsCommandInput - {@link GetMailboxDetailsCommandInput}
@@ -52,6 +57,8 @@ export interface GetMailboxDetailsCommandOutput extends GetMailboxDetailsRespons
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 GetMailboxDetailsCommand extends $Command<GetMailboxDetailsCommandInput, GetMailboxDetailsCommandOutput, WorkMailClientResolvedConfig> {
@@ -36,6 +36,16 @@ export interface GetMobileDeviceAccessEffectCommandOutput extends GetMobileDevic
36
36
  * };
37
37
  * const command = new GetMobileDeviceAccessEffectCommand(input);
38
38
  * const response = await client.send(command);
39
+ * // { // GetMobileDeviceAccessEffectResponse
40
+ * // Effect: "ALLOW" || "DENY",
41
+ * // MatchedRules: [ // MobileDeviceAccessMatchedRuleList
42
+ * // { // MobileDeviceAccessMatchedRule
43
+ * // MobileDeviceAccessRuleId: "STRING_VALUE",
44
+ * // Name: "STRING_VALUE",
45
+ * // },
46
+ * // ],
47
+ * // };
48
+ *
39
49
  * ```
40
50
  *
41
51
  * @param GetMobileDeviceAccessEffectCommandInput - {@link GetMobileDeviceAccessEffectCommandInput}
@@ -55,6 +65,8 @@ export interface GetMobileDeviceAccessEffectCommandOutput extends GetMobileDevic
55
65
  * <p>The organization must have a valid state to perform certain
56
66
  * operations on the organization or its members.</p>
57
67
  *
68
+ * @throws {@link WorkMailServiceException}
69
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
58
70
  *
59
71
  */
60
72
  export declare class GetMobileDeviceAccessEffectCommand extends $Command<GetMobileDeviceAccessEffectCommandInput, GetMobileDeviceAccessEffectCommandOutput, WorkMailClientResolvedConfig> {
@@ -33,6 +33,15 @@ export interface GetMobileDeviceAccessOverrideCommandOutput extends GetMobileDev
33
33
  * };
34
34
  * const command = new GetMobileDeviceAccessOverrideCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // GetMobileDeviceAccessOverrideResponse
37
+ * // UserId: "STRING_VALUE",
38
+ * // DeviceId: "STRING_VALUE",
39
+ * // Effect: "ALLOW" || "DENY",
40
+ * // Description: "STRING_VALUE",
41
+ * // DateCreated: new Date("TIMESTAMP"),
42
+ * // DateModified: new Date("TIMESTAMP"),
43
+ * // };
44
+ *
36
45
  * ```
37
46
  *
38
47
  * @param GetMobileDeviceAccessOverrideCommandInput - {@link GetMobileDeviceAccessOverrideCommandInput}
@@ -59,6 +68,8 @@ export interface GetMobileDeviceAccessOverrideCommandOutput extends GetMobileDev
59
68
  * @throws {@link ResourceNotFoundException} (client fault)
60
69
  * <p>The resource cannot be found.</p>
61
70
  *
71
+ * @throws {@link WorkMailServiceException}
72
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
62
73
  *
63
74
  */
64
75
  export declare class GetMobileDeviceAccessOverrideCommand extends $Command<GetMobileDeviceAccessOverrideCommandInput, GetMobileDeviceAccessOverrideCommandOutput, WorkMailClientResolvedConfig> {
@@ -31,6 +31,42 @@ export interface ListAccessControlRulesCommandOutput extends ListAccessControlRu
31
31
  * };
32
32
  * const command = new ListAccessControlRulesCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // ListAccessControlRulesResponse
35
+ * // Rules: [ // AccessControlRulesList
36
+ * // { // AccessControlRule
37
+ * // Name: "STRING_VALUE",
38
+ * // Effect: "ALLOW" || "DENY",
39
+ * // Description: "STRING_VALUE",
40
+ * // IpRanges: [ // IpRangeList
41
+ * // "STRING_VALUE",
42
+ * // ],
43
+ * // NotIpRanges: [
44
+ * // "STRING_VALUE",
45
+ * // ],
46
+ * // Actions: [ // ActionsList
47
+ * // "STRING_VALUE",
48
+ * // ],
49
+ * // NotActions: [
50
+ * // "STRING_VALUE",
51
+ * // ],
52
+ * // UserIds: [ // UserIdList
53
+ * // "STRING_VALUE",
54
+ * // ],
55
+ * // NotUserIds: [
56
+ * // "STRING_VALUE",
57
+ * // ],
58
+ * // DateCreated: new Date("TIMESTAMP"),
59
+ * // DateModified: new Date("TIMESTAMP"),
60
+ * // ImpersonationRoleIds: [ // ImpersonationRoleIdList
61
+ * // "STRING_VALUE",
62
+ * // ],
63
+ * // NotImpersonationRoleIds: [
64
+ * // "STRING_VALUE",
65
+ * // ],
66
+ * // },
67
+ * // ],
68
+ * // };
69
+ *
34
70
  * ```
35
71
  *
36
72
  * @param ListAccessControlRulesCommandInput - {@link ListAccessControlRulesCommandInput}
@@ -47,6 +83,8 @@ export interface ListAccessControlRulesCommandOutput extends ListAccessControlRu
47
83
  * <p>The organization must have a valid state to perform certain
48
84
  * operations on the organization or its members.</p>
49
85
  *
86
+ * @throws {@link WorkMailServiceException}
87
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
50
88
  *
51
89
  */
52
90
  export declare class ListAccessControlRulesCommand extends $Command<ListAccessControlRulesCommandInput, ListAccessControlRulesCommandOutput, WorkMailClientResolvedConfig> {
@@ -35,6 +35,13 @@ export interface ListAliasesCommandOutput extends ListAliasesResponse, __Metadat
35
35
  * };
36
36
  * const command = new ListAliasesCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // { // ListAliasesResponse
39
+ * // Aliases: [ // Aliases
40
+ * // "STRING_VALUE",
41
+ * // ],
42
+ * // NextToken: "STRING_VALUE",
43
+ * // };
44
+ *
38
45
  * ```
39
46
  *
40
47
  * @param ListAliasesCommandInput - {@link ListAliasesCommandInput}
@@ -62,6 +69,8 @@ export interface ListAliasesCommandOutput extends ListAliasesResponse, __Metadat
62
69
  * <p>The organization must have a valid state to perform certain
63
70
  * operations on the organization or its members.</p>
64
71
  *
72
+ * @throws {@link WorkMailServiceException}
73
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
65
74
  *
66
75
  */
67
76
  export declare class ListAliasesCommand extends $Command<ListAliasesCommandInput, ListAliasesCommandOutput, WorkMailClientResolvedConfig> {
@@ -33,6 +33,25 @@ export interface ListAvailabilityConfigurationsCommandOutput extends ListAvailab
33
33
  * };
34
34
  * const command = new ListAvailabilityConfigurationsCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // ListAvailabilityConfigurationsResponse
37
+ * // AvailabilityConfigurations: [ // AvailabilityConfigurationList
38
+ * // { // AvailabilityConfiguration
39
+ * // DomainName: "STRING_VALUE",
40
+ * // ProviderType: "EWS" || "LAMBDA",
41
+ * // EwsProvider: { // RedactedEwsAvailabilityProvider
42
+ * // EwsEndpoint: "STRING_VALUE",
43
+ * // EwsUsername: "STRING_VALUE",
44
+ * // },
45
+ * // LambdaProvider: { // LambdaAvailabilityProvider
46
+ * // LambdaArn: "STRING_VALUE", // required
47
+ * // },
48
+ * // DateCreated: new Date("TIMESTAMP"),
49
+ * // DateModified: new Date("TIMESTAMP"),
50
+ * // },
51
+ * // ],
52
+ * // NextToken: "STRING_VALUE",
53
+ * // };
54
+ *
36
55
  * ```
37
56
  *
38
57
  * @param ListAvailabilityConfigurationsCommandInput - {@link ListAvailabilityConfigurationsCommandInput}
@@ -49,6 +68,8 @@ export interface ListAvailabilityConfigurationsCommandOutput extends ListAvailab
49
68
  * <p>The organization must have a valid state to perform certain
50
69
  * operations on the organization or its members.</p>
51
70
  *
71
+ * @throws {@link WorkMailServiceException}
72
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
52
73
  *
53
74
  */
54
75
  export declare class ListAvailabilityConfigurationsCommand extends $Command<ListAvailabilityConfigurationsCommandInput, ListAvailabilityConfigurationsCommandOutput, WorkMailClientResolvedConfig> {
@@ -35,6 +35,20 @@ export interface ListGroupMembersCommandOutput extends ListGroupMembersResponse,
35
35
  * };
36
36
  * const command = new ListGroupMembersCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // { // ListGroupMembersResponse
39
+ * // Members: [ // Members
40
+ * // { // Member
41
+ * // Id: "STRING_VALUE",
42
+ * // Name: "STRING_VALUE",
43
+ * // Type: "GROUP" || "USER",
44
+ * // State: "ENABLED" || "DISABLED" || "DELETED",
45
+ * // EnabledDate: new Date("TIMESTAMP"),
46
+ * // DisabledDate: new Date("TIMESTAMP"),
47
+ * // },
48
+ * // ],
49
+ * // NextToken: "STRING_VALUE",
50
+ * // };
51
+ *
38
52
  * ```
39
53
  *
40
54
  * @param ListGroupMembersCommandInput - {@link ListGroupMembersCommandInput}
@@ -62,6 +76,8 @@ export interface ListGroupMembersCommandOutput extends ListGroupMembersResponse,
62
76
  * <p>The organization must have a valid state to perform certain
63
77
  * operations on the organization or its members.</p>
64
78
  *
79
+ * @throws {@link WorkMailServiceException}
80
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
65
81
  *
66
82
  */
67
83
  export declare class ListGroupMembersCommand extends $Command<ListGroupMembersCommandInput, ListGroupMembersCommandOutput, WorkMailClientResolvedConfig> {
@@ -33,6 +33,20 @@ export interface ListGroupsCommandOutput extends ListGroupsResponse, __MetadataB
33
33
  * };
34
34
  * const command = new ListGroupsCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // ListGroupsResponse
37
+ * // Groups: [ // Groups
38
+ * // { // Group
39
+ * // Id: "STRING_VALUE",
40
+ * // Email: "STRING_VALUE",
41
+ * // Name: "STRING_VALUE",
42
+ * // State: "ENABLED" || "DISABLED" || "DELETED",
43
+ * // EnabledDate: new Date("TIMESTAMP"),
44
+ * // DisabledDate: new Date("TIMESTAMP"),
45
+ * // },
46
+ * // ],
47
+ * // NextToken: "STRING_VALUE",
48
+ * // };
49
+ *
36
50
  * ```
37
51
  *
38
52
  * @param ListGroupsCommandInput - {@link ListGroupsCommandInput}
@@ -56,6 +70,8 @@ export interface ListGroupsCommandOutput extends ListGroupsResponse, __MetadataB
56
70
  * <p>The organization must have a valid state to perform certain
57
71
  * operations on the organization or its members.</p>
58
72
  *
73
+ * @throws {@link WorkMailServiceException}
74
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
59
75
  *
60
76
  */
61
77
  export declare class ListGroupsCommand extends $Command<ListGroupsCommandInput, ListGroupsCommandOutput, WorkMailClientResolvedConfig> {
@@ -33,6 +33,19 @@ export interface ListImpersonationRolesCommandOutput extends ListImpersonationRo
33
33
  * };
34
34
  * const command = new ListImpersonationRolesCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // ListImpersonationRolesResponse
37
+ * // Roles: [ // ImpersonationRoleList
38
+ * // { // ImpersonationRole
39
+ * // ImpersonationRoleId: "STRING_VALUE",
40
+ * // Name: "STRING_VALUE",
41
+ * // Type: "FULL_ACCESS" || "READ_ONLY",
42
+ * // DateCreated: new Date("TIMESTAMP"),
43
+ * // DateModified: new Date("TIMESTAMP"),
44
+ * // },
45
+ * // ],
46
+ * // NextToken: "STRING_VALUE",
47
+ * // };
48
+ *
36
49
  * ```
37
50
  *
38
51
  * @param ListImpersonationRolesCommandInput - {@link ListImpersonationRolesCommandInput}
@@ -52,6 +65,8 @@ export interface ListImpersonationRolesCommandOutput extends ListImpersonationRo
52
65
  * <p>The organization must have a valid state to perform certain
53
66
  * operations on the organization or its members.</p>
54
67
  *
68
+ * @throws {@link WorkMailServiceException}
69
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
55
70
  *
56
71
  */
57
72
  export declare class ListImpersonationRolesCommand extends $Command<ListImpersonationRolesCommandInput, ListImpersonationRolesCommandOutput, WorkMailClientResolvedConfig> {
@@ -33,6 +33,16 @@ export interface ListMailDomainsCommandOutput extends ListMailDomainsResponse, _
33
33
  * };
34
34
  * const command = new ListMailDomainsCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // ListMailDomainsResponse
37
+ * // MailDomains: [ // MailDomains
38
+ * // { // MailDomainSummary
39
+ * // DomainName: "STRING_VALUE",
40
+ * // DefaultDomain: true || false,
41
+ * // },
42
+ * // ],
43
+ * // NextToken: "STRING_VALUE",
44
+ * // };
45
+ *
36
46
  * ```
37
47
  *
38
48
  * @param ListMailDomainsCommandInput - {@link ListMailDomainsCommandInput}
@@ -52,6 +62,8 @@ export interface ListMailDomainsCommandOutput extends ListMailDomainsResponse, _
52
62
  * <p>The organization must have a valid state to perform certain
53
63
  * operations on the organization or its members.</p>
54
64
  *
65
+ * @throws {@link WorkMailServiceException}
66
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
55
67
  *
56
68
  */
57
69
  export declare class ListMailDomainsCommand extends $Command<ListMailDomainsCommandInput, ListMailDomainsCommandOutput, WorkMailClientResolvedConfig> {
@@ -34,6 +34,23 @@ export interface ListMailboxExportJobsCommandOutput extends ListMailboxExportJob
34
34
  * };
35
35
  * const command = new ListMailboxExportJobsCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // ListMailboxExportJobsResponse
38
+ * // Jobs: [ // Jobs
39
+ * // { // MailboxExportJob
40
+ * // JobId: "STRING_VALUE",
41
+ * // EntityId: "STRING_VALUE",
42
+ * // Description: "STRING_VALUE",
43
+ * // S3BucketName: "STRING_VALUE",
44
+ * // S3Path: "STRING_VALUE",
45
+ * // EstimatedProgress: Number("int"),
46
+ * // State: "RUNNING" || "COMPLETED" || "FAILED" || "CANCELLED",
47
+ * // StartTime: new Date("TIMESTAMP"),
48
+ * // EndTime: new Date("TIMESTAMP"),
49
+ * // },
50
+ * // ],
51
+ * // NextToken: "STRING_VALUE",
52
+ * // };
53
+ *
37
54
  * ```
38
55
  *
39
56
  * @param ListMailboxExportJobsCommandInput - {@link ListMailboxExportJobsCommandInput}
@@ -53,6 +70,8 @@ export interface ListMailboxExportJobsCommandOutput extends ListMailboxExportJob
53
70
  * <p>The organization must have a valid state to perform certain
54
71
  * operations on the organization or its members.</p>
55
72
  *
73
+ * @throws {@link WorkMailServiceException}
74
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
56
75
  *
57
76
  */
58
77
  export declare class ListMailboxExportJobsCommand extends $Command<ListMailboxExportJobsCommandInput, ListMailboxExportJobsCommandOutput, WorkMailClientResolvedConfig> {
@@ -35,6 +35,19 @@ export interface ListMailboxPermissionsCommandOutput extends ListMailboxPermissi
35
35
  * };
36
36
  * const command = new ListMailboxPermissionsCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // { // ListMailboxPermissionsResponse
39
+ * // Permissions: [ // Permissions
40
+ * // { // Permission
41
+ * // GranteeId: "STRING_VALUE", // required
42
+ * // GranteeType: "GROUP" || "USER", // required
43
+ * // PermissionValues: [ // PermissionValues // required
44
+ * // "FULL_ACCESS" || "SEND_AS" || "SEND_ON_BEHALF",
45
+ * // ],
46
+ * // },
47
+ * // ],
48
+ * // NextToken: "STRING_VALUE",
49
+ * // };
50
+ *
38
51
  * ```
39
52
  *
40
53
  * @param ListMailboxPermissionsCommandInput - {@link ListMailboxPermissionsCommandInput}
@@ -58,6 +71,8 @@ export interface ListMailboxPermissionsCommandOutput extends ListMailboxPermissi
58
71
  * <p>The organization must have a valid state to perform certain
59
72
  * operations on the organization or its members.</p>
60
73
  *
74
+ * @throws {@link WorkMailServiceException}
75
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
61
76
  *
62
77
  */
63
78
  export declare class ListMailboxPermissionsCommand extends $Command<ListMailboxPermissionsCommandInput, ListMailboxPermissionsCommandOutput, WorkMailClientResolvedConfig> {
@@ -35,6 +35,20 @@ export interface ListMobileDeviceAccessOverridesCommandOutput extends ListMobile
35
35
  * };
36
36
  * const command = new ListMobileDeviceAccessOverridesCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // { // ListMobileDeviceAccessOverridesResponse
39
+ * // Overrides: [ // MobileDeviceAccessOverridesList
40
+ * // { // MobileDeviceAccessOverride
41
+ * // UserId: "STRING_VALUE",
42
+ * // DeviceId: "STRING_VALUE",
43
+ * // Effect: "ALLOW" || "DENY",
44
+ * // Description: "STRING_VALUE",
45
+ * // DateCreated: new Date("TIMESTAMP"),
46
+ * // DateModified: new Date("TIMESTAMP"),
47
+ * // },
48
+ * // ],
49
+ * // NextToken: "STRING_VALUE",
50
+ * // };
51
+ *
38
52
  * ```
39
53
  *
40
54
  * @param ListMobileDeviceAccessOverridesCommandInput - {@link ListMobileDeviceAccessOverridesCommandInput}
@@ -58,6 +72,8 @@ export interface ListMobileDeviceAccessOverridesCommandOutput extends ListMobile
58
72
  * <p>The organization must have a valid state to perform certain
59
73
  * operations on the organization or its members.</p>
60
74
  *
75
+ * @throws {@link WorkMailServiceException}
76
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
61
77
  *
62
78
  */
63
79
  export declare class ListMobileDeviceAccessOverridesCommand extends $Command<ListMobileDeviceAccessOverridesCommandInput, ListMobileDeviceAccessOverridesCommandOutput, WorkMailClientResolvedConfig> {