@aws-sdk/client-ses 3.388.0 → 3.390.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 +25 -0
- package/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-cjs/models/models_0.js +21 -1
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-es/models/models_0.js +20 -0
- package/dist-types/SES.d.ts +28 -3
- package/dist-types/SESClient.d.ts +28 -3
- package/dist-types/commands/CloneReceiptRuleSetCommand.d.ts +2 -3
- package/dist-types/commands/CreateConfigurationSetCommand.d.ts +4 -4
- package/dist-types/commands/CreateConfigurationSetEventDestinationCommand.d.ts +8 -8
- package/dist-types/commands/CreateConfigurationSetTrackingOptionsCommand.d.ts +5 -5
- package/dist-types/commands/CreateCustomVerificationEmailTemplateCommand.d.ts +3 -2
- package/dist-types/commands/CreateReceiptFilterCommand.d.ts +4 -3
- package/dist-types/commands/CreateReceiptRuleCommand.d.ts +11 -11
- package/dist-types/commands/CreateReceiptRuleSetCommand.d.ts +2 -3
- package/dist-types/commands/CreateTemplateCommand.d.ts +3 -3
- package/dist-types/commands/DeleteConfigurationSetCommand.d.ts +3 -2
- package/dist-types/commands/DeleteConfigurationSetEventDestinationCommand.d.ts +3 -2
- package/dist-types/commands/DeleteConfigurationSetTrackingOptionsCommand.d.ts +5 -5
- package/dist-types/commands/DeleteCustomVerificationEmailTemplateCommand.d.ts +3 -2
- package/dist-types/commands/DeleteIdentityCommand.d.ts +1 -1
- package/dist-types/commands/DeleteIdentityPolicyCommand.d.ts +10 -10
- package/dist-types/commands/DeleteReceiptFilterCommand.d.ts +2 -2
- package/dist-types/commands/DeleteReceiptRuleCommand.d.ts +2 -2
- package/dist-types/commands/DeleteReceiptRuleSetCommand.d.ts +5 -4
- package/dist-types/commands/DeleteTemplateCommand.d.ts +1 -1
- package/dist-types/commands/DescribeActiveReceiptRuleSetCommand.d.ts +6 -7
- package/dist-types/commands/DescribeConfigurationSetCommand.d.ts +7 -7
- package/dist-types/commands/DescribeReceiptRuleCommand.d.ts +7 -7
- package/dist-types/commands/DescribeReceiptRuleSetCommand.d.ts +7 -6
- package/dist-types/commands/GetAccountSendingEnabledCommand.d.ts +2 -2
- package/dist-types/commands/GetCustomVerificationEmailTemplateCommand.d.ts +3 -2
- package/dist-types/commands/GetIdentityDkimAttributesCommand.d.ts +9 -8
- package/dist-types/commands/GetIdentityMailFromDomainAttributesCommand.d.ts +3 -3
- package/dist-types/commands/GetIdentityNotificationAttributesCommand.d.ts +2 -2
- package/dist-types/commands/GetIdentityPoliciesCommand.d.ts +8 -8
- package/dist-types/commands/GetIdentityVerificationAttributesCommand.d.ts +8 -8
- package/dist-types/commands/GetSendQuotaCommand.d.ts +1 -1
- package/dist-types/commands/GetSendStatisticsCommand.d.ts +2 -2
- package/dist-types/commands/GetTemplateCommand.d.ts +1 -1
- package/dist-types/commands/ListConfigurationSetsCommand.d.ts +6 -5
- package/dist-types/commands/ListCustomVerificationEmailTemplatesCommand.d.ts +4 -3
- package/dist-types/commands/ListIdentitiesCommand.d.ts +13 -3
- package/dist-types/commands/ListIdentityPoliciesCommand.d.ts +10 -10
- package/dist-types/commands/ListReceiptFiltersCommand.d.ts +5 -5
- package/dist-types/commands/ListReceiptRuleSetsCommand.d.ts +5 -4
- package/dist-types/commands/ListTemplatesCommand.d.ts +3 -3
- package/dist-types/commands/PutConfigurationSetDeliveryOptionsCommand.d.ts +1 -1
- package/dist-types/commands/PutIdentityPolicyCommand.d.ts +8 -8
- package/dist-types/commands/ReorderReceiptRuleSetCommand.d.ts +7 -7
- package/dist-types/commands/SendBounceCommand.d.ts +11 -10
- package/dist-types/commands/SendBulkTemplatedEmailCommand.d.ts +19 -19
- package/dist-types/commands/SendCustomVerificationEmailCommand.d.ts +5 -5
- package/dist-types/commands/SendEmailCommand.d.ts +19 -21
- package/dist-types/commands/SendRawEmailCommand.d.ts +50 -58
- package/dist-types/commands/SendTemplatedEmailCommand.d.ts +21 -22
- package/dist-types/commands/SetActiveReceiptRuleSetCommand.d.ts +7 -6
- package/dist-types/commands/SetIdentityDkimEnabledCommand.d.ts +6 -5
- package/dist-types/commands/SetIdentityFeedbackForwardingEnabledCommand.d.ts +4 -4
- package/dist-types/commands/SetIdentityHeadersInNotificationsEnabledCommand.d.ts +3 -3
- package/dist-types/commands/SetIdentityMailFromDomainCommand.d.ts +6 -7
- package/dist-types/commands/SetIdentityNotificationTopicCommand.d.ts +4 -4
- package/dist-types/commands/SetReceiptRulePositionCommand.d.ts +2 -2
- package/dist-types/commands/TestRenderTemplateCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAccountSendingEnabledCommand.d.ts +3 -3
- package/dist-types/commands/UpdateConfigurationSetEventDestinationCommand.d.ts +7 -7
- package/dist-types/commands/UpdateConfigurationSetReputationMetricsEnabledCommand.d.ts +2 -2
- package/dist-types/commands/UpdateConfigurationSetSendingEnabledCommand.d.ts +2 -2
- package/dist-types/commands/UpdateConfigurationSetTrackingOptionsCommand.d.ts +5 -5
- package/dist-types/commands/UpdateCustomVerificationEmailTemplateCommand.d.ts +3 -2
- package/dist-types/commands/UpdateReceiptRuleCommand.d.ts +10 -10
- package/dist-types/commands/UpdateTemplateCommand.d.ts +3 -3
- package/dist-types/commands/VerifyDomainDkimCommand.d.ts +13 -13
- package/dist-types/commands/VerifyDomainIdentityCommand.d.ts +5 -6
- package/dist-types/commands/VerifyEmailIdentityCommand.d.ts +2 -2
- package/dist-types/index.d.ts +28 -3
- package/dist-types/models/models_0.d.ts +710 -639
- package/dist-types/ts3.4/models/models_0.d.ts +26 -8
- package/package.json +1 -1
|
@@ -24,9 +24,9 @@ export interface DeleteReceiptFilterCommandOutput extends DeleteReceiptFilterRes
|
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Deletes the specified IP address filter.</p>
|
|
27
|
-
*
|
|
27
|
+
* <p>For information about managing IP address filters, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-ip-filtering-console-walkthrough.html">Amazon SES
|
|
28
28
|
* Developer Guide</a>.</p>
|
|
29
|
-
*
|
|
29
|
+
* <p>You can execute this operation no more than once per second.</p>
|
|
30
30
|
* @example
|
|
31
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
32
|
* ```javascript
|
|
@@ -24,9 +24,9 @@ export interface DeleteReceiptRuleCommandOutput extends DeleteReceiptRuleRespons
|
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Deletes the specified receipt rule.</p>
|
|
27
|
-
*
|
|
27
|
+
* <p>For information about managing receipt rules, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-receipt-rules-console-walkthrough.html">Amazon SES
|
|
28
28
|
* Developer Guide</a>.</p>
|
|
29
|
-
*
|
|
29
|
+
* <p>You can execute this operation no more than once per second.</p>
|
|
30
30
|
* @example
|
|
31
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
32
|
* ```javascript
|
|
@@ -25,11 +25,12 @@ export interface DeleteReceiptRuleSetCommandOutput extends DeleteReceiptRuleSetR
|
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Deletes the specified receipt rule set and all of the receipt rules it
|
|
27
27
|
* contains.</p>
|
|
28
|
-
*
|
|
28
|
+
* <note>
|
|
29
29
|
* <p>The currently active rule set cannot be deleted.</p>
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
*
|
|
30
|
+
* </note>
|
|
31
|
+
* <p>For information about managing receipt rule sets, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-receipt-rules-console-walkthrough.html">Amazon SES
|
|
32
|
+
* Developer Guide</a>.</p>
|
|
33
|
+
* <p>You can execute this operation no more than once per second.</p>
|
|
33
34
|
* @example
|
|
34
35
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
36
|
* ```javascript
|
|
@@ -24,7 +24,7 @@ export interface DeleteTemplateCommandOutput extends DeleteTemplateResponse, __M
|
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Deletes an email template.</p>
|
|
27
|
-
*
|
|
27
|
+
* <p>You can execute this operation no more than once per second.</p>
|
|
28
28
|
* @example
|
|
29
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
30
30
|
* ```javascript
|
|
@@ -25,9 +25,8 @@ export interface DescribeActiveReceiptRuleSetCommandOutput extends DescribeActiv
|
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Returns the metadata and receipt rules for the receipt rule set that is currently
|
|
27
27
|
* active.</p>
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
* <p>You can execute this operation no more than once per second.</p>
|
|
28
|
+
* <p>For information about setting up receipt rule sets, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html#receiving-email-concepts-rules">Amazon SES Developer Guide</a>.</p>
|
|
29
|
+
* <p>You can execute this operation no more than once per second.</p>
|
|
31
30
|
* @example
|
|
32
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
32
|
* ```javascript
|
|
@@ -46,7 +45,7 @@ export interface DescribeActiveReceiptRuleSetCommandOutput extends DescribeActiv
|
|
|
46
45
|
* // { // ReceiptRule
|
|
47
46
|
* // Name: "STRING_VALUE", // required
|
|
48
47
|
* // Enabled: true || false,
|
|
49
|
-
* // TlsPolicy: "
|
|
48
|
+
* // TlsPolicy: "Require" || "Optional",
|
|
50
49
|
* // Recipients: [ // RecipientsList
|
|
51
50
|
* // "STRING_VALUE",
|
|
52
51
|
* // ],
|
|
@@ -72,10 +71,10 @@ export interface DescribeActiveReceiptRuleSetCommandOutput extends DescribeActiv
|
|
|
72
71
|
* // LambdaAction: { // LambdaAction
|
|
73
72
|
* // TopicArn: "STRING_VALUE",
|
|
74
73
|
* // FunctionArn: "STRING_VALUE", // required
|
|
75
|
-
* // InvocationType: "
|
|
74
|
+
* // InvocationType: "Event" || "RequestResponse",
|
|
76
75
|
* // },
|
|
77
76
|
* // StopAction: { // StopAction
|
|
78
|
-
* // Scope: "
|
|
77
|
+
* // Scope: "RuleSet", // required
|
|
79
78
|
* // TopicArn: "STRING_VALUE",
|
|
80
79
|
* // },
|
|
81
80
|
* // AddHeaderAction: { // AddHeaderAction
|
|
@@ -84,7 +83,7 @@ export interface DescribeActiveReceiptRuleSetCommandOutput extends DescribeActiv
|
|
|
84
83
|
* // },
|
|
85
84
|
* // SNSAction: { // SNSAction
|
|
86
85
|
* // TopicArn: "STRING_VALUE", // required
|
|
87
|
-
* // Encoding: "
|
|
86
|
+
* // Encoding: "UTF-8" || "Base64",
|
|
88
87
|
* // },
|
|
89
88
|
* // },
|
|
90
89
|
* // ],
|
|
@@ -24,9 +24,9 @@ export interface DescribeConfigurationSetCommandOutput extends DescribeConfigura
|
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Returns the details of the specified configuration set. For information about using
|
|
27
|
-
* configuration sets, see the <a href="https://docs.aws.amazon.com/ses/latest/
|
|
28
|
-
*
|
|
29
|
-
*
|
|
27
|
+
* configuration sets, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html">Amazon SES Developer
|
|
28
|
+
* Guide</a>.</p>
|
|
29
|
+
* <p>You can execute this operation no more than once per second.</p>
|
|
30
30
|
* @example
|
|
31
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
32
|
* ```javascript
|
|
@@ -36,7 +36,7 @@ export interface DescribeConfigurationSetCommandOutput extends DescribeConfigura
|
|
|
36
36
|
* const input = { // DescribeConfigurationSetRequest
|
|
37
37
|
* ConfigurationSetName: "STRING_VALUE", // required
|
|
38
38
|
* ConfigurationSetAttributeNames: [ // ConfigurationSetAttributeList
|
|
39
|
-
* "
|
|
39
|
+
* "eventDestinations" || "trackingOptions" || "deliveryOptions" || "reputationOptions",
|
|
40
40
|
* ],
|
|
41
41
|
* };
|
|
42
42
|
* const command = new DescribeConfigurationSetCommand(input);
|
|
@@ -50,7 +50,7 @@ export interface DescribeConfigurationSetCommandOutput extends DescribeConfigura
|
|
|
50
50
|
* // Name: "STRING_VALUE", // required
|
|
51
51
|
* // Enabled: true || false,
|
|
52
52
|
* // MatchingEventTypes: [ // EventTypes // required
|
|
53
|
-
* // "
|
|
53
|
+
* // "send" || "reject" || "bounce" || "complaint" || "delivery" || "open" || "click" || "renderingFailure",
|
|
54
54
|
* // ],
|
|
55
55
|
* // KinesisFirehoseDestination: { // KinesisFirehoseDestination
|
|
56
56
|
* // IAMRoleARN: "STRING_VALUE", // required
|
|
@@ -60,7 +60,7 @@ export interface DescribeConfigurationSetCommandOutput extends DescribeConfigura
|
|
|
60
60
|
* // DimensionConfigurations: [ // CloudWatchDimensionConfigurations // required
|
|
61
61
|
* // { // CloudWatchDimensionConfiguration
|
|
62
62
|
* // DimensionName: "STRING_VALUE", // required
|
|
63
|
-
* // DimensionValueSource: "
|
|
63
|
+
* // DimensionValueSource: "messageTag" || "emailHeader" || "linkTag", // required
|
|
64
64
|
* // DefaultDimensionValue: "STRING_VALUE", // required
|
|
65
65
|
* // },
|
|
66
66
|
* // ],
|
|
@@ -74,7 +74,7 @@ export interface DescribeConfigurationSetCommandOutput extends DescribeConfigura
|
|
|
74
74
|
* // CustomRedirectDomain: "STRING_VALUE",
|
|
75
75
|
* // },
|
|
76
76
|
* // DeliveryOptions: { // DeliveryOptions
|
|
77
|
-
* // TlsPolicy: "
|
|
77
|
+
* // TlsPolicy: "Require" || "Optional",
|
|
78
78
|
* // },
|
|
79
79
|
* // ReputationOptions: { // ReputationOptions
|
|
80
80
|
* // SendingEnabled: true || false,
|
|
@@ -24,9 +24,9 @@ export interface DescribeReceiptRuleCommandOutput extends DescribeReceiptRuleRes
|
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Returns the details of the specified receipt rule.</p>
|
|
27
|
-
*
|
|
28
|
-
* Guide</a>.</p>
|
|
29
|
-
*
|
|
27
|
+
* <p>For information about setting up receipt rules, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-receipt-rules-console-walkthrough.html">Amazon SES
|
|
28
|
+
* Developer Guide</a>.</p>
|
|
29
|
+
* <p>You can execute this operation no more than once per second.</p>
|
|
30
30
|
* @example
|
|
31
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
32
|
* ```javascript
|
|
@@ -43,7 +43,7 @@ export interface DescribeReceiptRuleCommandOutput extends DescribeReceiptRuleRes
|
|
|
43
43
|
* // Rule: { // ReceiptRule
|
|
44
44
|
* // Name: "STRING_VALUE", // required
|
|
45
45
|
* // Enabled: true || false,
|
|
46
|
-
* // TlsPolicy: "
|
|
46
|
+
* // TlsPolicy: "Require" || "Optional",
|
|
47
47
|
* // Recipients: [ // RecipientsList
|
|
48
48
|
* // "STRING_VALUE",
|
|
49
49
|
* // ],
|
|
@@ -69,10 +69,10 @@ export interface DescribeReceiptRuleCommandOutput extends DescribeReceiptRuleRes
|
|
|
69
69
|
* // LambdaAction: { // LambdaAction
|
|
70
70
|
* // TopicArn: "STRING_VALUE",
|
|
71
71
|
* // FunctionArn: "STRING_VALUE", // required
|
|
72
|
-
* // InvocationType: "
|
|
72
|
+
* // InvocationType: "Event" || "RequestResponse",
|
|
73
73
|
* // },
|
|
74
74
|
* // StopAction: { // StopAction
|
|
75
|
-
* // Scope: "
|
|
75
|
+
* // Scope: "RuleSet", // required
|
|
76
76
|
* // TopicArn: "STRING_VALUE",
|
|
77
77
|
* // },
|
|
78
78
|
* // AddHeaderAction: { // AddHeaderAction
|
|
@@ -81,7 +81,7 @@ export interface DescribeReceiptRuleCommandOutput extends DescribeReceiptRuleRes
|
|
|
81
81
|
* // },
|
|
82
82
|
* // SNSAction: { // SNSAction
|
|
83
83
|
* // TopicArn: "STRING_VALUE", // required
|
|
84
|
-
* // Encoding: "
|
|
84
|
+
* // Encoding: "UTF-8" || "Base64",
|
|
85
85
|
* // },
|
|
86
86
|
* // },
|
|
87
87
|
* // ],
|
|
@@ -24,8 +24,9 @@ export interface DescribeReceiptRuleSetCommandOutput extends DescribeReceiptRule
|
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Returns the details of the specified receipt rule set.</p>
|
|
27
|
-
*
|
|
28
|
-
*
|
|
27
|
+
* <p>For information about managing receipt rule sets, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-receipt-rules-console-walkthrough.html">Amazon SES
|
|
28
|
+
* Developer Guide</a>.</p>
|
|
29
|
+
* <p>You can execute this operation no more than once per second.</p>
|
|
29
30
|
* @example
|
|
30
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
31
32
|
* ```javascript
|
|
@@ -46,7 +47,7 @@ export interface DescribeReceiptRuleSetCommandOutput extends DescribeReceiptRule
|
|
|
46
47
|
* // { // ReceiptRule
|
|
47
48
|
* // Name: "STRING_VALUE", // required
|
|
48
49
|
* // Enabled: true || false,
|
|
49
|
-
* // TlsPolicy: "
|
|
50
|
+
* // TlsPolicy: "Require" || "Optional",
|
|
50
51
|
* // Recipients: [ // RecipientsList
|
|
51
52
|
* // "STRING_VALUE",
|
|
52
53
|
* // ],
|
|
@@ -72,10 +73,10 @@ export interface DescribeReceiptRuleSetCommandOutput extends DescribeReceiptRule
|
|
|
72
73
|
* // LambdaAction: { // LambdaAction
|
|
73
74
|
* // TopicArn: "STRING_VALUE",
|
|
74
75
|
* // FunctionArn: "STRING_VALUE", // required
|
|
75
|
-
* // InvocationType: "
|
|
76
|
+
* // InvocationType: "Event" || "RequestResponse",
|
|
76
77
|
* // },
|
|
77
78
|
* // StopAction: { // StopAction
|
|
78
|
-
* // Scope: "
|
|
79
|
+
* // Scope: "RuleSet", // required
|
|
79
80
|
* // TopicArn: "STRING_VALUE",
|
|
80
81
|
* // },
|
|
81
82
|
* // AddHeaderAction: { // AddHeaderAction
|
|
@@ -84,7 +85,7 @@ export interface DescribeReceiptRuleSetCommandOutput extends DescribeReceiptRule
|
|
|
84
85
|
* // },
|
|
85
86
|
* // SNSAction: { // SNSAction
|
|
86
87
|
* // TopicArn: "STRING_VALUE", // required
|
|
87
|
-
* // Encoding: "
|
|
88
|
+
* // Encoding: "UTF-8" || "Base64",
|
|
88
89
|
* // },
|
|
89
90
|
* // },
|
|
90
91
|
* // ],
|
|
@@ -23,8 +23,8 @@ export interface GetAccountSendingEnabledCommandOutput extends GetAccountSending
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Returns the email sending status of the Amazon SES account for the current
|
|
27
|
-
*
|
|
26
|
+
* <p>Returns the email sending status of the Amazon SES account for the current Region.</p>
|
|
27
|
+
* <p>You can execute this operation no more than once per second.</p>
|
|
28
28
|
* @example
|
|
29
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
30
30
|
* ```javascript
|
|
@@ -25,9 +25,10 @@ export interface GetCustomVerificationEmailTemplateCommandOutput extends GetCust
|
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Returns the custom email verification template for the template name you
|
|
27
27
|
* specify.</p>
|
|
28
|
-
*
|
|
28
|
+
* <p>For more information about custom verification email templates, see <a href="https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom">Using
|
|
29
|
+
* Custom Verification Email Templates</a> in the <i>Amazon SES Developer
|
|
29
30
|
* Guide</i>.</p>
|
|
30
|
-
*
|
|
31
|
+
* <p>You can execute this operation no more than once per second.</p>
|
|
31
32
|
* @example
|
|
32
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
34
|
* ```javascript
|
|
@@ -27,25 +27,26 @@ export interface GetIdentityDkimAttributesCommandOutput extends GetIdentityDkimA
|
|
|
27
27
|
* identities, this operation also returns the DKIM tokens that are required for Easy DKIM
|
|
28
28
|
* signing, and whether Amazon SES has successfully verified that these tokens have been
|
|
29
29
|
* published.</p>
|
|
30
|
-
*
|
|
30
|
+
* <p>This operation takes a list of identities as input and returns the following
|
|
31
31
|
* information for each:</p>
|
|
32
|
-
*
|
|
32
|
+
* <ul>
|
|
33
33
|
* <li>
|
|
34
|
-
*
|
|
34
|
+
* <p>Whether Easy DKIM signing is enabled or disabled.</p>
|
|
35
35
|
* </li>
|
|
36
36
|
* <li>
|
|
37
|
-
*
|
|
37
|
+
* <p>A set of DKIM tokens that represent the identity. If the identity is an email
|
|
38
38
|
* address, the tokens represent the domain of that address.</p>
|
|
39
39
|
* </li>
|
|
40
40
|
* <li>
|
|
41
|
-
*
|
|
41
|
+
* <p>Whether Amazon SES has successfully verified the DKIM tokens published in the
|
|
42
42
|
* domain's DNS. This information is only returned for domain name identities, not
|
|
43
43
|
* for email addresses.</p>
|
|
44
44
|
* </li>
|
|
45
45
|
* </ul>
|
|
46
|
-
*
|
|
46
|
+
* <p>This operation is throttled at one request per second and can only get DKIM attributes
|
|
47
47
|
* for up to 100 identities at a time.</p>
|
|
48
|
-
*
|
|
48
|
+
* <p>For more information about creating DNS records using DKIM tokens, go to the <a href="https://docs.aws.amazon.com/ses/latest/dg/send-email-authentication-dkim-easy-managing.html">Amazon SES
|
|
49
|
+
* Developer Guide</a>.</p>
|
|
49
50
|
* @example
|
|
50
51
|
* Use a bare-bones client and the command you need to make an API call.
|
|
51
52
|
* ```javascript
|
|
@@ -63,7 +64,7 @@ export interface GetIdentityDkimAttributesCommandOutput extends GetIdentityDkimA
|
|
|
63
64
|
* // DkimAttributes: { // DkimAttributes // required
|
|
64
65
|
* // "<keys>": { // IdentityDkimAttributes
|
|
65
66
|
* // DkimEnabled: true || false, // required
|
|
66
|
-
* // DkimVerificationStatus: "
|
|
67
|
+
* // DkimVerificationStatus: "Pending" || "Success" || "Failed" || "TemporaryFailure" || "NotStarted", // required
|
|
67
68
|
* // DkimTokens: [ // VerificationTokenList
|
|
68
69
|
* // "STRING_VALUE",
|
|
69
70
|
* // ],
|
|
@@ -25,7 +25,7 @@ export interface GetIdentityMailFromDomainAttributesCommandOutput extends GetIde
|
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Returns the custom MAIL FROM attributes for a list of identities (email addresses :
|
|
27
27
|
* domains).</p>
|
|
28
|
-
*
|
|
28
|
+
* <p>This operation is throttled at one request per second and can only get custom MAIL
|
|
29
29
|
* FROM attributes for up to 100 identities at a time.</p>
|
|
30
30
|
* @example
|
|
31
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -44,8 +44,8 @@ export interface GetIdentityMailFromDomainAttributesCommandOutput extends GetIde
|
|
|
44
44
|
* // MailFromDomainAttributes: { // MailFromDomainAttributes // required
|
|
45
45
|
* // "<keys>": { // IdentityMailFromDomainAttributes
|
|
46
46
|
* // MailFromDomain: "STRING_VALUE", // required
|
|
47
|
-
* // MailFromDomainStatus: "
|
|
48
|
-
* // BehaviorOnMXFailure: "
|
|
47
|
+
* // MailFromDomainStatus: "Pending" || "Success" || "Failed" || "TemporaryFailure", // required
|
|
48
|
+
* // BehaviorOnMXFailure: "UseDefaultValue" || "RejectMessage", // required
|
|
49
49
|
* // },
|
|
50
50
|
* // },
|
|
51
51
|
* // };
|
|
@@ -25,9 +25,9 @@ export interface GetIdentityNotificationAttributesCommandOutput extends GetIdent
|
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Given a list of verified identities (email addresses and/or domains), returns a
|
|
27
27
|
* structure describing identity notification attributes.</p>
|
|
28
|
-
*
|
|
28
|
+
* <p>This operation is throttled at one request per second and can only get notification
|
|
29
29
|
* attributes for up to 100 identities at a time.</p>
|
|
30
|
-
*
|
|
30
|
+
* <p>For more information about using notifications with Amazon SES, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity-using-notifications.html">Amazon SES
|
|
31
31
|
* Developer Guide</a>.</p>
|
|
32
32
|
* @example
|
|
33
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -26,15 +26,15 @@ export interface GetIdentityPoliciesCommandOutput extends GetIdentityPoliciesRes
|
|
|
26
26
|
* <p>Returns the requested sending authorization policies for the given identity (an email
|
|
27
27
|
* address or a domain). The policies are returned as a map of policy names to policy
|
|
28
28
|
* contents. You can retrieve a maximum of 20 policies at a time.</p>
|
|
29
|
-
*
|
|
30
|
-
* <p>This
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
*
|
|
29
|
+
* <note>
|
|
30
|
+
* <p>This operation is for the identity owner only. If you have not verified the
|
|
31
|
+
* identity, it returns an error.</p>
|
|
32
|
+
* </note>
|
|
33
|
+
* <p>Sending authorization is a feature that enables an identity owner to authorize other
|
|
34
34
|
* senders to use its identities. For information about using sending authorization, see
|
|
35
|
-
* the <a href="https://docs.aws.amazon.com/ses/latest/
|
|
36
|
-
* Guide</a>.</p>
|
|
37
|
-
*
|
|
35
|
+
* the <a href="https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html">Amazon SES
|
|
36
|
+
* Developer Guide</a>.</p>
|
|
37
|
+
* <p>You can execute this operation no more than once per second.</p>
|
|
38
38
|
* @example
|
|
39
39
|
* Use a bare-bones client and the command you need to make an API call.
|
|
40
40
|
* ```javascript
|
|
@@ -25,19 +25,19 @@ export interface GetIdentityVerificationAttributesCommandOutput extends GetIdent
|
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Given a list of identities (email addresses and/or domains), returns the verification
|
|
27
27
|
* status and (for domain identities) the verification token for each identity.</p>
|
|
28
|
-
*
|
|
28
|
+
* <p>The verification status of an email address is "Pending" until the email address owner
|
|
29
29
|
* clicks the link within the verification email that Amazon SES sent to that address. If the
|
|
30
30
|
* email address owner clicks the link within 24 hours, the verification status of the
|
|
31
31
|
* email address changes to "Success". If the link is not clicked within 24 hours, the
|
|
32
|
-
* verification status changes to "Failed." In that case,
|
|
33
|
-
*
|
|
34
|
-
*
|
|
32
|
+
* verification status changes to "Failed." In that case, to verify the email address, you
|
|
33
|
+
* must restart the verification process from the beginning.</p>
|
|
34
|
+
* <p>For domain identities, the domain's verification status is "Pending" as Amazon SES searches
|
|
35
35
|
* for the required TXT record in the DNS settings of the domain. When Amazon SES detects the
|
|
36
36
|
* record, the domain's verification status changes to "Success". If Amazon SES is unable to
|
|
37
37
|
* detect the record within 72 hours, the domain's verification status changes to "Failed."
|
|
38
|
-
* In that case,
|
|
39
|
-
*
|
|
40
|
-
*
|
|
38
|
+
* In that case, to verify the domain, you must restart the verification process from the
|
|
39
|
+
* beginning.</p>
|
|
40
|
+
* <p>This operation is throttled at one request per second and can only get verification
|
|
41
41
|
* attributes for up to 100 identities at a time.</p>
|
|
42
42
|
* @example
|
|
43
43
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -55,7 +55,7 @@ export interface GetIdentityVerificationAttributesCommandOutput extends GetIdent
|
|
|
55
55
|
* // { // GetIdentityVerificationAttributesResponse
|
|
56
56
|
* // VerificationAttributes: { // VerificationAttributes // required
|
|
57
57
|
* // "<keys>": { // IdentityVerificationAttributes
|
|
58
|
-
* // VerificationStatus: "
|
|
58
|
+
* // VerificationStatus: "Pending" || "Success" || "Failed" || "TemporaryFailure" || "NotStarted", // required
|
|
59
59
|
* // VerificationToken: "STRING_VALUE",
|
|
60
60
|
* // },
|
|
61
61
|
* // },
|
|
@@ -24,7 +24,7 @@ export interface GetSendQuotaCommandOutput extends GetSendQuotaResponse, __Metad
|
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Provides the sending limits for the Amazon SES account. </p>
|
|
27
|
-
*
|
|
27
|
+
* <p>You can execute this operation no more than once per second.</p>
|
|
28
28
|
* @example
|
|
29
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
30
30
|
* ```javascript
|
|
@@ -23,10 +23,10 @@ export interface GetSendStatisticsCommandOutput extends GetSendStatisticsRespons
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Provides sending statistics for the current
|
|
26
|
+
* <p>Provides sending statistics for the current Amazon Web Services Region. The result is a list of data
|
|
27
27
|
* points, representing the last two weeks of sending activity. Each data point in the list
|
|
28
28
|
* contains statistics for a 15-minute period of time.</p>
|
|
29
|
-
*
|
|
29
|
+
* <p>You can execute this operation no more than once per second.</p>
|
|
30
30
|
* @example
|
|
31
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
32
|
* ```javascript
|
|
@@ -25,7 +25,7 @@ export interface GetTemplateCommandOutput extends GetTemplateResponse, __Metadat
|
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Displays the template object (which includes the Subject line, HTML part and text
|
|
27
27
|
* part) for the template you specify.</p>
|
|
28
|
-
*
|
|
28
|
+
* <p>You can execute this operation no more than once per second.</p>
|
|
29
29
|
* @example
|
|
30
30
|
* Use a bare-bones client and the command you need to make an API call.
|
|
31
31
|
* ```javascript
|
|
@@ -24,13 +24,14 @@ export interface ListConfigurationSetsCommandOutput extends ListConfigurationSet
|
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Provides a list of the configuration sets associated with your Amazon SES account in the
|
|
27
|
-
* current
|
|
27
|
+
* current Amazon Web Services Region. For information about using configuration sets, see <a href="https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html">Monitoring
|
|
28
|
+
* Your Amazon SES Sending Activity</a> in the <i>Amazon SES Developer
|
|
28
29
|
* Guide.</i>
|
|
29
30
|
* </p>
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
*
|
|
31
|
+
* <p>You can execute this operation no more than once per second. This operation returns up
|
|
32
|
+
* to 1,000 configuration sets each time it is run. If your Amazon SES account has more than
|
|
33
|
+
* 1,000 configuration sets, this operation also returns <code>NextToken</code>. You can
|
|
34
|
+
* then execute the <code>ListConfigurationSets</code> operation again, passing the
|
|
34
35
|
* <code>NextToken</code> parameter and the value of the NextToken element to retrieve
|
|
35
36
|
* additional results.</p>
|
|
36
37
|
* @example
|
|
@@ -24,10 +24,11 @@ export interface ListCustomVerificationEmailTemplatesCommandOutput extends ListC
|
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Lists the existing custom verification email templates for your account in the current
|
|
27
|
-
*
|
|
28
|
-
*
|
|
27
|
+
* Amazon Web Services Region.</p>
|
|
28
|
+
* <p>For more information about custom verification email templates, see <a href="https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom">Using
|
|
29
|
+
* Custom Verification Email Templates</a> in the <i>Amazon SES Developer
|
|
29
30
|
* Guide</i>.</p>
|
|
30
|
-
*
|
|
31
|
+
* <p>You can execute this operation no more than once per second.</p>
|
|
31
32
|
* @example
|
|
32
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
34
|
* ```javascript
|
|
@@ -24,8 +24,18 @@ export interface ListIdentitiesCommandOutput extends ListIdentitiesResponse, __M
|
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Returns a list containing all of the identities (email addresses and domains) for your
|
|
27
|
-
*
|
|
28
|
-
*
|
|
27
|
+
* Amazon Web Services account in the current Amazon Web Services Region, regardless of verification status.</p>
|
|
28
|
+
* <p>You can execute this operation no more than once per second.</p>
|
|
29
|
+
* <note>
|
|
30
|
+
* <p>It's recommended that for successive pagination calls of this API, you continue to
|
|
31
|
+
* the use the same parameter/value pairs as used in the original call, e.g., if you
|
|
32
|
+
* used <code>IdentityType=Domain</code> in the the original call and received a
|
|
33
|
+
* <code>NextToken</code> in the response, you should continue providing the
|
|
34
|
+
* <code>IdentityType=Domain</code> parameter for further <code>NextToken</code>
|
|
35
|
+
* calls; however, if you didn't provide the <code>IdentityType</code> parameter in the
|
|
36
|
+
* original call, then continue to not provide it for successive pagination calls.
|
|
37
|
+
* Using this protocol will ensure consistent results.</p>
|
|
38
|
+
* </note>
|
|
29
39
|
* @example
|
|
30
40
|
* Use a bare-bones client and the command you need to make an API call.
|
|
31
41
|
* ```javascript
|
|
@@ -33,7 +43,7 @@ export interface ListIdentitiesCommandOutput extends ListIdentitiesResponse, __M
|
|
|
33
43
|
* // const { SESClient, ListIdentitiesCommand } = require("@aws-sdk/client-ses"); // CommonJS import
|
|
34
44
|
* const client = new SESClient(config);
|
|
35
45
|
* const input = { // ListIdentitiesRequest
|
|
36
|
-
* IdentityType: "
|
|
46
|
+
* IdentityType: "EmailAddress" || "Domain",
|
|
37
47
|
* NextToken: "STRING_VALUE",
|
|
38
48
|
* MaxItems: Number("int"),
|
|
39
49
|
* };
|
|
@@ -24,17 +24,17 @@ export interface ListIdentityPoliciesCommandOutput extends ListIdentityPoliciesR
|
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Returns a list of sending authorization policies that are attached to the given
|
|
27
|
-
* identity (an email address or a domain). This
|
|
28
|
-
* actual policy content,
|
|
29
|
-
*
|
|
30
|
-
* <p>This
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
*
|
|
27
|
+
* identity (an email address or a domain). This operation returns only a list. To get the
|
|
28
|
+
* actual policy content, use <code>GetIdentityPolicies</code>.</p>
|
|
29
|
+
* <note>
|
|
30
|
+
* <p>This operation is for the identity owner only. If you have not verified the
|
|
31
|
+
* identity, it returns an error.</p>
|
|
32
|
+
* </note>
|
|
33
|
+
* <p>Sending authorization is a feature that enables an identity owner to authorize other
|
|
34
34
|
* senders to use its identities. For information about using sending authorization, see
|
|
35
|
-
* the <a href="https://docs.aws.amazon.com/ses/latest/
|
|
36
|
-
* Guide</a>.</p>
|
|
37
|
-
*
|
|
35
|
+
* the <a href="https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html">Amazon SES
|
|
36
|
+
* Developer Guide</a>.</p>
|
|
37
|
+
* <p>You can execute this operation no more than once per second.</p>
|
|
38
38
|
* @example
|
|
39
39
|
* Use a bare-bones client and the command you need to make an API call.
|
|
40
40
|
* ```javascript
|
|
@@ -23,11 +23,11 @@ export interface ListReceiptFiltersCommandOutput extends ListReceiptFiltersRespo
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Lists the IP address filters associated with your
|
|
27
|
-
* Region.</p>
|
|
28
|
-
*
|
|
26
|
+
* <p>Lists the IP address filters associated with your Amazon Web Services account in the current
|
|
27
|
+
* Amazon Web Services Region.</p>
|
|
28
|
+
* <p>For information about managing IP address filters, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-ip-filtering-console-walkthrough.html">Amazon SES
|
|
29
29
|
* Developer Guide</a>.</p>
|
|
30
|
-
*
|
|
30
|
+
* <p>You can execute this operation no more than once per second.</p>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -42,7 +42,7 @@ export interface ListReceiptFiltersCommandOutput extends ListReceiptFiltersRespo
|
|
|
42
42
|
* // { // ReceiptFilter
|
|
43
43
|
* // Name: "STRING_VALUE", // required
|
|
44
44
|
* // IpFilter: { // ReceiptIpFilter
|
|
45
|
-
* // Policy: "
|
|
45
|
+
* // Policy: "Block" || "Allow", // required
|
|
46
46
|
* // Cidr: "STRING_VALUE", // required
|
|
47
47
|
* // },
|
|
48
48
|
* // },
|
|
@@ -23,12 +23,13 @@ export interface ListReceiptRuleSetsCommandOutput extends ListReceiptRuleSetsRes
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Lists the receipt rule sets that exist under your
|
|
27
|
-
* Region. If there are additional receipt rule sets to be retrieved, you
|
|
26
|
+
* <p>Lists the receipt rule sets that exist under your Amazon Web Services account in the current
|
|
27
|
+
* Amazon Web Services Region. If there are additional receipt rule sets to be retrieved, you receive a
|
|
28
28
|
* <code>NextToken</code> that you can provide to the next call to
|
|
29
29
|
* <code>ListReceiptRuleSets</code> to retrieve the additional entries.</p>
|
|
30
|
-
*
|
|
31
|
-
*
|
|
30
|
+
* <p>For information about managing receipt rule sets, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-receipt-rules-console-walkthrough.html">Amazon SES
|
|
31
|
+
* Developer Guide</a>.</p>
|
|
32
|
+
* <p>You can execute this operation no more than once per second.</p>
|
|
32
33
|
* @example
|
|
33
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
35
|
* ```javascript
|
|
@@ -23,9 +23,9 @@ export interface ListTemplatesCommandOutput extends ListTemplatesResponse, __Met
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Lists the email templates present in your Amazon SES account in the current
|
|
27
|
-
* Region.</p>
|
|
28
|
-
*
|
|
26
|
+
* <p>Lists the email templates present in your Amazon SES account in the current
|
|
27
|
+
* Amazon Web Services Region.</p>
|
|
28
|
+
* <p>You can execute this operation no more than once per second.</p>
|
|
29
29
|
* @example
|
|
30
30
|
* Use a bare-bones client and the command you need to make an API call.
|
|
31
31
|
* ```javascript
|