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

Describes the specified workflow.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { TransferClient, DescribeWorkflowCommand } from "@aws-sdk/client-transfer"; // ES Modules import * // const { TransferClient, DescribeWorkflowCommand } = 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 = { // DescribeWorkflowRequest * WorkflowId: "STRING_VALUE", // required * }; * const command = new DescribeWorkflowCommand(input); * const response = await client.send(command); * // { // DescribeWorkflowResponse * // Workflow: { // DescribedWorkflow * // Arn: "STRING_VALUE", // required * // Description: "STRING_VALUE", * // Steps: [ // WorkflowSteps * // { // WorkflowStep * // Type: "COPY" || "CUSTOM" || "TAG" || "DELETE" || "DECRYPT", * // CopyStepDetails: { // CopyStepDetails * // Name: "STRING_VALUE", * // DestinationFileLocation: { // InputFileLocation * // S3FileLocation: { // S3InputFileLocation * // Bucket: "STRING_VALUE", * // Key: "STRING_VALUE", * // }, * // EfsFileLocation: { // EfsFileLocation * // FileSystemId: "STRING_VALUE", * // Path: "STRING_VALUE", * // }, * // }, * // OverwriteExisting: "TRUE" || "FALSE", * // SourceFileLocation: "STRING_VALUE", * // }, * // CustomStepDetails: { // CustomStepDetails * // Name: "STRING_VALUE", * // Target: "STRING_VALUE", * // TimeoutSeconds: Number("int"), * // SourceFileLocation: "STRING_VALUE", * // }, * // DeleteStepDetails: { // DeleteStepDetails * // Name: "STRING_VALUE", * // SourceFileLocation: "STRING_VALUE", * // }, * // TagStepDetails: { // TagStepDetails * // Name: "STRING_VALUE", * // Tags: [ // S3Tags * // { // S3Tag * // Key: "STRING_VALUE", // required * // Value: "STRING_VALUE", // required * // }, * // ], * // SourceFileLocation: "STRING_VALUE", * // }, * // DecryptStepDetails: { // DecryptStepDetails * // Name: "STRING_VALUE", * // Type: "PGP", // required * // SourceFileLocation: "STRING_VALUE", * // OverwriteExisting: "TRUE" || "FALSE", * // DestinationFileLocation: { * // S3FileLocation: { * // Bucket: "STRING_VALUE", * // Key: "STRING_VALUE", * // }, * // EfsFileLocation: { * // FileSystemId: "STRING_VALUE", * // Path: "STRING_VALUE", * // }, * // }, * // }, * // }, * // ], * // OnExceptionSteps: [ * // { * // Type: "COPY" || "CUSTOM" || "TAG" || "DELETE" || "DECRYPT", * // CopyStepDetails: { * // Name: "STRING_VALUE", * // DestinationFileLocation: { * // S3FileLocation: { * // Bucket: "STRING_VALUE", * // Key: "STRING_VALUE", * // }, * // EfsFileLocation: { * // FileSystemId: "STRING_VALUE", * // Path: "STRING_VALUE", * // }, * // }, * // OverwriteExisting: "TRUE" || "FALSE", * // SourceFileLocation: "STRING_VALUE", * // }, * // CustomStepDetails: { * // Name: "STRING_VALUE", * // Target: "STRING_VALUE", * // TimeoutSeconds: Number("int"), * // SourceFileLocation: "STRING_VALUE", * // }, * // DeleteStepDetails: { * // Name: "STRING_VALUE", * // SourceFileLocation: "STRING_VALUE", * // }, * // TagStepDetails: { * // Name: "STRING_VALUE", * // Tags: [ * // { * // Key: "STRING_VALUE", // required * // Value: "STRING_VALUE", // required * // }, * // ], * // SourceFileLocation: "STRING_VALUE", * // }, * // DecryptStepDetails: { * // Name: "STRING_VALUE", * // Type: "PGP", // required * // SourceFileLocation: "STRING_VALUE", * // OverwriteExisting: "TRUE" || "FALSE", * // DestinationFileLocation: { * // S3FileLocation: { * // Bucket: "STRING_VALUE", * // Key: "STRING_VALUE", * // }, * // EfsFileLocation: { * // FileSystemId: "STRING_VALUE", * // Path: "STRING_VALUE", * // }, * // }, * // }, * // }, * // ], * // WorkflowId: "STRING_VALUE", * // Tags: [ // Tags * // { // Tag * // Key: "STRING_VALUE", // required * // Value: "STRING_VALUE", // required * // }, * // ], * // }, * // }; * * ``` * * @param DescribeWorkflowCommandInput - {@link DescribeWorkflowCommandInput} * @returns {@link DescribeWorkflowCommandOutput} * @see {@link DescribeWorkflowCommandInput} for command's `input` shape. * @see {@link DescribeWorkflowCommandOutput} 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 DescribeWorkflowCommand extends DescribeWorkflowCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DescribeWorkflowRequest; output: DescribeWorkflowResponse; }; sdk: { input: DescribeWorkflowCommandInput; output: DescribeWorkflowCommandOutput; }; }; }