@aws-sdk/client-ses 3.287.0 → 3.289.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/dist-types/commands/CloneReceiptRuleSetCommand.d.ts +12 -0
- package/dist-types/commands/CreateReceiptFilterCommand.d.ts +17 -0
- package/dist-types/commands/CreateReceiptRuleCommand.d.ts +26 -0
- package/dist-types/commands/CreateReceiptRuleSetCommand.d.ts +11 -0
- package/dist-types/commands/DeleteIdentityCommand.d.ts +11 -0
- package/dist-types/commands/DeleteIdentityPolicyCommand.d.ts +12 -0
- package/dist-types/commands/DeleteReceiptFilterCommand.d.ts +11 -0
- package/dist-types/commands/DeleteReceiptRuleCommand.d.ts +12 -0
- package/dist-types/commands/DeleteReceiptRuleSetCommand.d.ts +11 -0
- package/dist-types/commands/DeleteVerifiedEmailAddressCommand.d.ts +11 -0
- package/dist-types/commands/DescribeActiveReceiptRuleSetCommand.d.ts +33 -0
- package/dist-types/commands/DescribeReceiptRuleCommand.d.ts +30 -0
- package/dist-types/commands/DescribeReceiptRuleSetCommand.d.ts +35 -0
- package/dist-types/commands/GetAccountSendingEnabledCommand.d.ts +14 -0
- package/dist-types/commands/GetIdentityDkimAttributesCommand.d.ts +33 -0
- package/dist-types/commands/GetIdentityMailFromDomainAttributesCommand.d.ts +24 -0
- package/dist-types/commands/GetIdentityNotificationAttributesCommand.d.ts +28 -0
- package/dist-types/commands/GetIdentityPoliciesCommand.d.ts +21 -0
- package/dist-types/commands/GetIdentityVerificationAttributesCommand.d.ts +23 -0
- package/dist-types/commands/GetSendQuotaCommand.d.ts +16 -0
- package/dist-types/commands/GetSendStatisticsCommand.d.ts +36 -0
- package/dist-types/commands/ListIdentitiesCommand.d.ts +21 -0
- package/dist-types/commands/ListIdentityPoliciesCommand.d.ts +18 -0
- package/dist-types/commands/ListReceiptFiltersCommand.d.ts +22 -0
- package/dist-types/commands/ListReceiptRuleSetsCommand.d.ts +22 -0
- package/dist-types/commands/ListVerifiedEmailAddressesCommand.d.ts +17 -0
- package/dist-types/commands/PutIdentityPolicyCommand.d.ts +13 -0
- package/dist-types/commands/ReorderReceiptRuleSetCommand.d.ts +15 -0
- package/dist-types/commands/SendEmailCommand.d.ts +46 -0
- package/dist-types/commands/SendRawEmailCommand.d.ts +23 -0
- package/dist-types/commands/SetActiveReceiptRuleSetCommand.d.ts +11 -0
- package/dist-types/commands/SetIdentityDkimEnabledCommand.d.ts +12 -0
- package/dist-types/commands/SetIdentityFeedbackForwardingEnabledCommand.d.ts +12 -0
- package/dist-types/commands/SetIdentityHeadersInNotificationsEnabledCommand.d.ts +13 -0
- package/dist-types/commands/SetIdentityMailFromDomainCommand.d.ts +13 -0
- package/dist-types/commands/SetIdentityNotificationTopicCommand.d.ts +13 -0
- package/dist-types/commands/SetReceiptRulePositionCommand.d.ts +13 -0
- package/dist-types/commands/UpdateAccountSendingEnabledCommand.d.ts +11 -0
- package/dist-types/commands/UpdateConfigurationSetReputationMetricsEnabledCommand.d.ts +12 -0
- package/dist-types/commands/UpdateConfigurationSetSendingEnabledCommand.d.ts +12 -0
- package/dist-types/commands/UpdateReceiptRuleCommand.d.ts +25 -0
- package/dist-types/commands/VerifyDomainDkimCommand.d.ts +20 -0
- package/dist-types/commands/VerifyDomainIdentityCommand.d.ts +16 -0
- package/dist-types/commands/VerifyEmailAddressCommand.d.ts +11 -0
- package/dist-types/commands/VerifyEmailIdentityCommand.d.ts +11 -0
- package/package.json +30 -30
|
@@ -34,6 +34,18 @@ export interface CloneReceiptRuleSetCommandOutput extends CloneReceiptRuleSetRes
|
|
|
34
34
|
* @see {@link CloneReceiptRuleSetCommandOutput} for command's `response` shape.
|
|
35
35
|
* @see {@link SESClientResolvedConfig | config} for SESClient's `config` shape.
|
|
36
36
|
*
|
|
37
|
+
* @example CloneReceiptRuleSet
|
|
38
|
+
* ```javascript
|
|
39
|
+
* // The following example creates a receipt rule set by cloning an existing one:
|
|
40
|
+
* const input = {
|
|
41
|
+
* "OriginalRuleSetName": "RuleSetToClone",
|
|
42
|
+
* "RuleSetName": "RuleSetToCreate"
|
|
43
|
+
* };
|
|
44
|
+
* const command = new CloneReceiptRuleSetCommand(input);
|
|
45
|
+
* await client.send(command);
|
|
46
|
+
* // example id: clonereceiptruleset-1469055039770
|
|
47
|
+
* ```
|
|
48
|
+
*
|
|
37
49
|
*/
|
|
38
50
|
export declare class CloneReceiptRuleSetCommand extends $Command<CloneReceiptRuleSetCommandInput, CloneReceiptRuleSetCommandOutput, SESClientResolvedConfig> {
|
|
39
51
|
readonly input: CloneReceiptRuleSetCommandInput;
|
|
@@ -31,6 +31,23 @@ export interface CreateReceiptFilterCommandOutput extends CreateReceiptFilterRes
|
|
|
31
31
|
* @see {@link CreateReceiptFilterCommandOutput} for command's `response` shape.
|
|
32
32
|
* @see {@link SESClientResolvedConfig | config} for SESClient's `config` shape.
|
|
33
33
|
*
|
|
34
|
+
* @example CreateReceiptFilter
|
|
35
|
+
* ```javascript
|
|
36
|
+
* // The following example creates a new IP address filter:
|
|
37
|
+
* const input = {
|
|
38
|
+
* "Filter": {
|
|
39
|
+
* "IpFilter": {
|
|
40
|
+
* "Cidr": "1.2.3.4/24",
|
|
41
|
+
* "Policy": "Allow"
|
|
42
|
+
* },
|
|
43
|
+
* "Name": "MyFilter"
|
|
44
|
+
* }
|
|
45
|
+
* };
|
|
46
|
+
* const command = new CreateReceiptFilterCommand(input);
|
|
47
|
+
* await client.send(command);
|
|
48
|
+
* // example id: createreceiptfilter-1469122681253
|
|
49
|
+
* ```
|
|
50
|
+
*
|
|
34
51
|
*/
|
|
35
52
|
export declare class CreateReceiptFilterCommand extends $Command<CreateReceiptFilterCommandInput, CreateReceiptFilterCommandOutput, SESClientResolvedConfig> {
|
|
36
53
|
readonly input: CreateReceiptFilterCommandInput;
|
|
@@ -32,6 +32,32 @@ export interface CreateReceiptRuleCommandOutput extends CreateReceiptRuleRespons
|
|
|
32
32
|
* @see {@link CreateReceiptRuleCommandOutput} for command's `response` shape.
|
|
33
33
|
* @see {@link SESClientResolvedConfig | config} for SESClient's `config` shape.
|
|
34
34
|
*
|
|
35
|
+
* @example CreateReceiptRule
|
|
36
|
+
* ```javascript
|
|
37
|
+
* // The following example creates a new receipt rule:
|
|
38
|
+
* const input = {
|
|
39
|
+
* "After": "",
|
|
40
|
+
* "Rule": {
|
|
41
|
+
* "Actions": [
|
|
42
|
+
* {
|
|
43
|
+
* "S3Action": {
|
|
44
|
+
* "BucketName": "MyBucket",
|
|
45
|
+
* "ObjectKeyPrefix": "email"
|
|
46
|
+
* }
|
|
47
|
+
* }
|
|
48
|
+
* ],
|
|
49
|
+
* "Enabled": true,
|
|
50
|
+
* "Name": "MyRule",
|
|
51
|
+
* "ScanEnabled": true,
|
|
52
|
+
* "TlsPolicy": "Optional"
|
|
53
|
+
* },
|
|
54
|
+
* "RuleSetName": "MyRuleSet"
|
|
55
|
+
* };
|
|
56
|
+
* const command = new CreateReceiptRuleCommand(input);
|
|
57
|
+
* await client.send(command);
|
|
58
|
+
* // example id: createreceiptrule-1469122946515
|
|
59
|
+
* ```
|
|
60
|
+
*
|
|
35
61
|
*/
|
|
36
62
|
export declare class CreateReceiptRuleCommand extends $Command<CreateReceiptRuleCommandInput, CreateReceiptRuleCommandOutput, SESClientResolvedConfig> {
|
|
37
63
|
readonly input: CreateReceiptRuleCommandInput;
|
|
@@ -32,6 +32,17 @@ export interface CreateReceiptRuleSetCommandOutput extends CreateReceiptRuleSetR
|
|
|
32
32
|
* @see {@link CreateReceiptRuleSetCommandOutput} for command's `response` shape.
|
|
33
33
|
* @see {@link SESClientResolvedConfig | config} for SESClient's `config` shape.
|
|
34
34
|
*
|
|
35
|
+
* @example CreateReceiptRuleSet
|
|
36
|
+
* ```javascript
|
|
37
|
+
* // The following example creates an empty receipt rule set:
|
|
38
|
+
* const input = {
|
|
39
|
+
* "RuleSetName": "MyRuleSet"
|
|
40
|
+
* };
|
|
41
|
+
* const command = new CreateReceiptRuleSetCommand(input);
|
|
42
|
+
* await client.send(command);
|
|
43
|
+
* // example id: createreceiptruleset-1469058761646
|
|
44
|
+
* ```
|
|
45
|
+
*
|
|
35
46
|
*/
|
|
36
47
|
export declare class CreateReceiptRuleSetCommand extends $Command<CreateReceiptRuleSetCommandInput, CreateReceiptRuleSetCommandOutput, SESClientResolvedConfig> {
|
|
37
48
|
readonly input: CreateReceiptRuleSetCommandInput;
|
|
@@ -31,6 +31,17 @@ export interface DeleteIdentityCommandOutput extends DeleteIdentityResponse, __M
|
|
|
31
31
|
* @see {@link DeleteIdentityCommandOutput} for command's `response` shape.
|
|
32
32
|
* @see {@link SESClientResolvedConfig | config} for SESClient's `config` shape.
|
|
33
33
|
*
|
|
34
|
+
* @example DeleteIdentity
|
|
35
|
+
* ```javascript
|
|
36
|
+
* // The following example deletes an identity from the list of identities that have been submitted for verification with Amazon SES:
|
|
37
|
+
* const input = {
|
|
38
|
+
* "Identity": "user@example.com"
|
|
39
|
+
* };
|
|
40
|
+
* const command = new DeleteIdentityCommand(input);
|
|
41
|
+
* await client.send(command);
|
|
42
|
+
* // example id: deleteidentity-1469047858906
|
|
43
|
+
* ```
|
|
44
|
+
*
|
|
34
45
|
*/
|
|
35
46
|
export declare class DeleteIdentityCommand extends $Command<DeleteIdentityCommandInput, DeleteIdentityCommandOutput, SESClientResolvedConfig> {
|
|
36
47
|
readonly input: DeleteIdentityCommandInput;
|
|
@@ -40,6 +40,18 @@ export interface DeleteIdentityPolicyCommandOutput extends DeleteIdentityPolicyR
|
|
|
40
40
|
* @see {@link DeleteIdentityPolicyCommandOutput} for command's `response` shape.
|
|
41
41
|
* @see {@link SESClientResolvedConfig | config} for SESClient's `config` shape.
|
|
42
42
|
*
|
|
43
|
+
* @example DeleteIdentityPolicy
|
|
44
|
+
* ```javascript
|
|
45
|
+
* // The following example deletes a sending authorization policy for an identity:
|
|
46
|
+
* const input = {
|
|
47
|
+
* "Identity": "user@example.com",
|
|
48
|
+
* "PolicyName": "MyPolicy"
|
|
49
|
+
* };
|
|
50
|
+
* const command = new DeleteIdentityPolicyCommand(input);
|
|
51
|
+
* await client.send(command);
|
|
52
|
+
* // example id: deleteidentitypolicy-1469055282499
|
|
53
|
+
* ```
|
|
54
|
+
*
|
|
43
55
|
*/
|
|
44
56
|
export declare class DeleteIdentityPolicyCommand extends $Command<DeleteIdentityPolicyCommandInput, DeleteIdentityPolicyCommandOutput, SESClientResolvedConfig> {
|
|
45
57
|
readonly input: DeleteIdentityPolicyCommandInput;
|
|
@@ -32,6 +32,17 @@ export interface DeleteReceiptFilterCommandOutput extends DeleteReceiptFilterRes
|
|
|
32
32
|
* @see {@link DeleteReceiptFilterCommandOutput} for command's `response` shape.
|
|
33
33
|
* @see {@link SESClientResolvedConfig | config} for SESClient's `config` shape.
|
|
34
34
|
*
|
|
35
|
+
* @example DeleteReceiptFilter
|
|
36
|
+
* ```javascript
|
|
37
|
+
* // The following example deletes an IP address filter:
|
|
38
|
+
* const input = {
|
|
39
|
+
* "FilterName": "MyFilter"
|
|
40
|
+
* };
|
|
41
|
+
* const command = new DeleteReceiptFilterCommand(input);
|
|
42
|
+
* await client.send(command);
|
|
43
|
+
* // example id: deletereceiptfilter-1469055456835
|
|
44
|
+
* ```
|
|
45
|
+
*
|
|
35
46
|
*/
|
|
36
47
|
export declare class DeleteReceiptFilterCommand extends $Command<DeleteReceiptFilterCommandInput, DeleteReceiptFilterCommandOutput, SESClientResolvedConfig> {
|
|
37
48
|
readonly input: DeleteReceiptFilterCommandInput;
|
|
@@ -32,6 +32,18 @@ export interface DeleteReceiptRuleCommandOutput extends DeleteReceiptRuleRespons
|
|
|
32
32
|
* @see {@link DeleteReceiptRuleCommandOutput} for command's `response` shape.
|
|
33
33
|
* @see {@link SESClientResolvedConfig | config} for SESClient's `config` shape.
|
|
34
34
|
*
|
|
35
|
+
* @example DeleteReceiptRule
|
|
36
|
+
* ```javascript
|
|
37
|
+
* // The following example deletes a receipt rule:
|
|
38
|
+
* const input = {
|
|
39
|
+
* "RuleName": "MyRule",
|
|
40
|
+
* "RuleSetName": "MyRuleSet"
|
|
41
|
+
* };
|
|
42
|
+
* const command = new DeleteReceiptRuleCommand(input);
|
|
43
|
+
* await client.send(command);
|
|
44
|
+
* // example id: deletereceiptrule-1469055563599
|
|
45
|
+
* ```
|
|
46
|
+
*
|
|
35
47
|
*/
|
|
36
48
|
export declare class DeleteReceiptRuleCommand extends $Command<DeleteReceiptRuleCommandInput, DeleteReceiptRuleCommandOutput, SESClientResolvedConfig> {
|
|
37
49
|
readonly input: DeleteReceiptRuleCommandInput;
|
|
@@ -35,6 +35,17 @@ export interface DeleteReceiptRuleSetCommandOutput extends DeleteReceiptRuleSetR
|
|
|
35
35
|
* @see {@link DeleteReceiptRuleSetCommandOutput} for command's `response` shape.
|
|
36
36
|
* @see {@link SESClientResolvedConfig | config} for SESClient's `config` shape.
|
|
37
37
|
*
|
|
38
|
+
* @example DeleteReceiptRuleSet
|
|
39
|
+
* ```javascript
|
|
40
|
+
* // The following example deletes a receipt rule set:
|
|
41
|
+
* const input = {
|
|
42
|
+
* "RuleSetName": "MyRuleSet"
|
|
43
|
+
* };
|
|
44
|
+
* const command = new DeleteReceiptRuleSetCommand(input);
|
|
45
|
+
* await client.send(command);
|
|
46
|
+
* // example id: deletereceiptruleset-1469055713690
|
|
47
|
+
* ```
|
|
48
|
+
*
|
|
38
49
|
*/
|
|
39
50
|
export declare class DeleteReceiptRuleSetCommand extends $Command<DeleteReceiptRuleSetCommandInput, DeleteReceiptRuleSetCommandOutput, SESClientResolvedConfig> {
|
|
40
51
|
readonly input: DeleteReceiptRuleSetCommandInput;
|
|
@@ -30,6 +30,17 @@ export interface DeleteVerifiedEmailAddressCommandOutput extends __MetadataBeare
|
|
|
30
30
|
* @see {@link DeleteVerifiedEmailAddressCommandOutput} for command's `response` shape.
|
|
31
31
|
* @see {@link SESClientResolvedConfig | config} for SESClient's `config` shape.
|
|
32
32
|
*
|
|
33
|
+
* @example DeleteVerifiedEmailAddress
|
|
34
|
+
* ```javascript
|
|
35
|
+
* // The following example deletes an email address from the list of identities that have been submitted for verification with Amazon SES:
|
|
36
|
+
* const input = {
|
|
37
|
+
* "EmailAddress": "user@example.com"
|
|
38
|
+
* };
|
|
39
|
+
* const command = new DeleteVerifiedEmailAddressCommand(input);
|
|
40
|
+
* await client.send(command);
|
|
41
|
+
* // example id: deleteverifiedemailaddress-1469051086444
|
|
42
|
+
* ```
|
|
43
|
+
*
|
|
33
44
|
*/
|
|
34
45
|
export declare class DeleteVerifiedEmailAddressCommand extends $Command<DeleteVerifiedEmailAddressCommandInput, DeleteVerifiedEmailAddressCommandOutput, SESClientResolvedConfig> {
|
|
35
46
|
readonly input: DeleteVerifiedEmailAddressCommandInput;
|
|
@@ -33,6 +33,39 @@ export interface DescribeActiveReceiptRuleSetCommandOutput extends DescribeActiv
|
|
|
33
33
|
* @see {@link DescribeActiveReceiptRuleSetCommandOutput} for command's `response` shape.
|
|
34
34
|
* @see {@link SESClientResolvedConfig | config} for SESClient's `config` shape.
|
|
35
35
|
*
|
|
36
|
+
* @example DescribeActiveReceiptRuleSet
|
|
37
|
+
* ```javascript
|
|
38
|
+
* // The following example returns the metadata and receipt rules for the receipt rule set that is currently active:
|
|
39
|
+
* const input = {};
|
|
40
|
+
* const command = new DescribeActiveReceiptRuleSetCommand(input);
|
|
41
|
+
* const response = await client.send(command);
|
|
42
|
+
* /* response ==
|
|
43
|
+
* {
|
|
44
|
+
* "Metadata": {
|
|
45
|
+
* "CreatedTimestamp": "2016-07-15T16:25:59.607Z",
|
|
46
|
+
* "Name": "default-rule-set"
|
|
47
|
+
* },
|
|
48
|
+
* "Rules": [
|
|
49
|
+
* {
|
|
50
|
+
* "Actions": [
|
|
51
|
+
* {
|
|
52
|
+
* "S3Action": {
|
|
53
|
+
* "BucketName": "MyBucket",
|
|
54
|
+
* "ObjectKeyPrefix": "email"
|
|
55
|
+
* }
|
|
56
|
+
* }
|
|
57
|
+
* ],
|
|
58
|
+
* "Enabled": true,
|
|
59
|
+
* "Name": "MyRule",
|
|
60
|
+
* "ScanEnabled": true,
|
|
61
|
+
* "TlsPolicy": "Optional"
|
|
62
|
+
* }
|
|
63
|
+
* ]
|
|
64
|
+
* }
|
|
65
|
+
* *\/
|
|
66
|
+
* // example id: describeactivereceiptruleset-1469121611502
|
|
67
|
+
* ```
|
|
68
|
+
*
|
|
36
69
|
*/
|
|
37
70
|
export declare class DescribeActiveReceiptRuleSetCommand extends $Command<DescribeActiveReceiptRuleSetCommandInput, DescribeActiveReceiptRuleSetCommandOutput, SESClientResolvedConfig> {
|
|
38
71
|
readonly input: DescribeActiveReceiptRuleSetCommandInput;
|
|
@@ -32,6 +32,36 @@ export interface DescribeReceiptRuleCommandOutput extends DescribeReceiptRuleRes
|
|
|
32
32
|
* @see {@link DescribeReceiptRuleCommandOutput} for command's `response` shape.
|
|
33
33
|
* @see {@link SESClientResolvedConfig | config} for SESClient's `config` shape.
|
|
34
34
|
*
|
|
35
|
+
* @example DescribeReceiptRule
|
|
36
|
+
* ```javascript
|
|
37
|
+
* // The following example returns the details of a receipt rule:
|
|
38
|
+
* const input = {
|
|
39
|
+
* "RuleName": "MyRule",
|
|
40
|
+
* "RuleSetName": "MyRuleSet"
|
|
41
|
+
* };
|
|
42
|
+
* const command = new DescribeReceiptRuleCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* /* response ==
|
|
45
|
+
* {
|
|
46
|
+
* "Rule": {
|
|
47
|
+
* "Actions": [
|
|
48
|
+
* {
|
|
49
|
+
* "S3Action": {
|
|
50
|
+
* "BucketName": "MyBucket",
|
|
51
|
+
* "ObjectKeyPrefix": "email"
|
|
52
|
+
* }
|
|
53
|
+
* }
|
|
54
|
+
* ],
|
|
55
|
+
* "Enabled": true,
|
|
56
|
+
* "Name": "MyRule",
|
|
57
|
+
* "ScanEnabled": true,
|
|
58
|
+
* "TlsPolicy": "Optional"
|
|
59
|
+
* }
|
|
60
|
+
* }
|
|
61
|
+
* *\/
|
|
62
|
+
* // example id: describereceiptrule-1469055813118
|
|
63
|
+
* ```
|
|
64
|
+
*
|
|
35
65
|
*/
|
|
36
66
|
export declare class DescribeReceiptRuleCommand extends $Command<DescribeReceiptRuleCommandInput, DescribeReceiptRuleCommandOutput, SESClientResolvedConfig> {
|
|
37
67
|
readonly input: DescribeReceiptRuleCommandInput;
|
|
@@ -31,6 +31,41 @@ export interface DescribeReceiptRuleSetCommandOutput extends DescribeReceiptRule
|
|
|
31
31
|
* @see {@link DescribeReceiptRuleSetCommandOutput} for command's `response` shape.
|
|
32
32
|
* @see {@link SESClientResolvedConfig | config} for SESClient's `config` shape.
|
|
33
33
|
*
|
|
34
|
+
* @example DescribeReceiptRuleSet
|
|
35
|
+
* ```javascript
|
|
36
|
+
* // The following example returns the metadata and receipt rules of a receipt rule set:
|
|
37
|
+
* const input = {
|
|
38
|
+
* "RuleSetName": "MyRuleSet"
|
|
39
|
+
* };
|
|
40
|
+
* const command = new DescribeReceiptRuleSetCommand(input);
|
|
41
|
+
* const response = await client.send(command);
|
|
42
|
+
* /* response ==
|
|
43
|
+
* {
|
|
44
|
+
* "Metadata": {
|
|
45
|
+
* "CreatedTimestamp": "2016-07-15T16:25:59.607Z",
|
|
46
|
+
* "Name": "MyRuleSet"
|
|
47
|
+
* },
|
|
48
|
+
* "Rules": [
|
|
49
|
+
* {
|
|
50
|
+
* "Actions": [
|
|
51
|
+
* {
|
|
52
|
+
* "S3Action": {
|
|
53
|
+
* "BucketName": "MyBucket",
|
|
54
|
+
* "ObjectKeyPrefix": "email"
|
|
55
|
+
* }
|
|
56
|
+
* }
|
|
57
|
+
* ],
|
|
58
|
+
* "Enabled": true,
|
|
59
|
+
* "Name": "MyRule",
|
|
60
|
+
* "ScanEnabled": true,
|
|
61
|
+
* "TlsPolicy": "Optional"
|
|
62
|
+
* }
|
|
63
|
+
* ]
|
|
64
|
+
* }
|
|
65
|
+
* *\/
|
|
66
|
+
* // example id: describereceiptruleset-1469121240385
|
|
67
|
+
* ```
|
|
68
|
+
*
|
|
34
69
|
*/
|
|
35
70
|
export declare class DescribeReceiptRuleSetCommand extends $Command<DescribeReceiptRuleSetCommandInput, DescribeReceiptRuleSetCommandOutput, SESClientResolvedConfig> {
|
|
36
71
|
readonly input: DescribeReceiptRuleSetCommandInput;
|
|
@@ -30,6 +30,20 @@ export interface GetAccountSendingEnabledCommandOutput extends GetAccountSending
|
|
|
30
30
|
* @see {@link GetAccountSendingEnabledCommandOutput} for command's `response` shape.
|
|
31
31
|
* @see {@link SESClientResolvedConfig | config} for SESClient's `config` shape.
|
|
32
32
|
*
|
|
33
|
+
* @example GetAccountSendingEnabled
|
|
34
|
+
* ```javascript
|
|
35
|
+
* // The following example returns if sending status for an account is enabled. (true / false):
|
|
36
|
+
* const input = undefined;
|
|
37
|
+
* const command = new GetAccountSendingEnabledCommand(input);
|
|
38
|
+
* const response = await client.send(command);
|
|
39
|
+
* /* response ==
|
|
40
|
+
* {
|
|
41
|
+
* "Enabled": true
|
|
42
|
+
* }
|
|
43
|
+
* *\/
|
|
44
|
+
* // example id: getaccountsendingenabled-1469047741333
|
|
45
|
+
* ```
|
|
46
|
+
*
|
|
33
47
|
*/
|
|
34
48
|
export declare class GetAccountSendingEnabledCommand extends $Command<GetAccountSendingEnabledCommandInput, GetAccountSendingEnabledCommandOutput, SESClientResolvedConfig> {
|
|
35
49
|
readonly input: GetAccountSendingEnabledCommandInput;
|
|
@@ -51,6 +51,39 @@ export interface GetIdentityDkimAttributesCommandOutput extends GetIdentityDkimA
|
|
|
51
51
|
* @see {@link GetIdentityDkimAttributesCommandOutput} for command's `response` shape.
|
|
52
52
|
* @see {@link SESClientResolvedConfig | config} for SESClient's `config` shape.
|
|
53
53
|
*
|
|
54
|
+
* @example GetIdentityDkimAttributes
|
|
55
|
+
* ```javascript
|
|
56
|
+
* // The following example retrieves the Amazon SES Easy DKIM attributes for a list of identities:
|
|
57
|
+
* const input = {
|
|
58
|
+
* "Identities": [
|
|
59
|
+
* "example.com",
|
|
60
|
+
* "user@example.com"
|
|
61
|
+
* ]
|
|
62
|
+
* };
|
|
63
|
+
* const command = new GetIdentityDkimAttributesCommand(input);
|
|
64
|
+
* const response = await client.send(command);
|
|
65
|
+
* /* response ==
|
|
66
|
+
* {
|
|
67
|
+
* "DkimAttributes": {
|
|
68
|
+
* "example.com": {
|
|
69
|
+
* "DkimEnabled": true,
|
|
70
|
+
* "DkimTokens": [
|
|
71
|
+
* "EXAMPLEjcs5xoyqytjsotsijas7236gr",
|
|
72
|
+
* "EXAMPLEjr76cvoc6mysspnioorxsn6ep",
|
|
73
|
+
* "EXAMPLEkbmkqkhlm2lyz77ppkulerm4k"
|
|
74
|
+
* ],
|
|
75
|
+
* "DkimVerificationStatus": "Success"
|
|
76
|
+
* },
|
|
77
|
+
* "user@example.com": {
|
|
78
|
+
* "DkimEnabled": false,
|
|
79
|
+
* "DkimVerificationStatus": "NotStarted"
|
|
80
|
+
* }
|
|
81
|
+
* }
|
|
82
|
+
* }
|
|
83
|
+
* *\/
|
|
84
|
+
* // example id: getidentitydkimattributes-1469050695628
|
|
85
|
+
* ```
|
|
86
|
+
*
|
|
54
87
|
*/
|
|
55
88
|
export declare class GetIdentityDkimAttributesCommand extends $Command<GetIdentityDkimAttributesCommandInput, GetIdentityDkimAttributesCommandOutput, SESClientResolvedConfig> {
|
|
56
89
|
readonly input: GetIdentityDkimAttributesCommandInput;
|
|
@@ -32,6 +32,30 @@ export interface GetIdentityMailFromDomainAttributesCommandOutput extends GetIde
|
|
|
32
32
|
* @see {@link GetIdentityMailFromDomainAttributesCommandOutput} for command's `response` shape.
|
|
33
33
|
* @see {@link SESClientResolvedConfig | config} for SESClient's `config` shape.
|
|
34
34
|
*
|
|
35
|
+
* @example GetIdentityMailFromDomainAttributes
|
|
36
|
+
* ```javascript
|
|
37
|
+
* // The following example returns the custom MAIL FROM attributes for an identity:
|
|
38
|
+
* const input = {
|
|
39
|
+
* "Identities": [
|
|
40
|
+
* "example.com"
|
|
41
|
+
* ]
|
|
42
|
+
* };
|
|
43
|
+
* const command = new GetIdentityMailFromDomainAttributesCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* /* response ==
|
|
46
|
+
* {
|
|
47
|
+
* "MailFromDomainAttributes": {
|
|
48
|
+
* "example.com": {
|
|
49
|
+
* "BehaviorOnMXFailure": "UseDefaultValue",
|
|
50
|
+
* "MailFromDomain": "bounces.example.com",
|
|
51
|
+
* "MailFromDomainStatus": "Success"
|
|
52
|
+
* }
|
|
53
|
+
* }
|
|
54
|
+
* }
|
|
55
|
+
* *\/
|
|
56
|
+
* // example id: getidentitymailfromdomainattributes-1469123114860
|
|
57
|
+
* ```
|
|
58
|
+
*
|
|
35
59
|
*/
|
|
36
60
|
export declare class GetIdentityMailFromDomainAttributesCommand extends $Command<GetIdentityMailFromDomainAttributesCommandInput, GetIdentityMailFromDomainAttributesCommandOutput, SESClientResolvedConfig> {
|
|
37
61
|
readonly input: GetIdentityMailFromDomainAttributesCommandInput;
|
|
@@ -34,6 +34,34 @@ export interface GetIdentityNotificationAttributesCommandOutput extends GetIdent
|
|
|
34
34
|
* @see {@link GetIdentityNotificationAttributesCommandOutput} for command's `response` shape.
|
|
35
35
|
* @see {@link SESClientResolvedConfig | config} for SESClient's `config` shape.
|
|
36
36
|
*
|
|
37
|
+
* @example GetIdentityNotificationAttributes
|
|
38
|
+
* ```javascript
|
|
39
|
+
* // The following example returns the notification attributes for an identity:
|
|
40
|
+
* const input = {
|
|
41
|
+
* "Identities": [
|
|
42
|
+
* "example.com"
|
|
43
|
+
* ]
|
|
44
|
+
* };
|
|
45
|
+
* const command = new GetIdentityNotificationAttributesCommand(input);
|
|
46
|
+
* const response = await client.send(command);
|
|
47
|
+
* /* response ==
|
|
48
|
+
* {
|
|
49
|
+
* "NotificationAttributes": {
|
|
50
|
+
* "example.com": {
|
|
51
|
+
* "BounceTopic": "arn:aws:sns:us-east-1:EXAMPLE65304:ExampleTopic",
|
|
52
|
+
* "ComplaintTopic": "arn:aws:sns:us-east-1:EXAMPLE65304:ExampleTopic",
|
|
53
|
+
* "DeliveryTopic": "arn:aws:sns:us-east-1:EXAMPLE65304:ExampleTopic",
|
|
54
|
+
* "ForwardingEnabled": true,
|
|
55
|
+
* "HeadersInBounceNotificationsEnabled": false,
|
|
56
|
+
* "HeadersInComplaintNotificationsEnabled": false,
|
|
57
|
+
* "HeadersInDeliveryNotificationsEnabled": false
|
|
58
|
+
* }
|
|
59
|
+
* }
|
|
60
|
+
* }
|
|
61
|
+
* *\/
|
|
62
|
+
* // example id: getidentitynotificationattributes-1469123466947
|
|
63
|
+
* ```
|
|
64
|
+
*
|
|
37
65
|
*/
|
|
38
66
|
export declare class GetIdentityNotificationAttributesCommand extends $Command<GetIdentityNotificationAttributesCommandInput, GetIdentityNotificationAttributesCommandOutput, SESClientResolvedConfig> {
|
|
39
67
|
readonly input: GetIdentityNotificationAttributesCommandInput;
|
|
@@ -40,6 +40,27 @@ export interface GetIdentityPoliciesCommandOutput extends GetIdentityPoliciesRes
|
|
|
40
40
|
* @see {@link GetIdentityPoliciesCommandOutput} for command's `response` shape.
|
|
41
41
|
* @see {@link SESClientResolvedConfig | config} for SESClient's `config` shape.
|
|
42
42
|
*
|
|
43
|
+
* @example GetIdentityPolicies
|
|
44
|
+
* ```javascript
|
|
45
|
+
* // The following example returns a sending authorization policy for an identity:
|
|
46
|
+
* const input = {
|
|
47
|
+
* "Identity": "example.com",
|
|
48
|
+
* "PolicyNames": [
|
|
49
|
+
* "MyPolicy"
|
|
50
|
+
* ]
|
|
51
|
+
* };
|
|
52
|
+
* const command = new GetIdentityPoliciesCommand(input);
|
|
53
|
+
* const response = await client.send(command);
|
|
54
|
+
* /* response ==
|
|
55
|
+
* {
|
|
56
|
+
* "Policies": {
|
|
57
|
+
* "MyPolicy": "{\"Version\":\"2008-10-17\",\"Statement\":[{\"Sid\":\"stmt1469123904194\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::123456789012:root\"},\"Action\":[\"ses:SendEmail\",\"ses:SendRawEmail\"],\"Resource\":\"arn:aws:ses:us-east-1:EXAMPLE65304:identity/example.com\"}]}"
|
|
58
|
+
* }
|
|
59
|
+
* }
|
|
60
|
+
* *\/
|
|
61
|
+
* // example id: getidentitypolicies-1469123949351
|
|
62
|
+
* ```
|
|
63
|
+
*
|
|
43
64
|
*/
|
|
44
65
|
export declare class GetIdentityPoliciesCommand extends $Command<GetIdentityPoliciesCommandInput, GetIdentityPoliciesCommandOutput, SESClientResolvedConfig> {
|
|
45
66
|
readonly input: GetIdentityPoliciesCommandInput;
|
|
@@ -44,6 +44,29 @@ export interface GetIdentityVerificationAttributesCommandOutput extends GetIdent
|
|
|
44
44
|
* @see {@link GetIdentityVerificationAttributesCommandOutput} for command's `response` shape.
|
|
45
45
|
* @see {@link SESClientResolvedConfig | config} for SESClient's `config` shape.
|
|
46
46
|
*
|
|
47
|
+
* @example GetIdentityVerificationAttributes
|
|
48
|
+
* ```javascript
|
|
49
|
+
* // The following example returns the verification status and the verification token for a domain identity:
|
|
50
|
+
* const input = {
|
|
51
|
+
* "Identities": [
|
|
52
|
+
* "example.com"
|
|
53
|
+
* ]
|
|
54
|
+
* };
|
|
55
|
+
* const command = new GetIdentityVerificationAttributesCommand(input);
|
|
56
|
+
* const response = await client.send(command);
|
|
57
|
+
* /* response ==
|
|
58
|
+
* {
|
|
59
|
+
* "VerificationAttributes": {
|
|
60
|
+
* "example.com": {
|
|
61
|
+
* "VerificationStatus": "Success",
|
|
62
|
+
* "VerificationToken": "EXAMPLE3VYb9EDI2nTOQRi/Tf6MI/6bD6THIGiP1MVY="
|
|
63
|
+
* }
|
|
64
|
+
* }
|
|
65
|
+
* }
|
|
66
|
+
* *\/
|
|
67
|
+
* // example id: getidentityverificationattributes-1469124205897
|
|
68
|
+
* ```
|
|
69
|
+
*
|
|
47
70
|
*/
|
|
48
71
|
export declare class GetIdentityVerificationAttributesCommand extends $Command<GetIdentityVerificationAttributesCommandInput, GetIdentityVerificationAttributesCommandOutput, SESClientResolvedConfig> {
|
|
49
72
|
readonly input: GetIdentityVerificationAttributesCommandInput;
|
|
@@ -30,6 +30,22 @@ export interface GetSendQuotaCommandOutput extends GetSendQuotaResponse, __Metad
|
|
|
30
30
|
* @see {@link GetSendQuotaCommandOutput} for command's `response` shape.
|
|
31
31
|
* @see {@link SESClientResolvedConfig | config} for SESClient's `config` shape.
|
|
32
32
|
*
|
|
33
|
+
* @example GetSendQuota
|
|
34
|
+
* ```javascript
|
|
35
|
+
* // The following example returns the Amazon SES sending limits for an AWS account:
|
|
36
|
+
* const input = undefined;
|
|
37
|
+
* const command = new GetSendQuotaCommand(input);
|
|
38
|
+
* const response = await client.send(command);
|
|
39
|
+
* /* response ==
|
|
40
|
+
* {
|
|
41
|
+
* "Max24HourSend": 200,
|
|
42
|
+
* "MaxSendRate": 1,
|
|
43
|
+
* "SentLast24Hours": 1
|
|
44
|
+
* }
|
|
45
|
+
* *\/
|
|
46
|
+
* // example id: getsendquota-1469047324508
|
|
47
|
+
* ```
|
|
48
|
+
*
|
|
33
49
|
*/
|
|
34
50
|
export declare class GetSendQuotaCommand extends $Command<GetSendQuotaCommandInput, GetSendQuotaCommandOutput, SESClientResolvedConfig> {
|
|
35
51
|
readonly input: GetSendQuotaCommandInput;
|
|
@@ -32,6 +32,42 @@ export interface GetSendStatisticsCommandOutput extends GetSendStatisticsRespons
|
|
|
32
32
|
* @see {@link GetSendStatisticsCommandOutput} for command's `response` shape.
|
|
33
33
|
* @see {@link SESClientResolvedConfig | config} for SESClient's `config` shape.
|
|
34
34
|
*
|
|
35
|
+
* @example GetSendStatistics
|
|
36
|
+
* ```javascript
|
|
37
|
+
* // The following example returns Amazon SES sending statistics:
|
|
38
|
+
* const input = undefined;
|
|
39
|
+
* const command = new GetSendStatisticsCommand(input);
|
|
40
|
+
* const response = await client.send(command);
|
|
41
|
+
* /* response ==
|
|
42
|
+
* {
|
|
43
|
+
* "SendDataPoints": [
|
|
44
|
+
* {
|
|
45
|
+
* "Bounces": 0,
|
|
46
|
+
* "Complaints": 0,
|
|
47
|
+
* "DeliveryAttempts": 5,
|
|
48
|
+
* "Rejects": 0,
|
|
49
|
+
* "Timestamp": "2016-07-13T22:43:00Z"
|
|
50
|
+
* },
|
|
51
|
+
* {
|
|
52
|
+
* "Bounces": 0,
|
|
53
|
+
* "Complaints": 0,
|
|
54
|
+
* "DeliveryAttempts": 3,
|
|
55
|
+
* "Rejects": 0,
|
|
56
|
+
* "Timestamp": "2016-07-13T23:13:00Z"
|
|
57
|
+
* },
|
|
58
|
+
* {
|
|
59
|
+
* "Bounces": 0,
|
|
60
|
+
* "Complaints": 0,
|
|
61
|
+
* "DeliveryAttempts": 1,
|
|
62
|
+
* "Rejects": 0,
|
|
63
|
+
* "Timestamp": "2016-07-13T21:13:00Z"
|
|
64
|
+
* }
|
|
65
|
+
* ]
|
|
66
|
+
* }
|
|
67
|
+
* *\/
|
|
68
|
+
* // example id: getsendstatistics-1469047741329
|
|
69
|
+
* ```
|
|
70
|
+
*
|
|
35
71
|
*/
|
|
36
72
|
export declare class GetSendStatisticsCommand extends $Command<GetSendStatisticsCommandInput, GetSendStatisticsCommandOutput, SESClientResolvedConfig> {
|
|
37
73
|
readonly input: GetSendStatisticsCommandInput;
|
|
@@ -31,6 +31,27 @@ export interface ListIdentitiesCommandOutput extends ListIdentitiesResponse, __M
|
|
|
31
31
|
* @see {@link ListIdentitiesCommandOutput} for command's `response` shape.
|
|
32
32
|
* @see {@link SESClientResolvedConfig | config} for SESClient's `config` shape.
|
|
33
33
|
*
|
|
34
|
+
* @example ListIdentities
|
|
35
|
+
* ```javascript
|
|
36
|
+
* // The following example lists the email address identities that have been submitted for verification with Amazon SES:
|
|
37
|
+
* const input = {
|
|
38
|
+
* "IdentityType": "EmailAddress",
|
|
39
|
+
* "MaxItems": 123,
|
|
40
|
+
* "NextToken": ""
|
|
41
|
+
* };
|
|
42
|
+
* const command = new ListIdentitiesCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* /* response ==
|
|
45
|
+
* {
|
|
46
|
+
* "Identities": [
|
|
47
|
+
* "user@example.com"
|
|
48
|
+
* ],
|
|
49
|
+
* "NextToken": ""
|
|
50
|
+
* }
|
|
51
|
+
* *\/
|
|
52
|
+
* // example id: listidentities-1469048638493
|
|
53
|
+
* ```
|
|
54
|
+
*
|
|
34
55
|
*/
|
|
35
56
|
export declare class ListIdentitiesCommand extends $Command<ListIdentitiesCommandInput, ListIdentitiesCommandOutput, SESClientResolvedConfig> {
|
|
36
57
|
readonly input: ListIdentitiesCommandInput;
|
|
@@ -40,6 +40,24 @@ export interface ListIdentityPoliciesCommandOutput extends ListIdentityPoliciesR
|
|
|
40
40
|
* @see {@link ListIdentityPoliciesCommandOutput} for command's `response` shape.
|
|
41
41
|
* @see {@link SESClientResolvedConfig | config} for SESClient's `config` shape.
|
|
42
42
|
*
|
|
43
|
+
* @example ListIdentityPolicies
|
|
44
|
+
* ```javascript
|
|
45
|
+
* // The following example returns a list of sending authorization policies that are attached to an identity:
|
|
46
|
+
* const input = {
|
|
47
|
+
* "Identity": "example.com"
|
|
48
|
+
* };
|
|
49
|
+
* const command = new ListIdentityPoliciesCommand(input);
|
|
50
|
+
* const response = await client.send(command);
|
|
51
|
+
* /* response ==
|
|
52
|
+
* {
|
|
53
|
+
* "PolicyNames": [
|
|
54
|
+
* "MyPolicy"
|
|
55
|
+
* ]
|
|
56
|
+
* }
|
|
57
|
+
* *\/
|
|
58
|
+
* // example id: listidentitypolicies-1469124417674
|
|
59
|
+
* ```
|
|
60
|
+
*
|
|
43
61
|
*/
|
|
44
62
|
export declare class ListIdentityPoliciesCommand extends $Command<ListIdentityPoliciesCommandInput, ListIdentityPoliciesCommandOutput, SESClientResolvedConfig> {
|
|
45
63
|
readonly input: ListIdentityPoliciesCommandInput;
|