DescribeExecution
You can use DescribeExecution to check the details of the execution of the specified workflow.
Note
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.
Request Syntax
{
"ExecutionId": "string",
"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.
- ExecutionId
-
A unique identifier for the execution of a workflow.
Type: String
Length Constraints: Fixed length of 36.
Pattern:
[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}Required: Yes
- 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
{
"Execution": {
"ExecutionId": "string",
"ExecutionRole": "string",
"InitialFileLocation": {
"EfsFileLocation": {
"FileSystemId": "string",
"Path": "string"
},
"S3FileLocation": {
"Bucket": "string",
"Etag": "string",
"Key": "string",
"VersionId": "string"
}
},
"LoggingConfiguration": {
"LoggingRole": "string",
"LogGroupName": "string"
},
"PosixProfile": {
"Gid": number,
"SecondaryGids": [ number ],
"Uid": number
},
"Results": {
"OnExceptionSteps": [
{
"Error": {
"Message": "string",
"Type": "string"
},
"Outputs": "string",
"StepType": "string"
}
],
"Steps": [
{
"Error": {
"Message": "string",
"Type": "string"
},
"Outputs": "string",
"StepType": "string"
}
]
},
"ServiceMetadata": {
"UserDetails": {
"ServerId": "string",
"SessionId": "string",
"UserName": "string"
}
},
"Status": "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.
- Execution
-
The structure that contains the details of the workflow' execution.
Type: DescribedExecution object
- WorkflowId
-
A unique identifier for the workflow.
Type: String
Length Constraints: Fixed length of 19.
Pattern:
w-([a-z0-9]{17})
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:
