Amazon OpenSearch Service · Example Payload

Amazon Opensearch Service Example

AnalyticsElasticsearchFull-Text SearchLog AnalyticsOpenSearchSearch

Amazon Opensearch Service Example is an example object payload from Amazon OpenSearch Service, with 15 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

DomainIdDomainNameARNCreatedDeletedEndpointEndpointsEngineVersionClusterConfigEBSOptionsAccessPoliciesSnapshotOptionsVPCOptionsEncryptionAtRestOptionsNodeToNodeEncryptionOptions

Example Payload

Raw ↑ 
{
  "DomainId": "resource-abc123",
  "DomainName": "my-resource",
  "ARN": "arn:aws:service:us-east-1:123456789012:resource/example",
  "Created": true,
  "Deleted": true,
  "Endpoint": "example-string",
  "Endpoints": {},
  "EngineVersion": "1.0.0",
  "ClusterConfig": "example-ref",
  "EBSOptions": "example-ref",
  "AccessPolicies": "example-string",
  "SnapshotOptions": {
    "AutomatedSnapshotStartHour": 5
  },
  "VPCOptions": "example-ref",
  "EncryptionAtRestOptions": {
    "Enabled": true,
    "KmsKeyId": "resource-abc123"
  },
  "NodeToNodeEncryptionOptions": {
    "Enabled": true
  }
}