{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/amazon-opensearch/json-schema/amazon-opensearch-start-service-software-update-request-schema.json",
  "title": "StartServiceSoftwareUpdateRequest",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/amazon-opensearch-opensearch-api-openapi.yml#/components/schemas/StartServiceSoftwareUpdateRequest",
  "type": "object",
  "properties": {
    "DomainName": {
      "type": "string",
      "description": "The name of the domain that you want to update to the latest service software."
    },
    "ScheduleAt": {
      "type": "string",
      "enum": [
        "NOW",
        "TIMESTAMP",
        "OFF_PEAK_WINDOW"
      ],
      "description": "When to start the service software update. NOW - Immediately schedules the update to happen in the current hour if there's capacity available. TIMESTAMP - Lets you specify a custom date and time to apply the update. If you specify this value, you must also provide a value for DesiredStartTime. OFF_PEAK_WINDOW - Marks the update to be picked up during an upcoming off-peak window. There's no guarantee that the update will happen during the next immediate window. Depending on capacity, it might happen in subsequent days. Default: NOW if you don't specify a value for DesiredStartTime, and TIMESTAM"
    },
    "DesiredStartTime": {
      "type": "integer",
      "description": "The Epoch timestamp when you want the service software update to start. You only need to specify this parameter if you set ScheduleAt to TIMESTAMP."
    }
  },
  "required": [
    "DomainName"
  ]
}