import { Command as $Command } from "@smithy/smithy-client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { DescribeExecutionRequest, DescribeExecutionResponse } from "../models/models_0"; import type { ServiceInputTypes, ServiceOutputTypes, TransferClientResolvedConfig } from "../TransferClient"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link DescribeExecutionCommand}. */ export interface DescribeExecutionCommandInput extends DescribeExecutionRequest { } /** * @public * * The output of {@link DescribeExecutionCommand}. */ export interface DescribeExecutionCommandOutput extends DescribeExecutionResponse, __MetadataBearer { } declare const DescribeExecutionCommand_base: { new (input: DescribeExecutionCommandInput): import("@smithy/smithy-client").CommandImpl; new (input: DescribeExecutionCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

You can use DescribeExecution to check the details of the execution of the specified workflow.

This API call only returns details for in-progress workflows.

If you provide an ID for an execution that is not in progress, or if the execution doesn't match the specified workflow ID, you receive a ResourceNotFound exception.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { TransferClient, DescribeExecutionCommand } from "@aws-sdk/client-transfer"; // ES Modules import * // const { TransferClient, DescribeExecutionCommand } = require("@aws-sdk/client-transfer"); // CommonJS import * // import type { TransferClientConfig } from "@aws-sdk/client-transfer"; * const config = {}; // type is TransferClientConfig * const client = new TransferClient(config); * const input = { // DescribeExecutionRequest * ExecutionId: "STRING_VALUE", // required * WorkflowId: "STRING_VALUE", // required * }; * const command = new DescribeExecutionCommand(input); * const response = await client.send(command); * // { // DescribeExecutionResponse * // WorkflowId: "STRING_VALUE", // required * // Execution: { // DescribedExecution * // ExecutionId: "STRING_VALUE", * // InitialFileLocation: { // FileLocation * // S3FileLocation: { // S3FileLocation * // Bucket: "STRING_VALUE", * // Key: "STRING_VALUE", * // VersionId: "STRING_VALUE", * // Etag: "STRING_VALUE", * // }, * // EfsFileLocation: { // EfsFileLocation * // FileSystemId: "STRING_VALUE", * // Path: "STRING_VALUE", * // }, * // }, * // ServiceMetadata: { // ServiceMetadata * // UserDetails: { // UserDetails * // UserName: "STRING_VALUE", // required * // ServerId: "STRING_VALUE", // required * // SessionId: "STRING_VALUE", * // }, * // }, * // ExecutionRole: "STRING_VALUE", * // LoggingConfiguration: { // LoggingConfiguration * // LoggingRole: "STRING_VALUE", * // LogGroupName: "STRING_VALUE", * // }, * // PosixProfile: { // PosixProfile * // Uid: Number("long"), // required * // Gid: Number("long"), // required * // SecondaryGids: [ // SecondaryGids * // Number("long"), * // ], * // }, * // Status: "IN_PROGRESS" || "COMPLETED" || "EXCEPTION" || "HANDLING_EXCEPTION", * // Results: { // ExecutionResults * // Steps: [ // ExecutionStepResults * // { // ExecutionStepResult * // StepType: "COPY" || "CUSTOM" || "TAG" || "DELETE" || "DECRYPT", * // Outputs: "STRING_VALUE", * // Error: { // ExecutionError * // Type: "PERMISSION_DENIED" || "CUSTOM_STEP_FAILED" || "THROTTLED" || "ALREADY_EXISTS" || "NOT_FOUND" || "BAD_REQUEST" || "TIMEOUT" || "INTERNAL_SERVER_ERROR", // required * // Message: "STRING_VALUE", // required * // }, * // }, * // ], * // OnExceptionSteps: [ * // { * // StepType: "COPY" || "CUSTOM" || "TAG" || "DELETE" || "DECRYPT", * // Outputs: "STRING_VALUE", * // Error: { * // Type: "PERMISSION_DENIED" || "CUSTOM_STEP_FAILED" || "THROTTLED" || "ALREADY_EXISTS" || "NOT_FOUND" || "BAD_REQUEST" || "TIMEOUT" || "INTERNAL_SERVER_ERROR", // required * // Message: "STRING_VALUE", // required * // }, * // }, * // ], * // }, * // }, * // }; * * ``` * * @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 TransferClientResolvedConfig | config} for TransferClient's `config` shape. * * @throws {@link InternalServiceError} (server fault) *

This exception is thrown when an error occurs in the Transfer Family service.

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

This exception is thrown when the client submits a malformed request.

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

This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.

* * @throws {@link ServiceUnavailableException} (server fault) *

The request has failed because the Amazon Web ServicesTransfer Family service is not available.

* * @throws {@link TransferServiceException} *

Base exception class for all service exceptions from Transfer service.

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