@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
@@ -31,6 +31,43 @@ export interface ListMobileDeviceAccessRulesCommandOutput extends ListMobileDevi
31
31
  * };
32
32
  * const command = new ListMobileDeviceAccessRulesCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // ListMobileDeviceAccessRulesResponse
35
+ * // Rules: [ // MobileDeviceAccessRulesList
36
+ * // { // MobileDeviceAccessRule
37
+ * // MobileDeviceAccessRuleId: "STRING_VALUE",
38
+ * // Name: "STRING_VALUE",
39
+ * // Description: "STRING_VALUE",
40
+ * // Effect: "ALLOW" || "DENY",
41
+ * // DeviceTypes: [ // DeviceTypeList
42
+ * // "STRING_VALUE",
43
+ * // ],
44
+ * // NotDeviceTypes: [
45
+ * // "STRING_VALUE",
46
+ * // ],
47
+ * // DeviceModels: [ // DeviceModelList
48
+ * // "STRING_VALUE",
49
+ * // ],
50
+ * // NotDeviceModels: [
51
+ * // "STRING_VALUE",
52
+ * // ],
53
+ * // DeviceOperatingSystems: [ // DeviceOperatingSystemList
54
+ * // "STRING_VALUE",
55
+ * // ],
56
+ * // NotDeviceOperatingSystems: [
57
+ * // "STRING_VALUE",
58
+ * // ],
59
+ * // DeviceUserAgents: [ // DeviceUserAgentList
60
+ * // "STRING_VALUE",
61
+ * // ],
62
+ * // NotDeviceUserAgents: [
63
+ * // "STRING_VALUE",
64
+ * // ],
65
+ * // DateCreated: new Date("TIMESTAMP"),
66
+ * // DateModified: new Date("TIMESTAMP"),
67
+ * // },
68
+ * // ],
69
+ * // };
70
+ *
34
71
  * ```
35
72
  *
36
73
  * @param ListMobileDeviceAccessRulesCommandInput - {@link ListMobileDeviceAccessRulesCommandInput}
@@ -50,6 +87,8 @@ export interface ListMobileDeviceAccessRulesCommandOutput extends ListMobileDevi
50
87
  * <p>The organization must have a valid state to perform certain
51
88
  * operations on the organization or its members.</p>
52
89
  *
90
+ * @throws {@link WorkMailServiceException}
91
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
53
92
  *
54
93
  */
55
94
  export declare class ListMobileDeviceAccessRulesCommand extends $Command<ListMobileDeviceAccessRulesCommandInput, ListMobileDeviceAccessRulesCommandOutput, WorkMailClientResolvedConfig> {
@@ -32,6 +32,19 @@ export interface ListOrganizationsCommandOutput extends ListOrganizationsRespons
32
32
  * };
33
33
  * const command = new ListOrganizationsCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // ListOrganizationsResponse
36
+ * // OrganizationSummaries: [ // OrganizationSummaries
37
+ * // { // OrganizationSummary
38
+ * // OrganizationId: "STRING_VALUE",
39
+ * // Alias: "STRING_VALUE",
40
+ * // DefaultMailDomain: "STRING_VALUE",
41
+ * // ErrorMessage: "STRING_VALUE",
42
+ * // State: "STRING_VALUE",
43
+ * // },
44
+ * // ],
45
+ * // NextToken: "STRING_VALUE",
46
+ * // };
47
+ *
35
48
  * ```
36
49
  *
37
50
  * @param ListOrganizationsCommandInput - {@link ListOrganizationsCommandInput}
@@ -43,6 +56,8 @@ export interface ListOrganizationsCommandOutput extends ListOrganizationsRespons
43
56
  * @throws {@link InvalidParameterException} (client fault)
44
57
  * <p>One or more of the input parameters don't match the service's restrictions.</p>
45
58
  *
59
+ * @throws {@link WorkMailServiceException}
60
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
46
61
  *
47
62
  */
48
63
  export declare class ListOrganizationsCommand extends $Command<ListOrganizationsCommandInput, ListOrganizationsCommandOutput, WorkMailClientResolvedConfig> {
@@ -35,6 +35,16 @@ export interface ListResourceDelegatesCommandOutput extends ListResourceDelegate
35
35
  * };
36
36
  * const command = new ListResourceDelegatesCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // { // ListResourceDelegatesResponse
39
+ * // Delegates: [ // ResourceDelegates
40
+ * // { // Delegate
41
+ * // Id: "STRING_VALUE", // required
42
+ * // Type: "GROUP" || "USER", // required
43
+ * // },
44
+ * // ],
45
+ * // NextToken: "STRING_VALUE",
46
+ * // };
47
+ *
38
48
  * ```
39
49
  *
40
50
  * @param ListResourceDelegatesCommandInput - {@link ListResourceDelegatesCommandInput}
@@ -62,6 +72,8 @@ export interface ListResourceDelegatesCommandOutput extends ListResourceDelegate
62
72
  * <p>The organization must have a valid state to perform certain
63
73
  * operations on the organization or its members.</p>
64
74
  *
75
+ * @throws {@link WorkMailServiceException}
76
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
65
77
  *
66
78
  */
67
79
  export declare class ListResourceDelegatesCommand extends $Command<ListResourceDelegatesCommandInput, ListResourceDelegatesCommandOutput, WorkMailClientResolvedConfig> {
@@ -33,6 +33,21 @@ export interface ListResourcesCommandOutput extends ListResourcesResponse, __Met
33
33
  * };
34
34
  * const command = new ListResourcesCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // ListResourcesResponse
37
+ * // Resources: [ // Resources
38
+ * // { // Resource
39
+ * // Id: "STRING_VALUE",
40
+ * // Email: "STRING_VALUE",
41
+ * // Name: "STRING_VALUE",
42
+ * // Type: "ROOM" || "EQUIPMENT",
43
+ * // State: "ENABLED" || "DISABLED" || "DELETED",
44
+ * // EnabledDate: new Date("TIMESTAMP"),
45
+ * // DisabledDate: new Date("TIMESTAMP"),
46
+ * // },
47
+ * // ],
48
+ * // NextToken: "STRING_VALUE",
49
+ * // };
50
+ *
36
51
  * ```
37
52
  *
38
53
  * @param ListResourcesCommandInput - {@link ListResourcesCommandInput}
@@ -52,6 +67,8 @@ export interface ListResourcesCommandOutput extends ListResourcesResponse, __Met
52
67
  * <p>The organization must have a valid state to perform certain
53
68
  * operations on the organization or its members.</p>
54
69
  *
70
+ * @throws {@link WorkMailServiceException}
71
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
55
72
  *
56
73
  */
57
74
  export declare class ListResourcesCommand extends $Command<ListResourcesCommandInput, ListResourcesCommandOutput, WorkMailClientResolvedConfig> {
@@ -31,6 +31,15 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
31
31
  * };
32
32
  * const command = new ListTagsForResourceCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // ListTagsForResourceResponse
35
+ * // Tags: [ // TagList
36
+ * // { // Tag
37
+ * // Key: "STRING_VALUE", // required
38
+ * // Value: "STRING_VALUE", // required
39
+ * // },
40
+ * // ],
41
+ * // };
42
+ *
34
43
  * ```
35
44
  *
36
45
  * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
@@ -42,6 +51,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
42
51
  * @throws {@link ResourceNotFoundException} (client fault)
43
52
  * <p>The resource cannot be found.</p>
44
53
  *
54
+ * @throws {@link WorkMailServiceException}
55
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
45
56
  *
46
57
  */
47
58
  export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, WorkMailClientResolvedConfig> {
@@ -33,6 +33,22 @@ export interface ListUsersCommandOutput extends ListUsersResponse, __MetadataBea
33
33
  * };
34
34
  * const command = new ListUsersCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // ListUsersResponse
37
+ * // Users: [ // Users
38
+ * // { // User
39
+ * // Id: "STRING_VALUE",
40
+ * // Email: "STRING_VALUE",
41
+ * // Name: "STRING_VALUE",
42
+ * // DisplayName: "STRING_VALUE",
43
+ * // State: "ENABLED" || "DISABLED" || "DELETED",
44
+ * // UserRole: "USER" || "RESOURCE" || "SYSTEM_USER",
45
+ * // EnabledDate: new Date("TIMESTAMP"),
46
+ * // DisabledDate: new Date("TIMESTAMP"),
47
+ * // },
48
+ * // ],
49
+ * // NextToken: "STRING_VALUE",
50
+ * // };
51
+ *
36
52
  * ```
37
53
  *
38
54
  * @param ListUsersCommandInput - {@link ListUsersCommandInput}
@@ -52,6 +68,8 @@ export interface ListUsersCommandOutput extends ListUsersResponse, __MetadataBea
52
68
  * <p>The organization must have a valid state to perform certain
53
69
  * operations on the organization or its members.</p>
54
70
  *
71
+ * @throws {@link WorkMailServiceException}
72
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
55
73
  *
56
74
  */
57
75
  export declare class ListUsersCommand extends $Command<ListUsersCommandInput, ListUsersCommandOutput, WorkMailClientResolvedConfig> {
@@ -61,6 +61,8 @@ export interface PutAccessControlRuleCommandOutput extends PutAccessControlRuleR
61
61
  * };
62
62
  * const command = new PutAccessControlRuleCommand(input);
63
63
  * const response = await client.send(command);
64
+ * // {};
65
+ *
64
66
  * ```
65
67
  *
66
68
  * @param PutAccessControlRuleCommandInput - {@link PutAccessControlRuleCommandInput}
@@ -90,6 +92,8 @@ export interface PutAccessControlRuleCommandOutput extends PutAccessControlRuleR
90
92
  * @throws {@link ResourceNotFoundException} (client fault)
91
93
  * <p>The resource cannot be found.</p>
92
94
  *
95
+ * @throws {@link WorkMailServiceException}
96
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
93
97
  *
94
98
  */
95
99
  export declare class PutAccessControlRuleCommand extends $Command<PutAccessControlRuleCommandInput, PutAccessControlRuleCommandOutput, WorkMailClientResolvedConfig> {
@@ -33,6 +33,8 @@ export interface PutEmailMonitoringConfigurationCommandOutput extends PutEmailMo
33
33
  * };
34
34
  * const command = new PutEmailMonitoringConfigurationCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // {};
37
+ *
36
38
  * ```
37
39
  *
38
40
  * @param PutEmailMonitoringConfigurationCommandInput - {@link PutEmailMonitoringConfigurationCommandInput}
@@ -55,6 +57,8 @@ export interface PutEmailMonitoringConfigurationCommandOutput extends PutEmailMo
55
57
  * @throws {@link ResourceNotFoundException} (client fault)
56
58
  * <p>The resource cannot be found.</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 PutEmailMonitoringConfigurationCommand extends $Command<PutEmailMonitoringConfigurationCommandInput, PutEmailMonitoringConfigurationCommandOutput, WorkMailClientResolvedConfig> {
@@ -32,6 +32,8 @@ export interface PutInboundDmarcSettingsCommandOutput extends PutInboundDmarcSet
32
32
  * };
33
33
  * const command = new PutInboundDmarcSettingsCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // {};
36
+ *
35
37
  * ```
36
38
  *
37
39
  * @param PutInboundDmarcSettingsCommandInput - {@link PutInboundDmarcSettingsCommandInput}
@@ -48,6 +50,8 @@ export interface PutInboundDmarcSettingsCommandOutput extends PutInboundDmarcSet
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 PutInboundDmarcSettingsCommand extends $Command<PutInboundDmarcSettingsCommandInput, PutInboundDmarcSettingsCommandOutput, WorkMailClientResolvedConfig> {
@@ -37,6 +37,8 @@ export interface PutMailboxPermissionsCommandOutput extends PutMailboxPermission
37
37
  * };
38
38
  * const command = new PutMailboxPermissionsCommand(input);
39
39
  * const response = await client.send(command);
40
+ * // {};
41
+ *
40
42
  * ```
41
43
  *
42
44
  * @param PutMailboxPermissionsCommandInput - {@link PutMailboxPermissionsCommandInput}
@@ -64,6 +66,8 @@ export interface PutMailboxPermissionsCommandOutput extends PutMailboxPermission
64
66
  * <p>The organization must have a valid state to perform certain
65
67
  * operations on the organization or its members.</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 PutMailboxPermissionsCommand extends $Command<PutMailboxPermissionsCommandInput, PutMailboxPermissionsCommandOutput, WorkMailClientResolvedConfig> {
@@ -35,6 +35,8 @@ export interface PutMobileDeviceAccessOverrideCommandOutput extends PutMobileDev
35
35
  * };
36
36
  * const command = new PutMobileDeviceAccessOverrideCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // {};
39
+ *
38
40
  * ```
39
41
  *
40
42
  * @param PutMobileDeviceAccessOverrideCommandInput - {@link PutMobileDeviceAccessOverrideCommandInput}
@@ -62,6 +64,8 @@ export interface PutMobileDeviceAccessOverrideCommandOutput extends PutMobileDev
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 PutMobileDeviceAccessOverrideCommand extends $Command<PutMobileDeviceAccessOverrideCommandInput, PutMobileDeviceAccessOverrideCommandOutput, WorkMailClientResolvedConfig> {
@@ -41,6 +41,8 @@ export interface PutRetentionPolicyCommandOutput extends PutRetentionPolicyRespo
41
41
  * };
42
42
  * const command = new PutRetentionPolicyCommand(input);
43
43
  * const response = await client.send(command);
44
+ * // {};
45
+ *
44
46
  * ```
45
47
  *
46
48
  * @param PutRetentionPolicyCommandInput - {@link PutRetentionPolicyCommandInput}
@@ -63,6 +65,8 @@ export interface PutRetentionPolicyCommandOutput extends PutRetentionPolicyRespo
63
65
  * <p>The organization must have a valid state to perform certain
64
66
  * operations on the organization or its members.</p>
65
67
  *
68
+ * @throws {@link WorkMailServiceException}
69
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
66
70
  *
67
71
  */
68
72
  export declare class PutRetentionPolicyCommand extends $Command<PutRetentionPolicyCommandInput, PutRetentionPolicyCommandOutput, WorkMailClientResolvedConfig> {
@@ -34,6 +34,8 @@ export interface RegisterMailDomainCommandOutput extends RegisterMailDomainRespo
34
34
  * };
35
35
  * const command = new RegisterMailDomainCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // {};
38
+ *
37
39
  * ```
38
40
  *
39
41
  * @param RegisterMailDomainCommandInput - {@link RegisterMailDomainCommandInput}
@@ -59,6 +61,8 @@ export interface RegisterMailDomainCommandOutput extends RegisterMailDomainRespo
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 RegisterMailDomainCommand extends $Command<RegisterMailDomainCommandInput, RegisterMailDomainCommandOutput, WorkMailClientResolvedConfig> {
@@ -39,6 +39,8 @@ export interface RegisterToWorkMailCommandOutput extends RegisterToWorkMailRespo
39
39
  * };
40
40
  * const command = new RegisterToWorkMailCommand(input);
41
41
  * const response = await client.send(command);
42
+ * // {};
43
+ *
42
44
  * ```
43
45
  *
44
46
  * @param RegisterToWorkMailCommandInput - {@link RegisterToWorkMailCommandInput}
@@ -87,6 +89,8 @@ export interface RegisterToWorkMailCommandOutput extends RegisterToWorkMailRespo
87
89
  * <p>The organization must have a valid state to perform certain
88
90
  * operations on the organization or its members.</p>
89
91
  *
92
+ * @throws {@link WorkMailServiceException}
93
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
90
94
  *
91
95
  */
92
96
  export declare class RegisterToWorkMailCommand extends $Command<RegisterToWorkMailCommandInput, RegisterToWorkMailCommandOutput, WorkMailClientResolvedConfig> {
@@ -33,6 +33,8 @@ export interface ResetPasswordCommandOutput extends ResetPasswordResponse, __Met
33
33
  * };
34
34
  * const command = new ResetPasswordCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // {};
37
+ *
36
38
  * ```
37
39
  *
38
40
  * @param ResetPasswordCommandInput - {@link ResetPasswordCommandInput}
@@ -73,6 +75,8 @@ export interface ResetPasswordCommandOutput extends ResetPasswordResponse, __Met
73
75
  * @throws {@link UnsupportedOperationException} (client fault)
74
76
  * <p>You can't perform a write operation against a read-only directory.</p>
75
77
  *
78
+ * @throws {@link WorkMailServiceException}
79
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
76
80
  *
77
81
  */
78
82
  export declare class ResetPasswordCommand extends $Command<ResetPasswordCommandInput, ResetPasswordCommandOutput, WorkMailClientResolvedConfig> {
@@ -41,6 +41,10 @@ export interface StartMailboxExportJobCommandOutput extends StartMailboxExportJo
41
41
  * };
42
42
  * const command = new StartMailboxExportJobCommand(input);
43
43
  * const response = await client.send(command);
44
+ * // { // StartMailboxExportJobResponse
45
+ * // JobId: "STRING_VALUE",
46
+ * // };
47
+ *
44
48
  * ```
45
49
  *
46
50
  * @param StartMailboxExportJobCommandInput - {@link StartMailboxExportJobCommandInput}
@@ -67,6 +71,8 @@ export interface StartMailboxExportJobCommandOutput extends StartMailboxExportJo
67
71
  * <p>The organization must have a valid state to perform certain
68
72
  * operations on the organization or its members.</p>
69
73
  *
74
+ * @throws {@link WorkMailServiceException}
75
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
70
76
  *
71
77
  */
72
78
  export declare class StartMailboxExportJobCommand extends $Command<StartMailboxExportJobCommandInput, StartMailboxExportJobCommandOutput, WorkMailClientResolvedConfig> {
@@ -38,6 +38,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
38
38
  * };
39
39
  * const command = new TagResourceCommand(input);
40
40
  * const response = await client.send(command);
41
+ * // {};
42
+ *
41
43
  * ```
42
44
  *
43
45
  * @param TagResourceCommandInput - {@link TagResourceCommandInput}
@@ -56,6 +58,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
56
58
  * @throws {@link TooManyTagsException} (client fault)
57
59
  * <p>The resource can have up to 50 user-applied tags.</p>
58
60
  *
61
+ * @throws {@link WorkMailServiceException}
62
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
59
63
  *
60
64
  */
61
65
  export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, WorkMailClientResolvedConfig> {
@@ -47,6 +47,11 @@ export interface TestAvailabilityConfigurationCommandOutput extends TestAvailabi
47
47
  * };
48
48
  * const command = new TestAvailabilityConfigurationCommand(input);
49
49
  * const response = await client.send(command);
50
+ * // { // TestAvailabilityConfigurationResponse
51
+ * // TestPassed: true || false,
52
+ * // FailureReason: "STRING_VALUE",
53
+ * // };
54
+ *
50
55
  * ```
51
56
  *
52
57
  * @param TestAvailabilityConfigurationCommandInput - {@link TestAvailabilityConfigurationCommandInput}
@@ -69,6 +74,8 @@ export interface TestAvailabilityConfigurationCommandOutput extends TestAvailabi
69
74
  * @throws {@link ResourceNotFoundException} (client fault)
70
75
  * <p>The resource cannot be found.</p>
71
76
  *
77
+ * @throws {@link WorkMailServiceException}
78
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
72
79
  *
73
80
  */
74
81
  export declare class TestAvailabilityConfigurationCommand extends $Command<TestAvailabilityConfigurationCommandInput, TestAvailabilityConfigurationCommandOutput, WorkMailClientResolvedConfig> {
@@ -35,6 +35,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
35
35
  * };
36
36
  * const command = new UntagResourceCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // {};
39
+ *
38
40
  * ```
39
41
  *
40
42
  * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
@@ -46,6 +48,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
46
48
  * @throws {@link ResourceNotFoundException} (client fault)
47
49
  * <p>The resource cannot be found.</p>
48
50
  *
51
+ * @throws {@link WorkMailServiceException}
52
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
49
53
  *
50
54
  */
51
55
  export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, WorkMailClientResolvedConfig> {
@@ -41,6 +41,8 @@ export interface UpdateAvailabilityConfigurationCommandOutput extends UpdateAvai
41
41
  * };
42
42
  * const command = new UpdateAvailabilityConfigurationCommand(input);
43
43
  * const response = await client.send(command);
44
+ * // {};
45
+ *
44
46
  * ```
45
47
  *
46
48
  * @param UpdateAvailabilityConfigurationCommandInput - {@link UpdateAvailabilityConfigurationCommandInput}
@@ -63,6 +65,8 @@ export interface UpdateAvailabilityConfigurationCommandOutput extends UpdateAvai
63
65
  * @throws {@link ResourceNotFoundException} (client fault)
64
66
  * <p>The resource cannot be found.</p>
65
67
  *
68
+ * @throws {@link WorkMailServiceException}
69
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
66
70
  *
67
71
  */
68
72
  export declare class UpdateAvailabilityConfigurationCommand extends $Command<UpdateAvailabilityConfigurationCommandInput, UpdateAvailabilityConfigurationCommandOutput, WorkMailClientResolvedConfig> {
@@ -32,6 +32,8 @@ export interface UpdateDefaultMailDomainCommandOutput extends UpdateDefaultMailD
32
32
  * };
33
33
  * const command = new UpdateDefaultMailDomainCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // {};
36
+ *
35
37
  * ```
36
38
  *
37
39
  * @param UpdateDefaultMailDomainCommandInput - {@link UpdateDefaultMailDomainCommandInput}
@@ -58,6 +60,8 @@ export interface UpdateDefaultMailDomainCommandOutput extends UpdateDefaultMailD
58
60
  * <p>The organization must have a valid state to perform certain
59
61
  * operations on the organization or its members.</p>
60
62
  *
63
+ * @throws {@link WorkMailServiceException}
64
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
61
65
  *
62
66
  */
63
67
  export declare class UpdateDefaultMailDomainCommand extends $Command<UpdateDefaultMailDomainCommandInput, UpdateDefaultMailDomainCommandOutput, WorkMailClientResolvedConfig> {
@@ -49,6 +49,8 @@ export interface UpdateImpersonationRoleCommandOutput extends UpdateImpersonatio
49
49
  * };
50
50
  * const command = new UpdateImpersonationRoleCommand(input);
51
51
  * const response = await client.send(command);
52
+ * // {};
53
+ *
52
54
  * ```
53
55
  *
54
56
  * @param UpdateImpersonationRoleCommandInput - {@link UpdateImpersonationRoleCommandInput}
@@ -82,6 +84,8 @@ export interface UpdateImpersonationRoleCommandOutput extends UpdateImpersonatio
82
84
  * @throws {@link ResourceNotFoundException} (client fault)
83
85
  * <p>The resource cannot be found.</p>
84
86
  *
87
+ * @throws {@link WorkMailServiceException}
88
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
85
89
  *
86
90
  */
87
91
  export declare class UpdateImpersonationRoleCommand extends $Command<UpdateImpersonationRoleCommandInput, UpdateImpersonationRoleCommandOutput, WorkMailClientResolvedConfig> {
@@ -34,6 +34,8 @@ export interface UpdateMailboxQuotaCommandOutput extends UpdateMailboxQuotaRespo
34
34
  * };
35
35
  * const command = new UpdateMailboxQuotaCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // {};
38
+ *
37
39
  * ```
38
40
  *
39
41
  * @param UpdateMailboxQuotaCommandInput - {@link UpdateMailboxQuotaCommandInput}
@@ -61,6 +63,8 @@ export interface UpdateMailboxQuotaCommandOutput extends UpdateMailboxQuotaRespo
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 UpdateMailboxQuotaCommand extends $Command<UpdateMailboxQuotaCommandInput, UpdateMailboxQuotaCommandOutput, WorkMailClientResolvedConfig> {
@@ -59,6 +59,8 @@ export interface UpdateMobileDeviceAccessRuleCommandOutput extends UpdateMobileD
59
59
  * };
60
60
  * const command = new UpdateMobileDeviceAccessRuleCommand(input);
61
61
  * const response = await client.send(command);
62
+ * // {};
63
+ *
62
64
  * ```
63
65
  *
64
66
  * @param UpdateMobileDeviceAccessRuleCommandInput - {@link UpdateMobileDeviceAccessRuleCommandInput}
@@ -82,6 +84,8 @@ export interface UpdateMobileDeviceAccessRuleCommandOutput extends UpdateMobileD
82
84
  * <p>The organization must have a valid state to perform certain
83
85
  * operations on the organization or its members.</p>
84
86
  *
87
+ * @throws {@link WorkMailServiceException}
88
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
85
89
  *
86
90
  */
87
91
  export declare class UpdateMobileDeviceAccessRuleCommand extends $Command<UpdateMobileDeviceAccessRuleCommandInput, UpdateMobileDeviceAccessRuleCommandOutput, WorkMailClientResolvedConfig> {
@@ -35,6 +35,8 @@ export interface UpdatePrimaryEmailAddressCommandOutput extends UpdatePrimaryEma
35
35
  * };
36
36
  * const command = new UpdatePrimaryEmailAddressCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // {};
39
+ *
38
40
  * ```
39
41
  *
40
42
  * @param UpdatePrimaryEmailAddressCommandInput - {@link UpdatePrimaryEmailAddressCommandInput}
@@ -82,6 +84,8 @@ export interface UpdatePrimaryEmailAddressCommandOutput extends UpdatePrimaryEma
82
84
  * @throws {@link UnsupportedOperationException} (client fault)
83
85
  * <p>You can't perform a write operation against a read-only directory.</p>
84
86
  *
87
+ * @throws {@link WorkMailServiceException}
88
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
85
89
  *
86
90
  */
87
91
  export declare class UpdatePrimaryEmailAddressCommand extends $Command<UpdatePrimaryEmailAddressCommandInput, UpdatePrimaryEmailAddressCommandOutput, WorkMailClientResolvedConfig> {
@@ -40,6 +40,8 @@ export interface UpdateResourceCommandOutput extends UpdateResourceResponse, __M
40
40
  * };
41
41
  * const command = new UpdateResourceCommand(input);
42
42
  * const response = await client.send(command);
43
+ * // {};
44
+ *
43
45
  * ```
44
46
  *
45
47
  * @param UpdateResourceCommandInput - {@link UpdateResourceCommandInput}
@@ -86,6 +88,8 @@ export interface UpdateResourceCommandOutput extends UpdateResourceResponse, __M
86
88
  * <p>The organization must have a valid state to perform certain
87
89
  * operations on the organization or its members.</p>
88
90
  *
91
+ * @throws {@link WorkMailServiceException}
92
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
89
93
  *
90
94
  */
91
95
  export declare class UpdateResourceCommand extends $Command<UpdateResourceCommandInput, UpdateResourceCommandOutput, WorkMailClientResolvedConfig> {
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-workmail",
3
3
  "description": "AWS SDK for JavaScript Workmail Client for Node.js, Browser and React Native",
4
- "version": "3.321.1",
4
+ "version": "3.326.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,33 +21,33 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.321.1",
24
+ "@aws-sdk/client-sts": "3.326.0",
25
25
  "@aws-sdk/config-resolver": "3.310.0",
26
- "@aws-sdk/credential-provider-node": "3.321.1",
26
+ "@aws-sdk/credential-provider-node": "3.326.0",
27
27
  "@aws-sdk/fetch-http-handler": "3.310.0",
28
28
  "@aws-sdk/hash-node": "3.310.0",
29
29
  "@aws-sdk/invalid-dependency": "3.310.0",
30
- "@aws-sdk/middleware-content-length": "3.310.0",
31
- "@aws-sdk/middleware-endpoint": "3.310.0",
32
- "@aws-sdk/middleware-host-header": "3.310.0",
33
- "@aws-sdk/middleware-logger": "3.310.0",
34
- "@aws-sdk/middleware-recursion-detection": "3.310.0",
35
- "@aws-sdk/middleware-retry": "3.310.0",
36
- "@aws-sdk/middleware-serde": "3.310.0",
37
- "@aws-sdk/middleware-signing": "3.310.0",
38
- "@aws-sdk/middleware-stack": "3.310.0",
39
- "@aws-sdk/middleware-user-agent": "3.319.0",
30
+ "@aws-sdk/middleware-content-length": "3.325.0",
31
+ "@aws-sdk/middleware-endpoint": "3.325.0",
32
+ "@aws-sdk/middleware-host-header": "3.325.0",
33
+ "@aws-sdk/middleware-logger": "3.325.0",
34
+ "@aws-sdk/middleware-recursion-detection": "3.325.0",
35
+ "@aws-sdk/middleware-retry": "3.325.0",
36
+ "@aws-sdk/middleware-serde": "3.325.0",
37
+ "@aws-sdk/middleware-signing": "3.325.0",
38
+ "@aws-sdk/middleware-stack": "3.325.0",
39
+ "@aws-sdk/middleware-user-agent": "3.325.0",
40
40
  "@aws-sdk/node-config-provider": "3.310.0",
41
41
  "@aws-sdk/node-http-handler": "3.321.1",
42
42
  "@aws-sdk/protocol-http": "3.310.0",
43
- "@aws-sdk/smithy-client": "3.316.0",
43
+ "@aws-sdk/smithy-client": "3.325.0",
44
44
  "@aws-sdk/types": "3.310.0",
45
45
  "@aws-sdk/url-parser": "3.310.0",
46
46
  "@aws-sdk/util-base64": "3.310.0",
47
47
  "@aws-sdk/util-body-length-browser": "3.310.0",
48
48
  "@aws-sdk/util-body-length-node": "3.310.0",
49
- "@aws-sdk/util-defaults-mode-browser": "3.316.0",
50
- "@aws-sdk/util-defaults-mode-node": "3.316.0",
49
+ "@aws-sdk/util-defaults-mode-browser": "3.325.0",
50
+ "@aws-sdk/util-defaults-mode-node": "3.325.0",
51
51
  "@aws-sdk/util-endpoints": "3.319.0",
52
52
  "@aws-sdk/util-retry": "3.310.0",
53
53
  "@aws-sdk/util-user-agent-browser": "3.310.0",