# DescribeWorkflow


Describes the specified workflow.

## Request Syntax


```
{
   "WorkflowId": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [WorkflowId](#API_DescribeWorkflow_RequestSyntax) **   <a name="TransferFamily-DescribeWorkflow-request-WorkflowId"></a>
A unique identifier for the workflow.  
Type: String  
Length Constraints: Fixed length of 19.  
Pattern: `w-([a-z0-9]{17})`   
Required: Yes

## Response Syntax


```
{
   "Workflow": { 
      "Arn": "string",
      "Description": "string",
      "OnExceptionSteps": [ 
         { 
            "CopyStepDetails": { 
               "DestinationFileLocation": { 
                  "EfsFileLocation": { 
                     "FileSystemId": "string",
                     "Path": "string"
                  },
                  "S3FileLocation": { 
                     "Bucket": "string",
                     "Key": "string"
                  }
               },
               "Name": "string",
               "OverwriteExisting": "string",
               "SourceFileLocation": "string"
            },
            "CustomStepDetails": { 
               "Name": "string",
               "SourceFileLocation": "string",
               "Target": "string",
               "TimeoutSeconds": number
            },
            "DecryptStepDetails": { 
               "DestinationFileLocation": { 
                  "EfsFileLocation": { 
                     "FileSystemId": "string",
                     "Path": "string"
                  },
                  "S3FileLocation": { 
                     "Bucket": "string",
                     "Key": "string"
                  }
               },
               "Name": "string",
               "OverwriteExisting": "string",
               "SourceFileLocation": "string",
               "Type": "string"
            },
            "DeleteStepDetails": { 
               "Name": "string",
               "SourceFileLocation": "string"
            },
            "TagStepDetails": { 
               "Name": "string",
               "SourceFileLocation": "string",
               "Tags": [ 
                  { 
                     "Key": "string",
                     "Value": "string"
                  }
               ]
            },
            "Type": "string"
         }
      ],
      "Steps": [ 
         { 
            "CopyStepDetails": { 
               "DestinationFileLocation": { 
                  "EfsFileLocation": { 
                     "FileSystemId": "string",
                     "Path": "string"
                  },
                  "S3FileLocation": { 
                     "Bucket": "string",
                     "Key": "string"
                  }
               },
               "Name": "string",
               "OverwriteExisting": "string",
               "SourceFileLocation": "string"
            },
            "CustomStepDetails": { 
               "Name": "string",
               "SourceFileLocation": "string",
               "Target": "string",
               "TimeoutSeconds": number
            },
            "DecryptStepDetails": { 
               "DestinationFileLocation": { 
                  "EfsFileLocation": { 
                     "FileSystemId": "string",
                     "Path": "string"
                  },
                  "S3FileLocation": { 
                     "Bucket": "string",
                     "Key": "string"
                  }
               },
               "Name": "string",
               "OverwriteExisting": "string",
               "SourceFileLocation": "string",
               "Type": "string"
            },
            "DeleteStepDetails": { 
               "Name": "string",
               "SourceFileLocation": "string"
            },
            "TagStepDetails": { 
               "Name": "string",
               "SourceFileLocation": "string",
               "Tags": [ 
                  { 
                     "Key": "string",
                     "Value": "string"
                  }
               ]
            },
            "Type": "string"
         }
      ],
      "Tags": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ],
      "WorkflowId": "string"
   }
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Workflow](#API_DescribeWorkflow_ResponseSyntax) **   <a name="TransferFamily-DescribeWorkflow-response-Workflow"></a>
The structure that contains the details of the workflow.  
Type: [DescribedWorkflow](API_DescribedWorkflow.md) object

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServiceError **   
This exception is thrown when an error occurs in the Amazon Transfer Family service.  
HTTP Status Code: 500

 ** InvalidRequestException **   
This exception is thrown when the client submits a malformed request.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
This exception is thrown when a resource is not found by the AmazonTransfer Family service.  
HTTP Status Code: 400

 ** ServiceUnavailableException **   
The request has failed because the AmazonTransfer Family service is not available.  
HTTP Status Code: 500

## See Also


For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/transfer-2018-11-05/DescribeWorkflow) 
+  [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/transfer-2018-11-05/DescribeWorkflow) 
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/transfer-2018-11-05/DescribeWorkflow) 
+  [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/transfer-2018-11-05/DescribeWorkflow) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/transfer-2018-11-05/DescribeWorkflow) 
+  [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/transfer-2018-11-05/DescribeWorkflow) 
+  [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/transfer-2018-11-05/DescribeWorkflow) 
+  [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/transfer-2018-11-05/DescribeWorkflow) 
+  [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/transfer-2018-11-05/DescribeWorkflow) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/transfer-2018-11-05/DescribeWorkflow)