@aws-sdk/client-sesv2 3.321.1 → 3.326.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 (87) hide show
  1. package/dist-types/commands/BatchGetMetricDataCommand.d.ts +23 -0
  2. package/dist-types/commands/CreateConfigurationSetCommand.d.ts +4 -0
  3. package/dist-types/commands/CreateConfigurationSetEventDestinationCommand.d.ts +4 -0
  4. package/dist-types/commands/CreateContactCommand.d.ts +4 -0
  5. package/dist-types/commands/CreateContactListCommand.d.ts +4 -0
  6. package/dist-types/commands/CreateCustomVerificationEmailTemplateCommand.d.ts +4 -0
  7. package/dist-types/commands/CreateDedicatedIpPoolCommand.d.ts +4 -0
  8. package/dist-types/commands/CreateDeliverabilityTestReportCommand.d.ts +7 -0
  9. package/dist-types/commands/CreateEmailIdentityCommand.d.ts +18 -0
  10. package/dist-types/commands/CreateEmailIdentityPolicyCommand.d.ts +4 -0
  11. package/dist-types/commands/CreateEmailTemplateCommand.d.ts +4 -0
  12. package/dist-types/commands/CreateImportJobCommand.d.ts +6 -0
  13. package/dist-types/commands/DeleteConfigurationSetCommand.d.ts +4 -0
  14. package/dist-types/commands/DeleteConfigurationSetEventDestinationCommand.d.ts +4 -0
  15. package/dist-types/commands/DeleteContactCommand.d.ts +4 -0
  16. package/dist-types/commands/DeleteContactListCommand.d.ts +4 -0
  17. package/dist-types/commands/DeleteCustomVerificationEmailTemplateCommand.d.ts +4 -0
  18. package/dist-types/commands/DeleteDedicatedIpPoolCommand.d.ts +4 -0
  19. package/dist-types/commands/DeleteEmailIdentityCommand.d.ts +4 -0
  20. package/dist-types/commands/DeleteEmailIdentityPolicyCommand.d.ts +4 -0
  21. package/dist-types/commands/DeleteEmailTemplateCommand.d.ts +4 -0
  22. package/dist-types/commands/DeleteSuppressedDestinationCommand.d.ts +4 -0
  23. package/dist-types/commands/GetAccountCommand.d.ts +41 -0
  24. package/dist-types/commands/GetBlacklistReportsCommand.d.ts +14 -0
  25. package/dist-types/commands/GetConfigurationSetCommand.d.ts +39 -0
  26. package/dist-types/commands/GetConfigurationSetEventDestinationsCommand.d.ts +33 -0
  27. package/dist-types/commands/GetContactCommand.d.ts +23 -0
  28. package/dist-types/commands/GetContactListCommand.d.ts +23 -0
  29. package/dist-types/commands/GetCustomVerificationEmailTemplateCommand.d.ts +11 -0
  30. package/dist-types/commands/GetDedicatedIpCommand.d.ts +11 -0
  31. package/dist-types/commands/GetDedicatedIpPoolCommand.d.ts +9 -0
  32. package/dist-types/commands/GetDedicatedIpsCommand.d.ts +14 -0
  33. package/dist-types/commands/GetDeliverabilityDashboardOptionsCommand.d.ts +32 -0
  34. package/dist-types/commands/GetDeliverabilityTestReportCommand.d.ts +39 -0
  35. package/dist-types/commands/GetDomainDeliverabilityCampaignCommand.d.ts +25 -0
  36. package/dist-types/commands/GetDomainStatisticsReportCommand.d.ts +43 -0
  37. package/dist-types/commands/GetEmailIdentityCommand.d.ts +35 -0
  38. package/dist-types/commands/GetEmailIdentityPoliciesCommand.d.ts +8 -0
  39. package/dist-types/commands/GetEmailTemplateCommand.d.ts +11 -0
  40. package/dist-types/commands/GetImportJobCommand.d.ts +28 -0
  41. package/dist-types/commands/GetSuppressedDestinationCommand.d.ts +14 -0
  42. package/dist-types/commands/ListConfigurationSetsCommand.d.ts +9 -0
  43. package/dist-types/commands/ListContactListsCommand.d.ts +12 -0
  44. package/dist-types/commands/ListContactsCommand.d.ts +25 -0
  45. package/dist-types/commands/ListCustomVerificationEmailTemplatesCommand.d.ts +15 -0
  46. package/dist-types/commands/ListDedicatedIpPoolsCommand.d.ts +9 -0
  47. package/dist-types/commands/ListDeliverabilityTestReportsCommand.d.ts +16 -0
  48. package/dist-types/commands/ListDomainDeliverabilityCampaignsCommand.d.ts +28 -0
  49. package/dist-types/commands/ListEmailIdentitiesCommand.d.ts +14 -0
  50. package/dist-types/commands/ListEmailTemplatesCommand.d.ts +12 -0
  51. package/dist-types/commands/ListImportJobsCommand.d.ts +24 -0
  52. package/dist-types/commands/ListRecommendationsCommand.d.ts +17 -0
  53. package/dist-types/commands/ListSuppressedDestinationsCommand.d.ts +13 -0
  54. package/dist-types/commands/ListTagsForResourceCommand.d.ts +11 -0
  55. package/dist-types/commands/PutAccountDedicatedIpWarmupAttributesCommand.d.ts +4 -0
  56. package/dist-types/commands/PutAccountDetailsCommand.d.ts +4 -0
  57. package/dist-types/commands/PutAccountSendingAttributesCommand.d.ts +4 -0
  58. package/dist-types/commands/PutAccountSuppressionAttributesCommand.d.ts +4 -0
  59. package/dist-types/commands/PutAccountVdmAttributesCommand.d.ts +4 -0
  60. package/dist-types/commands/PutConfigurationSetDeliveryOptionsCommand.d.ts +4 -0
  61. package/dist-types/commands/PutConfigurationSetReputationOptionsCommand.d.ts +4 -0
  62. package/dist-types/commands/PutConfigurationSetSendingOptionsCommand.d.ts +4 -0
  63. package/dist-types/commands/PutConfigurationSetSuppressionOptionsCommand.d.ts +4 -0
  64. package/dist-types/commands/PutConfigurationSetTrackingOptionsCommand.d.ts +4 -0
  65. package/dist-types/commands/PutConfigurationSetVdmOptionsCommand.d.ts +4 -0
  66. package/dist-types/commands/PutDedicatedIpInPoolCommand.d.ts +4 -0
  67. package/dist-types/commands/PutDedicatedIpWarmupAttributesCommand.d.ts +4 -0
  68. package/dist-types/commands/PutDeliverabilityDashboardOptionCommand.d.ts +4 -0
  69. package/dist-types/commands/PutEmailIdentityConfigurationSetAttributesCommand.d.ts +4 -0
  70. package/dist-types/commands/PutEmailIdentityDkimAttributesCommand.d.ts +4 -0
  71. package/dist-types/commands/PutEmailIdentityDkimSigningAttributesCommand.d.ts +9 -0
  72. package/dist-types/commands/PutEmailIdentityFeedbackAttributesCommand.d.ts +4 -0
  73. package/dist-types/commands/PutEmailIdentityMailFromAttributesCommand.d.ts +4 -0
  74. package/dist-types/commands/PutSuppressedDestinationCommand.d.ts +4 -0
  75. package/dist-types/commands/SendBulkEmailCommand.d.ts +12 -0
  76. package/dist-types/commands/SendCustomVerificationEmailCommand.d.ts +6 -0
  77. package/dist-types/commands/SendEmailCommand.d.ts +6 -0
  78. package/dist-types/commands/TagResourceCommand.d.ts +4 -0
  79. package/dist-types/commands/TestRenderEmailTemplateCommand.d.ts +6 -0
  80. package/dist-types/commands/UntagResourceCommand.d.ts +4 -0
  81. package/dist-types/commands/UpdateConfigurationSetEventDestinationCommand.d.ts +4 -0
  82. package/dist-types/commands/UpdateContactCommand.d.ts +4 -0
  83. package/dist-types/commands/UpdateContactListCommand.d.ts +4 -0
  84. package/dist-types/commands/UpdateCustomVerificationEmailTemplateCommand.d.ts +4 -0
  85. package/dist-types/commands/UpdateEmailIdentityPolicyCommand.d.ts +4 -0
  86. package/dist-types/commands/UpdateEmailTemplateCommand.d.ts +4 -0
  87. package/package.json +16 -16
@@ -32,6 +32,27 @@ export interface GetContactCommandOutput extends GetContactResponse, __MetadataB
32
32
  * };
33
33
  * const command = new GetContactCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // GetContactResponse
36
+ * // ContactListName: "STRING_VALUE",
37
+ * // EmailAddress: "STRING_VALUE",
38
+ * // TopicPreferences: [ // TopicPreferenceList
39
+ * // { // TopicPreference
40
+ * // TopicName: "STRING_VALUE", // required
41
+ * // SubscriptionStatus: "OPT_IN" || "OPT_OUT", // required
42
+ * // },
43
+ * // ],
44
+ * // TopicDefaultPreferences: [
45
+ * // {
46
+ * // TopicName: "STRING_VALUE", // required
47
+ * // SubscriptionStatus: "OPT_IN" || "OPT_OUT", // required
48
+ * // },
49
+ * // ],
50
+ * // UnsubscribeAll: true || false,
51
+ * // AttributesData: "STRING_VALUE",
52
+ * // CreatedTimestamp: new Date("TIMESTAMP"),
53
+ * // LastUpdatedTimestamp: new Date("TIMESTAMP"),
54
+ * // };
55
+ *
35
56
  * ```
36
57
  *
37
58
  * @param GetContactCommandInput - {@link GetContactCommandInput}
@@ -49,6 +70,8 @@ export interface GetContactCommandOutput extends GetContactResponse, __MetadataB
49
70
  * @throws {@link TooManyRequestsException} (client fault)
50
71
  * <p>Too many requests have been made to the operation.</p>
51
72
  *
73
+ * @throws {@link SESv2ServiceException}
74
+ * <p>Base exception class for all service exceptions from SESv2 service.</p>
52
75
  *
53
76
  */
54
77
  export declare class GetContactCommand extends $Command<GetContactCommandInput, GetContactCommandOutput, SESv2ClientResolvedConfig> {
@@ -32,6 +32,27 @@ export interface GetContactListCommandOutput extends GetContactListResponse, __M
32
32
  * };
33
33
  * const command = new GetContactListCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // GetContactListResponse
36
+ * // ContactListName: "STRING_VALUE",
37
+ * // Topics: [ // Topics
38
+ * // { // Topic
39
+ * // TopicName: "STRING_VALUE", // required
40
+ * // DisplayName: "STRING_VALUE", // required
41
+ * // Description: "STRING_VALUE",
42
+ * // DefaultSubscriptionStatus: "OPT_IN" || "OPT_OUT", // required
43
+ * // },
44
+ * // ],
45
+ * // Description: "STRING_VALUE",
46
+ * // CreatedTimestamp: new Date("TIMESTAMP"),
47
+ * // LastUpdatedTimestamp: new Date("TIMESTAMP"),
48
+ * // Tags: [ // TagList
49
+ * // { // Tag
50
+ * // Key: "STRING_VALUE", // required
51
+ * // Value: "STRING_VALUE", // required
52
+ * // },
53
+ * // ],
54
+ * // };
55
+ *
35
56
  * ```
36
57
  *
37
58
  * @param GetContactListCommandInput - {@link GetContactListCommandInput}
@@ -49,6 +70,8 @@ export interface GetContactListCommandOutput extends GetContactListResponse, __M
49
70
  * @throws {@link TooManyRequestsException} (client fault)
50
71
  * <p>Too many requests have been made to the operation.</p>
51
72
  *
73
+ * @throws {@link SESv2ServiceException}
74
+ * <p>Base exception class for all service exceptions from SESv2 service.</p>
52
75
  *
53
76
  */
54
77
  export declare class GetContactListCommand extends $Command<GetContactListCommandInput, GetContactListCommandOutput, SESv2ClientResolvedConfig> {
@@ -36,6 +36,15 @@ export interface GetCustomVerificationEmailTemplateCommandOutput extends GetCust
36
36
  * };
37
37
  * const command = new GetCustomVerificationEmailTemplateCommand(input);
38
38
  * const response = await client.send(command);
39
+ * // { // GetCustomVerificationEmailTemplateResponse
40
+ * // TemplateName: "STRING_VALUE",
41
+ * // FromEmailAddress: "STRING_VALUE",
42
+ * // TemplateSubject: "STRING_VALUE",
43
+ * // TemplateContent: "STRING_VALUE",
44
+ * // SuccessRedirectionURL: "STRING_VALUE",
45
+ * // FailureRedirectionURL: "STRING_VALUE",
46
+ * // };
47
+ *
39
48
  * ```
40
49
  *
41
50
  * @param GetCustomVerificationEmailTemplateCommandInput - {@link GetCustomVerificationEmailTemplateCommandInput}
@@ -53,6 +62,8 @@ export interface GetCustomVerificationEmailTemplateCommandOutput extends GetCust
53
62
  * @throws {@link TooManyRequestsException} (client fault)
54
63
  * <p>Too many requests have been made to the operation.</p>
55
64
  *
65
+ * @throws {@link SESv2ServiceException}
66
+ * <p>Base exception class for all service exceptions from SESv2 service.</p>
56
67
  *
57
68
  */
58
69
  export declare class GetCustomVerificationEmailTemplateCommand extends $Command<GetCustomVerificationEmailTemplateCommandInput, GetCustomVerificationEmailTemplateCommandOutput, SESv2ClientResolvedConfig> {
@@ -33,6 +33,15 @@ export interface GetDedicatedIpCommandOutput extends GetDedicatedIpResponse, __M
33
33
  * };
34
34
  * const command = new GetDedicatedIpCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // GetDedicatedIpResponse
37
+ * // DedicatedIp: { // DedicatedIp
38
+ * // Ip: "STRING_VALUE", // required
39
+ * // WarmupStatus: "IN_PROGRESS" || "DONE", // required
40
+ * // WarmupPercentage: Number("int"), // required
41
+ * // PoolName: "STRING_VALUE",
42
+ * // },
43
+ * // };
44
+ *
36
45
  * ```
37
46
  *
38
47
  * @param GetDedicatedIpCommandInput - {@link GetDedicatedIpCommandInput}
@@ -50,6 +59,8 @@ export interface GetDedicatedIpCommandOutput extends GetDedicatedIpResponse, __M
50
59
  * @throws {@link TooManyRequestsException} (client fault)
51
60
  * <p>Too many requests have been made to the operation.</p>
52
61
  *
62
+ * @throws {@link SESv2ServiceException}
63
+ * <p>Base exception class for all service exceptions from SESv2 service.</p>
53
64
  *
54
65
  */
55
66
  export declare class GetDedicatedIpCommand extends $Command<GetDedicatedIpCommandInput, GetDedicatedIpCommandOutput, SESv2ClientResolvedConfig> {
@@ -31,6 +31,13 @@ export interface GetDedicatedIpPoolCommandOutput extends GetDedicatedIpPoolRespo
31
31
  * };
32
32
  * const command = new GetDedicatedIpPoolCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // GetDedicatedIpPoolResponse
35
+ * // DedicatedIpPool: { // DedicatedIpPool
36
+ * // PoolName: "STRING_VALUE", // required
37
+ * // ScalingMode: "STANDARD" || "MANAGED", // required
38
+ * // },
39
+ * // };
40
+ *
34
41
  * ```
35
42
  *
36
43
  * @param GetDedicatedIpPoolCommandInput - {@link GetDedicatedIpPoolCommandInput}
@@ -48,6 +55,8 @@ export interface GetDedicatedIpPoolCommandOutput extends GetDedicatedIpPoolRespo
48
55
  * @throws {@link TooManyRequestsException} (client fault)
49
56
  * <p>Too many requests have been made to the operation.</p>
50
57
  *
58
+ * @throws {@link SESv2ServiceException}
59
+ * <p>Base exception class for all service exceptions from SESv2 service.</p>
51
60
  *
52
61
  */
53
62
  export declare class GetDedicatedIpPoolCommand extends $Command<GetDedicatedIpPoolCommandInput, GetDedicatedIpPoolCommandOutput, SESv2ClientResolvedConfig> {
@@ -34,6 +34,18 @@ export interface GetDedicatedIpsCommandOutput extends GetDedicatedIpsResponse, _
34
34
  * };
35
35
  * const command = new GetDedicatedIpsCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // GetDedicatedIpsResponse
38
+ * // DedicatedIps: [ // DedicatedIpList
39
+ * // { // DedicatedIp
40
+ * // Ip: "STRING_VALUE", // required
41
+ * // WarmupStatus: "IN_PROGRESS" || "DONE", // required
42
+ * // WarmupPercentage: Number("int"), // required
43
+ * // PoolName: "STRING_VALUE",
44
+ * // },
45
+ * // ],
46
+ * // NextToken: "STRING_VALUE",
47
+ * // };
48
+ *
37
49
  * ```
38
50
  *
39
51
  * @param GetDedicatedIpsCommandInput - {@link GetDedicatedIpsCommandInput}
@@ -51,6 +63,8 @@ export interface GetDedicatedIpsCommandOutput extends GetDedicatedIpsResponse, _
51
63
  * @throws {@link TooManyRequestsException} (client fault)
52
64
  * <p>Too many requests have been made to the operation.</p>
53
65
  *
66
+ * @throws {@link SESv2ServiceException}
67
+ * <p>Base exception class for all service exceptions from SESv2 service.</p>
54
68
  *
55
69
  */
56
70
  export declare class GetDedicatedIpsCommand extends $Command<GetDedicatedIpsCommandInput, GetDedicatedIpsCommandOutput, SESv2ClientResolvedConfig> {
@@ -35,6 +35,36 @@ export interface GetDeliverabilityDashboardOptionsCommandOutput extends GetDeliv
35
35
  * const input = {};
36
36
  * const command = new GetDeliverabilityDashboardOptionsCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // { // GetDeliverabilityDashboardOptionsResponse
39
+ * // DashboardEnabled: true || false, // required
40
+ * // SubscriptionExpiryDate: new Date("TIMESTAMP"),
41
+ * // AccountStatus: "ACTIVE" || "PENDING_EXPIRATION" || "DISABLED",
42
+ * // ActiveSubscribedDomains: [ // DomainDeliverabilityTrackingOptions
43
+ * // { // DomainDeliverabilityTrackingOption
44
+ * // Domain: "STRING_VALUE",
45
+ * // SubscriptionStartDate: new Date("TIMESTAMP"),
46
+ * // InboxPlacementTrackingOption: { // InboxPlacementTrackingOption
47
+ * // Global: true || false,
48
+ * // TrackedIsps: [ // IspNameList
49
+ * // "STRING_VALUE",
50
+ * // ],
51
+ * // },
52
+ * // },
53
+ * // ],
54
+ * // PendingExpirationSubscribedDomains: [
55
+ * // {
56
+ * // Domain: "STRING_VALUE",
57
+ * // SubscriptionStartDate: new Date("TIMESTAMP"),
58
+ * // InboxPlacementTrackingOption: {
59
+ * // Global: true || false,
60
+ * // TrackedIsps: [
61
+ * // "STRING_VALUE",
62
+ * // ],
63
+ * // },
64
+ * // },
65
+ * // ],
66
+ * // };
67
+ *
38
68
  * ```
39
69
  *
40
70
  * @param GetDeliverabilityDashboardOptionsCommandInput - {@link GetDeliverabilityDashboardOptionsCommandInput}
@@ -52,6 +82,8 @@ export interface GetDeliverabilityDashboardOptionsCommandOutput extends GetDeliv
52
82
  * @throws {@link TooManyRequestsException} (client fault)
53
83
  * <p>Too many requests have been made to the operation.</p>
54
84
  *
85
+ * @throws {@link SESv2ServiceException}
86
+ * <p>Base exception class for all service exceptions from SESv2 service.</p>
55
87
  *
56
88
  */
57
89
  export declare class GetDeliverabilityDashboardOptionsCommand extends $Command<GetDeliverabilityDashboardOptionsCommandInput, GetDeliverabilityDashboardOptionsCommandOutput, SESv2ClientResolvedConfig> {
@@ -31,6 +31,43 @@ export interface GetDeliverabilityTestReportCommandOutput extends GetDeliverabil
31
31
  * };
32
32
  * const command = new GetDeliverabilityTestReportCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // GetDeliverabilityTestReportResponse
35
+ * // DeliverabilityTestReport: { // DeliverabilityTestReport
36
+ * // ReportId: "STRING_VALUE",
37
+ * // ReportName: "STRING_VALUE",
38
+ * // Subject: "STRING_VALUE",
39
+ * // FromEmailAddress: "STRING_VALUE",
40
+ * // CreateDate: new Date("TIMESTAMP"),
41
+ * // DeliverabilityTestStatus: "IN_PROGRESS" || "COMPLETED",
42
+ * // },
43
+ * // OverallPlacement: { // PlacementStatistics
44
+ * // InboxPercentage: Number("double"),
45
+ * // SpamPercentage: Number("double"),
46
+ * // MissingPercentage: Number("double"),
47
+ * // SpfPercentage: Number("double"),
48
+ * // DkimPercentage: Number("double"),
49
+ * // },
50
+ * // IspPlacements: [ // IspPlacements // required
51
+ * // { // IspPlacement
52
+ * // IspName: "STRING_VALUE",
53
+ * // PlacementStatistics: {
54
+ * // InboxPercentage: Number("double"),
55
+ * // SpamPercentage: Number("double"),
56
+ * // MissingPercentage: Number("double"),
57
+ * // SpfPercentage: Number("double"),
58
+ * // DkimPercentage: Number("double"),
59
+ * // },
60
+ * // },
61
+ * // ],
62
+ * // Message: "STRING_VALUE",
63
+ * // Tags: [ // TagList
64
+ * // { // Tag
65
+ * // Key: "STRING_VALUE", // required
66
+ * // Value: "STRING_VALUE", // required
67
+ * // },
68
+ * // ],
69
+ * // };
70
+ *
34
71
  * ```
35
72
  *
36
73
  * @param GetDeliverabilityTestReportCommandInput - {@link GetDeliverabilityTestReportCommandInput}
@@ -48,6 +85,8 @@ export interface GetDeliverabilityTestReportCommandOutput extends GetDeliverabil
48
85
  * @throws {@link TooManyRequestsException} (client fault)
49
86
  * <p>Too many requests have been made to the operation.</p>
50
87
  *
88
+ * @throws {@link SESv2ServiceException}
89
+ * <p>Base exception class for all service exceptions from SESv2 service.</p>
51
90
  *
52
91
  */
53
92
  export declare class GetDeliverabilityTestReportCommand extends $Command<GetDeliverabilityTestReportCommandInput, GetDeliverabilityTestReportCommandOutput, SESv2ClientResolvedConfig> {
@@ -33,6 +33,29 @@ export interface GetDomainDeliverabilityCampaignCommandOutput extends GetDomainD
33
33
  * };
34
34
  * const command = new GetDomainDeliverabilityCampaignCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // GetDomainDeliverabilityCampaignResponse
37
+ * // DomainDeliverabilityCampaign: { // DomainDeliverabilityCampaign
38
+ * // CampaignId: "STRING_VALUE",
39
+ * // ImageUrl: "STRING_VALUE",
40
+ * // Subject: "STRING_VALUE",
41
+ * // FromAddress: "STRING_VALUE",
42
+ * // SendingIps: [ // IpList
43
+ * // "STRING_VALUE",
44
+ * // ],
45
+ * // FirstSeenDateTime: new Date("TIMESTAMP"),
46
+ * // LastSeenDateTime: new Date("TIMESTAMP"),
47
+ * // InboxCount: Number("long"),
48
+ * // SpamCount: Number("long"),
49
+ * // ReadRate: Number("double"),
50
+ * // DeleteRate: Number("double"),
51
+ * // ReadDeleteRate: Number("double"),
52
+ * // ProjectedVolume: Number("long"),
53
+ * // Esps: [ // Esps
54
+ * // "STRING_VALUE",
55
+ * // ],
56
+ * // },
57
+ * // };
58
+ *
36
59
  * ```
37
60
  *
38
61
  * @param GetDomainDeliverabilityCampaignCommandInput - {@link GetDomainDeliverabilityCampaignCommandInput}
@@ -50,6 +73,8 @@ export interface GetDomainDeliverabilityCampaignCommandOutput extends GetDomainD
50
73
  * @throws {@link TooManyRequestsException} (client fault)
51
74
  * <p>Too many requests have been made to the operation.</p>
52
75
  *
76
+ * @throws {@link SESv2ServiceException}
77
+ * <p>Base exception class for all service exceptions from SESv2 service.</p>
53
78
  *
54
79
  */
55
80
  export declare class GetDomainDeliverabilityCampaignCommand extends $Command<GetDomainDeliverabilityCampaignCommandInput, GetDomainDeliverabilityCampaignCommandOutput, SESv2ClientResolvedConfig> {
@@ -34,6 +34,47 @@ export interface GetDomainStatisticsReportCommandOutput extends GetDomainStatist
34
34
  * };
35
35
  * const command = new GetDomainStatisticsReportCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // GetDomainStatisticsReportResponse
38
+ * // OverallVolume: { // OverallVolume
39
+ * // VolumeStatistics: { // VolumeStatistics
40
+ * // InboxRawCount: Number("long"),
41
+ * // SpamRawCount: Number("long"),
42
+ * // ProjectedInbox: Number("long"),
43
+ * // ProjectedSpam: Number("long"),
44
+ * // },
45
+ * // ReadRatePercent: Number("double"),
46
+ * // DomainIspPlacements: [ // DomainIspPlacements
47
+ * // { // DomainIspPlacement
48
+ * // IspName: "STRING_VALUE",
49
+ * // InboxRawCount: Number("long"),
50
+ * // SpamRawCount: Number("long"),
51
+ * // InboxPercentage: Number("double"),
52
+ * // SpamPercentage: Number("double"),
53
+ * // },
54
+ * // ],
55
+ * // },
56
+ * // DailyVolumes: [ // DailyVolumes // required
57
+ * // { // DailyVolume
58
+ * // StartDate: new Date("TIMESTAMP"),
59
+ * // VolumeStatistics: {
60
+ * // InboxRawCount: Number("long"),
61
+ * // SpamRawCount: Number("long"),
62
+ * // ProjectedInbox: Number("long"),
63
+ * // ProjectedSpam: Number("long"),
64
+ * // },
65
+ * // DomainIspPlacements: [
66
+ * // {
67
+ * // IspName: "STRING_VALUE",
68
+ * // InboxRawCount: Number("long"),
69
+ * // SpamRawCount: Number("long"),
70
+ * // InboxPercentage: Number("double"),
71
+ * // SpamPercentage: Number("double"),
72
+ * // },
73
+ * // ],
74
+ * // },
75
+ * // ],
76
+ * // };
77
+ *
37
78
  * ```
38
79
  *
39
80
  * @param GetDomainStatisticsReportCommandInput - {@link GetDomainStatisticsReportCommandInput}
@@ -51,6 +92,8 @@ export interface GetDomainStatisticsReportCommandOutput extends GetDomainStatist
51
92
  * @throws {@link TooManyRequestsException} (client fault)
52
93
  * <p>Too many requests have been made to the operation.</p>
53
94
  *
95
+ * @throws {@link SESv2ServiceException}
96
+ * <p>Base exception class for all service exceptions from SESv2 service.</p>
54
97
  *
55
98
  */
56
99
  export declare class GetDomainStatisticsReportCommand extends $Command<GetDomainStatisticsReportCommandInput, GetDomainStatisticsReportCommandOutput, SESv2ClientResolvedConfig> {
@@ -33,6 +33,39 @@ export interface GetEmailIdentityCommandOutput extends GetEmailIdentityResponse,
33
33
  * };
34
34
  * const command = new GetEmailIdentityCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // GetEmailIdentityResponse
37
+ * // IdentityType: "EMAIL_ADDRESS" || "DOMAIN" || "MANAGED_DOMAIN",
38
+ * // FeedbackForwardingStatus: true || false,
39
+ * // VerifiedForSendingStatus: true || false,
40
+ * // DkimAttributes: { // DkimAttributes
41
+ * // SigningEnabled: true || false,
42
+ * // Status: "PENDING" || "SUCCESS" || "FAILED" || "TEMPORARY_FAILURE" || "NOT_STARTED",
43
+ * // Tokens: [ // DnsTokenList
44
+ * // "STRING_VALUE",
45
+ * // ],
46
+ * // SigningAttributesOrigin: "AWS_SES" || "EXTERNAL",
47
+ * // NextSigningKeyLength: "RSA_1024_BIT" || "RSA_2048_BIT",
48
+ * // CurrentSigningKeyLength: "RSA_1024_BIT" || "RSA_2048_BIT",
49
+ * // LastKeyGenerationTimestamp: new Date("TIMESTAMP"),
50
+ * // },
51
+ * // MailFromAttributes: { // MailFromAttributes
52
+ * // MailFromDomain: "STRING_VALUE", // required
53
+ * // MailFromDomainStatus: "PENDING" || "SUCCESS" || "FAILED" || "TEMPORARY_FAILURE", // required
54
+ * // BehaviorOnMxFailure: "USE_DEFAULT_VALUE" || "REJECT_MESSAGE", // required
55
+ * // },
56
+ * // Policies: { // PolicyMap
57
+ * // "<keys>": "STRING_VALUE",
58
+ * // },
59
+ * // Tags: [ // TagList
60
+ * // { // Tag
61
+ * // Key: "STRING_VALUE", // required
62
+ * // Value: "STRING_VALUE", // required
63
+ * // },
64
+ * // ],
65
+ * // ConfigurationSetName: "STRING_VALUE",
66
+ * // VerificationStatus: "PENDING" || "SUCCESS" || "FAILED" || "TEMPORARY_FAILURE" || "NOT_STARTED",
67
+ * // };
68
+ *
36
69
  * ```
37
70
  *
38
71
  * @param GetEmailIdentityCommandInput - {@link GetEmailIdentityCommandInput}
@@ -50,6 +83,8 @@ export interface GetEmailIdentityCommandOutput extends GetEmailIdentityResponse,
50
83
  * @throws {@link TooManyRequestsException} (client fault)
51
84
  * <p>Too many requests have been made to the operation.</p>
52
85
  *
86
+ * @throws {@link SESv2ServiceException}
87
+ * <p>Base exception class for all service exceptions from SESv2 service.</p>
53
88
  *
54
89
  */
55
90
  export declare class GetEmailIdentityCommand extends $Command<GetEmailIdentityCommandInput, GetEmailIdentityCommandOutput, SESv2ClientResolvedConfig> {
@@ -42,6 +42,12 @@ export interface GetEmailIdentityPoliciesCommandOutput extends GetEmailIdentityP
42
42
  * };
43
43
  * const command = new GetEmailIdentityPoliciesCommand(input);
44
44
  * const response = await client.send(command);
45
+ * // { // GetEmailIdentityPoliciesResponse
46
+ * // Policies: { // PolicyMap
47
+ * // "<keys>": "STRING_VALUE",
48
+ * // },
49
+ * // };
50
+ *
45
51
  * ```
46
52
  *
47
53
  * @param GetEmailIdentityPoliciesCommandInput - {@link GetEmailIdentityPoliciesCommandInput}
@@ -59,6 +65,8 @@ export interface GetEmailIdentityPoliciesCommandOutput extends GetEmailIdentityP
59
65
  * @throws {@link TooManyRequestsException} (client fault)
60
66
  * <p>Too many requests have been made to the operation.</p>
61
67
  *
68
+ * @throws {@link SESv2ServiceException}
69
+ * <p>Base exception class for all service exceptions from SESv2 service.</p>
62
70
  *
63
71
  */
64
72
  export declare class GetEmailIdentityPoliciesCommand extends $Command<GetEmailIdentityPoliciesCommandInput, GetEmailIdentityPoliciesCommandOutput, SESv2ClientResolvedConfig> {
@@ -33,6 +33,15 @@ export interface GetEmailTemplateCommandOutput extends GetEmailTemplateResponse,
33
33
  * };
34
34
  * const command = new GetEmailTemplateCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // GetEmailTemplateResponse
37
+ * // TemplateName: "STRING_VALUE", // required
38
+ * // TemplateContent: { // EmailTemplateContent
39
+ * // Subject: "STRING_VALUE",
40
+ * // Text: "STRING_VALUE",
41
+ * // Html: "STRING_VALUE",
42
+ * // },
43
+ * // };
44
+ *
36
45
  * ```
37
46
  *
38
47
  * @param GetEmailTemplateCommandInput - {@link GetEmailTemplateCommandInput}
@@ -50,6 +59,8 @@ export interface GetEmailTemplateCommandOutput extends GetEmailTemplateResponse,
50
59
  * @throws {@link TooManyRequestsException} (client fault)
51
60
  * <p>Too many requests have been made to the operation.</p>
52
61
  *
62
+ * @throws {@link SESv2ServiceException}
63
+ * <p>Base exception class for all service exceptions from SESv2 service.</p>
53
64
  *
54
65
  */
55
66
  export declare class GetEmailTemplateCommand extends $Command<GetEmailTemplateCommandInput, GetEmailTemplateCommandOutput, SESv2ClientResolvedConfig> {
@@ -31,6 +31,32 @@ export interface GetImportJobCommandOutput extends GetImportJobResponse, __Metad
31
31
  * };
32
32
  * const command = new GetImportJobCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // GetImportJobResponse
35
+ * // JobId: "STRING_VALUE",
36
+ * // ImportDestination: { // ImportDestination
37
+ * // SuppressionListDestination: { // SuppressionListDestination
38
+ * // SuppressionListImportAction: "DELETE" || "PUT", // required
39
+ * // },
40
+ * // ContactListDestination: { // ContactListDestination
41
+ * // ContactListName: "STRING_VALUE", // required
42
+ * // ContactListImportAction: "DELETE" || "PUT", // required
43
+ * // },
44
+ * // },
45
+ * // ImportDataSource: { // ImportDataSource
46
+ * // S3Url: "STRING_VALUE", // required
47
+ * // DataFormat: "CSV" || "JSON", // required
48
+ * // },
49
+ * // FailureInfo: { // FailureInfo
50
+ * // FailedRecordsS3Url: "STRING_VALUE",
51
+ * // ErrorMessage: "STRING_VALUE",
52
+ * // },
53
+ * // JobStatus: "CREATED" || "PROCESSING" || "COMPLETED" || "FAILED",
54
+ * // CreatedTimestamp: new Date("TIMESTAMP"),
55
+ * // CompletedTimestamp: new Date("TIMESTAMP"),
56
+ * // ProcessedRecordsCount: Number("int"),
57
+ * // FailedRecordsCount: Number("int"),
58
+ * // };
59
+ *
34
60
  * ```
35
61
  *
36
62
  * @param GetImportJobCommandInput - {@link GetImportJobCommandInput}
@@ -48,6 +74,8 @@ export interface GetImportJobCommandOutput extends GetImportJobResponse, __Metad
48
74
  * @throws {@link TooManyRequestsException} (client fault)
49
75
  * <p>Too many requests have been made to the operation.</p>
50
76
  *
77
+ * @throws {@link SESv2ServiceException}
78
+ * <p>Base exception class for all service exceptions from SESv2 service.</p>
51
79
  *
52
80
  */
53
81
  export declare class GetImportJobCommand extends $Command<GetImportJobCommandInput, GetImportJobCommandOutput, SESv2ClientResolvedConfig> {
@@ -32,6 +32,18 @@ export interface GetSuppressedDestinationCommandOutput extends GetSuppressedDest
32
32
  * };
33
33
  * const command = new GetSuppressedDestinationCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // GetSuppressedDestinationResponse
36
+ * // SuppressedDestination: { // SuppressedDestination
37
+ * // EmailAddress: "STRING_VALUE", // required
38
+ * // Reason: "BOUNCE" || "COMPLAINT", // required
39
+ * // LastUpdateTime: new Date("TIMESTAMP"), // required
40
+ * // Attributes: { // SuppressedDestinationAttributes
41
+ * // MessageId: "STRING_VALUE",
42
+ * // FeedbackId: "STRING_VALUE",
43
+ * // },
44
+ * // },
45
+ * // };
46
+ *
35
47
  * ```
36
48
  *
37
49
  * @param GetSuppressedDestinationCommandInput - {@link GetSuppressedDestinationCommandInput}
@@ -49,6 +61,8 @@ export interface GetSuppressedDestinationCommandOutput extends GetSuppressedDest
49
61
  * @throws {@link TooManyRequestsException} (client fault)
50
62
  * <p>Too many requests have been made to the operation.</p>
51
63
  *
64
+ * @throws {@link SESv2ServiceException}
65
+ * <p>Base exception class for all service exceptions from SESv2 service.</p>
52
66
  *
53
67
  */
54
68
  export declare class GetSuppressedDestinationCommand extends $Command<GetSuppressedDestinationCommandInput, GetSuppressedDestinationCommandOutput, SESv2ClientResolvedConfig> {
@@ -38,6 +38,13 @@ export interface ListConfigurationSetsCommandOutput extends ListConfigurationSet
38
38
  * };
39
39
  * const command = new ListConfigurationSetsCommand(input);
40
40
  * const response = await client.send(command);
41
+ * // { // ListConfigurationSetsResponse
42
+ * // ConfigurationSets: [ // ConfigurationSetNameList
43
+ * // "STRING_VALUE",
44
+ * // ],
45
+ * // NextToken: "STRING_VALUE",
46
+ * // };
47
+ *
41
48
  * ```
42
49
  *
43
50
  * @param ListConfigurationSetsCommandInput - {@link ListConfigurationSetsCommandInput}
@@ -52,6 +59,8 @@ export interface ListConfigurationSetsCommandOutput extends ListConfigurationSet
52
59
  * @throws {@link TooManyRequestsException} (client fault)
53
60
  * <p>Too many requests have been made to the operation.</p>
54
61
  *
62
+ * @throws {@link SESv2ServiceException}
63
+ * <p>Base exception class for all service exceptions from SESv2 service.</p>
55
64
  *
56
65
  */
57
66
  export declare class ListConfigurationSetsCommand extends $Command<ListConfigurationSetsCommandInput, ListConfigurationSetsCommandOutput, SESv2ClientResolvedConfig> {
@@ -32,6 +32,16 @@ export interface ListContactListsCommandOutput extends ListContactListsResponse,
32
32
  * };
33
33
  * const command = new ListContactListsCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // ListContactListsResponse
36
+ * // ContactLists: [ // ListOfContactLists
37
+ * // { // ContactList
38
+ * // ContactListName: "STRING_VALUE",
39
+ * // LastUpdatedTimestamp: new Date("TIMESTAMP"),
40
+ * // },
41
+ * // ],
42
+ * // NextToken: "STRING_VALUE",
43
+ * // };
44
+ *
35
45
  * ```
36
46
  *
37
47
  * @param ListContactListsCommandInput - {@link ListContactListsCommandInput}
@@ -46,6 +56,8 @@ export interface ListContactListsCommandOutput extends ListContactListsResponse,
46
56
  * @throws {@link TooManyRequestsException} (client fault)
47
57
  * <p>Too many requests have been made to the operation.</p>
48
58
  *
59
+ * @throws {@link SESv2ServiceException}
60
+ * <p>Base exception class for all service exceptions from SESv2 service.</p>
49
61
  *
50
62
  */
51
63
  export declare class ListContactListsCommand extends $Command<ListContactListsCommandInput, ListContactListsCommandOutput, SESv2ClientResolvedConfig> {
@@ -40,6 +40,29 @@ export interface ListContactsCommandOutput extends ListContactsResponse, __Metad
40
40
  * };
41
41
  * const command = new ListContactsCommand(input);
42
42
  * const response = await client.send(command);
43
+ * // { // ListContactsResponse
44
+ * // Contacts: [ // ListOfContacts
45
+ * // { // Contact
46
+ * // EmailAddress: "STRING_VALUE",
47
+ * // TopicPreferences: [ // TopicPreferenceList
48
+ * // { // TopicPreference
49
+ * // TopicName: "STRING_VALUE", // required
50
+ * // SubscriptionStatus: "OPT_IN" || "OPT_OUT", // required
51
+ * // },
52
+ * // ],
53
+ * // TopicDefaultPreferences: [
54
+ * // {
55
+ * // TopicName: "STRING_VALUE", // required
56
+ * // SubscriptionStatus: "OPT_IN" || "OPT_OUT", // required
57
+ * // },
58
+ * // ],
59
+ * // UnsubscribeAll: true || false,
60
+ * // LastUpdatedTimestamp: new Date("TIMESTAMP"),
61
+ * // },
62
+ * // ],
63
+ * // NextToken: "STRING_VALUE",
64
+ * // };
65
+ *
43
66
  * ```
44
67
  *
45
68
  * @param ListContactsCommandInput - {@link ListContactsCommandInput}
@@ -57,6 +80,8 @@ export interface ListContactsCommandOutput extends ListContactsResponse, __Metad
57
80
  * @throws {@link TooManyRequestsException} (client fault)
58
81
  * <p>Too many requests have been made to the operation.</p>
59
82
  *
83
+ * @throws {@link SESv2ServiceException}
84
+ * <p>Base exception class for all service exceptions from SESv2 service.</p>
60
85
  *
61
86
  */
62
87
  export declare class ListContactsCommand extends $Command<ListContactsCommandInput, ListContactsCommandOutput, SESv2ClientResolvedConfig> {