{ "openapi": "3.0.0", "info": { "version": "2011-02-01", "x-release": "v4", "title": "Amazon CloudSearch", "description": "Amazon CloudSearch Configuration Service

You use the configuration service to create, configure, and manage search domains. Configuration service requests are submitted using the AWS Query protocol. AWS Query requests are HTTP or HTTPS requests submitted via HTTP GET or POST with a query parameter named Action.

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

", "x-logo": { "url": "https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png", "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": "cloudsearch", "x-origin": [ { "contentType": "application/json", "url": "https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/cloudsearch-2011-02-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": false }, "externalDocs": { "description": "Amazon Web Services documentation", "url": "https://docs.aws.amazon.com/cloudsearch/" }, "servers": [ { "url": "http://cloudsearch.{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 CloudSearch multi-region endpoint" }, { "url": "https://cloudsearch.{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 CloudSearch multi-region endpoint" }, { "url": "http://cloudsearch.{region}.amazonaws.com.cn", "variables": { "region": { "description": "The AWS region", "enum": [ "cn-north-1", "cn-northwest-1" ], "default": "cn-north-1" } }, "description": "The Amazon CloudSearch endpoint for China (Beijing) and China (Ningxia)" }, { "url": "https://cloudsearch.{region}.amazonaws.com.cn", "variables": { "region": { "description": "The AWS region", "enum": [ "cn-north-1", "cn-northwest-1" ], "default": "cn-north-1" } }, "description": "The Amazon CloudSearch endpoint for China (Beijing) and China (Ningxia)" } ], "x-hasEquivalentPaths": true, "paths": { "/#Action=CreateDomain": { "get": { "x-aws-operation-name": "CreateDomain", "operationId": "GET_CreateDomain", "description": "Creates a new search domain.", "responses": { "200": { "description": "Success", "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/CreateDomainResponse" } } } }, "409": { "description": "LimitExceededException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/LimitExceededException" } } } }, "480": { "description": "BaseException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/BaseException" } } } }, "500": { "description": "InternalException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/InternalException" } } } } }, "parameters": [ { "name": "DomainName", "in": "query", "required": true, "description": "", "schema": { "type": "string", "pattern": "[a-z][a-z0-9\\-]+", "description": "A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.", "minLength": 3, "maxLength": 28 } }, { "name": "Action", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "CreateDomain" ] } }, { "name": "Version", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "2011-02-01" ] } } ] }, "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": { "x-aws-operation-name": "CreateDomain", "operationId": "POST_CreateDomain", "description": "Creates a new search domain.", "responses": { "200": { "description": "Success", "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/CreateDomainResponse" } } } }, "409": { "description": "LimitExceededException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/LimitExceededException" } } } }, "480": { "description": "BaseException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/BaseException" } } } }, "500": { "description": "InternalException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/InternalException" } } } } }, "requestBody": { "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/CreateDomainRequest" } } } }, "parameters": [ { "name": "Action", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "CreateDomain" ] } }, { "name": "Version", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "2011-02-01" ] } } ] } }, "/#Action=DefineIndexField": { "get": { "x-aws-operation-name": "DefineIndexField", "operationId": "GET_DefineIndexField", "description": "Configures an IndexField for the search domain. Used to create new fields and modify existing ones. If the field exists, the new configuration replaces the old one. You can configure a maximum of 200 index fields.", "responses": { "200": { "description": "Success", "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/DefineIndexFieldResponse" } } } }, "409": { "description": "ResourceNotFoundException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundException" } } } }, "480": { "description": "BaseException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/BaseException" } } } }, "500": { "description": "InternalException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/InternalException" } } } } }, "parameters": [ { "name": "DomainName", "in": "query", "required": true, "description": "", "schema": { "type": "string", "pattern": "[a-z][a-z0-9\\-]+", "description": "A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.", "minLength": 3, "maxLength": 28 } }, { "name": "IndexField", "in": "query", "required": true, "description": "", "schema": { "type": "object", "required": [ "IndexFieldName", "IndexFieldType" ], "properties": { "IndexFieldName": { "allOf": [ { "$ref": "#/components/schemas/FieldName" }, { "description": "The name of a field in the search index. Field names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Uppercase letters and hyphens are not allowed. The names \"body\", \"docid\", and \"text_relevance\" are reserved and cannot be specified as field or rank expression names." } ] }, "IndexFieldType": { "allOf": [ { "$ref": "#/components/schemas/IndexFieldType" }, { "description": "The type of field. Based on this type, exactly one of the UIntOptions, LiteralOptions or TextOptions must be present." } ] }, "UIntOptions": { "allOf": [ { "$ref": "#/components/schemas/UIntOptions" }, { "description": "Options for an unsigned integer field. Present if IndexFieldType specifies the field is of type unsigned integer." } ] }, "LiteralOptions": { "allOf": [ { "$ref": "#/components/schemas/LiteralOptions" }, { "description": "Options for literal field. Present if IndexFieldType specifies the field is of type literal." } ] }, "TextOptions": { "allOf": [ { "$ref": "#/components/schemas/TextOptions" }, { "description": "Options for text field. Present if IndexFieldType specifies the field is of type text." } ] }, "SourceAttributes": { "allOf": [ { "$ref": "#/components/schemas/SourceAttributeList" }, { "description": "An optional list of source attributes that provide data for this index field. If not specified, the data is pulled from a source attribute with the same name as this IndexField. When one or more source attributes are specified, an optional data transformation can be applied to the source data when populating the index field. You can configure a maximum of 20 sources for an IndexField." } ] } }, "description": "Defines a field in the index, including its name, type, and the source of its data. The IndexFieldType indicates which of the options will be present. It is invalid to specify options for a type other than the IndexFieldType." } }, { "name": "Action", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "DefineIndexField" ] } }, { "name": "Version", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "2011-02-01" ] } } ] }, "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": { "x-aws-operation-name": "DefineIndexField", "operationId": "POST_DefineIndexField", "description": "Configures an IndexField for the search domain. Used to create new fields and modify existing ones. If the field exists, the new configuration replaces the old one. You can configure a maximum of 200 index fields.", "responses": { "200": { "description": "Success", "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/DefineIndexFieldResponse" } } } }, "409": { "description": "ResourceNotFoundException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundException" } } } }, "480": { "description": "BaseException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/BaseException" } } } }, "500": { "description": "InternalException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/InternalException" } } } } }, "requestBody": { "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/DefineIndexFieldRequest" } } } }, "parameters": [ { "name": "Action", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "DefineIndexField" ] } }, { "name": "Version", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "2011-02-01" ] } } ] } }, "/#Action=DefineRankExpression": { "get": { "x-aws-operation-name": "DefineRankExpression", "operationId": "GET_DefineRankExpression", "description": "Configures a RankExpression for the search domain. Used to create new rank expressions and modify existing ones. If the expression exists, the new configuration replaces the old one. You can configure a maximum of 50 rank expressions.", "responses": { "200": { "description": "Success", "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/DefineRankExpressionResponse" } } } }, "409": { "description": "ResourceNotFoundException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundException" } } } }, "480": { "description": "BaseException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/BaseException" } } } }, "500": { "description": "InternalException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/InternalException" } } } } }, "parameters": [ { "name": "DomainName", "in": "query", "required": true, "description": "", "schema": { "type": "string", "pattern": "[a-z][a-z0-9\\-]+", "description": "A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.", "minLength": 3, "maxLength": 28 } }, { "name": "RankExpression", "in": "query", "required": true, "description": "", "schema": { "type": "object", "required": [ "RankName", "RankExpression" ], "properties": { "RankName": { "allOf": [ { "$ref": "#/components/schemas/FieldName" }, { "description": "The name of a rank expression. Rank expression names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Uppercase letters and hyphens are not allowed. The names \"body\", \"docid\", and \"text_relevance\" are reserved and cannot be specified as field or rank expression names." } ] }, "RankExpression": { "allOf": [ { "$ref": "#/components/schemas/RankExpression" }, { "description": "

The expression to evaluate for ranking or thresholding while processing a search request. The RankExpression syntax is based on JavaScript expressions and supports:

Intermediate results are calculated as double precision floating point values. The final return value of a RankExpression is automatically converted from floating point to a 32-bit unsigned integer by rounding to the nearest integer, with a natural floor of 0 and a ceiling of max(uint32_t), 4294967295. Mathematical errors such as dividing by 0 will fail during evaluation and return a value of 0.

The source data for a RankExpression can be the name of an IndexField of type uint, another RankExpression or the reserved name text_relevance. The text_relevance source is defined to return an integer from 0 to 1000 (inclusive) to indicate how relevant a document is to the search request, taking into account repetition of search terms in the document and proximity of search terms to each other in each matching IndexField in the document.

For more information about using rank expressions to customize ranking, see the Amazon CloudSearch Developer Guide.

" } ] } }, "description": "A named expression that can be evaluated at search time and used for ranking or thresholding in a search query. " } }, { "name": "Action", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "DefineRankExpression" ] } }, { "name": "Version", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "2011-02-01" ] } } ] }, "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": { "x-aws-operation-name": "DefineRankExpression", "operationId": "POST_DefineRankExpression", "description": "Configures a RankExpression for the search domain. Used to create new rank expressions and modify existing ones. If the expression exists, the new configuration replaces the old one. You can configure a maximum of 50 rank expressions.", "responses": { "200": { "description": "Success", "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/DefineRankExpressionResponse" } } } }, "409": { "description": "ResourceNotFoundException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundException" } } } }, "480": { "description": "BaseException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/BaseException" } } } }, "500": { "description": "InternalException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/InternalException" } } } } }, "requestBody": { "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/DefineRankExpressionRequest" } } } }, "parameters": [ { "name": "Action", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "DefineRankExpression" ] } }, { "name": "Version", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "2011-02-01" ] } } ] } }, "/#Action=DeleteDomain": { "get": { "x-aws-operation-name": "DeleteDomain", "operationId": "GET_DeleteDomain", "description": "Permanently deletes a search domain and all of its data.", "responses": { "200": { "description": "Success", "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/DeleteDomainResponse" } } } }, "480": { "description": "BaseException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/BaseException" } } } }, "500": { "description": "InternalException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/InternalException" } } } } }, "parameters": [ { "name": "DomainName", "in": "query", "required": true, "description": "", "schema": { "type": "string", "pattern": "[a-z][a-z0-9\\-]+", "description": "A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.", "minLength": 3, "maxLength": 28 } }, { "name": "Action", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "DeleteDomain" ] } }, { "name": "Version", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "2011-02-01" ] } } ] }, "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": { "x-aws-operation-name": "DeleteDomain", "operationId": "POST_DeleteDomain", "description": "Permanently deletes a search domain and all of its data.", "responses": { "200": { "description": "Success", "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/DeleteDomainResponse" } } } }, "480": { "description": "BaseException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/BaseException" } } } }, "500": { "description": "InternalException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/InternalException" } } } } }, "requestBody": { "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/DeleteDomainRequest" } } } }, "parameters": [ { "name": "Action", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "DeleteDomain" ] } }, { "name": "Version", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "2011-02-01" ] } } ] } }, "/#Action=DeleteIndexField": { "get": { "x-aws-operation-name": "DeleteIndexField", "operationId": "GET_DeleteIndexField", "description": "Removes an IndexField from the search domain.", "responses": { "200": { "description": "Success", "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/DeleteIndexFieldResponse" } } } }, "409": { "description": "ResourceNotFoundException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundException" } } } }, "480": { "description": "BaseException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/BaseException" } } } }, "500": { "description": "InternalException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/InternalException" } } } } }, "parameters": [ { "name": "DomainName", "in": "query", "required": true, "description": "", "schema": { "type": "string", "pattern": "[a-z][a-z0-9\\-]+", "description": "A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.", "minLength": 3, "maxLength": 28 } }, { "name": "IndexFieldName", "in": "query", "required": true, "description": "", "schema": { "type": "string", "pattern": "[a-z][a-z0-9_]*", "description": "A string that represents the name of an index field. Field names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Uppercase letters and hyphens are not allowed. The names \"body\", \"docid\", and \"text_relevance\" are reserved and cannot be specified as field or rank expression names.", "minLength": 1, "maxLength": 64 } }, { "name": "Action", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "DeleteIndexField" ] } }, { "name": "Version", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "2011-02-01" ] } } ] }, "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": { "x-aws-operation-name": "DeleteIndexField", "operationId": "POST_DeleteIndexField", "description": "Removes an IndexField from the search domain.", "responses": { "200": { "description": "Success", "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/DeleteIndexFieldResponse" } } } }, "409": { "description": "ResourceNotFoundException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundException" } } } }, "480": { "description": "BaseException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/BaseException" } } } }, "500": { "description": "InternalException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/InternalException" } } } } }, "requestBody": { "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/DeleteIndexFieldRequest" } } } }, "parameters": [ { "name": "Action", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "DeleteIndexField" ] } }, { "name": "Version", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "2011-02-01" ] } } ] } }, "/#Action=DeleteRankExpression": { "get": { "x-aws-operation-name": "DeleteRankExpression", "operationId": "GET_DeleteRankExpression", "description": "Removes a RankExpression from the search domain.", "responses": { "200": { "description": "Success", "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/DeleteRankExpressionResponse" } } } }, "409": { "description": "ResourceNotFoundException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundException" } } } }, "480": { "description": "BaseException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/BaseException" } } } }, "500": { "description": "InternalException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/InternalException" } } } } }, "parameters": [ { "name": "DomainName", "in": "query", "required": true, "description": "", "schema": { "type": "string", "pattern": "[a-z][a-z0-9\\-]+", "description": "A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.", "minLength": 3, "maxLength": 28 } }, { "name": "RankName", "in": "query", "required": true, "description": "The name of the RankExpression to delete.", "schema": { "type": "string", "pattern": "[a-z][a-z0-9_]*", "description": "A string that represents the name of an index field. Field names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Uppercase letters and hyphens are not allowed. The names \"body\", \"docid\", and \"text_relevance\" are reserved and cannot be specified as field or rank expression names.", "minLength": 1, "maxLength": 64 } }, { "name": "Action", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "DeleteRankExpression" ] } }, { "name": "Version", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "2011-02-01" ] } } ] }, "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": { "x-aws-operation-name": "DeleteRankExpression", "operationId": "POST_DeleteRankExpression", "description": "Removes a RankExpression from the search domain.", "responses": { "200": { "description": "Success", "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/DeleteRankExpressionResponse" } } } }, "409": { "description": "ResourceNotFoundException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundException" } } } }, "480": { "description": "BaseException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/BaseException" } } } }, "500": { "description": "InternalException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/InternalException" } } } } }, "requestBody": { "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/DeleteRankExpressionRequest" } } } }, "parameters": [ { "name": "Action", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "DeleteRankExpression" ] } }, { "name": "Version", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "2011-02-01" ] } } ] } }, "/#Action=DescribeAvailabilityOptions": { "get": { "x-aws-operation-name": "DescribeAvailabilityOptions", "operationId": "GET_DescribeAvailabilityOptions", "description": "Gets the availability options configured for a domain. By default, shows the configuration with any pending changes. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Availability Options in the Amazon CloudSearch Developer Guide.", "responses": { "200": { "description": "Success", "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/DescribeAvailabilityOptionsResponse" } } } }, "409": { "description": "DisabledOperationException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/DisabledOperationException" } } } }, "480": { "description": "BaseException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/BaseException" } } } }, "500": { "description": "InternalException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/InternalException" } } } } }, "parameters": [ { "name": "DomainName", "in": "query", "required": true, "description": "The name of the domain you want to describe.", "schema": { "type": "string", "pattern": "[a-z][a-z0-9\\-]+", "description": "A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.", "minLength": 3, "maxLength": 28 } }, { "name": "Action", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "DescribeAvailabilityOptions" ] } }, { "name": "Version", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "2011-02-01" ] } } ] }, "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": { "x-aws-operation-name": "DescribeAvailabilityOptions", "operationId": "POST_DescribeAvailabilityOptions", "description": "Gets the availability options configured for a domain. By default, shows the configuration with any pending changes. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Availability Options in the Amazon CloudSearch Developer Guide.", "responses": { "200": { "description": "Success", "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/DescribeAvailabilityOptionsResponse" } } } }, "409": { "description": "DisabledOperationException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/DisabledOperationException" } } } }, "480": { "description": "BaseException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/BaseException" } } } }, "500": { "description": "InternalException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/InternalException" } } } } }, "requestBody": { "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/DescribeAvailabilityOptionsRequest" } } } }, "parameters": [ { "name": "Action", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "DescribeAvailabilityOptions" ] } }, { "name": "Version", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "2011-02-01" ] } } ] } }, "/#Action=DescribeDefaultSearchField": { "get": { "x-aws-operation-name": "DescribeDefaultSearchField", "operationId": "GET_DescribeDefaultSearchField", "description": "Gets the default search field configured for the search domain.", "responses": { "200": { "description": "Success", "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/DescribeDefaultSearchFieldResponse" } } } }, "409": { "description": "ResourceNotFoundException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundException" } } } }, "480": { "description": "BaseException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/BaseException" } } } }, "500": { "description": "InternalException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/InternalException" } } } } }, "parameters": [ { "name": "DomainName", "in": "query", "required": true, "description": "", "schema": { "type": "string", "pattern": "[a-z][a-z0-9\\-]+", "description": "A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.", "minLength": 3, "maxLength": 28 } }, { "name": "Action", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "DescribeDefaultSearchField" ] } }, { "name": "Version", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "2011-02-01" ] } } ] }, "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": { "x-aws-operation-name": "DescribeDefaultSearchField", "operationId": "POST_DescribeDefaultSearchField", "description": "Gets the default search field configured for the search domain.", "responses": { "200": { "description": "Success", "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/DescribeDefaultSearchFieldResponse" } } } }, "409": { "description": "ResourceNotFoundException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundException" } } } }, "480": { "description": "BaseException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/BaseException" } } } }, "500": { "description": "InternalException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/InternalException" } } } } }, "requestBody": { "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/DescribeDefaultSearchFieldRequest" } } } }, "parameters": [ { "name": "Action", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "DescribeDefaultSearchField" ] } }, { "name": "Version", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "2011-02-01" ] } } ] } }, "/#Action=DescribeDomains": { "get": { "x-aws-operation-name": "DescribeDomains", "operationId": "GET_DescribeDomains", "description": "Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default.", "responses": { "200": { "description": "Success", "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/DescribeDomainsResponse" } } } }, "480": { "description": "BaseException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/BaseException" } } } }, "500": { "description": "InternalException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/InternalException" } } } } }, "parameters": [ { "name": "DomainNames", "in": "query", "required": false, "description": "Limits the DescribeDomains response to the specified search domains.", "schema": { "type": "array", "description": "A list of domain names.", "items": { "$ref": "#/components/schemas/DomainName" } } }, { "name": "Action", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "DescribeDomains" ] } }, { "name": "Version", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "2011-02-01" ] } } ] }, "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": { "x-aws-operation-name": "DescribeDomains", "operationId": "POST_DescribeDomains", "description": "Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default.", "responses": { "200": { "description": "Success", "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/DescribeDomainsResponse" } } } }, "480": { "description": "BaseException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/BaseException" } } } }, "500": { "description": "InternalException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/InternalException" } } } } }, "requestBody": { "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/DescribeDomainsRequest" } } } }, "parameters": [ { "name": "Action", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "DescribeDomains" ] } }, { "name": "Version", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "2011-02-01" ] } } ] } }, "/#Action=DescribeIndexFields": { "get": { "x-aws-operation-name": "DescribeIndexFields", "operationId": "GET_DescribeIndexFields", "description": "Gets information about the index fields configured for the search domain. Can be limited to specific fields by name. Shows all fields by default.", "responses": { "200": { "description": "Success", "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/DescribeIndexFieldsResponse" } } } }, "409": { "description": "ResourceNotFoundException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundException" } } } }, "480": { "description": "BaseException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/BaseException" } } } }, "500": { "description": "InternalException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/InternalException" } } } } }, "parameters": [ { "name": "DomainName", "in": "query", "required": true, "description": "", "schema": { "type": "string", "pattern": "[a-z][a-z0-9\\-]+", "description": "A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.", "minLength": 3, "maxLength": 28 } }, { "name": "FieldNames", "in": "query", "required": false, "description": "Limits the DescribeIndexFields response to the specified fields.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FieldName" } } }, { "name": "Action", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "DescribeIndexFields" ] } }, { "name": "Version", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "2011-02-01" ] } } ] }, "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": { "x-aws-operation-name": "DescribeIndexFields", "operationId": "POST_DescribeIndexFields", "description": "Gets information about the index fields configured for the search domain. Can be limited to specific fields by name. Shows all fields by default.", "responses": { "200": { "description": "Success", "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/DescribeIndexFieldsResponse" } } } }, "409": { "description": "ResourceNotFoundException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundException" } } } }, "480": { "description": "BaseException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/BaseException" } } } }, "500": { "description": "InternalException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/InternalException" } } } } }, "requestBody": { "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/DescribeIndexFieldsRequest" } } } }, "parameters": [ { "name": "Action", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "DescribeIndexFields" ] } }, { "name": "Version", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "2011-02-01" ] } } ] } }, "/#Action=DescribeRankExpressions": { "get": { "x-aws-operation-name": "DescribeRankExpressions", "operationId": "GET_DescribeRankExpressions", "description": "Gets the rank expressions configured for the search domain. Can be limited to specific rank expressions by name. Shows all rank expressions by default. ", "responses": { "200": { "description": "Success", "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/DescribeRankExpressionsResponse" } } } }, "409": { "description": "ResourceNotFoundException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundException" } } } }, "480": { "description": "BaseException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/BaseException" } } } }, "500": { "description": "InternalException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/InternalException" } } } } }, "parameters": [ { "name": "DomainName", "in": "query", "required": true, "description": "", "schema": { "type": "string", "pattern": "[a-z][a-z0-9\\-]+", "description": "A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.", "minLength": 3, "maxLength": 28 } }, { "name": "RankNames", "in": "query", "required": false, "description": "Limits the DescribeRankExpressions response to the specified fields.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FieldName" } } }, { "name": "Action", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "DescribeRankExpressions" ] } }, { "name": "Version", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "2011-02-01" ] } } ] }, "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": { "x-aws-operation-name": "DescribeRankExpressions", "operationId": "POST_DescribeRankExpressions", "description": "Gets the rank expressions configured for the search domain. Can be limited to specific rank expressions by name. Shows all rank expressions by default. ", "responses": { "200": { "description": "Success", "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/DescribeRankExpressionsResponse" } } } }, "409": { "description": "ResourceNotFoundException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundException" } } } }, "480": { "description": "BaseException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/BaseException" } } } }, "500": { "description": "InternalException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/InternalException" } } } } }, "requestBody": { "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/DescribeRankExpressionsRequest" } } } }, "parameters": [ { "name": "Action", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "DescribeRankExpressions" ] } }, { "name": "Version", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "2011-02-01" ] } } ] } }, "/#Action=DescribeServiceAccessPolicies": { "get": { "x-aws-operation-name": "DescribeServiceAccessPolicies", "operationId": "GET_DescribeServiceAccessPolicies", "description": "Gets information about the resource-based policies that control access to the domain's document and search services.", "responses": { "200": { "description": "Success", "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/DescribeServiceAccessPoliciesResponse" } } } }, "409": { "description": "ResourceNotFoundException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundException" } } } }, "480": { "description": "BaseException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/BaseException" } } } }, "500": { "description": "InternalException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/InternalException" } } } } }, "parameters": [ { "name": "DomainName", "in": "query", "required": true, "description": "", "schema": { "type": "string", "pattern": "[a-z][a-z0-9\\-]+", "description": "A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.", "minLength": 3, "maxLength": 28 } }, { "name": "Action", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "DescribeServiceAccessPolicies" ] } }, { "name": "Version", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "2011-02-01" ] } } ] }, "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": { "x-aws-operation-name": "DescribeServiceAccessPolicies", "operationId": "POST_DescribeServiceAccessPolicies", "description": "Gets information about the resource-based policies that control access to the domain's document and search services.", "responses": { "200": { "description": "Success", "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/DescribeServiceAccessPoliciesResponse" } } } }, "409": { "description": "ResourceNotFoundException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundException" } } } }, "480": { "description": "BaseException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/BaseException" } } } }, "500": { "description": "InternalException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/InternalException" } } } } }, "requestBody": { "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/DescribeServiceAccessPoliciesRequest" } } } }, "parameters": [ { "name": "Action", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "DescribeServiceAccessPolicies" ] } }, { "name": "Version", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "2011-02-01" ] } } ] } }, "/#Action=DescribeStemmingOptions": { "get": { "x-aws-operation-name": "DescribeStemmingOptions", "operationId": "GET_DescribeStemmingOptions", "description": "Gets the stemming dictionary configured for the search domain.", "responses": { "200": { "description": "Success", "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/DescribeStemmingOptionsResponse" } } } }, "409": { "description": "ResourceNotFoundException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundException" } } } }, "480": { "description": "BaseException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/BaseException" } } } }, "500": { "description": "InternalException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/InternalException" } } } } }, "parameters": [ { "name": "DomainName", "in": "query", "required": true, "description": "", "schema": { "type": "string", "pattern": "[a-z][a-z0-9\\-]+", "description": "A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.", "minLength": 3, "maxLength": 28 } }, { "name": "Action", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "DescribeStemmingOptions" ] } }, { "name": "Version", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "2011-02-01" ] } } ] }, "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": { "x-aws-operation-name": "DescribeStemmingOptions", "operationId": "POST_DescribeStemmingOptions", "description": "Gets the stemming dictionary configured for the search domain.", "responses": { "200": { "description": "Success", "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/DescribeStemmingOptionsResponse" } } } }, "409": { "description": "ResourceNotFoundException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundException" } } } }, "480": { "description": "BaseException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/BaseException" } } } }, "500": { "description": "InternalException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/InternalException" } } } } }, "requestBody": { "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/DescribeStemmingOptionsRequest" } } } }, "parameters": [ { "name": "Action", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "DescribeStemmingOptions" ] } }, { "name": "Version", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "2011-02-01" ] } } ] } }, "/#Action=DescribeStopwordOptions": { "get": { "x-aws-operation-name": "DescribeStopwordOptions", "operationId": "GET_DescribeStopwordOptions", "description": "Gets the stopwords configured for the search domain.", "responses": { "200": { "description": "Success", "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/DescribeStopwordOptionsResponse" } } } }, "409": { "description": "ResourceNotFoundException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundException" } } } }, "480": { "description": "BaseException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/BaseException" } } } }, "500": { "description": "InternalException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/InternalException" } } } } }, "parameters": [ { "name": "DomainName", "in": "query", "required": true, "description": "", "schema": { "type": "string", "pattern": "[a-z][a-z0-9\\-]+", "description": "A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.", "minLength": 3, "maxLength": 28 } }, { "name": "Action", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "DescribeStopwordOptions" ] } }, { "name": "Version", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "2011-02-01" ] } } ] }, "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": { "x-aws-operation-name": "DescribeStopwordOptions", "operationId": "POST_DescribeStopwordOptions", "description": "Gets the stopwords configured for the search domain.", "responses": { "200": { "description": "Success", "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/DescribeStopwordOptionsResponse" } } } }, "409": { "description": "ResourceNotFoundException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundException" } } } }, "480": { "description": "BaseException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/BaseException" } } } }, "500": { "description": "InternalException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/InternalException" } } } } }, "requestBody": { "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/DescribeStopwordOptionsRequest" } } } }, "parameters": [ { "name": "Action", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "DescribeStopwordOptions" ] } }, { "name": "Version", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "2011-02-01" ] } } ] } }, "/#Action=DescribeSynonymOptions": { "get": { "x-aws-operation-name": "DescribeSynonymOptions", "operationId": "GET_DescribeSynonymOptions", "description": "Gets the synonym dictionary configured for the search domain.", "responses": { "200": { "description": "Success", "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/DescribeSynonymOptionsResponse" } } } }, "409": { "description": "ResourceNotFoundException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundException" } } } }, "480": { "description": "BaseException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/BaseException" } } } }, "500": { "description": "InternalException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/InternalException" } } } } }, "parameters": [ { "name": "DomainName", "in": "query", "required": true, "description": "", "schema": { "type": "string", "pattern": "[a-z][a-z0-9\\-]+", "description": "A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.", "minLength": 3, "maxLength": 28 } }, { "name": "Action", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "DescribeSynonymOptions" ] } }, { "name": "Version", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "2011-02-01" ] } } ] }, "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": { "x-aws-operation-name": "DescribeSynonymOptions", "operationId": "POST_DescribeSynonymOptions", "description": "Gets the synonym dictionary configured for the search domain.", "responses": { "200": { "description": "Success", "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/DescribeSynonymOptionsResponse" } } } }, "409": { "description": "ResourceNotFoundException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundException" } } } }, "480": { "description": "BaseException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/BaseException" } } } }, "500": { "description": "InternalException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/InternalException" } } } } }, "requestBody": { "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/DescribeSynonymOptionsRequest" } } } }, "parameters": [ { "name": "Action", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "DescribeSynonymOptions" ] } }, { "name": "Version", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "2011-02-01" ] } } ] } }, "/#Action=IndexDocuments": { "get": { "x-aws-operation-name": "IndexDocuments", "operationId": "GET_IndexDocuments", "description": "Tells the search domain to start indexing its documents using the latest text processing options and IndexFields. This operation must be invoked to make options whose OptionStatus has OptionState of RequiresIndexDocuments visible in search results.", "responses": { "200": { "description": "Success", "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/IndexDocumentsResponse" } } } }, "409": { "description": "ResourceNotFoundException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundException" } } } }, "480": { "description": "BaseException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/BaseException" } } } }, "500": { "description": "InternalException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/InternalException" } } } } }, "parameters": [ { "name": "DomainName", "in": "query", "required": true, "description": "", "schema": { "type": "string", "pattern": "[a-z][a-z0-9\\-]+", "description": "A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.", "minLength": 3, "maxLength": 28 } }, { "name": "Action", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "IndexDocuments" ] } }, { "name": "Version", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "2011-02-01" ] } } ] }, "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": { "x-aws-operation-name": "IndexDocuments", "operationId": "POST_IndexDocuments", "description": "Tells the search domain to start indexing its documents using the latest text processing options and IndexFields. This operation must be invoked to make options whose OptionStatus has OptionState of RequiresIndexDocuments visible in search results.", "responses": { "200": { "description": "Success", "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/IndexDocumentsResponse" } } } }, "409": { "description": "ResourceNotFoundException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundException" } } } }, "480": { "description": "BaseException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/BaseException" } } } }, "500": { "description": "InternalException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/InternalException" } } } } }, "requestBody": { "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/IndexDocumentsRequest" } } } }, "parameters": [ { "name": "Action", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "IndexDocuments" ] } }, { "name": "Version", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "2011-02-01" ] } } ] } }, "/#Action=UpdateAvailabilityOptions": { "get": { "x-aws-operation-name": "UpdateAvailabilityOptions", "operationId": "GET_UpdateAvailabilityOptions", "description": "Configures the availability options for a domain. Enabling the Multi-AZ option expands an Amazon CloudSearch domain to an additional Availability Zone in the same Region to increase fault tolerance in the event of a service disruption. Changes to the Multi-AZ option can take about half an hour to become active. For more information, see Configuring Availability Options in the Amazon CloudSearch Developer Guide.", "responses": { "200": { "description": "Success", "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/UpdateAvailabilityOptionsResponse" } } } }, "409": { "description": "DisabledOperationException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/DisabledOperationException" } } } }, "480": { "description": "BaseException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/BaseException" } } } }, "500": { "description": "InternalException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/InternalException" } } } } }, "parameters": [ { "name": "DomainName", "in": "query", "required": true, "description": "", "schema": { "type": "string", "pattern": "[a-z][a-z0-9\\-]+", "description": "A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.", "minLength": 3, "maxLength": 28 } }, { "name": "MultiAZ", "in": "query", "required": true, "description": "You expand an existing search domain to a second Availability Zone by setting the Multi-AZ option to true. Similarly, you can turn off the Multi-AZ option to downgrade the domain to a single Availability Zone by setting the Multi-AZ option to false. ", "schema": { "type": "boolean" } }, { "name": "Action", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "UpdateAvailabilityOptions" ] } }, { "name": "Version", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "2011-02-01" ] } } ] }, "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": { "x-aws-operation-name": "UpdateAvailabilityOptions", "operationId": "POST_UpdateAvailabilityOptions", "description": "Configures the availability options for a domain. Enabling the Multi-AZ option expands an Amazon CloudSearch domain to an additional Availability Zone in the same Region to increase fault tolerance in the event of a service disruption. Changes to the Multi-AZ option can take about half an hour to become active. For more information, see Configuring Availability Options in the Amazon CloudSearch Developer Guide.", "responses": { "200": { "description": "Success", "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/UpdateAvailabilityOptionsResponse" } } } }, "409": { "description": "DisabledOperationException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/DisabledOperationException" } } } }, "480": { "description": "BaseException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/BaseException" } } } }, "500": { "description": "InternalException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/InternalException" } } } } }, "requestBody": { "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/UpdateAvailabilityOptionsRequest" } } } }, "parameters": [ { "name": "Action", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "UpdateAvailabilityOptions" ] } }, { "name": "Version", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "2011-02-01" ] } } ] } }, "/#Action=UpdateDefaultSearchField": { "get": { "x-aws-operation-name": "UpdateDefaultSearchField", "operationId": "GET_UpdateDefaultSearchField", "description": "Configures the default search field for the search domain. The default search field is the text field that is searched when a search request does not specify which fields to search. By default, it is configured to include the contents of all of the domain's text fields. ", "responses": { "200": { "description": "Success", "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/UpdateDefaultSearchFieldResponse" } } } }, "409": { "description": "ResourceNotFoundException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundException" } } } }, "480": { "description": "BaseException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/BaseException" } } } }, "500": { "description": "InternalException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/InternalException" } } } } }, "parameters": [ { "name": "DomainName", "in": "query", "required": true, "description": "", "schema": { "type": "string", "pattern": "[a-z][a-z0-9\\-]+", "description": "A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.", "minLength": 3, "maxLength": 28 } }, { "name": "DefaultSearchField", "in": "query", "required": true, "description": "The text field to search if the search request does not specify which field to search. The default search field is used when search terms are specified with the q parameter, or if a match expression specified with the bq parameter does not constrain the search to a particular field. The default is an empty string, which automatically searches all text fields.", "schema": { "type": "string" } }, { "name": "Action", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "UpdateDefaultSearchField" ] } }, { "name": "Version", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "2011-02-01" ] } } ] }, "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": { "x-aws-operation-name": "UpdateDefaultSearchField", "operationId": "POST_UpdateDefaultSearchField", "description": "Configures the default search field for the search domain. The default search field is the text field that is searched when a search request does not specify which fields to search. By default, it is configured to include the contents of all of the domain's text fields. ", "responses": { "200": { "description": "Success", "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/UpdateDefaultSearchFieldResponse" } } } }, "409": { "description": "ResourceNotFoundException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundException" } } } }, "480": { "description": "BaseException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/BaseException" } } } }, "500": { "description": "InternalException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/InternalException" } } } } }, "requestBody": { "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/UpdateDefaultSearchFieldRequest" } } } }, "parameters": [ { "name": "Action", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "UpdateDefaultSearchField" ] } }, { "name": "Version", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "2011-02-01" ] } } ] } }, "/#Action=UpdateServiceAccessPolicies": { "get": { "x-aws-operation-name": "UpdateServiceAccessPolicies", "operationId": "GET_UpdateServiceAccessPolicies", "description": "Configures the policies that control access to the domain's document and search services. The maximum size of an access policy document is 100 KB.", "responses": { "200": { "description": "Success", "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/UpdateServiceAccessPoliciesResponse" } } } }, "409": { "description": "InvalidTypeException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/InvalidTypeException" } } } }, "480": { "description": "BaseException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/BaseException" } } } }, "500": { "description": "InternalException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/InternalException" } } } } }, "parameters": [ { "name": "DomainName", "in": "query", "required": true, "description": "", "schema": { "type": "string", "pattern": "[a-z][a-z0-9\\-]+", "description": "A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.", "minLength": 3, "maxLength": 28 } }, { "name": "AccessPolicies", "in": "query", "required": true, "description": "", "schema": { "type": "string", "description": "

An IAM access policy as described in The Access Policy Language in Using AWS Identity and Access Management. The maximum size of an access policy document is 100 KB.

Example: {\"Statement\": [{\"Effect\":\"Allow\", \"Action\": \"*\", \"Resource\": \"arn:aws:cs:us-east-1:1234567890:search/movies\", \"Condition\": { \"IpAddress\": { \"aws:SourceIp\": [\"203.0.113.1/32\"] } }}, {\"Effect\":\"Allow\", \"Action\": \"*\", \"Resource\": \"arn:aws:cs:us-east-1:1234567890:documents/movies\", \"Condition\": { \"IpAddress\": { \"aws:SourceIp\": [\"203.0.113.1/32\"] } }} ] }

" } }, { "name": "Action", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "UpdateServiceAccessPolicies" ] } }, { "name": "Version", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "2011-02-01" ] } } ] }, "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": { "x-aws-operation-name": "UpdateServiceAccessPolicies", "operationId": "POST_UpdateServiceAccessPolicies", "description": "Configures the policies that control access to the domain's document and search services. The maximum size of an access policy document is 100 KB.", "responses": { "200": { "description": "Success", "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/UpdateServiceAccessPoliciesResponse" } } } }, "409": { "description": "InvalidTypeException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/InvalidTypeException" } } } }, "480": { "description": "BaseException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/BaseException" } } } }, "500": { "description": "InternalException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/InternalException" } } } } }, "requestBody": { "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/UpdateServiceAccessPoliciesRequest" } } } }, "parameters": [ { "name": "Action", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "UpdateServiceAccessPolicies" ] } }, { "name": "Version", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "2011-02-01" ] } } ] } }, "/#Action=UpdateStemmingOptions": { "get": { "x-aws-operation-name": "UpdateStemmingOptions", "operationId": "GET_UpdateStemmingOptions", "description": "Configures a stemming dictionary for the search domain. The stemming dictionary is used during indexing and when processing search requests. The maximum size of the stemming dictionary is 500 KB.", "responses": { "200": { "description": "Success", "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/UpdateStemmingOptionsResponse" } } } }, "409": { "description": "ResourceNotFoundException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundException" } } } }, "480": { "description": "BaseException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/BaseException" } } } }, "500": { "description": "InternalException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/InternalException" } } } } }, "parameters": [ { "name": "DomainName", "in": "query", "required": true, "description": "", "schema": { "type": "string", "pattern": "[a-z][a-z0-9\\-]+", "description": "A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.", "minLength": 3, "maxLength": 28 } }, { "name": "Stems", "in": "query", "required": true, "description": "", "schema": { "type": "string", "description": "Maps terms to their stems, serialized as a JSON document. The document has a single object with one property \"stems\" whose value is an object mapping terms to their stems. The maximum size of a stemming document is 500 KB. Example: { \"stems\": {\"people\": \"person\", \"walking\": \"walk\"} }" } }, { "name": "Action", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "UpdateStemmingOptions" ] } }, { "name": "Version", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "2011-02-01" ] } } ] }, "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": { "x-aws-operation-name": "UpdateStemmingOptions", "operationId": "POST_UpdateStemmingOptions", "description": "Configures a stemming dictionary for the search domain. The stemming dictionary is used during indexing and when processing search requests. The maximum size of the stemming dictionary is 500 KB.", "responses": { "200": { "description": "Success", "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/UpdateStemmingOptionsResponse" } } } }, "409": { "description": "ResourceNotFoundException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundException" } } } }, "480": { "description": "BaseException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/BaseException" } } } }, "500": { "description": "InternalException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/InternalException" } } } } }, "requestBody": { "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/UpdateStemmingOptionsRequest" } } } }, "parameters": [ { "name": "Action", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "UpdateStemmingOptions" ] } }, { "name": "Version", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "2011-02-01" ] } } ] } }, "/#Action=UpdateStopwordOptions": { "get": { "x-aws-operation-name": "UpdateStopwordOptions", "operationId": "GET_UpdateStopwordOptions", "description": "Configures stopwords for the search domain. Stopwords are used during indexing and when processing search requests. The maximum size of the stopwords dictionary is 10 KB.", "responses": { "200": { "description": "Success", "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/UpdateStopwordOptionsResponse" } } } }, "409": { "description": "ResourceNotFoundException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundException" } } } }, "480": { "description": "BaseException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/BaseException" } } } }, "500": { "description": "InternalException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/InternalException" } } } } }, "parameters": [ { "name": "DomainName", "in": "query", "required": true, "description": "", "schema": { "type": "string", "pattern": "[a-z][a-z0-9\\-]+", "description": "A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.", "minLength": 3, "maxLength": 28 } }, { "name": "Stopwords", "in": "query", "required": true, "description": "", "schema": { "type": "string", "description": "Lists stopwords serialized as a JSON document. The document has a single object with one property \"stopwords\" whose value is an array of strings. The maximum size of a stopwords document is 10 KB. Example: { \"stopwords\": [\"a\", \"an\", \"the\", \"of\"] }" } }, { "name": "Action", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "UpdateStopwordOptions" ] } }, { "name": "Version", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "2011-02-01" ] } } ] }, "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": { "x-aws-operation-name": "UpdateStopwordOptions", "operationId": "POST_UpdateStopwordOptions", "description": "Configures stopwords for the search domain. Stopwords are used during indexing and when processing search requests. The maximum size of the stopwords dictionary is 10 KB.", "responses": { "200": { "description": "Success", "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/UpdateStopwordOptionsResponse" } } } }, "409": { "description": "ResourceNotFoundException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundException" } } } }, "480": { "description": "BaseException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/BaseException" } } } }, "500": { "description": "InternalException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/InternalException" } } } } }, "requestBody": { "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/UpdateStopwordOptionsRequest" } } } }, "parameters": [ { "name": "Action", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "UpdateStopwordOptions" ] } }, { "name": "Version", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "2011-02-01" ] } } ] } }, "/#Action=UpdateSynonymOptions": { "get": { "x-aws-operation-name": "UpdateSynonymOptions", "operationId": "GET_UpdateSynonymOptions", "description": "Configures a synonym dictionary for the search domain. The synonym dictionary is used during indexing to configure mappings for terms that occur in text fields. The maximum size of the synonym dictionary is 100 KB. ", "responses": { "200": { "description": "Success", "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/UpdateSynonymOptionsResponse" } } } }, "409": { "description": "ResourceNotFoundException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundException" } } } }, "480": { "description": "BaseException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/BaseException" } } } }, "500": { "description": "InternalException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/InternalException" } } } } }, "parameters": [ { "name": "DomainName", "in": "query", "required": true, "description": "", "schema": { "type": "string", "pattern": "[a-z][a-z0-9\\-]+", "description": "A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.", "minLength": 3, "maxLength": 28 } }, { "name": "Synonyms", "in": "query", "required": true, "description": "", "schema": { "type": "string", "description": "Maps terms to their synonyms, serialized as a JSON document. The document has a single object with one property \"synonyms\" whose value is an object mapping terms to their synonyms. Each synonym is a simple string or an array of strings. The maximum size of a stopwords document is 100 KB. Example: { \"synonyms\": {\"cat\": [\"feline\", \"kitten\"], \"puppy\": \"dog\"} }" } }, { "name": "Action", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "UpdateSynonymOptions" ] } }, { "name": "Version", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "2011-02-01" ] } } ] }, "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": { "x-aws-operation-name": "UpdateSynonymOptions", "operationId": "POST_UpdateSynonymOptions", "description": "Configures a synonym dictionary for the search domain. The synonym dictionary is used during indexing to configure mappings for terms that occur in text fields. The maximum size of the synonym dictionary is 100 KB. ", "responses": { "200": { "description": "Success", "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/UpdateSynonymOptionsResponse" } } } }, "409": { "description": "ResourceNotFoundException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundException" } } } }, "480": { "description": "BaseException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/BaseException" } } } }, "500": { "description": "InternalException", "x-aws-exception": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/InternalException" } } } } }, "requestBody": { "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/UpdateSynonymOptionsRequest" } } } }, "parameters": [ { "name": "Action", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "UpdateSynonymOptions" ] } }, { "name": "Version", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "2011-02-01" ] } } ] } } }, "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": { "CreateDomainResponse": { "type": "object", "properties": { "DomainStatus": { "$ref": "#/components/schemas/DomainStatus" } }, "description": "A response message that contains the status of a newly created domain." }, "BaseException": { "type": "object", "properties": { "Code": { "$ref": "#/components/schemas/ErrorCode" }, "Message": { "$ref": "#/components/schemas/ErrorMessage" } }, "description": "An error occurred while processing the request." }, "InternalException": { "type": "object", "properties": {}, "description": "An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard." }, "LimitExceededException": { "type": "object", "properties": {}, "description": "The request was rejected because a resource limit has already been met." }, "DefineIndexFieldResponse": { "type": "object", "required": [ "IndexField" ], "properties": { "IndexField": { "$ref": "#/components/schemas/IndexFieldStatus" } }, "description": "A response message that contains the status of an updated index field." }, "FieldName": { "type": "string", "pattern": "[a-z][a-z0-9_]*", "description": "A string that represents the name of an index field. Field names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Uppercase letters and hyphens are not allowed. The names \"body\", \"docid\", and \"text_relevance\" are reserved and cannot be specified as field or rank expression names.", "minLength": 1, "maxLength": 64 }, "IndexFieldType": { "type": "string", "enum": [ "uint", "literal", "text" ], "description": "The type of IndexField." }, "UIntOptions": { "type": "object", "properties": { "DefaultValue": { "allOf": [ { "$ref": "#/components/schemas/UIntValue" }, { "description": "The default value for an unsigned integer field. Optional." } ] } }, "description": "Options that define a uint field in the search index." }, "LiteralOptions": { "type": "object", "properties": { "DefaultValue": { "allOf": [ { "$ref": "#/components/schemas/FieldValue" }, { "description": "The default value for a literal field. Optional." } ] }, "SearchEnabled": { "allOf": [ { "$ref": "#/components/schemas/Boolean" }, { "description": "Specifies whether search is enabled for this field. Default: False." } ] }, "FacetEnabled": { "allOf": [ { "$ref": "#/components/schemas/Boolean" }, { "description": "Specifies whether facets are enabled for this field. Default: False." } ] }, "ResultEnabled": { "allOf": [ { "$ref": "#/components/schemas/Boolean" }, { "description": "Specifies whether values of this field can be returned in search results and used for ranking. Default: False." } ] } }, "description": "Options that define a literal field in the search index." }, "TextOptions": { "type": "object", "properties": { "DefaultValue": { "allOf": [ { "$ref": "#/components/schemas/FieldValue" }, { "description": "The default value for a text field. Optional." } ] }, "FacetEnabled": { "allOf": [ { "$ref": "#/components/schemas/Boolean" }, { "description": "Specifies whether facets are enabled for this field. Default: False." } ] }, "ResultEnabled": { "allOf": [ { "$ref": "#/components/schemas/Boolean" }, { "description": "Specifies whether values of this field can be returned in search results and used for ranking. Default: False." } ] }, "TextProcessor": { "allOf": [ { "$ref": "#/components/schemas/FieldName" }, { "description": "

The text processor to apply to this field. Optional. Possible values:

Default: none

" } ] } }, "description": "Options that define a text field in the search index." }, "SourceAttributeList": { "type": "array", "items": { "$ref": "#/components/schemas/SourceAttribute" } }, "InvalidTypeException": { "type": "object", "properties": {}, "description": "The request was rejected because it specified an invalid type definition." }, "ResourceNotFoundException": { "type": "object", "properties": {}, "description": "The request was rejected because it attempted to reference a resource that does not exist." }, "DefineRankExpressionResponse": { "type": "object", "required": [ "RankExpression" ], "properties": { "RankExpression": { "$ref": "#/components/schemas/RankExpressionStatus" } }, "description": "A response message that contains the status of an updated RankExpression." }, "RankExpression": { "type": "string", "description": "The current status of the rank expression.", "minLength": 1, "maxLength": 10240 }, "DeleteDomainResponse": { "type": "object", "properties": { "DomainStatus": { "$ref": "#/components/schemas/DomainStatus" } }, "description": "A response message that contains the status of a newly deleted domain, or no status if the domain has already been completely deleted." }, "DeleteIndexFieldResponse": { "type": "object", "required": [ "IndexField" ], "properties": { "IndexField": { "$ref": "#/components/schemas/IndexFieldStatus" } }, "description": "A response message that contains the status of a deleted index field." }, "DeleteRankExpressionResponse": { "type": "object", "required": [ "RankExpression" ], "properties": { "RankExpression": { "$ref": "#/components/schemas/RankExpressionStatus" } }, "description": "A response message that contains the status of a deleted RankExpression." }, "DescribeAvailabilityOptionsResponse": { "type": "object", "properties": { "AvailabilityOptions": { "allOf": [ { "$ref": "#/components/schemas/AvailabilityOptionsStatus" }, { "description": "The availability options configured for the domain. Indicates whether Multi-AZ is enabled for the domain. " } ] } }, "description": "The result of a DescribeAvailabilityOptions request. Indicates whether or not the Multi-AZ option is enabled for the domain specified in the request. " }, "DisabledOperationException": { "type": "object", "properties": {}, "description": "The request was rejected because it attempted an operation which is not enabled." }, "DescribeDefaultSearchFieldResponse": { "type": "object", "required": [ "DefaultSearchField" ], "properties": { "DefaultSearchField": { "allOf": [ { "$ref": "#/components/schemas/DefaultSearchFieldStatus" }, { "description": "The name of the IndexField to use for search requests issued with the q parameter. The default is the empty string, which automatically searches all text fields." } ] } }, "description": "A response message that contains the default search field for a search domain." }, "DescribeDomainsResponse": { "type": "object", "required": [ "DomainStatusList" ], "properties": { "DomainStatusList": { "$ref": "#/components/schemas/DomainStatusList" } }, "description": "A response message that contains the status of one or more domains." }, "DomainName": { "type": "string", "pattern": "[a-z][a-z0-9\\-]+", "description": "A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.", "minLength": 3, "maxLength": 28 }, "DescribeIndexFieldsResponse": { "type": "object", "required": [ "IndexFields" ], "properties": { "IndexFields": { "allOf": [ { "$ref": "#/components/schemas/IndexFieldStatusList" }, { "description": "The index fields configured for the domain." } ] } }, "description": "A response message that contains the index fields for a search domain." }, "DescribeRankExpressionsResponse": { "type": "object", "required": [ "RankExpressions" ], "properties": { "RankExpressions": { "allOf": [ { "$ref": "#/components/schemas/RankExpressionStatusList" }, { "description": "The rank expressions configured for the domain." } ] } }, "description": "A response message that contains the rank expressions for a search domain." }, "DescribeServiceAccessPoliciesResponse": { "type": "object", "required": [ "AccessPolicies" ], "properties": { "AccessPolicies": { "$ref": "#/components/schemas/AccessPoliciesStatus" } }, "description": "A response message that contains the access policies for a domain." }, "DescribeStemmingOptionsResponse": { "type": "object", "required": [ "Stems" ], "properties": { "Stems": { "$ref": "#/components/schemas/StemmingOptionsStatus" } }, "description": "A response message that contains the stemming options for a search domain." }, "DescribeStopwordOptionsResponse": { "type": "object", "required": [ "Stopwords" ], "properties": { "Stopwords": { "$ref": "#/components/schemas/StopwordOptionsStatus" } }, "description": "A response message that contains the stopword options for a search domain." }, "DescribeSynonymOptionsResponse": { "type": "object", "required": [ "Synonyms" ], "properties": { "Synonyms": { "$ref": "#/components/schemas/SynonymOptionsStatus" } }, "description": "A response message that contains the synonym options for a search domain." }, "IndexDocumentsResponse": { "type": "object", "properties": { "FieldNames": { "allOf": [ { "$ref": "#/components/schemas/FieldNameList" }, { "description": "The names of the fields that are currently being processed due to an IndexDocuments action." } ] } }, "description": "The result of an IndexDocuments action." }, "UpdateAvailabilityOptionsResponse": { "type": "object", "properties": { "AvailabilityOptions": { "allOf": [ { "$ref": "#/components/schemas/AvailabilityOptionsStatus" }, { "description": "The newly-configured availability options. Indicates whether Multi-AZ is enabled for the domain. " } ] } }, "description": "The result of a UpdateAvailabilityOptions request. Contains the status of the domain's availability options. " }, "UpdateDefaultSearchFieldResponse": { "type": "object", "required": [ "DefaultSearchField" ], "properties": { "DefaultSearchField": { "$ref": "#/components/schemas/DefaultSearchFieldStatus" } }, "description": "A response message that contains the status of an updated default search field." }, "UpdateServiceAccessPoliciesResponse": { "type": "object", "required": [ "AccessPolicies" ], "properties": { "AccessPolicies": { "$ref": "#/components/schemas/AccessPoliciesStatus" } }, "description": "A response message that contains the status of updated access policies." }, "UpdateStemmingOptionsResponse": { "type": "object", "required": [ "Stems" ], "properties": { "Stems": { "$ref": "#/components/schemas/StemmingOptionsStatus" } }, "description": "A response message that contains the status of updated stemming options." }, "UpdateStopwordOptionsResponse": { "type": "object", "required": [ "Stopwords" ], "properties": { "Stopwords": { "$ref": "#/components/schemas/StopwordOptionsStatus" } }, "description": "A response message that contains the status of updated stopword options." }, "UpdateSynonymOptionsResponse": { "type": "object", "required": [ "Synonyms" ], "properties": { "Synonyms": { "$ref": "#/components/schemas/SynonymOptionsStatus" } }, "description": "A response message that contains the status of updated synonym options." }, "PolicyDocument": { "type": "string", "description": "

An IAM access policy as described in The Access Policy Language in Using AWS Identity and Access Management. The maximum size of an access policy document is 100 KB.

Example: {\"Statement\": [{\"Effect\":\"Allow\", \"Action\": \"*\", \"Resource\": \"arn:aws:cs:us-east-1:1234567890:search/movies\", \"Condition\": { \"IpAddress\": { \"aws:SourceIp\": [\"203.0.113.1/32\"] } }}, {\"Effect\":\"Allow\", \"Action\": \"*\", \"Resource\": \"arn:aws:cs:us-east-1:1234567890:documents/movies\", \"Condition\": { \"IpAddress\": { \"aws:SourceIp\": [\"203.0.113.1/32\"] } }} ] }

" }, "OptionStatus": { "type": "object", "required": [ "CreationDate", "UpdateDate", "State" ], "properties": { "CreationDate": { "allOf": [ { "$ref": "#/components/schemas/UpdateTimestamp" }, { "description": "A timestamp for when this option was created." } ] }, "UpdateDate": { "allOf": [ { "$ref": "#/components/schemas/UpdateTimestamp" }, { "description": "A timestamp for when this option was last updated." } ] }, "UpdateVersion": { "allOf": [ { "$ref": "#/components/schemas/UIntValue" }, { "description": "A unique integer that indicates when this option was last updated." } ] }, "State": { "allOf": [ { "$ref": "#/components/schemas/OptionState" }, { "description": "

The state of processing a change to an option. Possible values:

" } ] }, "PendingDeletion": { "allOf": [ { "$ref": "#/components/schemas/Boolean" }, { "description": "Indicates that the option will be deleted once processing is complete." } ] } }, "description": "The status of an option, including when it was last updated and whether it is actively in use for searches." }, "AccessPoliciesStatus": { "type": "object", "required": [ "Options", "Status" ], "properties": { "Options": { "$ref": "#/components/schemas/PolicyDocument" }, "Status": { "$ref": "#/components/schemas/OptionStatus" } }, "description": "A PolicyDocument that specifies access policies for the search domain's services, and the current status of those policies." }, "Arn": { "type": "string", "description": "An Amazon Resource Name (ARN). See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information." }, "MultiAZ": { "type": "boolean" }, "AvailabilityOptionsStatus": { "type": "object", "required": [ "Options", "Status" ], "properties": { "Options": { "allOf": [ { "$ref": "#/components/schemas/MultiAZ" }, { "description": "The availability options configured for the domain." } ] }, "Status": { "$ref": "#/components/schemas/OptionStatus" } }, "description": "The status and configuration of the domain's availability options." }, "ErrorCode": { "type": "string", "description": "A machine-parsable string error or warning code." }, "ErrorMessage": { "type": "string", "description": "A human-readable string error or warning message." }, "Boolean": { "type": "boolean" }, "CreateDomainRequest": { "type": "object", "required": [ "DomainName" ], "title": "CreateDomainRequest", "properties": { "DomainName": { "$ref": "#/components/schemas/DomainName" } } }, "DomainStatus": { "type": "object", "required": [ "DomainId", "DomainName", "RequiresIndexDocuments" ], "properties": { "DomainId": { "$ref": "#/components/schemas/DomainId" }, "DomainName": { "$ref": "#/components/schemas/DomainName" }, "Created": { "allOf": [ { "$ref": "#/components/schemas/Boolean" }, { "description": "True if the search domain is created. It can take several minutes to initialize a domain when CreateDomain is called. Newly created search domains are returned from DescribeDomains with a false value for Created until domain creation is complete." } ] }, "Deleted": { "allOf": [ { "$ref": "#/components/schemas/Boolean" }, { "description": "True if the search domain has been deleted. The system must clean up resources dedicated to the search domain when DeleteDomain is called. Newly deleted search domains are returned from DescribeDomains with a true value for IsDeleted for several minutes until resource cleanup is complete." } ] }, "NumSearchableDocs": { "allOf": [ { "$ref": "#/components/schemas/DocumentCount" }, { "description": "The number of documents that have been submitted to the domain and indexed." } ] }, "DocService": { "allOf": [ { "$ref": "#/components/schemas/ServiceEndpoint" }, { "description": "The service endpoint for updating documents in a search domain." } ] }, "SearchService": { "allOf": [ { "$ref": "#/components/schemas/ServiceEndpoint" }, { "description": "The service endpoint for requesting search results from a search domain." } ] }, "RequiresIndexDocuments": { "allOf": [ { "$ref": "#/components/schemas/Boolean" }, { "description": "True if IndexDocuments needs to be called to activate the current domain configuration." } ] }, "Processing": { "allOf": [ { "$ref": "#/components/schemas/Boolean" }, { "description": "True if processing is being done to activate the current domain configuration." } ] }, "SearchInstanceType": { "allOf": [ { "$ref": "#/components/schemas/SearchInstanceType" }, { "description": "The instance type (such as search.m1.small) that is being used to process search requests." } ] }, "SearchPartitionCount": { "allOf": [ { "$ref": "#/components/schemas/PartitionCount" }, { "description": "The number of partitions across which the search index is spread." } ] }, "SearchInstanceCount": { "allOf": [ { "$ref": "#/components/schemas/InstanceCount" }, { "description": "The number of search instances that are available to process search requests." } ] } }, "description": "The current status of the search domain." }, "DefaultSearchFieldStatus": { "type": "object", "required": [ "Options", "Status" ], "properties": { "Options": { "allOf": [ { "$ref": "#/components/schemas/FieldName" }, { "description": "The name of the IndexField to use as the default search field. The default is an empty string, which automatically searches all text fields." } ] }, "Status": { "$ref": "#/components/schemas/OptionStatus" } }, "description": "The value of the DefaultSearchField configured for this search domain and its current status." }, "IndexField": { "type": "object", "required": [ "IndexFieldName", "IndexFieldType" ], "properties": { "IndexFieldName": { "allOf": [ { "$ref": "#/components/schemas/FieldName" }, { "description": "The name of a field in the search index. Field names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Uppercase letters and hyphens are not allowed. The names \"body\", \"docid\", and \"text_relevance\" are reserved and cannot be specified as field or rank expression names." } ] }, "IndexFieldType": { "allOf": [ { "$ref": "#/components/schemas/IndexFieldType" }, { "description": "The type of field. Based on this type, exactly one of the UIntOptions, LiteralOptions or TextOptions must be present." } ] }, "UIntOptions": { "allOf": [ { "$ref": "#/components/schemas/UIntOptions" }, { "description": "Options for an unsigned integer field. Present if IndexFieldType specifies the field is of type unsigned integer." } ] }, "LiteralOptions": { "allOf": [ { "$ref": "#/components/schemas/LiteralOptions" }, { "description": "Options for literal field. Present if IndexFieldType specifies the field is of type literal." } ] }, "TextOptions": { "allOf": [ { "$ref": "#/components/schemas/TextOptions" }, { "description": "Options for text field. Present if IndexFieldType specifies the field is of type text." } ] }, "SourceAttributes": { "allOf": [ { "$ref": "#/components/schemas/SourceAttributeList" }, { "description": "An optional list of source attributes that provide data for this index field. If not specified, the data is pulled from a source attribute with the same name as this IndexField. When one or more source attributes are specified, an optional data transformation can be applied to the source data when populating the index field. You can configure a maximum of 20 sources for an IndexField." } ] } }, "description": "Defines a field in the index, including its name, type, and the source of its data. The IndexFieldType indicates which of the options will be present. It is invalid to specify options for a type other than the IndexFieldType." }, "DefineIndexFieldRequest": { "type": "object", "required": [ "DomainName", "IndexField" ], "title": "DefineIndexFieldRequest", "properties": { "DomainName": { "$ref": "#/components/schemas/DomainName" }, "IndexField": { "$ref": "#/components/schemas/IndexField" } } }, "IndexFieldStatus": { "type": "object", "required": [ "Options", "Status" ], "properties": { "Options": { "$ref": "#/components/schemas/IndexField" }, "Status": { "$ref": "#/components/schemas/OptionStatus" } }, "description": "The value of an IndexField and its current status." }, "NamedRankExpression": { "type": "object", "required": [ "RankName", "RankExpression" ], "properties": { "RankName": { "allOf": [ { "$ref": "#/components/schemas/FieldName" }, { "description": "The name of a rank expression. Rank expression names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Uppercase letters and hyphens are not allowed. The names \"body\", \"docid\", and \"text_relevance\" are reserved and cannot be specified as field or rank expression names." } ] }, "RankExpression": { "allOf": [ { "$ref": "#/components/schemas/RankExpression" }, { "description": "

The expression to evaluate for ranking or thresholding while processing a search request. The RankExpression syntax is based on JavaScript expressions and supports:

Intermediate results are calculated as double precision floating point values. The final return value of a RankExpression is automatically converted from floating point to a 32-bit unsigned integer by rounding to the nearest integer, with a natural floor of 0 and a ceiling of max(uint32_t), 4294967295. Mathematical errors such as dividing by 0 will fail during evaluation and return a value of 0.

The source data for a RankExpression can be the name of an IndexField of type uint, another RankExpression or the reserved name text_relevance. The text_relevance source is defined to return an integer from 0 to 1000 (inclusive) to indicate how relevant a document is to the search request, taking into account repetition of search terms in the document and proximity of search terms to each other in each matching IndexField in the document.

For more information about using rank expressions to customize ranking, see the Amazon CloudSearch Developer Guide.

" } ] } }, "description": "A named expression that can be evaluated at search time and used for ranking or thresholding in a search query. " }, "DefineRankExpressionRequest": { "type": "object", "required": [ "DomainName", "RankExpression" ], "title": "DefineRankExpressionRequest", "properties": { "DomainName": { "$ref": "#/components/schemas/DomainName" }, "RankExpression": { "$ref": "#/components/schemas/NamedRankExpression" } } }, "RankExpressionStatus": { "type": "object", "required": [ "Options", "Status" ], "properties": { "Options": { "allOf": [ { "$ref": "#/components/schemas/NamedRankExpression" }, { "description": "The expression that is evaluated for ranking or thresholding while processing a search request." } ] }, "Status": { "$ref": "#/components/schemas/OptionStatus" } }, "description": "The value of a RankExpression and its current status." }, "DeleteDomainRequest": { "type": "object", "required": [ "DomainName" ], "title": "DeleteDomainRequest", "properties": { "DomainName": { "$ref": "#/components/schemas/DomainName" } } }, "DeleteIndexFieldRequest": { "type": "object", "required": [ "DomainName", "IndexFieldName" ], "title": "DeleteIndexFieldRequest", "properties": { "DomainName": { "$ref": "#/components/schemas/DomainName" }, "IndexFieldName": { "$ref": "#/components/schemas/FieldName" } } }, "DeleteRankExpressionRequest": { "type": "object", "required": [ "DomainName", "RankName" ], "title": "DeleteRankExpressionRequest", "properties": { "DomainName": { "$ref": "#/components/schemas/DomainName" }, "RankName": { "allOf": [ { "$ref": "#/components/schemas/FieldName" }, { "description": "The name of the RankExpression to delete." } ] } } }, "DescribeAvailabilityOptionsRequest": { "type": "object", "required": [ "DomainName" ], "title": "DescribeAvailabilityOptionsRequest", "properties": { "DomainName": { "allOf": [ { "$ref": "#/components/schemas/DomainName" }, { "description": "The name of the domain you want to describe." } ] } }, "description": "Container for the parameters to the DescribeAvailabilityOptions operation. Specifies the name of the domain you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true." }, "DescribeDefaultSearchFieldRequest": { "type": "object", "required": [ "DomainName" ], "title": "DescribeDefaultSearchFieldRequest", "properties": { "DomainName": { "$ref": "#/components/schemas/DomainName" } } }, "DomainNameList": { "type": "array", "description": "A list of domain names.", "items": { "$ref": "#/components/schemas/DomainName" } }, "DescribeDomainsRequest": { "type": "object", "title": "DescribeDomainsRequest", "properties": { "DomainNames": { "allOf": [ { "$ref": "#/components/schemas/DomainNameList" }, { "description": "Limits the DescribeDomains response to the specified search domains." } ] } } }, "DomainStatusList": { "type": "array", "description": "The current status of all of your search domains.", "items": { "$ref": "#/components/schemas/DomainStatus" } }, "FieldNameList": { "type": "array", "items": { "$ref": "#/components/schemas/FieldName" } }, "DescribeIndexFieldsRequest": { "type": "object", "required": [ "DomainName" ], "title": "DescribeIndexFieldsRequest", "properties": { "DomainName": { "$ref": "#/components/schemas/DomainName" }, "FieldNames": { "allOf": [ { "$ref": "#/components/schemas/FieldNameList" }, { "description": "Limits the DescribeIndexFields response to the specified fields." } ] } } }, "IndexFieldStatusList": { "type": "array", "items": { "$ref": "#/components/schemas/IndexFieldStatus" } }, "DescribeRankExpressionsRequest": { "type": "object", "required": [ "DomainName" ], "title": "DescribeRankExpressionsRequest", "properties": { "DomainName": { "$ref": "#/components/schemas/DomainName" }, "RankNames": { "allOf": [ { "$ref": "#/components/schemas/FieldNameList" }, { "description": "Limits the DescribeRankExpressions response to the specified fields." } ] } } }, "RankExpressionStatusList": { "type": "array", "items": { "$ref": "#/components/schemas/RankExpressionStatus" } }, "DescribeServiceAccessPoliciesRequest": { "type": "object", "required": [ "DomainName" ], "title": "DescribeServiceAccessPoliciesRequest", "properties": { "DomainName": { "$ref": "#/components/schemas/DomainName" } } }, "DescribeStemmingOptionsRequest": { "type": "object", "required": [ "DomainName" ], "title": "DescribeStemmingOptionsRequest", "properties": { "DomainName": { "$ref": "#/components/schemas/DomainName" } } }, "StemmingOptionsStatus": { "type": "object", "required": [ "Options", "Status" ], "properties": { "Options": { "$ref": "#/components/schemas/StemsDocument" }, "Status": { "$ref": "#/components/schemas/OptionStatus" } }, "description": "The stemming options configured for this search domain and the current status of those options." }, "DescribeStopwordOptionsRequest": { "type": "object", "required": [ "DomainName" ], "title": "DescribeStopwordOptionsRequest", "properties": { "DomainName": { "$ref": "#/components/schemas/DomainName" } } }, "StopwordOptionsStatus": { "type": "object", "required": [ "Options", "Status" ], "properties": { "Options": { "$ref": "#/components/schemas/StopwordsDocument" }, "Status": { "$ref": "#/components/schemas/OptionStatus" } }, "description": "The stopword options configured for this search domain and the current status of those options." }, "DescribeSynonymOptionsRequest": { "type": "object", "required": [ "DomainName" ], "title": "DescribeSynonymOptionsRequest", "properties": { "DomainName": { "$ref": "#/components/schemas/DomainName" } } }, "SynonymOptionsStatus": { "type": "object", "required": [ "Options", "Status" ], "properties": { "Options": { "$ref": "#/components/schemas/SynonymsDocument" }, "Status": { "$ref": "#/components/schemas/OptionStatus" } }, "description": "The synonym options configured for this search domain and the current status of those options." }, "DocumentCount": { "type": "integer", "minimum": 0 }, "DomainId": { "type": "string", "description": "An internally generated unique identifier for a domain.", "minLength": 1, "maxLength": 64 }, "ServiceEndpoint": { "type": "object", "properties": { "Arn": { "$ref": "#/components/schemas/Arn" }, "Endpoint": { "$ref": "#/components/schemas/ServiceUrl" } }, "description": "The endpoint to which service requests can be submitted, including the actual URL prefix for sending requests and the Amazon Resource Name (ARN) so the endpoint can be referenced in other API calls such as UpdateServiceAccessPolicies." }, "SearchInstanceType": { "type": "string" }, "PartitionCount": { "type": "integer", "minimum": 1 }, "InstanceCount": { "type": "integer", "minimum": 1 }, "FieldValue": { "type": "string", "description": "The value of a field or source document attribute.", "minLength": 0, "maxLength": 1024 }, "IndexDocumentsRequest": { "type": "object", "required": [ "DomainName" ], "title": "IndexDocumentsRequest", "properties": { "DomainName": { "$ref": "#/components/schemas/DomainName" } } }, "Language": { "type": "string", "pattern": "[a-zA-Z]{2,8}(?:-[a-zA-Z]{2,8})*", "description": "An IETF RFC 4646 language code. Only the primary language is considered. English (en) is currently the only supported language." }, "OptionState": { "type": "string", "enum": [ "RequiresIndexDocuments", "Processing", "Active" ], "description": "The state of processing a change to an option." }, "UpdateTimestamp": { "type": "string", "format": "date-time" }, "UIntValue": { "type": "integer", "minimum": 0 }, "ServiceUrl": { "type": "string", "description": "The URL (including /version/pathPrefix) to which service requests can be submitted." }, "SourceDataFunction": { "type": "string", "enum": [ "Copy", "TrimTitle", "Map" ] }, "SourceData": { "type": "object", "required": [ "SourceName" ], "properties": { "SourceName": { "allOf": [ { "$ref": "#/components/schemas/FieldName" }, { "description": "The name of the document source field to add to this IndexField." } ] }, "DefaultValue": { "allOf": [ { "$ref": "#/components/schemas/FieldValue" }, { "description": "The default value to use if the source attribute is not specified in a document. Optional." } ] } }, "description": "The source attribute name and an optional default value to use if a document doesn't have an attribute of that name." }, "SourceDataTrimTitle": { "type": "object", "required": [ "SourceName" ], "properties": { "SourceName": { "allOf": [ { "$ref": "#/components/schemas/FieldName" }, { "description": "The name of the document source field to add to this IndexField." } ] }, "DefaultValue": { "allOf": [ { "$ref": "#/components/schemas/FieldValue" }, { "description": "The default value to use if the source attribute is not specified in a document. Optional." } ] }, "Separator": { "allOf": [ { "$ref": "#/components/schemas/String" }, { "description": "The separator that follows the text to trim." } ] }, "Language": { "$ref": "#/components/schemas/Language" } }, "description": "Specifies how to trim common words from the beginning of a field to enable title sorting by that field." }, "SourceDataMap": { "type": "object", "required": [ "SourceName" ], "properties": { "SourceName": { "allOf": [ { "$ref": "#/components/schemas/FieldName" }, { "description": "The name of the document source field to add to this IndexField." } ] }, "DefaultValue": { "allOf": [ { "$ref": "#/components/schemas/FieldValue" }, { "description": "The default value to use if the source attribute is not specified in a document. Optional." } ] }, "Cases": { "allOf": [ { "$ref": "#/components/schemas/StringCaseMap" }, { "description": "A map that translates source field values to custom values." } ] } }, "description": "Specifies how to map source attribute values to custom values when populating an IndexField." }, "SourceAttribute": { "type": "object", "required": [ "SourceDataFunction" ], "properties": { "SourceDataFunction": { "allOf": [ { "$ref": "#/components/schemas/SourceDataFunction" }, { "description": "Identifies the transformation to apply when copying data from a source attribute." } ] }, "SourceDataCopy": { "allOf": [ { "$ref": "#/components/schemas/SourceData" }, { "description": "Copies data from a source document attribute to an IndexField." } ] }, "SourceDataTrimTitle": { "allOf": [ { "$ref": "#/components/schemas/SourceDataTrimTitle" }, { "description": "Trims common title words from a source document attribute when populating an IndexField. This can be used to create an IndexField you can use for sorting." } ] }, "SourceDataMap": { "allOf": [ { "$ref": "#/components/schemas/SourceDataMap" }, { "description": "Maps source document attribute values to new values when populating the IndexField." } ] } }, "description": "Identifies the source data for an index field. An optional data transformation can be applied to the source data when populating the index field. By default, the value of the source attribute is copied to the index field." }, "StringCaseMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/FieldValue" } }, "String": { "type": "string" }, "StemsDocument": { "type": "string", "description": "Maps terms to their stems, serialized as a JSON document. The document has a single object with one property \"stems\" whose value is an object mapping terms to their stems. The maximum size of a stemming document is 500 KB. Example: { \"stems\": {\"people\": \"person\", \"walking\": \"walk\"} }" }, "StopwordsDocument": { "type": "string", "description": "Lists stopwords serialized as a JSON document. The document has a single object with one property \"stopwords\" whose value is an array of strings. The maximum size of a stopwords document is 10 KB. Example: { \"stopwords\": [\"a\", \"an\", \"the\", \"of\"] }" }, "SynonymsDocument": { "type": "string", "description": "Maps terms to their synonyms, serialized as a JSON document. The document has a single object with one property \"synonyms\" whose value is an object mapping terms to their synonyms. Each synonym is a simple string or an array of strings. The maximum size of a stopwords document is 100 KB. Example: { \"synonyms\": {\"cat\": [\"feline\", \"kitten\"], \"puppy\": \"dog\"} }" }, "UpdateAvailabilityOptionsRequest": { "type": "object", "required": [ "DomainName", "MultiAZ" ], "title": "UpdateAvailabilityOptionsRequest", "properties": { "DomainName": { "$ref": "#/components/schemas/DomainName" }, "MultiAZ": { "allOf": [ { "$ref": "#/components/schemas/Boolean" }, { "description": "You expand an existing search domain to a second Availability Zone by setting the Multi-AZ option to true. Similarly, you can turn off the Multi-AZ option to downgrade the domain to a single Availability Zone by setting the Multi-AZ option to false. " } ] } }, "description": "Container for the parameters to the UpdateAvailabilityOptions operation. Specifies the name of the domain you want to update and the Multi-AZ availability option." }, "UpdateDefaultSearchFieldRequest": { "type": "object", "required": [ "DomainName", "DefaultSearchField" ], "title": "UpdateDefaultSearchFieldRequest", "properties": { "DomainName": { "$ref": "#/components/schemas/DomainName" }, "DefaultSearchField": { "allOf": [ { "$ref": "#/components/schemas/String" }, { "description": "The text field to search if the search request does not specify which field to search. The default search field is used when search terms are specified with the q parameter, or if a match expression specified with the bq parameter does not constrain the search to a particular field. The default is an empty string, which automatically searches all text fields." } ] } } }, "UpdateServiceAccessPoliciesRequest": { "type": "object", "required": [ "DomainName", "AccessPolicies" ], "title": "UpdateServiceAccessPoliciesRequest", "properties": { "DomainName": { "$ref": "#/components/schemas/DomainName" }, "AccessPolicies": { "$ref": "#/components/schemas/PolicyDocument" } } }, "UpdateStemmingOptionsRequest": { "type": "object", "required": [ "DomainName", "Stems" ], "title": "UpdateStemmingOptionsRequest", "properties": { "DomainName": { "$ref": "#/components/schemas/DomainName" }, "Stems": { "$ref": "#/components/schemas/StemsDocument" } } }, "UpdateStopwordOptionsRequest": { "type": "object", "required": [ "DomainName", "Stopwords" ], "title": "UpdateStopwordOptionsRequest", "properties": { "DomainName": { "$ref": "#/components/schemas/DomainName" }, "Stopwords": { "$ref": "#/components/schemas/StopwordsDocument" } } }, "UpdateSynonymOptionsRequest": { "type": "object", "required": [ "DomainName", "Synonyms" ], "title": "UpdateSynonymOptionsRequest", "properties": { "DomainName": { "$ref": "#/components/schemas/DomainName" }, "Synonyms": { "$ref": "#/components/schemas/SynonymsDocument" } } } } }, "security": [ { "hmac": [] } ] }