import { Command as $Command } from "@smithy/smithy-client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { UpdateReceiptRuleRequest, UpdateReceiptRuleResponse } from "../models/models_0"; import type { ServiceInputTypes, ServiceOutputTypes, SESClientResolvedConfig } from "../SESClient"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link UpdateReceiptRuleCommand}. */ export interface UpdateReceiptRuleCommandInput extends UpdateReceiptRuleRequest { } /** * @public * * The output of {@link UpdateReceiptRuleCommand}. */ export interface UpdateReceiptRuleCommandOutput extends UpdateReceiptRuleResponse, __MetadataBearer { } declare const UpdateReceiptRuleCommand_base: { new (input: UpdateReceiptRuleCommandInput): import("@smithy/smithy-client").CommandImpl; new (input: UpdateReceiptRuleCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

Updates a receipt rule.

*

For information about managing receipt rules, see the Amazon SES * Developer Guide.

*

You can execute this operation no more than once per second.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { SESClient, UpdateReceiptRuleCommand } from "@aws-sdk/client-ses"; // ES Modules import * // const { SESClient, UpdateReceiptRuleCommand } = require("@aws-sdk/client-ses"); // CommonJS import * // import type { SESClientConfig } from "@aws-sdk/client-ses"; * const config = {}; // type is SESClientConfig * const client = new SESClient(config); * const input = { // UpdateReceiptRuleRequest * RuleSetName: "STRING_VALUE", // required * Rule: { // ReceiptRule * Name: "STRING_VALUE", // required * Enabled: true || false, * TlsPolicy: "Require" || "Optional", * Recipients: [ // RecipientsList * "STRING_VALUE", * ], * Actions: [ // ReceiptActionsList * { // ReceiptAction * S3Action: { // S3Action * TopicArn: "STRING_VALUE", * BucketName: "STRING_VALUE", // required * ObjectKeyPrefix: "STRING_VALUE", * KmsKeyArn: "STRING_VALUE", * IamRoleArn: "STRING_VALUE", * }, * BounceAction: { // BounceAction * TopicArn: "STRING_VALUE", * SmtpReplyCode: "STRING_VALUE", // required * StatusCode: "STRING_VALUE", * Message: "STRING_VALUE", // required * Sender: "STRING_VALUE", // required * }, * WorkmailAction: { // WorkmailAction * TopicArn: "STRING_VALUE", * OrganizationArn: "STRING_VALUE", // required * }, * LambdaAction: { // LambdaAction * TopicArn: "STRING_VALUE", * FunctionArn: "STRING_VALUE", // required * InvocationType: "Event" || "RequestResponse", * }, * StopAction: { // StopAction * Scope: "RuleSet", // required * TopicArn: "STRING_VALUE", * }, * AddHeaderAction: { // AddHeaderAction * HeaderName: "STRING_VALUE", // required * HeaderValue: "STRING_VALUE", // required * }, * SNSAction: { // SNSAction * TopicArn: "STRING_VALUE", // required * Encoding: "UTF-8" || "Base64", * }, * ConnectAction: { // ConnectAction * InstanceARN: "STRING_VALUE", // required * IAMRoleARN: "STRING_VALUE", // required * }, * }, * ], * ScanEnabled: true || false, * }, * }; * const command = new UpdateReceiptRuleCommand(input); * const response = await client.send(command); * // {}; * * ``` * * @param UpdateReceiptRuleCommandInput - {@link UpdateReceiptRuleCommandInput} * @returns {@link UpdateReceiptRuleCommandOutput} * @see {@link UpdateReceiptRuleCommandInput} for command's `input` shape. * @see {@link UpdateReceiptRuleCommandOutput} for command's `response` shape. * @see {@link SESClientResolvedConfig | config} for SESClient's `config` shape. * * @throws {@link InvalidLambdaFunctionException} (client fault) *

Indicates that the provided Amazon Web Services Lambda function is invalid, or that Amazon SES could * not execute the provided function, possibly due to permissions issues. For information * about giving permissions, see the Amazon SES * Developer Guide.

* * @throws {@link InvalidS3ConfigurationException} (client fault) *

Indicates that the provided Amazon S3 bucket or Amazon Web Services KMS encryption key is invalid, * or that Amazon SES could not publish to the bucket, possibly due to permissions issues. * For information about giving permissions, see the Amazon SES * Developer Guide.

* * @throws {@link InvalidSnsTopicException} (client fault) *

Indicates that the provided Amazon SNS topic is invalid, or that Amazon SES could not * publish to the topic, possibly due to permissions issues. For information about giving * permissions, see the Amazon SES * Developer Guide.

* * @throws {@link LimitExceededException} (client fault) *

Indicates that a resource could not be created because of service limits. For a list * of Amazon SES limits, see the Amazon SES Developer * Guide.

* * @throws {@link RuleDoesNotExistException} (client fault) *

Indicates that the provided receipt rule does not exist.

* * @throws {@link RuleSetDoesNotExistException} (client fault) *

Indicates that the provided receipt rule set does not exist.

* * @throws {@link SESServiceException} *

Base exception class for all service exceptions from SES service.

* * * @example UpdateReceiptRule * ```javascript * // The following example updates a receipt rule to use an Amazon S3 action: * const input = { * Rule: { * Actions: [ * { * S3Action: { * BucketName: "MyBucket", * ObjectKeyPrefix: "email" * } * } * ], * Enabled: true, * Name: "MyRule", * ScanEnabled: true, * TlsPolicy: "Optional" * }, * RuleSetName: "MyRuleSet" * }; * const command = new UpdateReceiptRuleCommand(input); * const response = await client.send(command); * /* response is * { /* metadata only *\/ } * *\/ * ``` * * @public */ export declare class UpdateReceiptRuleCommand extends UpdateReceiptRuleCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: UpdateReceiptRuleRequest; output: {}; }; sdk: { input: UpdateReceiptRuleCommandInput; output: UpdateReceiptRuleCommandOutput; }; }; }