Amazon OpenSearch Service API · Schema
UpdateSecurityConfigRequest
AnalyticsAmazon Web ServicesElasticsearchSearch
Properties
| Name | Type | Description |
|---|---|---|
| id | string | The security configuration identifier. For SAML the ID will be saml/<accountId>/<idpProviderName>. For example, saml/123456789123/OKTADev. |
| configVersion | string | The version of the security configuration to be updated. You can find the most recent version of a security configuration using the GetSecurityPolicy command. |
| description | string | A description of the security configuration. |
| samlOptions | object | |
| iamIdentityCenterOptionsUpdates | object | |
| iamFederationOptions | object | |
| clientToken | string | Unique, case-sensitive identifier to ensure idempotency of the request. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/amazon-opensearch/json-schema/amazon-opensearch-update-security-config-request-schema.json",
"title": "UpdateSecurityConfigRequest",
"x-generated": "2026-11-11",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/amazon-opensearch-security-config-api-openapi.yml#/components/schemas/UpdateSecurityConfigRequest",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The security configuration identifier. For SAML the ID will be saml/<accountId>/<idpProviderName>. For example, saml/123456789123/OKTADev."
},
"configVersion": {
"type": "string",
"description": "The version of the security configuration to be updated. You can find the most recent version of a security configuration using the GetSecurityPolicy command."
},
"description": {
"type": "string",
"description": "A description of the security configuration."
},
"samlOptions": {
"$ref": "#/$defs/SamlConfigOptions"
},
"iamIdentityCenterOptionsUpdates": {
"$ref": "#/$defs/UpdateIamIdentityCenterConfigOptions"
},
"iamFederationOptions": {
"$ref": "#/$defs/IamFederationConfigOptions"
},
"clientToken": {
"type": "string",
"description": "Unique, case-sensitive identifier to ensure idempotency of the request."
}
},
"required": [
"id",
"configVersion"
],
"$defs": {
"IamFederationConfigOptions": {
"type": "object",
"properties": {
"groupAttribute": {
"type": "string",
"description": "The group attribute for this IAM federation integration. This attribute is used to map identity provider groups to OpenSearch Serverless permissions."
},
"userAttribute": {
"type": "string",
"description": "The user attribute for this IAM federation integration. This attribute is used to identify users in the federated authentication process."
}
}
},
"SamlConfigOptions": {
"type": "object",
"properties": {
"metadata": {
"type": "string",
"description": "The XML IdP metadata file generated from your identity provider."
},
"userAttribute": {
"type": "string",
"description": "A user attribute for this SAML integration."
},
"groupAttribute": {
"type": "string",
"description": "The group attribute for this SAML integration."
},
"openSearchServerlessEntityId": {
"type": "string",
"description": "Custom entity ID attribute to override the default entity ID for this SAML integration."
},
"sessionTimeout": {
"type": "integer",
"description": "The session timeout, in minutes. Default is 60 minutes (12 hours)."
}
},
"required": [
"metadata"
]
},
"UpdateIamIdentityCenterConfigOptions": {
"type": "object",
"properties": {
"userAttribute": {
"type": "string",
"description": "The user attribute for this IAM Identity Center integration. Defaults to UserId."
},
"groupAttribute": {
"type": "string",
"description": "The group attribute for this IAM Identity Center integration. Defaults to GroupId."
}
}
}
}
}
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.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/amazon-opensearch-update-security-config-request"
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.