BatchGetStepItem
The details of a step returned in a batch get operation.
Contents
- createdAt
-
The date and time the resource was created.
Type: Timestamp
Required: Yes
- createdBy
-
The user or system that created this resource.
Type: String
Required: Yes
- farmId
-
The farm ID of the step.
Type: String
Pattern:
farm-[0-9a-f]{32}Required: Yes
- jobId
-
The job ID of the step.
Type: String
Pattern:
job-[0-9a-f]{32}Required: Yes
- lifecycleStatus
-
The life cycle status of the step.
Type: String
Valid Values:
CREATE_COMPLETE | UPDATE_IN_PROGRESS | UPDATE_FAILED | UPDATE_SUCCEEDEDRequired: Yes
- name
-
The name of the step.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Required: Yes
- queueId
-
The queue ID of the step.
Type: String
Pattern:
queue-[0-9a-f]{32}Required: Yes
- stepId
-
The step ID.
Type: String
Pattern:
step-[0-9a-f]{32}Required: Yes
- taskRunStatus
-
The task run status for the step.
Type: String
Valid Values:
PENDING | READY | ASSIGNED | STARTING | SCHEDULED | INTERRUPTING | RUNNING | SUSPENDED | CANCELED | FAILED | SUCCEEDED | NOT_COMPATIBLERequired: Yes
- taskRunStatusCounts
-
The number of tasks for each run status for the step.
Type: String to integer map
Valid Keys:
PENDING | READY | ASSIGNED | STARTING | SCHEDULED | INTERRUPTING | RUNNING | SUSPENDED | CANCELED | FAILED | SUCCEEDED | NOT_COMPATIBLERequired: Yes
- dependencyCounts
-
The number of dependencies for the step.
Type: DependencyCounts object
Required: No
- description
-
The description of the step.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
- endedAt
-
The date and time the resource ended running.
Type: Timestamp
Required: No
- lifecycleStatusMessage
-
A message that communicates the status of the life cycle.
Type: String
Required: No
- parameterSpace
-
The parameter space for the step.
Type: ParameterSpace object
Required: No
- requiredCapabilities
-
The required capabilities for the step.
Type: StepRequiredCapabilities object
Required: No
- startedAt
-
The date and time the resource started running.
Type: Timestamp
Required: No
- targetTaskRunStatus
-
The task status to start with on the step.
Type: String
Valid Values:
READY | FAILED | SUCCEEDED | CANCELED | SUSPENDED | PENDINGRequired: No
- taskFailureRetryCount
-
The number of times that tasks failed and were retried.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 2147483647.
Required: No
- updatedAt
-
The date and time the resource was updated.
Type: Timestamp
Required: No
- updatedBy
-
The user or system that updated this resource.
Type: String
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
