@aws-sdk/client-mailmanager 3.581.0

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

@@ -0,0 +1,221 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { MailManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../MailManagerClient";
+import { GetRuleSetRequest, GetRuleSetResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link GetRuleSetCommand}.
+ */
+export interface GetRuleSetCommandInput extends GetRuleSetRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetRuleSetCommand}.
+ */
+export interface GetRuleSetCommandOutput extends GetRuleSetResponse, __MetadataBearer {
+}
+declare const GetRuleSetCommand_base: {
+    new (input: GetRuleSetCommandInput): import("@smithy/smithy-client").CommandImpl<GetRuleSetCommandInput, GetRuleSetCommandOutput, MailManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: GetRuleSetCommandInput): import("@smithy/smithy-client").CommandImpl<GetRuleSetCommandInput, GetRuleSetCommandOutput, MailManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Fetch attributes of a rule set.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { MailManagerClient, GetRuleSetCommand } from "@aws-sdk/client-mailmanager"; // ES Modules import
+ * // const { MailManagerClient, GetRuleSetCommand } = require("@aws-sdk/client-mailmanager"); // CommonJS import
+ * const client = new MailManagerClient(config);
+ * const input = { // GetRuleSetRequest
+ *   RuleSetId: "STRING_VALUE", // required
+ * };
+ * const command = new GetRuleSetCommand(input);
+ * const response = await client.send(command);
+ * // { // GetRuleSetResponse
+ * //   RuleSetId: "STRING_VALUE", // required
+ * //   RuleSetArn: "STRING_VALUE", // required
+ * //   RuleSetName: "STRING_VALUE", // required
+ * //   CreatedDate: new Date("TIMESTAMP"), // required
+ * //   LastModificationDate: new Date("TIMESTAMP"), // required
+ * //   Rules: [ // Rules // required
+ * //     { // Rule
+ * //       Name: "STRING_VALUE",
+ * //       Conditions: [ // RuleConditions
+ * //         { // RuleCondition Union: only one key present
+ * //           BooleanExpression: { // RuleBooleanExpression
+ * //             Evaluate: { // RuleBooleanToEvaluate Union: only one key present
+ * //               Attribute: "READ_RECEIPT_REQUESTED" || "TLS" || "TLS_WRAPPED",
+ * //             },
+ * //             Operator: "IS_TRUE" || "IS_FALSE", // required
+ * //           },
+ * //           StringExpression: { // RuleStringExpression
+ * //             Evaluate: { // RuleStringToEvaluate Union: only one key present
+ * //               Attribute: "MAIL_FROM" || "HELO" || "RECIPIENT" || "SENDER" || "FROM" || "SUBJECT" || "TO" || "CC",
+ * //             },
+ * //             Operator: "EQUALS" || "NOT_EQUALS" || "STARTS_WITH" || "ENDS_WITH" || "CONTAINS", // required
+ * //             Values: [ // RuleStringList // required
+ * //               "STRING_VALUE",
+ * //             ],
+ * //           },
+ * //           NumberExpression: { // RuleNumberExpression
+ * //             Evaluate: { // RuleNumberToEvaluate Union: only one key present
+ * //               Attribute: "MESSAGE_SIZE",
+ * //             },
+ * //             Operator: "EQUALS" || "NOT_EQUALS" || "LESS_THAN" || "GREATER_THAN" || "LESS_THAN_OR_EQUAL" || "GREATER_THAN_OR_EQUAL", // required
+ * //             Value: Number("double"), // required
+ * //           },
+ * //           IpExpression: { // RuleIpExpression
+ * //             Evaluate: { // RuleIpToEvaluate Union: only one key present
+ * //               Attribute: "SOURCE_IP",
+ * //             },
+ * //             Operator: "CIDR_MATCHES" || "NOT_CIDR_MATCHES", // required
+ * //             Values: [ // RuleIpValueList // required
+ * //               "STRING_VALUE",
+ * //             ],
+ * //           },
+ * //           VerdictExpression: { // RuleVerdictExpression
+ * //             Evaluate: { // RuleVerdictToEvaluate Union: only one key present
+ * //               Attribute: "SPF" || "DKIM",
+ * //               Analysis: { // Analysis
+ * //                 Analyzer: "STRING_VALUE", // required
+ * //                 ResultField: "STRING_VALUE", // required
+ * //               },
+ * //             },
+ * //             Operator: "EQUALS" || "NOT_EQUALS", // required
+ * //             Values: [ // RuleVerdictValueList // required
+ * //               "PASS" || "FAIL" || "GRAY" || "PROCESSING_FAILED",
+ * //             ],
+ * //           },
+ * //           DmarcExpression: { // RuleDmarcExpression
+ * //             Operator: "EQUALS" || "NOT_EQUALS", // required
+ * //             Values: [ // RuleDmarcValueList // required
+ * //               "NONE" || "QUARANTINE" || "REJECT",
+ * //             ],
+ * //           },
+ * //         },
+ * //       ],
+ * //       Unless: [
+ * //         {//  Union: only one key present
+ * //           BooleanExpression: {
+ * //             Evaluate: {//  Union: only one key present
+ * //               Attribute: "READ_RECEIPT_REQUESTED" || "TLS" || "TLS_WRAPPED",
+ * //             },
+ * //             Operator: "IS_TRUE" || "IS_FALSE", // required
+ * //           },
+ * //           StringExpression: {
+ * //             Evaluate: {//  Union: only one key present
+ * //               Attribute: "MAIL_FROM" || "HELO" || "RECIPIENT" || "SENDER" || "FROM" || "SUBJECT" || "TO" || "CC",
+ * //             },
+ * //             Operator: "EQUALS" || "NOT_EQUALS" || "STARTS_WITH" || "ENDS_WITH" || "CONTAINS", // required
+ * //             Values: [ // required
+ * //               "STRING_VALUE",
+ * //             ],
+ * //           },
+ * //           NumberExpression: {
+ * //             Evaluate: {//  Union: only one key present
+ * //               Attribute: "MESSAGE_SIZE",
+ * //             },
+ * //             Operator: "EQUALS" || "NOT_EQUALS" || "LESS_THAN" || "GREATER_THAN" || "LESS_THAN_OR_EQUAL" || "GREATER_THAN_OR_EQUAL", // required
+ * //             Value: Number("double"), // required
+ * //           },
+ * //           IpExpression: {
+ * //             Evaluate: {//  Union: only one key present
+ * //               Attribute: "SOURCE_IP",
+ * //             },
+ * //             Operator: "CIDR_MATCHES" || "NOT_CIDR_MATCHES", // required
+ * //             Values: [ // required
+ * //               "STRING_VALUE",
+ * //             ],
+ * //           },
+ * //           VerdictExpression: {
+ * //             Evaluate: {//  Union: only one key present
+ * //               Attribute: "SPF" || "DKIM",
+ * //               Analysis: {
+ * //                 Analyzer: "STRING_VALUE", // required
+ * //                 ResultField: "STRING_VALUE", // required
+ * //               },
+ * //             },
+ * //             Operator: "EQUALS" || "NOT_EQUALS", // required
+ * //             Values: [ // required
+ * //               "PASS" || "FAIL" || "GRAY" || "PROCESSING_FAILED",
+ * //             ],
+ * //           },
+ * //           DmarcExpression: {
+ * //             Operator: "EQUALS" || "NOT_EQUALS", // required
+ * //             Values: [ // required
+ * //               "NONE" || "QUARANTINE" || "REJECT",
+ * //             ],
+ * //           },
+ * //         },
+ * //       ],
+ * //       Actions: [ // RuleActions // required
+ * //         { // RuleAction Union: only one key present
+ * //           Drop: {},
+ * //           Relay: { // RelayAction
+ * //             ActionFailurePolicy: "CONTINUE" || "DROP",
+ * //             Relay: "STRING_VALUE", // required
+ * //             MailFrom: "REPLACE" || "PRESERVE",
+ * //           },
+ * //           Archive: { // ArchiveAction
+ * //             ActionFailurePolicy: "CONTINUE" || "DROP",
+ * //             TargetArchive: "STRING_VALUE", // required
+ * //           },
+ * //           WriteToS3: { // S3Action
+ * //             ActionFailurePolicy: "CONTINUE" || "DROP",
+ * //             RoleArn: "STRING_VALUE", // required
+ * //             S3Bucket: "STRING_VALUE", // required
+ * //             S3Prefix: "STRING_VALUE",
+ * //             S3SseKmsKeyId: "STRING_VALUE",
+ * //           },
+ * //           Send: { // SendAction
+ * //             ActionFailurePolicy: "CONTINUE" || "DROP",
+ * //             RoleArn: "STRING_VALUE", // required
+ * //           },
+ * //           AddHeader: { // AddHeaderAction
+ * //             HeaderName: "STRING_VALUE", // required
+ * //             HeaderValue: "STRING_VALUE", // required
+ * //           },
+ * //           ReplaceRecipient: { // ReplaceRecipientAction
+ * //             ReplaceWith: [ // Recipients
+ * //               "STRING_VALUE",
+ * //             ],
+ * //           },
+ * //           DeliverToMailbox: { // DeliverToMailboxAction
+ * //             ActionFailurePolicy: "CONTINUE" || "DROP",
+ * //             MailboxArn: "STRING_VALUE", // required
+ * //             RoleArn: "STRING_VALUE", // required
+ * //           },
+ * //         },
+ * //       ],
+ * //     },
+ * //   ],
+ * // };
+ *
+ * ```
+ *
+ * @param GetRuleSetCommandInput - {@link GetRuleSetCommandInput}
+ * @returns {@link GetRuleSetCommandOutput}
+ * @see {@link GetRuleSetCommandInput} for command's `input` shape.
+ * @see {@link GetRuleSetCommandOutput} for command's `response` shape.
+ * @see {@link MailManagerClientResolvedConfig | config} for MailManagerClient's `config` shape.
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>Occurs when a requested resource is not found.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The request validation has failed. For details, see the accompanying error message.</p>
+ *
+ * @throws {@link MailManagerServiceException}
+ * <p>Base exception class for all service exceptions from MailManager service.</p>
+ *
+ * @public
+ */
+export declare class GetRuleSetCommand extends GetRuleSetCommand_base {
+}

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

@@ -0,0 +1,114 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { MailManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../MailManagerClient";
+import { GetTrafficPolicyRequest, GetTrafficPolicyResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link GetTrafficPolicyCommand}.
+ */
+export interface GetTrafficPolicyCommandInput extends GetTrafficPolicyRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetTrafficPolicyCommand}.
+ */
+export interface GetTrafficPolicyCommandOutput extends GetTrafficPolicyResponse, __MetadataBearer {
+}
+declare const GetTrafficPolicyCommand_base: {
+    new (input: GetTrafficPolicyCommandInput): import("@smithy/smithy-client").CommandImpl<GetTrafficPolicyCommandInput, GetTrafficPolicyCommandOutput, MailManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: GetTrafficPolicyCommandInput): import("@smithy/smithy-client").CommandImpl<GetTrafficPolicyCommandInput, GetTrafficPolicyCommandOutput, MailManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Fetch attributes of a traffic policy resource.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { MailManagerClient, GetTrafficPolicyCommand } from "@aws-sdk/client-mailmanager"; // ES Modules import
+ * // const { MailManagerClient, GetTrafficPolicyCommand } = require("@aws-sdk/client-mailmanager"); // CommonJS import
+ * const client = new MailManagerClient(config);
+ * const input = { // GetTrafficPolicyRequest
+ *   TrafficPolicyId: "STRING_VALUE", // required
+ * };
+ * const command = new GetTrafficPolicyCommand(input);
+ * const response = await client.send(command);
+ * // { // GetTrafficPolicyResponse
+ * //   TrafficPolicyName: "STRING_VALUE", // required
+ * //   TrafficPolicyId: "STRING_VALUE", // required
+ * //   TrafficPolicyArn: "STRING_VALUE",
+ * //   PolicyStatements: [ // PolicyStatementList
+ * //     { // PolicyStatement
+ * //       Conditions: [ // PolicyConditions // required
+ * //         { // PolicyCondition Union: only one key present
+ * //           StringExpression: { // IngressStringExpression
+ * //             Evaluate: { // IngressStringToEvaluate Union: only one key present
+ * //               Attribute: "RECIPIENT",
+ * //             },
+ * //             Operator: "EQUALS" || "NOT_EQUALS" || "STARTS_WITH" || "ENDS_WITH" || "CONTAINS", // required
+ * //             Values: [ // StringList // required
+ * //               "STRING_VALUE",
+ * //             ],
+ * //           },
+ * //           IpExpression: { // IngressIpv4Expression
+ * //             Evaluate: { // IngressIpToEvaluate Union: only one key present
+ * //               Attribute: "SENDER_IP",
+ * //             },
+ * //             Operator: "CIDR_MATCHES" || "NOT_CIDR_MATCHES", // required
+ * //             Values: [ // Ipv4Cidrs // required
+ * //               "STRING_VALUE",
+ * //             ],
+ * //           },
+ * //           TlsExpression: { // IngressTlsProtocolExpression
+ * //             Evaluate: { // IngressTlsProtocolToEvaluate Union: only one key present
+ * //               Attribute: "TLS_PROTOCOL",
+ * //             },
+ * //             Operator: "MINIMUM_TLS_VERSION" || "IS", // required
+ * //             Value: "TLS1_2" || "TLS1_3", // required
+ * //           },
+ * //           BooleanExpression: { // IngressBooleanExpression
+ * //             Evaluate: { // IngressBooleanToEvaluate Union: only one key present
+ * //               Analysis: { // IngressAnalysis
+ * //                 Analyzer: "STRING_VALUE", // required
+ * //                 ResultField: "STRING_VALUE", // required
+ * //               },
+ * //             },
+ * //             Operator: "IS_TRUE" || "IS_FALSE", // required
+ * //           },
+ * //         },
+ * //       ],
+ * //       Action: "ALLOW" || "DENY", // required
+ * //     },
+ * //   ],
+ * //   MaxMessageSizeBytes: Number("int"),
+ * //   DefaultAction: "ALLOW" || "DENY",
+ * //   CreatedTimestamp: new Date("TIMESTAMP"),
+ * //   LastUpdatedTimestamp: new Date("TIMESTAMP"),
+ * // };
+ *
+ * ```
+ *
+ * @param GetTrafficPolicyCommandInput - {@link GetTrafficPolicyCommandInput}
+ * @returns {@link GetTrafficPolicyCommandOutput}
+ * @see {@link GetTrafficPolicyCommandInput} for command's `input` shape.
+ * @see {@link GetTrafficPolicyCommandOutput} for command's `response` shape.
+ * @see {@link MailManagerClientResolvedConfig | config} for MailManagerClient's `config` shape.
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>Occurs when a requested resource is not found.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The request validation has failed. For details, see the accompanying error message.</p>
+ *
+ * @throws {@link MailManagerServiceException}
+ * <p>Base exception class for all service exceptions from MailManager service.</p>
+ *
+ * @public
+ */
+export declare class GetTrafficPolicyCommand extends GetTrafficPolicyCommand_base {
+}

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

@@ -0,0 +1,72 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { MailManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../MailManagerClient";
+import { ListAddonInstancesRequest, ListAddonInstancesResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListAddonInstancesCommand}.
+ */
+export interface ListAddonInstancesCommandInput extends ListAddonInstancesRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListAddonInstancesCommand}.
+ */
+export interface ListAddonInstancesCommandOutput extends ListAddonInstancesResponse, __MetadataBearer {
+}
+declare const ListAddonInstancesCommand_base: {
+    new (input: ListAddonInstancesCommandInput): import("@smithy/smithy-client").CommandImpl<ListAddonInstancesCommandInput, ListAddonInstancesCommandOutput, MailManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (...[input]: [] | [ListAddonInstancesCommandInput]): import("@smithy/smithy-client").CommandImpl<ListAddonInstancesCommandInput, ListAddonInstancesCommandOutput, MailManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Lists all Add On instances in your account.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { MailManagerClient, ListAddonInstancesCommand } from "@aws-sdk/client-mailmanager"; // ES Modules import
+ * // const { MailManagerClient, ListAddonInstancesCommand } = require("@aws-sdk/client-mailmanager"); // CommonJS import
+ * const client = new MailManagerClient(config);
+ * const input = { // ListAddonInstancesRequest
+ *   NextToken: "STRING_VALUE",
+ *   PageSize: Number("int"),
+ * };
+ * const command = new ListAddonInstancesCommand(input);
+ * const response = await client.send(command);
+ * // { // ListAddonInstancesResponse
+ * //   AddonInstances: [ // AddonInstances
+ * //     { // AddonInstance
+ * //       AddonInstanceId: "STRING_VALUE",
+ * //       AddonSubscriptionId: "STRING_VALUE",
+ * //       AddonName: "STRING_VALUE",
+ * //       AddonInstanceArn: "STRING_VALUE",
+ * //       CreatedTimestamp: new Date("TIMESTAMP"),
+ * //     },
+ * //   ],
+ * //   NextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ListAddonInstancesCommandInput - {@link ListAddonInstancesCommandInput}
+ * @returns {@link ListAddonInstancesCommandOutput}
+ * @see {@link ListAddonInstancesCommandInput} for command's `input` shape.
+ * @see {@link ListAddonInstancesCommandOutput} for command's `response` shape.
+ * @see {@link MailManagerClientResolvedConfig | config} for MailManagerClient's `config` shape.
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The request validation has failed. For details, see the accompanying error message.</p>
+ *
+ * @throws {@link MailManagerServiceException}
+ * <p>Base exception class for all service exceptions from MailManager service.</p>
+ *
+ * @public
+ */
+export declare class ListAddonInstancesCommand extends ListAddonInstancesCommand_base {
+}

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

@@ -0,0 +1,71 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { MailManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../MailManagerClient";
+import { ListAddonSubscriptionsRequest, ListAddonSubscriptionsResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListAddonSubscriptionsCommand}.
+ */
+export interface ListAddonSubscriptionsCommandInput extends ListAddonSubscriptionsRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListAddonSubscriptionsCommand}.
+ */
+export interface ListAddonSubscriptionsCommandOutput extends ListAddonSubscriptionsResponse, __MetadataBearer {
+}
+declare const ListAddonSubscriptionsCommand_base: {
+    new (input: ListAddonSubscriptionsCommandInput): import("@smithy/smithy-client").CommandImpl<ListAddonSubscriptionsCommandInput, ListAddonSubscriptionsCommandOutput, MailManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (...[input]: [] | [ListAddonSubscriptionsCommandInput]): import("@smithy/smithy-client").CommandImpl<ListAddonSubscriptionsCommandInput, ListAddonSubscriptionsCommandOutput, MailManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Lists all Add On subscriptions in your account.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { MailManagerClient, ListAddonSubscriptionsCommand } from "@aws-sdk/client-mailmanager"; // ES Modules import
+ * // const { MailManagerClient, ListAddonSubscriptionsCommand } = require("@aws-sdk/client-mailmanager"); // CommonJS import
+ * const client = new MailManagerClient(config);
+ * const input = { // ListAddonSubscriptionsRequest
+ *   NextToken: "STRING_VALUE",
+ *   PageSize: Number("int"),
+ * };
+ * const command = new ListAddonSubscriptionsCommand(input);
+ * const response = await client.send(command);
+ * // { // ListAddonSubscriptionsResponse
+ * //   AddonSubscriptions: [ // AddonSubscriptions
+ * //     { // AddonSubscription
+ * //       AddonSubscriptionId: "STRING_VALUE",
+ * //       AddonName: "STRING_VALUE",
+ * //       AddonSubscriptionArn: "STRING_VALUE",
+ * //       CreatedTimestamp: new Date("TIMESTAMP"),
+ * //     },
+ * //   ],
+ * //   NextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ListAddonSubscriptionsCommandInput - {@link ListAddonSubscriptionsCommandInput}
+ * @returns {@link ListAddonSubscriptionsCommandOutput}
+ * @see {@link ListAddonSubscriptionsCommandInput} for command's `input` shape.
+ * @see {@link ListAddonSubscriptionsCommandOutput} for command's `response` shape.
+ * @see {@link MailManagerClientResolvedConfig | config} for MailManagerClient's `config` shape.
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The request validation has failed. For details, see the accompanying error message.</p>
+ *
+ * @throws {@link MailManagerServiceException}
+ * <p>Base exception class for all service exceptions from MailManager service.</p>
+ *
+ * @public
+ */
+export declare class ListAddonSubscriptionsCommand extends ListAddonSubscriptionsCommand_base {
+}

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

@@ -0,0 +1,84 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { MailManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../MailManagerClient";
+import { ListArchiveExportsRequest, ListArchiveExportsResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListArchiveExportsCommand}.
+ */
+export interface ListArchiveExportsCommandInput extends ListArchiveExportsRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListArchiveExportsCommand}.
+ */
+export interface ListArchiveExportsCommandOutput extends ListArchiveExportsResponse, __MetadataBearer {
+}
+declare const ListArchiveExportsCommand_base: {
+    new (input: ListArchiveExportsCommandInput): import("@smithy/smithy-client").CommandImpl<ListArchiveExportsCommandInput, ListArchiveExportsCommandOutput, MailManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: ListArchiveExportsCommandInput): import("@smithy/smithy-client").CommandImpl<ListArchiveExportsCommandInput, ListArchiveExportsCommandOutput, MailManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Returns a list of email archive export jobs.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { MailManagerClient, ListArchiveExportsCommand } from "@aws-sdk/client-mailmanager"; // ES Modules import
+ * // const { MailManagerClient, ListArchiveExportsCommand } = require("@aws-sdk/client-mailmanager"); // CommonJS import
+ * const client = new MailManagerClient(config);
+ * const input = { // ListArchiveExportsRequest
+ *   ArchiveId: "STRING_VALUE", // required
+ *   NextToken: "STRING_VALUE",
+ *   PageSize: Number("int"),
+ * };
+ * const command = new ListArchiveExportsCommand(input);
+ * const response = await client.send(command);
+ * // { // ListArchiveExportsResponse
+ * //   Exports: [ // ExportSummaryList
+ * //     { // ExportSummary
+ * //       ExportId: "STRING_VALUE",
+ * //       Status: { // ExportStatus
+ * //         SubmissionTimestamp: new Date("TIMESTAMP"),
+ * //         CompletionTimestamp: new Date("TIMESTAMP"),
+ * //         State: "QUEUED" || "PREPROCESSING" || "PROCESSING" || "COMPLETED" || "FAILED" || "CANCELLED",
+ * //         ErrorMessage: "STRING_VALUE",
+ * //       },
+ * //     },
+ * //   ],
+ * //   NextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ListArchiveExportsCommandInput - {@link ListArchiveExportsCommandInput}
+ * @returns {@link ListArchiveExportsCommandOutput}
+ * @see {@link ListArchiveExportsCommandInput} for command's `input` shape.
+ * @see {@link ListArchiveExportsCommandOutput} for command's `response` shape.
+ * @see {@link MailManagerClientResolvedConfig | config} for MailManagerClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>Occurs when a user is denied access to a specific resource or action.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>Occurs when a requested resource is not found.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The request validation has failed. For details, see the accompanying error message.</p>
+ *
+ * @throws {@link MailManagerServiceException}
+ * <p>Base exception class for all service exceptions from MailManager service.</p>
+ *
+ * @public
+ */
+export declare class ListArchiveExportsCommand extends ListArchiveExportsCommand_base {
+}

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

@@ -0,0 +1,84 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { MailManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../MailManagerClient";
+import { ListArchiveSearchesRequest, ListArchiveSearchesResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListArchiveSearchesCommand}.
+ */
+export interface ListArchiveSearchesCommandInput extends ListArchiveSearchesRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListArchiveSearchesCommand}.
+ */
+export interface ListArchiveSearchesCommandOutput extends ListArchiveSearchesResponse, __MetadataBearer {
+}
+declare const ListArchiveSearchesCommand_base: {
+    new (input: ListArchiveSearchesCommandInput): import("@smithy/smithy-client").CommandImpl<ListArchiveSearchesCommandInput, ListArchiveSearchesCommandOutput, MailManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: ListArchiveSearchesCommandInput): import("@smithy/smithy-client").CommandImpl<ListArchiveSearchesCommandInput, ListArchiveSearchesCommandOutput, MailManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Returns a list of email archive search jobs.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { MailManagerClient, ListArchiveSearchesCommand } from "@aws-sdk/client-mailmanager"; // ES Modules import
+ * // const { MailManagerClient, ListArchiveSearchesCommand } = require("@aws-sdk/client-mailmanager"); // CommonJS import
+ * const client = new MailManagerClient(config);
+ * const input = { // ListArchiveSearchesRequest
+ *   ArchiveId: "STRING_VALUE", // required
+ *   NextToken: "STRING_VALUE",
+ *   PageSize: Number("int"),
+ * };
+ * const command = new ListArchiveSearchesCommand(input);
+ * const response = await client.send(command);
+ * // { // ListArchiveSearchesResponse
+ * //   Searches: [ // SearchSummaryList
+ * //     { // SearchSummary
+ * //       SearchId: "STRING_VALUE",
+ * //       Status: { // SearchStatus
+ * //         SubmissionTimestamp: new Date("TIMESTAMP"),
+ * //         CompletionTimestamp: new Date("TIMESTAMP"),
+ * //         State: "QUEUED" || "RUNNING" || "COMPLETED" || "FAILED" || "CANCELLED",
+ * //         ErrorMessage: "STRING_VALUE",
+ * //       },
+ * //     },
+ * //   ],
+ * //   NextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ListArchiveSearchesCommandInput - {@link ListArchiveSearchesCommandInput}
+ * @returns {@link ListArchiveSearchesCommandOutput}
+ * @see {@link ListArchiveSearchesCommandInput} for command's `input` shape.
+ * @see {@link ListArchiveSearchesCommandOutput} for command's `response` shape.
+ * @see {@link MailManagerClientResolvedConfig | config} for MailManagerClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>Occurs when a user is denied access to a specific resource or action.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>Occurs when a requested resource is not found.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The request validation has failed. For details, see the accompanying error message.</p>
+ *
+ * @throws {@link MailManagerServiceException}
+ * <p>Base exception class for all service exceptions from MailManager service.</p>
+ *
+ * @public
+ */
+export declare class ListArchiveSearchesCommand extends ListArchiveSearchesCommand_base {
+}