@aws-sdk/client-sesv2 3.402.0 → 3.403.0

package/dist-types/commands/CancelExportJobCommand.d.ts

@@ -57,6 +57,17 @@ export interface CancelExportJobCommandOutput extends CancelExportJobResponse, _
  * @throws {@link SESv2ServiceException}
  * <p>Base exception class for all service exceptions from SESv2 service.</p>
  *
+ * @example Cancel export job
+ * ```javascript
+ * // Cancels the export job with ID ef28cf62-9d8e-4b60-9283-b09816c99a99
+ * const input = {
+ *   "JobId": "ef28cf62-9d8e-4b60-9283-b09816c99a99"
+ * };
+ * const command = new CancelExportJobCommand(input);
+ * await client.send(command);
+ * // example id: cancel-export-job-1685699696331
+ * ```
+ *
  */
 export declare class CancelExportJobCommand extends $Command<CancelExportJobCommandInput, CancelExportJobCommandOutput, SESv2ClientResolvedConfig> {
     readonly input: CancelExportJobCommandInput;

package/dist-types/commands/CreateExportJobCommand.d.ts

@@ -129,6 +129,84 @@ export interface CreateExportJobCommandOutput extends CreateExportJobResponse, _
  * @throws {@link SESv2ServiceException}
  * <p>Base exception class for all service exceptions from SESv2 service.</p>
  *
+ * @example Create Metrics export job
+ * ```javascript
+ * // Creates a new export job for Metrics data
+ * const input = {
+ *   "ExportDataSource": {
+ *     "MetricsDataSource": {
+ *       "Dimensions": {
+ *         "ISP": [
+ *           "*"
+ *         ]
+ *       },
+ *       "EndDate": "2023-07-02T00:00:00",
+ *       "Metrics": [
+ *         {
+ *           "Aggregation": "VOLUME",
+ *           "Name": "SEND"
+ *         },
+ *         {
+ *           "Aggregation": "VOLUME",
+ *           "Name": "COMPLAINT"
+ *         },
+ *         {
+ *           "Aggregation": "RATE",
+ *           "Name": "COMPLAINT"
+ *         }
+ *       ],
+ *       "Namespace": "VDM",
+ *       "StartDate": "2023-07-01T00:00:00"
+ *     }
+ *   },
+ *   "ExportDestination": {
+ *     "DataFormat": "CSV"
+ *   }
+ * };
+ * const command = new CreateExportJobCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "JobId": "ef28cf62-9d8e-4b60-9283-b09816c99a99"
+ * }
+ * *\/
+ * // example id: create-export-job-1685701853690
+ * ```
+ *
+ * @example Create Message Insights export job
+ * ```javascript
+ * // Creates a new export job for Message Insights data
+ * const input = {
+ *   "ExportDataSource": {
+ *     "MessageInsightsDataSource": {
+ *       "EndDate": "2023-07-02T00:00:00",
+ *       "Exclude": {
+ *         "FromEmailAddress": [
+ *           "hello@example.com"
+ *         ]
+ *       },
+ *       "Include": {
+ *         "Subject": [
+ *           "Hello"
+ *         ]
+ *       },
+ *       "StartDate": "2023-07-01T00:00:00"
+ *     }
+ *   },
+ *   "ExportDestination": {
+ *     "DataFormat": "CSV"
+ *   }
+ * };
+ * const command = new CreateExportJobCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "JobId": "ef28cf62-9d8e-4b60-9283-b09816c99a99"
+ * }
+ * *\/
+ * // example id: create-export-job-1689957853323
+ * ```
+ *
  */
 export declare class CreateExportJobCommand extends $Command<CreateExportJobCommandInput, CreateExportJobCommandOutput, SESv2ClientResolvedConfig> {
     readonly input: CreateExportJobCommandInput;

package/dist-types/commands/GetExportJobCommand.d.ts

@@ -138,6 +138,58 @@ export interface GetExportJobCommandOutput extends GetExportJobResponse, __Metad
  * @throws {@link SESv2ServiceException}
  * <p>Base exception class for all service exceptions from SESv2 service.</p>
  *
+ * @example Get export job
+ * ```javascript
+ * // Gets the export job with ID ef28cf62-9d8e-4b60-9283-b09816c99a99
+ * const input = {
+ *   "JobId": "ef28cf62-9d8e-4b60-9283-b09816c99a99"
+ * };
+ * const command = new GetExportJobCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "CreatedTimestamp": "1685700961057",
+ *   "ExportDataSource": {
+ *     "MetricsDataSource": {
+ *       "Dimensions": {
+ *         "ISP": [
+ *           "*"
+ *         ]
+ *       },
+ *       "EndDate": "1675209600000",
+ *       "Metrics": [
+ *         {
+ *           "Aggregation": "VOLUME",
+ *           "Name": "SEND"
+ *         },
+ *         {
+ *           "Aggregation": "VOLUME",
+ *           "Name": "COMPLAINT"
+ *         },
+ *         {
+ *           "Aggregation": "RATE",
+ *           "Name": "COMPLAINT"
+ *         }
+ *       ],
+ *       "Namespace": "VDM",
+ *       "StartDate": "1672531200000"
+ *     }
+ *   },
+ *   "ExportDestination": {
+ *     "DataFormat": "CSV"
+ *   },
+ *   "ExportSourceType": "METRICS_DATA",
+ *   "JobId": "ef28cf62-9d8e-4b60-9283-b09816c99a99",
+ *   "JobStatus": "PROCESSING",
+ *   "Statistics": {
+ *     "ExportedRecordsCount": 5,
+ *     "ProcessedRecordsCount": 5
+ *   }
+ * }
+ * *\/
+ * // example id: get-export-job-1685699942772
+ * ```
+ *
  */
 export declare class GetExportJobCommand extends $Command<GetExportJobCommandInput, GetExportJobCommandOutput, SESv2ClientResolvedConfig> {
     readonly input: GetExportJobCommandInput;

package/dist-types/commands/GetMessageInsightsCommand.d.ts

@@ -92,6 +92,66 @@ export interface GetMessageInsightsCommandOutput extends GetMessageInsightsRespo
  * @throws {@link SESv2ServiceException}
  * <p>Base exception class for all service exceptions from SESv2 service.</p>
  *
+ * @example Get Message Insights
+ * ```javascript
+ * // Provides information about a specific message.
+ * const input = {
+ *   "MessageId": "000000000000ab00-0a000aa0-1234-0a0a-1234-0a0aaa0aa00a-000000"
+ * };
+ * const command = new GetMessageInsightsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "EmailTags": [
+ *     {
+ *       "Name": "ses:operation",
+ *       "Value": "SendEmail"
+ *     },
+ *     {
+ *       "Name": "ses:recipient-isp",
+ *       "Value": "UNKNOWN_ISP"
+ *     },
+ *     {
+ *       "Name": "ses:source-ip",
+ *       "Value": "0.0.0.0"
+ *     },
+ *     {
+ *       "Name": "ses:from-domain",
+ *       "Value": "example.com"
+ *     },
+ *     {
+ *       "Name": "ses:sender-identity",
+ *       "Value": "hello@example.com"
+ *     },
+ *     {
+ *       "Name": "ses:caller-identity",
+ *       "Value": "Identity"
+ *     }
+ *   ],
+ *   "FromEmailAddress": "hello@example.com",
+ *   "Insights": [
+ *     {
+ *       "Destination": "recipient@example.com",
+ *       "Events": [
+ *         {
+ *           "Timestamp": "2023-01-01T00:00:00.000000+01:00",
+ *           "Type": "SEND"
+ *         },
+ *         {
+ *           "Timestamp": "2023-01-01T00:00:01.000000+01:00",
+ *           "Type": "DELIVERY"
+ *         }
+ *       ],
+ *       "Isp": "UNKNOWN_ISP"
+ *     }
+ *   ],
+ *   "MessageId": "000000000000ab00-0a000aa0-1234-0a0a-1234-0a0aaa0aa00a-000000",
+ *   "Subject": "hello"
+ * }
+ * *\/
+ * // example id: get-message-insights-1689955713493
+ * ```
+ *
  */
 export declare class GetMessageInsightsCommand extends $Command<GetMessageInsightsCommandInput, GetMessageInsightsCommandOutput, SESv2ClientResolvedConfig> {
     readonly input: GetMessageInsightsCommandInput;

package/dist-types/commands/ListExportJobsCommand.d.ts

@@ -68,6 +68,31 @@ export interface ListExportJobsCommandOutput extends ListExportJobsResponse, __M
  * @throws {@link SESv2ServiceException}
  * <p>Base exception class for all service exceptions from SESv2 service.</p>
  *
+ * @example List export jobs
+ * ```javascript
+ * // Lists export jobs of type METRICS_DATA and status PROCESSING
+ * const input = {
+ *   "ExportSourceType": "METRICS_DATA",
+ *   "JobStatus": "PROCESSING",
+ *   "PageSize": 25
+ * };
+ * const command = new ListExportJobsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "ExportJobs": [
+ *     {
+ *       "CreatedTimestamp": "167697473543",
+ *       "ExportSourceType": "METRICS_DATA",
+ *       "JobId": "72de83a0-6b49-47ca-9783-8b812576887a",
+ *       "JobStatus": "PROCESSING"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: list-export-jobs-1685702074256
+ * ```
+ *
  */
 export declare class ListExportJobsCommand extends $Command<ListExportJobsCommandInput, ListExportJobsCommandOutput, SESv2ClientResolvedConfig> {
     readonly input: ListExportJobsCommandInput;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-sesv2",
   "description": "AWS SDK for JavaScript Sesv2 Client for Node.js, Browser and React Native",
-  "version": "3.402.0",
+  "version": "3.403.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",