@aws-sdk/client-sesv2 3.1056.0 → 3.1057.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 (37) hide show
  1. package/README.md +7 -0
  2. package/dist-cjs/index.js +19 -0
  3. package/dist-cjs/schemas/schemas_0.js +50 -27
  4. package/dist-es/SESv2.js +2 -0
  5. package/dist-es/commands/PutTenantSuppressionAttributesCommand.js +16 -0
  6. package/dist-es/commands/index.js +1 -0
  7. package/dist-es/models/enums.js +4 -0
  8. package/dist-es/schemas/schemas_0.js +45 -22
  9. package/dist-types/SESv2.d.ts +7 -0
  10. package/dist-types/SESv2Client.d.ts +3 -2
  11. package/dist-types/commands/CreateConfigurationSetCommand.d.ts +1 -0
  12. package/dist-types/commands/CreateTenantCommand.d.ts +15 -0
  13. package/dist-types/commands/DeleteSuppressedDestinationCommand.d.ts +5 -1
  14. package/dist-types/commands/GetConfigurationSetCommand.d.ts +1 -0
  15. package/dist-types/commands/GetEmailTemplateCommand.d.ts +1 -1
  16. package/dist-types/commands/GetSuppressedDestinationCommand.d.ts +5 -1
  17. package/dist-types/commands/GetTenantCommand.d.ts +7 -1
  18. package/dist-types/commands/ListSuppressedDestinationsCommand.d.ts +7 -1
  19. package/dist-types/commands/PutConfigurationSetSuppressionOptionsCommand.d.ts +5 -1
  20. package/dist-types/commands/PutEmailIdentityFeedbackAttributesCommand.d.ts +2 -1
  21. package/dist-types/commands/PutSuppressedDestinationCommand.d.ts +8 -1
  22. package/dist-types/commands/PutTenantSuppressionAttributesCommand.d.ts +91 -0
  23. package/dist-types/commands/index.d.ts +1 -0
  24. package/dist-types/models/enums.d.ts +12 -0
  25. package/dist-types/models/models_0.d.ts +160 -40
  26. package/dist-types/models/models_1.d.ts +65 -5
  27. package/dist-types/schemas/schemas_0.d.ts +4 -0
  28. package/dist-types/ts3.4/SESv2.d.ts +17 -0
  29. package/dist-types/ts3.4/SESv2Client.d.ts +6 -0
  30. package/dist-types/ts3.4/commands/PutEmailIdentityFeedbackAttributesCommand.d.ts +2 -4
  31. package/dist-types/ts3.4/commands/PutTenantSuppressionAttributesCommand.d.ts +53 -0
  32. package/dist-types/ts3.4/commands/index.d.ts +1 -0
  33. package/dist-types/ts3.4/models/enums.d.ts +6 -0
  34. package/dist-types/ts3.4/models/models_0.d.ts +14 -1
  35. package/dist-types/ts3.4/models/models_1.d.ts +9 -0
  36. package/dist-types/ts3.4/schemas/schemas_0.d.ts +4 -0
  37. package/package.json +2 -2
@@ -35,6 +35,9 @@ declare const CreateTenantCommand_base: {
35
35
  * Each tenant can have its own set of resources like email identities, configuration sets,
36
36
  * and templates, along with reputation metrics and sending status. This helps isolate and manage
37
37
  * email sending for different customers or business units within your Amazon SES API v2 account.</p>
38
+ * <p>You can optionally specify <code>SuppressionAttributes</code> to configure tenant-level
39
+ * suppression at creation time. When tenant-level suppression is enabled, Amazon SES maintains a
40
+ * separate suppression list for the tenant instead of using the account-level suppression list.</p>
38
41
  * @example
39
42
  * Use a bare-bones client and the command you need to make an API call.
40
43
  * ```javascript
@@ -51,6 +54,12 @@ declare const CreateTenantCommand_base: {
51
54
  * Value: "STRING_VALUE", // required
52
55
  * },
53
56
  * ],
57
+ * SuppressionAttributes: { // TenantSuppressionAttributes
58
+ * SuppressedReasons: [ // SuppressionListReasons
59
+ * "BOUNCE" || "COMPLAINT",
60
+ * ],
61
+ * SuppressionScope: "ACCOUNT" || "TENANT",
62
+ * },
54
63
  * };
55
64
  * const command = new CreateTenantCommand(input);
56
65
  * const response = await client.send(command);
@@ -66,6 +75,12 @@ declare const CreateTenantCommand_base: {
66
75
  * // },
67
76
  * // ],
68
77
  * // SendingStatus: "ENABLED" || "REINSTATED" || "DISABLED",
78
+ * // SuppressionAttributes: { // TenantSuppressionAttributes
79
+ * // SuppressedReasons: [ // SuppressionListReasons
80
+ * // "BOUNCE" || "COMPLAINT",
81
+ * // ],
82
+ * // SuppressionScope: "ACCOUNT" || "TENANT",
83
+ * // },
69
84
  * // };
70
85
  *
71
86
  * ```
@@ -29,7 +29,10 @@ declare const DeleteSuppressedDestinationCommand_base: {
29
29
  };
30
30
  };
31
31
  /**
32
- * <p>Removes an email address from the suppression list for your account.</p>
32
+ * <p>Removes an email address from the suppression list for your account or for a specific
33
+ * tenant. To target a tenant's suppression list, specify the <code>TenantName</code>
34
+ * parameter. If you omit <code>TenantName</code>, the address is removed from the
35
+ * account-level suppression list.</p>
33
36
  * @example
34
37
  * Use a bare-bones client and the command you need to make an API call.
35
38
  * ```javascript
@@ -40,6 +43,7 @@ declare const DeleteSuppressedDestinationCommand_base: {
40
43
  * const client = new SESv2Client(config);
41
44
  * const input = { // DeleteSuppressedDestinationRequest
42
45
  * EmailAddress: "STRING_VALUE", // required
46
+ * TenantName: "STRING_VALUE",
43
47
  * };
44
48
  * const command = new DeleteSuppressedDestinationCommand(input);
45
49
  * const response = await client.send(command);
@@ -78,6 +78,7 @@ declare const GetConfigurationSetCommand_base: {
78
78
  * // SuppressedReasons: [ // SuppressionListReasons
79
79
  * // "BOUNCE" || "COMPLAINT",
80
80
  * // ],
81
+ * // SuppressionScope: "ACCOUNT" || "TENANT",
81
82
  * // ValidationOptions: { // SuppressionValidationOptions
82
83
  * // ConditionThreshold: { // SuppressionConditionThreshold
83
84
  * // ConditionThresholdEnabled: "ENABLED" || "DISABLED", // required
@@ -31,7 +31,7 @@ declare const GetEmailTemplateCommand_base: {
31
31
  /**
32
32
  * <p>Displays the template object (which includes the subject line, HTML part and text
33
33
  * part) for the template you specify.</p>
34
- * <p>You can execute this operation no more than once per second.</p>
34
+ * <p>You can execute this operation no more than 50 times per second.</p>
35
35
  * @example
36
36
  * Use a bare-bones client and the command you need to make an API call.
37
37
  * ```javascript
@@ -30,7 +30,9 @@ declare const GetSuppressedDestinationCommand_base: {
30
30
  };
31
31
  /**
32
32
  * <p>Retrieves information about a specific email address that's on the suppression list
33
- * for your account.</p>
33
+ * for your account or for a specific tenant. To target a tenant's suppression list,
34
+ * specify the <code>TenantName</code> parameter. If you omit <code>TenantName</code>,
35
+ * the operation targets the account-level suppression list.</p>
34
36
  * @example
35
37
  * Use a bare-bones client and the command you need to make an API call.
36
38
  * ```javascript
@@ -41,6 +43,7 @@ declare const GetSuppressedDestinationCommand_base: {
41
43
  * const client = new SESv2Client(config);
42
44
  * const input = { // GetSuppressedDestinationRequest
43
45
  * EmailAddress: "STRING_VALUE", // required
46
+ * TenantName: "STRING_VALUE",
44
47
  * };
45
48
  * const command = new GetSuppressedDestinationCommand(input);
46
49
  * const response = await client.send(command);
@@ -53,6 +56,7 @@ declare const GetSuppressedDestinationCommand_base: {
53
56
  * // MessageId: "STRING_VALUE",
54
57
  * // FeedbackId: "STRING_VALUE",
55
58
  * // },
59
+ * // TenantName: "STRING_VALUE",
56
60
  * // },
57
61
  * // };
58
62
  *
@@ -30,7 +30,7 @@ declare const GetTenantCommand_base: {
30
30
  };
31
31
  /**
32
32
  * <p>Get information about a specific tenant, including the tenant's name, ID, ARN,
33
- * creation timestamp, tags, and sending status.</p>
33
+ * creation timestamp, tags, sending status, and suppression attributes.</p>
34
34
  * @example
35
35
  * Use a bare-bones client and the command you need to make an API call.
36
36
  * ```javascript
@@ -57,6 +57,12 @@ declare const GetTenantCommand_base: {
57
57
  * // },
58
58
  * // ],
59
59
  * // SendingStatus: "ENABLED" || "REINSTATED" || "DISABLED",
60
+ * // SuppressionAttributes: { // TenantSuppressionAttributes
61
+ * // SuppressedReasons: [ // SuppressionListReasons
62
+ * // "BOUNCE" || "COMPLAINT",
63
+ * // ],
64
+ * // SuppressionScope: "ACCOUNT" || "TENANT",
65
+ * // },
60
66
  * // },
61
67
  * // };
62
68
  *
@@ -30,7 +30,9 @@ declare const ListSuppressedDestinationsCommand_base: {
30
30
  };
31
31
  /**
32
32
  * <p>Retrieves a list of email addresses that are on the suppression list for your
33
- * account.</p>
33
+ * account or for a specific tenant. To target a tenant's suppression list, specify the
34
+ * <code>TenantName</code> parameter. If you omit <code>TenantName</code>, the operation
35
+ * targets the account-level suppression list.</p>
34
36
  * @example
35
37
  * Use a bare-bones client and the command you need to make an API call.
36
38
  * ```javascript
@@ -40,6 +42,7 @@ declare const ListSuppressedDestinationsCommand_base: {
40
42
  * const config = {}; // type is SESv2ClientConfig
41
43
  * const client = new SESv2Client(config);
42
44
  * const input = { // ListSuppressedDestinationsRequest
45
+ * TenantName: "STRING_VALUE",
43
46
  * Reasons: [ // SuppressionListReasons
44
47
  * "BOUNCE" || "COMPLAINT",
45
48
  * ],
@@ -75,6 +78,9 @@ declare const ListSuppressedDestinationsCommand_base: {
75
78
  * @throws {@link InvalidNextTokenException} (client fault)
76
79
  * <p>The specified request includes an invalid or expired token.</p>
77
80
  *
81
+ * @throws {@link NotFoundException} (client fault)
82
+ * <p>The resource you attempted to access doesn't exist.</p>
83
+ *
78
84
  * @throws {@link TooManyRequestsException} (client fault)
79
85
  * <p>Too many requests have been made to the operation.</p>
80
86
  *
@@ -29,7 +29,10 @@ declare const PutConfigurationSetSuppressionOptionsCommand_base: {
29
29
  };
30
30
  };
31
31
  /**
32
- * <p>Specify the account suppression list preferences for a configuration set.</p>
32
+ * <p>Specify the suppression list preferences for a configuration set. You can
33
+ * also use this operation to specify a <code>SuppressionScope</code> to override the
34
+ * suppression scope of the tenant or account for emails sent using this configuration
35
+ * set.</p>
33
36
  * @example
34
37
  * Use a bare-bones client and the command you need to make an API call.
35
38
  * ```javascript
@@ -40,6 +43,7 @@ declare const PutConfigurationSetSuppressionOptionsCommand_base: {
40
43
  * const client = new SESv2Client(config);
41
44
  * const input = { // PutConfigurationSetSuppressionOptionsRequest
42
45
  * ConfigurationSetName: "STRING_VALUE", // required
46
+ * SuppressionScope: "ACCOUNT" || "TENANT",
43
47
  * SuppressedReasons: [ // SuppressionListReasons
44
48
  * "BOUNCE" || "COMPLAINT",
45
49
  * ],
@@ -1,6 +1,7 @@
1
1
  import { Command as $Command } from "@smithy/core/client";
2
2
  import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
- import type { PutEmailIdentityFeedbackAttributesRequest, PutEmailIdentityFeedbackAttributesResponse } from "../models/models_0";
3
+ import type { PutEmailIdentityFeedbackAttributesRequest } from "../models/models_0";
4
+ import type { PutEmailIdentityFeedbackAttributesResponse } from "../models/models_1";
4
5
  import type { ServiceInputTypes, ServiceOutputTypes, SESv2ClientResolvedConfig } from "../SESv2Client";
5
6
  /**
6
7
  * @public
@@ -29,7 +29,10 @@ declare const PutSuppressedDestinationCommand_base: {
29
29
  };
30
30
  };
31
31
  /**
32
- * <p>Adds an email address to the suppression list for your account.</p>
32
+ * <p>Adds an email address to the suppression list for your account or for a specific
33
+ * tenant. To target a tenant's suppression list, specify the <code>TenantName</code>
34
+ * parameter. If you omit <code>TenantName</code>, the address is added to the
35
+ * account-level suppression list.</p>
33
36
  * @example
34
37
  * Use a bare-bones client and the command you need to make an API call.
35
38
  * ```javascript
@@ -41,6 +44,7 @@ declare const PutSuppressedDestinationCommand_base: {
41
44
  * const input = { // PutSuppressedDestinationRequest
42
45
  * EmailAddress: "STRING_VALUE", // required
43
46
  * Reason: "BOUNCE" || "COMPLAINT", // required
47
+ * TenantName: "STRING_VALUE",
44
48
  * };
45
49
  * const command = new PutSuppressedDestinationCommand(input);
46
50
  * const response = await client.send(command);
@@ -57,6 +61,9 @@ declare const PutSuppressedDestinationCommand_base: {
57
61
  * @throws {@link BadRequestException} (client fault)
58
62
  * <p>The input you provided is invalid.</p>
59
63
  *
64
+ * @throws {@link NotFoundException} (client fault)
65
+ * <p>The resource you attempted to access doesn't exist.</p>
66
+ *
60
67
  * @throws {@link TooManyRequestsException} (client fault)
61
68
  * <p>Too many requests have been made to the operation.</p>
62
69
  *
@@ -0,0 +1,91 @@
1
+ import { Command as $Command } from "@smithy/core/client";
2
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import type { PutTenantSuppressionAttributesRequest, PutTenantSuppressionAttributesResponse } from "../models/models_1";
4
+ import type { ServiceInputTypes, ServiceOutputTypes, SESv2ClientResolvedConfig } from "../SESv2Client";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link PutTenantSuppressionAttributesCommand}.
14
+ */
15
+ export interface PutTenantSuppressionAttributesCommandInput extends PutTenantSuppressionAttributesRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link PutTenantSuppressionAttributesCommand}.
21
+ */
22
+ export interface PutTenantSuppressionAttributesCommandOutput extends PutTenantSuppressionAttributesResponse, __MetadataBearer {
23
+ }
24
+ declare const PutTenantSuppressionAttributesCommand_base: {
25
+ new (input: PutTenantSuppressionAttributesCommandInput): import("@smithy/core/client").CommandImpl<PutTenantSuppressionAttributesCommandInput, PutTenantSuppressionAttributesCommandOutput, SESv2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (input: PutTenantSuppressionAttributesCommandInput): import("@smithy/core/client").CommandImpl<PutTenantSuppressionAttributesCommandInput, PutTenantSuppressionAttributesCommandOutput, SESv2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): {
28
+ [x: string]: unknown;
29
+ };
30
+ };
31
+ /**
32
+ * <p>Configure the suppression list preferences for a tenant. Use this operation to enable
33
+ * or disable tenant-level suppression, or to change the suppressed reasons for a tenant.</p>
34
+ * <p>When you set the suppression scope to <code>TENANT</code>, Amazon SES maintains a separate
35
+ * suppression list for the tenant. When you set the scope to <code>ACCOUNT</code>, the tenant
36
+ * uses the account-level suppression list.</p>
37
+ * @example
38
+ * Use a bare-bones client and the command you need to make an API call.
39
+ * ```javascript
40
+ * import { SESv2Client, PutTenantSuppressionAttributesCommand } from "@aws-sdk/client-sesv2"; // ES Modules import
41
+ * // const { SESv2Client, PutTenantSuppressionAttributesCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import
42
+ * // import type { SESv2ClientConfig } from "@aws-sdk/client-sesv2";
43
+ * const config = {}; // type is SESv2ClientConfig
44
+ * const client = new SESv2Client(config);
45
+ * const input = { // PutTenantSuppressionAttributesRequest
46
+ * TenantName: "STRING_VALUE", // required
47
+ * SuppressedReasons: [ // SuppressionListReasons
48
+ * "BOUNCE" || "COMPLAINT",
49
+ * ],
50
+ * SuppressionScope: "ACCOUNT" || "TENANT",
51
+ * };
52
+ * const command = new PutTenantSuppressionAttributesCommand(input);
53
+ * const response = await client.send(command);
54
+ * // {};
55
+ *
56
+ * ```
57
+ *
58
+ * @param PutTenantSuppressionAttributesCommandInput - {@link PutTenantSuppressionAttributesCommandInput}
59
+ * @returns {@link PutTenantSuppressionAttributesCommandOutput}
60
+ * @see {@link PutTenantSuppressionAttributesCommandInput} for command's `input` shape.
61
+ * @see {@link PutTenantSuppressionAttributesCommandOutput} for command's `response` shape.
62
+ * @see {@link SESv2ClientResolvedConfig | config} for SESv2Client's `config` shape.
63
+ *
64
+ * @throws {@link BadRequestException} (client fault)
65
+ * <p>The input you provided is invalid.</p>
66
+ *
67
+ * @throws {@link NotFoundException} (client fault)
68
+ * <p>The resource you attempted to access doesn't exist.</p>
69
+ *
70
+ * @throws {@link TooManyRequestsException} (client fault)
71
+ * <p>Too many requests have been made to the operation.</p>
72
+ *
73
+ * @throws {@link SESv2ServiceException}
74
+ * <p>Base exception class for all service exceptions from SESv2 service.</p>
75
+ *
76
+ *
77
+ * @public
78
+ */
79
+ export declare class PutTenantSuppressionAttributesCommand extends PutTenantSuppressionAttributesCommand_base {
80
+ /** @internal type navigation helper, not in runtime. */
81
+ protected static __types: {
82
+ api: {
83
+ input: PutTenantSuppressionAttributesRequest;
84
+ output: {};
85
+ };
86
+ sdk: {
87
+ input: PutTenantSuppressionAttributesCommandInput;
88
+ output: PutTenantSuppressionAttributesCommandOutput;
89
+ };
90
+ };
91
+ }
@@ -94,6 +94,7 @@ export * from "./PutEmailIdentityDkimSigningAttributesCommand";
94
94
  export * from "./PutEmailIdentityFeedbackAttributesCommand";
95
95
  export * from "./PutEmailIdentityMailFromAttributesCommand";
96
96
  export * from "./PutSuppressedDestinationCommand";
97
+ export * from "./PutTenantSuppressionAttributesCommand";
97
98
  export * from "./SendBulkEmailCommand";
98
99
  export * from "./SendCustomVerificationEmailCommand";
99
100
  export * from "./SendEmailCommand";
@@ -227,6 +227,18 @@ export declare const SuppressionListReason: {
227
227
  * @public
228
228
  */
229
229
  export type SuppressionListReason = (typeof SuppressionListReason)[keyof typeof SuppressionListReason];
230
+ /**
231
+ * @public
232
+ * @enum
233
+ */
234
+ export declare const SuppressionListScope: {
235
+ readonly ACCOUNT: "ACCOUNT";
236
+ readonly TENANT: "TENANT";
237
+ };
238
+ /**
239
+ * @public
240
+ */
241
+ export type SuppressionListScope = (typeof SuppressionListScope)[keyof typeof SuppressionListScope];
230
242
  /**
231
243
  * @public
232
244
  * @enum