Amazon Snow Family · JSON Structure

Amazon Snow Family Update Job Shipment State Request Structure

UpdateJobShipmentStateRequest schema from Amazon Snow Family API

Type: object Properties: 2 Required: 2
Data MigrationEdge ComputingOffline TransferPhysical Appliance

UpdateJobShipmentStateRequest is a JSON Structure definition published by Amazon Snow Family, describing 2 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

JobId ShipmentState

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "type": "object",
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-snow-family/refs/heads/main/json-structure/amazon-snow-family-update-job-shipment-state-request-structure.json",
  "name": "UpdateJobShipmentStateRequest",
  "description": "UpdateJobShipmentStateRequest schema from Amazon Snow Family API",
  "properties": {
    "JobId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/JobId"
        },
        {
          "description": "The job ID of the job whose shipment date you want to update, for example <code>JID123e4567-e89b-12d3-a456-426655440000</code>."
        }
      ]
    },
    "ShipmentState": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ShipmentState"
        },
        {
          "description": "<p>The state of a device when it is being shipped. </p> <p>Set to <code>RECEIVED</code> when the device arrives at your location.</p> <p>Set to <code>RETURNED</code> when you have returned the device to Amazon Web Services.</p>"
        }
      ]
    }
  },
  "required": [
    "JobId",
    "ShipmentState"
  ]
}