@aws-sdk/client-workmail 3.679.0 → 3.683.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 +65 -1
- package/dist-cjs/index.js +386 -4
- package/dist-es/WorkMail.js +16 -0
- package/dist-es/commands/CreateIdentityCenterApplicationCommand.js +22 -0
- package/dist-es/commands/CreateResourceCommand.js +2 -1
- package/dist-es/commands/DeleteIdentityCenterApplicationCommand.js +22 -0
- package/dist-es/commands/DeleteIdentityProviderConfigurationCommand.js +22 -0
- package/dist-es/commands/DeletePersonalAccessTokenCommand.js +22 -0
- package/dist-es/commands/DescribeIdentityProviderConfigurationCommand.js +22 -0
- package/dist-es/commands/DescribeResourceCommand.js +2 -1
- package/dist-es/commands/GetPersonalAccessTokenMetadataCommand.js +22 -0
- package/dist-es/commands/ListPersonalAccessTokensCommand.js +22 -0
- package/dist-es/commands/ListResourcesCommand.js +2 -1
- package/dist-es/commands/PutIdentityProviderConfigurationCommand.js +22 -0
- package/dist-es/commands/UpdateResourceCommand.js +2 -1
- package/dist-es/commands/index.js +8 -0
- package/dist-es/models/models_0.js +28 -0
- package/dist-es/pagination/ListPersonalAccessTokensPaginator.js +4 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/protocols/Aws_json1_1.js +200 -0
- package/dist-types/WorkMail.d.ts +56 -0
- package/dist-types/WorkMailClient.d.ts +10 -2
- package/dist-types/commands/CreateIdentityCenterApplicationCommand.d.ts +78 -0
- package/dist-types/commands/CreateUserCommand.d.ts +1 -0
- package/dist-types/commands/DeleteIdentityCenterApplicationCommand.d.ts +78 -0
- package/dist-types/commands/DeleteIdentityProviderConfigurationCommand.d.ts +82 -0
- package/dist-types/commands/DeleteOrganizationCommand.d.ts +1 -0
- package/dist-types/commands/DeletePersonalAccessTokenCommand.d.ts +83 -0
- package/dist-types/commands/DescribeIdentityProviderConfigurationCommand.d.ts +95 -0
- package/dist-types/commands/DescribeUserCommand.d.ts +8 -0
- package/dist-types/commands/GetPersonalAccessTokenMetadataCommand.d.ts +96 -0
- package/dist-types/commands/ListAvailabilityConfigurationsCommand.d.ts +3 -0
- package/dist-types/commands/ListPersonalAccessTokensCommand.d.ts +108 -0
- package/dist-types/commands/ListUsersCommand.d.ts +3 -0
- package/dist-types/commands/PutIdentityProviderConfigurationCommand.d.ts +96 -0
- package/dist-types/commands/UpdateGroupCommand.d.ts +1 -1
- package/dist-types/commands/UpdateUserCommand.d.ts +1 -0
- package/dist-types/commands/index.d.ts +8 -0
- package/dist-types/models/models_0.d.ts +485 -1
- package/dist-types/pagination/ListPersonalAccessTokensPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/protocols/Aws_json1_1.d.ts +72 -0
- package/dist-types/ts3.4/WorkMail.d.ts +148 -0
- package/dist-types/ts3.4/WorkMailClient.d.ts +48 -0
- package/dist-types/ts3.4/commands/CreateIdentityCenterApplicationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteIdentityCenterApplicationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteIdentityProviderConfigurationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeletePersonalAccessTokenCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DescribeIdentityProviderConfigurationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetPersonalAccessTokenMetadataCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListPersonalAccessTokensCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/PutIdentityProviderConfigurationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +8 -0
- package/dist-types/ts3.4/models/models_0.d.ts +111 -0
- package/dist-types/ts3.4/pagination/ListPersonalAccessTokensPaginator.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 +96 -0
- package/package.json +6 -6
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { CreateIdentityCenterApplicationRequest, CreateIdentityCenterApplicationResponse } from "../models/models_0";
|
|
4
|
+
import { ServiceInputTypes, ServiceOutputTypes, WorkMailClientResolvedConfig } from "../WorkMailClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link CreateIdentityCenterApplicationCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface CreateIdentityCenterApplicationCommandInput extends CreateIdentityCenterApplicationRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link CreateIdentityCenterApplicationCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface CreateIdentityCenterApplicationCommandOutput extends CreateIdentityCenterApplicationResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const CreateIdentityCenterApplicationCommand_base: {
|
|
25
|
+
new (input: CreateIdentityCenterApplicationCommandInput): import("@smithy/smithy-client").CommandImpl<CreateIdentityCenterApplicationCommandInput, CreateIdentityCenterApplicationCommandOutput, WorkMailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: CreateIdentityCenterApplicationCommandInput): import("@smithy/smithy-client").CommandImpl<CreateIdentityCenterApplicationCommandInput, CreateIdentityCenterApplicationCommandOutput, WorkMailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>
|
|
31
|
+
* Creates the WorkMail application in IAM Identity Center that can be used later in the WorkMail - IdC integration. For more information, see PutIdentityProviderConfiguration. This action does not affect the authentication settings for any WorkMail organizations.
|
|
32
|
+
* </p>
|
|
33
|
+
* @example
|
|
34
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
35
|
+
* ```javascript
|
|
36
|
+
* import { WorkMailClient, CreateIdentityCenterApplicationCommand } from "@aws-sdk/client-workmail"; // ES Modules import
|
|
37
|
+
* // const { WorkMailClient, CreateIdentityCenterApplicationCommand } = require("@aws-sdk/client-workmail"); // CommonJS import
|
|
38
|
+
* const client = new WorkMailClient(config);
|
|
39
|
+
* const input = { // CreateIdentityCenterApplicationRequest
|
|
40
|
+
* Name: "STRING_VALUE", // required
|
|
41
|
+
* InstanceArn: "STRING_VALUE", // required
|
|
42
|
+
* ClientToken: "STRING_VALUE",
|
|
43
|
+
* };
|
|
44
|
+
* const command = new CreateIdentityCenterApplicationCommand(input);
|
|
45
|
+
* const response = await client.send(command);
|
|
46
|
+
* // { // CreateIdentityCenterApplicationResponse
|
|
47
|
+
* // ApplicationArn: "STRING_VALUE",
|
|
48
|
+
* // };
|
|
49
|
+
*
|
|
50
|
+
* ```
|
|
51
|
+
*
|
|
52
|
+
* @param CreateIdentityCenterApplicationCommandInput - {@link CreateIdentityCenterApplicationCommandInput}
|
|
53
|
+
* @returns {@link CreateIdentityCenterApplicationCommandOutput}
|
|
54
|
+
* @see {@link CreateIdentityCenterApplicationCommandInput} for command's `input` shape.
|
|
55
|
+
* @see {@link CreateIdentityCenterApplicationCommandOutput} for command's `response` shape.
|
|
56
|
+
* @see {@link WorkMailClientResolvedConfig | config} for WorkMailClient's `config` shape.
|
|
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 WorkMailServiceException}
|
|
62
|
+
* <p>Base exception class for all service exceptions from WorkMail service.</p>
|
|
63
|
+
*
|
|
64
|
+
* @public
|
|
65
|
+
*/
|
|
66
|
+
export declare class CreateIdentityCenterApplicationCommand extends CreateIdentityCenterApplicationCommand_base {
|
|
67
|
+
/** @internal type navigation helper, not in runtime. */
|
|
68
|
+
protected static __types: {
|
|
69
|
+
api: {
|
|
70
|
+
input: CreateIdentityCenterApplicationRequest;
|
|
71
|
+
output: CreateIdentityCenterApplicationResponse;
|
|
72
|
+
};
|
|
73
|
+
sdk: {
|
|
74
|
+
input: CreateIdentityCenterApplicationCommandInput;
|
|
75
|
+
output: CreateIdentityCenterApplicationCommandOutput;
|
|
76
|
+
};
|
|
77
|
+
};
|
|
78
|
+
}
|
|
@@ -43,6 +43,7 @@ declare const CreateUserCommand_base: {
|
|
|
43
43
|
* FirstName: "STRING_VALUE",
|
|
44
44
|
* LastName: "STRING_VALUE",
|
|
45
45
|
* HiddenFromGlobalAddressList: true || false,
|
|
46
|
+
* IdentityProviderUserId: "STRING_VALUE",
|
|
46
47
|
* };
|
|
47
48
|
* const command = new CreateUserCommand(input);
|
|
48
49
|
* const response = await client.send(command);
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { DeleteIdentityCenterApplicationRequest, DeleteIdentityCenterApplicationResponse } from "../models/models_0";
|
|
4
|
+
import { ServiceInputTypes, ServiceOutputTypes, WorkMailClientResolvedConfig } from "../WorkMailClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link DeleteIdentityCenterApplicationCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DeleteIdentityCenterApplicationCommandInput extends DeleteIdentityCenterApplicationRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DeleteIdentityCenterApplicationCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DeleteIdentityCenterApplicationCommandOutput extends DeleteIdentityCenterApplicationResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const DeleteIdentityCenterApplicationCommand_base: {
|
|
25
|
+
new (input: DeleteIdentityCenterApplicationCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteIdentityCenterApplicationCommandInput, DeleteIdentityCenterApplicationCommandOutput, WorkMailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: DeleteIdentityCenterApplicationCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteIdentityCenterApplicationCommandInput, DeleteIdentityCenterApplicationCommandOutput, WorkMailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>
|
|
31
|
+
* Deletes the IAM Identity Center application from WorkMail. This action does not affect the authentication settings for any WorkMail organizations.
|
|
32
|
+
* </p>
|
|
33
|
+
* @example
|
|
34
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
35
|
+
* ```javascript
|
|
36
|
+
* import { WorkMailClient, DeleteIdentityCenterApplicationCommand } from "@aws-sdk/client-workmail"; // ES Modules import
|
|
37
|
+
* // const { WorkMailClient, DeleteIdentityCenterApplicationCommand } = require("@aws-sdk/client-workmail"); // CommonJS import
|
|
38
|
+
* const client = new WorkMailClient(config);
|
|
39
|
+
* const input = { // DeleteIdentityCenterApplicationRequest
|
|
40
|
+
* ApplicationArn: "STRING_VALUE", // required
|
|
41
|
+
* };
|
|
42
|
+
* const command = new DeleteIdentityCenterApplicationCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // {};
|
|
45
|
+
*
|
|
46
|
+
* ```
|
|
47
|
+
*
|
|
48
|
+
* @param DeleteIdentityCenterApplicationCommandInput - {@link DeleteIdentityCenterApplicationCommandInput}
|
|
49
|
+
* @returns {@link DeleteIdentityCenterApplicationCommandOutput}
|
|
50
|
+
* @see {@link DeleteIdentityCenterApplicationCommandInput} for command's `input` shape.
|
|
51
|
+
* @see {@link DeleteIdentityCenterApplicationCommandOutput} for command's `response` shape.
|
|
52
|
+
* @see {@link WorkMailClientResolvedConfig | config} for WorkMailClient's `config` shape.
|
|
53
|
+
*
|
|
54
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
55
|
+
* <p>One or more of the input parameters don't match the service's restrictions.</p>
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link OrganizationStateException} (client fault)
|
|
58
|
+
* <p>The organization must have a valid state to perform certain
|
|
59
|
+
* operations on the organization or its members.</p>
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link WorkMailServiceException}
|
|
62
|
+
* <p>Base exception class for all service exceptions from WorkMail service.</p>
|
|
63
|
+
*
|
|
64
|
+
* @public
|
|
65
|
+
*/
|
|
66
|
+
export declare class DeleteIdentityCenterApplicationCommand extends DeleteIdentityCenterApplicationCommand_base {
|
|
67
|
+
/** @internal type navigation helper, not in runtime. */
|
|
68
|
+
protected static __types: {
|
|
69
|
+
api: {
|
|
70
|
+
input: DeleteIdentityCenterApplicationRequest;
|
|
71
|
+
output: {};
|
|
72
|
+
};
|
|
73
|
+
sdk: {
|
|
74
|
+
input: DeleteIdentityCenterApplicationCommandInput;
|
|
75
|
+
output: DeleteIdentityCenterApplicationCommandOutput;
|
|
76
|
+
};
|
|
77
|
+
};
|
|
78
|
+
}
|
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { DeleteIdentityProviderConfigurationRequest, DeleteIdentityProviderConfigurationResponse } from "../models/models_0";
|
|
4
|
+
import { ServiceInputTypes, ServiceOutputTypes, WorkMailClientResolvedConfig } from "../WorkMailClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link DeleteIdentityProviderConfigurationCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DeleteIdentityProviderConfigurationCommandInput extends DeleteIdentityProviderConfigurationRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DeleteIdentityProviderConfigurationCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DeleteIdentityProviderConfigurationCommandOutput extends DeleteIdentityProviderConfigurationResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const DeleteIdentityProviderConfigurationCommand_base: {
|
|
25
|
+
new (input: DeleteIdentityProviderConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteIdentityProviderConfigurationCommandInput, DeleteIdentityProviderConfigurationCommandOutput, WorkMailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: DeleteIdentityProviderConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteIdentityProviderConfigurationCommandInput, DeleteIdentityProviderConfigurationCommandOutput, WorkMailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>
|
|
31
|
+
* Disables the integration between IdC and WorkMail. Authentication will continue with the directory as it was before the IdC integration. You might have to reset your directory passwords and reconfigure your desktop and mobile email clients.
|
|
32
|
+
* </p>
|
|
33
|
+
* @example
|
|
34
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
35
|
+
* ```javascript
|
|
36
|
+
* import { WorkMailClient, DeleteIdentityProviderConfigurationCommand } from "@aws-sdk/client-workmail"; // ES Modules import
|
|
37
|
+
* // const { WorkMailClient, DeleteIdentityProviderConfigurationCommand } = require("@aws-sdk/client-workmail"); // CommonJS import
|
|
38
|
+
* const client = new WorkMailClient(config);
|
|
39
|
+
* const input = { // DeleteIdentityProviderConfigurationRequest
|
|
40
|
+
* OrganizationId: "STRING_VALUE", // required
|
|
41
|
+
* };
|
|
42
|
+
* const command = new DeleteIdentityProviderConfigurationCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // {};
|
|
45
|
+
*
|
|
46
|
+
* ```
|
|
47
|
+
*
|
|
48
|
+
* @param DeleteIdentityProviderConfigurationCommandInput - {@link DeleteIdentityProviderConfigurationCommandInput}
|
|
49
|
+
* @returns {@link DeleteIdentityProviderConfigurationCommandOutput}
|
|
50
|
+
* @see {@link DeleteIdentityProviderConfigurationCommandInput} for command's `input` shape.
|
|
51
|
+
* @see {@link DeleteIdentityProviderConfigurationCommandOutput} for command's `response` shape.
|
|
52
|
+
* @see {@link WorkMailClientResolvedConfig | config} for WorkMailClient's `config` shape.
|
|
53
|
+
*
|
|
54
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
55
|
+
* <p>One or more of the input parameters don't match the service's restrictions.</p>
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link OrganizationNotFoundException} (client fault)
|
|
58
|
+
* <p>An operation received a valid organization identifier that either doesn't belong or
|
|
59
|
+
* exist in the system.</p>
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link OrganizationStateException} (client fault)
|
|
62
|
+
* <p>The organization must have a valid state to perform certain
|
|
63
|
+
* operations on the organization or its members.</p>
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link WorkMailServiceException}
|
|
66
|
+
* <p>Base exception class for all service exceptions from WorkMail service.</p>
|
|
67
|
+
*
|
|
68
|
+
* @public
|
|
69
|
+
*/
|
|
70
|
+
export declare class DeleteIdentityProviderConfigurationCommand extends DeleteIdentityProviderConfigurationCommand_base {
|
|
71
|
+
/** @internal type navigation helper, not in runtime. */
|
|
72
|
+
protected static __types: {
|
|
73
|
+
api: {
|
|
74
|
+
input: DeleteIdentityProviderConfigurationRequest;
|
|
75
|
+
output: {};
|
|
76
|
+
};
|
|
77
|
+
sdk: {
|
|
78
|
+
input: DeleteIdentityProviderConfigurationCommandInput;
|
|
79
|
+
output: DeleteIdentityProviderConfigurationCommandOutput;
|
|
80
|
+
};
|
|
81
|
+
};
|
|
82
|
+
}
|
|
@@ -39,6 +39,7 @@ declare const DeleteOrganizationCommand_base: {
|
|
|
39
39
|
* OrganizationId: "STRING_VALUE", // required
|
|
40
40
|
* DeleteDirectory: true || false, // required
|
|
41
41
|
* ForceDelete: true || false,
|
|
42
|
+
* DeleteIdentityCenterApplication: true || false,
|
|
42
43
|
* };
|
|
43
44
|
* const command = new DeleteOrganizationCommand(input);
|
|
44
45
|
* const response = await client.send(command);
|
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { DeletePersonalAccessTokenRequest, DeletePersonalAccessTokenResponse } from "../models/models_0";
|
|
4
|
+
import { ServiceInputTypes, ServiceOutputTypes, WorkMailClientResolvedConfig } from "../WorkMailClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link DeletePersonalAccessTokenCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DeletePersonalAccessTokenCommandInput extends DeletePersonalAccessTokenRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DeletePersonalAccessTokenCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DeletePersonalAccessTokenCommandOutput extends DeletePersonalAccessTokenResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const DeletePersonalAccessTokenCommand_base: {
|
|
25
|
+
new (input: DeletePersonalAccessTokenCommandInput): import("@smithy/smithy-client").CommandImpl<DeletePersonalAccessTokenCommandInput, DeletePersonalAccessTokenCommandOutput, WorkMailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: DeletePersonalAccessTokenCommandInput): import("@smithy/smithy-client").CommandImpl<DeletePersonalAccessTokenCommandInput, DeletePersonalAccessTokenCommandOutput, WorkMailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>
|
|
31
|
+
* Deletes the Personal Access Token from the provided WorkMail Organization.
|
|
32
|
+
* </p>
|
|
33
|
+
* @example
|
|
34
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
35
|
+
* ```javascript
|
|
36
|
+
* import { WorkMailClient, DeletePersonalAccessTokenCommand } from "@aws-sdk/client-workmail"; // ES Modules import
|
|
37
|
+
* // const { WorkMailClient, DeletePersonalAccessTokenCommand } = require("@aws-sdk/client-workmail"); // CommonJS import
|
|
38
|
+
* const client = new WorkMailClient(config);
|
|
39
|
+
* const input = { // DeletePersonalAccessTokenRequest
|
|
40
|
+
* OrganizationId: "STRING_VALUE", // required
|
|
41
|
+
* PersonalAccessTokenId: "STRING_VALUE", // required
|
|
42
|
+
* };
|
|
43
|
+
* const command = new DeletePersonalAccessTokenCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* // {};
|
|
46
|
+
*
|
|
47
|
+
* ```
|
|
48
|
+
*
|
|
49
|
+
* @param DeletePersonalAccessTokenCommandInput - {@link DeletePersonalAccessTokenCommandInput}
|
|
50
|
+
* @returns {@link DeletePersonalAccessTokenCommandOutput}
|
|
51
|
+
* @see {@link DeletePersonalAccessTokenCommandInput} for command's `input` shape.
|
|
52
|
+
* @see {@link DeletePersonalAccessTokenCommandOutput} for command's `response` shape.
|
|
53
|
+
* @see {@link WorkMailClientResolvedConfig | config} for WorkMailClient's `config` shape.
|
|
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
|
+
*
|
|
58
|
+
* @throws {@link OrganizationNotFoundException} (client fault)
|
|
59
|
+
* <p>An operation received a valid organization identifier that either doesn't belong or
|
|
60
|
+
* exist in the system.</p>
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link OrganizationStateException} (client fault)
|
|
63
|
+
* <p>The organization must have a valid state to perform certain
|
|
64
|
+
* operations on the organization or its members.</p>
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link WorkMailServiceException}
|
|
67
|
+
* <p>Base exception class for all service exceptions from WorkMail service.</p>
|
|
68
|
+
*
|
|
69
|
+
* @public
|
|
70
|
+
*/
|
|
71
|
+
export declare class DeletePersonalAccessTokenCommand extends DeletePersonalAccessTokenCommand_base {
|
|
72
|
+
/** @internal type navigation helper, not in runtime. */
|
|
73
|
+
protected static __types: {
|
|
74
|
+
api: {
|
|
75
|
+
input: DeletePersonalAccessTokenRequest;
|
|
76
|
+
output: {};
|
|
77
|
+
};
|
|
78
|
+
sdk: {
|
|
79
|
+
input: DeletePersonalAccessTokenCommandInput;
|
|
80
|
+
output: DeletePersonalAccessTokenCommandOutput;
|
|
81
|
+
};
|
|
82
|
+
};
|
|
83
|
+
}
|
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { DescribeIdentityProviderConfigurationRequest, DescribeIdentityProviderConfigurationResponse } from "../models/models_0";
|
|
4
|
+
import { ServiceInputTypes, ServiceOutputTypes, WorkMailClientResolvedConfig } from "../WorkMailClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link DescribeIdentityProviderConfigurationCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DescribeIdentityProviderConfigurationCommandInput extends DescribeIdentityProviderConfigurationRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DescribeIdentityProviderConfigurationCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DescribeIdentityProviderConfigurationCommandOutput extends DescribeIdentityProviderConfigurationResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const DescribeIdentityProviderConfigurationCommand_base: {
|
|
25
|
+
new (input: DescribeIdentityProviderConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeIdentityProviderConfigurationCommandInput, DescribeIdentityProviderConfigurationCommandOutput, WorkMailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: DescribeIdentityProviderConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeIdentityProviderConfigurationCommandInput, DescribeIdentityProviderConfigurationCommandOutput, WorkMailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>
|
|
31
|
+
* Returns detailed information on the current IdC setup for the WorkMail organization.
|
|
32
|
+
* </p>
|
|
33
|
+
* @example
|
|
34
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
35
|
+
* ```javascript
|
|
36
|
+
* import { WorkMailClient, DescribeIdentityProviderConfigurationCommand } from "@aws-sdk/client-workmail"; // ES Modules import
|
|
37
|
+
* // const { WorkMailClient, DescribeIdentityProviderConfigurationCommand } = require("@aws-sdk/client-workmail"); // CommonJS import
|
|
38
|
+
* const client = new WorkMailClient(config);
|
|
39
|
+
* const input = { // DescribeIdentityProviderConfigurationRequest
|
|
40
|
+
* OrganizationId: "STRING_VALUE", // required
|
|
41
|
+
* };
|
|
42
|
+
* const command = new DescribeIdentityProviderConfigurationCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // { // DescribeIdentityProviderConfigurationResponse
|
|
45
|
+
* // AuthenticationMode: "IDENTITY_PROVIDER_ONLY" || "IDENTITY_PROVIDER_AND_DIRECTORY",
|
|
46
|
+
* // IdentityCenterConfiguration: { // IdentityCenterConfiguration
|
|
47
|
+
* // InstanceArn: "STRING_VALUE", // required
|
|
48
|
+
* // ApplicationArn: "STRING_VALUE", // required
|
|
49
|
+
* // },
|
|
50
|
+
* // PersonalAccessTokenConfiguration: { // PersonalAccessTokenConfiguration
|
|
51
|
+
* // Status: "ACTIVE" || "INACTIVE", // required
|
|
52
|
+
* // LifetimeInDays: Number("int"),
|
|
53
|
+
* // },
|
|
54
|
+
* // };
|
|
55
|
+
*
|
|
56
|
+
* ```
|
|
57
|
+
*
|
|
58
|
+
* @param DescribeIdentityProviderConfigurationCommandInput - {@link DescribeIdentityProviderConfigurationCommandInput}
|
|
59
|
+
* @returns {@link DescribeIdentityProviderConfigurationCommandOutput}
|
|
60
|
+
* @see {@link DescribeIdentityProviderConfigurationCommandInput} for command's `input` shape.
|
|
61
|
+
* @see {@link DescribeIdentityProviderConfigurationCommandOutput} for command's `response` shape.
|
|
62
|
+
* @see {@link WorkMailClientResolvedConfig | config} for WorkMailClient's `config` shape.
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
65
|
+
* <p>One or more of the input parameters don't match the service's restrictions.</p>
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link OrganizationNotFoundException} (client fault)
|
|
68
|
+
* <p>An operation received a valid organization identifier that either doesn't belong or
|
|
69
|
+
* exist in the system.</p>
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link OrganizationStateException} (client fault)
|
|
72
|
+
* <p>The organization must have a valid state to perform certain
|
|
73
|
+
* operations on the organization or its members.</p>
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
76
|
+
* <p>The resource cannot be found.</p>
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link WorkMailServiceException}
|
|
79
|
+
* <p>Base exception class for all service exceptions from WorkMail service.</p>
|
|
80
|
+
*
|
|
81
|
+
* @public
|
|
82
|
+
*/
|
|
83
|
+
export declare class DescribeIdentityProviderConfigurationCommand extends DescribeIdentityProviderConfigurationCommand_base {
|
|
84
|
+
/** @internal type navigation helper, not in runtime. */
|
|
85
|
+
protected static __types: {
|
|
86
|
+
api: {
|
|
87
|
+
input: DescribeIdentityProviderConfigurationRequest;
|
|
88
|
+
output: DescribeIdentityProviderConfigurationResponse;
|
|
89
|
+
};
|
|
90
|
+
sdk: {
|
|
91
|
+
input: DescribeIdentityProviderConfigurationCommandInput;
|
|
92
|
+
output: DescribeIdentityProviderConfigurationCommandOutput;
|
|
93
|
+
};
|
|
94
|
+
};
|
|
95
|
+
}
|
|
@@ -64,6 +64,8 @@ declare const DescribeUserCommand_base: {
|
|
|
64
64
|
* // Department: "STRING_VALUE",
|
|
65
65
|
* // Country: "STRING_VALUE",
|
|
66
66
|
* // Office: "STRING_VALUE",
|
|
67
|
+
* // IdentityProviderUserId: "STRING_VALUE",
|
|
68
|
+
* // IdentityProviderIdentityStoreId: "STRING_VALUE",
|
|
67
69
|
* // };
|
|
68
70
|
*
|
|
69
71
|
* ```
|
|
@@ -74,6 +76,12 @@ declare const DescribeUserCommand_base: {
|
|
|
74
76
|
* @see {@link DescribeUserCommandOutput} for command's `response` shape.
|
|
75
77
|
* @see {@link WorkMailClientResolvedConfig | config} for WorkMailClient's `config` shape.
|
|
76
78
|
*
|
|
79
|
+
* @throws {@link DirectoryServiceAuthenticationFailedException} (client fault)
|
|
80
|
+
* <p>The directory service doesn't recognize the credentials supplied by WorkMail.</p>
|
|
81
|
+
*
|
|
82
|
+
* @throws {@link DirectoryUnavailableException} (client fault)
|
|
83
|
+
* <p>The directory is unavailable. It might be located in another Region or deleted.</p>
|
|
84
|
+
*
|
|
77
85
|
* @throws {@link EntityNotFoundException} (client fault)
|
|
78
86
|
* <p>The identifier supplied for the user, group, or resource does not exist in your
|
|
79
87
|
* organization.</p>
|
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { GetPersonalAccessTokenMetadataRequest, GetPersonalAccessTokenMetadataResponse } from "../models/models_0";
|
|
4
|
+
import { ServiceInputTypes, ServiceOutputTypes, WorkMailClientResolvedConfig } from "../WorkMailClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetPersonalAccessTokenMetadataCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetPersonalAccessTokenMetadataCommandInput extends GetPersonalAccessTokenMetadataRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetPersonalAccessTokenMetadataCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetPersonalAccessTokenMetadataCommandOutput extends GetPersonalAccessTokenMetadataResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetPersonalAccessTokenMetadataCommand_base: {
|
|
25
|
+
new (input: GetPersonalAccessTokenMetadataCommandInput): import("@smithy/smithy-client").CommandImpl<GetPersonalAccessTokenMetadataCommandInput, GetPersonalAccessTokenMetadataCommandOutput, WorkMailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: GetPersonalAccessTokenMetadataCommandInput): import("@smithy/smithy-client").CommandImpl<GetPersonalAccessTokenMetadataCommandInput, GetPersonalAccessTokenMetadataCommandOutput, WorkMailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>
|
|
31
|
+
* Requests details of a specific Personal Access Token within the WorkMail organization.
|
|
32
|
+
* </p>
|
|
33
|
+
* @example
|
|
34
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
35
|
+
* ```javascript
|
|
36
|
+
* import { WorkMailClient, GetPersonalAccessTokenMetadataCommand } from "@aws-sdk/client-workmail"; // ES Modules import
|
|
37
|
+
* // const { WorkMailClient, GetPersonalAccessTokenMetadataCommand } = require("@aws-sdk/client-workmail"); // CommonJS import
|
|
38
|
+
* const client = new WorkMailClient(config);
|
|
39
|
+
* const input = { // GetPersonalAccessTokenMetadataRequest
|
|
40
|
+
* OrganizationId: "STRING_VALUE", // required
|
|
41
|
+
* PersonalAccessTokenId: "STRING_VALUE", // required
|
|
42
|
+
* };
|
|
43
|
+
* const command = new GetPersonalAccessTokenMetadataCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* // { // GetPersonalAccessTokenMetadataResponse
|
|
46
|
+
* // PersonalAccessTokenId: "STRING_VALUE",
|
|
47
|
+
* // UserId: "STRING_VALUE",
|
|
48
|
+
* // Name: "STRING_VALUE",
|
|
49
|
+
* // DateCreated: new Date("TIMESTAMP"),
|
|
50
|
+
* // DateLastUsed: new Date("TIMESTAMP"),
|
|
51
|
+
* // ExpiresTime: new Date("TIMESTAMP"),
|
|
52
|
+
* // Scopes: [ // PersonalAccessTokenScopeList
|
|
53
|
+
* // "STRING_VALUE",
|
|
54
|
+
* // ],
|
|
55
|
+
* // };
|
|
56
|
+
*
|
|
57
|
+
* ```
|
|
58
|
+
*
|
|
59
|
+
* @param GetPersonalAccessTokenMetadataCommandInput - {@link GetPersonalAccessTokenMetadataCommandInput}
|
|
60
|
+
* @returns {@link GetPersonalAccessTokenMetadataCommandOutput}
|
|
61
|
+
* @see {@link GetPersonalAccessTokenMetadataCommandInput} for command's `input` shape.
|
|
62
|
+
* @see {@link GetPersonalAccessTokenMetadataCommandOutput} for command's `response` shape.
|
|
63
|
+
* @see {@link WorkMailClientResolvedConfig | config} for WorkMailClient's `config` shape.
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
66
|
+
* <p>One or more of the input parameters don't match the service's restrictions.</p>
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link OrganizationNotFoundException} (client fault)
|
|
69
|
+
* <p>An operation received a valid organization identifier that either doesn't belong or
|
|
70
|
+
* exist in the system.</p>
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link OrganizationStateException} (client fault)
|
|
73
|
+
* <p>The organization must have a valid state to perform certain
|
|
74
|
+
* operations on the organization or its members.</p>
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
77
|
+
* <p>The resource cannot be found.</p>
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link WorkMailServiceException}
|
|
80
|
+
* <p>Base exception class for all service exceptions from WorkMail service.</p>
|
|
81
|
+
*
|
|
82
|
+
* @public
|
|
83
|
+
*/
|
|
84
|
+
export declare class GetPersonalAccessTokenMetadataCommand extends GetPersonalAccessTokenMetadataCommand_base {
|
|
85
|
+
/** @internal type navigation helper, not in runtime. */
|
|
86
|
+
protected static __types: {
|
|
87
|
+
api: {
|
|
88
|
+
input: GetPersonalAccessTokenMetadataRequest;
|
|
89
|
+
output: GetPersonalAccessTokenMetadataResponse;
|
|
90
|
+
};
|
|
91
|
+
sdk: {
|
|
92
|
+
input: GetPersonalAccessTokenMetadataCommandInput;
|
|
93
|
+
output: GetPersonalAccessTokenMetadataCommandOutput;
|
|
94
|
+
};
|
|
95
|
+
};
|
|
96
|
+
}
|
|
@@ -68,6 +68,9 @@ declare const ListAvailabilityConfigurationsCommand_base: {
|
|
|
68
68
|
* @see {@link ListAvailabilityConfigurationsCommandOutput} for command's `response` shape.
|
|
69
69
|
* @see {@link WorkMailClientResolvedConfig | config} for WorkMailClient's `config` shape.
|
|
70
70
|
*
|
|
71
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
72
|
+
* <p>One or more of the input parameters don't match the service's restrictions.</p>
|
|
73
|
+
*
|
|
71
74
|
* @throws {@link OrganizationNotFoundException} (client fault)
|
|
72
75
|
* <p>An operation received a valid organization identifier that either doesn't belong or
|
|
73
76
|
* exist in the system.</p>
|