The current options of an Elasticsearch domain service software options.
Type: objectProperties: 8
AnalyticsElasticsearchSearch
ServiceSoftwareOptions is a JSON Structure definition published by Amazon OpenSearch Service API, describing 8 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
{
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-opensearch/refs/heads/main/json-structure/openapi-service-software-options-structure.json",
"name": "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": "<code>True</code> if you are able to update you service software version. <code>False</code> if you are not able to update your service software version. "
}
]
},
"Cancellable": {
"allOf": [
{
"$ref": "#/components/schemas/Boolean"
},
{
"description": "<code>True</code> if you are able to cancel your service software version update. <code>False</code> 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: <code>ELIGIBLE</code>, <code>PENDING_UPDATE</code>, <code>IN_PROGRESS</code>, <code>COMPLETED</code>, and <code>NOT_ELIGIBLE</code>."
}
]
},
"Description": {
"allOf": [
{
"$ref": "#/components/schemas/String"
},
{
"description": "The description of the <code>UpdateStatus</code>."
}
]
},
"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": "<code>True</code> if a service software is never automatically updated. <code>False</code> if a service software is automatically updated after <code>AutomatedUpdateDate</code>. "
}
]
}
}
}
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.