@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.
Files changed (58) hide show
  1. package/README.md +65 -1
  2. package/dist-cjs/index.js +386 -4
  3. package/dist-es/WorkMail.js +16 -0
  4. package/dist-es/commands/CreateIdentityCenterApplicationCommand.js +22 -0
  5. package/dist-es/commands/CreateResourceCommand.js +2 -1
  6. package/dist-es/commands/DeleteIdentityCenterApplicationCommand.js +22 -0
  7. package/dist-es/commands/DeleteIdentityProviderConfigurationCommand.js +22 -0
  8. package/dist-es/commands/DeletePersonalAccessTokenCommand.js +22 -0
  9. package/dist-es/commands/DescribeIdentityProviderConfigurationCommand.js +22 -0
  10. package/dist-es/commands/DescribeResourceCommand.js +2 -1
  11. package/dist-es/commands/GetPersonalAccessTokenMetadataCommand.js +22 -0
  12. package/dist-es/commands/ListPersonalAccessTokensCommand.js +22 -0
  13. package/dist-es/commands/ListResourcesCommand.js +2 -1
  14. package/dist-es/commands/PutIdentityProviderConfigurationCommand.js +22 -0
  15. package/dist-es/commands/UpdateResourceCommand.js +2 -1
  16. package/dist-es/commands/index.js +8 -0
  17. package/dist-es/models/models_0.js +28 -0
  18. package/dist-es/pagination/ListPersonalAccessTokensPaginator.js +4 -0
  19. package/dist-es/pagination/index.js +1 -0
  20. package/dist-es/protocols/Aws_json1_1.js +200 -0
  21. package/dist-types/WorkMail.d.ts +56 -0
  22. package/dist-types/WorkMailClient.d.ts +10 -2
  23. package/dist-types/commands/CreateIdentityCenterApplicationCommand.d.ts +78 -0
  24. package/dist-types/commands/CreateUserCommand.d.ts +1 -0
  25. package/dist-types/commands/DeleteIdentityCenterApplicationCommand.d.ts +78 -0
  26. package/dist-types/commands/DeleteIdentityProviderConfigurationCommand.d.ts +82 -0
  27. package/dist-types/commands/DeleteOrganizationCommand.d.ts +1 -0
  28. package/dist-types/commands/DeletePersonalAccessTokenCommand.d.ts +83 -0
  29. package/dist-types/commands/DescribeIdentityProviderConfigurationCommand.d.ts +95 -0
  30. package/dist-types/commands/DescribeUserCommand.d.ts +8 -0
  31. package/dist-types/commands/GetPersonalAccessTokenMetadataCommand.d.ts +96 -0
  32. package/dist-types/commands/ListAvailabilityConfigurationsCommand.d.ts +3 -0
  33. package/dist-types/commands/ListPersonalAccessTokensCommand.d.ts +108 -0
  34. package/dist-types/commands/ListUsersCommand.d.ts +3 -0
  35. package/dist-types/commands/PutIdentityProviderConfigurationCommand.d.ts +96 -0
  36. package/dist-types/commands/UpdateGroupCommand.d.ts +1 -1
  37. package/dist-types/commands/UpdateUserCommand.d.ts +1 -0
  38. package/dist-types/commands/index.d.ts +8 -0
  39. package/dist-types/models/models_0.d.ts +485 -1
  40. package/dist-types/pagination/ListPersonalAccessTokensPaginator.d.ts +7 -0
  41. package/dist-types/pagination/index.d.ts +1 -0
  42. package/dist-types/protocols/Aws_json1_1.d.ts +72 -0
  43. package/dist-types/ts3.4/WorkMail.d.ts +148 -0
  44. package/dist-types/ts3.4/WorkMailClient.d.ts +48 -0
  45. package/dist-types/ts3.4/commands/CreateIdentityCenterApplicationCommand.d.ts +51 -0
  46. package/dist-types/ts3.4/commands/DeleteIdentityCenterApplicationCommand.d.ts +51 -0
  47. package/dist-types/ts3.4/commands/DeleteIdentityProviderConfigurationCommand.d.ts +51 -0
  48. package/dist-types/ts3.4/commands/DeletePersonalAccessTokenCommand.d.ts +51 -0
  49. package/dist-types/ts3.4/commands/DescribeIdentityProviderConfigurationCommand.d.ts +51 -0
  50. package/dist-types/ts3.4/commands/GetPersonalAccessTokenMetadataCommand.d.ts +51 -0
  51. package/dist-types/ts3.4/commands/ListPersonalAccessTokensCommand.d.ts +51 -0
  52. package/dist-types/ts3.4/commands/PutIdentityProviderConfigurationCommand.d.ts +51 -0
  53. package/dist-types/ts3.4/commands/index.d.ts +8 -0
  54. package/dist-types/ts3.4/models/models_0.d.ts +111 -0
  55. package/dist-types/ts3.4/pagination/ListPersonalAccessTokensPaginator.d.ts +11 -0
  56. package/dist-types/ts3.4/pagination/index.d.ts +1 -0
  57. package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +96 -0
  58. package/package.json +6 -6
@@ -0,0 +1,108 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { ListPersonalAccessTokensRequest, ListPersonalAccessTokensResponse } 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 ListPersonalAccessTokensCommand}.
14
+ */
15
+ export interface ListPersonalAccessTokensCommandInput extends ListPersonalAccessTokensRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link ListPersonalAccessTokensCommand}.
21
+ */
22
+ export interface ListPersonalAccessTokensCommandOutput extends ListPersonalAccessTokensResponse, __MetadataBearer {
23
+ }
24
+ declare const ListPersonalAccessTokensCommand_base: {
25
+ new (input: ListPersonalAccessTokensCommandInput): import("@smithy/smithy-client").CommandImpl<ListPersonalAccessTokensCommandInput, ListPersonalAccessTokensCommandOutput, WorkMailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: ListPersonalAccessTokensCommandInput): import("@smithy/smithy-client").CommandImpl<ListPersonalAccessTokensCommandInput, ListPersonalAccessTokensCommandOutput, WorkMailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>
31
+ * Returns a summary of your Personal Access Tokens.
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, ListPersonalAccessTokensCommand } from "@aws-sdk/client-workmail"; // ES Modules import
37
+ * // const { WorkMailClient, ListPersonalAccessTokensCommand } = require("@aws-sdk/client-workmail"); // CommonJS import
38
+ * const client = new WorkMailClient(config);
39
+ * const input = { // ListPersonalAccessTokensRequest
40
+ * OrganizationId: "STRING_VALUE", // required
41
+ * UserId: "STRING_VALUE",
42
+ * NextToken: "STRING_VALUE",
43
+ * MaxResults: Number("int"),
44
+ * };
45
+ * const command = new ListPersonalAccessTokensCommand(input);
46
+ * const response = await client.send(command);
47
+ * // { // ListPersonalAccessTokensResponse
48
+ * // NextToken: "STRING_VALUE",
49
+ * // PersonalAccessTokenSummaries: [ // PersonalAccessTokenSummaryList
50
+ * // { // PersonalAccessTokenSummary
51
+ * // PersonalAccessTokenId: "STRING_VALUE",
52
+ * // UserId: "STRING_VALUE",
53
+ * // Name: "STRING_VALUE",
54
+ * // DateCreated: new Date("TIMESTAMP"),
55
+ * // DateLastUsed: new Date("TIMESTAMP"),
56
+ * // ExpiresTime: new Date("TIMESTAMP"),
57
+ * // Scopes: [ // PersonalAccessTokenScopeList
58
+ * // "STRING_VALUE",
59
+ * // ],
60
+ * // },
61
+ * // ],
62
+ * // };
63
+ *
64
+ * ```
65
+ *
66
+ * @param ListPersonalAccessTokensCommandInput - {@link ListPersonalAccessTokensCommandInput}
67
+ * @returns {@link ListPersonalAccessTokensCommandOutput}
68
+ * @see {@link ListPersonalAccessTokensCommandInput} for command's `input` shape.
69
+ * @see {@link ListPersonalAccessTokensCommandOutput} for command's `response` shape.
70
+ * @see {@link WorkMailClientResolvedConfig | config} for WorkMailClient's `config` shape.
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 WorkMailServiceException}
92
+ * <p>Base exception class for all service exceptions from WorkMail service.</p>
93
+ *
94
+ * @public
95
+ */
96
+ export declare class ListPersonalAccessTokensCommand extends ListPersonalAccessTokensCommand_base {
97
+ /** @internal type navigation helper, not in runtime. */
98
+ protected static __types: {
99
+ api: {
100
+ input: ListPersonalAccessTokensRequest;
101
+ output: ListPersonalAccessTokensResponse;
102
+ };
103
+ sdk: {
104
+ input: ListPersonalAccessTokensCommandInput;
105
+ output: ListPersonalAccessTokensCommandOutput;
106
+ };
107
+ };
108
+ }
@@ -43,6 +43,7 @@ declare const ListUsersCommand_base: {
43
43
  * DisplayNamePrefix: "STRING_VALUE",
44
44
  * PrimaryEmailPrefix: "STRING_VALUE",
45
45
  * State: "ENABLED" || "DISABLED" || "DELETED",
46
+ * IdentityProviderUserIdPrefix: "STRING_VALUE",
46
47
  * },
47
48
  * };
48
49
  * const command = new ListUsersCommand(input);
@@ -58,6 +59,8 @@ declare const ListUsersCommand_base: {
58
59
  * // UserRole: "USER" || "RESOURCE" || "SYSTEM_USER" || "REMOTE_USER",
59
60
  * // EnabledDate: new Date("TIMESTAMP"),
60
61
  * // DisabledDate: new Date("TIMESTAMP"),
62
+ * // IdentityProviderUserId: "STRING_VALUE",
63
+ * // IdentityProviderIdentityStoreId: "STRING_VALUE",
61
64
  * // },
62
65
  * // ],
63
66
  * // NextToken: "STRING_VALUE",
@@ -0,0 +1,96 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { PutIdentityProviderConfigurationRequest, PutIdentityProviderConfigurationResponse } 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 PutIdentityProviderConfigurationCommand}.
14
+ */
15
+ export interface PutIdentityProviderConfigurationCommandInput extends PutIdentityProviderConfigurationRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link PutIdentityProviderConfigurationCommand}.
21
+ */
22
+ export interface PutIdentityProviderConfigurationCommandOutput extends PutIdentityProviderConfigurationResponse, __MetadataBearer {
23
+ }
24
+ declare const PutIdentityProviderConfigurationCommand_base: {
25
+ new (input: PutIdentityProviderConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<PutIdentityProviderConfigurationCommandInput, PutIdentityProviderConfigurationCommandOutput, WorkMailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: PutIdentityProviderConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<PutIdentityProviderConfigurationCommandInput, PutIdentityProviderConfigurationCommandOutput, WorkMailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>
31
+ * Enables integration between IAM Identity Center (IdC) and WorkMail to proxy authentication requests for mailbox users. You can connect your IdC directory or your external directory to WorkMail through
32
+ * IdC and manage access to WorkMail mailboxes in a single place. For enhanced protection, you could enable Multifactor Authentication (MFA) and Personal Access Tokens.
33
+ *
34
+ * </p>
35
+ * @example
36
+ * Use a bare-bones client and the command you need to make an API call.
37
+ * ```javascript
38
+ * import { WorkMailClient, PutIdentityProviderConfigurationCommand } from "@aws-sdk/client-workmail"; // ES Modules import
39
+ * // const { WorkMailClient, PutIdentityProviderConfigurationCommand } = require("@aws-sdk/client-workmail"); // CommonJS import
40
+ * const client = new WorkMailClient(config);
41
+ * const input = { // PutIdentityProviderConfigurationRequest
42
+ * OrganizationId: "STRING_VALUE", // required
43
+ * AuthenticationMode: "IDENTITY_PROVIDER_ONLY" || "IDENTITY_PROVIDER_AND_DIRECTORY", // required
44
+ * IdentityCenterConfiguration: { // IdentityCenterConfiguration
45
+ * InstanceArn: "STRING_VALUE", // required
46
+ * ApplicationArn: "STRING_VALUE", // required
47
+ * },
48
+ * PersonalAccessTokenConfiguration: { // PersonalAccessTokenConfiguration
49
+ * Status: "ACTIVE" || "INACTIVE", // required
50
+ * LifetimeInDays: Number("int"),
51
+ * },
52
+ * };
53
+ * const command = new PutIdentityProviderConfigurationCommand(input);
54
+ * const response = await client.send(command);
55
+ * // {};
56
+ *
57
+ * ```
58
+ *
59
+ * @param PutIdentityProviderConfigurationCommandInput - {@link PutIdentityProviderConfigurationCommandInput}
60
+ * @returns {@link PutIdentityProviderConfigurationCommandOutput}
61
+ * @see {@link PutIdentityProviderConfigurationCommandInput} for command's `input` shape.
62
+ * @see {@link PutIdentityProviderConfigurationCommandOutput} 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 PutIdentityProviderConfigurationCommand extends PutIdentityProviderConfigurationCommand_base {
85
+ /** @internal type navigation helper, not in runtime. */
86
+ protected static __types: {
87
+ api: {
88
+ input: PutIdentityProviderConfigurationRequest;
89
+ output: {};
90
+ };
91
+ sdk: {
92
+ input: PutIdentityProviderConfigurationCommandInput;
93
+ output: PutIdentityProviderConfigurationCommandOutput;
94
+ };
95
+ };
96
+ }
@@ -27,7 +27,7 @@ declare const UpdateGroupCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Updates attibutes in a group.</p>
30
+ * <p>Updates attributes in a group.</p>
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -54,6 +54,7 @@ declare const UpdateUserCommand_base: {
54
54
  * Department: "STRING_VALUE",
55
55
  * Country: "STRING_VALUE",
56
56
  * Office: "STRING_VALUE",
57
+ * IdentityProviderUserId: "STRING_VALUE",
57
58
  * };
58
59
  * const command = new UpdateUserCommand(input);
59
60
  * const response = await client.send(command);
@@ -5,6 +5,7 @@ export * from "./CancelMailboxExportJobCommand";
5
5
  export * from "./CreateAliasCommand";
6
6
  export * from "./CreateAvailabilityConfigurationCommand";
7
7
  export * from "./CreateGroupCommand";
8
+ export * from "./CreateIdentityCenterApplicationCommand";
8
9
  export * from "./CreateImpersonationRoleCommand";
9
10
  export * from "./CreateMobileDeviceAccessRuleCommand";
10
11
  export * from "./CreateOrganizationCommand";
@@ -15,11 +16,14 @@ export * from "./DeleteAliasCommand";
15
16
  export * from "./DeleteAvailabilityConfigurationCommand";
16
17
  export * from "./DeleteEmailMonitoringConfigurationCommand";
17
18
  export * from "./DeleteGroupCommand";
19
+ export * from "./DeleteIdentityCenterApplicationCommand";
20
+ export * from "./DeleteIdentityProviderConfigurationCommand";
18
21
  export * from "./DeleteImpersonationRoleCommand";
19
22
  export * from "./DeleteMailboxPermissionsCommand";
20
23
  export * from "./DeleteMobileDeviceAccessOverrideCommand";
21
24
  export * from "./DeleteMobileDeviceAccessRuleCommand";
22
25
  export * from "./DeleteOrganizationCommand";
26
+ export * from "./DeletePersonalAccessTokenCommand";
23
27
  export * from "./DeleteResourceCommand";
24
28
  export * from "./DeleteRetentionPolicyCommand";
25
29
  export * from "./DeleteUserCommand";
@@ -28,6 +32,7 @@ export * from "./DeregisterMailDomainCommand";
28
32
  export * from "./DescribeEmailMonitoringConfigurationCommand";
29
33
  export * from "./DescribeEntityCommand";
30
34
  export * from "./DescribeGroupCommand";
35
+ export * from "./DescribeIdentityProviderConfigurationCommand";
31
36
  export * from "./DescribeInboundDmarcSettingsCommand";
32
37
  export * from "./DescribeMailboxExportJobCommand";
33
38
  export * from "./DescribeOrganizationCommand";
@@ -43,6 +48,7 @@ export * from "./GetMailDomainCommand";
43
48
  export * from "./GetMailboxDetailsCommand";
44
49
  export * from "./GetMobileDeviceAccessEffectCommand";
45
50
  export * from "./GetMobileDeviceAccessOverrideCommand";
51
+ export * from "./GetPersonalAccessTokenMetadataCommand";
46
52
  export * from "./ListAccessControlRulesCommand";
47
53
  export * from "./ListAliasesCommand";
48
54
  export * from "./ListAvailabilityConfigurationsCommand";
@@ -56,12 +62,14 @@ export * from "./ListMailboxPermissionsCommand";
56
62
  export * from "./ListMobileDeviceAccessOverridesCommand";
57
63
  export * from "./ListMobileDeviceAccessRulesCommand";
58
64
  export * from "./ListOrganizationsCommand";
65
+ export * from "./ListPersonalAccessTokensCommand";
59
66
  export * from "./ListResourceDelegatesCommand";
60
67
  export * from "./ListResourcesCommand";
61
68
  export * from "./ListTagsForResourceCommand";
62
69
  export * from "./ListUsersCommand";
63
70
  export * from "./PutAccessControlRuleCommand";
64
71
  export * from "./PutEmailMonitoringConfigurationCommand";
72
+ export * from "./PutIdentityProviderConfigurationCommand";
65
73
  export * from "./PutInboundDmarcSettingsCommand";
66
74
  export * from "./PutMailboxPermissionsCommand";
67
75
  export * from "./PutMobileDeviceAccessOverrideCommand";