UpdateDomainConfigResponse

AnalyticsAmazon Web ServicesElasticsearchSearch

Properties

Name Type Description
DomainConfig object
DryRunResults object
DryRunProgressStatus object
View JSON Schema on GitHub

JSON Schema

amazon-opensearch-update-domain-config-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/amazon-opensearch/json-schema/amazon-opensearch-update-domain-config-response-schema.json",
  "title": "UpdateDomainConfigResponse",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/amazon-opensearch-config-api-openapi.yml#/components/schemas/UpdateDomainConfigResponse",
  "type": "object",
  "properties": {
    "DomainConfig": {
      "$ref": "#/$defs/DomainConfig"
    },
    "DryRunResults": {
      "$ref": "#/$defs/DryRunResults"
    },
    "DryRunProgressStatus": {
      "$ref": "#/$defs/DryRunProgressStatus"
    }
  },
  "required": [
    "DomainConfig"
  ],
  "$defs": {
    "AIMLOptionsOutput": {
      "type": "object",
      "properties": {
        "NaturalLanguageQueryGenerationOptions": {
          "$ref": "#/$defs/NaturalLanguageQueryGenerationOptionsOutput"
        },
        "S3VectorsEngine": {
          "$ref": "#/$defs/S3VectorsEngine"
        },
        "ServerlessVectorAcceleration": {
          "$ref": "#/$defs/ServerlessVectorAcceleration"
        }
      }
    },
    "AIMLOptionsStatus": {
      "type": "object",
      "properties": {
        "Options": {
          "$ref": "#/$defs/AIMLOptionsOutput"
        },
        "Status": {
          "$ref": "#/$defs/OptionStatus"
        }
      }
    },
    "AccessPoliciesStatus": {
      "type": "object",
      "properties": {
        "Options": {
          "type": "string",
          "description": "The access policy configured for the domain. Access policies can be resource-based, IP-based, or IAM-based. For more information, see Configuring access policies."
        },
        "Status": {
          "$ref": "#/$defs/OptionStatus"
        }
      },
      "required": [
        "Options",
        "Status"
      ]
    },
    "AdvancedOptionsStatus": {
      "type": "object",
      "properties": {
        "Options": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          },
          "description": "The status of advanced options for the specified domain."
        },
        "Status": {
          "$ref": "#/$defs/OptionStatus"
        }
      },
      "required": [
        "Options",
        "Status"
      ]
    },
    "AdvancedSecurityOptions": {
      "type": "object",
      "properties": {
        "Enabled": {
          "type": "boolean",
          "description": "True if fine-grained access control is enabled."
        },
        "InternalUserDatabaseEnabled": {
          "type": "boolean",
          "description": "True if the internal user database is enabled."
        },
        "SAMLOptions": {
          "$ref": "#/$defs/SAMLOptionsOutput"
        },
        "JWTOptions": {
          "$ref": "#/$defs/JWTOptionsOutput"
        },
        "IAMFederationOptions": {
          "$ref": "#/$defs/IAMFederationOptionsOutput"
        },
        "AnonymousAuthDisableDate": {
          "type": "string",
          "format": "date-time",
          "description": "Date and time when the migration period will be disabled. Only necessary when enabling fine-grained access control on an existing domain."
        },
        "AnonymousAuthEnabled": {
          "type": "boolean",
          "description": "True if a 30-day migration period is enabled, during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain."
        }
      }
    },
    "AdvancedSecurityOptionsStatus": {
      "type": "object",
      "properties": {
        "Options": {
          "$ref": "#/$defs/AdvancedSecurityOptions"
        },
        "Status": {
          "$ref": "#/$defs/OptionStatus"
        }
      },
      "required": [
        "Options",
        "Status"
      ]
    },
    "AutoTuneMaintenanceSchedule": {
      "type": "object",
      "properties": {
        "StartAt": {
          "type": "string",
          "format": "date-time",
          "description": "The Epoch timestamp at which the Auto-Tune maintenance schedule starts."
        },
        "Duration": {
          "$ref": "#/$defs/Duration"
        },
        "CronExpressionForRecurrence": {
          "type": "string",
          "description": "A cron expression for a recurring maintenance schedule during which Auto-Tune can deploy changes."
        }
      }
    },
    "AutoTuneOptions": {
      "type": "object",
      "properties": {
        "DesiredState": {
          "type": "string",
          "enum": [
            "ENABLED",
            "DISABLED"
          ],
          "description": "Whether Auto-Tune is enabled or disabled."
        },
        "RollbackOnDisable": {
          "type": "string",
          "enum": [
            "NO_ROLLBACK",
            "DEFAULT_ROLLBACK"
          ],
          "description": "When disabling Auto-Tune, specify NO_ROLLBACK to retain all prior Auto-Tune settings or DEFAULT_ROLLBACK to revert to the OpenSearch Service defaults. If you specify DEFAULT_ROLLBACK, you must include a MaintenanceSchedule in the request. Otherwise, OpenSearch Service is unable to perform the rollback."
        },
        "MaintenanceSchedules": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/AutoTuneMaintenanceSchedule"
          },
          "description": "DEPRECATED. Use off-peak window instead. A list of maintenance schedules during which Auto-Tune can deploy changes."
        },
        "UseOffPeakWindow": {
          "type": "boolean",
          "description": "Whether to use the domain's off-peak window to deploy configuration changes on the domain rather than a maintenance schedule."
        }
      }
    },
    "AutoTuneOptionsStatus": {
      "type": "object",
      "properties": {
        "Options": {
          "$ref": "#/$defs/AutoTuneOptions"
        },
        "Status": {
          "$ref": "#/$defs/AutoTuneStatus"
        }
      }
    },
    "AutoTuneStatus": {
      "type": "object",
      "properties": {
        "CreationDate": {
          "type": "string",
          "format": "date-time",
          "description": "Date and time when Auto-Tune was enabled for the domain."
        },
        "UpdateDate": {
          "type": "string",
          "format": "date-time",
          "description": "Date and time when the Auto-Tune options were last updated for the domain."
        },
        "UpdateVersion": {
          "type": "integer",
          "description": "The latest version of the Auto-Tune options."
        },
        "State": {
          "type": "string",
          "enum": [
            "ENABLED",
            "DISABLED",
            "ENABLE_IN_PROGRESS",
            "DISABLE_IN_PROGRESS",
            "DISABLED_AND_ROLLBACK_SCHEDULED",
            "DISABLED_AND_ROLLBACK_IN_PROGRESS",
            "DISABLED_AND_ROLLBACK_COMPLETE",
            "DISABLED_AND_ROLLBACK_ERROR",
            "ERROR"
          ],
          "description": "The current state of Auto-Tune on the domain."
        },
        "ErrorMessage": {
          "type": "string",
          "description": "Any errors that occurred while enabling or disabling Auto-Tune."
        },
        "PendingDeletion": {
          "type": "boolean",
          "description": "Indicates whether the domain is being deleted."
        }
      },
      "required": [
        "CreationDate",
        "UpdateDate",
        "State"
      ]
    },
    "AutomatedSnapshotPauseOptions": {
      "type": "object",
      "properties": {
        "Enabled": {
          "type": "boolean",
          "description": "Whether automated snapshot pause is enabled for the domain."
        },
        "StartTime": {
          "type": "string",
          "format": "date-time",
          "description": "The timestamp at which the automated snapshot pause begins."
        },
        "EndTime": {
          "type": "string",
          "format": "date-time",
          "description": "The timestamp at which the automated snapshot pause ends."
        },
        "State": {
          "type": "string",
          "enum": [
            "Active",
            "Completed",
            "Scheduled",
            "Disabled"
          ],
          "description": "The current state of the automated snapshot pause. Valid values are Active, Completed, Scheduled, and Disabled."
        }
      },
      "required": [
        "Enabled"
      ]
    },
    "AutomatedSnapshotPauseOptionsStatus": {
      "type": "object",
      "properties": {
        "Options": {
          "$ref": "#/$defs/AutomatedSnapshotPauseOptions"
        },
        "Status": {
          "$ref": "#/$defs/OptionStatus"
        }
      },
      "required": [
        "Options",
        "Status"
      ]
    },
    "ChangeProgressDetails": {
      "type": "object",
      "properties": {
        "ChangeId": {
          "type": "string",
          "description": "The ID of the configuration change."
        },
        "Message": {
          "type": "string",
          "description": "A message corresponding to the status of the configuration change."
        },
        "ConfigChangeStatus": {
          "type": "string",
          "enum": [
            "Pending",
            "Initializing",
            "Validating",
            "ValidationFailed",
            "ApplyingChanges",
            "Completed",
            "PendingUserInput",
            "Cancelled"
          ],
          "description": "The current status of the configuration change."
        },
        "InitiatedBy": {
          "type": "string",
          "enum": [
            "CUSTOMER",
            "SERVICE"
          ],
          "description": "The IAM principal who initiated the configuration change."
        },
        "StartTime": {
          "type": "string",
          "format": "date-time",
          "description": "The time that the configuration change was initiated, in Universal Coordinated Time (UTC)."
        },
        "LastUpdatedTime": {
          "type": "string",
          "format": "date-time",
          "description": "The last time that the configuration change was updated."
        }
      }
    },
    "ClusterConfig": {
      "type": "object",
      "properties": {
        "InstanceType": {
          "type": "string",
          "enum": [
            "m3.medium.search",
            "m3.large.search",
            "m3.xlarge.search",
            "m3.2xlarge.search",
            "m4.large.search",
            "m4.xlarge.search",
            "m4.2xlarge.search",
            "m4.4xlarge.search",
            "m4.10xlarge.search",
            "m5.large.search",
            "m5.xlarge.search",
            "m5.2xlarge.search",
            "m5.4xlarge.search",
            "m5.12xlarge.search",
            "m5.24xlarge.search",
            "r5.large.search",
            "r5.xlarge.search",
            "r5.2xlarge.search",
            "r5.4xlarge.search",
            "r5.12xlarge.search",
            "r5.24xlarge.search",
            "c5.large.search",
            "c5.xlarge.search",
            "c5.2xlarge.search",
            "c5.4xlarge.search",
            "c5.9xlarge.search",
            "c5.18xlarge.search",
            "t3.nano.search",
            "t3.micro.search",
            "t3.small.search",
            "t3.medium.search",
            "t3.large.search",
            "t3.xlarge.search",
            "t3.2xlarge.search",
            "or1.medium.search",
            "or1.large.search",
            "or1.xlarge.search",
            "or1.2xlarge.search",
            "or1.4xlarge.search",
            "or1.8xlarge.search",
            "or1.12xlarge.search",
            "or1.16xlarge.search",
            "ultrawarm1.medium.search",
            "ultrawarm1.large.search",
            "ultrawarm1.xlarge.search",
            "t2.micro.search",
            "t2.small.search",
            "t2.medium.search",
            "r3.large.search",
            "r3.xlarge.search",
            "r3.2xlarge.search",
            "r3.4xlarge.search",
            "r3.8xlarge.search",
            "i2.xlarge.search",
            "i2.2xlarge.search",
            "d2.xlarge.search",
            "d2.2xlarge.search",
            "d2.4xlarge.search",
            "d2.8xlarge.search",
            "c4.large.search",
            "c4.xlarge.search",
            "c4.2xlarge.search",
            "c4.4xlarge.search",
            "c4.8xlarge.search",
            "r4.large.search",
            "r4.xlarge.search",
            "r4.2xlarge.search",
            "r4.4xlarge.search",
            "r4.8xlarge.search",
            "r4.16xlarge.search",
            "i3.large.search",
            "i3.xlarge.search",
            "i3.2xlarge.search",
            "i3.4xlarge.search",
            "i3.8xlarge.search",
            "i3.16xlarge.search",
            "r6g.large.search",
            "r6g.xlarge.search",
            "r6g.2xlarge.search",
            "r6g.4xlarge.search",
            "r6g.8xlarge.search",
            "r6g.12xlarge.search",
            "m6g.large.search",
            "m6g.xlarge.search",
            "m6g.2xlarge.search",
            "m6g.4xlarge.search",
            "m6g.8xlarge.search",
            "m6g.12xlarge.search",
            "c6g.large.search",
            "c6g.xlarge.search",
            "c6g.2xlarge.search",
            "c6g.4xlarge.search",
            "c6g.8xlarge.search",
            "c6g.12xlarge.search",
            "r6gd.large.search",
            "r6gd.xlarge.search",
            "r6gd.2xlarge.search",
            "r6gd.4xlarge.search",
            "r6gd.8xlarge.search",
            "r6gd.12xlarge.search",
            "r6gd.16xlarge.search",
            "t4g.small.search",
            "t4g.medium.search"
          ],
          "description": "Instance type of data nodes in the cluster."
        },
        "InstanceCount": {
          "type": "integer",
          "description": "Number of data nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception."
        },
        "DedicatedMasterEnabled": {
          "type": "boolean",
          "description": "Indicates whether dedicated master nodes are enabled for the cluster.True if the cluster will use a dedicated master node.False if the cluster will not."
        },
        "ZoneAwarenessEnabled": {
          "type": "boolean",
          "description": "Indicates whether multiple Availability Zones are enabled. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service."
        },
        "ZoneAwarenessConfig": {
          "$ref": "#/$defs/ZoneAwarenessConfig"
        },
        "DedicatedMasterType": {
          "type": "string",
          "enum": [
            "m3.medium.search",
            "m3.large.search",
            "m3.xlarge.search",
            "m3.2xlarge.search",
            "m4.large.search",
            "m4.xlarge.search",
            "m4.2xlarge.search",
            "m4.4xlarge.search",
            "m4.10xlarge.search",
            "m5.large.search",
            "m5.xlarge.search",
            "m5.2xlarge.search",
            "m5.4xlarge.search",
            "m5.12xlarge.search",
            "m5.24xlarge.search",
            "r5.large.search",
            "r5.xlarge.search",
            "r5.2xlarge.search",
            "r5.4xlarge.search",
            "r5.12xlarge.search",
            "r5.24xlarge.search",
            "c5.large.search",
            "c5.xlarge.search",
            "c5.2xlarge.search",
            "c5.4xlarge.search",
            "c5.9xlarge.search",
            "c5.18xlarge.search",
            "t3.nano.search",
            "t3.micro.search",
            "t3.small.search",
            "t3.medium.search",
            "t3.large.search",
            "t3.xlarge.search",
            "t3.2xlarge.search",
            "or1.medium.search",
            "or1.large.search",
            "or1.xlarge.search",
            "or1.2xlarge.search",
            "or1.4xlarge.search",
            "or1.8xlarge.search",
            "or1.12xlarge.search",
            "or1.16xlarge.search",
            "ultrawarm1.medium.search",
            "ultrawarm1.large.search",
            "ultrawarm1.xlarge.search",
            "t2.micro.search",
            "t2.small.search",
            "t2.medium.search",
            "r3.large.search",
            "r3.xlarge.search",
            "r3.2xlarge.search",
            "r3.4xlarge.search",
            "r3.8xlarge.search",
            "i2.xlarge.search",
            "i2.2xlarge.search",
            "d2.xlarge.search",
            "d2.2xlarge.search",
            "d2.4xlarge.search",
            "d2.8xlarge.search",
            "c4.large.search",
            "c4.xlarge.search",
            "c4.2xlarge.search",
            "c4.4xlarge.search",
            "c4.8xlarge.search",
            "r4.large.search",
            "r4.xlarge.search",
            "r4.2xlarge.search",
            "r4.4xlarge.search",
            "r4.8xlarge.search",
            "r4.16xlarge.search",
            "i3.large.search",
            "i3.xlarge.search",
            "i3.2xlarge.search",
            "i3.4xlarge.search",
            "i3.8xlarge.search",
            "i3.16xlarge.search",
            "r6g.large.search",
            "r6g.xlarge.search",
            "r6g.2xlarge.search",
            "r6g.4xlarge.search",
            "r6g.8xlarge.search",
            "r6g.12xlarge.search",
            "m6g.large.search",
            "m6g.xlarge.search",
            "m6g.2xlarge.search",
            "m6g.4xlarge.search",
            "m6g.8xlarge.search",
            "m6g.12xlarge.search",
            "c6g.large.search",
            "c6g.xlarge.search",
            "c6g.2xlarge.search",
            "c6g.4xlarge.search",
            "c6g.8xlarge.search",
            "c6g.12xlarge.search",
            "r6gd.large.search",
            "r6gd.xlarge.search",
            "r6gd.2xlarge.search",
            "r6gd.4xlarge.search",
            "r6gd.8xlarge.search",
            "r6gd.12xlarge.search",
            "r6gd.16xlarge.search",
            "t4g.small.search",
            "t4g.medium.search"
          ],
          "description": "OpenSearch Service instance type of the dedicated master nodes in the cluster."
        },
        "DedicatedMasterCount": {
          "type": "integer",
          "description": "Number of dedicated master nodes in the cluster. This number must be greater than 2 and not 4, otherwise you receive a validation exception."
        },
        "WarmEnabled": {
          "type": "boolean",
          "description": "Whether to enable warm storage for the cluster."
        },
        "WarmType": {
          "type": "string",
          "enum": [
            "ultrawarm1.medium.search",
            "ultrawarm1.large.search",
            "ultrawarm1.xlarge.search"
          ],
          "description": "The instance type for the cluster's warm nodes."
        },
        "WarmCount": {
          "type": "integer",
          "description": "The number of warm nodes in the cluster."
        },
        "ColdStorageOptions": {
          "$ref": "#/$defs/ColdStorageOptions"
        },
        "MultiAZWithStandbyEnabled": {
          "type": "boolean",
          "description": "A boolean that indicates whether a multi-AZ domain is turned on with a standby AZ. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service."
        },
        "NodeOptions": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/NodeOption"
          },
          "description": "List of node options for the domain."
        }
      }
    },
    "ClusterConfigStatus": {
      "type": "object",
      "properties": {
        "Options": {
          "$ref": "#/$defs/ClusterConfig"
        },
        "Status": {
          "$ref": "#/$defs/OptionStatus"
        }
      },
      "required": [
        "Options",
        "Status"
      ]
    },
    "CognitoOptions": {
      "type": "object",
      "properties": {
        "Enabled": {
          "type": "boolean",
          "description": "Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards."
        },
        "UserPoolId": {
          "type": "string",
          "description": "The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication."
        },
        "IdentityPoolId": {
          "type": "string",
          "description": "The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication."
        },
        "RoleArn": {
          "type": "string",
          "description": "The AmazonOpenSearchServiceCognitoAccess role that allows OpenSearch Service to configure your user pool and identity pool."
        }
      }
    },
    "CognitoOptionsStatus": {
      "type": "object",
      "properties": {
        "Options": {
          "$ref": "#/$defs/CognitoOptions"
        },
        "Status": {
          "$ref": "#/$defs/OptionStatus"
        }
      },
      "required": [
        "Options",
        "Status"
      ]
    },
    "ColdStorageOptions": {
      "type": "object",
      "properties": {
        "Enabled": {
          "type": "boolean",
          "description": "Whether to enable or disable cold storage on the domain. You must enable UltraWarm storage to enable cold storage."
        }
      },
      "required": [
        "Enabled"
      ]
    },
    "DeploymentStrategyOptions": {
      "type": "object",
      "properties": {
        "DeploymentStrategy": {
          "type": "string",
          "enum": [
            "Default",
            "CapacityOptimized"
          ],
          "description": "Specifies the deployment strategy for the domain. Valid values are Default and CapacityOptimized."
        }
      },
      "required": [
        "DeploymentStrategy"
      ]
    },
    "DeploymentStrategyOptionsStatus": {
      "type": "object",
      "properties": {
        "Options": {
          "$ref": "#/$defs/DeploymentStrategyOptions"
        },
        "Status": {
          "$ref": "#/$defs/OptionStatus"
        }
      },
      "required": [
        "Options",
        "Status"
      ]
    },
    "DomainConfig": {
      "type": "object",
      "properties": {
        "EngineVersion": {
          "$ref": "#/$defs/VersionStatus"
        },
        "ClusterConfig": {
          "$ref": "#/$defs/ClusterConfigStatus"
        },
        "EBSOptions": {
          "$ref": "#/$defs/EBSOptionsStatus"
        },
        "AccessPolicies": {
          "$ref": "#/$defs/AccessPoliciesStatus"
        },
        "IPAddressType": {
          "$ref": "#/$defs/IPAddressTypeStatus"
        },
        "SnapshotOptions": {
          "$ref": "#/$defs/SnapshotOptionsStatus"
        },
        "VPCOptions": {
          "$ref": "#/$defs/VPCDerivedInfoStatus"
        },
        "CognitoOptions": {
          "$ref": "#/$defs/CognitoOptionsStatus"
        },
        "EncryptionAtRestOptions": {
          "$ref": "#/$defs/EncryptionAtRestOptionsStatus"
        },
        "NodeToNodeEncryptionOptions": {
          "$ref": "#/$defs/NodeToNodeEncryptionOptionsStatus"
        },
        "AdvancedOptions": {
          "$ref": "#/$defs/AdvancedOptionsStatus"
        },
        "LogPublishingOptions": {
          "$ref": "#/$defs/LogPublishingOptionsStatus"
        },
        "DomainEndpointOptions": {
          "$ref": "#/$defs/DomainEndpointOptionsStatus"
        },
        "AdvancedSecurityOptions": {
          "$ref": "#/$defs/AdvancedSecurityOptionsStatus"
        },
        "IdentityCenterOptions": {
          "$ref": "#/$defs/IdentityCenterOptionsStatus"
        },
        "AutoTuneOptions": {
          "$ref": "#/$defs/AutoTuneOptionsStatus"
        },
        "ChangeProgressDetails": {
          "$ref": "#/$defs/ChangeProgressDetails"
        },
        "OffPeakWindowOptions": {
          "$ref": "#/$defs/OffPeakWindowOptionsStatus"
        },
        "SoftwareUpdateOptions": {
          "$ref": "#/$defs/SoftwareUpdateOptionsStatus"
        },
        "ModifyingProperties": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/ModifyingProperties"
          },
          "description": "Information about the domain properties that are currently being modified."
        },
        "AIMLOptions": {
          "$ref": "#/$defs/AIMLOptionsStatus"
        },
        "DeploymentStrategyOptions": {
          "$ref": "#/$defs/DeploymentStrategyOptionsStatus"
        },
        "AutomatedSnapshotPauseOptions": {
          "$ref": "#/$defs/AutomatedSnapshotPauseOptionsStatus"
        },
        "UseCase": {
          "$ref": "#/$defs/UseCaseStatus"
        },
        "EngineMode": {
          "$ref": "#/$defs/EngineModeStatus"
        }
      }
    },
    "DomainEndpointOptions": {
      "type": "object",
      "properties": {
        "EnforceHTTPS": {
          "type": "boolean",
          "description": "True to require that all traffic to the domain arrive over HTTPS."
        },
        "TLSSecurityPolicy": {
          "type": "string",
          "enum": [
            "Policy-Min-TLS-1-0-2019-07",
            "Policy-Min-TLS-1-2-2019-07",
            "Policy-Min-TLS-1-2-PFS-2023-10",
            "Policy-Min-TLS-1-2-RFC9151-FIPS-2024-08",
            "Policy-Min-TLS-1-2-FIPS-PQ-2026-10"
          ],
          "description": "Specify the TLS security policy to apply to the HTTPS endpoint of the domain. The policy can be one of the following values: Policy-Min-TLS-1-0-2019-07: TLS security policy that supports TLS version 1.0 to TLS version 1.2 Policy-Min-TLS-1-2-2019-07: TLS security policy that supports only TLS version 1.2 Policy-Min-TLS-1-2-PFS-2023-10: TLS security policy that supports TLS version 1.2 to TLS version 1.3 with perfect forward secrecy cipher suites Policy-Min-TLS-1-2-RFC9151-FIPS-2024-08: TLS security policy that supports TLS version 1.3 with FIPS Policy-Min-TLS-1-2-FIPS-PQ-2026-10: TLS security p"
        },
        "CustomEndpointEnabled": {
          "type": "boolean",
          "description": "Whether to enable a custom endpoint for the domain."
        },
        "CustomEndpoint": {
          "type": "string",
          "description": "The fully qualified URL for the custom endpoint."
        },
        "CustomEndpointCertificateArn": {
          "type": "string",
          "description": "The ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM)."
        }
      }
    },
    "DomainEndpointOptionsStatus": {
      "type": "object",
      "properties": {
        "Options": {
          "$ref": "#/$defs/DomainEndpointOptions"
        },
        "Status": {
          "$ref": "#/$defs/OptionStatus"
        }
      },
      "required": [
        "Options",
        "Status"
      ]
    },
    "DryRunProgressStatus": {
      "type": "object",
      "properties": {
        "DryRunId": {
          "type": "string",
          "description": "The unique identifier of the dry run."
        },
        "DryRunStatus": {
          "type": "string",
          "description": "The current status of the dry run."
        },
        "CreationDate": {
          "type": "string",
          "description": "The timestamp when the dry run was initiated."
        },
        "UpdateDate": {
          "type": "string",
          "description": "The timestamp when the dry run was last updated."
        },
        "ValidationFailures": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/ValidationFailure"
          },
          "description": "The validation failures that occurred as a result of the dry run."
        },
        "AcceptedWarnings": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "The list of advisory warning codes that were accepted for the configuration change."
        }
      },
      "required": [
        "DryRunId",
        "DryRunStatus",
        "CreationDate",
        "UpdateDate"
      ]
    },
    "DryRunResults": {
      "type": "object",
      "properties": {
        "DeploymentType": {
          "type": "string",
          "description": "Specifies the way in which OpenSearch Service will apply an update. Possible values are: Blue/Green - The update requires a blue/green deployment. DynamicUpdate - No blue/green deployment required Undetermined - The domain is in the middle of an update and can't predict the deployment type. Try again after the update is complete. None - The request doesn't include any configuration changes."
        },
        "Message": {
          "type": "string",
          "description": "A message corresponding to the deployment type."
        }
      }
    },
    "Duration": {
      "type": "object",
      "properties": {
        "Value": {
          "type": "integer",
          "description": "Integer to specify the value of a maintenance schedule duration."
        },
        "Unit": {
          "type": "string",
          "enum": [
            "HOURS"
          ],
          "description": "The unit of measurement for the duration of a maintenance schedule."
        }
      }
    },
    "EBSOptions": {
      "type": "object",
      "properties": {
        "EBSEnabled": {
          "type": "boolean",
          "description": "Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain."
        },
        "VolumeType": {
          "type": "string",
          "enum": [
            "standard",
            "gp2",
            "io1",
            "gp3"
          ],
          "description": "Specifies the type of EBS volumes attached to data nodes."
        },
        "VolumeSize": {
          "type": "integer",
          "description": "Specifies the size (in GiB) of EBS volumes attached to data nodes."
        },
        "Iops": {
          "type": "integer",
          "description": "Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the gp3 and provisioned IOPS EBS volume types."
        },
        "Throughput": {
          "type": "integer",
          "description": "Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the gp3 volume type."
        }
      }
    },
    "EBSOptionsStatus": {
      "type": "object",
      "properties": {
        "Options": {
          "$ref": "#/$defs/EBSOptions"
        },
        "Status": {
          "$ref": "#/$defs/OptionStatus"
        }
      },
      "required": [
        "Options",
        "Status"
      ]
    },
    "EncryptionAtRestOptions": {
      "type": "object",
      "properties": {
        "Enabled": {
          "type": "boolean",
          "description": "True to enable encryption at rest."
        },
        "KmsKeyId": {
          "type": "string",
          "description": "The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a."
        },
        "EncryptionMode": {
          "type": "string",
          "enum": [
            "DISK",
            "NATIVE"
          ],
          "description": "The type of encryption at rest applied to the domain's data. Valid values are DISK and NATIVE. DISK is the default and uses volume-level encryption. NATIVE uses engine-native, index-level encryption and requires encryption at rest to be enabled and OpenSearch version 3.3 or later. After the mode is set to NATIVE, it can't be changed back to DISK."
        }
      }
    },
    "EncryptionAtRestOptionsStatus": {
      "type": "object",
      "properties": {
        "Options": {
          "$ref": "#/$defs/EncryptionAtRestOptions"
        },
        "Status": {
          "$ref": "#/$defs/OptionStatus"
        }
      },
      "required": [
        "Options",
        "Status"
      ]
    },
    "EngineModeStatus": {
      "type": "object",
      "properties": {
        "Options": {
          "type": "string",
          "enum": [
            "GENERAL",
            "OPTIMIZED"
          ],
          "description": "The engine mode configured for the domain."
        },
        "Status": {
          "$ref": "#/$defs/OptionStatus"
        }
      },
      "required": [
        "Options",
        "Status"
      ]
    },
    "IAMFederationOptionsOutput": {
      "type": "object",
      "properties": {
        "Enabled": {
          "type": "boolean",
          "description": "Indicates whether IAM identity federation is currently enabled for the domain."
        },
        "SubjectKey": {
          "type": "string",
          "description": "The configured key in the SAML assertion for the user's subject identifier."
        },
        "RolesKey": {
          "type": "string",
          "description": "The con

# --- truncated at 32 KB (51 KB total) ---
# Full source: https://artifacts.apis.io/amazon-opensearch/json-schema/amazon-opensearch-update-domain-config-response-schema.json

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/amazon-opensearch-update-domain-config-response"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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.

A second provider on the same verified email joins the account you already have.