@aws-sdk/client-workmail 3.414.0 → 3.418.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.
- package/README.md +32 -0
- package/dist-cjs/WorkMail.js +8 -0
- package/dist-cjs/commands/AssociateDelegateToResourceCommand.js +5 -0
- package/dist-cjs/commands/AssociateMemberToGroupCommand.js +5 -0
- package/dist-cjs/commands/AssumeImpersonationRoleCommand.js +5 -0
- package/dist-cjs/commands/CancelMailboxExportJobCommand.js +5 -0
- package/dist-cjs/commands/CreateAliasCommand.js +5 -0
- package/dist-cjs/commands/CreateAvailabilityConfigurationCommand.js +5 -0
- package/dist-cjs/commands/CreateGroupCommand.js +5 -0
- package/dist-cjs/commands/CreateImpersonationRoleCommand.js +5 -0
- package/dist-cjs/commands/CreateMobileDeviceAccessRuleCommand.js +5 -0
- package/dist-cjs/commands/CreateOrganizationCommand.js +5 -0
- package/dist-cjs/commands/CreateResourceCommand.js +5 -0
- package/dist-cjs/commands/CreateUserCommand.js +5 -0
- package/dist-cjs/commands/DeleteAccessControlRuleCommand.js +5 -0
- package/dist-cjs/commands/DeleteAliasCommand.js +5 -0
- package/dist-cjs/commands/DeleteAvailabilityConfigurationCommand.js +5 -0
- package/dist-cjs/commands/DeleteEmailMonitoringConfigurationCommand.js +5 -0
- package/dist-cjs/commands/DeleteGroupCommand.js +5 -0
- package/dist-cjs/commands/DeleteImpersonationRoleCommand.js +5 -0
- package/dist-cjs/commands/DeleteMailboxPermissionsCommand.js +5 -0
- package/dist-cjs/commands/DeleteMobileDeviceAccessOverrideCommand.js +5 -0
- package/dist-cjs/commands/DeleteMobileDeviceAccessRuleCommand.js +5 -0
- package/dist-cjs/commands/DeleteOrganizationCommand.js +5 -0
- package/dist-cjs/commands/DeleteResourceCommand.js +5 -0
- package/dist-cjs/commands/DeleteRetentionPolicyCommand.js +5 -0
- package/dist-cjs/commands/DeleteUserCommand.js +5 -0
- package/dist-cjs/commands/DeregisterFromWorkMailCommand.js +5 -0
- package/dist-cjs/commands/DeregisterMailDomainCommand.js +5 -0
- package/dist-cjs/commands/DescribeEmailMonitoringConfigurationCommand.js +5 -0
- package/dist-cjs/commands/DescribeEntityCommand.js +51 -0
- package/dist-cjs/commands/DescribeGroupCommand.js +5 -0
- package/dist-cjs/commands/DescribeInboundDmarcSettingsCommand.js +5 -0
- package/dist-cjs/commands/DescribeMailboxExportJobCommand.js +5 -0
- package/dist-cjs/commands/DescribeOrganizationCommand.js +5 -0
- package/dist-cjs/commands/DescribeResourceCommand.js +5 -0
- package/dist-cjs/commands/DescribeUserCommand.js +7 -1
- package/dist-cjs/commands/DisassociateDelegateFromResourceCommand.js +5 -0
- package/dist-cjs/commands/DisassociateMemberFromGroupCommand.js +5 -0
- package/dist-cjs/commands/GetAccessControlEffectCommand.js +5 -0
- package/dist-cjs/commands/GetDefaultRetentionPolicyCommand.js +5 -0
- package/dist-cjs/commands/GetImpersonationRoleCommand.js +5 -0
- package/dist-cjs/commands/GetImpersonationRoleEffectCommand.js +5 -0
- package/dist-cjs/commands/GetMailDomainCommand.js +5 -0
- package/dist-cjs/commands/GetMailboxDetailsCommand.js +5 -0
- package/dist-cjs/commands/GetMobileDeviceAccessEffectCommand.js +5 -0
- package/dist-cjs/commands/GetMobileDeviceAccessOverrideCommand.js +5 -0
- package/dist-cjs/commands/ListAccessControlRulesCommand.js +5 -0
- package/dist-cjs/commands/ListAliasesCommand.js +5 -0
- package/dist-cjs/commands/ListAvailabilityConfigurationsCommand.js +5 -0
- package/dist-cjs/commands/ListGroupMembersCommand.js +5 -0
- package/dist-cjs/commands/ListGroupsCommand.js +5 -0
- package/dist-cjs/commands/ListGroupsForEntityCommand.js +51 -0
- package/dist-cjs/commands/ListImpersonationRolesCommand.js +5 -0
- package/dist-cjs/commands/ListMailDomainsCommand.js +5 -0
- package/dist-cjs/commands/ListMailboxExportJobsCommand.js +5 -0
- package/dist-cjs/commands/ListMailboxPermissionsCommand.js +5 -0
- package/dist-cjs/commands/ListMobileDeviceAccessOverridesCommand.js +5 -0
- package/dist-cjs/commands/ListMobileDeviceAccessRulesCommand.js +5 -0
- package/dist-cjs/commands/ListOrganizationsCommand.js +5 -0
- package/dist-cjs/commands/ListResourceDelegatesCommand.js +5 -0
- package/dist-cjs/commands/ListResourcesCommand.js +5 -0
- package/dist-cjs/commands/ListTagsForResourceCommand.js +5 -0
- package/dist-cjs/commands/ListUsersCommand.js +7 -1
- package/dist-cjs/commands/PutAccessControlRuleCommand.js +5 -0
- package/dist-cjs/commands/PutEmailMonitoringConfigurationCommand.js +5 -0
- package/dist-cjs/commands/PutInboundDmarcSettingsCommand.js +5 -0
- package/dist-cjs/commands/PutMailboxPermissionsCommand.js +5 -0
- package/dist-cjs/commands/PutMobileDeviceAccessOverrideCommand.js +5 -0
- package/dist-cjs/commands/PutRetentionPolicyCommand.js +5 -0
- package/dist-cjs/commands/RegisterMailDomainCommand.js +5 -0
- package/dist-cjs/commands/RegisterToWorkMailCommand.js +5 -0
- package/dist-cjs/commands/ResetPasswordCommand.js +5 -0
- package/dist-cjs/commands/StartMailboxExportJobCommand.js +5 -0
- package/dist-cjs/commands/TagResourceCommand.js +5 -0
- package/dist-cjs/commands/TestAvailabilityConfigurationCommand.js +5 -0
- package/dist-cjs/commands/UntagResourceCommand.js +5 -0
- package/dist-cjs/commands/UpdateAvailabilityConfigurationCommand.js +5 -0
- package/dist-cjs/commands/UpdateDefaultMailDomainCommand.js +5 -0
- package/dist-cjs/commands/UpdateGroupCommand.js +51 -0
- package/dist-cjs/commands/UpdateImpersonationRoleCommand.js +5 -0
- package/dist-cjs/commands/UpdateMailboxQuotaCommand.js +5 -0
- package/dist-cjs/commands/UpdateMobileDeviceAccessRuleCommand.js +5 -0
- package/dist-cjs/commands/UpdatePrimaryEmailAddressCommand.js +5 -0
- package/dist-cjs/commands/UpdateResourceCommand.js +5 -0
- package/dist-cjs/commands/UpdateUserCommand.js +52 -0
- package/dist-cjs/commands/index.js +4 -0
- package/dist-cjs/models/models_0.js +73 -20
- package/dist-cjs/pagination/ListGroupsForEntityPaginator.js +29 -0
- package/dist-cjs/pagination/index.js +1 -0
- package/dist-cjs/protocols/Aws_json1_1.js +276 -4
- package/dist-es/WorkMail.js +8 -0
- package/dist-es/commands/AssociateDelegateToResourceCommand.js +5 -0
- package/dist-es/commands/AssociateMemberToGroupCommand.js +5 -0
- package/dist-es/commands/AssumeImpersonationRoleCommand.js +5 -0
- package/dist-es/commands/CancelMailboxExportJobCommand.js +5 -0
- package/dist-es/commands/CreateAliasCommand.js +5 -0
- package/dist-es/commands/CreateAvailabilityConfigurationCommand.js +5 -0
- package/dist-es/commands/CreateGroupCommand.js +5 -0
- package/dist-es/commands/CreateImpersonationRoleCommand.js +5 -0
- package/dist-es/commands/CreateMobileDeviceAccessRuleCommand.js +5 -0
- package/dist-es/commands/CreateOrganizationCommand.js +5 -0
- package/dist-es/commands/CreateResourceCommand.js +5 -0
- package/dist-es/commands/CreateUserCommand.js +5 -0
- package/dist-es/commands/DeleteAccessControlRuleCommand.js +5 -0
- package/dist-es/commands/DeleteAliasCommand.js +5 -0
- package/dist-es/commands/DeleteAvailabilityConfigurationCommand.js +5 -0
- package/dist-es/commands/DeleteEmailMonitoringConfigurationCommand.js +5 -0
- package/dist-es/commands/DeleteGroupCommand.js +5 -0
- package/dist-es/commands/DeleteImpersonationRoleCommand.js +5 -0
- package/dist-es/commands/DeleteMailboxPermissionsCommand.js +5 -0
- package/dist-es/commands/DeleteMobileDeviceAccessOverrideCommand.js +5 -0
- package/dist-es/commands/DeleteMobileDeviceAccessRuleCommand.js +5 -0
- package/dist-es/commands/DeleteOrganizationCommand.js +5 -0
- package/dist-es/commands/DeleteResourceCommand.js +5 -0
- package/dist-es/commands/DeleteRetentionPolicyCommand.js +5 -0
- package/dist-es/commands/DeleteUserCommand.js +5 -0
- package/dist-es/commands/DeregisterFromWorkMailCommand.js +5 -0
- package/dist-es/commands/DeregisterMailDomainCommand.js +5 -0
- package/dist-es/commands/DescribeEmailMonitoringConfigurationCommand.js +5 -0
- package/dist-es/commands/DescribeEntityCommand.js +47 -0
- package/dist-es/commands/DescribeGroupCommand.js +5 -0
- package/dist-es/commands/DescribeInboundDmarcSettingsCommand.js +5 -0
- package/dist-es/commands/DescribeMailboxExportJobCommand.js +5 -0
- package/dist-es/commands/DescribeOrganizationCommand.js +5 -0
- package/dist-es/commands/DescribeResourceCommand.js +5 -0
- package/dist-es/commands/DescribeUserCommand.js +7 -1
- package/dist-es/commands/DisassociateDelegateFromResourceCommand.js +5 -0
- package/dist-es/commands/DisassociateMemberFromGroupCommand.js +5 -0
- package/dist-es/commands/GetAccessControlEffectCommand.js +5 -0
- package/dist-es/commands/GetDefaultRetentionPolicyCommand.js +5 -0
- package/dist-es/commands/GetImpersonationRoleCommand.js +5 -0
- package/dist-es/commands/GetImpersonationRoleEffectCommand.js +5 -0
- package/dist-es/commands/GetMailDomainCommand.js +5 -0
- package/dist-es/commands/GetMailboxDetailsCommand.js +5 -0
- package/dist-es/commands/GetMobileDeviceAccessEffectCommand.js +5 -0
- package/dist-es/commands/GetMobileDeviceAccessOverrideCommand.js +5 -0
- package/dist-es/commands/ListAccessControlRulesCommand.js +5 -0
- package/dist-es/commands/ListAliasesCommand.js +5 -0
- package/dist-es/commands/ListAvailabilityConfigurationsCommand.js +5 -0
- package/dist-es/commands/ListGroupMembersCommand.js +5 -0
- package/dist-es/commands/ListGroupsCommand.js +5 -0
- package/dist-es/commands/ListGroupsForEntityCommand.js +47 -0
- package/dist-es/commands/ListImpersonationRolesCommand.js +5 -0
- package/dist-es/commands/ListMailDomainsCommand.js +5 -0
- package/dist-es/commands/ListMailboxExportJobsCommand.js +5 -0
- package/dist-es/commands/ListMailboxPermissionsCommand.js +5 -0
- package/dist-es/commands/ListMobileDeviceAccessOverridesCommand.js +5 -0
- package/dist-es/commands/ListMobileDeviceAccessRulesCommand.js +5 -0
- package/dist-es/commands/ListOrganizationsCommand.js +5 -0
- package/dist-es/commands/ListResourceDelegatesCommand.js +5 -0
- package/dist-es/commands/ListResourcesCommand.js +5 -0
- package/dist-es/commands/ListTagsForResourceCommand.js +5 -0
- package/dist-es/commands/ListUsersCommand.js +7 -1
- package/dist-es/commands/PutAccessControlRuleCommand.js +5 -0
- package/dist-es/commands/PutEmailMonitoringConfigurationCommand.js +5 -0
- package/dist-es/commands/PutInboundDmarcSettingsCommand.js +5 -0
- package/dist-es/commands/PutMailboxPermissionsCommand.js +5 -0
- package/dist-es/commands/PutMobileDeviceAccessOverrideCommand.js +5 -0
- package/dist-es/commands/PutRetentionPolicyCommand.js +5 -0
- package/dist-es/commands/RegisterMailDomainCommand.js +5 -0
- package/dist-es/commands/RegisterToWorkMailCommand.js +5 -0
- package/dist-es/commands/ResetPasswordCommand.js +5 -0
- package/dist-es/commands/StartMailboxExportJobCommand.js +5 -0
- package/dist-es/commands/TagResourceCommand.js +5 -0
- package/dist-es/commands/TestAvailabilityConfigurationCommand.js +5 -0
- package/dist-es/commands/UntagResourceCommand.js +5 -0
- package/dist-es/commands/UpdateAvailabilityConfigurationCommand.js +5 -0
- package/dist-es/commands/UpdateDefaultMailDomainCommand.js +5 -0
- package/dist-es/commands/UpdateGroupCommand.js +47 -0
- package/dist-es/commands/UpdateImpersonationRoleCommand.js +5 -0
- package/dist-es/commands/UpdateMailboxQuotaCommand.js +5 -0
- package/dist-es/commands/UpdateMobileDeviceAccessRuleCommand.js +5 -0
- package/dist-es/commands/UpdatePrimaryEmailAddressCommand.js +5 -0
- package/dist-es/commands/UpdateResourceCommand.js +5 -0
- package/dist-es/commands/UpdateUserCommand.js +48 -0
- package/dist-es/commands/index.js +4 -0
- package/dist-es/models/models_0.js +66 -17
- package/dist-es/pagination/ListGroupsForEntityPaginator.js +25 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/protocols/Aws_json1_1.js +265 -1
- package/dist-types/WorkMail.d.ts +28 -0
- package/dist-types/WorkMailClient.d.ts +6 -2
- package/dist-types/commands/AssociateDelegateToResourceCommand.d.ts +3 -0
- package/dist-types/commands/CreateGroupCommand.d.ts +1 -0
- package/dist-types/commands/CreateOrganizationCommand.d.ts +1 -1
- package/dist-types/commands/CreateResourceCommand.d.ts +5 -0
- package/dist-types/commands/CreateUserCommand.d.ts +5 -1
- package/dist-types/commands/DeleteOrganizationCommand.d.ts +1 -0
- package/dist-types/commands/DeleteResourceCommand.d.ts +3 -0
- package/dist-types/commands/DescribeEntityCommand.d.ts +91 -0
- package/dist-types/commands/DescribeGroupCommand.d.ts +1 -0
- package/dist-types/commands/DescribeOrganizationCommand.d.ts +2 -0
- package/dist-types/commands/DescribeResourceCommand.d.ts +5 -0
- package/dist-types/commands/DescribeUserCommand.d.ts +16 -1
- package/dist-types/commands/DisassociateDelegateFromResourceCommand.d.ts +3 -0
- package/dist-types/commands/GetMailboxDetailsCommand.d.ts +3 -0
- package/dist-types/commands/ListGroupsCommand.d.ts +5 -0
- package/dist-types/commands/ListGroupsForEntityCommand.d.ts +104 -0
- package/dist-types/commands/ListResourceDelegatesCommand.d.ts +3 -0
- package/dist-types/commands/ListResourcesCommand.d.ts +9 -0
- package/dist-types/commands/ListUsersCommand.d.ts +7 -1
- package/dist-types/commands/TagResourceCommand.d.ts +3 -0
- package/dist-types/commands/UpdateGroupCommand.d.ts +95 -0
- package/dist-types/commands/UpdateResourceCommand.d.ts +9 -0
- package/dist-types/commands/UpdateUserCommand.d.ts +117 -0
- package/dist-types/commands/index.d.ts +4 -0
- package/dist-types/models/models_0.d.ts +921 -58
- package/dist-types/pagination/ListGroupsForEntityPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/protocols/Aws_json1_1.d.ts +36 -0
- package/dist-types/ts3.4/WorkMail.d.ts +68 -0
- package/dist-types/ts3.4/WorkMailClient.d.ts +26 -2
- package/dist-types/ts3.4/commands/DescribeEntityCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/ListGroupsForEntityCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/UpdateGroupCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/UpdateUserCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/index.d.ts +4 -0
- package/dist-types/ts3.4/models/models_0.d.ts +139 -16
- package/dist-types/ts3.4/pagination/ListGroupsForEntityPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +48 -0
- package/package.json +31 -31
|
@@ -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",
|
|
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
|
*
|
|
@@ -0,0 +1,117 @@
|
|
|
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 { UpdateUserRequest, UpdateUserResponse } 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 UpdateUserCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface UpdateUserCommandInput extends UpdateUserRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link UpdateUserCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface UpdateUserCommandOutput extends UpdateUserResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Updates data for the user. To have the latest information, it must be preceded by a
|
|
27
|
+
* <a>DescribeUser</a> call. The dataset in the request should be the one
|
|
28
|
+
* expected when performing another <code>DescribeUser</code> call.</p>
|
|
29
|
+
* @example
|
|
30
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
31
|
+
* ```javascript
|
|
32
|
+
* import { WorkMailClient, UpdateUserCommand } from "@aws-sdk/client-workmail"; // ES Modules import
|
|
33
|
+
* // const { WorkMailClient, UpdateUserCommand } = require("@aws-sdk/client-workmail"); // CommonJS import
|
|
34
|
+
* const client = new WorkMailClient(config);
|
|
35
|
+
* const input = { // UpdateUserRequest
|
|
36
|
+
* OrganizationId: "STRING_VALUE", // required
|
|
37
|
+
* UserId: "STRING_VALUE", // required
|
|
38
|
+
* Role: "USER" || "RESOURCE" || "SYSTEM_USER" || "REMOTE_USER",
|
|
39
|
+
* DisplayName: "STRING_VALUE",
|
|
40
|
+
* FirstName: "STRING_VALUE",
|
|
41
|
+
* LastName: "STRING_VALUE",
|
|
42
|
+
* HiddenFromGlobalAddressList: true || false,
|
|
43
|
+
* Initials: "STRING_VALUE",
|
|
44
|
+
* Telephone: "STRING_VALUE",
|
|
45
|
+
* Street: "STRING_VALUE",
|
|
46
|
+
* JobTitle: "STRING_VALUE",
|
|
47
|
+
* City: "STRING_VALUE",
|
|
48
|
+
* Company: "STRING_VALUE",
|
|
49
|
+
* ZipCode: "STRING_VALUE",
|
|
50
|
+
* Department: "STRING_VALUE",
|
|
51
|
+
* Country: "STRING_VALUE",
|
|
52
|
+
* Office: "STRING_VALUE",
|
|
53
|
+
* };
|
|
54
|
+
* const command = new UpdateUserCommand(input);
|
|
55
|
+
* const response = await client.send(command);
|
|
56
|
+
* // {};
|
|
57
|
+
*
|
|
58
|
+
* ```
|
|
59
|
+
*
|
|
60
|
+
* @param UpdateUserCommandInput - {@link UpdateUserCommandInput}
|
|
61
|
+
* @returns {@link UpdateUserCommandOutput}
|
|
62
|
+
* @see {@link UpdateUserCommandInput} for command's `input` shape.
|
|
63
|
+
* @see {@link UpdateUserCommandOutput} for command's `response` shape.
|
|
64
|
+
* @see {@link WorkMailClientResolvedConfig | config} for WorkMailClient's `config` shape.
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link DirectoryServiceAuthenticationFailedException} (client fault)
|
|
67
|
+
* <p>The directory service doesn't recognize the credentials supplied by WorkMail.</p>
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link DirectoryUnavailableException} (client fault)
|
|
70
|
+
* <p>The directory is unavailable. It might be located in another Region or deleted.</p>
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link EntityNotFoundException} (client fault)
|
|
73
|
+
* <p>The identifier supplied for the user, group, or resource does not exist in your
|
|
74
|
+
* organization.</p>
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link EntityStateException} (client fault)
|
|
77
|
+
* <p>You are performing an operation on a user, group, or resource that isn't in the
|
|
78
|
+
* expected state, such as trying to delete an active user.</p>
|
|
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
|
+
*
|
|
83
|
+
* @throws {@link OrganizationNotFoundException} (client fault)
|
|
84
|
+
* <p>An operation received a valid organization identifier that either doesn't belong or
|
|
85
|
+
* exist in the system.</p>
|
|
86
|
+
*
|
|
87
|
+
* @throws {@link OrganizationStateException} (client fault)
|
|
88
|
+
* <p>The organization must have a valid state to perform certain
|
|
89
|
+
* operations on the organization or its members.</p>
|
|
90
|
+
*
|
|
91
|
+
* @throws {@link UnsupportedOperationException} (client fault)
|
|
92
|
+
* <p>You can't perform a write operation against a read-only directory.</p>
|
|
93
|
+
*
|
|
94
|
+
* @throws {@link WorkMailServiceException}
|
|
95
|
+
* <p>Base exception class for all service exceptions from WorkMail service.</p>
|
|
96
|
+
*
|
|
97
|
+
*/
|
|
98
|
+
export declare class UpdateUserCommand extends $Command<UpdateUserCommandInput, UpdateUserCommandOutput, WorkMailClientResolvedConfig> {
|
|
99
|
+
readonly input: UpdateUserCommandInput;
|
|
100
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
101
|
+
/**
|
|
102
|
+
* @public
|
|
103
|
+
*/
|
|
104
|
+
constructor(input: UpdateUserCommandInput);
|
|
105
|
+
/**
|
|
106
|
+
* @internal
|
|
107
|
+
*/
|
|
108
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkMailClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateUserCommandInput, UpdateUserCommandOutput>;
|
|
109
|
+
/**
|
|
110
|
+
* @internal
|
|
111
|
+
*/
|
|
112
|
+
private serialize;
|
|
113
|
+
/**
|
|
114
|
+
* @internal
|
|
115
|
+
*/
|
|
116
|
+
private deserialize;
|
|
117
|
+
}
|