GetStep
Gets a step.
Request Syntax
GET /2023-10-12/farms/farmId/queues/queueId/jobs/jobId/steps/stepId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"createdAt": "string",
"createdBy": "string",
"dependencyCounts": {
"consumersResolved": number,
"consumersUnresolved": number,
"dependenciesResolved": number,
"dependenciesUnresolved": number
},
"description": "string",
"endedAt": "string",
"lifecycleStatus": "string",
"lifecycleStatusMessage": "string",
"name": "string",
"parameterSpace": {
"combination": "string",
"parameters": [
{
"name": "string",
"type": "string"
}
]
},
"requiredCapabilities": {
"amounts": [
{
"max": number,
"min": number,
"name": "string",
"value": number
}
],
"attributes": [
{
"allOf": [ "string" ],
"anyOf": [ "string" ],
"name": "string"
}
]
},
"startedAt": "string",
"stepId": "string",
"targetTaskRunStatus": "string",
"taskRunStatus": "string",
"taskRunStatusCounts": {
"string" : number
},
"updatedAt": "string",
"updatedBy": "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.
- createdAt
-
The date and time the resource was created.
Type: Timestamp
- createdBy
-
The user or system that created this resource.
Type: String
- dependencyCounts
-
The number of dependencies in the step.
Type: DependencyCounts object
- description
-
The description of the step.
Important
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
- endedAt
-
The date and time the resource ended running.
Type: Timestamp
- lifecycleStatus
-
The life cycle status of the step.
Type: String
Valid Values:
CREATE_COMPLETE | UPDATE_IN_PROGRESS | UPDATE_FAILED | UPDATE_SUCCEEDED - lifecycleStatusMessage
-
A message that describes the lifecycle status of the step.
Type: String
- name
-
The name of the step.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
- parameterSpace
-
A list of step parameters and the combination expression for the step.
Type: ParameterSpace object
- requiredCapabilities
-
The required capabilities of the step.
Type: StepRequiredCapabilities object
- startedAt
-
The date and time the resource started running.
Type: Timestamp
- stepId
-
The step ID.
Type: String
Pattern:
step-[0-9a-f]{32} - targetTaskRunStatus
-
The task status with which the job started.
Type: String
Valid Values:
READY | FAILED | SUCCEEDED | CANCELED | SUSPENDED | PENDING - taskRunStatus
-
The task run status for the job.
Type: String
Valid Values:
PENDING | READY | ASSIGNED | STARTING | SCHEDULED | INTERRUPTING | RUNNING | SUSPENDED | CANCELED | FAILED | SUCCEEDED | NOT_COMPATIBLE - taskRunStatusCounts
-
The number of tasks running on the job.
Type: String to integer map
Valid Keys:
PENDING | READY | ASSIGNED | STARTING | SCHEDULED | INTERRUPTING | RUNNING | SUSPENDED | CANCELED | FAILED | SUCCEEDED | NOT_COMPATIBLE - updatedAt
-
The date and time the resource was updated.
Type: Timestamp
- updatedBy
-
The user or system that updated this resource.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You don't have permission to perform the action.
HTTP Status Code: 403
- InternalServerErrorException
-
Deadline Cloud can't process your request right now. Try again later.
HTTP Status Code: 500
- ResourceNotFoundException
-
The requested resource can't be found.
HTTP Status Code: 404
- ThrottlingException
-
Your request exceeded a request rate quota.
HTTP Status Code: 429
- ValidationException
-
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
