@aws-sdk/client-lambda/dist-types/commands/SendDurableExecutionCallbackHeartbeatCommand.d.ts

AWS SDK for JavaScript Lambda Client for Node.js, Browser and React Native

import { Command as $Command } from "@smithy/smithy-client";
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
import type { LambdaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LambdaClient";
import type { SendDurableExecutionCallbackHeartbeatRequest, SendDurableExecutionCallbackHeartbeatResponse } from "../models/models_0";
/**
 * @public
 */
export type { __MetadataBearer };
export { $Command };
/**
 * @public
 *
 * The input for {@link SendDurableExecutionCallbackHeartbeatCommand}.
 */
export interface SendDurableExecutionCallbackHeartbeatCommandInput extends SendDurableExecutionCallbackHeartbeatRequest {
}
/**
 * @public
 *
 * The output of {@link SendDurableExecutionCallbackHeartbeatCommand}.
 */
export interface SendDurableExecutionCallbackHeartbeatCommandOutput extends SendDurableExecutionCallbackHeartbeatResponse, __MetadataBearer {
}
declare const SendDurableExecutionCallbackHeartbeatCommand_base: {
    new (input: SendDurableExecutionCallbackHeartbeatCommandInput): import("@smithy/smithy-client").CommandImpl<SendDurableExecutionCallbackHeartbeatCommandInput, SendDurableExecutionCallbackHeartbeatCommandOutput, LambdaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
    new (input: SendDurableExecutionCallbackHeartbeatCommandInput): import("@smithy/smithy-client").CommandImpl<SendDurableExecutionCallbackHeartbeatCommandInput, SendDurableExecutionCallbackHeartbeatCommandOutput, LambdaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
};
/**
 * <p>Sends a heartbeat signal for a long-running callback operation to prevent timeout. Use this API to extend the callback timeout period while the external operation is still in progress.</p>
 * @example
 * Use a bare-bones client and the command you need to make an API call.
 * ```javascript
 * import { LambdaClient, SendDurableExecutionCallbackHeartbeatCommand } from "@aws-sdk/client-lambda"; // ES Modules import
 * // const { LambdaClient, SendDurableExecutionCallbackHeartbeatCommand } = require("@aws-sdk/client-lambda"); // CommonJS import
 * // import type { LambdaClientConfig } from "@aws-sdk/client-lambda";
 * const config = {}; // type is LambdaClientConfig
 * const client = new LambdaClient(config);
 * const input = { // SendDurableExecutionCallbackHeartbeatRequest
 *   CallbackId: "STRING_VALUE", // required
 * };
 * const command = new SendDurableExecutionCallbackHeartbeatCommand(input);
 * const response = await client.send(command);
 * // {};
 *
 * ```
 *
 * @param SendDurableExecutionCallbackHeartbeatCommandInput - {@link SendDurableExecutionCallbackHeartbeatCommandInput}
 * @returns {@link SendDurableExecutionCallbackHeartbeatCommandOutput}
 * @see {@link SendDurableExecutionCallbackHeartbeatCommandInput} for command's `input` shape.
 * @see {@link SendDurableExecutionCallbackHeartbeatCommandOutput} for command's `response` shape.
 * @see {@link LambdaClientResolvedConfig | config} for LambdaClient's `config` shape.
 *
 * @throws {@link CallbackTimeoutException} (client fault)
 *  <p>The callback ID token has either expired or the callback associated with the token has already been closed.</p>
 *
 * @throws {@link InvalidParameterValueException} (client fault)
 *  <p>One of the parameters in the request is not valid.</p>
 *
 * @throws {@link ServiceException} (server fault)
 *  <p>The Lambda service encountered an internal error.</p>
 *
 * @throws {@link TooManyRequestsException} (client fault)
 *  <p>The request throughput limit was exceeded. For more information, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-limits.html#api-requests">Lambda quotas</a>.</p>
 *
 * @throws {@link LambdaServiceException}
 * <p>Base exception class for all service exceptions from Lambda service.</p>
 *
 *
 * @public
 */
export declare class SendDurableExecutionCallbackHeartbeatCommand extends SendDurableExecutionCallbackHeartbeatCommand_base {
    /** @internal type navigation helper, not in runtime. */
    protected static __types: {
        api: {
            input: SendDurableExecutionCallbackHeartbeatRequest;
            output: {};
        };
        sdk: {
            input: SendDurableExecutionCallbackHeartbeatCommandInput;
            output: SendDurableExecutionCallbackHeartbeatCommandOutput;
        };
    };
}