import { Command as $Command } from "@smithy/core/client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { DescribeExecutionInput, DescribeExecutionOutput } from "../models/models_0"; import type { ServiceInputTypes, ServiceOutputTypes, SFNClientResolvedConfig } from "../SFNClient"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link DescribeExecutionCommand}. */ export interface DescribeExecutionCommandInput extends DescribeExecutionInput { } /** * @public * * The output of {@link DescribeExecutionCommand}. */ export interface DescribeExecutionCommandOutput extends DescribeExecutionOutput, __MetadataBearer { } declare const DescribeExecutionCommand_base: { new (input: DescribeExecutionCommandInput): import("@smithy/core/client").CommandImpl; new (input: DescribeExecutionCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): { [x: string]: unknown; }; }; /** *

Provides information about a state machine execution, such as the state machine associated with the execution, the execution input and output, and relevant execution metadata. If you've redriven an execution, you can use this API action to return information about the redrives of that execution. In addition, you can use this API action to return the Map Run Amazon Resource Name (ARN) if the execution was dispatched by a Map Run.

*

If you specify a version or alias ARN when you call the StartExecution * API action, DescribeExecution returns that ARN.

* *

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

*
*

Executions of an EXPRESS state machine aren't supported by DescribeExecution unless a Map Run dispatched them.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { SFNClient, DescribeExecutionCommand } from "@aws-sdk/client-sfn"; // ES Modules import * // const { SFNClient, DescribeExecutionCommand } = require("@aws-sdk/client-sfn"); // CommonJS import * // import type { SFNClientConfig } from "@aws-sdk/client-sfn"; * const config = {}; // type is SFNClientConfig * const client = new SFNClient(config); * const input = { // DescribeExecutionInput * executionArn: "STRING_VALUE", // required * includedData: "ALL_DATA" || "METADATA_ONLY", * }; * const command = new DescribeExecutionCommand(input); * const response = await client.send(command); * // { // DescribeExecutionOutput * // executionArn: "STRING_VALUE", // required * // stateMachineArn: "STRING_VALUE", // required * // name: "STRING_VALUE", * // status: "RUNNING" || "SUCCEEDED" || "FAILED" || "TIMED_OUT" || "ABORTED" || "PENDING_REDRIVE", // required * // startDate: new Date("TIMESTAMP"), // required * // stopDate: new Date("TIMESTAMP"), * // input: "STRING_VALUE", * // inputDetails: { // CloudWatchEventsExecutionDataDetails * // included: true || false, * // }, * // output: "STRING_VALUE", * // outputDetails: { * // included: true || false, * // }, * // traceHeader: "STRING_VALUE", * // mapRunArn: "STRING_VALUE", * // error: "STRING_VALUE", * // cause: "STRING_VALUE", * // stateMachineVersionArn: "STRING_VALUE", * // stateMachineAliasArn: "STRING_VALUE", * // redriveCount: Number("int"), * // redriveDate: new Date("TIMESTAMP"), * // redriveStatus: "REDRIVABLE" || "NOT_REDRIVABLE" || "REDRIVABLE_BY_MAP_RUN", * // redriveStatusReason: "STRING_VALUE", * // }; * * ``` * * @param DescribeExecutionCommandInput - {@link DescribeExecutionCommandInput} * @returns {@link DescribeExecutionCommandOutput} * @see {@link DescribeExecutionCommandInput} for command's `input` shape. * @see {@link DescribeExecutionCommandOutput} for command's `response` shape. * @see {@link SFNClientResolvedConfig | config} for SFNClient's `config` shape. * * @throws {@link ExecutionDoesNotExist} (client fault) *

The specified execution does not exist.

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

The provided Amazon Resource Name (ARN) is not valid.

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

Either your KMS key policy or API caller does not have the required permissions.

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

The KMS key is not in valid state, for example: Disabled or Deleted.

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

Received when KMS returns ThrottlingException for a KMS call that Step Functions makes on behalf of the caller.

* * @throws {@link SFNServiceException} *

Base exception class for all service exceptions from SFN service.

* * * @public */ export declare class DescribeExecutionCommand extends DescribeExecutionCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DescribeExecutionInput; output: DescribeExecutionOutput; }; sdk: { input: DescribeExecutionCommandInput; output: DescribeExecutionCommandOutput; }; }; }