GetWorkflowStepExecutionResponse

GetWorkflowStepExecutionResponse schema from EC2 Image Builder

Amazon Web ServicesAutomationContainer ImagesEC2Image BuildingVirtual Machine Images

Properties

Name Type Description
requestId object
stepExecutionId object
workflowBuildVersionArn object
workflowExecutionId object
imageBuildVersionArn object
name object
description object
action object
status object
rollbackStatus object
message object
inputs object
outputs object
startTime object
endTime object
onFailure object
timeoutSeconds object
View JSON Schema on GitHub

JSON Schema

ec2-image-builder-get-workflow-step-execution-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-ec2-image-builder/refs/heads/main/json-schema/ec2-image-builder-get-workflow-step-execution-response-schema.json",
  "title": "GetWorkflowStepExecutionResponse",
  "description": "GetWorkflowStepExecutionResponse schema from EC2 Image Builder",
  "type": "object",
  "properties": {
    "requestId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NonEmptyString"
        },
        {
          "description": "The request ID that uniquely identifies this request."
        }
      ]
    },
    "stepExecutionId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WorkflowStepExecutionId"
        },
        {
          "description": "The unique identifier for the runtime version of the workflow step that you specified in the request."
        }
      ]
    },
    "workflowBuildVersionArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WorkflowBuildVersionArn"
        },
        {
          "description": "The Amazon Resource Name (ARN) of the build version for the Image Builder workflow resource that defines this workflow step."
        }
      ]
    },
    "workflowExecutionId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WorkflowExecutionId"
        },
        {
          "description": "The unique identifier that Image Builder assigned to keep track of runtime details when it ran the workflow."
        }
      ]
    },
    "imageBuildVersionArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ImageBuildVersionArn"
        },
        {
          "description": "The Amazon Resource Name (ARN) of the image resource build version that the specified runtime instance of the workflow step creates."
        }
      ]
    },
    "name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WorkflowStepName"
        },
        {
          "description": "The name of the specified runtime instance of the workflow step."
        }
      ]
    },
    "description": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WorkflowStepDescription"
        },
        {
          "description": "Describes the specified workflow step."
        }
      ]
    },
    "action": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WorkflowStepAction"
        },
        {
          "description": "The name of the action that the specified step performs."
        }
      ]
    },
    "status": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WorkflowStepExecutionStatus"
        },
        {
          "description": "The current status for the specified runtime version of the workflow step."
        }
      ]
    },
    "rollbackStatus": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WorkflowStepExecutionRollbackStatus"
        },
        {
          "description": "Reports on the rollback status of the specified runtime version of the workflow step, if applicable."
        }
      ]
    },
    "message": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WorkflowStepMessage"
        },
        {
          "description": "The output message from the specified runtime instance of the workflow step, if applicable."
        }
      ]
    },
    "inputs": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WorkflowStepInputs"
        },
        {
          "description": "Input parameters that Image Builder provided for the specified runtime instance of the workflow step."
        }
      ]
    },
    "outputs": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WorkflowStepOutputs"
        },
        {
          "description": "The file names that the specified runtime version of the workflow step created as output."
        }
      ]
    },
    "startTime": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DateTime"
        },
        {
          "description": "The timestamp when the specified runtime version of the workflow step started."
        }
      ]
    },
    "endTime": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DateTime"
        },
        {
          "description": "The timestamp when the specified runtime instance of the workflow step finished."
        }
      ]
    },
    "onFailure": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NonEmptyString"
        },
        {
          "description": "The action to perform if the workflow step fails."
        }
      ]
    },
    "timeoutSeconds": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WorkflowStepTimeoutSecondsInteger"
        },
        {
          "description": "The maximum duration in seconds for this step to complete its action."
        }
      ]
    }
  }
}