@aws-sdk/client-sesv2 3.398.0 → 3.403.0

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

@@ -0,0 +1,91 @@
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
+import { CancelExportJobRequest, CancelExportJobResponse } from "../models/models_0";
+import { ServiceInputTypes, ServiceOutputTypes, SESv2ClientResolvedConfig } from "../SESv2Client";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link CancelExportJobCommand}.
+ */
+export interface CancelExportJobCommandInput extends CancelExportJobRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link CancelExportJobCommand}.
+ */
+export interface CancelExportJobCommandOutput extends CancelExportJobResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Cancels an export job.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { SESv2Client, CancelExportJobCommand } from "@aws-sdk/client-sesv2"; // ES Modules import
+ * // const { SESv2Client, CancelExportJobCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import
+ * const client = new SESv2Client(config);
+ * const input = { // CancelExportJobRequest
+ *   JobId: "STRING_VALUE", // required
+ * };
+ * const command = new CancelExportJobCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param CancelExportJobCommandInput - {@link CancelExportJobCommandInput}
+ * @returns {@link CancelExportJobCommandOutput}
+ * @see {@link CancelExportJobCommandInput} for command's `input` shape.
+ * @see {@link CancelExportJobCommandOutput} for command's `response` shape.
+ * @see {@link SESv2ClientResolvedConfig | config} for SESv2Client's `config` shape.
+ *
+ * @throws {@link BadRequestException} (client fault)
+ *  <p>The input you provided is invalid.</p>
+ *
+ * @throws {@link NotFoundException} (client fault)
+ *  <p>The resource you attempted to access doesn't exist.</p>
+ *
+ * @throws {@link TooManyRequestsException} (client fault)
+ *  <p>Too many requests have been made to the operation.</p>
+ *
+ * @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;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: CancelExportJobCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SESv2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CancelExportJobCommandInput, CancelExportJobCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -0,0 +1,230 @@
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
+import { CreateExportJobRequest, CreateExportJobResponse } from "../models/models_0";
+import { ServiceInputTypes, ServiceOutputTypes, SESv2ClientResolvedConfig } from "../SESv2Client";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link CreateExportJobCommand}.
+ */
+export interface CreateExportJobCommandInput extends CreateExportJobRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link CreateExportJobCommand}.
+ */
+export interface CreateExportJobCommandOutput extends CreateExportJobResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Creates an export job for a data source and destination.</p>
+ *          <p>You can execute this operation no more than once per second.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { SESv2Client, CreateExportJobCommand } from "@aws-sdk/client-sesv2"; // ES Modules import
+ * // const { SESv2Client, CreateExportJobCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import
+ * const client = new SESv2Client(config);
+ * const input = { // CreateExportJobRequest
+ *   ExportDataSource: { // ExportDataSource
+ *     MetricsDataSource: { // MetricsDataSource
+ *       Dimensions: { // ExportDimensions // required
+ *         "<keys>": [ // ExportDimensionValue
+ *           "STRING_VALUE",
+ *         ],
+ *       },
+ *       Namespace: "VDM", // required
+ *       Metrics: [ // ExportMetrics // required
+ *         { // ExportMetric
+ *           Name: "SEND" || "COMPLAINT" || "PERMANENT_BOUNCE" || "TRANSIENT_BOUNCE" || "OPEN" || "CLICK" || "DELIVERY" || "DELIVERY_OPEN" || "DELIVERY_CLICK" || "DELIVERY_COMPLAINT",
+ *           Aggregation: "RATE" || "VOLUME",
+ *         },
+ *       ],
+ *       StartDate: new Date("TIMESTAMP"), // required
+ *       EndDate: new Date("TIMESTAMP"), // required
+ *     },
+ *     MessageInsightsDataSource: { // MessageInsightsDataSource
+ *       StartDate: new Date("TIMESTAMP"), // required
+ *       EndDate: new Date("TIMESTAMP"), // required
+ *       Include: { // MessageInsightsFilters
+ *         FromEmailAddress: [ // EmailAddressFilterList
+ *           "STRING_VALUE",
+ *         ],
+ *         Destination: [
+ *           "STRING_VALUE",
+ *         ],
+ *         Subject: [ // EmailSubjectFilterList
+ *           "STRING_VALUE",
+ *         ],
+ *         Isp: [ // IspFilterList
+ *           "STRING_VALUE",
+ *         ],
+ *         LastDeliveryEvent: [ // LastDeliveryEventList
+ *           "SEND" || "DELIVERY" || "TRANSIENT_BOUNCE" || "PERMANENT_BOUNCE" || "UNDETERMINED_BOUNCE" || "COMPLAINT",
+ *         ],
+ *         LastEngagementEvent: [ // LastEngagementEventList
+ *           "OPEN" || "CLICK",
+ *         ],
+ *       },
+ *       Exclude: {
+ *         FromEmailAddress: [
+ *           "STRING_VALUE",
+ *         ],
+ *         Destination: [
+ *           "STRING_VALUE",
+ *         ],
+ *         Subject: [
+ *           "STRING_VALUE",
+ *         ],
+ *         Isp: [
+ *           "STRING_VALUE",
+ *         ],
+ *         LastDeliveryEvent: [
+ *           "SEND" || "DELIVERY" || "TRANSIENT_BOUNCE" || "PERMANENT_BOUNCE" || "UNDETERMINED_BOUNCE" || "COMPLAINT",
+ *         ],
+ *         LastEngagementEvent: [
+ *           "OPEN" || "CLICK",
+ *         ],
+ *       },
+ *       MaxResults: Number("int"),
+ *     },
+ *   },
+ *   ExportDestination: { // ExportDestination
+ *     DataFormat: "CSV" || "JSON", // required
+ *     S3Url: "STRING_VALUE",
+ *   },
+ * };
+ * const command = new CreateExportJobCommand(input);
+ * const response = await client.send(command);
+ * // { // CreateExportJobResponse
+ * //   JobId: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param CreateExportJobCommandInput - {@link CreateExportJobCommandInput}
+ * @returns {@link CreateExportJobCommandOutput}
+ * @see {@link CreateExportJobCommandInput} for command's `input` shape.
+ * @see {@link CreateExportJobCommandOutput} for command's `response` shape.
+ * @see {@link SESv2ClientResolvedConfig | config} for SESv2Client's `config` shape.
+ *
+ * @throws {@link BadRequestException} (client fault)
+ *  <p>The input you provided is invalid.</p>
+ *
+ * @throws {@link LimitExceededException} (client fault)
+ *  <p>There are too many instances of the specified resource type.</p>
+ *
+ * @throws {@link NotFoundException} (client fault)
+ *  <p>The resource you attempted to access doesn't exist.</p>
+ *
+ * @throws {@link TooManyRequestsException} (client fault)
+ *  <p>Too many requests have been made to the operation.</p>
+ *
+ * @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;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: CreateExportJobCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SESv2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateExportJobCommandInput, CreateExportJobCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -0,0 +1,213 @@
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
+import { GetExportJobRequest, GetExportJobResponse } from "../models/models_0";
+import { ServiceInputTypes, ServiceOutputTypes, SESv2ClientResolvedConfig } from "../SESv2Client";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link GetExportJobCommand}.
+ */
+export interface GetExportJobCommandInput extends GetExportJobRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetExportJobCommand}.
+ */
+export interface GetExportJobCommandOutput extends GetExportJobResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Provides information about an export job.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { SESv2Client, GetExportJobCommand } from "@aws-sdk/client-sesv2"; // ES Modules import
+ * // const { SESv2Client, GetExportJobCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import
+ * const client = new SESv2Client(config);
+ * const input = { // GetExportJobRequest
+ *   JobId: "STRING_VALUE", // required
+ * };
+ * const command = new GetExportJobCommand(input);
+ * const response = await client.send(command);
+ * // { // GetExportJobResponse
+ * //   JobId: "STRING_VALUE",
+ * //   ExportSourceType: "METRICS_DATA" || "MESSAGE_INSIGHTS",
+ * //   JobStatus: "CREATED" || "PROCESSING" || "COMPLETED" || "FAILED" || "CANCELLED",
+ * //   ExportDestination: { // ExportDestination
+ * //     DataFormat: "CSV" || "JSON", // required
+ * //     S3Url: "STRING_VALUE",
+ * //   },
+ * //   ExportDataSource: { // ExportDataSource
+ * //     MetricsDataSource: { // MetricsDataSource
+ * //       Dimensions: { // ExportDimensions // required
+ * //         "<keys>": [ // ExportDimensionValue
+ * //           "STRING_VALUE",
+ * //         ],
+ * //       },
+ * //       Namespace: "VDM", // required
+ * //       Metrics: [ // ExportMetrics // required
+ * //         { // ExportMetric
+ * //           Name: "SEND" || "COMPLAINT" || "PERMANENT_BOUNCE" || "TRANSIENT_BOUNCE" || "OPEN" || "CLICK" || "DELIVERY" || "DELIVERY_OPEN" || "DELIVERY_CLICK" || "DELIVERY_COMPLAINT",
+ * //           Aggregation: "RATE" || "VOLUME",
+ * //         },
+ * //       ],
+ * //       StartDate: new Date("TIMESTAMP"), // required
+ * //       EndDate: new Date("TIMESTAMP"), // required
+ * //     },
+ * //     MessageInsightsDataSource: { // MessageInsightsDataSource
+ * //       StartDate: new Date("TIMESTAMP"), // required
+ * //       EndDate: new Date("TIMESTAMP"), // required
+ * //       Include: { // MessageInsightsFilters
+ * //         FromEmailAddress: [ // EmailAddressFilterList
+ * //           "STRING_VALUE",
+ * //         ],
+ * //         Destination: [
+ * //           "STRING_VALUE",
+ * //         ],
+ * //         Subject: [ // EmailSubjectFilterList
+ * //           "STRING_VALUE",
+ * //         ],
+ * //         Isp: [ // IspFilterList
+ * //           "STRING_VALUE",
+ * //         ],
+ * //         LastDeliveryEvent: [ // LastDeliveryEventList
+ * //           "SEND" || "DELIVERY" || "TRANSIENT_BOUNCE" || "PERMANENT_BOUNCE" || "UNDETERMINED_BOUNCE" || "COMPLAINT",
+ * //         ],
+ * //         LastEngagementEvent: [ // LastEngagementEventList
+ * //           "OPEN" || "CLICK",
+ * //         ],
+ * //       },
+ * //       Exclude: {
+ * //         FromEmailAddress: [
+ * //           "STRING_VALUE",
+ * //         ],
+ * //         Destination: [
+ * //           "STRING_VALUE",
+ * //         ],
+ * //         Subject: [
+ * //           "STRING_VALUE",
+ * //         ],
+ * //         Isp: [
+ * //           "STRING_VALUE",
+ * //         ],
+ * //         LastDeliveryEvent: [
+ * //           "SEND" || "DELIVERY" || "TRANSIENT_BOUNCE" || "PERMANENT_BOUNCE" || "UNDETERMINED_BOUNCE" || "COMPLAINT",
+ * //         ],
+ * //         LastEngagementEvent: [
+ * //           "OPEN" || "CLICK",
+ * //         ],
+ * //       },
+ * //       MaxResults: Number("int"),
+ * //     },
+ * //   },
+ * //   CreatedTimestamp: new Date("TIMESTAMP"),
+ * //   CompletedTimestamp: new Date("TIMESTAMP"),
+ * //   FailureInfo: { // FailureInfo
+ * //     FailedRecordsS3Url: "STRING_VALUE",
+ * //     ErrorMessage: "STRING_VALUE",
+ * //   },
+ * //   Statistics: { // ExportStatistics
+ * //     ProcessedRecordsCount: Number("int"),
+ * //     ExportedRecordsCount: Number("int"),
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param GetExportJobCommandInput - {@link GetExportJobCommandInput}
+ * @returns {@link GetExportJobCommandOutput}
+ * @see {@link GetExportJobCommandInput} for command's `input` shape.
+ * @see {@link GetExportJobCommandOutput} for command's `response` shape.
+ * @see {@link SESv2ClientResolvedConfig | config} for SESv2Client's `config` shape.
+ *
+ * @throws {@link BadRequestException} (client fault)
+ *  <p>The input you provided is invalid.</p>
+ *
+ * @throws {@link NotFoundException} (client fault)
+ *  <p>The resource you attempted to access doesn't exist.</p>
+ *
+ * @throws {@link TooManyRequestsException} (client fault)
+ *  <p>Too many requests have been made to the operation.</p>
+ *
+ * @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;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: GetExportJobCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SESv2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetExportJobCommandInput, GetExportJobCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -54,7 +54,7 @@ export interface GetImportJobCommandOutput extends GetImportJobResponse, __Metad
  * //     FailedRecordsS3Url: "STRING_VALUE",
  * //     ErrorMessage: "STRING_VALUE",
  * //   },
- * //   JobStatus: "CREATED" || "PROCESSING" || "COMPLETED" || "FAILED",
+ * //   JobStatus: "CREATED" || "PROCESSING" || "COMPLETED" || "FAILED" || "CANCELLED",
  * //   CreatedTimestamp: new Date("TIMESTAMP"),
  * //   CompletedTimestamp: new Date("TIMESTAMP"),
  * //   ProcessedRecordsCount: Number("int"),