{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-opensearch/refs/heads/main/json-schema/openapi-service-software-options-schema.json",
"title": "ServiceSoftwareOptions",
"description": "The current options of an Elasticsearch domain service software options.",
"type": "object",
"properties": {
"CurrentVersion": {
"allOf": [
{
"$ref": "#/components/schemas/String"
},
{
"description": "The current service software version that is present on the domain."
}
]
},
"NewVersion": {
"allOf": [
{
"$ref": "#/components/schemas/String"
},
{
"description": "The new service software version if one is available."
}
]
},
"UpdateAvailable": {
"allOf": [
{
"$ref": "#/components/schemas/Boolean"
},
{
"description": "True if you are able to update you service software version. False if you are not able to update your service software version. "
}
]
},
"Cancellable": {
"allOf": [
{
"$ref": "#/components/schemas/Boolean"
},
{
"description": "True if you are able to cancel your service software version update. False if you are not able to cancel your service software version. "
}
]
},
"UpdateStatus": {
"allOf": [
{
"$ref": "#/components/schemas/DeploymentStatus"
},
{
"description": "The status of your service software update. This field can take the following values: ELIGIBLE, PENDING_UPDATE, IN_PROGRESS, COMPLETED, and NOT_ELIGIBLE."
}
]
},
"Description": {
"allOf": [
{
"$ref": "#/components/schemas/String"
},
{
"description": "The description of the UpdateStatus."
}
]
},
"AutomatedUpdateDate": {
"allOf": [
{
"$ref": "#/components/schemas/DeploymentCloseDateTimeStamp"
},
{
"description": "Timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software."
}
]
},
"OptionalDeployment": {
"allOf": [
{
"$ref": "#/components/schemas/Boolean"
},
{
"description": "True if a service software is never automatically updated. False if a service software is automatically updated after AutomatedUpdateDate. "
}
]
}
}
}