openapi: 3.0.0 info: version: '2015-01-01' x-release: v4 title: Amazon Elasticsearch Service description: 'Amazon Elasticsearch Configuration Service

Use the Amazon Elasticsearch Configuration API to create, configure, and manage Elasticsearch domains.

For sample code that uses the Configuration API, see the Amazon Elasticsearch Service Developer Guide. The guide also contains sample code for sending signed HTTP requests to the Elasticsearch APIs.

The endpoint for configuration service requests is region-specific: es.region.amazonaws.com. For example, es.us-east-1.amazonaws.com. For a current list of supported regions and endpoints, see Regions and Endpoints.

' x-logo: url: 'https://twitter.com/awscloud/profile_image?size=original' backgroundColor: '#FFFFFF' termsOfService: 'https://aws.amazon.com/service-terms/' contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: 'https://github.com/mermade/aws2openapi' x-twitter: PermittedSoc license: name: Apache 2.0 License url: 'http://www.apache.org/licenses/' x-providerName: amazonaws.com x-serviceName: es x-origin: - contentType: application/json url: 'https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/es-2015-01-01.normal.json' converter: url: 'https://github.com/mermade/aws2openapi' version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: 'https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct' x-apisguru-categories: - cloud x-preferred: true externalDocs: description: Amazon Web Services documentation url: 'https://docs.aws.amazon.com/es/' servers: - url: 'http://es.{region}.amazonaws.com' variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon Elasticsearch Service multi-region endpoint - url: 'https://es.{region}.amazonaws.com' variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon Elasticsearch Service multi-region endpoint - url: 'http://es.{region}.amazonaws.com.cn' variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon Elasticsearch Service endpoint for China (Beijing) and China (Ningxia) - url: 'https://es.{region}.amazonaws.com.cn' variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon Elasticsearch Service endpoint for China (Beijing) and China (Ningxia) paths: '/2015-01-01/es/ccs/inboundConnection/{ConnectionId}/accept': put: operationId: AcceptInboundCrossClusterSearchConnection description: Allows the destination domain owner to accept an inbound cross-cluster search connection request. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/AcceptInboundCrossClusterSearchConnectionResponse' examples: AcceptInboundCrossClusterSearchConnection200Example: summary: Default AcceptInboundCrossClusterSearchConnection 200 response x-microcks-default: true value: CrossClusterSearchConnection: example-string '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '482': description: DisabledOperationException content: application/json: schema: $ref: '#/components/schemas/DisabledOperationException' parameters: - name: ConnectionId in: path required: true description: The id of the inbound connection that you want to accept. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon OpenSearch Accept Inbound Cross Cluster Search Connection parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /2015-01-01/tags: post: operationId: AddTags description: 'Attaches tags to an existing Elasticsearch domain. Tags are a set of case-sensitive key value pairs. An Elasticsearch domain may have up to 10 tags. See Tagging Amazon Elasticsearch Service Domains for more information.' responses: '200': description: Success '480': description: BaseException content: application/json: schema: $ref: '#/components/schemas/BaseException' '481': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '482': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '483': description: InternalException content: application/json: schema: $ref: '#/components/schemas/InternalException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - ARN - TagList properties: ARN: description: 'The Amazon Resource Name (ARN) of the Elasticsearch domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.' type: string TagList: description: 'A list of Tag ' type: array items: $ref: '#/components/schemas/Tag' x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon OpenSearch Add Tags parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' '/2015-01-01/packages/associate/{PackageID}/{DomainName}': post: operationId: AssociatePackage description: Associates a package with an Amazon ES domain. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/AssociatePackageResponse' examples: AssociatePackage200Example: summary: Default AssociatePackage 200 response x-microcks-default: true value: DomainPackageDetails: example-string '480': description: BaseException content: application/json: schema: $ref: '#/components/schemas/BaseException' '481': description: InternalException content: application/json: schema: $ref: '#/components/schemas/InternalException' '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '483': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '484': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '485': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' parameters: - name: PackageID in: path required: true description: Internal ID of the package that you want to associate with a domain. Use DescribePackages to find this value. schema: type: string - name: DomainName in: path required: true description: Name of the domain that you want to associate the package with. schema: type: string pattern: '[a-z][a-z0-9\-]+' description: 'The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).' minLength: 3 maxLength: 28 x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon OpenSearch Associate Package parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' '/2015-01-01/es/domain/{DomainName}/authorizeVpcEndpointAccess': post: operationId: AuthorizeVpcEndpointAccess description: Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/AuthorizeVpcEndpointAccessResponse' examples: AuthorizeVpcEndpointAccess200Example: summary: Default AuthorizeVpcEndpointAccess 200 response x-microcks-default: true value: AuthorizedPrincipal: example-string '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: DisabledOperationException content: application/json: schema: $ref: '#/components/schemas/DisabledOperationException' '482': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '483': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '484': description: InternalException content: application/json: schema: $ref: '#/components/schemas/InternalException' '485': description: BaseException content: application/json: schema: $ref: '#/components/schemas/BaseException' parameters: - name: DomainName in: path required: true description: The name of the OpenSearch Service domain to provide access to. schema: type: string pattern: '[a-z][a-z0-9\-]+' description: 'The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).' minLength: 3 maxLength: 28 requestBody: required: true content: application/json: schema: type: object required: - Account properties: Account: description: The account ID to grant access to. type: string pattern: '^[0-9]+$' x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon OpenSearch Authorize Vpc Endpoint Access parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /2015-01-01/es/serviceSoftwareUpdate/cancel: post: operationId: CancelElasticsearchServiceSoftwareUpdate description: Cancels a scheduled service software update for an Amazon ES domain. You can only perform this operation before the AutomatedUpdateDate and when the UpdateStatus is in the PENDING_UPDATE state. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CancelElasticsearchServiceSoftwareUpdateResponse' examples: CancelElasticsearchServiceSoftwareUpdate200Example: summary: Default CancelElasticsearchServiceSoftwareUpdate 200 response x-microcks-default: true value: ServiceSoftwareOptions: example-string '480': description: BaseException content: application/json: schema: $ref: '#/components/schemas/BaseException' '481': description: InternalException content: application/json: schema: $ref: '#/components/schemas/InternalException' '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '483': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - DomainName properties: DomainName: description: 'The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).' type: string pattern: '[a-z][a-z0-9\-]+' minLength: 3 maxLength: 28 x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon OpenSearch Cancel Elasticsearch Service Software Update parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /2015-01-01/es/domain: post: operationId: CreateElasticsearchDomain description: 'Creates a new Elasticsearch domain. For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateElasticsearchDomainResponse' examples: CreateElasticsearchDomain200Example: summary: Default CreateElasticsearchDomain 200 response x-microcks-default: true value: DomainStatus: active '480': description: BaseException content: application/json: schema: $ref: '#/components/schemas/BaseException' '481': description: DisabledOperationException content: application/json: schema: $ref: '#/components/schemas/DisabledOperationException' '482': description: InternalException content: application/json: schema: $ref: '#/components/schemas/InternalException' '483': description: InvalidTypeException content: application/json: schema: $ref: '#/components/schemas/InvalidTypeException' '484': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '485': description: ResourceAlreadyExistsException content: application/json: schema: $ref: '#/components/schemas/ResourceAlreadyExistsException' '486': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - DomainName properties: DomainName: description: 'The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).' type: string pattern: '[a-z][a-z0-9\-]+' minLength: 3 maxLength: 28 ElasticsearchVersion: description: 'String of format X.Y to specify version for the Elasticsearch domain eg. "1.5" or "2.3". For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.' type: string pattern: '^[0-9]{1}\.[0-9]{1,2}$|^OpenSearch_[0-9]{1,2}\.[0-9]{1,2}$|^OS_[0-9]{1,2}\.[0-9]{1,2}$' ElasticsearchClusterConfig: description: 'Specifies the configuration for the domain cluster, such as the type and number of instances.' type: object properties: InstanceType: allOf: - $ref: '#/components/schemas/ESPartitionInstanceType' - description: The instance type for an Elasticsearch cluster. UltraWarm instance types are not supported for data instances. InstanceCount: allOf: - $ref: '#/components/schemas/IntegerClass' - description: The number of instances in the specified domain cluster. DedicatedMasterEnabled: allOf: - $ref: '#/components/schemas/Boolean' - description: 'A boolean value to indicate whether a dedicated master node is enabled. See About Dedicated Master Nodes for more information.' ZoneAwarenessEnabled: allOf: - $ref: '#/components/schemas/Boolean' - description: 'A boolean value to indicate whether zone awareness is enabled. See About Zone Awareness for more information.' ZoneAwarenessConfig: allOf: - $ref: '#/components/schemas/ZoneAwarenessConfig' - description: Specifies the zone awareness configuration for a domain when zone awareness is enabled. DedicatedMasterType: allOf: - $ref: '#/components/schemas/ESPartitionInstanceType' - description: The instance type for a dedicated master node. DedicatedMasterCount: allOf: - $ref: '#/components/schemas/IntegerClass' - description: 'Total number of dedicated master nodes, active and on standby, for the cluster.' WarmEnabled: allOf: - $ref: '#/components/schemas/Boolean' - description: True to enable warm storage. WarmType: allOf: - $ref: '#/components/schemas/ESWarmPartitionInstanceType' - description: The instance type for the Elasticsearch cluster's warm nodes. WarmCount: allOf: - $ref: '#/components/schemas/IntegerClass' - description: The number of warm nodes in the cluster. ColdStorageOptions: allOf: - $ref: '#/components/schemas/ColdStorageOptions' - description: Specifies the ColdStorageOptions config for Elasticsearch Domain EBSOptions: description: 'Options to enable, disable, and specify the properties of EBS storage volumes. For more information, see Configuring EBS-based Storage.' type: object properties: EBSEnabled: allOf: - $ref: '#/components/schemas/Boolean' - description: Specifies whether EBS-based storage is enabled. VolumeType: allOf: - $ref: '#/components/schemas/VolumeType' - description: ' Specifies the volume type for EBS-based storage.' VolumeSize: allOf: - $ref: '#/components/schemas/IntegerClass' - description: ' Integer to specify the size of an EBS volume.' Iops: allOf: - $ref: '#/components/schemas/IntegerClass' - description: Specifies the IOPS for Provisioned IOPS And GP3 EBS volume (SSD). Throughput: allOf: - $ref: '#/components/schemas/IntegerClass' - description: Specifies the Throughput for GP3 EBS volume (SSD). AccessPolicies: description: 'Access policy rules for an Elasticsearch domain service endpoints. For more information, see Configuring Access Policies in the Amazon Elasticsearch Service Developer Guide. The maximum size of a policy document is 100 KB.' type: string SnapshotOptions: description: 'Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is 0 hours.' type: object properties: AutomatedSnapshotStartHour: allOf: - $ref: '#/components/schemas/IntegerClass' - description: 'Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is 0 hours.' VPCOptions: description: 'Options to specify the subnets and security groups for VPC endpoint. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.' type: object properties: SubnetIds: allOf: - $ref: '#/components/schemas/StringList' - description: Specifies the subnets for VPC endpoint. SecurityGroupIds: allOf: - $ref: '#/components/schemas/StringList' - description: Specifies the security groups for VPC endpoint. CognitoOptions: description: 'Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana.' type: object properties: Enabled: allOf: - $ref: '#/components/schemas/Boolean' - description: Specifies the option to enable Cognito for Kibana authentication. UserPoolId: allOf: - $ref: '#/components/schemas/UserPoolId' - description: Specifies the Cognito user pool ID for Kibana authentication. IdentityPoolId: allOf: - $ref: '#/components/schemas/IdentityPoolId' - description: Specifies the Cognito identity pool ID for Kibana authentication. RoleArn: allOf: - $ref: '#/components/schemas/RoleArn' - description: Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources. EncryptionAtRestOptions: description: Specifies the Encryption At Rest Options. type: object properties: Enabled: allOf: - $ref: '#/components/schemas/Boolean' - description: Specifies the option to enable Encryption At Rest. KmsKeyId: allOf: - $ref: '#/components/schemas/KmsKeyId' - description: ' Specifies the KMS Key ID for Encryption At Rest options.' NodeToNodeEncryptionOptions: description: Specifies the node-to-node encryption options. type: object properties: Enabled: allOf: - $ref: '#/components/schemas/Boolean' - description: Specify true to enable node-to-node encryption. AdvancedOptions: description: '

Exposes select native Elasticsearch configuration values from elasticsearch.yml. Currently, the following advanced options are available:

For more information, see Configuring Advanced Options.

' type: object additionalProperties: $ref: '#/components/schemas/String' LogPublishingOptions: description: 'Map of LogType and LogPublishingOption, each containing options to publish a given type of Elasticsearch log.' type: object additionalProperties: $ref: '#/components/schemas/LogPublishingOption' DomainEndpointOptions: description: Options to configure endpoint for the Elasticsearch domain. type: object properties: EnforceHTTPS: allOf: - $ref: '#/components/schemas/Boolean' - description: Specify if only HTTPS endpoint should be enabled for the Elasticsearch domain. TLSSecurityPolicy: allOf: - $ref: '#/components/schemas/TLSSecurityPolicy' - description: 'Specify the TLS security policy that needs to be applied to the HTTPS endpoint of Elasticsearch domain.
It can be one of the following values: ' CustomEndpointEnabled: allOf: - $ref: '#/components/schemas/Boolean' - description: Specify if custom endpoint should be enabled for the Elasticsearch domain. CustomEndpoint: allOf: - $ref: '#/components/schemas/DomainNameFqdn' - description: Specify the fully qualified domain for your custom endpoint. CustomEndpointCertificateArn: allOf: - $ref: '#/components/schemas/ARN' - description: Specify ACM certificate ARN for your custom endpoint. AdvancedSecurityOptions: description: 'Specifies the advanced security configuration: whether advanced security is enabled, whether the internal database option is enabled, master username and password (if internal database is enabled), and master user ARN (if IAM is enabled).' type: object properties: Enabled: allOf: - $ref: '#/components/schemas/Boolean' - description: True if advanced security is enabled. InternalUserDatabaseEnabled: allOf: - $ref: '#/components/schemas/Boolean' - description: True if the internal user database is enabled. MasterUserOptions: allOf: - $ref: '#/components/schemas/MasterUserOptions' - description: 'Credentials for the master user: username and password, ARN, or both.' SAMLOptions: allOf: - $ref: '#/components/schemas/SAMLOptionsInput' - description: Specifies the SAML application configuration for the domain. AnonymousAuthEnabled: allOf: - $ref: '#/components/schemas/Boolean' - description: True if Anonymous auth is enabled. Anonymous auth can be enabled only when AdvancedSecurity is enabled on existing domains. AutoTuneOptions: description: 'Specifies the Auto-Tune options: the Auto-Tune desired state for the domain and list of maintenance schedules.' type: object properties: DesiredState: allOf: - $ref: '#/components/schemas/AutoTuneDesiredState' - description: 'Specifies the Auto-Tune desired state. Valid values are ENABLED, DISABLED. ' MaintenanceSchedules: allOf: - $ref: '#/components/schemas/AutoTuneMaintenanceScheduleList' - description: 'Specifies list of maitenance schedules. See the Developer Guide for more information.' TagList: description: 'A list of Tag ' type: array items: $ref: '#/components/schemas/Tag' x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon OpenSearch Create Elasticsearch Domain parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /2015-01-01/es/ccs/outboundConnection: post: operationId: CreateOutboundCrossClusterSearchConnection description: Creates a new cross-cluster search connection from a source domain to a destination domain. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateOutboundCrossClusterSearchConnectionResponse' examples: CreateOutboundCrossClusterSearchConnection200Example: summary: Default CreateOutboundCrossClusterSearchConnection 200 response x-microcks-default: true value: SourceDomainInfo: example-string DestinationDomainInfo: example-string ConnectionAlias: example-string ConnectionStatus: active CrossClusterSearchConnectionId: resource-abc123 '480': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '481': description: InternalException content: application/json: schema: $ref: '#/components/schemas/InternalException' '482': description: ResourceAlreadyExistsException content: application/json: schema: $ref: '#/components/schemas/ResourceAlreadyExistsException' '483': description: DisabledOperationException content: application/json: schema: $ref: '#/components/schemas/DisabledOperationException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - SourceDomainInfo - DestinationDomainInfo - ConnectionAlias properties: SourceDomainInfo: description: Specifies the DomainInformation for the source Elasticsearch domain. type: object properties: OwnerId: $ref: '#/components/schemas/OwnerId' DomainName: $ref: '#/components/schemas/DomainName' Region: $ref: '#/components/schemas/Region' DestinationDomainInfo: description: Specifies the DomainInformation for the destination Elasticsearch domain. type: object properties: OwnerId: $ref: '#/components/schemas/OwnerId' DomainName: $ref: '#/components/schemas/DomainName' Region: $ref: '#/components/schemas/Region' ConnectionAlias: description: Specifies the connection alias that will be used by the customer for this connection. type: string maxLength: 20 x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon OpenSearch Create Outbound Cross Cluster Search Connection parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /2015-01-01/packages: post: operationId: CreatePackage description: Create a package for use with Amazon ES domains. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreatePackageResponse' examples: CreatePackage200Example: summary: Default CreatePackage 200 response x-microcks-default: true value: PackageDetails: example-string '480': description: BaseException content: application/json: schema: $ref: '#/components/schemas/BaseException' '481': description: InternalException content: application/json: schema: $ref: '#/components/schemas/InternalException' '482': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '483': description: InvalidTypeException content: application/json: schema: $ref: '#/components/schemas/InvalidTypeException' '484': description: ResourceAlreadyExistsException content: application/json: schema: $ref: '#/components/schemas/ResourceAlreadyExistsException' '485': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '486': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - PackageName - PackageType - PackageSource properties: PackageName: description: Unique identifier for the package. type: string pattern: '[a-z][a-z0-9\-]+' minLength: 3 maxLength: 28 PackageType: description: Type of package. Currently supports only TXT-DICTIONARY. type: string enum: - TXT-DICTIONARY PackageDescription: description: Description of the package. type: string maxLength: 1024 PackageSource: description: The S3 location for importing the package specified as S3BucketName and S3Key type: object properties: S3BucketName: allOf: - $ref: '#/components/schemas/S3BucketName' - description: Name of the bucket containing the package. S3Key: allOf: - $ref: '#/components/schemas/S3Key' - description: Key (file name) of the package. x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon OpenSearch Create Package parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /2015-01-01/es/vpcEndpoints: post: operationId: CreateVpcEndpoint description: Creates an Amazon OpenSearch Service-managed VPC endpoint. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateVpcEndpointResponse' examples: CreateVpcEndpoint200Example: summary: Default CreateVpcEndpoint 200 response x-microcks-default: true value: VpcEndpoint: example-string '480': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '481': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '482': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '483': description: InternalException content: application/json: schema: $ref: '#/components/schemas/InternalException' '484': description: DisabledOperationException content: application/json: schema: $ref: '#/components/schemas/DisabledOperationException' '485': description: BaseException content: application/json: schema: $ref: '#/components/schemas/BaseException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - DomainArn - VpcOptions properties: DomainArn: description: The Amazon Resource Name (ARN) of the domain to grant access to. type: string pattern: 'arn:aws[a-z\-]*:[a-z]+:[a-z0-9\-]+:[0-9]+:domain\/[a-z0-9\-]+' minLength: 1 maxLength: 512 VpcOptions: description: 'Options to specify the subnets and security groups for VPC endpoint. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.' type: object properties: SubnetIds: allOf: - $ref: '#/components/schemas/StringList' - description: Specifies the subnets for VPC endpoint. SecurityGroupIds: allOf: - $ref: '#/components/schemas/StringList' - description: Specifies the security groups for VPC endpoint. ClientToken: description: 'Unique, case-sensitive identifier to ensure idempotency of the request.' type: string minLength: 1 maxLength: 64 x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon OpenSearch Create Vpc Endpoint parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: ListVpcEndpoints description: Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current account and Region. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListVpcEndpointsResponse' examples: ListVpcEndpoints200Example: summary: Default ListVpcEndpoints 200 response x-microcks-default: true value: VpcEndpointSummaryList: example-string NextToken: example-string '480': description: InternalException content: application/json: schema: $ref: '#/components/schemas/InternalException' '481': description: DisabledOperationException content: application/json: schema: $ref: '#/components/schemas/DisabledOperationException' '482': description: BaseException content: application/json: schema: $ref: '#/components/schemas/BaseException' parameters: - name: nextToken in: query required: false description: Identifier to allow retrieval of paginated results. schema: type: string description: ' Paginated APIs accepts NextToken input to returns next page results and provides a NextToken output in the response which can be used by the client to retrieve more results. ' x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon OpenSearch List Vpc Endpoints '/2015-01-01/es/domain/{DomainName}': delete: operationId: DeleteElasticsearchDomain description: 'Permanently deletes the specified Elasticsearch domain and all of its data. Once a domain is deleted, it cannot be recovered.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteElasticsearchDomainResponse' examples: DeleteElasticsearchDomain200Example: summary: Default DeleteElasticsearchDomain 200 response x-microcks-default: true value: DomainStatus: active '480': description: BaseException content: application/json: schema: $ref: '#/components/schemas/BaseException' '481': description: InternalException content: application/json: schema: $ref: '#/components/schemas/InternalException' '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '483': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' parameters: - name: DomainName in: path required: true description: The name of the Elasticsearch domain that you want to permanently delete. schema: type: string pattern: '[a-z][a-z0-9\-]+' description: 'The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).' minLength: 3 maxLength: 28 x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon OpenSearch Delete Elasticsearch Domain parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: DescribeElasticsearchDomain description: 'Returns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeElasticsearchDomainResponse' examples: DescribeElasticsearchDomain200Example: summary: Default DescribeElasticsearchDomain 200 response x-microcks-default: true value: DomainStatus: active '480': description: BaseException content: application/json: schema: $ref: '#/components/schemas/BaseException' '481': description: InternalException content: application/json: schema: $ref: '#/components/schemas/InternalException' '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '483': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' parameters: - name: DomainName in: path required: true description: The name of the Elasticsearch domain for which you want information. schema: type: string pattern: '[a-z][a-z0-9\-]+' description: 'The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).' minLength: 3 maxLength: 28 x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon OpenSearch Describe Elasticsearch Domain /2015-01-01/es/role: delete: operationId: DeleteElasticsearchServiceRole description: 'Deletes the service-linked role that Elasticsearch Service uses to manage and maintain VPC domains. Role deletion will fail if any existing VPC domains use the role. You must delete any such Elasticsearch domains before deleting the role. See Deleting Elasticsearch Service Role in VPC Endpoints for Amazon Elasticsearch Service Domains.' responses: '200': description: Success '480': description: BaseException content: application/json: schema: $ref: '#/components/schemas/BaseException' '481': description: InternalException content: application/json: schema: $ref: '#/components/schemas/InternalException' '482': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon OpenSearch Delete Elasticsearch Service Role parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' '/2015-01-01/es/ccs/inboundConnection/{ConnectionId}': delete: operationId: DeleteInboundCrossClusterSearchConnection description: Allows the destination domain owner to delete an existing inbound cross-cluster search connection. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteInboundCrossClusterSearchConnectionResponse' examples: DeleteInboundCrossClusterSearchConnection200Example: summary: Default DeleteInboundCrossClusterSearchConnection 200 response x-microcks-default: true value: CrossClusterSearchConnection: example-string '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: DisabledOperationException content: application/json: schema: $ref: '#/components/schemas/DisabledOperationException' parameters: - name: ConnectionId in: path required: true description: The id of the inbound connection that you want to permanently delete. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon OpenSearch Delete Inbound Cross Cluster Search Connection parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' '/2015-01-01/es/ccs/outboundConnection/{ConnectionId}': delete: operationId: DeleteOutboundCrossClusterSearchConnection description: Allows the source domain owner to delete an existing outbound cross-cluster search connection. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteOutboundCrossClusterSearchConnectionResponse' examples: DeleteOutboundCrossClusterSearchConnection200Example: summary: Default DeleteOutboundCrossClusterSearchConnection 200 response x-microcks-default: true value: CrossClusterSearchConnection: example-string '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: DisabledOperationException content: application/json: schema: $ref: '#/components/schemas/DisabledOperationException' parameters: - name: ConnectionId in: path required: true description: The id of the outbound connection that you want to permanently delete. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon OpenSearch Delete Outbound Cross Cluster Search Connection parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' '/2015-01-01/packages/{PackageID}': delete: operationId: DeletePackage description: Delete the package. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeletePackageResponse' examples: DeletePackage200Example: summary: Default DeletePackage 200 response x-microcks-default: true value: PackageDetails: example-string '480': description: BaseException content: application/json: schema: $ref: '#/components/schemas/BaseException' '481': description: InternalException content: application/json: schema: $ref: '#/components/schemas/InternalException' '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '483': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '484': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '485': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' parameters: - name: PackageID in: path required: true description: Internal ID of the package that you want to delete. Use DescribePackages to find this value. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon OpenSearch Delete Package parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' '/2015-01-01/es/vpcEndpoints/{VpcEndpointId}': delete: operationId: DeleteVpcEndpoint description: Deletes an Amazon OpenSearch Service-managed interface VPC endpoint. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteVpcEndpointResponse' examples: DeleteVpcEndpoint200Example: summary: Default DeleteVpcEndpoint 200 response x-microcks-default: true value: VpcEndpointSummary: example-string '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: DisabledOperationException content: application/json: schema: $ref: '#/components/schemas/DisabledOperationException' '482': description: InternalException content: application/json: schema: $ref: '#/components/schemas/InternalException' '483': description: BaseException content: application/json: schema: $ref: '#/components/schemas/BaseException' parameters: - name: VpcEndpointId in: path required: true description: The unique identifier of the endpoint to be deleted. schema: type: string pattern: '^aos-[a-zA-Z0-9]*$' minLength: 5 maxLength: 256 x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon OpenSearch Delete Vpc Endpoint parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' '/2015-01-01/es/domain/{DomainName}/autoTunes': get: operationId: DescribeDomainAutoTunes description: 'Provides scheduled Auto-Tune action details for the Elasticsearch domain, such as Auto-Tune action type, description, severity, and scheduled date.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeDomainAutoTunesResponse' examples: DescribeDomainAutoTunes200Example: summary: Default DescribeDomainAutoTunes 200 response x-microcks-default: true value: AutoTunes: example-string NextToken: example-string '480': description: BaseException content: application/json: schema: $ref: '#/components/schemas/BaseException' '481': description: InternalException content: application/json: schema: $ref: '#/components/schemas/InternalException' '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '483': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' parameters: - name: DomainName in: path required: true description: Specifies the domain name for which you want Auto-Tune action details. schema: type: string pattern: '[a-z][a-z0-9\-]+' description: 'The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).' minLength: 3 maxLength: 28 - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false requestBody: required: true content: application/json: schema: type: object properties: MaxResults: description: ' Set this value to limit the number of results returned. ' type: integer maximum: 100 NextToken: description: ' Paginated APIs accepts NextToken input to returns next page results and provides a NextToken output in the response which can be used by the client to retrieve more results. ' type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon OpenSearch Describe Domain Auto Tunes parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' '/2015-01-01/es/domain/{DomainName}/progress': get: operationId: DescribeDomainChangeProgress description: 'Returns information about the current blue/green deployment happening on a domain, including a change ID, status, and progress stages.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeDomainChangeProgressResponse' examples: DescribeDomainChangeProgress200Example: summary: Default DescribeDomainChangeProgress 200 response x-microcks-default: true value: ChangeProgressStatus: active '480': description: BaseException content: application/json: schema: $ref: '#/components/schemas/BaseException' '481': description: InternalException content: application/json: schema: $ref: '#/components/schemas/InternalException' '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '483': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' parameters: - name: DomainName in: path required: true description: The domain you want to get the progress information about. schema: type: string pattern: '[a-z][a-z0-9\-]+' description: 'The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).' minLength: 3 maxLength: 28 - name: changeid in: query required: false description: 'The specific change ID for which you want to get progress information. This is an optional parameter. If omitted, the service returns information about the most recent configuration change. ' schema: type: string pattern: '\p{XDigit}{8}-\p{XDigit}{4}-\p{XDigit}{4}-\p{XDigit}{4}-\p{XDigit}{12}' x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon OpenSearch Describe Domain Change Progress parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' '/2015-01-01/es/domain/{DomainName}/config': get: operationId: DescribeElasticsearchDomainConfig description: 'Provides cluster configuration information about the specified Elasticsearch domain, such as the state, creation date, update version, and update date for cluster options.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeElasticsearchDomainConfigResponse' examples: DescribeElasticsearchDomainConfig200Example: summary: Default DescribeElasticsearchDomainConfig 200 response x-microcks-default: true value: DomainConfig: example-string '480': description: BaseException content: application/json: schema: $ref: '#/components/schemas/BaseException' '481': description: InternalException content: application/json: schema: $ref: '#/components/schemas/InternalException' '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '483': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' parameters: - name: DomainName in: path required: true description: The Elasticsearch domain that you want to get information about. schema: type: string pattern: '[a-z][a-z0-9\-]+' description: 'The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).' minLength: 3 maxLength: 28 x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon OpenSearch Describe Elasticsearch Domain Config parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: UpdateElasticsearchDomainConfig description: 'Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances. ' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateElasticsearchDomainConfigResponse' examples: UpdateElasticsearchDomainConfig200Example: summary: Default UpdateElasticsearchDomainConfig 200 response x-microcks-default: true value: DomainConfig: example-string DryRunResults: example-string '480': description: BaseException content: application/json: schema: $ref: '#/components/schemas/BaseException' '481': description: InternalException content: application/json: schema: $ref: '#/components/schemas/InternalException' '482': description: InvalidTypeException content: application/json: schema: $ref: '#/components/schemas/InvalidTypeException' '483': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '484': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '485': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' parameters: - name: DomainName in: path required: true description: 'The name of the Elasticsearch domain that you are updating. ' schema: type: string pattern: '[a-z][a-z0-9\-]+' description: 'The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).' minLength: 3 maxLength: 28 requestBody: required: true content: application/json: schema: type: object properties: ElasticsearchClusterConfig: description: 'Specifies the configuration for the domain cluster, such as the type and number of instances.' type: object properties: InstanceType: allOf: - $ref: '#/components/schemas/ESPartitionInstanceType' - description: The instance type for an Elasticsearch cluster. UltraWarm instance types are not supported for data instances. InstanceCount: allOf: - $ref: '#/components/schemas/IntegerClass' - description: The number of instances in the specified domain cluster. DedicatedMasterEnabled: allOf: - $ref: '#/components/schemas/Boolean' - description: 'A boolean value to indicate whether a dedicated master node is enabled. See About Dedicated Master Nodes for more information.' ZoneAwarenessEnabled: allOf: - $ref: '#/components/schemas/Boolean' - description: 'A boolean value to indicate whether zone awareness is enabled. See About Zone Awareness for more information.' ZoneAwarenessConfig: allOf: - $ref: '#/components/schemas/ZoneAwarenessConfig' - description: Specifies the zone awareness configuration for a domain when zone awareness is enabled. DedicatedMasterType: allOf: - $ref: '#/components/schemas/ESPartitionInstanceType' - description: The instance type for a dedicated master node. DedicatedMasterCount: allOf: - $ref: '#/components/schemas/IntegerClass' - description: 'Total number of dedicated master nodes, active and on standby, for the cluster.' WarmEnabled: allOf: - $ref: '#/components/schemas/Boolean' - description: True to enable warm storage. WarmType: allOf: - $ref: '#/components/schemas/ESWarmPartitionInstanceType' - description: The instance type for the Elasticsearch cluster's warm nodes. WarmCount: allOf: - $ref: '#/components/schemas/IntegerClass' - description: The number of warm nodes in the cluster. ColdStorageOptions: allOf: - $ref: '#/components/schemas/ColdStorageOptions' - description: Specifies the ColdStorageOptions config for Elasticsearch Domain EBSOptions: description: 'Options to enable, disable, and specify the properties of EBS storage volumes. For more information, see Configuring EBS-based Storage.' type: object properties: EBSEnabled: allOf: - $ref: '#/components/schemas/Boolean' - description: Specifies whether EBS-based storage is enabled. VolumeType: allOf: - $ref: '#/components/schemas/VolumeType' - description: ' Specifies the volume type for EBS-based storage.' VolumeSize: allOf: - $ref: '#/components/schemas/IntegerClass' - description: ' Integer to specify the size of an EBS volume.' Iops: allOf: - $ref: '#/components/schemas/IntegerClass' - description: Specifies the IOPS for Provisioned IOPS And GP3 EBS volume (SSD). Throughput: allOf: - $ref: '#/components/schemas/IntegerClass' - description: Specifies the Throughput for GP3 EBS volume (SSD). SnapshotOptions: description: 'Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is 0 hours.' type: object properties: AutomatedSnapshotStartHour: allOf: - $ref: '#/components/schemas/IntegerClass' - description: 'Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is 0 hours.' VPCOptions: description: 'Options to specify the subnets and security groups for VPC endpoint. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.' type: object properties: SubnetIds: allOf: - $ref: '#/components/schemas/StringList' - description: Specifies the subnets for VPC endpoint. SecurityGroupIds: allOf: - $ref: '#/components/schemas/StringList' - description: Specifies the security groups for VPC endpoint. CognitoOptions: description: 'Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana.' type: object properties: Enabled: allOf: - $ref: '#/components/schemas/Boolean' - description: Specifies the option to enable Cognito for Kibana authentication. UserPoolId: allOf: - $ref: '#/components/schemas/UserPoolId' - description: Specifies the Cognito user pool ID for Kibana authentication. IdentityPoolId: allOf: - $ref: '#/components/schemas/IdentityPoolId' - description: Specifies the Cognito identity pool ID for Kibana authentication. RoleArn: allOf: - $ref: '#/components/schemas/RoleArn' - description: Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources. AdvancedOptions: description: '

Exposes select native Elasticsearch configuration values from elasticsearch.yml. Currently, the following advanced options are available:

For more information, see Configuring Advanced Options.

' type: object additionalProperties: $ref: '#/components/schemas/String' AccessPolicies: description: 'Access policy rules for an Elasticsearch domain service endpoints. For more information, see Configuring Access Policies in the Amazon Elasticsearch Service Developer Guide. The maximum size of a policy document is 100 KB.' type: string LogPublishingOptions: description: 'Map of LogType and LogPublishingOption, each containing options to publish a given type of Elasticsearch log.' type: object additionalProperties: $ref: '#/components/schemas/LogPublishingOption' DomainEndpointOptions: description: Options to configure endpoint for the Elasticsearch domain. type: object properties: EnforceHTTPS: allOf: - $ref: '#/components/schemas/Boolean' - description: Specify if only HTTPS endpoint should be enabled for the Elasticsearch domain. TLSSecurityPolicy: allOf: - $ref: '#/components/schemas/TLSSecurityPolicy' - description: 'Specify the TLS security policy that needs to be applied to the HTTPS endpoint of Elasticsearch domain.
It can be one of the following values: ' CustomEndpointEnabled: allOf: - $ref: '#/components/schemas/Boolean' - description: Specify if custom endpoint should be enabled for the Elasticsearch domain. CustomEndpoint: allOf: - $ref: '#/components/schemas/DomainNameFqdn' - description: Specify the fully qualified domain for your custom endpoint. CustomEndpointCertificateArn: allOf: - $ref: '#/components/schemas/ARN' - description: Specify ACM certificate ARN for your custom endpoint. AdvancedSecurityOptions: description: 'Specifies the advanced security configuration: whether advanced security is enabled, whether the internal database option is enabled, master username and password (if internal database is enabled), and master user ARN (if IAM is enabled).' type: object properties: Enabled: allOf: - $ref: '#/components/schemas/Boolean' - description: True if advanced security is enabled. InternalUserDatabaseEnabled: allOf: - $ref: '#/components/schemas/Boolean' - description: True if the internal user database is enabled. MasterUserOptions: allOf: - $ref: '#/components/schemas/MasterUserOptions' - description: 'Credentials for the master user: username and password, ARN, or both.' SAMLOptions: allOf: - $ref: '#/components/schemas/SAMLOptionsInput' - description: Specifies the SAML application configuration for the domain. AnonymousAuthEnabled: allOf: - $ref: '#/components/schemas/Boolean' - description: True if Anonymous auth is enabled. Anonymous auth can be enabled only when AdvancedSecurity is enabled on existing domains. NodeToNodeEncryptionOptions: description: Specifies the node-to-node encryption options. type: object properties: Enabled: allOf: - $ref: '#/components/schemas/Boolean' - description: Specify true to enable node-to-node encryption. EncryptionAtRestOptions: description: Specifies the Encryption At Rest Options. type: object properties: Enabled: allOf: - $ref: '#/components/schemas/Boolean' - description: Specifies the option to enable Encryption At Rest. KmsKeyId: allOf: - $ref: '#/components/schemas/KmsKeyId' - description: ' Specifies the KMS Key ID for Encryption At Rest options.' AutoTuneOptions: description: 'Specifies the Auto-Tune options: the Auto-Tune desired state for the domain, rollback state when disabling Auto-Tune options and list of maintenance schedules.' type: object properties: DesiredState: allOf: - $ref: '#/components/schemas/AutoTuneDesiredState' - description: 'Specifies the Auto-Tune desired state. Valid values are ENABLED, DISABLED. ' RollbackOnDisable: allOf: - $ref: '#/components/schemas/RollbackOnDisable' - description: 'Specifies the rollback state while disabling Auto-Tune for the domain. Valid values are NO_ROLLBACK, DEFAULT_ROLLBACK. ' MaintenanceSchedules: allOf: - $ref: '#/components/schemas/AutoTuneMaintenanceScheduleList' - description: 'Specifies list of maitenance schedules. See the Developer Guide for more information.' DryRun: description: ' This flag, when set to True, specifies whether the UpdateElasticsearchDomain request should return the results of validation checks without actually applying the change. This flag, when set to True, specifies the deployment mechanism through which the update shall be applied on the domain. This will not actually perform the Update. ' type: boolean x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon OpenSearch Update Elasticsearch Domain Config /2015-01-01/es/domain-info: post: operationId: DescribeElasticsearchDomains description: 'Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeElasticsearchDomainsResponse' examples: DescribeElasticsearchDomains200Example: summary: Default DescribeElasticsearchDomains 200 response x-microcks-default: true value: DomainStatusList: active '480': description: BaseException content: application/json: schema: $ref: '#/components/schemas/BaseException' '481': description: InternalException content: application/json: schema: $ref: '#/components/schemas/InternalException' '482': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - DomainNames properties: DomainNames: description: A list of Elasticsearch domain names. type: array items: $ref: '#/components/schemas/DomainName' x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon OpenSearch Describe Elasticsearch Domains parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' '/2015-01-01/es/instanceTypeLimits/{ElasticsearchVersion}/{InstanceType}': get: operationId: DescribeElasticsearchInstanceTypeLimits description: ' Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion. When modifying existing Domain, specify the DomainName to know what Limits are supported for modifying. ' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeElasticsearchInstanceTypeLimitsResponse' examples: DescribeElasticsearchInstanceTypeLimits200Example: summary: Default DescribeElasticsearchInstanceTypeLimits 200 response x-microcks-default: true value: LimitsByRole: example-ref '480': description: BaseException content: application/json: schema: $ref: '#/components/schemas/BaseException' '481': description: InternalException content: application/json: schema: $ref: '#/components/schemas/InternalException' '482': description: InvalidTypeException content: application/json: schema: $ref: '#/components/schemas/InvalidTypeException' '483': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '484': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '485': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' parameters: - name: domainName in: query required: false description: ' DomainName represents the name of the Domain that we are trying to modify. This should be present only if we are querying for Elasticsearch Limits for existing domain. ' schema: type: string pattern: '[a-z][a-z0-9\-]+' description: 'The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).' minLength: 3 maxLength: 28 - name: InstanceType in: path required: true description: ' The instance type for an Elasticsearch cluster for which Elasticsearch Limits are needed. ' schema: type: string enum: - m3.medium.elasticsearch - m3.large.elasticsearch - m3.xlarge.elasticsearch - m3.2xlarge.elasticsearch - m4.large.elasticsearch - m4.xlarge.elasticsearch - m4.2xlarge.elasticsearch - m4.4xlarge.elasticsearch - m4.10xlarge.elasticsearch - m5.large.elasticsearch - m5.xlarge.elasticsearch - m5.2xlarge.elasticsearch - m5.4xlarge.elasticsearch - m5.12xlarge.elasticsearch - r5.large.elasticsearch - r5.xlarge.elasticsearch - r5.2xlarge.elasticsearch - r5.4xlarge.elasticsearch - r5.12xlarge.elasticsearch - c5.large.elasticsearch - c5.xlarge.elasticsearch - c5.2xlarge.elasticsearch - c5.4xlarge.elasticsearch - c5.9xlarge.elasticsearch - c5.18xlarge.elasticsearch - ultrawarm1.medium.elasticsearch - ultrawarm1.large.elasticsearch - t2.micro.elasticsearch - t2.small.elasticsearch - t2.medium.elasticsearch - r3.large.elasticsearch - r3.xlarge.elasticsearch - r3.2xlarge.elasticsearch - r3.4xlarge.elasticsearch - r3.8xlarge.elasticsearch - i2.xlarge.elasticsearch - i2.2xlarge.elasticsearch - d2.xlarge.elasticsearch - d2.2xlarge.elasticsearch - d2.4xlarge.elasticsearch - d2.8xlarge.elasticsearch - c4.large.elasticsearch - c4.xlarge.elasticsearch - c4.2xlarge.elasticsearch - c4.4xlarge.elasticsearch - c4.8xlarge.elasticsearch - r4.large.elasticsearch - r4.xlarge.elasticsearch - r4.2xlarge.elasticsearch - r4.4xlarge.elasticsearch - r4.8xlarge.elasticsearch - r4.16xlarge.elasticsearch - i3.large.elasticsearch - i3.xlarge.elasticsearch - i3.2xlarge.elasticsearch - i3.4xlarge.elasticsearch - i3.8xlarge.elasticsearch - i3.16xlarge.elasticsearch - name: ElasticsearchVersion in: path required: true description: ' Version of Elasticsearch for which Limits are needed. ' schema: type: string pattern: '^[0-9]{1}\.[0-9]{1,2}$|^OpenSearch_[0-9]{1,2}\.[0-9]{1,2}$|^OS_[0-9]{1,2}\.[0-9]{1,2}$' x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon OpenSearch Describe Elasticsearch Instance Type Limits parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /2015-01-01/es/ccs/inboundConnection/search: post: operationId: DescribeInboundCrossClusterSearchConnections description: Lists all the inbound cross-cluster search connections for a destination domain. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeInboundCrossClusterSearchConnectionsResponse' examples: DescribeInboundCrossClusterSearchConnections200Example: summary: Default DescribeInboundCrossClusterSearchConnections 200 response x-microcks-default: true value: CrossClusterSearchConnections: example-string NextToken: example-string '480': description: InvalidPaginationTokenException content: application/json: schema: $ref: '#/components/schemas/InvalidPaginationTokenException' '481': description: DisabledOperationException content: application/json: schema: $ref: '#/components/schemas/DisabledOperationException' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false requestBody: required: true content: application/json: schema: type: object properties: Filters: description: ' A list of filters used to match properties for inbound cross-cluster search connection. Available Filter names for this operation are: ' type: array items: $ref: '#/components/schemas/Filter' MaxResults: description: ' Set this value to limit the number of results returned. ' type: integer maximum: 100 NextToken: description: ' Paginated APIs accepts NextToken input to returns next page results and provides a NextToken output in the response which can be used by the client to retrieve more results. ' type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon OpenSearch Describe Inbound Cross Cluster Search Connections parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /2015-01-01/es/ccs/outboundConnection/search: post: operationId: DescribeOutboundCrossClusterSearchConnections description: Lists all the outbound cross-cluster search connections for a source domain. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeOutboundCrossClusterSearchConnectionsResponse' examples: DescribeOutboundCrossClusterSearchConnections200Example: summary: Default DescribeOutboundCrossClusterSearchConnections 200 response x-microcks-default: true value: CrossClusterSearchConnections: example-string NextToken: example-string '480': description: InvalidPaginationTokenException content: application/json: schema: $ref: '#/components/schemas/InvalidPaginationTokenException' '481': description: DisabledOperationException content: application/json: schema: $ref: '#/components/schemas/DisabledOperationException' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false requestBody: required: true content: application/json: schema: type: object properties: Filters: description: ' A list of filters used to match properties for outbound cross-cluster search connection. Available Filter names for this operation are: ' type: array items: $ref: '#/components/schemas/Filter' MaxResults: description: ' Set this value to limit the number of results returned. ' type: integer maximum: 100 NextToken: description: ' Paginated APIs accepts NextToken input to returns next page results and provides a NextToken output in the response which can be used by the client to retrieve more results. ' type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon OpenSearch Describe Outbound Cross Cluster Search Connections parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /2015-01-01/packages/describe: post: operationId: DescribePackages description: 'Describes all packages available to Amazon ES. Includes options for filtering, limiting the number of results, and pagination.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribePackagesResponse' examples: DescribePackages200Example: summary: Default DescribePackages 200 response x-microcks-default: true value: PackageDetailsList: example-string NextToken: example-ref '480': description: BaseException content: application/json: schema: $ref: '#/components/schemas/BaseException' '481': description: InternalException content: application/json: schema: $ref: '#/components/schemas/InternalException' '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '483': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '484': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false requestBody: required: true content: application/json: schema: type: object properties: Filters: description: A list of DescribePackagesFilter to filter the packages included in a DescribePackages response. type: array items: $ref: '#/components/schemas/DescribePackagesFilter' MaxResults: description: ' Set this value to limit the number of results returned. ' type: integer maximum: 100 NextToken: description: ' Paginated APIs accepts NextToken input to returns next page results and provides a NextToken output in the response which can be used by the client to retrieve more results. ' type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon OpenSearch Describe Packages parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /2015-01-01/es/reservedInstanceOfferings: get: operationId: DescribeReservedElasticsearchInstanceOfferings description: Lists available reserved Elasticsearch instance offerings. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeReservedElasticsearchInstanceOfferingsResponse' examples: DescribeReservedElasticsearchInstanceOfferings200Example: summary: Default DescribeReservedElasticsearchInstanceOfferings 200 response x-microcks-default: true value: NextToken: example-string ReservedElasticsearchInstanceOfferings: example-string '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '482': description: DisabledOperationException content: application/json: schema: $ref: '#/components/schemas/DisabledOperationException' '483': description: InternalException content: application/json: schema: $ref: '#/components/schemas/InternalException' parameters: - name: offeringId in: query required: false description: The offering identifier filter value. Use this parameter to show only the available offering that matches the specified reservation identifier. schema: type: string pattern: '\p{XDigit}{8}-\p{XDigit}{4}-\p{XDigit}{4}-\p{XDigit}{4}-\p{XDigit}{12}' - name: maxResults in: query required: false description: 'Set this value to limit the number of results returned. If not specified, defaults to 100.' schema: type: integer description: ' Set this value to limit the number of results returned. ' maximum: 100 - name: nextToken in: query required: false description: NextToken should be sent in case if earlier API call produced result containing NextToken. It is used for pagination. schema: type: string description: ' Paginated APIs accepts NextToken input to returns next page results and provides a NextToken output in the response which can be used by the client to retrieve more results. ' - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon OpenSearch Describe Reserved Elasticsearch Instance Offerings parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /2015-01-01/es/reservedInstances: get: operationId: DescribeReservedElasticsearchInstances description: Returns information about reserved Elasticsearch instances for this account. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeReservedElasticsearchInstancesResponse' examples: DescribeReservedElasticsearchInstances200Example: summary: Default DescribeReservedElasticsearchInstances 200 response x-microcks-default: true value: NextToken: example-string ReservedElasticsearchInstances: example-string '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: InternalException content: application/json: schema: $ref: '#/components/schemas/InternalException' '482': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '483': description: DisabledOperationException content: application/json: schema: $ref: '#/components/schemas/DisabledOperationException' parameters: - name: reservationId in: query required: false description: The reserved instance identifier filter value. Use this parameter to show only the reservation that matches the specified reserved Elasticsearch instance ID. schema: type: string pattern: '\p{XDigit}{8}-\p{XDigit}{4}-\p{XDigit}{4}-\p{XDigit}{4}-\p{XDigit}{12}' - name: maxResults in: query required: false description: 'Set this value to limit the number of results returned. If not specified, defaults to 100.' schema: type: integer description: ' Set this value to limit the number of results returned. ' maximum: 100 - name: nextToken in: query required: false description: NextToken should be sent in case if earlier API call produced result containing NextToken. It is used for pagination. schema: type: string description: ' Paginated APIs accepts NextToken input to returns next page results and provides a NextToken output in the response which can be used by the client to retrieve more results. ' - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon OpenSearch Describe Reserved Elasticsearch Instances parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /2015-01-01/es/vpcEndpoints/describe: post: operationId: DescribeVpcEndpoints description: Describes one or more Amazon OpenSearch Service-managed VPC endpoints. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeVpcEndpointsResponse' examples: DescribeVpcEndpoints200Example: summary: Default DescribeVpcEndpoints 200 response x-microcks-default: true value: VpcEndpoints: example-string VpcEndpointErrors: example-string '480': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '481': description: InternalException content: application/json: schema: $ref: '#/components/schemas/InternalException' '482': description: DisabledOperationException content: application/json: schema: $ref: '#/components/schemas/DisabledOperationException' '483': description: BaseException content: application/json: schema: $ref: '#/components/schemas/BaseException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - VpcEndpointIds properties: VpcEndpointIds: description: The unique identifiers of the endpoints to get information about. type: array items: $ref: '#/components/schemas/VpcEndpointId' x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon OpenSearch Describe Vpc Endpoints parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' '/2015-01-01/packages/dissociate/{PackageID}/{DomainName}': post: operationId: DissociatePackage description: Dissociates a package from the Amazon ES domain. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DissociatePackageResponse' examples: DissociatePackage200Example: summary: Default DissociatePackage 200 response x-microcks-default: true value: DomainPackageDetails: example-string '480': description: BaseException content: application/json: schema: $ref: '#/components/schemas/BaseException' '481': description: InternalException content: application/json: schema: $ref: '#/components/schemas/InternalException' '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '483': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '484': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '485': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' parameters: - name: PackageID in: path required: true description: Internal ID of the package that you want to associate with a domain. Use DescribePackages to find this value. schema: type: string - name: DomainName in: path required: true description: Name of the domain that you want to associate the package with. schema: type: string pattern: '[a-z][a-z0-9\-]+' description: 'The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).' minLength: 3 maxLength: 28 x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon OpenSearch Dissociate Package parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /2015-01-01/es/compatibleVersions: get: operationId: GetCompatibleElasticsearchVersions description: ' Returns a list of upgrade compatible Elastisearch versions. You can optionally pass a DomainName to get all upgrade compatible Elasticsearch versions for that specific domain. ' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetCompatibleElasticsearchVersionsResponse' examples: GetCompatibleElasticsearchVersions200Example: summary: Default GetCompatibleElasticsearchVersions 200 response x-microcks-default: true value: CompatibleElasticsearchVersions: 1.0.0 '480': description: BaseException content: application/json: schema: $ref: '#/components/schemas/BaseException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: DisabledOperationException content: application/json: schema: $ref: '#/components/schemas/DisabledOperationException' '483': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '484': description: InternalException content: application/json: schema: $ref: '#/components/schemas/InternalException' parameters: - name: domainName in: query required: false description: '' schema: type: string pattern: '[a-z][a-z0-9\-]+' description: 'The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).' minLength: 3 maxLength: 28 x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon OpenSearch Get Compatible Elasticsearch Versions parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' '/2015-01-01/packages/{PackageID}/history': get: operationId: GetPackageVersionHistory description: 'Returns a list of versions of the package, along with their creation time and commit message.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetPackageVersionHistoryResponse' examples: GetPackageVersionHistory200Example: summary: Default GetPackageVersionHistory 200 response x-microcks-default: true value: PackageID: example-ref PackageVersionHistoryList: 1.0.0 NextToken: example-ref '480': description: BaseException content: application/json: schema: $ref: '#/components/schemas/BaseException' '481': description: InternalException content: application/json: schema: $ref: '#/components/schemas/InternalException' '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '483': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '484': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' parameters: - name: PackageID in: path required: true description: Returns an audit history of versions of the package. schema: type: string - name: maxResults in: query required: false description: Limits results to a maximum number of versions. schema: type: integer description: ' Set this value to limit the number of results returned. ' maximum: 100 - name: nextToken in: query required: false description: 'Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.' schema: type: string description: ' Paginated APIs accepts NextToken input to returns next page results and provides a NextToken output in the response which can be used by the client to retrieve more results. ' - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon OpenSearch Get Package Version History parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' '/2015-01-01/es/upgradeDomain/{DomainName}/history': get: operationId: GetUpgradeHistory description: Retrieves the complete history of the last 10 upgrades that were performed on the domain. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetUpgradeHistoryResponse' examples: GetUpgradeHistory200Example: summary: Default GetUpgradeHistory 200 response x-microcks-default: true value: UpgradeHistories: example-string NextToken: example-string '480': description: BaseException content: application/json: schema: $ref: '#/components/schemas/BaseException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: DisabledOperationException content: application/json: schema: $ref: '#/components/schemas/DisabledOperationException' '483': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '484': description: InternalException content: application/json: schema: $ref: '#/components/schemas/InternalException' parameters: - name: DomainName in: path required: true description: '' schema: type: string pattern: '[a-z][a-z0-9\-]+' description: 'The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).' minLength: 3 maxLength: 28 - name: maxResults in: query required: false description: '' schema: type: integer description: ' Set this value to limit the number of results returned. ' maximum: 100 - name: nextToken in: query required: false description: '' schema: type: string description: ' Paginated APIs accepts NextToken input to returns next page results and provides a NextToken output in the response which can be used by the client to retrieve more results. ' - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon OpenSearch Get Upgrade History parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' '/2015-01-01/es/upgradeDomain/{DomainName}/status': get: operationId: GetUpgradeStatus description: Retrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetUpgradeStatusResponse' examples: GetUpgradeStatus200Example: summary: Default GetUpgradeStatus 200 response x-microcks-default: true value: UpgradeStep: example-string StepStatus: active UpgradeName: my-resource '480': description: BaseException content: application/json: schema: $ref: '#/components/schemas/BaseException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: DisabledOperationException content: application/json: schema: $ref: '#/components/schemas/DisabledOperationException' '483': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '484': description: InternalException content: application/json: schema: $ref: '#/components/schemas/InternalException' parameters: - name: DomainName in: path required: true description: '' schema: type: string pattern: '[a-z][a-z0-9\-]+' description: 'The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).' minLength: 3 maxLength: 28 x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon OpenSearch Get Upgrade Status parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /2015-01-01/domain: get: operationId: ListDomainNames description: 'Returns the name of all Elasticsearch domains owned by the current user''s account. ' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListDomainNamesResponse' examples: ListDomainNames200Example: summary: Default ListDomainNames 200 response x-microcks-default: true value: DomainNames: my-resource '480': description: BaseException content: application/json: schema: $ref: '#/components/schemas/BaseException' '481': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' parameters: - name: engineType in: query required: false description: ' Optional parameter to filter the output by domain engine type. Acceptable values are ''Elasticsearch'' and ''OpenSearch''. ' schema: type: string enum: - OpenSearch - Elasticsearch x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon OpenSearch List Domain Names parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' '/2015-01-01/packages/{PackageID}/domains': get: operationId: ListDomainsForPackage description: Lists all Amazon ES domains associated with the package. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListDomainsForPackageResponse' examples: ListDomainsForPackage200Example: summary: Default ListDomainsForPackage 200 response x-microcks-default: true value: DomainPackageDetailsList: example-string NextToken: example-ref '480': description: BaseException content: application/json: schema: $ref: '#/components/schemas/BaseException' '481': description: InternalException content: application/json: schema: $ref: '#/components/schemas/InternalException' '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '483': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '484': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' parameters: - name: PackageID in: path required: true description: The package for which to list domains. schema: type: string - name: maxResults in: query required: false description: Limits results to a maximum number of domains. schema: type: integer description: ' Set this value to limit the number of results returned. ' maximum: 100 - name: nextToken in: query required: false description: 'Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.' schema: type: string description: ' Paginated APIs accepts NextToken input to returns next page results and provides a NextToken output in the response which can be used by the client to retrieve more results. ' - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon OpenSearch List Domains for Package parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' '/2015-01-01/es/instanceTypes/{ElasticsearchVersion}': get: operationId: ListElasticsearchInstanceTypes description: List all Elasticsearch instance types that are supported for given ElasticsearchVersion responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListElasticsearchInstanceTypesResponse' examples: ListElasticsearchInstanceTypes200Example: summary: Default ListElasticsearchInstanceTypes 200 response x-microcks-default: true value: ElasticsearchInstanceTypes: standard NextToken: example-string '480': description: BaseException content: application/json: schema: $ref: '#/components/schemas/BaseException' '481': description: InternalException content: application/json: schema: $ref: '#/components/schemas/InternalException' '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '483': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' parameters: - name: ElasticsearchVersion in: path required: true description: 'Version of Elasticsearch for which list of supported elasticsearch instance types are needed. ' schema: type: string pattern: '^[0-9]{1}\.[0-9]{1,2}$|^OpenSearch_[0-9]{1,2}\.[0-9]{1,2}$|^OS_[0-9]{1,2}\.[0-9]{1,2}$' - name: domainName in: query required: false description: 'DomainName represents the name of the Domain that we are trying to modify. This should be present only if we are querying for list of available Elasticsearch instance types when modifying existing domain. ' schema: type: string pattern: '[a-z][a-z0-9\-]+' description: 'The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).' minLength: 3 maxLength: 28 - name: maxResults in: query required: false description: ' Set this value to limit the number of results returned. Value provided must be greater than 30 else it wont be honored. ' schema: type: integer description: ' Set this value to limit the number of results returned. ' maximum: 100 - name: nextToken in: query required: false description: 'NextToken should be sent in case if earlier API call produced result containing NextToken. It is used for pagination. ' schema: type: string description: ' Paginated APIs accepts NextToken input to returns next page results and provides a NextToken output in the response which can be used by the client to retrieve more results. ' - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon OpenSearch List Elasticsearch Instance Types parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /2015-01-01/es/versions: get: operationId: ListElasticsearchVersions description: List all supported Elasticsearch versions responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListElasticsearchVersionsResponse' examples: ListElasticsearchVersions200Example: summary: Default ListElasticsearchVersions 200 response x-microcks-default: true value: ElasticsearchVersions: example-ref NextToken: example-ref '480': description: BaseException content: application/json: schema: $ref: '#/components/schemas/BaseException' '481': description: InternalException content: application/json: schema: $ref: '#/components/schemas/InternalException' '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '483': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' parameters: - name: maxResults in: query required: false description: ' Set this value to limit the number of results returned. Value provided must be greater than 10 else it wont be honored. ' schema: type: integer description: ' Set this value to limit the number of results returned. ' maximum: 100 - name: nextToken in: query required: false description: '' schema: type: string description: ' Paginated APIs accepts NextToken input to returns next page results and provides a NextToken output in the response which can be used by the client to retrieve more results. ' - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon OpenSearch List Elasticsearch Versions parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' '/2015-01-01/domain/{DomainName}/packages': get: operationId: ListPackagesForDomain description: Lists all packages associated with the Amazon ES domain. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListPackagesForDomainResponse' examples: ListPackagesForDomain200Example: summary: Default ListPackagesForDomain 200 response x-microcks-default: true value: DomainPackageDetailsList: example-string NextToken: example-string '480': description: BaseException content: application/json: schema: $ref: '#/components/schemas/BaseException' '481': description: InternalException content: application/json: schema: $ref: '#/components/schemas/InternalException' '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '483': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '484': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' parameters: - name: DomainName in: path required: true description: The name of the domain for which you want to list associated packages. schema: type: string pattern: '[a-z][a-z0-9\-]+' description: 'The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).' minLength: 3 maxLength: 28 - name: maxResults in: query required: false description: Limits results to a maximum number of packages. schema: type: integer description: ' Set this value to limit the number of results returned. ' maximum: 100 - name: nextToken in: query required: false description: 'Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.' schema: type: string description: ' Paginated APIs accepts NextToken input to returns next page results and provides a NextToken output in the response which can be used by the client to retrieve more results. ' - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon OpenSearch List Packages for Domain parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /2015-01-01/tags/#arn: get: operationId: ListTags description: Returns all tags for the given Elasticsearch domain. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListTagsResponse' examples: ListTags200Example: summary: Default ListTags 200 response x-microcks-default: true value: TagList: example-string '480': description: BaseException content: application/json: schema: $ref: '#/components/schemas/BaseException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '483': description: InternalException content: application/json: schema: $ref: '#/components/schemas/InternalException' parameters: - name: arn in: query required: true description: ' Specify the ARN for the Elasticsearch domain to which the tags are attached that you want to view.' schema: type: string description: 'The Amazon Resource Name (ARN) of the Elasticsearch domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.' x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon OpenSearch List Tags parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' '/2015-01-01/es/domain/{DomainName}/listVpcEndpointAccess': get: operationId: ListVpcEndpointAccess description: Retrieves information about each principal that is allowed to access a given Amazon OpenSearch Service domain through the use of an interface VPC endpoint. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListVpcEndpointAccessResponse' examples: ListVpcEndpointAccess200Example: summary: Default ListVpcEndpointAccess 200 response x-microcks-default: true value: AuthorizedPrincipalList: example-string NextToken: example-string '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: DisabledOperationException content: application/json: schema: $ref: '#/components/schemas/DisabledOperationException' '482': description: InternalException content: application/json: schema: $ref: '#/components/schemas/InternalException' '483': description: BaseException content: application/json: schema: $ref: '#/components/schemas/BaseException' parameters: - name: DomainName in: path required: true description: The name of the OpenSearch Service domain to retrieve access information for. schema: type: string pattern: '[a-z][a-z0-9\-]+' description: 'The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).' minLength: 3 maxLength: 28 - name: nextToken in: query required: false description: Provides an identifier to allow retrieval of paginated results. schema: type: string description: ' Paginated APIs accepts NextToken input to returns next page results and provides a NextToken output in the response which can be used by the client to retrieve more results. ' x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon OpenSearch List Vpc Endpoint Access parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' '/2015-01-01/es/domain/{DomainName}/vpcEndpoints': get: operationId: ListVpcEndpointsForDomain description: Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListVpcEndpointsForDomainResponse' examples: ListVpcEndpointsForDomain200Example: summary: Default ListVpcEndpointsForDomain 200 response x-microcks-default: true value: VpcEndpointSummaryList: example-string NextToken: example-string '480': description: InternalException content: application/json: schema: $ref: '#/components/schemas/InternalException' '481': description: DisabledOperationException content: application/json: schema: $ref: '#/components/schemas/DisabledOperationException' '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '483': description: BaseException content: application/json: schema: $ref: '#/components/schemas/BaseException' parameters: - name: DomainName in: path required: true description: Name of the ElasticSearch domain whose VPC endpoints are to be listed. schema: type: string pattern: '[a-z][a-z0-9\-]+' description: 'The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).' minLength: 3 maxLength: 28 - name: nextToken in: query required: false description: Provides an identifier to allow retrieval of paginated results. schema: type: string description: ' Paginated APIs accepts NextToken input to returns next page results and provides a NextToken output in the response which can be used by the client to retrieve more results. ' x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon OpenSearch List Vpc Endpoints for Domain parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /2015-01-01/es/purchaseReservedInstanceOffering: post: operationId: PurchaseReservedElasticsearchInstanceOffering description: Allows you to purchase reserved Elasticsearch instances. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/PurchaseReservedElasticsearchInstanceOfferingResponse' examples: PurchaseReservedElasticsearchInstanceOffering200Example: summary: Default PurchaseReservedElasticsearchInstanceOffering 200 response x-microcks-default: true value: ReservedElasticsearchInstanceId: resource-abc123 ReservationName: my-resource '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: ResourceAlreadyExistsException content: application/json: schema: $ref: '#/components/schemas/ResourceAlreadyExistsException' '482': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '483': description: DisabledOperationException content: application/json: schema: $ref: '#/components/schemas/DisabledOperationException' '484': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '485': description: InternalException content: application/json: schema: $ref: '#/components/schemas/InternalException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - ReservedElasticsearchInstanceOfferingId - ReservationName properties: ReservedElasticsearchInstanceOfferingId: description: The ID of the reserved Elasticsearch instance offering to purchase. type: string pattern: '\p{XDigit}{8}-\p{XDigit}{4}-\p{XDigit}{4}-\p{XDigit}{4}-\p{XDigit}{12}' ReservationName: description: A customer-specified identifier to track this reservation. type: string minLength: 5 maxLength: 64 InstanceCount: description: Specifies the number of EC2 instances in the Elasticsearch domain. type: integer minimum: 1 x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon OpenSearch Purchase Reserved Elasticsearch Instance Offering parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' '/2015-01-01/es/ccs/inboundConnection/{ConnectionId}/reject': put: operationId: RejectInboundCrossClusterSearchConnection description: Allows the destination domain owner to reject an inbound cross-cluster search connection request. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/RejectInboundCrossClusterSearchConnectionResponse' examples: RejectInboundCrossClusterSearchConnection200Example: summary: Default RejectInboundCrossClusterSearchConnection 200 response x-microcks-default: true value: CrossClusterSearchConnection: example-string '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: DisabledOperationException content: application/json: schema: $ref: '#/components/schemas/DisabledOperationException' parameters: - name: ConnectionId in: path required: true description: The id of the inbound connection that you want to reject. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon OpenSearch Reject Inbound Cross Cluster Search Connection parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /2015-01-01/tags-removal: post: operationId: RemoveTags description: Removes the specified set of tags from the specified Elasticsearch domain. responses: '200': description: Success '480': description: BaseException content: application/json: schema: $ref: '#/components/schemas/BaseException' '481': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '482': description: InternalException content: application/json: schema: $ref: '#/components/schemas/InternalException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - ARN - TagKeys properties: ARN: description: 'The Amazon Resource Name (ARN) of the Elasticsearch domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.' type: string TagKeys: description: Specifies the TagKey list which you want to remove from the Elasticsearch domain. type: array items: $ref: '#/components/schemas/String' x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon OpenSearch Remove Tags parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' '/2015-01-01/es/domain/{DomainName}/revokeVpcEndpointAccess': post: operationId: RevokeVpcEndpointAccess description: Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/RevokeVpcEndpointAccessResponse' '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '482': description: DisabledOperationException content: application/json: schema: $ref: '#/components/schemas/DisabledOperationException' '483': description: InternalException content: application/json: schema: $ref: '#/components/schemas/InternalException' '484': description: BaseException content: application/json: schema: $ref: '#/components/schemas/BaseException' parameters: - name: DomainName in: path required: true description: The name of the OpenSearch Service domain. schema: type: string pattern: '[a-z][a-z0-9\-]+' description: 'The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).' minLength: 3 maxLength: 28 requestBody: required: true content: application/json: schema: type: object required: - Account properties: Account: description: The account ID to revoke access from. type: string pattern: '^[0-9]+$' x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon OpenSearch Revoke Vpc Endpoint Access parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /2015-01-01/es/serviceSoftwareUpdate/start: post: operationId: StartElasticsearchServiceSoftwareUpdate description: Schedules a service software update for an Amazon ES domain. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/StartElasticsearchServiceSoftwareUpdateResponse' examples: StartElasticsearchServiceSoftwareUpdate200Example: summary: Default StartElasticsearchServiceSoftwareUpdate 200 response x-microcks-default: true value: ServiceSoftwareOptions: example-string '480': description: BaseException content: application/json: schema: $ref: '#/components/schemas/BaseException' '481': description: InternalException content: application/json: schema: $ref: '#/components/schemas/InternalException' '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '483': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - DomainName properties: DomainName: description: 'The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).' type: string pattern: '[a-z][a-z0-9\-]+' minLength: 3 maxLength: 28 x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon OpenSearch Start Elasticsearch Service Software Update parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /2015-01-01/packages/update: post: operationId: UpdatePackage description: Updates a package for use with Amazon ES domains. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdatePackageResponse' examples: UpdatePackage200Example: summary: Default UpdatePackage 200 response x-microcks-default: true value: PackageDetails: example-string '480': description: BaseException content: application/json: schema: $ref: '#/components/schemas/BaseException' '481': description: InternalException content: application/json: schema: $ref: '#/components/schemas/InternalException' '482': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '483': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '484': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '485': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - PackageID - PackageSource properties: PackageID: description: Unique identifier for the package. type: string PackageSource: description: The S3 location for importing the package specified as S3BucketName and S3Key type: object properties: S3BucketName: allOf: - $ref: '#/components/schemas/S3BucketName' - description: Name of the bucket containing the package. S3Key: allOf: - $ref: '#/components/schemas/S3Key' - description: Key (file name) of the package. PackageDescription: description: New description of the package. type: string maxLength: 1024 CommitMessage: description: An info message for the new version which will be shown as part of GetPackageVersionHistoryResponse. type: string maxLength: 160 x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon OpenSearch Update Package parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /2015-01-01/es/vpcEndpoints/update: post: operationId: UpdateVpcEndpoint description: Modifies an Amazon OpenSearch Service-managed interface VPC endpoint. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateVpcEndpointResponse' examples: UpdateVpcEndpoint200Example: summary: Default UpdateVpcEndpoint 200 response x-microcks-default: true value: VpcEndpoint: example-string '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: DisabledOperationException content: application/json: schema: $ref: '#/components/schemas/DisabledOperationException' '482': description: InternalException content: application/json: schema: $ref: '#/components/schemas/InternalException' '483': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '484': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '485': description: BaseException content: application/json: schema: $ref: '#/components/schemas/BaseException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - VpcEndpointId - VpcOptions properties: VpcEndpointId: description: Unique identifier of the VPC endpoint to be updated. type: string pattern: '^aos-[a-zA-Z0-9]*$' minLength: 5 maxLength: 256 VpcOptions: description: 'Options to specify the subnets and security groups for VPC endpoint. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.' type: object properties: SubnetIds: allOf: - $ref: '#/components/schemas/StringList' - description: Specifies the subnets for VPC endpoint. SecurityGroupIds: allOf: - $ref: '#/components/schemas/StringList' - description: Specifies the security groups for VPC endpoint. x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon OpenSearch Update Vpc Endpoint parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /2015-01-01/es/upgradeDomain: post: operationId: UpgradeElasticsearchDomain description: Allows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible Elasticsearch version. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpgradeElasticsearchDomainResponse' examples: UpgradeElasticsearchDomain200Example: summary: Default UpgradeElasticsearchDomain 200 response x-microcks-default: true value: DomainName: example-ref TargetVersion: 1.0.0 PerformCheckOnly: example-string ChangeProgressDetails: example-ref '480': description: BaseException content: application/json: schema: $ref: '#/components/schemas/BaseException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: ResourceAlreadyExistsException content: application/json: schema: $ref: '#/components/schemas/ResourceAlreadyExistsException' '483': description: DisabledOperationException content: application/json: schema: $ref: '#/components/schemas/DisabledOperationException' '484': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '485': description: InternalException content: application/json: schema: $ref: '#/components/schemas/InternalException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - DomainName - TargetVersion properties: DomainName: description: 'The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).' type: string pattern: '[a-z][a-z0-9\-]+' minLength: 3 maxLength: 28 TargetVersion: description: The version of Elasticsearch that you intend to upgrade the domain to. type: string pattern: '^[0-9]{1}\.[0-9]{1,2}$|^OpenSearch_[0-9]{1,2}\.[0-9]{1,2}$|^OS_[0-9]{1,2}\.[0-9]{1,2}$' PerformCheckOnly: description: ' This flag, when set to True, indicates that an Upgrade Eligibility Check needs to be performed. This will not actually perform the Upgrade. ' type: boolean x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon OpenSearch Upgrade Elasticsearch Domain parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' components: parameters: X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 in: header schema: type: string required: false X-Amz-Date: name: X-Amz-Date in: header schema: type: string required: false X-Amz-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false X-Amz-Credential: name: X-Amz-Credential in: header schema: type: string required: false X-Amz-Security-Token: name: X-Amz-Security-Token in: header schema: type: string required: false X-Amz-Signature: name: X-Amz-Signature in: header schema: type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders in: header schema: type: string required: false securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 schemas: AcceptInboundCrossClusterSearchConnectionResponse: type: object properties: CrossClusterSearchConnection: allOf: - $ref: '#/components/schemas/InboundCrossClusterSearchConnection' - description: 'Specifies the InboundCrossClusterSearchConnection of accepted inbound connection. ' description: The result of a AcceptInboundCrossClusterSearchConnection operation. Contains details of accepted inbound connection. ResourceNotFoundException: {} LimitExceededException: {} DisabledOperationException: {} Tag: type: object required: - Key - Value properties: Key: allOf: - $ref: '#/components/schemas/TagKey' - description: 'Specifies the TagKey, the name of the tag. Tag keys must be unique for the Elasticsearch domain to which they are attached.' Value: allOf: - $ref: '#/components/schemas/TagValue' - description: 'Specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and do not have to be unique in a tag set. For example, you can have a key value pair in a tag set of project : Trinity and cost-center : Trinity' description: Specifies a key value pair for a resource tag. BaseException: {} ValidationException: {} InternalException: {} AssociatePackageResponse: type: object properties: DomainPackageDetails: allOf: - $ref: '#/components/schemas/DomainPackageDetails' - description: DomainPackageDetails description: ' Container for response returned by AssociatePackage operation. ' AccessDeniedException: {} ConflictException: {} AuthorizeVpcEndpointAccessResponse: type: object required: - AuthorizedPrincipal properties: AuthorizedPrincipal: allOf: - $ref: '#/components/schemas/AuthorizedPrincipal' - description: Information about the account or service that was provided access to the domain. description: Container for response parameters to the AuthorizeVpcEndpointAccess operation. Contains the account ID and the type of the account being authorized to access the VPC endpoint. CancelElasticsearchServiceSoftwareUpdateResponse: type: object properties: ServiceSoftwareOptions: allOf: - $ref: '#/components/schemas/ServiceSoftwareOptions' - description: The current status of the Elasticsearch service software update. description: The result of a CancelElasticsearchServiceSoftwareUpdate operation. Contains the status of the update. CreateElasticsearchDomainResponse: type: object properties: DomainStatus: allOf: - $ref: '#/components/schemas/ElasticsearchDomainStatus' - description: 'The status of the newly created Elasticsearch domain. ' description: The result of a CreateElasticsearchDomain operation. Contains the status of the newly created Elasticsearch domain. ESPartitionInstanceType: type: string enum: - m3.medium.elasticsearch - m3.large.elasticsearch - m3.xlarge.elasticsearch - m3.2xlarge.elasticsearch - m4.large.elasticsearch - m4.xlarge.elasticsearch - m4.2xlarge.elasticsearch - m4.4xlarge.elasticsearch - m4.10xlarge.elasticsearch - m5.large.elasticsearch - m5.xlarge.elasticsearch - m5.2xlarge.elasticsearch - m5.4xlarge.elasticsearch - m5.12xlarge.elasticsearch - r5.large.elasticsearch - r5.xlarge.elasticsearch - r5.2xlarge.elasticsearch - r5.4xlarge.elasticsearch - r5.12xlarge.elasticsearch - c5.large.elasticsearch - c5.xlarge.elasticsearch - c5.2xlarge.elasticsearch - c5.4xlarge.elasticsearch - c5.9xlarge.elasticsearch - c5.18xlarge.elasticsearch - ultrawarm1.medium.elasticsearch - ultrawarm1.large.elasticsearch - t2.micro.elasticsearch - t2.small.elasticsearch - t2.medium.elasticsearch - r3.large.elasticsearch - r3.xlarge.elasticsearch - r3.2xlarge.elasticsearch - r3.4xlarge.elasticsearch - r3.8xlarge.elasticsearch - i2.xlarge.elasticsearch - i2.2xlarge.elasticsearch - d2.xlarge.elasticsearch - d2.2xlarge.elasticsearch - d2.4xlarge.elasticsearch - d2.8xlarge.elasticsearch - c4.large.elasticsearch - c4.xlarge.elasticsearch - c4.2xlarge.elasticsearch - c4.4xlarge.elasticsearch - c4.8xlarge.elasticsearch - r4.large.elasticsearch - r4.xlarge.elasticsearch - r4.2xlarge.elasticsearch - r4.4xlarge.elasticsearch - r4.8xlarge.elasticsearch - r4.16xlarge.elasticsearch - i3.large.elasticsearch - i3.xlarge.elasticsearch - i3.2xlarge.elasticsearch - i3.4xlarge.elasticsearch - i3.8xlarge.elasticsearch - i3.16xlarge.elasticsearch IntegerClass: type: integer Boolean: type: boolean ZoneAwarenessConfig: type: object properties: AvailabilityZoneCount: allOf: - $ref: '#/components/schemas/IntegerClass' - description: An integer value to indicate the number of availability zones for a domain when zone awareness is enabled. This should be equal to number of subnets if VPC endpoints is enabled description: 'Specifies the zone awareness configuration for the domain cluster, such as the number of availability zones.' ESWarmPartitionInstanceType: type: string enum: - ultrawarm1.medium.elasticsearch - ultrawarm1.large.elasticsearch ColdStorageOptions: type: object required: - Enabled properties: Enabled: allOf: - $ref: '#/components/schemas/Boolean' - description: Enable cold storage option. Accepted values true or false description: Specifies the configuration for cold storage options such as enabled VolumeType: type: string enum: - standard - gp2 - io1 - gp3 description: ' The type of EBS volume, standard, gp2, gp3 or io1. See Configuring EBS-based Storagefor more information.' StringList: type: array items: $ref: '#/components/schemas/String' UserPoolId: type: string pattern: '[\w-]+_[0-9a-zA-Z]+' minLength: 1 maxLength: 55 IdentityPoolId: type: string pattern: '[\w-]+:[0-9a-f-]+' minLength: 1 maxLength: 55 RoleArn: type: string minLength: 20 maxLength: 2048 KmsKeyId: type: string minLength: 1 maxLength: 500 String: type: string LogPublishingOption: type: object properties: CloudWatchLogsLogGroupArn: $ref: '#/components/schemas/CloudWatchLogsLogGroupArn' Enabled: allOf: - $ref: '#/components/schemas/Boolean' - description: ' Specifies whether given log publishing option is enabled or not.' description: 'Log Publishing option that is set for given domain.
Attributes and their details: ' TLSSecurityPolicy: type: string enum: - Policy-Min-TLS-1-0-2019-07 - Policy-Min-TLS-1-2-2019-07 DomainNameFqdn: type: string pattern: '^(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9])\.)+((?!-)[A-Za-z0-9-]{1,62}[A-Za-z0-9])$' minLength: 1 maxLength: 255 ARN: type: string description: 'The Amazon Resource Name (ARN) of the Elasticsearch domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.' MasterUserOptions: type: object properties: MasterUserARN: allOf: - $ref: '#/components/schemas/ARN' - description: ARN for the master user (if IAM is enabled). MasterUserName: allOf: - $ref: '#/components/schemas/Username' - description: 'The master user''s username, which is stored in the Amazon Elasticsearch Service domain''s internal database.' MasterUserPassword: allOf: - $ref: '#/components/schemas/Password' - description: 'The master user''s password, which is stored in the Amazon Elasticsearch Service domain''s internal database.' description: 'Credentials for the master user: username and password, ARN, or both.' SAMLOptionsInput: type: object properties: Enabled: allOf: - $ref: '#/components/schemas/Boolean' - description: True if SAML is enabled. Idp: allOf: - $ref: '#/components/schemas/SAMLIdp' - description: Specifies the SAML Identity Provider's information. MasterUserName: allOf: - $ref: '#/components/schemas/Username' - description: 'The SAML master username, which is stored in the Amazon Elasticsearch Service domain''s internal database.' MasterBackendRole: allOf: - $ref: '#/components/schemas/BackendRole' - description: The backend role to which the SAML master user is mapped to. SubjectKey: allOf: - $ref: '#/components/schemas/String' - description: The key to use for matching the SAML Subject attribute. RolesKey: allOf: - $ref: '#/components/schemas/String' - description: The key to use for matching the SAML Roles attribute. SessionTimeoutMinutes: allOf: - $ref: '#/components/schemas/IntegerClass' - description: 'The duration, in minutes, after which a user session becomes inactive. Acceptable values are between 1 and 1440, and the default value is 60.' description: Specifies the SAML application configuration for the domain. AutoTuneDesiredState: type: string enum: - ENABLED - DISABLED description: 'Specifies the Auto-Tune desired state. Valid values are ENABLED, DISABLED.' AutoTuneMaintenanceScheduleList: type: array items: $ref: '#/components/schemas/AutoTuneMaintenanceSchedule' maxItems: 100 InvalidTypeException: {} ResourceAlreadyExistsException: {} CreateOutboundCrossClusterSearchConnectionResponse: type: object properties: SourceDomainInfo: allOf: - $ref: '#/components/schemas/DomainInformation' - description: Specifies the DomainInformation for the source Elasticsearch domain. DestinationDomainInfo: allOf: - $ref: '#/components/schemas/DomainInformation' - description: Specifies the DomainInformation for the destination Elasticsearch domain. ConnectionAlias: allOf: - $ref: '#/components/schemas/ConnectionAlias' - description: Specifies the connection alias provided during the create connection request. ConnectionStatus: allOf: - $ref: '#/components/schemas/OutboundCrossClusterSearchConnectionStatus' - description: Specifies the OutboundCrossClusterSearchConnectionStatus for the newly created connection. CrossClusterSearchConnectionId: allOf: - $ref: '#/components/schemas/CrossClusterSearchConnectionId' - description: 'Unique id for the created outbound connection, which is used for subsequent operations on connection.' description: The result of a CreateOutboundCrossClusterSearchConnection request. Contains the details of the newly created cross-cluster search connection. OwnerId: type: string minLength: 12 maxLength: 12 DomainName: type: string pattern: '[a-z][a-z0-9\-]+' description: 'The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).' minLength: 3 maxLength: 28 Region: type: string CreatePackageResponse: type: object properties: PackageDetails: allOf: - $ref: '#/components/schemas/PackageDetails' - description: Information about the package PackageDetails. description: ' Container for response returned by CreatePackage operation. ' S3BucketName: type: string minLength: 3 maxLength: 63 S3Key: type: string CreateVpcEndpointResponse: type: object required: - VpcEndpoint properties: VpcEndpoint: allOf: - $ref: '#/components/schemas/VpcEndpoint' - description: Information about the newly created VPC endpoint. description: Container for response parameters to the CreateVpcEndpoint operation. Contains the configuration and status of the VPC Endpoint being created. DeleteElasticsearchDomainResponse: type: object properties: DomainStatus: allOf: - $ref: '#/components/schemas/ElasticsearchDomainStatus' - description: The status of the Elasticsearch domain being deleted. description: 'The result of a DeleteElasticsearchDomain request. Contains the status of the pending deletion, or no status if the domain and all of its resources have been deleted.' DeleteInboundCrossClusterSearchConnectionResponse: type: object properties: CrossClusterSearchConnection: allOf: - $ref: '#/components/schemas/InboundCrossClusterSearchConnection' - description: 'Specifies the InboundCrossClusterSearchConnection of deleted inbound connection. ' description: The result of a DeleteInboundCrossClusterSearchConnection operation. Contains details of deleted inbound connection. DeleteOutboundCrossClusterSearchConnectionResponse: type: object properties: CrossClusterSearchConnection: allOf: - $ref: '#/components/schemas/OutboundCrossClusterSearchConnection' - description: 'Specifies the OutboundCrossClusterSearchConnection of deleted outbound connection. ' description: The result of a DeleteOutboundCrossClusterSearchConnection operation. Contains details of deleted outbound connection. DeletePackageResponse: type: object properties: PackageDetails: allOf: - $ref: '#/components/schemas/PackageDetails' - description: PackageDetails description: ' Container for response parameters to DeletePackage operation. ' DeleteVpcEndpointResponse: type: object required: - VpcEndpointSummary properties: VpcEndpointSummary: allOf: - $ref: '#/components/schemas/VpcEndpointSummary' - description: 'Information about the deleted endpoint, including its current status (DELETING or DELETE_FAILED).' description: Container for response parameters to the DeleteVpcEndpoint operation. Contains the summarized detail of the VPC Endpoint being deleted. DescribeDomainAutoTunesResponse: type: object properties: AutoTunes: allOf: - $ref: '#/components/schemas/AutoTuneList' - description: 'Specifies the list of setting adjustments that Auto-Tune has made to the domain. See the Developer Guide for more information.' NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: Specifies an identifier to allow retrieval of paginated results. description: 'The result of DescribeDomainAutoTunes request. See the Developer Guide for more information. ' DescribeDomainChangeProgressResponse: type: object properties: ChangeProgressStatus: allOf: - $ref: '#/components/schemas/ChangeProgressStatusDetails' - description: 'Progress information for the configuration change that is requested in the DescribeDomainChangeProgress request. ' description: 'The result of a DescribeDomainChangeProgress request. Contains the progress information of the requested domain change. ' DescribeElasticsearchDomainResponse: type: object required: - DomainStatus properties: DomainStatus: allOf: - $ref: '#/components/schemas/ElasticsearchDomainStatus' - description: The current status of the Elasticsearch domain. description: The result of a DescribeElasticsearchDomain request. Contains the status of the domain specified in the request. DescribeElasticsearchDomainConfigResponse: type: object required: - DomainConfig properties: DomainConfig: allOf: - $ref: '#/components/schemas/ElasticsearchDomainConfig' - description: The configuration information of the domain requested in the DescribeElasticsearchDomainConfig request. description: The result of a DescribeElasticsearchDomainConfig request. Contains the configuration information of the requested domain. DescribeElasticsearchDomainsResponse: type: object required: - DomainStatusList properties: DomainStatusList: allOf: - $ref: '#/components/schemas/ElasticsearchDomainStatusList' - description: The status of the domains requested in the DescribeElasticsearchDomains request. description: The result of a DescribeElasticsearchDomains request. Contains the status of the specified domains or all domains owned by the account. DescribeElasticsearchInstanceTypeLimitsResponse: type: object properties: LimitsByRole: $ref: '#/components/schemas/LimitsByRole' description: ' Container for the parameters received from DescribeElasticsearchInstanceTypeLimits operation. ' DescribeInboundCrossClusterSearchConnectionsResponse: type: object properties: CrossClusterSearchConnections: allOf: - $ref: '#/components/schemas/InboundCrossClusterSearchConnections' - description: Consists of list of InboundCrossClusterSearchConnection matching the specified filter criteria. NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: 'If more results are available and NextToken is present, make the next request to the same API with the received NextToken to paginate the remaining results. ' description: The result of a DescribeInboundCrossClusterSearchConnections request. Contains the list of connections matching the filter criteria. Filter: type: object properties: Name: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: ' Specifies the name of the filter. ' Values: allOf: - $ref: '#/components/schemas/ValueStringList' - description: ' Contains one or more values for the filter. ' description: ' A filter used to limit results when describing inbound or outbound cross-cluster search connections. Multiple values can be specified per filter. A cross-cluster search connection must match at least one of the specified values for it to be returned from an operation. ' InvalidPaginationTokenException: {} DescribeOutboundCrossClusterSearchConnectionsResponse: type: object properties: CrossClusterSearchConnections: allOf: - $ref: '#/components/schemas/OutboundCrossClusterSearchConnections' - description: Consists of list of OutboundCrossClusterSearchConnection matching the specified filter criteria. NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: 'If more results are available and NextToken is present, make the next request to the same API with the received NextToken to paginate the remaining results. ' description: The result of a DescribeOutboundCrossClusterSearchConnections request. Contains the list of connections matching the filter criteria. DescribePackagesResponse: type: object properties: PackageDetailsList: allOf: - $ref: '#/components/schemas/PackageDetailsList' - description: List of PackageDetails objects. NextToken: $ref: '#/components/schemas/String' description: ' Container for response returned by DescribePackages operation. ' DescribePackagesFilter: type: object properties: Name: allOf: - $ref: '#/components/schemas/DescribePackagesFilterName' - description: Any field from PackageDetails. Value: allOf: - $ref: '#/components/schemas/DescribePackagesFilterValues' - description: A non-empty list of values for the specified field. description: Filter to apply in DescribePackage response. DescribeReservedElasticsearchInstanceOfferingsResponse: type: object properties: NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: Provides an identifier to allow retrieval of paginated results. ReservedElasticsearchInstanceOfferings: allOf: - $ref: '#/components/schemas/ReservedElasticsearchInstanceOfferingList' - description: List of reserved Elasticsearch instance offerings description: Container for results from DescribeReservedElasticsearchInstanceOfferings DescribeReservedElasticsearchInstancesResponse: type: object properties: NextToken: allOf: - $ref: '#/components/schemas/String' - description: Provides an identifier to allow retrieval of paginated results. ReservedElasticsearchInstances: allOf: - $ref: '#/components/schemas/ReservedElasticsearchInstanceList' - description: List of reserved Elasticsearch instances. description: Container for results from DescribeReservedElasticsearchInstances DescribeVpcEndpointsResponse: type: object required: - VpcEndpoints - VpcEndpointErrors properties: VpcEndpoints: allOf: - $ref: '#/components/schemas/VpcEndpoints' - description: Information about each requested VPC endpoint. VpcEndpointErrors: allOf: - $ref: '#/components/schemas/VpcEndpointErrorList' - description: Any errors associated with the request. description: Container for response parameters to the DescribeVpcEndpoints operation. Returns a list containing configuration details and status of the VPC Endpoints as well as a list containing error responses of the endpoints that could not be described VpcEndpointId: type: string pattern: '^aos-[a-zA-Z0-9]*$' minLength: 5 maxLength: 256 DissociatePackageResponse: type: object properties: DomainPackageDetails: allOf: - $ref: '#/components/schemas/DomainPackageDetails' - description: DomainPackageDetails description: ' Container for response returned by DissociatePackage operation. ' GetCompatibleElasticsearchVersionsResponse: type: object properties: CompatibleElasticsearchVersions: allOf: - $ref: '#/components/schemas/CompatibleElasticsearchVersionsList' - description: ' A map of compatible Elasticsearch versions returned as part of the GetCompatibleElasticsearchVersions operation. ' description: ' Container for response returned by GetCompatibleElasticsearchVersions operation. ' GetPackageVersionHistoryResponse: type: object properties: PackageID: $ref: '#/components/schemas/PackageID' PackageVersionHistoryList: allOf: - $ref: '#/components/schemas/PackageVersionHistoryList' - description: List of PackageVersionHistory objects. NextToken: $ref: '#/components/schemas/String' description: ' Container for response returned by GetPackageVersionHistory operation. ' GetUpgradeHistoryResponse: type: object properties: UpgradeHistories: allOf: - $ref: '#/components/schemas/UpgradeHistoryList' - description: ' A list of UpgradeHistory objects corresponding to each Upgrade or Upgrade Eligibility Check performed on a domain returned as part of GetUpgradeHistoryResponse object. ' NextToken: allOf: - $ref: '#/components/schemas/String' - description: Pagination token that needs to be supplied to the next call to get the next page of results description: ' Container for response returned by GetUpgradeHistory operation. ' GetUpgradeStatusResponse: type: object properties: UpgradeStep: allOf: - $ref: '#/components/schemas/UpgradeStep' - description: ' Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does through: ' StepStatus: allOf: - $ref: '#/components/schemas/UpgradeStatus' - description: ' One of 4 statuses that a step can go through returned as part of the GetUpgradeStatusResponse object. The status can take one of the following values: ' UpgradeName: allOf: - $ref: '#/components/schemas/UpgradeName' - description: A string that describes the update briefly description: ' Container for response returned by GetUpgradeStatus operation. ' ListDomainNamesResponse: type: object properties: DomainNames: allOf: - $ref: '#/components/schemas/DomainInfoList' - description: List of domain names and respective engine types. description: The result of a ListDomainNames operation. Contains the names of all domains owned by this account and their respective engine types. ListDomainsForPackageResponse: type: object properties: DomainPackageDetailsList: allOf: - $ref: '#/components/schemas/DomainPackageDetailsList' - description: List of DomainPackageDetails objects. NextToken: $ref: '#/components/schemas/String' description: ' Container for response parameters to ListDomainsForPackage operation. ' ListElasticsearchInstanceTypesResponse: type: object properties: ElasticsearchInstanceTypes: allOf: - $ref: '#/components/schemas/ElasticsearchInstanceTypeList' - description: ' List of instance types supported by Amazon Elasticsearch service for given ElasticsearchVersion ' NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: 'In case if there are more results available NextToken would be present, make further request to the same API with received NextToken to paginate remaining results. ' description: ' Container for the parameters returned by ListElasticsearchInstanceTypes operation. ' ListElasticsearchVersionsResponse: type: object properties: ElasticsearchVersions: $ref: '#/components/schemas/ElasticsearchVersionList' NextToken: $ref: '#/components/schemas/NextToken' description: ' Container for the parameters for response received from ListElasticsearchVersions operation. ' ListPackagesForDomainResponse: type: object properties: DomainPackageDetailsList: allOf: - $ref: '#/components/schemas/DomainPackageDetailsList' - description: List of DomainPackageDetails objects. NextToken: allOf: - $ref: '#/components/schemas/String' - description: Pagination token that needs to be supplied to the next call to get the next page of results. description: ' Container for response parameters to ListPackagesForDomain operation. ' ListTagsResponse: type: object properties: TagList: allOf: - $ref: '#/components/schemas/TagList' - description: ' List of Tag for the requested Elasticsearch domain.' description: The result of a ListTags operation. Contains tags for all requested Elasticsearch domains. ListVpcEndpointAccessResponse: type: object required: - AuthorizedPrincipalList - NextToken properties: AuthorizedPrincipalList: allOf: - $ref: '#/components/schemas/AuthorizedPrincipalList' - description: List of AuthorizedPrincipal describing the details of the permissions to manage VPC endpoints against the specified domain. NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: Provides an identifier to allow retrieval of paginated results. description: Container for response parameters to the ListVpcEndpointAccess operation. Returns a list of accounts id and account type authorized to manage VPC endpoints. ListVpcEndpointsResponse: type: object required: - VpcEndpointSummaryList - NextToken properties: VpcEndpointSummaryList: allOf: - $ref: '#/components/schemas/VpcEndpointSummaryList' - description: Information about each endpoint. NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: Provides an identifier to allow retrieval of paginated results. description: Container for response parameters to the ListVpcEndpoints operation. Returns a list containing summarized details of the VPC endpoints. ListVpcEndpointsForDomainResponse: type: object required: - VpcEndpointSummaryList - NextToken properties: VpcEndpointSummaryList: allOf: - $ref: '#/components/schemas/VpcEndpointSummaryList' - description: Provides list of VpcEndpointSummary summarizing details of the VPC endpoints. NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: Information about each endpoint associated with the domain. description: Container for response parameters to the ListVpcEndpointsForDomain operation. Returns a list containing summarized details of the VPC endpoints. PurchaseReservedElasticsearchInstanceOfferingResponse: type: object properties: ReservedElasticsearchInstanceId: allOf: - $ref: '#/components/schemas/GUID' - description: Details of the reserved Elasticsearch instance which was purchased. ReservationName: allOf: - $ref: '#/components/schemas/ReservationToken' - description: The customer-specified identifier used to track this reservation. description: Represents the output of a PurchaseReservedElasticsearchInstanceOffering operation. RejectInboundCrossClusterSearchConnectionResponse: type: object properties: CrossClusterSearchConnection: allOf: - $ref: '#/components/schemas/InboundCrossClusterSearchConnection' - description: 'Specifies the InboundCrossClusterSearchConnection of rejected inbound connection. ' description: The result of a RejectInboundCrossClusterSearchConnection operation. Contains details of rejected inbound connection. RevokeVpcEndpointAccessResponse: type: object properties: {} description: Container for response parameters to the RevokeVpcEndpointAccess operation. The response body for this operation is empty. StartElasticsearchServiceSoftwareUpdateResponse: type: object properties: ServiceSoftwareOptions: allOf: - $ref: '#/components/schemas/ServiceSoftwareOptions' - description: The current status of the Elasticsearch service software update. description: The result of a StartElasticsearchServiceSoftwareUpdate operation. Contains the status of the update. UpdateElasticsearchDomainConfigResponse: type: object required: - DomainConfig properties: DomainConfig: allOf: - $ref: '#/components/schemas/ElasticsearchDomainConfig' - description: 'The status of the updated Elasticsearch domain. ' DryRunResults: allOf: - $ref: '#/components/schemas/DryRunResults' - description: 'Contains result of DryRun. ' description: The result of an UpdateElasticsearchDomain request. Contains the status of the Elasticsearch domain being updated. RollbackOnDisable: type: string enum: - NO_ROLLBACK - DEFAULT_ROLLBACK description: 'Specifies the rollback state while disabling Auto-Tune for the domain. Valid values are NO_ROLLBACK, DEFAULT_ROLLBACK.' UpdatePackageResponse: type: object properties: PackageDetails: allOf: - $ref: '#/components/schemas/PackageDetails' - description: Information about the package PackageDetails. description: ' Container for response returned by UpdatePackage operation. ' UpdateVpcEndpointResponse: type: object required: - VpcEndpoint properties: VpcEndpoint: allOf: - $ref: '#/components/schemas/VpcEndpoint' - description: The endpoint to be updated. description: Contains the configuration and status of the VPC endpoint being updated. UpgradeElasticsearchDomainResponse: type: object properties: DomainName: $ref: '#/components/schemas/DomainName' TargetVersion: allOf: - $ref: '#/components/schemas/ElasticsearchVersionString' - description: The version of Elasticsearch that you intend to upgrade the domain to. PerformCheckOnly: allOf: - $ref: '#/components/schemas/Boolean' - description: ' This flag, when set to True, indicates that an Upgrade Eligibility Check needs to be performed. This will not actually perform the Upgrade. ' ChangeProgressDetails: $ref: '#/components/schemas/ChangeProgressDetails' description: ' Container for response returned by UpgradeElasticsearchDomain operation. ' AWSAccount: type: string pattern: '^[0-9]+$' CrossClusterSearchConnectionId: type: string AcceptInboundCrossClusterSearchConnectionRequest: type: object title: AcceptInboundCrossClusterSearchConnectionRequest properties: {} description: Container for the parameters to the AcceptInboundCrossClusterSearchConnection operation. InboundCrossClusterSearchConnection: type: object properties: SourceDomainInfo: allOf: - $ref: '#/components/schemas/DomainInformation' - description: Specifies the DomainInformation for the source Elasticsearch domain. DestinationDomainInfo: allOf: - $ref: '#/components/schemas/DomainInformation' - description: Specifies the DomainInformation for the destination Elasticsearch domain. CrossClusterSearchConnectionId: allOf: - $ref: '#/components/schemas/CrossClusterSearchConnectionId' - description: Specifies the connection id for the inbound cross-cluster search connection. ConnectionStatus: allOf: - $ref: '#/components/schemas/InboundCrossClusterSearchConnectionStatus' - description: Specifies the InboundCrossClusterSearchConnectionStatus for the outbound connection. description: Specifies details of an inbound connection. PolicyDocument: type: string description: 'Access policy rules for an Elasticsearch domain service endpoints. For more information, see Configuring Access Policies in the Amazon Elasticsearch Service Developer Guide. The maximum size of a policy document is 100 KB.' OptionStatus: type: object required: - CreationDate - UpdateDate - State properties: CreationDate: allOf: - $ref: '#/components/schemas/UpdateTimestamp' - description: Timestamp which tells the creation date for the entity. UpdateDate: allOf: - $ref: '#/components/schemas/UpdateTimestamp' - description: Timestamp which tells the last updated time for the entity. UpdateVersion: allOf: - $ref: '#/components/schemas/UIntValue' - description: Specifies the latest version for the entity. State: allOf: - $ref: '#/components/schemas/OptionState' - description: Provides the OptionState for the Elasticsearch domain. PendingDeletion: allOf: - $ref: '#/components/schemas/Boolean' - description: Indicates whether the Elasticsearch domain is being deleted. description: Provides the current status of the entity. AccessPoliciesStatus: type: object required: - Options - Status properties: Options: allOf: - $ref: '#/components/schemas/PolicyDocument' - description: 'The access policy configured for the Elasticsearch domain. Access policies may be resource-based, IP-based, or IAM-based. See Configuring Access Policiesfor more information.' Status: allOf: - $ref: '#/components/schemas/OptionStatus' - description: 'The status of the access policy for the Elasticsearch domain. See OptionStatus for the status information that''s included. ' description: 'The configured access rules for the domain''s document and search endpoints, and the current status of those rules.' TagList: type: array description: 'A list of Tag ' items: $ref: '#/components/schemas/Tag' AddTagsRequest: type: object required: - ARN - TagList title: AddTagsRequest properties: ARN: allOf: - $ref: '#/components/schemas/ARN' - description: ' Specify the ARN for which you want to add the tags.' TagList: allOf: - $ref: '#/components/schemas/TagList' - description: ' List of Tag that need to be added for the Elasticsearch domain. ' description: Container for the parameters to the AddTags operation. Specify the tags that you want to attach to the Elasticsearch domain. LimitName: type: string LimitValueList: type: array items: $ref: '#/components/schemas/LimitValue' AdditionalLimit: type: object properties: LimitName: allOf: - $ref: '#/components/schemas/LimitName' - description: ' Name of Additional Limit is specific to a given InstanceType and for each of it''s InstanceRole etc.
Attributes and their details:
' LimitValues: allOf: - $ref: '#/components/schemas/LimitValueList' - description: ' Value for given AdditionalLimit$LimitName . ' description: ' List of limits that are specific to a given InstanceType and for each of it''s InstanceRole . ' AdditionalLimitList: type: array items: $ref: '#/components/schemas/AdditionalLimit' AdvancedOptions: type: object description: '

Exposes select native Elasticsearch configuration values from elasticsearch.yml. Currently, the following advanced options are available:

For more information, see Configuring Advanced Options.

' additionalProperties: $ref: '#/components/schemas/String' AdvancedOptionsStatus: type: object required: - Options - Status properties: Options: allOf: - $ref: '#/components/schemas/AdvancedOptions' - description: ' Specifies the status of advanced options for the specified Elasticsearch domain.' Status: allOf: - $ref: '#/components/schemas/OptionStatus' - description: ' Specifies the status of OptionStatus for advanced options for the specified Elasticsearch domain.' description: '

Status of the advanced options for the specified Elasticsearch domain. Currently, the following advanced options are available:

For more information, see Configuring Advanced Options.

' SAMLOptionsOutput: type: object properties: Enabled: allOf: - $ref: '#/components/schemas/Boolean' - description: True if SAML is enabled. Idp: allOf: - $ref: '#/components/schemas/SAMLIdp' - description: Describes the SAML Identity Provider's information. SubjectKey: allOf: - $ref: '#/components/schemas/String' - description: The key used for matching the SAML Subject attribute. RolesKey: allOf: - $ref: '#/components/schemas/String' - description: The key used for matching the SAML Roles attribute. SessionTimeoutMinutes: allOf: - $ref: '#/components/schemas/IntegerClass' - description: 'The duration, in minutes, after which a user session becomes inactive.' description: Describes the SAML application configured for the domain. DisableTimestamp: type: string format: date-time AdvancedSecurityOptions: type: object properties: Enabled: allOf: - $ref: '#/components/schemas/Boolean' - description: True if advanced security is enabled. InternalUserDatabaseEnabled: allOf: - $ref: '#/components/schemas/Boolean' - description: True if the internal user database is enabled. SAMLOptions: allOf: - $ref: '#/components/schemas/SAMLOptionsOutput' - description: Describes the SAML application configured for a domain. AnonymousAuthDisableDate: allOf: - $ref: '#/components/schemas/DisableTimestamp' - description: Specifies the Anonymous Auth Disable Date when Anonymous Auth is enabled. AnonymousAuthEnabled: allOf: - $ref: '#/components/schemas/Boolean' - description: True if Anonymous auth is enabled. Anonymous auth can be enabled only when AdvancedSecurity is enabled on existing domains. description: 'Specifies the advanced security configuration: whether advanced security is enabled, whether the internal database option is enabled.' AdvancedSecurityOptionsInput: type: object properties: Enabled: allOf: - $ref: '#/components/schemas/Boolean' - description: True if advanced security is enabled. InternalUserDatabaseEnabled: allOf: - $ref: '#/components/schemas/Boolean' - description: True if the internal user database is enabled. MasterUserOptions: allOf: - $ref: '#/components/schemas/MasterUserOptions' - description: 'Credentials for the master user: username and password, ARN, or both.' SAMLOptions: allOf: - $ref: '#/components/schemas/SAMLOptionsInput' - description: Specifies the SAML application configuration for the domain. AnonymousAuthEnabled: allOf: - $ref: '#/components/schemas/Boolean' - description: True if Anonymous auth is enabled. Anonymous auth can be enabled only when AdvancedSecurity is enabled on existing domains. description: 'Specifies the advanced security configuration: whether advanced security is enabled, whether the internal database option is enabled, master username and password (if internal database is enabled), and master user ARN (if IAM is enabled).' AdvancedSecurityOptionsStatus: type: object required: - Options - Status properties: Options: allOf: - $ref: '#/components/schemas/AdvancedSecurityOptions' - description: ' Specifies advanced security options for the specified Elasticsearch domain.' Status: allOf: - $ref: '#/components/schemas/OptionStatus' - description: ' Status of the advanced security options for the specified Elasticsearch domain.' description: ' Specifies the status of advanced security options for the specified Elasticsearch domain.' PackageID: type: string AssociatePackageRequest: type: object title: AssociatePackageRequest properties: {} description: ' Container for request parameters to AssociatePackage operation. ' DomainPackageDetails: type: object properties: PackageID: allOf: - $ref: '#/components/schemas/PackageID' - description: Internal ID of the package. PackageName: allOf: - $ref: '#/components/schemas/PackageName' - description: User specified name of the package. PackageType: allOf: - $ref: '#/components/schemas/PackageType' - description: Currently supports only TXT-DICTIONARY. LastUpdated: allOf: - $ref: '#/components/schemas/LastUpdated' - description: Timestamp of the most-recent update to the association status. DomainName: allOf: - $ref: '#/components/schemas/DomainName' - description: Name of the domain you've associated a package with. DomainPackageStatus: allOf: - $ref: '#/components/schemas/DomainPackageStatus' - description: State of the association. Values are ASSOCIATING/ASSOCIATION_FAILED/ACTIVE/DISSOCIATING/DISSOCIATION_FAILED. PackageVersion: $ref: '#/components/schemas/PackageVersion' ReferencePath: allOf: - $ref: '#/components/schemas/ReferencePath' - description: 'The relative path on Amazon ES nodes, which can be used as synonym_path when the package is synonym file.' ErrorDetails: allOf: - $ref: '#/components/schemas/ErrorDetails' - description: Additional information if the package is in an error state. Null otherwise. description: Information on a package that is associated with a domain. AuthorizeVpcEndpointAccessRequest: type: object required: - Account title: AuthorizeVpcEndpointAccessRequest properties: Account: allOf: - $ref: '#/components/schemas/AWSAccount' - description: The account ID to grant access to. description: Container for request parameters to the AuthorizeVpcEndpointAccess operation. Specifies the account to be permitted to manage VPC endpoints against the domain. AuthorizedPrincipal: type: object properties: PrincipalType: allOf: - $ref: '#/components/schemas/PrincipalType' - description: The type of principal. Principal: allOf: - $ref: '#/components/schemas/String' - description: The IAM principal that is allowed access to the domain. description: Information about an account or service that has access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint. PrincipalType: type: string enum: - AWS_ACCOUNT - AWS_SERVICE description: 'Specifies the type of AWS account permitted to manage VPC endpoints.: ' AuthorizedPrincipalList: type: array items: $ref: '#/components/schemas/AuthorizedPrincipal' AutoTuneType: type: string enum: - SCHEDULED_ACTION description: 'Specifies Auto-Tune type. Valid value is SCHEDULED_ACTION. ' AutoTuneDetails: type: object properties: ScheduledAutoTuneDetails: $ref: '#/components/schemas/ScheduledAutoTuneDetails' description: 'Specifies details of the Auto-Tune action. See the Developer Guide for more information. ' AutoTune: type: object properties: AutoTuneType: allOf: - $ref: '#/components/schemas/AutoTuneType' - description: 'Specifies Auto-Tune type. Valid value is SCHEDULED_ACTION. ' AutoTuneDetails: allOf: - $ref: '#/components/schemas/AutoTuneDetails' - description: 'Specifies details of the Auto-Tune action. See the Developer Guide for more information. ' description: 'Specifies Auto-Tune type and Auto-Tune action details. ' AutoTuneDate: type: string description: 'Specifies timestamp for the Auto-Tune action scheduled for the domain. ' format: date-time ScheduledAutoTuneDetails: type: object properties: Date: allOf: - $ref: '#/components/schemas/AutoTuneDate' - description: 'Specifies timestamp for the Auto-Tune action scheduled for the domain. ' ActionType: allOf: - $ref: '#/components/schemas/ScheduledAutoTuneActionType' - description: 'Specifies Auto-Tune action type. Valid values are JVM_HEAP_SIZE_TUNING and JVM_YOUNG_GEN_TUNING. ' Action: allOf: - $ref: '#/components/schemas/ScheduledAutoTuneDescription' - description: 'Specifies Auto-Tune action description. ' Severity: allOf: - $ref: '#/components/schemas/ScheduledAutoTuneSeverityType' - description: 'Specifies Auto-Tune action severity. Valid values are LOW, MEDIUM and HIGH. ' description: 'Specifies details of the scheduled Auto-Tune action. See the Developer Guide for more information. ' AutoTuneList: type: array items: $ref: '#/components/schemas/AutoTune' StartAt: type: string format: date-time Duration: type: object properties: Value: allOf: - $ref: '#/components/schemas/DurationValue' - description: ' Integer to specify the value of a maintenance schedule duration. See the Developer Guide for more information.' Unit: allOf: - $ref: '#/components/schemas/TimeUnit' - description: 'Specifies the unit of a maintenance schedule duration. Valid value is HOURS. See the Developer Guide for more information.' description: 'Specifies maintenance schedule duration: duration value and duration unit. See the Developer Guide for more information.' AutoTuneMaintenanceSchedule: type: object properties: StartAt: allOf: - $ref: '#/components/schemas/StartAt' - description: 'Specifies timestamp at which Auto-Tune maintenance schedule start. ' Duration: allOf: - $ref: '#/components/schemas/Duration' - description: 'Specifies maintenance schedule duration: duration value and duration unit. See the Developer Guide for more information.' CronExpressionForRecurrence: allOf: - $ref: '#/components/schemas/String' - description: 'Specifies cron expression for a recurring maintenance schedule. See the Developer Guide for more information.' description: 'Specifies Auto-Tune maitenance schedule. See the Developer Guide for more information.' AutoTuneOptions: type: object properties: DesiredState: allOf: - $ref: '#/components/schemas/AutoTuneDesiredState' - description: 'Specifies the Auto-Tune desired state. Valid values are ENABLED, DISABLED. ' RollbackOnDisable: allOf: - $ref: '#/components/schemas/RollbackOnDisable' - description: 'Specifies the rollback state while disabling Auto-Tune for the domain. Valid values are NO_ROLLBACK, DEFAULT_ROLLBACK. ' MaintenanceSchedules: allOf: - $ref: '#/components/schemas/AutoTuneMaintenanceScheduleList' - description: 'Specifies list of maitenance schedules. See the Developer Guide for more information.' description: 'Specifies the Auto-Tune options: the Auto-Tune desired state for the domain, rollback state when disabling Auto-Tune options and list of maintenance schedules.' AutoTuneOptionsInput: type: object properties: DesiredState: allOf: - $ref: '#/components/schemas/AutoTuneDesiredState' - description: 'Specifies the Auto-Tune desired state. Valid values are ENABLED, DISABLED. ' MaintenanceSchedules: allOf: - $ref: '#/components/schemas/AutoTuneMaintenanceScheduleList' - description: 'Specifies list of maitenance schedules. See the Developer Guide for more information.' description: 'Specifies the Auto-Tune options: the Auto-Tune desired state for the domain and list of maintenance schedules.' AutoTuneState: 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: 'Specifies the Auto-Tune state for the Elasticsearch domain. For valid states see the Developer Guide.' AutoTuneOptionsOutput: type: object properties: State: allOf: - $ref: '#/components/schemas/AutoTuneState' - description: Specifies the AutoTuneState for the Elasticsearch domain. ErrorMessage: allOf: - $ref: '#/components/schemas/String' - description: Specifies the error message while enabling or disabling the Auto-Tune. description: 'Specifies the Auto-Tune options: the Auto-Tune desired state for the domain and list of maintenance schedules.' AutoTuneStatus: type: object required: - CreationDate - UpdateDate - State properties: CreationDate: allOf: - $ref: '#/components/schemas/UpdateTimestamp' - description: Timestamp which tells Auto-Tune options creation date . UpdateDate: allOf: - $ref: '#/components/schemas/UpdateTimestamp' - description: Timestamp which tells Auto-Tune options last updated time. UpdateVersion: allOf: - $ref: '#/components/schemas/UIntValue' - description: Specifies the Auto-Tune options latest version. State: allOf: - $ref: '#/components/schemas/AutoTuneState' - description: Specifies the AutoTuneState for the Elasticsearch domain. ErrorMessage: allOf: - $ref: '#/components/schemas/String' - description: Specifies the error message while enabling or disabling the Auto-Tune options. PendingDeletion: allOf: - $ref: '#/components/schemas/Boolean' - description: Indicates whether the Elasticsearch domain is being deleted. description: 'Provides the current status of the Auto-Tune options. ' AutoTuneOptionsStatus: type: object properties: Options: allOf: - $ref: '#/components/schemas/AutoTuneOptions' - description: ' Specifies Auto-Tune options for the specified Elasticsearch domain.' Status: allOf: - $ref: '#/components/schemas/AutoTuneStatus' - description: ' Specifies Status of the Auto-Tune options for the specified Elasticsearch domain.' description: ' Specifies the status of Auto-Tune options for the specified Elasticsearch domain.' UpdateTimestamp: type: string format: date-time UIntValue: type: integer minimum: 0 BackendRole: type: string minLength: 1 maxLength: 256 CancelElasticsearchServiceSoftwareUpdateRequest: type: object required: - DomainName title: CancelElasticsearchServiceSoftwareUpdateRequest properties: DomainName: allOf: - $ref: '#/components/schemas/DomainName' - description: The name of the domain that you want to stop the latest service software update on. description: Container for the parameters to the CancelElasticsearchServiceSoftwareUpdate operation. Specifies the name of the Elasticsearch domain that you wish to cancel a service software update on. ServiceSoftwareOptions: 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: 'True if you are able to update you service software version. False if you are not able to update your service software version. ' Cancellable: allOf: - $ref: '#/components/schemas/Boolean' - description: 'True if you are able to cancel your service software version update. False 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: ELIGIBLE, PENDING_UPDATE, IN_PROGRESS, COMPLETED, and NOT_ELIGIBLE.' Description: allOf: - $ref: '#/components/schemas/String' - description: The description of the UpdateStatus. 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: 'True if a service software is never automatically updated. False if a service software is automatically updated after AutomatedUpdateDate. ' description: The current options of an Elasticsearch domain service software options. GUID: type: string pattern: '\p{XDigit}{8}-\p{XDigit}{4}-\p{XDigit}{4}-\p{XDigit}{4}-\p{XDigit}{12}' Message: type: string minLength: 0 maxLength: 1024 ChangeProgressDetails: type: object properties: ChangeId: allOf: - $ref: '#/components/schemas/GUID' - description: The unique change identifier associated with a specific domain configuration change. Message: allOf: - $ref: '#/components/schemas/Message' - description: Contains an optional message associated with the domain configuration change. description: Specifies change details of the domain configuration change. ChangeProgressStageName: type: string minLength: 1 maxLength: 64 ChangeProgressStageStatus: type: string minLength: 1 maxLength: 256 Description: type: string LastUpdated: type: string format: date-time ChangeProgressStage: type: object properties: Name: allOf: - $ref: '#/components/schemas/ChangeProgressStageName' - description: The name of the specific progress stage. Status: allOf: - $ref: '#/components/schemas/ChangeProgressStageStatus' - description: The overall status of a specific progress stage. Description: allOf: - $ref: '#/components/schemas/Description' - description: The description of the progress stage. LastUpdated: allOf: - $ref: '#/components/schemas/LastUpdated' - description: The last updated timestamp of the progress stage. description: A progress stage details of a specific domain configuration change. ChangeProgressStageList: type: array description: The list of progress stages of a specific domain configuration change. items: $ref: '#/components/schemas/ChangeProgressStage' OverallChangeStatus: type: string enum: - PENDING - PROCESSING - COMPLETED - FAILED description: The overall status value of the domain configuration change. TotalNumberOfStages: type: integer ChangeProgressStatusDetails: type: object properties: ChangeId: allOf: - $ref: '#/components/schemas/GUID' - description: The unique change identifier associated with a specific domain configuration change. StartTime: allOf: - $ref: '#/components/schemas/UpdateTimestamp' - description: The time at which the configuration change is made on the domain. Status: allOf: - $ref: '#/components/schemas/OverallChangeStatus' - description: 'The overall status of the domain configuration change. This field can take the following values: PENDING, PROCESSING, COMPLETED and FAILED' PendingProperties: allOf: - $ref: '#/components/schemas/StringList' - description: The list of properties involved in the domain configuration change that are still in pending. CompletedProperties: allOf: - $ref: '#/components/schemas/StringList' - description: The list of properties involved in the domain configuration change that are completed. TotalNumberOfStages: allOf: - $ref: '#/components/schemas/TotalNumberOfStages' - description: The total number of stages required for the configuration change. ChangeProgressStages: allOf: - $ref: '#/components/schemas/ChangeProgressStageList' - description: The specific stages that the domain is going through to perform the configuration change. description: The progress details of a specific domain configuration change. ClientToken: type: string minLength: 1 maxLength: 64 CloudWatchLogsLogGroupArn: type: string description: ARN of the Cloudwatch log group to which log needs to be published. CognitoOptions: type: object properties: Enabled: allOf: - $ref: '#/components/schemas/Boolean' - description: Specifies the option to enable Cognito for Kibana authentication. UserPoolId: allOf: - $ref: '#/components/schemas/UserPoolId' - description: Specifies the Cognito user pool ID for Kibana authentication. IdentityPoolId: allOf: - $ref: '#/components/schemas/IdentityPoolId' - description: Specifies the Cognito identity pool ID for Kibana authentication. RoleArn: allOf: - $ref: '#/components/schemas/RoleArn' - description: Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources. description: 'Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana.' CognitoOptionsStatus: type: object required: - Options - Status properties: Options: allOf: - $ref: '#/components/schemas/CognitoOptions' - description: Specifies the Cognito options for the specified Elasticsearch domain. Status: allOf: - $ref: '#/components/schemas/OptionStatus' - description: Specifies the status of the Cognito options for the specified Elasticsearch domain. description: Status of the Cognito options for the specified Elasticsearch domain. CommitMessage: type: string maxLength: 160 CompatibleVersionsMap: type: object properties: SourceVersion: allOf: - $ref: '#/components/schemas/ElasticsearchVersionString' - description: The current version of Elasticsearch on which a domain is. TargetVersions: $ref: '#/components/schemas/ElasticsearchVersionList' description: ' A map from an ElasticsearchVersion to a list of compatible ElasticsearchVersion s to which the domain can be upgraded. ' CompatibleElasticsearchVersionsList: type: array items: $ref: '#/components/schemas/CompatibleVersionsMap' ElasticsearchVersionString: type: string pattern: '^[0-9]{1}\.[0-9]{1,2}$|^OpenSearch_[0-9]{1,2}\.[0-9]{1,2}$|^OS_[0-9]{1,2}\.[0-9]{1,2}$' ElasticsearchVersionList: type: array description: 'List of supported elastic search versions. ' items: $ref: '#/components/schemas/ElasticsearchVersionString' ConnectionAlias: type: string maxLength: 20 ElasticsearchClusterConfig: type: object properties: InstanceType: allOf: - $ref: '#/components/schemas/ESPartitionInstanceType' - description: The instance type for an Elasticsearch cluster. UltraWarm instance types are not supported for data instances. InstanceCount: allOf: - $ref: '#/components/schemas/IntegerClass' - description: The number of instances in the specified domain cluster. DedicatedMasterEnabled: allOf: - $ref: '#/components/schemas/Boolean' - description: 'A boolean value to indicate whether a dedicated master node is enabled. See About Dedicated Master Nodes for more information.' ZoneAwarenessEnabled: allOf: - $ref: '#/components/schemas/Boolean' - description: 'A boolean value to indicate whether zone awareness is enabled. See About Zone Awareness for more information.' ZoneAwarenessConfig: allOf: - $ref: '#/components/schemas/ZoneAwarenessConfig' - description: Specifies the zone awareness configuration for a domain when zone awareness is enabled. DedicatedMasterType: allOf: - $ref: '#/components/schemas/ESPartitionInstanceType' - description: The instance type for a dedicated master node. DedicatedMasterCount: allOf: - $ref: '#/components/schemas/IntegerClass' - description: 'Total number of dedicated master nodes, active and on standby, for the cluster.' WarmEnabled: allOf: - $ref: '#/components/schemas/Boolean' - description: True to enable warm storage. WarmType: allOf: - $ref: '#/components/schemas/ESWarmPartitionInstanceType' - description: The instance type for the Elasticsearch cluster's warm nodes. WarmCount: allOf: - $ref: '#/components/schemas/IntegerClass' - description: The number of warm nodes in the cluster. ColdStorageOptions: allOf: - $ref: '#/components/schemas/ColdStorageOptions' - description: Specifies the ColdStorageOptions config for Elasticsearch Domain description: 'Specifies the configuration for the domain cluster, such as the type and number of instances.' EBSOptions: type: object properties: EBSEnabled: allOf: - $ref: '#/components/schemas/Boolean' - description: Specifies whether EBS-based storage is enabled. VolumeType: allOf: - $ref: '#/components/schemas/VolumeType' - description: ' Specifies the volume type for EBS-based storage.' VolumeSize: allOf: - $ref: '#/components/schemas/IntegerClass' - description: ' Integer to specify the size of an EBS volume.' Iops: allOf: - $ref: '#/components/schemas/IntegerClass' - description: Specifies the IOPS for Provisioned IOPS And GP3 EBS volume (SSD). Throughput: allOf: - $ref: '#/components/schemas/IntegerClass' - description: Specifies the Throughput for GP3 EBS volume (SSD). description: 'Options to enable, disable, and specify the properties of EBS storage volumes. For more information, see Configuring EBS-based Storage.' SnapshotOptions: type: object properties: AutomatedSnapshotStartHour: allOf: - $ref: '#/components/schemas/IntegerClass' - description: 'Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is 0 hours.' description: 'Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is 0 hours.' VPCOptions: type: object properties: SubnetIds: allOf: - $ref: '#/components/schemas/StringList' - description: Specifies the subnets for VPC endpoint. SecurityGroupIds: allOf: - $ref: '#/components/schemas/StringList' - description: Specifies the security groups for VPC endpoint. description: 'Options to specify the subnets and security groups for VPC endpoint. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.' EncryptionAtRestOptions: type: object properties: Enabled: allOf: - $ref: '#/components/schemas/Boolean' - description: Specifies the option to enable Encryption At Rest. KmsKeyId: allOf: - $ref: '#/components/schemas/KmsKeyId' - description: ' Specifies the KMS Key ID for Encryption At Rest options.' description: Specifies the Encryption At Rest Options. NodeToNodeEncryptionOptions: type: object properties: Enabled: allOf: - $ref: '#/components/schemas/Boolean' - description: Specify true to enable node-to-node encryption. description: Specifies the node-to-node encryption options. LogPublishingOptions: type: object additionalProperties: $ref: '#/components/schemas/LogPublishingOption' DomainEndpointOptions: type: object properties: EnforceHTTPS: allOf: - $ref: '#/components/schemas/Boolean' - description: Specify if only HTTPS endpoint should be enabled for the Elasticsearch domain. TLSSecurityPolicy: allOf: - $ref: '#/components/schemas/TLSSecurityPolicy' - description: 'Specify the TLS security policy that needs to be applied to the HTTPS endpoint of Elasticsearch domain.
It can be one of the following values: ' CustomEndpointEnabled: allOf: - $ref: '#/components/schemas/Boolean' - description: Specify if custom endpoint should be enabled for the Elasticsearch domain. CustomEndpoint: allOf: - $ref: '#/components/schemas/DomainNameFqdn' - description: Specify the fully qualified domain for your custom endpoint. CustomEndpointCertificateArn: allOf: - $ref: '#/components/schemas/ARN' - description: Specify ACM certificate ARN for your custom endpoint. description: Options to configure endpoint for the Elasticsearch domain. CreateElasticsearchDomainRequest: type: object required: - DomainName title: CreateElasticsearchDomainRequest properties: DomainName: allOf: - $ref: '#/components/schemas/DomainName' - description: 'The name of the Elasticsearch domain that you are creating. Domain names are unique across the domains owned by an account within an AWS region. Domain names must start with a lowercase letter and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).' ElasticsearchVersion: allOf: - $ref: '#/components/schemas/ElasticsearchVersionString' - description: 'String of format X.Y to specify version for the Elasticsearch domain eg. "1.5" or "2.3". For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.' ElasticsearchClusterConfig: allOf: - $ref: '#/components/schemas/ElasticsearchClusterConfig' - description: 'Configuration options for an Elasticsearch domain. Specifies the instance type and number of instances in the domain cluster. ' EBSOptions: allOf: - $ref: '#/components/schemas/EBSOptions' - description: 'Options to enable, disable and specify the type and size of EBS storage volumes. ' AccessPolicies: allOf: - $ref: '#/components/schemas/PolicyDocument' - description: ' IAM access policy as a JSON-formatted string.' SnapshotOptions: allOf: - $ref: '#/components/schemas/SnapshotOptions' - description: 'Option to set time, in UTC format, of the daily automated snapshot. Default value is 0 hours. ' VPCOptions: allOf: - $ref: '#/components/schemas/VPCOptions' - description: 'Options to specify the subnets and security groups for VPC endpoint. For more information, see Creating a VPC in VPC Endpoints for Amazon Elasticsearch Service Domains' CognitoOptions: allOf: - $ref: '#/components/schemas/CognitoOptions' - description: 'Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana.' EncryptionAtRestOptions: allOf: - $ref: '#/components/schemas/EncryptionAtRestOptions' - description: Specifies the Encryption At Rest Options. NodeToNodeEncryptionOptions: allOf: - $ref: '#/components/schemas/NodeToNodeEncryptionOptions' - description: Specifies the NodeToNodeEncryptionOptions. AdvancedOptions: allOf: - $ref: '#/components/schemas/AdvancedOptions' - description: ' Option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Configuration Advanced Options for more information.' LogPublishingOptions: allOf: - $ref: '#/components/schemas/LogPublishingOptions' - description: 'Map of LogType and LogPublishingOption, each containing options to publish a given type of Elasticsearch log.' DomainEndpointOptions: allOf: - $ref: '#/components/schemas/DomainEndpointOptions' - description: Options to specify configuration that will be applied to the domain endpoint. AdvancedSecurityOptions: allOf: - $ref: '#/components/schemas/AdvancedSecurityOptionsInput' - description: Specifies advanced security options. AutoTuneOptions: allOf: - $ref: '#/components/schemas/AutoTuneOptionsInput' - description: Specifies Auto-Tune options. TagList: allOf: - $ref: '#/components/schemas/TagList' - description: A list of Tag added during domain creation. ElasticsearchDomainStatus: type: object required: - DomainId - DomainName - ARN - ElasticsearchClusterConfig properties: DomainId: allOf: - $ref: '#/components/schemas/DomainId' - description: The unique identifier for the specified Elasticsearch domain. DomainName: allOf: - $ref: '#/components/schemas/DomainName' - description: 'The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).' ARN: allOf: - $ref: '#/components/schemas/ARN' - description: 'The Amazon resource name (ARN) of an Elasticsearch domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.' Created: allOf: - $ref: '#/components/schemas/Boolean' - description: The domain creation status. True if the creation of an Elasticsearch domain is complete. False if domain creation is still in progress. Deleted: allOf: - $ref: '#/components/schemas/Boolean' - description: 'The domain deletion status. True if a delete request has been received for the domain but resource cleanup is still in progress. False if the domain has not been deleted. Once domain deletion is complete, the status of the domain is no longer returned.' Endpoint: allOf: - $ref: '#/components/schemas/ServiceUrl' - description: The Elasticsearch domain endpoint that you use to submit index and search requests. Endpoints: allOf: - $ref: '#/components/schemas/EndpointsMap' - description: 'Map containing the Elasticsearch domain endpoints used to submit index and search requests. Example key, value: ''vpc'',''vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com''.' Processing: allOf: - $ref: '#/components/schemas/Boolean' - description: The status of the Elasticsearch domain configuration. True if Amazon Elasticsearch Service is processing configuration changes. False if the configuration is active. UpgradeProcessing: allOf: - $ref: '#/components/schemas/Boolean' - description: The status of an Elasticsearch domain version upgrade. True if Amazon Elasticsearch Service is undergoing a version upgrade. False if the configuration is active. ElasticsearchVersion: $ref: '#/components/schemas/ElasticsearchVersionString' ElasticsearchClusterConfig: allOf: - $ref: '#/components/schemas/ElasticsearchClusterConfig' - description: The type and number of instances in the domain cluster. EBSOptions: allOf: - $ref: '#/components/schemas/EBSOptions' - description: 'The EBSOptions for the specified domain. See Configuring EBS-based Storage for more information.' AccessPolicies: allOf: - $ref: '#/components/schemas/PolicyDocument' - description: ' IAM access policy as a JSON-formatted string.' SnapshotOptions: allOf: - $ref: '#/components/schemas/SnapshotOptions' - description: Specifies the status of the SnapshotOptions VPCOptions: allOf: - $ref: '#/components/schemas/VPCDerivedInfo' - description: 'The VPCOptions for the specified domain. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.' CognitoOptions: allOf: - $ref: '#/components/schemas/CognitoOptions' - description: 'The CognitoOptions for the specified domain. For more information, see Amazon Cognito Authentication for Kibana.' EncryptionAtRestOptions: allOf: - $ref: '#/components/schemas/EncryptionAtRestOptions' - description: ' Specifies the status of the EncryptionAtRestOptions.' NodeToNodeEncryptionOptions: allOf: - $ref: '#/components/schemas/NodeToNodeEncryptionOptions' - description: Specifies the status of the NodeToNodeEncryptionOptions. AdvancedOptions: allOf: - $ref: '#/components/schemas/AdvancedOptions' - description: Specifies the status of the AdvancedOptions LogPublishingOptions: allOf: - $ref: '#/components/schemas/LogPublishingOptions' - description: Log publishing options for the given domain. ServiceSoftwareOptions: allOf: - $ref: '#/components/schemas/ServiceSoftwareOptions' - description: The current status of the Elasticsearch domain's service software. DomainEndpointOptions: allOf: - $ref: '#/components/schemas/DomainEndpointOptions' - description: The current status of the Elasticsearch domain's endpoint options. AdvancedSecurityOptions: allOf: - $ref: '#/components/schemas/AdvancedSecurityOptions' - description: The current status of the Elasticsearch domain's advanced security options. AutoTuneOptions: allOf: - $ref: '#/components/schemas/AutoTuneOptionsOutput' - description: The current status of the Elasticsearch domain's Auto-Tune options. ChangeProgressDetails: allOf: - $ref: '#/components/schemas/ChangeProgressDetails' - description: Specifies change details of the domain configuration change. description: The current status of an Elasticsearch domain. DomainInformation: type: object required: - DomainName properties: OwnerId: $ref: '#/components/schemas/OwnerId' DomainName: $ref: '#/components/schemas/DomainName' Region: $ref: '#/components/schemas/Region' CreateOutboundCrossClusterSearchConnectionRequest: type: object required: - SourceDomainInfo - DestinationDomainInfo - ConnectionAlias title: CreateOutboundCrossClusterSearchConnectionRequest properties: SourceDomainInfo: allOf: - $ref: '#/components/schemas/DomainInformation' - description: Specifies the DomainInformation for the source Elasticsearch domain. DestinationDomainInfo: allOf: - $ref: '#/components/schemas/DomainInformation' - description: Specifies the DomainInformation for the destination Elasticsearch domain. ConnectionAlias: allOf: - $ref: '#/components/schemas/ConnectionAlias' - description: Specifies the connection alias that will be used by the customer for this connection. description: Container for the parameters to the CreateOutboundCrossClusterSearchConnection operation. OutboundCrossClusterSearchConnectionStatus: type: object properties: StatusCode: allOf: - $ref: '#/components/schemas/OutboundCrossClusterSearchConnectionStatusCode' - description: '

The state code for outbound connection. This can be one of the following:

' Message: allOf: - $ref: '#/components/schemas/CrossClusterSearchConnectionStatusMessage' - description: Specifies verbose information for the outbound connection status. description: Specifies the connection status of an outbound cross-cluster search connection. PackageName: type: string pattern: '[a-z][a-z0-9\-]+' minLength: 3 maxLength: 28 PackageType: type: string enum: - TXT-DICTIONARY PackageDescription: type: string maxLength: 1024 PackageSource: type: object properties: S3BucketName: allOf: - $ref: '#/components/schemas/S3BucketName' - description: Name of the bucket containing the package. S3Key: allOf: - $ref: '#/components/schemas/S3Key' - description: Key (file name) of the package. description: The S3 location for importing the package specified as S3BucketName and S3Key CreatePackageRequest: type: object required: - PackageName - PackageType - PackageSource title: CreatePackageRequest properties: PackageName: allOf: - $ref: '#/components/schemas/PackageName' - description: Unique identifier for the package. PackageType: allOf: - $ref: '#/components/schemas/PackageType' - description: Type of package. Currently supports only TXT-DICTIONARY. PackageDescription: allOf: - $ref: '#/components/schemas/PackageDescription' - description: Description of the package. PackageSource: allOf: - $ref: '#/components/schemas/PackageSource' - description: The customer S3 location PackageSource for importing the package. description: ' Container for request parameters to CreatePackage operation. ' PackageDetails: type: object properties: PackageID: allOf: - $ref: '#/components/schemas/PackageID' - description: Internal ID of the package. PackageName: allOf: - $ref: '#/components/schemas/PackageName' - description: User specified name of the package. PackageType: allOf: - $ref: '#/components/schemas/PackageType' - description: Currently supports only TXT-DICTIONARY. PackageDescription: allOf: - $ref: '#/components/schemas/PackageDescription' - description: User-specified description of the package. PackageStatus: allOf: - $ref: '#/components/schemas/PackageStatus' - description: Current state of the package. Values are COPYING/COPY_FAILED/AVAILABLE/DELETING/DELETE_FAILED CreatedAt: allOf: - $ref: '#/components/schemas/CreatedAt' - description: Timestamp which tells creation date of the package. LastUpdatedAt: $ref: '#/components/schemas/LastUpdated' AvailablePackageVersion: $ref: '#/components/schemas/PackageVersion' ErrorDetails: allOf: - $ref: '#/components/schemas/ErrorDetails' - description: Additional information if the package is in an error state. Null otherwise. description: Basic information about a package. DomainArn: type: string pattern: 'arn:aws[a-z\-]*:[a-z]+:[a-z0-9\-]+:[0-9]+:domain\/[a-z0-9\-]+' minLength: 1 maxLength: 512 CreateVpcEndpointRequest: type: object required: - DomainArn - VpcOptions title: CreateVpcEndpointRequest properties: DomainArn: allOf: - $ref: '#/components/schemas/DomainArn' - description: The Amazon Resource Name (ARN) of the domain to grant access to. VpcOptions: allOf: - $ref: '#/components/schemas/VPCOptions' - description: Options to specify the subnets and security groups for the endpoint. ClientToken: allOf: - $ref: '#/components/schemas/ClientToken' - description: 'Unique, case-sensitive identifier to ensure idempotency of the request.' description: Container for the parameters to the CreateVpcEndpointRequest operation. VpcEndpoint: type: object properties: VpcEndpointId: allOf: - $ref: '#/components/schemas/VpcEndpointId' - description: The unique identifier of the endpoint. VpcEndpointOwner: allOf: - $ref: '#/components/schemas/AWSAccount' - description: The creator of the endpoint. DomainArn: allOf: - $ref: '#/components/schemas/DomainArn' - description: The Amazon Resource Name (ARN) of the domain associated with the endpoint. VpcOptions: allOf: - $ref: '#/components/schemas/VPCDerivedInfo' - description: Options to specify the subnets and security groups for an Amazon OpenSearch Service VPC endpoint. Status: allOf: - $ref: '#/components/schemas/VpcEndpointStatus' - description: The current status of the endpoint. Endpoint: allOf: - $ref: '#/components/schemas/Endpoint' - description: The connection endpoint ID for connecting to the domain. description: The connection endpoint for connecting to an Amazon OpenSearch Service domain through a proxy. CreatedAt: type: string format: date-time CrossClusterSearchConnectionStatusMessage: type: string DeleteElasticsearchDomainRequest: type: object title: DeleteElasticsearchDomainRequest properties: {} description: Container for the parameters to the DeleteElasticsearchDomain operation. Specifies the name of the Elasticsearch domain that you want to delete. DeleteInboundCrossClusterSearchConnectionRequest: type: object title: DeleteInboundCrossClusterSearchConnectionRequest properties: {} description: Container for the parameters to the DeleteInboundCrossClusterSearchConnection operation. DeleteOutboundCrossClusterSearchConnectionRequest: type: object title: DeleteOutboundCrossClusterSearchConnectionRequest properties: {} description: Container for the parameters to the DeleteOutboundCrossClusterSearchConnection operation. OutboundCrossClusterSearchConnection: type: object properties: SourceDomainInfo: allOf: - $ref: '#/components/schemas/DomainInformation' - description: Specifies the DomainInformation for the source Elasticsearch domain. DestinationDomainInfo: allOf: - $ref: '#/components/schemas/DomainInformation' - description: Specifies the DomainInformation for the destination Elasticsearch domain. CrossClusterSearchConnectionId: allOf: - $ref: '#/components/schemas/CrossClusterSearchConnectionId' - description: Specifies the connection id for the outbound cross-cluster search connection. ConnectionAlias: allOf: - $ref: '#/components/schemas/ConnectionAlias' - description: Specifies the connection alias for the outbound cross-cluster search connection. ConnectionStatus: allOf: - $ref: '#/components/schemas/OutboundCrossClusterSearchConnectionStatus' - description: Specifies the OutboundCrossClusterSearchConnectionStatus for the outbound connection. description: Specifies details of an outbound connection. DeletePackageRequest: type: object title: DeletePackageRequest properties: {} description: ' Container for request parameters to DeletePackage operation. ' DeleteVpcEndpointRequest: type: object title: DeleteVpcEndpointRequest properties: {} description: Deletes an Amazon OpenSearch Service-managed interface VPC endpoint. VpcEndpointSummary: type: object properties: VpcEndpointId: allOf: - $ref: '#/components/schemas/VpcEndpointId' - description: The unique identifier of the endpoint. VpcEndpointOwner: allOf: - $ref: '#/components/schemas/String' - description: The creator of the endpoint. DomainArn: allOf: - $ref: '#/components/schemas/DomainArn' - description: The Amazon Resource Name (ARN) of the domain associated with the endpoint. Status: allOf: - $ref: '#/components/schemas/VpcEndpointStatus' - description: The current status of the endpoint. description: Summary information for an Amazon OpenSearch Service-managed VPC endpoint. DeploymentCloseDateTimeStamp: type: string format: date-time DeploymentStatus: type: string enum: - PENDING_UPDATE - IN_PROGRESS - COMPLETED - NOT_ELIGIBLE - ELIGIBLE DeploymentType: type: string minLength: 2 maxLength: 128 MaxResults: type: integer description: ' Set this value to limit the number of results returned. ' maximum: 100 NextToken: type: string description: ' Paginated APIs accepts NextToken input to returns next page results and provides a NextToken output in the response which can be used by the client to retrieve more results. ' DescribeDomainAutoTunesRequest: type: object title: DescribeDomainAutoTunesRequest properties: MaxResults: allOf: - $ref: '#/components/schemas/MaxResults' - description: 'Set this value to limit the number of results returned. If not specified, defaults to 100.' NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: NextToken is sent in case the earlier API call results contain the NextToken. It is used for pagination. description: Container for the parameters to the DescribeDomainAutoTunes operation. DescribeDomainChangeProgressRequest: type: object title: DescribeDomainChangeProgressRequest properties: {} description: 'Container for the parameters to the DescribeDomainChangeProgress operation. Specifies the domain name and optional change specific identity for which you want progress information. ' DescribeElasticsearchDomainConfigRequest: type: object title: DescribeElasticsearchDomainConfigRequest properties: {} description: ' Container for the parameters to the DescribeElasticsearchDomainConfig operation. Specifies the domain name for which you want configuration information.' ElasticsearchDomainConfig: type: object properties: ElasticsearchVersion: allOf: - $ref: '#/components/schemas/ElasticsearchVersionStatus' - description: String of format X.Y to specify version for the Elasticsearch domain. ElasticsearchClusterConfig: allOf: - $ref: '#/components/schemas/ElasticsearchClusterConfigStatus' - description: Specifies the ElasticsearchClusterConfig for the Elasticsearch domain. EBSOptions: allOf: - $ref: '#/components/schemas/EBSOptionsStatus' - description: Specifies the EBSOptions for the Elasticsearch domain. AccessPolicies: allOf: - $ref: '#/components/schemas/AccessPoliciesStatus' - description: IAM access policy as a JSON-formatted string. SnapshotOptions: allOf: - $ref: '#/components/schemas/SnapshotOptionsStatus' - description: Specifies the SnapshotOptions for the Elasticsearch domain. VPCOptions: allOf: - $ref: '#/components/schemas/VPCDerivedInfoStatus' - description: 'The VPCOptions for the specified domain. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.' CognitoOptions: allOf: - $ref: '#/components/schemas/CognitoOptionsStatus' - description: 'The CognitoOptions for the specified domain. For more information, see Amazon Cognito Authentication for Kibana.' EncryptionAtRestOptions: allOf: - $ref: '#/components/schemas/EncryptionAtRestOptionsStatus' - description: Specifies the EncryptionAtRestOptions for the Elasticsearch domain. NodeToNodeEncryptionOptions: allOf: - $ref: '#/components/schemas/NodeToNodeEncryptionOptionsStatus' - description: Specifies the NodeToNodeEncryptionOptions for the Elasticsearch domain. AdvancedOptions: allOf: - $ref: '#/components/schemas/AdvancedOptionsStatus' - description: 'Specifies the AdvancedOptions for the domain. See Configuring Advanced Options for more information.' LogPublishingOptions: allOf: - $ref: '#/components/schemas/LogPublishingOptionsStatus' - description: Log publishing options for the given domain. DomainEndpointOptions: allOf: - $ref: '#/components/schemas/DomainEndpointOptionsStatus' - description: Specifies the DomainEndpointOptions for the Elasticsearch domain. AdvancedSecurityOptions: allOf: - $ref: '#/components/schemas/AdvancedSecurityOptionsStatus' - description: 'Specifies AdvancedSecurityOptions for the domain. ' AutoTuneOptions: allOf: - $ref: '#/components/schemas/AutoTuneOptionsStatus' - description: 'Specifies AutoTuneOptions for the domain. ' ChangeProgressDetails: allOf: - $ref: '#/components/schemas/ChangeProgressDetails' - description: Specifies change details of the domain configuration change. description: The configuration of an Elasticsearch domain. DescribeElasticsearchDomainRequest: type: object title: DescribeElasticsearchDomainRequest properties: {} description: Container for the parameters to the DescribeElasticsearchDomain operation. DomainNameList: type: array description: A list of Elasticsearch domain names. items: $ref: '#/components/schemas/DomainName' DescribeElasticsearchDomainsRequest: type: object required: - DomainNames title: DescribeElasticsearchDomainsRequest properties: DomainNames: allOf: - $ref: '#/components/schemas/DomainNameList' - description: The Elasticsearch domains for which you want information. description: 'Container for the parameters to the DescribeElasticsearchDomains operation. By default, the API returns the status of all Elasticsearch domains.' ElasticsearchDomainStatusList: type: array description: A list that contains the status of each requested Elasticsearch domain. items: $ref: '#/components/schemas/ElasticsearchDomainStatus' DescribeElasticsearchInstanceTypeLimitsRequest: type: object title: DescribeElasticsearchInstanceTypeLimitsRequest properties: {} description: ' Container for the parameters to DescribeElasticsearchInstanceTypeLimits operation. ' LimitsByRole: type: object description: ' Map of Role of the Instance and Limits that are applicable. Role performed by given Instance in Elasticsearch can be one of the following: ' additionalProperties: $ref: '#/components/schemas/Limits' FilterList: type: array items: $ref: '#/components/schemas/Filter' DescribeInboundCrossClusterSearchConnectionsRequest: type: object title: DescribeInboundCrossClusterSearchConnectionsRequest properties: Filters: allOf: - $ref: '#/components/schemas/FilterList' - description: ' A list of filters used to match properties for inbound cross-cluster search connection. Available Filter names for this operation are: ' MaxResults: allOf: - $ref: '#/components/schemas/MaxResults' - description: 'Set this value to limit the number of results returned. If not specified, defaults to 100.' NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: ' NextToken is sent in case the earlier API call results contain the NextToken. It is used for pagination.' description: Container for the parameters to the DescribeInboundCrossClusterSearchConnections operation. InboundCrossClusterSearchConnections: type: array items: $ref: '#/components/schemas/InboundCrossClusterSearchConnection' DescribeOutboundCrossClusterSearchConnectionsRequest: type: object title: DescribeOutboundCrossClusterSearchConnectionsRequest properties: Filters: allOf: - $ref: '#/components/schemas/FilterList' - description: ' A list of filters used to match properties for outbound cross-cluster search connection. Available Filter names for this operation are: ' MaxResults: allOf: - $ref: '#/components/schemas/MaxResults' - description: 'Set this value to limit the number of results returned. If not specified, defaults to 100.' NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: ' NextToken is sent in case the earlier API call results contain the NextToken. It is used for pagination.' description: Container for the parameters to the DescribeOutboundCrossClusterSearchConnections operation. OutboundCrossClusterSearchConnections: type: array items: $ref: '#/components/schemas/OutboundCrossClusterSearchConnection' DescribePackagesFilterName: type: string enum: - PackageID - PackageName - PackageStatus DescribePackagesFilterValues: type: array items: $ref: '#/components/schemas/DescribePackagesFilterValue' minItems: 1 DescribePackagesFilterList: type: array description: A list of DescribePackagesFilter to filter the packages included in a DescribePackages response. items: $ref: '#/components/schemas/DescribePackagesFilter' DescribePackagesFilterValue: type: string pattern: '^[0-9a-zA-Z\*\.\\/\?-]*$' DescribePackagesRequest: type: object title: DescribePackagesRequest properties: Filters: allOf: - $ref: '#/components/schemas/DescribePackagesFilterList' - description: Only returns packages that match the DescribePackagesFilterList values. MaxResults: allOf: - $ref: '#/components/schemas/MaxResults' - description: Limits results to a maximum number of packages. NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: 'Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.' description: ' Container for request parameters to DescribePackage operation. ' PackageDetailsList: type: array items: $ref: '#/components/schemas/PackageDetails' DescribeReservedElasticsearchInstanceOfferingsRequest: type: object title: DescribeReservedElasticsearchInstanceOfferingsRequest properties: {} description: Container for parameters to DescribeReservedElasticsearchInstanceOfferings ReservedElasticsearchInstanceOfferingList: type: array items: $ref: '#/components/schemas/ReservedElasticsearchInstanceOffering' DescribeReservedElasticsearchInstancesRequest: type: object title: DescribeReservedElasticsearchInstancesRequest properties: {} description: Container for parameters to DescribeReservedElasticsearchInstances ReservedElasticsearchInstanceList: type: array items: $ref: '#/components/schemas/ReservedElasticsearchInstance' VpcEndpointIdList: type: array items: $ref: '#/components/schemas/VpcEndpointId' DescribeVpcEndpointsRequest: type: object required: - VpcEndpointIds title: DescribeVpcEndpointsRequest properties: VpcEndpointIds: allOf: - $ref: '#/components/schemas/VpcEndpointIdList' - description: The unique identifiers of the endpoints to get information about. description: Container for request parameters to the DescribeVpcEndpoints operation. Specifies the list of VPC endpoints to be described. VpcEndpoints: type: array items: $ref: '#/components/schemas/VpcEndpoint' VpcEndpointErrorList: type: array items: $ref: '#/components/schemas/VpcEndpointError' DissociatePackageRequest: type: object title: DissociatePackageRequest properties: {} description: ' Container for request parameters to DissociatePackage operation. ' DomainEndpointOptionsStatus: type: object required: - Options - Status properties: Options: allOf: - $ref: '#/components/schemas/DomainEndpointOptions' - description: Options to configure endpoint for the Elasticsearch domain. Status: allOf: - $ref: '#/components/schemas/OptionStatus' - description: 'The status of the endpoint options for the Elasticsearch domain. See OptionStatus for the status information that''s included. ' description: The configured endpoint options for the domain and their current status. DomainId: type: string description: Unique identifier for an Elasticsearch domain. minLength: 1 maxLength: 64 EngineType: type: string enum: - OpenSearch - Elasticsearch DomainInfo: type: object properties: DomainName: allOf: - $ref: '#/components/schemas/DomainName' - description: ' Specifies the DomainName.' EngineType: allOf: - $ref: '#/components/schemas/EngineType' - description: ' Specifies the EngineType of the domain.' DomainInfoList: type: array description: ' Contains the list of Elasticsearch domain information.' items: $ref: '#/components/schemas/DomainInfo' DomainPackageStatus: type: string enum: - ASSOCIATING - ASSOCIATION_FAILED - ACTIVE - DISSOCIATING - DISSOCIATION_FAILED PackageVersion: type: string ReferencePath: type: string ErrorDetails: type: object properties: ErrorType: $ref: '#/components/schemas/ErrorType' ErrorMessage: $ref: '#/components/schemas/ErrorMessage' DomainPackageDetailsList: type: array items: $ref: '#/components/schemas/DomainPackageDetails' Double: type: number format: double DryRun: type: boolean DryRunResults: type: object properties: DeploymentType: allOf: - $ref: '#/components/schemas/DeploymentType' - description: ' Specifies the deployment mechanism through which the update shall be applied on the domain. Possible responses are Blue/Green (The update will require a blue/green deployment.) DynamicUpdate (The update can be applied in-place without a Blue/Green deployment required.) Undetermined (The domain is undergoing an update which needs to complete before the deployment type can be predicted.) None (The configuration change matches the current configuration and will not result in any update.) ' Message: allOf: - $ref: '#/components/schemas/Message' - description: Contains an optional message associated with the DryRunResults. DurationValue: type: integer description: ' Integer to specify the value of a maintenance schedule duration. See the Developer Guide for more information.' minimum: 1 maximum: 24 TimeUnit: type: string enum: - HOURS description: 'Specifies the unit of a maintenance schedule duration. Valid value is HOUR. See the Developer Guide for more information.' EBSOptionsStatus: type: object required: - Options - Status properties: Options: allOf: - $ref: '#/components/schemas/EBSOptions' - description: ' Specifies the EBS options for the specified Elasticsearch domain.' Status: allOf: - $ref: '#/components/schemas/OptionStatus' - description: ' Specifies the status of the EBS options for the specified Elasticsearch domain.' description: ' Status of the EBS options for the specified Elasticsearch domain.' ElasticsearchClusterConfigStatus: type: object required: - Options - Status properties: Options: allOf: - $ref: '#/components/schemas/ElasticsearchClusterConfig' - description: ' Specifies the cluster configuration for the specified Elasticsearch domain.' Status: allOf: - $ref: '#/components/schemas/OptionStatus' - description: ' Specifies the status of the configuration for the specified Elasticsearch domain.' description: ' Specifies the configuration status for the specified Elasticsearch domain.' ElasticsearchVersionStatus: type: object required: - Options - Status properties: Options: allOf: - $ref: '#/components/schemas/ElasticsearchVersionString' - description: ' Specifies the Elasticsearch version for the specified Elasticsearch domain.' Status: allOf: - $ref: '#/components/schemas/OptionStatus' - description: ' Specifies the status of the Elasticsearch version options for the specified Elasticsearch domain.' description: ' Status of the Elasticsearch version options for the specified Elasticsearch domain.' SnapshotOptionsStatus: type: object required: - Options - Status properties: Options: allOf: - $ref: '#/components/schemas/SnapshotOptions' - description: Specifies the daily snapshot options specified for the Elasticsearch domain. Status: allOf: - $ref: '#/components/schemas/OptionStatus' - description: Specifies the status of a daily automated snapshot. description: Status of a daily automated snapshot. VPCDerivedInfoStatus: type: object required: - Options - Status properties: Options: allOf: - $ref: '#/components/schemas/VPCDerivedInfo' - description: ' Specifies the VPC options for the specified Elasticsearch domain.' Status: allOf: - $ref: '#/components/schemas/OptionStatus' - description: ' Specifies the status of the VPC options for the specified Elasticsearch domain.' description: ' Status of the VPC options for the specified Elasticsearch domain.' EncryptionAtRestOptionsStatus: type: object required: - Options - Status properties: Options: allOf: - $ref: '#/components/schemas/EncryptionAtRestOptions' - description: ' Specifies the Encryption At Rest options for the specified Elasticsearch domain.' Status: allOf: - $ref: '#/components/schemas/OptionStatus' - description: ' Specifies the status of the Encryption At Rest options for the specified Elasticsearch domain.' description: ' Status of the Encryption At Rest options for the specified Elasticsearch domain.' NodeToNodeEncryptionOptionsStatus: type: object required: - Options - Status properties: Options: allOf: - $ref: '#/components/schemas/NodeToNodeEncryptionOptions' - description: Specifies the node-to-node encryption options for the specified Elasticsearch domain. Status: allOf: - $ref: '#/components/schemas/OptionStatus' - description: Specifies the status of the node-to-node encryption options for the specified Elasticsearch domain. description: Status of the node-to-node encryption options for the specified Elasticsearch domain. LogPublishingOptionsStatus: type: object properties: Options: allOf: - $ref: '#/components/schemas/LogPublishingOptions' - description: The log publishing options configured for the Elasticsearch domain. Status: allOf: - $ref: '#/components/schemas/OptionStatus' - description: 'The status of the log publishing options for the Elasticsearch domain. See OptionStatus for the status information that''s included. ' description: The configured log publishing options for the domain and their current status. ServiceUrl: type: string description: 'The endpoint to which service requests are submitted. For example, search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.es.amazonaws.com or doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.es.amazonaws.com.' EndpointsMap: type: object additionalProperties: $ref: '#/components/schemas/ServiceUrl' VPCDerivedInfo: type: object properties: VPCId: allOf: - $ref: '#/components/schemas/String' - description: The VPC Id for the Elasticsearch domain. Exists only if the domain was created with VPCOptions. SubnetIds: allOf: - $ref: '#/components/schemas/StringList' - description: Specifies the subnets for VPC endpoint. AvailabilityZones: allOf: - $ref: '#/components/schemas/StringList' - description: The availability zones for the Elasticsearch domain. Exists only if the domain was created with VPCOptions. SecurityGroupIds: allOf: - $ref: '#/components/schemas/StringList' - description: Specifies the security groups for VPC endpoint. description: 'Options to specify the subnets and security groups for VPC endpoint. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.' ElasticsearchInstanceTypeList: type: array description: ' List of instance types supported by Amazon Elasticsearch service. ' items: $ref: '#/components/schemas/ESPartitionInstanceType' Endpoint: type: string pattern: '^[A-Za-z0-9\-\.]+$' ErrorType: type: string ErrorMessage: type: string NonEmptyString: type: string minLength: 1 ValueStringList: type: array items: $ref: '#/components/schemas/NonEmptyString' minItems: 1 GetCompatibleElasticsearchVersionsRequest: type: object title: GetCompatibleElasticsearchVersionsRequest properties: {} description: ' Container for request parameters to GetCompatibleElasticsearchVersions operation. ' GetPackageVersionHistoryRequest: type: object title: GetPackageVersionHistoryRequest properties: {} description: ' Container for request parameters to GetPackageVersionHistory operation. ' PackageVersionHistoryList: type: array items: $ref: '#/components/schemas/PackageVersionHistory' GetUpgradeHistoryRequest: type: object title: GetUpgradeHistoryRequest properties: {} description: ' Container for request parameters to GetUpgradeHistory operation. ' UpgradeHistoryList: type: array items: $ref: '#/components/schemas/UpgradeHistory' GetUpgradeStatusRequest: type: object title: GetUpgradeStatusRequest properties: {} description: ' Container for request parameters to GetUpgradeStatus operation. ' UpgradeStep: type: string enum: - PRE_UPGRADE_CHECK - SNAPSHOT - UPGRADE UpgradeStatus: type: string enum: - IN_PROGRESS - SUCCEEDED - SUCCEEDED_WITH_ISSUES - FAILED UpgradeName: type: string InboundCrossClusterSearchConnectionStatus: type: object properties: StatusCode: allOf: - $ref: '#/components/schemas/InboundCrossClusterSearchConnectionStatusCode' - description: '

The state code for inbound connection. This can be one of the following:

' Message: allOf: - $ref: '#/components/schemas/CrossClusterSearchConnectionStatusMessage' - description: Specifies verbose information for the inbound connection status. description: Specifies the coonection status of an inbound cross-cluster search connection. InboundCrossClusterSearchConnectionStatusCode: type: string enum: - PENDING_ACCEPTANCE - APPROVED - REJECTING - REJECTED - DELETING - DELETED InstanceCount: type: integer description: Specifies the number of EC2 instances in the Elasticsearch domain. minimum: 1 MinimumInstanceCount: type: integer description: ' Minimum number of Instances that can be instantiated for given InstanceType. ' MaximumInstanceCount: type: integer description: ' Maximum number of Instances that can be instantiated for given InstanceType. ' InstanceCountLimits: type: object properties: MinimumInstanceCount: $ref: '#/components/schemas/MinimumInstanceCount' MaximumInstanceCount: $ref: '#/components/schemas/MaximumInstanceCount' description: ' InstanceCountLimits represents the limits on number of instances that be created in Amazon Elasticsearch for given InstanceType. ' InstanceLimits: type: object properties: InstanceCountLimits: $ref: '#/components/schemas/InstanceCountLimits' description: 'InstanceLimits represents the list of instance related attributes that are available for given InstanceType. ' InstanceRole: type: string Integer: type: integer Issue: type: string Issues: type: array items: $ref: '#/components/schemas/Issue' LimitValue: type: string StorageTypeList: type: array items: $ref: '#/components/schemas/StorageType' Limits: type: object properties: StorageTypes: allOf: - $ref: '#/components/schemas/StorageTypeList' - description: 'StorageType represents the list of storage related types and attributes that are available for given InstanceType. ' InstanceLimits: $ref: '#/components/schemas/InstanceLimits' AdditionalLimits: allOf: - $ref: '#/components/schemas/AdditionalLimitList' - description: ' List of additional limits that are specific to a given InstanceType and for each of it''s InstanceRole . ' description: ' Limits for given InstanceType and for each of it''s role.
Limits contains following StorageTypes, InstanceLimits and AdditionalLimits ' ListDomainNamesRequest: type: object title: ListDomainNamesRequest properties: {} description: ' Container for the parameters to the ListDomainNames operation.' ListDomainsForPackageRequest: type: object title: ListDomainsForPackageRequest properties: {} description: ' Container for request parameters to ListDomainsForPackage operation. ' ListElasticsearchInstanceTypesRequest: type: object title: ListElasticsearchInstanceTypesRequest properties: {} description: ' Container for the parameters to the ListElasticsearchInstanceTypes operation. ' ListElasticsearchVersionsRequest: type: object title: ListElasticsearchVersionsRequest properties: {} description: '

Container for the parameters to the ListElasticsearchVersions operation.

Use MaxResults to control the maximum number of results to retrieve in a single call.

Use NextToken in response to retrieve more results. If the received response does not contain a NextToken, then there are no more results to retrieve.

' ListPackagesForDomainRequest: type: object title: ListPackagesForDomainRequest properties: {} description: ' Container for request parameters to ListPackagesForDomain operation. ' ListTagsRequest: type: object title: ListTagsRequest properties: {} description: Container for the parameters to the ListTags operation. Specify the ARN for the Elasticsearch domain to which the tags are attached that you want to view are attached. ListVpcEndpointAccessRequest: type: object title: ListVpcEndpointAccessRequest properties: {} description: Retrieves information about each principal that is allowed to access a given Amazon OpenSearch Service domain through the use of an interface VPC endpoint ListVpcEndpointsForDomainRequest: type: object title: ListVpcEndpointsForDomainRequest properties: {} description: Container for request parameters to the ListVpcEndpointsForDomain operation. Specifies the domain whose VPC endpoints will be listed. VpcEndpointSummaryList: type: array items: $ref: '#/components/schemas/VpcEndpointSummary' ListVpcEndpointsRequest: type: object title: ListVpcEndpointsRequest properties: {} description: Container for request parameters to the ListVpcEndpoints operation. LogType: type: string enum: - INDEX_SLOW_LOGS - SEARCH_SLOW_LOGS - ES_APPLICATION_LOGS - AUDIT_LOGS description: 'Type of Log File, it can be one of the following: ' Username: type: string minLength: 1 format: password Password: type: string minLength: 8 format: password OptionState: type: string enum: - RequiresIndexDocuments - Processing - Active description: '

The state of a requested change. One of the following:

' OutboundCrossClusterSearchConnectionStatusCode: type: string enum: - PENDING_ACCEPTANCE - VALIDATING - VALIDATION_FAILED - PROVISIONING - ACTIVE - REJECTED - DELETING - DELETED PackageStatus: type: string enum: - COPYING - COPY_FAILED - VALIDATING - VALIDATION_FAILED - AVAILABLE - DELETING - DELETED - DELETE_FAILED PackageVersionHistory: type: object properties: PackageVersion: allOf: - $ref: '#/components/schemas/PackageVersion' - description: Version of the package. CommitMessage: allOf: - $ref: '#/components/schemas/CommitMessage' - description: A message associated with the version. CreatedAt: allOf: - $ref: '#/components/schemas/CreatedAt' - description: Timestamp which tells creation time of the package version. description: Details of a package version. ReservationToken: type: string minLength: 5 maxLength: 64 PurchaseReservedElasticsearchInstanceOfferingRequest: type: object required: - ReservedElasticsearchInstanceOfferingId - ReservationName title: PurchaseReservedElasticsearchInstanceOfferingRequest properties: ReservedElasticsearchInstanceOfferingId: allOf: - $ref: '#/components/schemas/GUID' - description: The ID of the reserved Elasticsearch instance offering to purchase. ReservationName: allOf: - $ref: '#/components/schemas/ReservationToken' - description: A customer-specified identifier to track this reservation. InstanceCount: allOf: - $ref: '#/components/schemas/InstanceCount' - description: The number of Elasticsearch instances to reserve. description: Container for parameters to PurchaseReservedElasticsearchInstanceOffering RecurringCharge: type: object properties: RecurringChargeAmount: allOf: - $ref: '#/components/schemas/Double' - description: The monetary amount of the recurring charge. RecurringChargeFrequency: allOf: - $ref: '#/components/schemas/String' - description: The frequency of the recurring charge. description: 'Contains the specific price and frequency of a recurring charges for a reserved Elasticsearch instance, or for a reserved Elasticsearch instance offering.' RecurringChargeList: type: array items: $ref: '#/components/schemas/RecurringCharge' RejectInboundCrossClusterSearchConnectionRequest: type: object title: RejectInboundCrossClusterSearchConnectionRequest properties: {} description: Container for the parameters to the RejectInboundCrossClusterSearchConnection operation. RemoveTagsRequest: type: object required: - ARN - TagKeys title: RemoveTagsRequest properties: ARN: allOf: - $ref: '#/components/schemas/ARN' - description: Specifies the ARN for the Elasticsearch domain from which you want to delete the specified tags. TagKeys: allOf: - $ref: '#/components/schemas/StringList' - description: Specifies the TagKey list which you want to remove from the Elasticsearch domain. description: Container for the parameters to the RemoveTags operation. Specify the ARN for the Elasticsearch domain from which you want to remove the specified TagKey. ReservedElasticsearchInstancePaymentOption: type: string enum: - ALL_UPFRONT - PARTIAL_UPFRONT - NO_UPFRONT ReservedElasticsearchInstance: type: object properties: ReservationName: allOf: - $ref: '#/components/schemas/ReservationToken' - description: The customer-specified identifier to track this reservation. ReservedElasticsearchInstanceId: allOf: - $ref: '#/components/schemas/GUID' - description: The unique identifier for the reservation. ReservedElasticsearchInstanceOfferingId: allOf: - $ref: '#/components/schemas/String' - description: The offering identifier. ElasticsearchInstanceType: allOf: - $ref: '#/components/schemas/ESPartitionInstanceType' - description: The Elasticsearch instance type offered by the reserved instance offering. StartTime: allOf: - $ref: '#/components/schemas/UpdateTimestamp' - description: The time the reservation started. Duration: allOf: - $ref: '#/components/schemas/Integer' - description: 'The duration, in seconds, for which the Elasticsearch instance is reserved.' FixedPrice: allOf: - $ref: '#/components/schemas/Double' - description: 'The upfront fixed charge you will paid to purchase the specific reserved Elasticsearch instance offering. ' UsagePrice: allOf: - $ref: '#/components/schemas/Double' - description: The rate you are charged for each hour for the domain that is using this reserved instance. CurrencyCode: allOf: - $ref: '#/components/schemas/String' - description: The currency code for the reserved Elasticsearch instance offering. ElasticsearchInstanceCount: allOf: - $ref: '#/components/schemas/Integer' - description: The number of Elasticsearch instances that have been reserved. State: allOf: - $ref: '#/components/schemas/String' - description: The state of the reserved Elasticsearch instance. PaymentOption: allOf: - $ref: '#/components/schemas/ReservedElasticsearchInstancePaymentOption' - description: The payment option as defined in the reserved Elasticsearch instance offering. RecurringCharges: allOf: - $ref: '#/components/schemas/RecurringChargeList' - description: The charge to your account regardless of whether you are creating any domains using the instance offering. description: Details of a reserved Elasticsearch instance. ReservedElasticsearchInstanceOffering: type: object properties: ReservedElasticsearchInstanceOfferingId: allOf: - $ref: '#/components/schemas/GUID' - description: The Elasticsearch reserved instance offering identifier. ElasticsearchInstanceType: allOf: - $ref: '#/components/schemas/ESPartitionInstanceType' - description: The Elasticsearch instance type offered by the reserved instance offering. Duration: allOf: - $ref: '#/components/schemas/Integer' - description: 'The duration, in seconds, for which the offering will reserve the Elasticsearch instance.' FixedPrice: allOf: - $ref: '#/components/schemas/Double' - description: 'The upfront fixed charge you will pay to purchase the specific reserved Elasticsearch instance offering. ' UsagePrice: allOf: - $ref: '#/components/schemas/Double' - description: The rate you are charged for each hour the domain that is using the offering is running. CurrencyCode: allOf: - $ref: '#/components/schemas/String' - description: The currency code for the reserved Elasticsearch instance offering. PaymentOption: allOf: - $ref: '#/components/schemas/ReservedElasticsearchInstancePaymentOption' - description: Payment option for the reserved Elasticsearch instance offering RecurringCharges: allOf: - $ref: '#/components/schemas/RecurringChargeList' - description: The charge to your account regardless of whether you are creating any domains using the instance offering. description: Details of a reserved Elasticsearch instance offering. RevokeVpcEndpointAccessRequest: type: object required: - Account title: RevokeVpcEndpointAccessRequest properties: Account: allOf: - $ref: '#/components/schemas/AWSAccount' - description: The account ID to revoke access from. description: Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint. SAMLEntityId: type: string minLength: 8 maxLength: 512 SAMLMetadata: type: string minLength: 1 maxLength: 1048576 SAMLIdp: type: object required: - MetadataContent - EntityId properties: MetadataContent: allOf: - $ref: '#/components/schemas/SAMLMetadata' - description: The Metadata of the SAML application in xml format. EntityId: allOf: - $ref: '#/components/schemas/SAMLEntityId' - description: The unique Entity ID of the application in SAML Identity Provider. description: Specifies the SAML Identity Provider's information. ScheduledAutoTuneActionType: type: string enum: - JVM_HEAP_SIZE_TUNING - JVM_YOUNG_GEN_TUNING description: 'Specifies Auto-Tune action type. Valid values are JVM_HEAP_SIZE_TUNING and JVM_YOUNG_GEN_TUNING. ' ScheduledAutoTuneDescription: type: string description: 'Specifies Auto-Tune action description. ' ScheduledAutoTuneSeverityType: type: string enum: - LOW - MEDIUM - HIGH description: 'Specifies Auto-Tune action severity. Valid values are LOW, MEDIUM and HIGH. ' StartElasticsearchServiceSoftwareUpdateRequest: type: object required: - DomainName title: StartElasticsearchServiceSoftwareUpdateRequest properties: DomainName: allOf: - $ref: '#/components/schemas/DomainName' - description: The name of the domain that you want to update to the latest service software. description: Container for the parameters to the StartElasticsearchServiceSoftwareUpdate operation. Specifies the name of the Elasticsearch domain that you wish to schedule a service software update on. StartTimestamp: type: string format: date-time StorageSubTypeName: type: string description: ' SubType of the given storage type. List of available sub-storage options: For "instance" storageType we wont have any storageSubType, in case of "ebs" storageType we will have following valid storageSubTypes
  1. standard
  2. gp2
  3. gp3
  4. io1
Refer VolumeType for more information regarding above EBS storage options. ' StorageTypeName: type: string description: ' Type of the storage. List of available storage options:
  1. instance
  2. Inbuilt storage available for the given Instance
  3. ebs
  4. Elastic block storage that would be attached to the given Instance
' StorageTypeLimitList: type: array items: $ref: '#/components/schemas/StorageTypeLimit' StorageType: type: object properties: StorageTypeName: $ref: '#/components/schemas/StorageTypeName' StorageSubTypeName: $ref: '#/components/schemas/StorageSubTypeName' StorageTypeLimits: allOf: - $ref: '#/components/schemas/StorageTypeLimitList' - description: 'List of limits that are applicable for given storage type. ' description: 'StorageTypes represents the list of storage related types and their attributes that are available for given InstanceType. ' StorageTypeLimit: type: object properties: LimitName: allOf: - $ref: '#/components/schemas/LimitName' - description: ' Name of storage limits that are applicable for given storage type. If StorageType is ebs, following storage options are applicable
  1. MinimumVolumeSize
  2. Minimum amount of volume size that is applicable for given storage type.It can be empty if it is not applicable.
  3. MaximumVolumeSize
  4. Maximum amount of volume size that is applicable for given storage type.It can be empty if it is not applicable.
  5. MaximumIops
  6. Maximum amount of Iops that is applicable for given storage type.It can be empty if it is not applicable.
  7. MinimumIops
  8. Minimum amount of Iops that is applicable for given storage type.It can be empty if it is not applicable.
  9. MaximumThroughput
  10. Maximum amount of Throughput that is applicable for given storage type.It can be empty if it is not applicable.
  11. MinimumThroughput
  12. Minimum amount of Throughput that is applicable for given storage type.It can be empty if it is not applicable.
' LimitValues: allOf: - $ref: '#/components/schemas/LimitValueList' - description: ' Values for the StorageTypeLimit$LimitName . ' description: 'Limits that are applicable for given storage type. ' TagKey: type: string description: A string of length from 1 to 128 characters that specifies the key for a Tag. Tag keys must be unique for the Elasticsearch domain to which they are attached. minLength: 1 maxLength: 128 TagValue: type: string description: A string of length from 0 to 256 characters that specifies the value for a Tag. Tag values can be null and do not have to be unique in a tag set. minLength: 0 maxLength: 256 UpdateElasticsearchDomainConfigRequest: type: object title: UpdateElasticsearchDomainConfigRequest properties: ElasticsearchClusterConfig: allOf: - $ref: '#/components/schemas/ElasticsearchClusterConfig' - description: The type and number of instances to instantiate for the domain cluster. EBSOptions: allOf: - $ref: '#/components/schemas/EBSOptions' - description: 'Specify the type and size of the EBS volume that you want to use. ' SnapshotOptions: allOf: - $ref: '#/components/schemas/SnapshotOptions' - description: 'Option to set the time, in UTC format, for the daily automated snapshot. Default value is 0 hours. ' VPCOptions: allOf: - $ref: '#/components/schemas/VPCOptions' - description: 'Options to specify the subnets and security groups for VPC endpoint. For more information, see Creating a VPC in VPC Endpoints for Amazon Elasticsearch Service Domains' CognitoOptions: allOf: - $ref: '#/components/schemas/CognitoOptions' - description: 'Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana.' AdvancedOptions: allOf: - $ref: '#/components/schemas/AdvancedOptions' - description: 'Modifies the advanced option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Configuration Advanced Options for more information.' AccessPolicies: allOf: - $ref: '#/components/schemas/PolicyDocument' - description: IAM access policy as a JSON-formatted string. LogPublishingOptions: allOf: - $ref: '#/components/schemas/LogPublishingOptions' - description: 'Map of LogType and LogPublishingOption, each containing options to publish a given type of Elasticsearch log.' DomainEndpointOptions: allOf: - $ref: '#/components/schemas/DomainEndpointOptions' - description: Options to specify configuration that will be applied to the domain endpoint. AdvancedSecurityOptions: allOf: - $ref: '#/components/schemas/AdvancedSecurityOptionsInput' - description: Specifies advanced security options. NodeToNodeEncryptionOptions: allOf: - $ref: '#/components/schemas/NodeToNodeEncryptionOptions' - description: Specifies the NodeToNodeEncryptionOptions. EncryptionAtRestOptions: allOf: - $ref: '#/components/schemas/EncryptionAtRestOptions' - description: Specifies the Encryption At Rest Options. AutoTuneOptions: allOf: - $ref: '#/components/schemas/AutoTuneOptions' - description: Specifies Auto-Tune options. DryRun: allOf: - $ref: '#/components/schemas/DryRun' - description: ' This flag, when set to True, specifies whether the UpdateElasticsearchDomain request should return the results of validation checks without actually applying the change. This flag, when set to True, specifies the deployment mechanism through which the update shall be applied on the domain. This will not actually perform the Update. ' description: Container for the parameters to the UpdateElasticsearchDomain operation. Specifies the type and number of instances in the domain cluster. UpdatePackageRequest: type: object required: - PackageID - PackageSource title: UpdatePackageRequest properties: PackageID: allOf: - $ref: '#/components/schemas/PackageID' - description: Unique identifier for the package. PackageSource: $ref: '#/components/schemas/PackageSource' PackageDescription: allOf: - $ref: '#/components/schemas/PackageDescription' - description: New description of the package. CommitMessage: allOf: - $ref: '#/components/schemas/CommitMessage' - description: An info message for the new version which will be shown as part of GetPackageVersionHistoryResponse. description: ' Container for request parameters to UpdatePackage operation. ' UpdateVpcEndpointRequest: type: object required: - VpcEndpointId - VpcOptions title: UpdateVpcEndpointRequest properties: VpcEndpointId: allOf: - $ref: '#/components/schemas/VpcEndpointId' - description: Unique identifier of the VPC endpoint to be updated. VpcOptions: allOf: - $ref: '#/components/schemas/VPCOptions' - description: 'The security groups and/or subnets to add, remove, or modify.' description: Modifies an Amazon OpenSearch Service-managed interface VPC endpoint. UpgradeElasticsearchDomainRequest: type: object required: - DomainName - TargetVersion title: UpgradeElasticsearchDomainRequest properties: DomainName: $ref: '#/components/schemas/DomainName' TargetVersion: allOf: - $ref: '#/components/schemas/ElasticsearchVersionString' - description: The version of Elasticsearch that you intend to upgrade the domain to. PerformCheckOnly: allOf: - $ref: '#/components/schemas/Boolean' - description: ' This flag, when set to True, indicates that an Upgrade Eligibility Check needs to be performed. This will not actually perform the Upgrade. ' description: ' Container for request parameters to UpgradeElasticsearchDomain operation. ' UpgradeStepsList: type: array items: $ref: '#/components/schemas/UpgradeStepItem' UpgradeHistory: type: object properties: UpgradeName: allOf: - $ref: '#/components/schemas/UpgradeName' - description: A string that describes the update briefly StartTimestamp: allOf: - $ref: '#/components/schemas/StartTimestamp' - description: 'UTC Timestamp at which the Upgrade API call was made in "yyyy-MM-ddTHH:mm:ssZ" format.' UpgradeStatus: allOf: - $ref: '#/components/schemas/UpgradeStatus' - description: ' The overall status of the update. The status can take one of the following values: ' StepsList: allOf: - $ref: '#/components/schemas/UpgradeStepsList' - description: ' A list of UpgradeStepItem s representing information about each step performed as pard of a specific Upgrade or Upgrade Eligibility Check. ' description: History of the last 10 Upgrades and Upgrade Eligibility Checks. UpgradeStepItem: type: object properties: UpgradeStep: allOf: - $ref: '#/components/schemas/UpgradeStep' - description: ' Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does through: ' UpgradeStepStatus: allOf: - $ref: '#/components/schemas/UpgradeStatus' - description: ' The status of a particular step during an upgrade. The status can take one of the following values: ' Issues: allOf: - $ref: '#/components/schemas/Issues' - description: A list of strings containing detailed information about the errors encountered in a particular step. ProgressPercent: allOf: - $ref: '#/components/schemas/Double' - description: The Floating point value representing progress percentage of a particular step. description: Represents a single step of the Upgrade or Upgrade Eligibility Check workflow. VpcEndpointStatus: type: string enum: - CREATING - CREATE_FAILED - ACTIVE - UPDATING - UPDATE_FAILED - DELETING - DELETE_FAILED description: 'Specifies the current status of the VPC endpoint: ' VpcEndpointErrorCode: type: string enum: - ENDPOINT_NOT_FOUND - SERVER_ERROR description: 'Specifies the error code of the failure encountered while describing the VPC endpoint: ' VpcEndpointError: type: object properties: VpcEndpointId: allOf: - $ref: '#/components/schemas/VpcEndpointId' - description: 'The unique identifier of the endpoint. ' ErrorCode: allOf: - $ref: '#/components/schemas/VpcEndpointErrorCode' - description: The code associated with the error. ErrorMessage: allOf: - $ref: '#/components/schemas/String' - description: A message describing the error. description: Error information when attempting to describe an Amazon OpenSearch Service-managed VPC endpoint. security: - hmac: []