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.
The request accepts the following data in JSON format.
- WorkflowId
-
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
-
The structure that contains the details of the workflow.
Type: DescribedWorkflow object
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServiceError
-
This exception is thrown when an error occurs in the AWS 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 AWSTransfer Family service.
HTTP Status Code: 400
- ServiceUnavailableException
-
The request has failed because the AWSTransfer Family service is not available.
HTTP Status Code: 500
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
