@aws-sdk/client-workmail 3.183.0 → 3.184.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/CHANGELOG.md +11 -0
- package/README.md +1 -1
- package/dist-cjs/WorkMail.js +105 -0
- package/dist-cjs/commands/AssumeImpersonationRoleCommand.js +36 -0
- package/dist-cjs/commands/CreateImpersonationRoleCommand.js +36 -0
- package/dist-cjs/commands/DeleteImpersonationRoleCommand.js +36 -0
- package/dist-cjs/commands/GetImpersonationRoleCommand.js +36 -0
- package/dist-cjs/commands/GetImpersonationRoleEffectCommand.js +36 -0
- package/dist-cjs/commands/ListImpersonationRolesCommand.js +36 -0
- package/dist-cjs/commands/UpdateImpersonationRoleCommand.js +36 -0
- package/dist-cjs/commands/index.js +7 -0
- package/dist-cjs/models/models_0.js +97 -19
- package/dist-cjs/pagination/ListImpersonationRolesPaginator.js +36 -0
- package/dist-cjs/pagination/index.js +1 -0
- package/dist-cjs/protocols/Aws_json1_1.js +626 -3
- package/dist-es/WorkMail.js +105 -0
- package/dist-es/commands/AssumeImpersonationRoleCommand.js +32 -0
- package/dist-es/commands/CreateImpersonationRoleCommand.js +32 -0
- package/dist-es/commands/DeleteImpersonationRoleCommand.js +32 -0
- package/dist-es/commands/GetImpersonationRoleCommand.js +32 -0
- package/dist-es/commands/GetImpersonationRoleEffectCommand.js +32 -0
- package/dist-es/commands/ListImpersonationRolesCommand.js +32 -0
- package/dist-es/commands/UpdateImpersonationRoleCommand.js +32 -0
- package/dist-es/commands/index.js +7 -0
- package/dist-es/models/models_0.js +74 -13
- package/dist-es/pagination/ListImpersonationRolesPaginator.js +32 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/protocols/Aws_json1_1.js +608 -1
- package/dist-types/WorkMail.d.ts +91 -32
- package/dist-types/WorkMailClient.d.ts +10 -3
- package/dist-types/commands/AssumeImpersonationRoleCommand.d.ts +36 -0
- package/dist-types/commands/CreateAliasCommand.d.ts +1 -1
- package/dist-types/commands/CreateGroupCommand.d.ts +1 -1
- package/dist-types/commands/CreateImpersonationRoleCommand.d.ts +40 -0
- package/dist-types/commands/CreateMobileDeviceAccessRuleCommand.d.ts +1 -1
- package/dist-types/commands/CreateOrganizationCommand.d.ts +9 -5
- package/dist-types/commands/CreateResourceCommand.d.ts +1 -1
- package/dist-types/commands/CreateUserCommand.d.ts +1 -1
- package/dist-types/commands/DeleteGroupCommand.d.ts +1 -1
- package/dist-types/commands/DeleteImpersonationRoleCommand.d.ts +35 -0
- package/dist-types/commands/DeleteMobileDeviceAccessRuleCommand.d.ts +1 -1
- package/dist-types/commands/DeleteOrganizationCommand.d.ts +1 -1
- package/dist-types/commands/DeleteResourceCommand.d.ts +1 -1
- package/dist-types/commands/DeleteUserCommand.d.ts +1 -1
- package/dist-types/commands/DeregisterFromWorkMailCommand.d.ts +1 -1
- package/dist-types/commands/DeregisterMailDomainCommand.d.ts +1 -1
- package/dist-types/commands/GetAccessControlEffectCommand.d.ts +1 -1
- package/dist-types/commands/GetImpersonationRoleCommand.d.ts +35 -0
- package/dist-types/commands/GetImpersonationRoleEffectCommand.d.ts +35 -0
- package/dist-types/commands/GetMobileDeviceAccessEffectCommand.d.ts +1 -1
- package/dist-types/commands/ListImpersonationRolesCommand.d.ts +35 -0
- package/dist-types/commands/ListMailDomainsCommand.d.ts +1 -1
- package/dist-types/commands/ListMobileDeviceAccessRulesCommand.d.ts +1 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
- package/dist-types/commands/PutAccessControlRuleCommand.d.ts +1 -1
- package/dist-types/commands/RegisterMailDomainCommand.d.ts +1 -1
- package/dist-types/commands/RegisterToWorkMailCommand.d.ts +2 -2
- package/dist-types/commands/StartMailboxExportJobCommand.d.ts +1 -1
- package/dist-types/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/commands/TestAvailabilityConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateImpersonationRoleCommand.d.ts +35 -0
- package/dist-types/commands/UpdateMobileDeviceAccessRuleCommand.d.ts +1 -1
- package/dist-types/commands/index.d.ts +7 -0
- package/dist-types/models/models_0.d.ts +442 -73
- package/dist-types/pagination/ListImpersonationRolesPaginator.d.ts +4 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/protocols/Aws_json1_1.d.ts +21 -0
- package/dist-types/ts3.4/WorkMail.d.ts +119 -0
- package/dist-types/ts3.4/WorkMailClient.d.ts +42 -0
- package/dist-types/ts3.4/commands/AssumeImpersonationRoleCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/CreateImpersonationRoleCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/DeleteImpersonationRoleCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/GetImpersonationRoleCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/GetImpersonationRoleEffectCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/ListImpersonationRolesCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/UpdateImpersonationRoleCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/index.d.ts +7 -0
- package/dist-types/ts3.4/models/models_0.d.ts +157 -9
- package/dist-types/ts3.4/pagination/ListImpersonationRolesPaginator.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 +84 -0
- package/package.json +1 -1
|
@@ -7,11 +7,15 @@ export interface CreateOrganizationCommandInput extends CreateOrganizationReques
|
|
|
7
7
|
export interface CreateOrganizationCommandOutput extends CreateOrganizationResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Creates a new
|
|
11
|
-
* <p>You can associate multiple email domains with an organization, then
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
10
|
+
* <p>Creates a new WorkMail organization. Optionally, you can choose to associate an existing AWS Directory Service directory with your organization. If an AWS Directory Service directory ID is specified, the organization alias must match the directory alias. If you choose not to associate an existing directory with your organization, then we create a new WorkMail directory for you. For more information, see <a href="https://docs.aws.amazon.com/workmail/latest/adminguide/add_new_organization.html">Adding an organization</a> in the <i>WorkMail Administrator Guide</i>.</p>
|
|
11
|
+
* <p>You can associate multiple email domains with an organization, then choose your
|
|
12
|
+
* default email domain from the WorkMail console. You can also associate a domain that is managed
|
|
13
|
+
* in an Amazon Route 53 public hosted zone. For more information, see <a href="https://docs.aws.amazon.com/workmail/latest/adminguide/add_domain.html">Adding a
|
|
14
|
+
* domain</a> and <a href="https://docs.aws.amazon.com/workmail/latest/adminguide/default_domain.html">Choosing the default domain</a>
|
|
15
|
+
* in the <i>WorkMail Administrator Guide</i>.</p>
|
|
16
|
+
* <p>Optionally, you can use a customer managed key from AWS Key Management Service (AWS
|
|
17
|
+
* KMS) to encrypt email for your organization. If you don't associate an AWS KMS key, WorkMail
|
|
18
|
+
* creates a default, AWS managed key for you.</p>
|
|
15
19
|
* @example
|
|
16
20
|
* Use a bare-bones client and the command you need to make an API call.
|
|
17
21
|
* ```javascript
|
|
@@ -7,7 +7,7 @@ export interface CreateResourceCommandInput extends CreateResourceRequest {
|
|
|
7
7
|
export interface CreateResourceCommandOutput extends CreateResourceResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Creates a new
|
|
10
|
+
* <p>Creates a new WorkMail resource.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|
|
@@ -7,7 +7,7 @@ export interface CreateUserCommandInput extends CreateUserRequest {
|
|
|
7
7
|
export interface CreateUserCommandOutput extends CreateUserResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Creates a user who can be used in
|
|
10
|
+
* <p>Creates a user who can be used in WorkMail by calling the <a>RegisterToWorkMail</a> operation.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|
|
@@ -7,7 +7,7 @@ export interface DeleteGroupCommandInput extends DeleteGroupRequest {
|
|
|
7
7
|
export interface DeleteGroupCommandOutput extends DeleteGroupResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Deletes a group from
|
|
10
|
+
* <p>Deletes a group from WorkMail.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
2
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
3
|
+
import { DeleteImpersonationRoleRequest, DeleteImpersonationRoleResponse } from "../models/models_0";
|
|
4
|
+
import { ServiceInputTypes, ServiceOutputTypes, WorkMailClientResolvedConfig } from "../WorkMailClient";
|
|
5
|
+
export interface DeleteImpersonationRoleCommandInput extends DeleteImpersonationRoleRequest {
|
|
6
|
+
}
|
|
7
|
+
export interface DeleteImpersonationRoleCommandOutput extends DeleteImpersonationRoleResponse, __MetadataBearer {
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* <p>Deletes an impersonation role for the given WorkMail organization.</p>
|
|
11
|
+
* @example
|
|
12
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
13
|
+
* ```javascript
|
|
14
|
+
* import { WorkMailClient, DeleteImpersonationRoleCommand } from "@aws-sdk/client-workmail"; // ES Modules import
|
|
15
|
+
* // const { WorkMailClient, DeleteImpersonationRoleCommand } = require("@aws-sdk/client-workmail"); // CommonJS import
|
|
16
|
+
* const client = new WorkMailClient(config);
|
|
17
|
+
* const command = new DeleteImpersonationRoleCommand(input);
|
|
18
|
+
* const response = await client.send(command);
|
|
19
|
+
* ```
|
|
20
|
+
*
|
|
21
|
+
* @see {@link DeleteImpersonationRoleCommandInput} for command's `input` shape.
|
|
22
|
+
* @see {@link DeleteImpersonationRoleCommandOutput} for command's `response` shape.
|
|
23
|
+
* @see {@link WorkMailClientResolvedConfig | config} for WorkMailClient's `config` shape.
|
|
24
|
+
*
|
|
25
|
+
*/
|
|
26
|
+
export declare class DeleteImpersonationRoleCommand extends $Command<DeleteImpersonationRoleCommandInput, DeleteImpersonationRoleCommandOutput, WorkMailClientResolvedConfig> {
|
|
27
|
+
readonly input: DeleteImpersonationRoleCommandInput;
|
|
28
|
+
constructor(input: DeleteImpersonationRoleCommandInput);
|
|
29
|
+
/**
|
|
30
|
+
* @internal
|
|
31
|
+
*/
|
|
32
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkMailClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteImpersonationRoleCommandInput, DeleteImpersonationRoleCommandOutput>;
|
|
33
|
+
private serialize;
|
|
34
|
+
private deserialize;
|
|
35
|
+
}
|
|
@@ -7,7 +7,7 @@ export interface DeleteMobileDeviceAccessRuleCommandInput extends DeleteMobileDe
|
|
|
7
7
|
export interface DeleteMobileDeviceAccessRuleCommandOutput extends DeleteMobileDeviceAccessRuleResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Deletes a mobile device access rule for the specified
|
|
10
|
+
* <p>Deletes a mobile device access rule for the specified WorkMail organization.</p>
|
|
11
11
|
* <note>
|
|
12
12
|
* <p>Deleting already deleted and non-existing rules does not produce an error. In those cases, the service sends back an HTTP 200 response with an empty HTTP body.</p>
|
|
13
13
|
* </note>
|
|
@@ -7,7 +7,7 @@ export interface DeleteOrganizationCommandInput extends DeleteOrganizationReques
|
|
|
7
7
|
export interface DeleteOrganizationCommandOutput extends DeleteOrganizationResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Deletes an
|
|
10
|
+
* <p>Deletes an WorkMail organization and all underlying AWS resources managed by WorkMail as part of the organization. You can choose whether to delete the associated directory. For more information, see <a href="https://docs.aws.amazon.com/workmail/latest/adminguide/remove_organization.html">Removing an organization</a> in the <i>WorkMail Administrator Guide</i>.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|
|
@@ -7,7 +7,7 @@ export interface DeleteResourceCommandInput extends DeleteResourceRequest {
|
|
|
7
7
|
export interface DeleteResourceCommandOutput extends DeleteResourceResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Deletes the specified resource
|
|
10
|
+
* <p>Deletes the specified resource.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|
|
@@ -7,7 +7,7 @@ export interface DeleteUserCommandInput extends DeleteUserRequest {
|
|
|
7
7
|
export interface DeleteUserCommandOutput extends DeleteUserResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Deletes a user from
|
|
10
|
+
* <p>Deletes a user from WorkMail and all subsequent systems. Before you can delete a
|
|
11
11
|
* user, the user state must be <code>DISABLED</code>. Use the <a>DescribeUser</a>
|
|
12
12
|
* action to confirm the user state.</p>
|
|
13
13
|
* <p>Deleting a user is permanent and cannot be undone. WorkMail archives user mailboxes for
|
|
@@ -7,7 +7,7 @@ export interface DeregisterFromWorkMailCommandInput extends DeregisterFromWorkMa
|
|
|
7
7
|
export interface DeregisterFromWorkMailCommandOutput extends DeregisterFromWorkMailResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Mark a user, group, or resource as no longer used in
|
|
10
|
+
* <p>Mark a user, group, or resource as no longer used in WorkMail. This action
|
|
11
11
|
* disassociates the mailbox and schedules it for clean-up. WorkMail keeps mailboxes for 30 days
|
|
12
12
|
* before they are permanently removed. The functionality in the console is
|
|
13
13
|
* <i>Disable</i>.</p>
|
|
@@ -7,7 +7,7 @@ export interface DeregisterMailDomainCommandInput extends DeregisterMailDomainRe
|
|
|
7
7
|
export interface DeregisterMailDomainCommandOutput extends DeregisterMailDomainResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Removes a domain from
|
|
10
|
+
* <p>Removes a domain from WorkMail, stops email routing to WorkMail, and removes the authorization allowing WorkMail use. SES keeps the domain because other applications may use it. You must first
|
|
11
11
|
* remove any email address used by WorkMail entities before you remove the domain.</p>
|
|
12
12
|
* @example
|
|
13
13
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -8,7 +8,7 @@ export interface GetAccessControlEffectCommandOutput extends GetAccessControlEff
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Gets the effects of an organization's access control rules as they apply to a
|
|
11
|
-
* specified IPv4 address, access protocol action, or user ID.
|
|
11
|
+
* specified IPv4 address, access protocol action, and user ID or impersonation role ID. You must provide either the user ID or impersonation role ID. Impersonation role ID can only be used with Action EWS.</p>
|
|
12
12
|
* @example
|
|
13
13
|
* Use a bare-bones client and the command you need to make an API call.
|
|
14
14
|
* ```javascript
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
2
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
3
|
+
import { GetImpersonationRoleRequest, GetImpersonationRoleResponse } from "../models/models_0";
|
|
4
|
+
import { ServiceInputTypes, ServiceOutputTypes, WorkMailClientResolvedConfig } from "../WorkMailClient";
|
|
5
|
+
export interface GetImpersonationRoleCommandInput extends GetImpersonationRoleRequest {
|
|
6
|
+
}
|
|
7
|
+
export interface GetImpersonationRoleCommandOutput extends GetImpersonationRoleResponse, __MetadataBearer {
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* <p>Gets the impersonation role details for the given WorkMail organization.</p>
|
|
11
|
+
* @example
|
|
12
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
13
|
+
* ```javascript
|
|
14
|
+
* import { WorkMailClient, GetImpersonationRoleCommand } from "@aws-sdk/client-workmail"; // ES Modules import
|
|
15
|
+
* // const { WorkMailClient, GetImpersonationRoleCommand } = require("@aws-sdk/client-workmail"); // CommonJS import
|
|
16
|
+
* const client = new WorkMailClient(config);
|
|
17
|
+
* const command = new GetImpersonationRoleCommand(input);
|
|
18
|
+
* const response = await client.send(command);
|
|
19
|
+
* ```
|
|
20
|
+
*
|
|
21
|
+
* @see {@link GetImpersonationRoleCommandInput} for command's `input` shape.
|
|
22
|
+
* @see {@link GetImpersonationRoleCommandOutput} for command's `response` shape.
|
|
23
|
+
* @see {@link WorkMailClientResolvedConfig | config} for WorkMailClient's `config` shape.
|
|
24
|
+
*
|
|
25
|
+
*/
|
|
26
|
+
export declare class GetImpersonationRoleCommand extends $Command<GetImpersonationRoleCommandInput, GetImpersonationRoleCommandOutput, WorkMailClientResolvedConfig> {
|
|
27
|
+
readonly input: GetImpersonationRoleCommandInput;
|
|
28
|
+
constructor(input: GetImpersonationRoleCommandInput);
|
|
29
|
+
/**
|
|
30
|
+
* @internal
|
|
31
|
+
*/
|
|
32
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkMailClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetImpersonationRoleCommandInput, GetImpersonationRoleCommandOutput>;
|
|
33
|
+
private serialize;
|
|
34
|
+
private deserialize;
|
|
35
|
+
}
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
2
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
3
|
+
import { GetImpersonationRoleEffectRequest, GetImpersonationRoleEffectResponse } from "../models/models_0";
|
|
4
|
+
import { ServiceInputTypes, ServiceOutputTypes, WorkMailClientResolvedConfig } from "../WorkMailClient";
|
|
5
|
+
export interface GetImpersonationRoleEffectCommandInput extends GetImpersonationRoleEffectRequest {
|
|
6
|
+
}
|
|
7
|
+
export interface GetImpersonationRoleEffectCommandOutput extends GetImpersonationRoleEffectResponse, __MetadataBearer {
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* <p>Tests whether the given impersonation role can impersonate a target user.</p>
|
|
11
|
+
* @example
|
|
12
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
13
|
+
* ```javascript
|
|
14
|
+
* import { WorkMailClient, GetImpersonationRoleEffectCommand } from "@aws-sdk/client-workmail"; // ES Modules import
|
|
15
|
+
* // const { WorkMailClient, GetImpersonationRoleEffectCommand } = require("@aws-sdk/client-workmail"); // CommonJS import
|
|
16
|
+
* const client = new WorkMailClient(config);
|
|
17
|
+
* const command = new GetImpersonationRoleEffectCommand(input);
|
|
18
|
+
* const response = await client.send(command);
|
|
19
|
+
* ```
|
|
20
|
+
*
|
|
21
|
+
* @see {@link GetImpersonationRoleEffectCommandInput} for command's `input` shape.
|
|
22
|
+
* @see {@link GetImpersonationRoleEffectCommandOutput} for command's `response` shape.
|
|
23
|
+
* @see {@link WorkMailClientResolvedConfig | config} for WorkMailClient's `config` shape.
|
|
24
|
+
*
|
|
25
|
+
*/
|
|
26
|
+
export declare class GetImpersonationRoleEffectCommand extends $Command<GetImpersonationRoleEffectCommandInput, GetImpersonationRoleEffectCommandOutput, WorkMailClientResolvedConfig> {
|
|
27
|
+
readonly input: GetImpersonationRoleEffectCommandInput;
|
|
28
|
+
constructor(input: GetImpersonationRoleEffectCommandInput);
|
|
29
|
+
/**
|
|
30
|
+
* @internal
|
|
31
|
+
*/
|
|
32
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkMailClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetImpersonationRoleEffectCommandInput, GetImpersonationRoleEffectCommandOutput>;
|
|
33
|
+
private serialize;
|
|
34
|
+
private deserialize;
|
|
35
|
+
}
|
|
@@ -8,7 +8,7 @@ export interface GetMobileDeviceAccessEffectCommandOutput extends GetMobileDevic
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Simulates the effect of the mobile device access rules for the given attributes of a sample access event. Use this method to test the effects of the current set of mobile device access
|
|
11
|
-
* rules for the
|
|
11
|
+
* rules for the WorkMail organization for a particular user's attributes.</p>
|
|
12
12
|
* @example
|
|
13
13
|
* Use a bare-bones client and the command you need to make an API call.
|
|
14
14
|
* ```javascript
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
2
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
3
|
+
import { ListImpersonationRolesRequest, ListImpersonationRolesResponse } from "../models/models_0";
|
|
4
|
+
import { ServiceInputTypes, ServiceOutputTypes, WorkMailClientResolvedConfig } from "../WorkMailClient";
|
|
5
|
+
export interface ListImpersonationRolesCommandInput extends ListImpersonationRolesRequest {
|
|
6
|
+
}
|
|
7
|
+
export interface ListImpersonationRolesCommandOutput extends ListImpersonationRolesResponse, __MetadataBearer {
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* <p>Lists all the impersonation roles for the given WorkMail organization.</p>
|
|
11
|
+
* @example
|
|
12
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
13
|
+
* ```javascript
|
|
14
|
+
* import { WorkMailClient, ListImpersonationRolesCommand } from "@aws-sdk/client-workmail"; // ES Modules import
|
|
15
|
+
* // const { WorkMailClient, ListImpersonationRolesCommand } = require("@aws-sdk/client-workmail"); // CommonJS import
|
|
16
|
+
* const client = new WorkMailClient(config);
|
|
17
|
+
* const command = new ListImpersonationRolesCommand(input);
|
|
18
|
+
* const response = await client.send(command);
|
|
19
|
+
* ```
|
|
20
|
+
*
|
|
21
|
+
* @see {@link ListImpersonationRolesCommandInput} for command's `input` shape.
|
|
22
|
+
* @see {@link ListImpersonationRolesCommandOutput} for command's `response` shape.
|
|
23
|
+
* @see {@link WorkMailClientResolvedConfig | config} for WorkMailClient's `config` shape.
|
|
24
|
+
*
|
|
25
|
+
*/
|
|
26
|
+
export declare class ListImpersonationRolesCommand extends $Command<ListImpersonationRolesCommandInput, ListImpersonationRolesCommandOutput, WorkMailClientResolvedConfig> {
|
|
27
|
+
readonly input: ListImpersonationRolesCommandInput;
|
|
28
|
+
constructor(input: ListImpersonationRolesCommandInput);
|
|
29
|
+
/**
|
|
30
|
+
* @internal
|
|
31
|
+
*/
|
|
32
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkMailClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListImpersonationRolesCommandInput, ListImpersonationRolesCommandOutput>;
|
|
33
|
+
private serialize;
|
|
34
|
+
private deserialize;
|
|
35
|
+
}
|
|
@@ -7,7 +7,7 @@ export interface ListMailDomainsCommandInput extends ListMailDomainsRequest {
|
|
|
7
7
|
export interface ListMailDomainsCommandOutput extends ListMailDomainsResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Lists the mail domains in a given
|
|
10
|
+
* <p>Lists the mail domains in a given WorkMail organization.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|
|
@@ -7,7 +7,7 @@ export interface ListMobileDeviceAccessRulesCommandInput extends ListMobileDevic
|
|
|
7
7
|
export interface ListMobileDeviceAccessRulesCommandOutput extends ListMobileDeviceAccessRulesResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Lists the mobile device access rules for the specified
|
|
10
|
+
* <p>Lists the mobile device access rules for the specified WorkMail organization.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|
|
@@ -7,7 +7,7 @@ export interface ListTagsForResourceCommandInput extends ListTagsForResourceRequ
|
|
|
7
7
|
export interface ListTagsForResourceCommandOutput extends ListTagsForResourceResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Lists the tags applied to an
|
|
10
|
+
* <p>Lists the tags applied to an WorkMail organization resource.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|
|
@@ -9,7 +9,7 @@ export interface PutAccessControlRuleCommandOutput extends PutAccessControlRuleR
|
|
|
9
9
|
/**
|
|
10
10
|
* <p>Adds a new access control rule for the specified organization. The rule allows or
|
|
11
11
|
* denies access to the organization for the specified IPv4 addresses, access protocol
|
|
12
|
-
* actions, and
|
|
12
|
+
* actions, user IDs and impersonation IDs. Adding a new rule with the same name as an existing rule replaces
|
|
13
13
|
* the older rule.</p>
|
|
14
14
|
* @example
|
|
15
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -7,7 +7,7 @@ export interface RegisterMailDomainCommandInput extends RegisterMailDomainReques
|
|
|
7
7
|
export interface RegisterMailDomainCommandOutput extends RegisterMailDomainResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Registers a new domain in
|
|
10
|
+
* <p>Registers a new domain in WorkMail and SES, and configures it for use by WorkMail. Emails received by SES for this domain are routed to the specified WorkMail organization, and WorkMail has
|
|
11
11
|
* permanent permission to use the specified domain for sending your users' emails.</p>
|
|
12
12
|
* @example
|
|
13
13
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -7,11 +7,11 @@ export interface RegisterToWorkMailCommandInput extends RegisterToWorkMailReques
|
|
|
7
7
|
export interface RegisterToWorkMailCommandOutput extends RegisterToWorkMailResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Registers an existing and disabled user, group, or resource for
|
|
10
|
+
* <p>Registers an existing and disabled user, group, or resource for WorkMail use by
|
|
11
11
|
* associating a mailbox and calendaring capabilities. It performs no change if the user,
|
|
12
12
|
* group, or resource is enabled and fails if the user, group, or resource is deleted. This
|
|
13
13
|
* operation results in the accumulation of costs. For more information, see <a href="https://aws.amazon.com/workmail/pricing">Pricing</a>. The equivalent console
|
|
14
|
-
* functionality for this operation is <i>Enable</i
|
|
14
|
+
* functionality for this operation is <i>Enable</i>.</p>
|
|
15
15
|
* <p>Users can either be created by calling the <a>CreateUser</a> API operation
|
|
16
16
|
* or they can be synchronized from your directory. For more information, see <a>DeregisterFromWorkMail</a>.</p>
|
|
17
17
|
* @example
|
|
@@ -10,7 +10,7 @@ export interface StartMailboxExportJobCommandOutput extends StartMailboxExportJo
|
|
|
10
10
|
* <p>Starts a mailbox export job to export MIME-format email messages and calendar items
|
|
11
11
|
* from the specified mailbox to the specified Amazon Simple Storage Service (Amazon S3)
|
|
12
12
|
* bucket. For more information, see <a href="https://docs.aws.amazon.com/workmail/latest/adminguide/mail-export.html">Exporting mailbox content</a> in
|
|
13
|
-
* the <i>
|
|
13
|
+
* the <i>WorkMail Administrator Guide</i>.</p>
|
|
14
14
|
* @example
|
|
15
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
16
16
|
* ```javascript
|
|
@@ -7,7 +7,7 @@ export interface TagResourceCommandInput extends TagResourceRequest {
|
|
|
7
7
|
export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Applies the specified tags to the specified
|
|
10
|
+
* <p>Applies the specified tags to the specified WorkMailorganization
|
|
11
11
|
* resource.</p>
|
|
12
12
|
* @example
|
|
13
13
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -13,7 +13,7 @@ export interface TestAvailabilityConfigurationCommandOutput extends TestAvailabi
|
|
|
13
13
|
* <p>The request must contain either one provider definition (<code>EwsProvider</code> or
|
|
14
14
|
* <code>LambdaProvider</code>) or the <code>DomainName</code> parameter. If the
|
|
15
15
|
* <code>DomainName</code> parameter is provided, the configuration stored under the
|
|
16
|
-
* <code>DomainName</code> will be tested
|
|
16
|
+
* <code>DomainName</code> will be tested.</p>
|
|
17
17
|
* </note>
|
|
18
18
|
* @example
|
|
19
19
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -7,7 +7,7 @@ export interface UntagResourceCommandInput extends UntagResourceRequest {
|
|
|
7
7
|
export interface UntagResourceCommandOutput extends UntagResourceResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Untags the specified tags from the specified
|
|
10
|
+
* <p>Untags the specified tags from the specified WorkMail organization
|
|
11
11
|
* resource.</p>
|
|
12
12
|
* @example
|
|
13
13
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
2
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
3
|
+
import { UpdateImpersonationRoleRequest, UpdateImpersonationRoleResponse } from "../models/models_0";
|
|
4
|
+
import { ServiceInputTypes, ServiceOutputTypes, WorkMailClientResolvedConfig } from "../WorkMailClient";
|
|
5
|
+
export interface UpdateImpersonationRoleCommandInput extends UpdateImpersonationRoleRequest {
|
|
6
|
+
}
|
|
7
|
+
export interface UpdateImpersonationRoleCommandOutput extends UpdateImpersonationRoleResponse, __MetadataBearer {
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* <p>Updates an impersonation role for the given WorkMail organization.</p>
|
|
11
|
+
* @example
|
|
12
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
13
|
+
* ```javascript
|
|
14
|
+
* import { WorkMailClient, UpdateImpersonationRoleCommand } from "@aws-sdk/client-workmail"; // ES Modules import
|
|
15
|
+
* // const { WorkMailClient, UpdateImpersonationRoleCommand } = require("@aws-sdk/client-workmail"); // CommonJS import
|
|
16
|
+
* const client = new WorkMailClient(config);
|
|
17
|
+
* const command = new UpdateImpersonationRoleCommand(input);
|
|
18
|
+
* const response = await client.send(command);
|
|
19
|
+
* ```
|
|
20
|
+
*
|
|
21
|
+
* @see {@link UpdateImpersonationRoleCommandInput} for command's `input` shape.
|
|
22
|
+
* @see {@link UpdateImpersonationRoleCommandOutput} for command's `response` shape.
|
|
23
|
+
* @see {@link WorkMailClientResolvedConfig | config} for WorkMailClient's `config` shape.
|
|
24
|
+
*
|
|
25
|
+
*/
|
|
26
|
+
export declare class UpdateImpersonationRoleCommand extends $Command<UpdateImpersonationRoleCommandInput, UpdateImpersonationRoleCommandOutput, WorkMailClientResolvedConfig> {
|
|
27
|
+
readonly input: UpdateImpersonationRoleCommandInput;
|
|
28
|
+
constructor(input: UpdateImpersonationRoleCommandInput);
|
|
29
|
+
/**
|
|
30
|
+
* @internal
|
|
31
|
+
*/
|
|
32
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkMailClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateImpersonationRoleCommandInput, UpdateImpersonationRoleCommandOutput>;
|
|
33
|
+
private serialize;
|
|
34
|
+
private deserialize;
|
|
35
|
+
}
|
|
@@ -7,7 +7,7 @@ export interface UpdateMobileDeviceAccessRuleCommandInput extends UpdateMobileDe
|
|
|
7
7
|
export interface UpdateMobileDeviceAccessRuleCommandOutput extends UpdateMobileDeviceAccessRuleResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Updates a mobile device access rule for the specified
|
|
10
|
+
* <p>Updates a mobile device access rule for the specified WorkMail organization.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|
|
@@ -1,9 +1,11 @@
|
|
|
1
1
|
export * from "./AssociateDelegateToResourceCommand";
|
|
2
2
|
export * from "./AssociateMemberToGroupCommand";
|
|
3
|
+
export * from "./AssumeImpersonationRoleCommand";
|
|
3
4
|
export * from "./CancelMailboxExportJobCommand";
|
|
4
5
|
export * from "./CreateAliasCommand";
|
|
5
6
|
export * from "./CreateAvailabilityConfigurationCommand";
|
|
6
7
|
export * from "./CreateGroupCommand";
|
|
8
|
+
export * from "./CreateImpersonationRoleCommand";
|
|
7
9
|
export * from "./CreateMobileDeviceAccessRuleCommand";
|
|
8
10
|
export * from "./CreateOrganizationCommand";
|
|
9
11
|
export * from "./CreateResourceCommand";
|
|
@@ -13,6 +15,7 @@ export * from "./DeleteAliasCommand";
|
|
|
13
15
|
export * from "./DeleteAvailabilityConfigurationCommand";
|
|
14
16
|
export * from "./DeleteEmailMonitoringConfigurationCommand";
|
|
15
17
|
export * from "./DeleteGroupCommand";
|
|
18
|
+
export * from "./DeleteImpersonationRoleCommand";
|
|
16
19
|
export * from "./DeleteMailboxPermissionsCommand";
|
|
17
20
|
export * from "./DeleteMobileDeviceAccessOverrideCommand";
|
|
18
21
|
export * from "./DeleteMobileDeviceAccessRuleCommand";
|
|
@@ -33,6 +36,8 @@ export * from "./DisassociateDelegateFromResourceCommand";
|
|
|
33
36
|
export * from "./DisassociateMemberFromGroupCommand";
|
|
34
37
|
export * from "./GetAccessControlEffectCommand";
|
|
35
38
|
export * from "./GetDefaultRetentionPolicyCommand";
|
|
39
|
+
export * from "./GetImpersonationRoleCommand";
|
|
40
|
+
export * from "./GetImpersonationRoleEffectCommand";
|
|
36
41
|
export * from "./GetMailDomainCommand";
|
|
37
42
|
export * from "./GetMailboxDetailsCommand";
|
|
38
43
|
export * from "./GetMobileDeviceAccessEffectCommand";
|
|
@@ -42,6 +47,7 @@ export * from "./ListAliasesCommand";
|
|
|
42
47
|
export * from "./ListAvailabilityConfigurationsCommand";
|
|
43
48
|
export * from "./ListGroupMembersCommand";
|
|
44
49
|
export * from "./ListGroupsCommand";
|
|
50
|
+
export * from "./ListImpersonationRolesCommand";
|
|
45
51
|
export * from "./ListMailDomainsCommand";
|
|
46
52
|
export * from "./ListMailboxExportJobsCommand";
|
|
47
53
|
export * from "./ListMailboxPermissionsCommand";
|
|
@@ -67,6 +73,7 @@ export * from "./TestAvailabilityConfigurationCommand";
|
|
|
67
73
|
export * from "./UntagResourceCommand";
|
|
68
74
|
export * from "./UpdateAvailabilityConfigurationCommand";
|
|
69
75
|
export * from "./UpdateDefaultMailDomainCommand";
|
|
76
|
+
export * from "./UpdateImpersonationRoleCommand";
|
|
70
77
|
export * from "./UpdateMailboxQuotaCommand";
|
|
71
78
|
export * from "./UpdateMobileDeviceAccessRuleCommand";
|
|
72
79
|
export * from "./UpdatePrimaryEmailAddressCommand";
|