EffectiveDeployment

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-iot-greengrass/refs/heads/main/json-schema/iot-greengrass-effective-deployment-schema.json",
  "title": "EffectiveDeployment",
  "description": "Contains information about a deployment job that IoT Greengrass sends to a Greengrass core device.",
  "type": "object",
  "properties": {
    "deploymentId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DeploymentID"
        },
        {
          "description": "The ID of the deployment."
        }
      ]
    },
    "deploymentName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DeploymentName"
        },
        {
          "description": "The name of the deployment."
        }
      ]
    },
    "iotJobId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/IoTJobId"
        },
        {
          "description": "The ID of the IoT job that applies the deployment to target devices."
        }
      ]
    },
    "iotJobArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/IoTJobARN"
        },
        {
          "description": "The <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">ARN</a> of the IoT job that applies the deployment to target devices."
        }
      ]
    },
    "description": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Description"
        },
        {
          "description": "The description of the deployment job."
        }
      ]
    },
    "targetArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TargetARN"
        },
        {
          "description": "The <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">ARN</a> of the target IoT thing or thing group."
        }
      ]
    },
    "coreDeviceExecutionStatus": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EffectiveDeploymentExecutionStatus"
        },
        {
          "description": "<p>The status of the deployment job on the Greengrass core device.</p> <ul> <li> <p> <code>IN_PROGRESS</code> \u2013 The deployment job is running.</p> </li> <li> <p> <code>QUEUED</code> \u2013 The deployment job is in the job queue and waiting to run.</p> </li> <li> <p> <code>FAILED</code> \u2013 The deployment failed. For more information, see the <code>statusDetails</code> field.</p> </li> <li> <p> <code>COMPLETED</code> \u2013 The deployment to an IoT thing was completed successfully.</p> </li> <li> <p> <code>TIMED_OUT</code> \u2013 The deployment didn't complete in the allotted time. </p> </li> <li> <p> <code>CANCELED</code> \u2013 The deployment was canceled by the user.</p> </li> <li> <p> <code>REJECTED</code> \u2013 The deployment was rejected. For more information, see the <code>statusDetails</code> field.</p> </li> <li> <p> <code>SUCCEEDED</code> \u2013 The deployment to an IoT thing group was completed successfully.</p> </li> </ul>"
        }
      ]
    },
    "reason": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Reason"
        },
        {
          "description": "The reason code for the update, if the job was updated."
        }
      ]
    },
    "creationTimestamp": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "The time at which the deployment was created, expressed in ISO 8601 format."
        }
      ]
    },
    "modifiedTimestamp": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "The time at which the deployment job was last modified, expressed in ISO 8601 format."
        }
      ]
    },
    "statusDetails": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EffectiveDeploymentStatusDetails"
        },
        {
          "description": "The status details that explain why a deployment has an error. This response will be null if the deployment is in a success state."
        }
      ]
    }
  },
  "required": [
    "deploymentId",
    "deploymentName",
    "targetArn",
    "coreDeviceExecutionStatus",
    "creationTimestamp",
    "modifiedTimestamp"
  ]
}