@aws-sdk/client-workmail 3.413.0 → 3.415.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 (71) hide show
  1. package/README.md +32 -0
  2. package/dist-cjs/WorkMail.js +8 -0
  3. package/dist-cjs/commands/DescribeEntityCommand.js +46 -0
  4. package/dist-cjs/commands/DescribeUserCommand.js +2 -1
  5. package/dist-cjs/commands/ListGroupsForEntityCommand.js +46 -0
  6. package/dist-cjs/commands/ListUsersCommand.js +2 -1
  7. package/dist-cjs/commands/UpdateGroupCommand.js +46 -0
  8. package/dist-cjs/commands/UpdateUserCommand.js +47 -0
  9. package/dist-cjs/commands/index.js +4 -0
  10. package/dist-cjs/models/models_0.js +73 -20
  11. package/dist-cjs/pagination/ListGroupsForEntityPaginator.js +29 -0
  12. package/dist-cjs/pagination/index.js +1 -0
  13. package/dist-cjs/protocols/Aws_json1_1.js +276 -4
  14. package/dist-cjs/runtimeExtensions.js +3 -0
  15. package/dist-es/WorkMail.js +8 -0
  16. package/dist-es/commands/DescribeEntityCommand.js +42 -0
  17. package/dist-es/commands/DescribeUserCommand.js +2 -1
  18. package/dist-es/commands/ListGroupsForEntityCommand.js +42 -0
  19. package/dist-es/commands/ListUsersCommand.js +2 -1
  20. package/dist-es/commands/UpdateGroupCommand.js +42 -0
  21. package/dist-es/commands/UpdateUserCommand.js +43 -0
  22. package/dist-es/commands/index.js +4 -0
  23. package/dist-es/models/models_0.js +66 -17
  24. package/dist-es/pagination/ListGroupsForEntityPaginator.js +25 -0
  25. package/dist-es/pagination/index.js +1 -0
  26. package/dist-es/protocols/Aws_json1_1.js +265 -1
  27. package/dist-es/runtimeExtensions.js +3 -0
  28. package/dist-types/WorkMail.d.ts +28 -0
  29. package/dist-types/WorkMailClient.d.ts +6 -2
  30. package/dist-types/commands/AssociateDelegateToResourceCommand.d.ts +3 -0
  31. package/dist-types/commands/CreateGroupCommand.d.ts +1 -0
  32. package/dist-types/commands/CreateOrganizationCommand.d.ts +1 -1
  33. package/dist-types/commands/CreateResourceCommand.d.ts +5 -0
  34. package/dist-types/commands/CreateUserCommand.d.ts +5 -1
  35. package/dist-types/commands/DeleteOrganizationCommand.d.ts +1 -0
  36. package/dist-types/commands/DeleteResourceCommand.d.ts +3 -0
  37. package/dist-types/commands/DescribeEntityCommand.d.ts +91 -0
  38. package/dist-types/commands/DescribeGroupCommand.d.ts +1 -0
  39. package/dist-types/commands/DescribeOrganizationCommand.d.ts +2 -0
  40. package/dist-types/commands/DescribeResourceCommand.d.ts +5 -0
  41. package/dist-types/commands/DescribeUserCommand.d.ts +16 -1
  42. package/dist-types/commands/DisassociateDelegateFromResourceCommand.d.ts +3 -0
  43. package/dist-types/commands/GetMailboxDetailsCommand.d.ts +3 -0
  44. package/dist-types/commands/ListGroupsCommand.d.ts +5 -0
  45. package/dist-types/commands/ListGroupsForEntityCommand.d.ts +104 -0
  46. package/dist-types/commands/ListResourceDelegatesCommand.d.ts +3 -0
  47. package/dist-types/commands/ListResourcesCommand.d.ts +9 -0
  48. package/dist-types/commands/ListUsersCommand.d.ts +7 -1
  49. package/dist-types/commands/TagResourceCommand.d.ts +3 -0
  50. package/dist-types/commands/UpdateGroupCommand.d.ts +95 -0
  51. package/dist-types/commands/UpdateResourceCommand.d.ts +9 -0
  52. package/dist-types/commands/UpdateUserCommand.d.ts +117 -0
  53. package/dist-types/commands/index.d.ts +4 -0
  54. package/dist-types/extensionConfiguration.d.ts +2 -1
  55. package/dist-types/models/models_0.d.ts +921 -58
  56. package/dist-types/pagination/ListGroupsForEntityPaginator.d.ts +7 -0
  57. package/dist-types/pagination/index.d.ts +1 -0
  58. package/dist-types/protocols/Aws_json1_1.d.ts +36 -0
  59. package/dist-types/ts3.4/WorkMail.d.ts +68 -0
  60. package/dist-types/ts3.4/WorkMailClient.d.ts +26 -2
  61. package/dist-types/ts3.4/commands/DescribeEntityCommand.d.ts +38 -0
  62. package/dist-types/ts3.4/commands/ListGroupsForEntityCommand.d.ts +39 -0
  63. package/dist-types/ts3.4/commands/UpdateGroupCommand.d.ts +35 -0
  64. package/dist-types/ts3.4/commands/UpdateUserCommand.d.ts +35 -0
  65. package/dist-types/ts3.4/commands/index.d.ts +4 -0
  66. package/dist-types/ts3.4/extensionConfiguration.d.ts +3 -1
  67. package/dist-types/ts3.4/models/models_0.d.ts +139 -16
  68. package/dist-types/ts3.4/pagination/ListGroupsForEntityPaginator.d.ts +11 -0
  69. package/dist-types/ts3.4/pagination/index.d.ts +1 -0
  70. package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +48 -0
  71. package/package.json +4 -3
@@ -34,6 +34,8 @@ export interface CreateResourceCommandOutput extends CreateResourceResponse, __M
34
34
  * OrganizationId: "STRING_VALUE", // required
35
35
  * Name: "STRING_VALUE", // required
36
36
  * Type: "ROOM" || "EQUIPMENT", // required
37
+ * Description: "STRING_VALUE",
38
+ * HiddenFromGlobalAddressList: true || false,
37
39
  * };
38
40
  * const command = new CreateResourceCommand(input);
39
41
  * const response = await client.send(command);
@@ -72,6 +74,9 @@ export interface CreateResourceCommandOutput extends CreateResourceResponse, __M
72
74
  * @throws {@link ReservedNameException} (client fault)
73
75
  * <p>This user, group, or resource name is not allowed in WorkMail.</p>
74
76
  *
77
+ * @throws {@link UnsupportedOperationException} (client fault)
78
+ * <p>You can't perform a write operation against a read-only directory.</p>
79
+ *
75
80
  * @throws {@link WorkMailServiceException}
76
81
  * <p>Base exception class for all service exceptions from WorkMail service.</p>
77
82
  *
@@ -34,7 +34,11 @@ export interface CreateUserCommandOutput extends CreateUserResponse, __MetadataB
34
34
  * OrganizationId: "STRING_VALUE", // required
35
35
  * Name: "STRING_VALUE", // required
36
36
  * DisplayName: "STRING_VALUE", // required
37
- * Password: "STRING_VALUE", // required
37
+ * Password: "STRING_VALUE",
38
+ * Role: "USER" || "RESOURCE" || "SYSTEM_USER" || "REMOTE_USER",
39
+ * FirstName: "STRING_VALUE",
40
+ * LastName: "STRING_VALUE",
41
+ * HiddenFromGlobalAddressList: true || false,
38
42
  * };
39
43
  * const command = new CreateUserCommand(input);
40
44
  * const response = await client.send(command);
@@ -34,6 +34,7 @@ export interface DeleteOrganizationCommandOutput extends DeleteOrganizationRespo
34
34
  * ClientToken: "STRING_VALUE",
35
35
  * OrganizationId: "STRING_VALUE", // required
36
36
  * DeleteDirectory: true || false, // required
37
+ * ForceDelete: true || false,
37
38
  * };
38
39
  * const command = new DeleteOrganizationCommand(input);
39
40
  * const response = await client.send(command);
@@ -61,6 +61,9 @@ export interface DeleteResourceCommandOutput extends DeleteResourceResponse, __M
61
61
  * <p>The organization must have a valid state to perform certain
62
62
  * operations on the organization or its members.</p>
63
63
  *
64
+ * @throws {@link UnsupportedOperationException} (client fault)
65
+ * <p>You can't perform a write operation against a read-only directory.</p>
66
+ *
64
67
  * @throws {@link WorkMailServiceException}
65
68
  * <p>Base exception class for all service exceptions from WorkMail service.</p>
66
69
  *
@@ -0,0 +1,91 @@
1
+ import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
2
+ import { Command as $Command } from "@smithy/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
4
+ import { DescribeEntityRequest, DescribeEntityResponse } from "../models/models_0";
5
+ import { ServiceInputTypes, ServiceOutputTypes, WorkMailClientResolvedConfig } from "../WorkMailClient";
6
+ /**
7
+ * @public
8
+ */
9
+ export { __MetadataBearer, $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link DescribeEntityCommand}.
14
+ */
15
+ export interface DescribeEntityCommandInput extends DescribeEntityRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link DescribeEntityCommand}.
21
+ */
22
+ export interface DescribeEntityCommandOutput extends DescribeEntityResponse, __MetadataBearer {
23
+ }
24
+ /**
25
+ * @public
26
+ * <p>Returns basic details about an entity in WorkMail. </p>
27
+ * @example
28
+ * Use a bare-bones client and the command you need to make an API call.
29
+ * ```javascript
30
+ * import { WorkMailClient, DescribeEntityCommand } from "@aws-sdk/client-workmail"; // ES Modules import
31
+ * // const { WorkMailClient, DescribeEntityCommand } = require("@aws-sdk/client-workmail"); // CommonJS import
32
+ * const client = new WorkMailClient(config);
33
+ * const input = { // DescribeEntityRequest
34
+ * OrganizationId: "STRING_VALUE", // required
35
+ * Email: "STRING_VALUE", // required
36
+ * };
37
+ * const command = new DescribeEntityCommand(input);
38
+ * const response = await client.send(command);
39
+ * // { // DescribeEntityResponse
40
+ * // EntityId: "STRING_VALUE",
41
+ * // Name: "STRING_VALUE",
42
+ * // Type: "GROUP" || "USER" || "RESOURCE",
43
+ * // };
44
+ *
45
+ * ```
46
+ *
47
+ * @param DescribeEntityCommandInput - {@link DescribeEntityCommandInput}
48
+ * @returns {@link DescribeEntityCommandOutput}
49
+ * @see {@link DescribeEntityCommandInput} for command's `input` shape.
50
+ * @see {@link DescribeEntityCommandOutput} for command's `response` shape.
51
+ * @see {@link WorkMailClientResolvedConfig | config} for WorkMailClient's `config` shape.
52
+ *
53
+ * @throws {@link EntityNotFoundException} (client fault)
54
+ * <p>The identifier supplied for the user, group, or resource does not exist in your
55
+ * organization.</p>
56
+ *
57
+ * @throws {@link InvalidParameterException} (client fault)
58
+ * <p>One or more of the input parameters don't match the service's restrictions.</p>
59
+ *
60
+ * @throws {@link OrganizationNotFoundException} (client fault)
61
+ * <p>An operation received a valid organization identifier that either doesn't belong or
62
+ * exist in the system.</p>
63
+ *
64
+ * @throws {@link OrganizationStateException} (client fault)
65
+ * <p>The organization must have a valid state to perform certain
66
+ * operations on the organization or its members.</p>
67
+ *
68
+ * @throws {@link WorkMailServiceException}
69
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
70
+ *
71
+ */
72
+ export declare class DescribeEntityCommand extends $Command<DescribeEntityCommandInput, DescribeEntityCommandOutput, WorkMailClientResolvedConfig> {
73
+ readonly input: DescribeEntityCommandInput;
74
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
75
+ /**
76
+ * @public
77
+ */
78
+ constructor(input: DescribeEntityCommandInput);
79
+ /**
80
+ * @internal
81
+ */
82
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkMailClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeEntityCommandInput, DescribeEntityCommandOutput>;
83
+ /**
84
+ * @internal
85
+ */
86
+ private serialize;
87
+ /**
88
+ * @internal
89
+ */
90
+ private deserialize;
91
+ }
@@ -43,6 +43,7 @@ export interface DescribeGroupCommandOutput extends DescribeGroupResponse, __Met
43
43
  * // State: "ENABLED" || "DISABLED" || "DELETED",
44
44
  * // EnabledDate: new Date("TIMESTAMP"),
45
45
  * // DisabledDate: new Date("TIMESTAMP"),
46
+ * // HiddenFromGlobalAddressList: true || false,
46
47
  * // };
47
48
  *
48
49
  * ```
@@ -46,6 +46,8 @@ export interface DescribeOrganizationCommandOutput extends DescribeOrganizationR
46
46
  * // CompletedDate: new Date("TIMESTAMP"),
47
47
  * // ErrorMessage: "STRING_VALUE",
48
48
  * // ARN: "STRING_VALUE",
49
+ * // MigrationAdmin: "STRING_VALUE",
50
+ * // InteroperabilityEnabled: true || false,
49
51
  * // };
50
52
  *
51
53
  * ```
@@ -49,6 +49,8 @@ export interface DescribeResourceCommandOutput extends DescribeResourceResponse,
49
49
  * // State: "ENABLED" || "DISABLED" || "DELETED",
50
50
  * // EnabledDate: new Date("TIMESTAMP"),
51
51
  * // DisabledDate: new Date("TIMESTAMP"),
52
+ * // Description: "STRING_VALUE",
53
+ * // HiddenFromGlobalAddressList: true || false,
52
54
  * // };
53
55
  *
54
56
  * ```
@@ -74,6 +76,9 @@ export interface DescribeResourceCommandOutput extends DescribeResourceResponse,
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 UnsupportedOperationException} (client fault)
80
+ * <p>You can't perform a write operation against a read-only directory.</p>
81
+ *
77
82
  * @throws {@link WorkMailServiceException}
78
83
  * <p>Base exception class for all service exceptions from WorkMail service.</p>
79
84
  *
@@ -42,9 +42,24 @@ export interface DescribeUserCommandOutput extends DescribeUserResponse, __Metad
42
42
  * // Email: "STRING_VALUE",
43
43
  * // DisplayName: "STRING_VALUE",
44
44
  * // State: "ENABLED" || "DISABLED" || "DELETED",
45
- * // UserRole: "USER" || "RESOURCE" || "SYSTEM_USER",
45
+ * // UserRole: "USER" || "RESOURCE" || "SYSTEM_USER" || "REMOTE_USER",
46
46
  * // EnabledDate: new Date("TIMESTAMP"),
47
47
  * // DisabledDate: new Date("TIMESTAMP"),
48
+ * // MailboxProvisionedDate: new Date("TIMESTAMP"),
49
+ * // MailboxDeprovisionedDate: new Date("TIMESTAMP"),
50
+ * // FirstName: "STRING_VALUE",
51
+ * // LastName: "STRING_VALUE",
52
+ * // HiddenFromGlobalAddressList: true || false,
53
+ * // Initials: "STRING_VALUE",
54
+ * // Telephone: "STRING_VALUE",
55
+ * // Street: "STRING_VALUE",
56
+ * // JobTitle: "STRING_VALUE",
57
+ * // City: "STRING_VALUE",
58
+ * // Company: "STRING_VALUE",
59
+ * // ZipCode: "STRING_VALUE",
60
+ * // Department: "STRING_VALUE",
61
+ * // Country: "STRING_VALUE",
62
+ * // Office: "STRING_VALUE",
48
63
  * // };
49
64
  *
50
65
  * ```
@@ -66,6 +66,9 @@ export interface DisassociateDelegateFromResourceCommandOutput extends Disassoci
66
66
  * <p>The organization must have a valid state to perform certain
67
67
  * operations on the organization or its members.</p>
68
68
  *
69
+ * @throws {@link UnsupportedOperationException} (client fault)
70
+ * <p>You can't perform a write operation against a read-only directory.</p>
71
+ *
69
72
  * @throws {@link WorkMailServiceException}
70
73
  * <p>Base exception class for all service exceptions from WorkMail service.</p>
71
74
  *
@@ -53,6 +53,9 @@ export interface GetMailboxDetailsCommandOutput extends GetMailboxDetailsRespons
53
53
  * <p>The identifier supplied for the user, group, or resource does not exist in your
54
54
  * organization.</p>
55
55
  *
56
+ * @throws {@link InvalidParameterException} (client fault)
57
+ * <p>One or more of the input parameters don't match the service's restrictions.</p>
58
+ *
56
59
  * @throws {@link OrganizationNotFoundException} (client fault)
57
60
  * <p>An operation received a valid organization identifier that either doesn't belong or
58
61
  * exist in the system.</p>
@@ -34,6 +34,11 @@ export interface ListGroupsCommandOutput extends ListGroupsResponse, __MetadataB
34
34
  * OrganizationId: "STRING_VALUE", // required
35
35
  * NextToken: "STRING_VALUE",
36
36
  * MaxResults: Number("int"),
37
+ * Filters: { // ListGroupsFilters
38
+ * NamePrefix: "STRING_VALUE",
39
+ * PrimaryEmailPrefix: "STRING_VALUE",
40
+ * State: "ENABLED" || "DISABLED" || "DELETED",
41
+ * },
37
42
  * };
38
43
  * const command = new ListGroupsCommand(input);
39
44
  * const response = await client.send(command);
@@ -0,0 +1,104 @@
1
+ import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
2
+ import { Command as $Command } from "@smithy/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
4
+ import { ListGroupsForEntityRequest, ListGroupsForEntityResponse } from "../models/models_0";
5
+ import { ServiceInputTypes, ServiceOutputTypes, WorkMailClientResolvedConfig } from "../WorkMailClient";
6
+ /**
7
+ * @public
8
+ */
9
+ export { __MetadataBearer, $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link ListGroupsForEntityCommand}.
14
+ */
15
+ export interface ListGroupsForEntityCommandInput extends ListGroupsForEntityRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link ListGroupsForEntityCommand}.
21
+ */
22
+ export interface ListGroupsForEntityCommandOutput extends ListGroupsForEntityResponse, __MetadataBearer {
23
+ }
24
+ /**
25
+ * @public
26
+ * <p>Returns all the groups to which an entity belongs.</p>
27
+ * @example
28
+ * Use a bare-bones client and the command you need to make an API call.
29
+ * ```javascript
30
+ * import { WorkMailClient, ListGroupsForEntityCommand } from "@aws-sdk/client-workmail"; // ES Modules import
31
+ * // const { WorkMailClient, ListGroupsForEntityCommand } = require("@aws-sdk/client-workmail"); // CommonJS import
32
+ * const client = new WorkMailClient(config);
33
+ * const input = { // ListGroupsForEntityRequest
34
+ * OrganizationId: "STRING_VALUE", // required
35
+ * EntityId: "STRING_VALUE", // required
36
+ * Filters: { // ListGroupsForEntityFilters
37
+ * GroupNamePrefix: "STRING_VALUE",
38
+ * },
39
+ * NextToken: "STRING_VALUE",
40
+ * MaxResults: Number("int"),
41
+ * };
42
+ * const command = new ListGroupsForEntityCommand(input);
43
+ * const response = await client.send(command);
44
+ * // { // ListGroupsForEntityResponse
45
+ * // Groups: [ // GroupIdentifiers
46
+ * // { // GroupIdentifier
47
+ * // GroupId: "STRING_VALUE",
48
+ * // GroupName: "STRING_VALUE",
49
+ * // },
50
+ * // ],
51
+ * // NextToken: "STRING_VALUE",
52
+ * // };
53
+ *
54
+ * ```
55
+ *
56
+ * @param ListGroupsForEntityCommandInput - {@link ListGroupsForEntityCommandInput}
57
+ * @returns {@link ListGroupsForEntityCommandOutput}
58
+ * @see {@link ListGroupsForEntityCommandInput} for command's `input` shape.
59
+ * @see {@link ListGroupsForEntityCommandOutput} for command's `response` shape.
60
+ * @see {@link WorkMailClientResolvedConfig | config} for WorkMailClient's `config` shape.
61
+ *
62
+ * @throws {@link EntityNotFoundException} (client fault)
63
+ * <p>The identifier supplied for the user, group, or resource does not exist in your
64
+ * organization.</p>
65
+ *
66
+ * @throws {@link EntityStateException} (client fault)
67
+ * <p>You are performing an operation on a user, group, or resource that isn't in the
68
+ * expected state, such as trying to delete an active user.</p>
69
+ *
70
+ * @throws {@link InvalidParameterException} (client fault)
71
+ * <p>One or more of the input parameters don't match the service's restrictions.</p>
72
+ *
73
+ * @throws {@link OrganizationNotFoundException} (client fault)
74
+ * <p>An operation received a valid organization identifier that either doesn't belong or
75
+ * exist in the system.</p>
76
+ *
77
+ * @throws {@link OrganizationStateException} (client fault)
78
+ * <p>The organization must have a valid state to perform certain
79
+ * operations on the organization or its members.</p>
80
+ *
81
+ * @throws {@link WorkMailServiceException}
82
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
83
+ *
84
+ */
85
+ export declare class ListGroupsForEntityCommand extends $Command<ListGroupsForEntityCommandInput, ListGroupsForEntityCommandOutput, WorkMailClientResolvedConfig> {
86
+ readonly input: ListGroupsForEntityCommandInput;
87
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
88
+ /**
89
+ * @public
90
+ */
91
+ constructor(input: ListGroupsForEntityCommandInput);
92
+ /**
93
+ * @internal
94
+ */
95
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkMailClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListGroupsForEntityCommandInput, ListGroupsForEntityCommandOutput>;
96
+ /**
97
+ * @internal
98
+ */
99
+ private serialize;
100
+ /**
101
+ * @internal
102
+ */
103
+ private deserialize;
104
+ }
@@ -76,6 +76,9 @@ export interface ListResourceDelegatesCommandOutput extends ListResourceDelegate
76
76
  * <p>The organization must have a valid state to perform certain
77
77
  * operations on the organization or its members.</p>
78
78
  *
79
+ * @throws {@link UnsupportedOperationException} (client fault)
80
+ * <p>You can't perform a write operation against a read-only directory.</p>
81
+ *
79
82
  * @throws {@link WorkMailServiceException}
80
83
  * <p>Base exception class for all service exceptions from WorkMail service.</p>
81
84
  *
@@ -34,6 +34,11 @@ export interface ListResourcesCommandOutput extends ListResourcesResponse, __Met
34
34
  * OrganizationId: "STRING_VALUE", // required
35
35
  * NextToken: "STRING_VALUE",
36
36
  * MaxResults: Number("int"),
37
+ * Filters: { // ListResourcesFilters
38
+ * NamePrefix: "STRING_VALUE",
39
+ * PrimaryEmailPrefix: "STRING_VALUE",
40
+ * State: "ENABLED" || "DISABLED" || "DELETED",
41
+ * },
37
42
  * };
38
43
  * const command = new ListResourcesCommand(input);
39
44
  * const response = await client.send(command);
@@ -47,6 +52,7 @@ export interface ListResourcesCommandOutput extends ListResourcesResponse, __Met
47
52
  * // State: "ENABLED" || "DISABLED" || "DELETED",
48
53
  * // EnabledDate: new Date("TIMESTAMP"),
49
54
  * // DisabledDate: new Date("TIMESTAMP"),
55
+ * // Description: "STRING_VALUE",
50
56
  * // },
51
57
  * // ],
52
58
  * // NextToken: "STRING_VALUE",
@@ -71,6 +77,9 @@ export interface ListResourcesCommandOutput extends ListResourcesResponse, __Met
71
77
  * <p>The organization must have a valid state to perform certain
72
78
  * operations on the organization or its members.</p>
73
79
  *
80
+ * @throws {@link UnsupportedOperationException} (client fault)
81
+ * <p>You can't perform a write operation against a read-only directory.</p>
82
+ *
74
83
  * @throws {@link WorkMailServiceException}
75
84
  * <p>Base exception class for all service exceptions from WorkMail service.</p>
76
85
  *
@@ -34,6 +34,12 @@ export interface ListUsersCommandOutput extends ListUsersResponse, __MetadataBea
34
34
  * OrganizationId: "STRING_VALUE", // required
35
35
  * NextToken: "STRING_VALUE",
36
36
  * MaxResults: Number("int"),
37
+ * Filters: { // ListUsersFilters
38
+ * UsernamePrefix: "STRING_VALUE",
39
+ * DisplayNamePrefix: "STRING_VALUE",
40
+ * PrimaryEmailPrefix: "STRING_VALUE",
41
+ * State: "ENABLED" || "DISABLED" || "DELETED",
42
+ * },
37
43
  * };
38
44
  * const command = new ListUsersCommand(input);
39
45
  * const response = await client.send(command);
@@ -45,7 +51,7 @@ export interface ListUsersCommandOutput extends ListUsersResponse, __MetadataBea
45
51
  * // Name: "STRING_VALUE",
46
52
  * // DisplayName: "STRING_VALUE",
47
53
  * // State: "ENABLED" || "DISABLED" || "DELETED",
48
- * // UserRole: "USER" || "RESOURCE" || "SYSTEM_USER",
54
+ * // UserRole: "USER" || "RESOURCE" || "SYSTEM_USER" || "REMOTE_USER",
49
55
  * // EnabledDate: new Date("TIMESTAMP"),
50
56
  * // DisabledDate: new Date("TIMESTAMP"),
51
57
  * // },
@@ -52,6 +52,9 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
52
52
  * @see {@link TagResourceCommandOutput} for command's `response` shape.
53
53
  * @see {@link WorkMailClientResolvedConfig | config} for WorkMailClient's `config` shape.
54
54
  *
55
+ * @throws {@link InvalidParameterException} (client fault)
56
+ * <p>One or more of the input parameters don't match the service's restrictions.</p>
57
+ *
55
58
  * @throws {@link OrganizationStateException} (client fault)
56
59
  * <p>The organization must have a valid state to perform certain
57
60
  * operations on the organization or its members.</p>
@@ -0,0 +1,95 @@
1
+ import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
2
+ import { Command as $Command } from "@smithy/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
4
+ import { UpdateGroupRequest, UpdateGroupResponse } from "../models/models_0";
5
+ import { ServiceInputTypes, ServiceOutputTypes, WorkMailClientResolvedConfig } from "../WorkMailClient";
6
+ /**
7
+ * @public
8
+ */
9
+ export { __MetadataBearer, $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link UpdateGroupCommand}.
14
+ */
15
+ export interface UpdateGroupCommandInput extends UpdateGroupRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link UpdateGroupCommand}.
21
+ */
22
+ export interface UpdateGroupCommandOutput extends UpdateGroupResponse, __MetadataBearer {
23
+ }
24
+ /**
25
+ * @public
26
+ * <p>Updates attibutes in a group.</p>
27
+ * @example
28
+ * Use a bare-bones client and the command you need to make an API call.
29
+ * ```javascript
30
+ * import { WorkMailClient, UpdateGroupCommand } from "@aws-sdk/client-workmail"; // ES Modules import
31
+ * // const { WorkMailClient, UpdateGroupCommand } = require("@aws-sdk/client-workmail"); // CommonJS import
32
+ * const client = new WorkMailClient(config);
33
+ * const input = { // UpdateGroupRequest
34
+ * OrganizationId: "STRING_VALUE", // required
35
+ * GroupId: "STRING_VALUE", // required
36
+ * HiddenFromGlobalAddressList: true || false,
37
+ * };
38
+ * const command = new UpdateGroupCommand(input);
39
+ * const response = await client.send(command);
40
+ * // {};
41
+ *
42
+ * ```
43
+ *
44
+ * @param UpdateGroupCommandInput - {@link UpdateGroupCommandInput}
45
+ * @returns {@link UpdateGroupCommandOutput}
46
+ * @see {@link UpdateGroupCommandInput} for command's `input` shape.
47
+ * @see {@link UpdateGroupCommandOutput} for command's `response` shape.
48
+ * @see {@link WorkMailClientResolvedConfig | config} for WorkMailClient's `config` shape.
49
+ *
50
+ * @throws {@link EntityNotFoundException} (client fault)
51
+ * <p>The identifier supplied for the user, group, or resource does not exist in your
52
+ * organization.</p>
53
+ *
54
+ * @throws {@link EntityStateException} (client fault)
55
+ * <p>You are performing an operation on a user, group, or resource that isn't in the
56
+ * expected state, such as trying to delete an active user.</p>
57
+ *
58
+ * @throws {@link InvalidParameterException} (client fault)
59
+ * <p>One or more of the input parameters don't match the service's restrictions.</p>
60
+ *
61
+ * @throws {@link OrganizationNotFoundException} (client fault)
62
+ * <p>An operation received a valid organization identifier that either doesn't belong or
63
+ * exist in the system.</p>
64
+ *
65
+ * @throws {@link OrganizationStateException} (client fault)
66
+ * <p>The organization must have a valid state to perform certain
67
+ * operations on the organization or its members.</p>
68
+ *
69
+ * @throws {@link UnsupportedOperationException} (client fault)
70
+ * <p>You can't perform a write operation against a read-only directory.</p>
71
+ *
72
+ * @throws {@link WorkMailServiceException}
73
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
74
+ *
75
+ */
76
+ export declare class UpdateGroupCommand extends $Command<UpdateGroupCommandInput, UpdateGroupCommandOutput, WorkMailClientResolvedConfig> {
77
+ readonly input: UpdateGroupCommandInput;
78
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
79
+ /**
80
+ * @public
81
+ */
82
+ constructor(input: UpdateGroupCommandInput);
83
+ /**
84
+ * @internal
85
+ */
86
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkMailClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateGroupCommandInput, UpdateGroupCommandOutput>;
87
+ /**
88
+ * @internal
89
+ */
90
+ private serialize;
91
+ /**
92
+ * @internal
93
+ */
94
+ private deserialize;
95
+ }
@@ -41,6 +41,9 @@ export interface UpdateResourceCommandOutput extends UpdateResourceResponse, __M
41
41
  * AutoDeclineRecurringRequests: true || false,
42
42
  * AutoDeclineConflictingRequests: true || false,
43
43
  * },
44
+ * Description: "STRING_VALUE",
45
+ * Type: "ROOM" || "EQUIPMENT",
46
+ * HiddenFromGlobalAddressList: true || false,
44
47
  * };
45
48
  * const command = new UpdateResourceCommand(input);
46
49
  * const response = await client.send(command);
@@ -74,6 +77,9 @@ export interface UpdateResourceCommandOutput extends UpdateResourceResponse, __M
74
77
  * auto-respond to requests or have at least one delegate associated that can do so on its
75
78
  * behalf.</p>
76
79
  *
80
+ * @throws {@link InvalidParameterException} (client fault)
81
+ * <p>One or more of the input parameters don't match the service's restrictions.</p>
82
+ *
77
83
  * @throws {@link MailDomainNotFoundException} (client fault)
78
84
  * <p>The domain specified is not found in your organization.</p>
79
85
  *
@@ -92,6 +98,9 @@ export interface UpdateResourceCommandOutput extends UpdateResourceResponse, __M
92
98
  * <p>The organization must have a valid state to perform certain
93
99
  * operations on the organization or its members.</p>
94
100
  *
101
+ * @throws {@link UnsupportedOperationException} (client fault)
102
+ * <p>You can't perform a write operation against a read-only directory.</p>
103
+ *
95
104
  * @throws {@link WorkMailServiceException}
96
105
  * <p>Base exception class for all service exceptions from WorkMail service.</p>
97
106
  *