AWS Kinesis · Schema
AmazonopensearchserviceDestinationUpdate
Describes an update for a destination in Amazon OpenSearch Service.
AnalyticsApache FlinkBig DataData ProcessingReal-TimeStreamingVideo
Properties
| Name | Type | Description |
|---|---|---|
| RoleARN | object | |
| DomainARN | object | |
| ClusterEndpoint | object | |
| IndexName | object | |
| TypeName | object | |
| IndexRotationPeriod | object | |
| BufferingHints | object | |
| RetryOptions | object | |
| S3Update | object | |
| ProcessingConfiguration | object | |
| CloudWatchLoggingOptions | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/AmazonopensearchserviceDestinationUpdate",
"title": "AmazonopensearchserviceDestinationUpdate",
"type": "object",
"properties": {
"RoleARN": {
"allOf": [
{
"$ref": "#/components/schemas/RoleARN"
},
{
"description": "The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon OpenSearch Service Configuration API and for indexing documents. "
}
]
},
"DomainARN": {
"allOf": [
{
"$ref": "#/components/schemas/AmazonopensearchserviceDomainARN"
},
{
"description": "The ARN of the Amazon OpenSearch Service domain. The IAM role must have permissions for DescribeDomain, DescribeDomains, and DescribeDomainConfig after assuming the IAM role specified in RoleARN."
}
]
},
"ClusterEndpoint": {
"allOf": [
{
"$ref": "#/components/schemas/AmazonopensearchserviceClusterEndpoint"
},
{
"description": "The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field. "
}
]
},
"IndexName": {
"allOf": [
{
"$ref": "#/components/schemas/AmazonopensearchserviceIndexName"
},
{
"description": "The Amazon OpenSearch Service index name."
}
]
},
"TypeName": {
"allOf": [
{
"$ref": "#/components/schemas/AmazonopensearchserviceTypeName"
},
{
"description": "<p>The Amazon OpenSearch Service type name. For Elasticsearch 6.x, there can be only one type per index. If you try to specify a new type for an existing index that already has another type, Kinesis Data Firehose returns an error during runtime. </p> <p>If you upgrade Elasticsearch from 6.x to 7.x and don\u2019t update your delivery stream, Kinesis Data Firehose still delivers data to Elasticsearch with the old index name and type name. If you want to update your delivery stream with a new index name, provide an empty string for TypeName. </p>"
}
]
},
"IndexRotationPeriod": {
"allOf": [
{
"$ref": "#/components/schemas/AmazonopensearchserviceIndexRotationPeriod"
},
{
"description": "The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to IndexName to facilitate the expiration of old data."
}
]
},
"BufferingHints": {
"allOf": [
{
"$ref": "#/components/schemas/AmazonopensearchserviceBufferingHints"
},
{
"description": "The buffering options. If no value is specified, AmazonopensearchBufferingHints object default values are used. "
}
]
},
"RetryOptions": {
"allOf": [
{
"$ref": "#/components/schemas/AmazonopensearchserviceRetryOptions"
},
{
"description": "The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon OpenSearch Service. The default value is 300 (5 minutes). "
}
]
},
"S3Update": {
"$ref": "#/components/schemas/S3DestinationUpdate"
},
"ProcessingConfiguration": {
"$ref": "#/components/schemas/ProcessingConfiguration"
},
"CloudWatchLoggingOptions": {
"$ref": "#/components/schemas/CloudWatchLoggingOptions"
}
},
"description": "Describes an update for a destination in Amazon OpenSearch Service."
}
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/kinesis-amazonopensearchservicedestinationupdate"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"
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.
A second provider on the same verified email joins the account you already have.