lobo/aws-sdk-for-zig
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects 1 Releases Wiki Activity
xml
aws-sdk-for-zig/codegen/models/cloudsearch.2013-01-01.json

3396 lines
160 KiB
JSON
Raw Permalink Normal View History

codegen all the things
2021-05-30 01:17:45 +00:00
{
"smithy": "1.0",
"metadata": {
"suppressions": [
{
"id": "HttpMethodSemantics",
"namespace": "*"
},
{
"id": "HttpResponseCodeSemantics",
"namespace": "*"
},
{
"id": "PaginatedTrait",
"namespace": "*"
},
{
"id": "HttpHeaderTrait",
"namespace": "*"
},
{
"id": "HttpUriConflict",
"namespace": "*"
},
{
"id": "Service",
"namespace": "*"
}
]
},
"shapes": {
"com.amazonaws.cloudsearch#A9SearchCloudConfigService2013": {
"type": "service",
"version": "2013-01-01",
"operations": [
{
"target": "com.amazonaws.cloudsearch#BuildSuggesters"
},
{
"target": "com.amazonaws.cloudsearch#CreateDomain"
},
{
"target": "com.amazonaws.cloudsearch#DefineAnalysisScheme"
},
{
"target": "com.amazonaws.cloudsearch#DefineExpression"
},
{
"target": "com.amazonaws.cloudsearch#DefineIndexField"
},
{
"target": "com.amazonaws.cloudsearch#DefineSuggester"
},
{
"target": "com.amazonaws.cloudsearch#DeleteAnalysisScheme"
},
{
"target": "com.amazonaws.cloudsearch#DeleteDomain"
},
{
"target": "com.amazonaws.cloudsearch#DeleteExpression"
},
{
"target": "com.amazonaws.cloudsearch#DeleteIndexField"
},
{
"target": "com.amazonaws.cloudsearch#DeleteSuggester"
},
{
"target": "com.amazonaws.cloudsearch#DescribeAnalysisSchemes"
},
{
"target": "com.amazonaws.cloudsearch#DescribeAvailabilityOptions"
},
{
"target": "com.amazonaws.cloudsearch#DescribeDomainEndpointOptions"
},
{
"target": "com.amazonaws.cloudsearch#DescribeDomains"
},
{
"target": "com.amazonaws.cloudsearch#DescribeExpressions"
},
{
"target": "com.amazonaws.cloudsearch#DescribeIndexFields"
},
{
"target": "com.amazonaws.cloudsearch#DescribeScalingParameters"
},
{
"target": "com.amazonaws.cloudsearch#DescribeServiceAccessPolicies"
},
{
"target": "com.amazonaws.cloudsearch#DescribeSuggesters"
},
{
"target": "com.amazonaws.cloudsearch#IndexDocuments"
},
{
"target": "com.amazonaws.cloudsearch#ListDomainNames"
},
{
"target": "com.amazonaws.cloudsearch#UpdateAvailabilityOptions"
},
{
"target": "com.amazonaws.cloudsearch#UpdateDomainEndpointOptions"
},
{
"target": "com.amazonaws.cloudsearch#UpdateScalingParameters"
},
{
"target": "com.amazonaws.cloudsearch#UpdateServiceAccessPolicies"
}
],
"traits": {
"aws.api#service": {
"sdkId": "CloudSearch",
"arnNamespace": "cloudsearch",
"cloudFormationName": "CloudSearch",
"cloudTrailEventSource": "cloudsearch.amazonaws.com",
"endpointPrefix": "cloudsearch"
},
"aws.auth#sigv4": {
"name": "cloudsearch"
},
"aws.protocols#awsQuery": {},
"smithy.api#documentation": "<fullname>Amazon CloudSearch Configuration Service</fullname>\n <p>You use the Amazon CloudSearch configuration service to create, configure, and manage search domains.\n Configuration service requests are submitted using the AWS Query protocol. AWS Query requests\n are HTTP or HTTPS requests submitted via HTTP GET or POST with a query parameter named Action.</p>\n <p>The endpoint for configuration service requests is region-specific: cloudsearch.<i>region</i>.amazonaws.com.\n For example, cloudsearch.us-east-1.amazonaws.com. For a current list of supported regions and endpoints,\n see <a href=\"http://docs.aws.amazon.com/general/latest/gr/rande.html#cloudsearch_region\" target=\"_blank\">Regions and Endpoints</a>.</p>",
"smithy.api#title": "Amazon CloudSearch",
"smithy.api#xmlNamespace": {
"uri": "http://cloudsearch.amazonaws.com/doc/2013-01-01/"
}
}
},
"com.amazonaws.cloudsearch#APIVersion": {
"type": "string",
"traits": {
"smithy.api#documentation": "<p>The Amazon CloudSearch API version for a domain: 2011-02-01 or 2013-01-01.</p>"
}
},
"com.amazonaws.cloudsearch#ARN": {
"type": "string",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the search domain. See <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access Management</i> for more information.</p>"
}
},
"com.amazonaws.cloudsearch#AccessPoliciesStatus": {
"type": "structure",
"members": {
"Options": {
"target": "com.amazonaws.cloudsearch#PolicyDocument",
"traits": {
"smithy.api#required": {}
}
},
"Status": {
"target": "com.amazonaws.cloudsearch#OptionStatus",
"traits": {
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>The configured access rules for the domain's document and search endpoints, and the current status of those rules.</p>"
}
},
"com.amazonaws.cloudsearch#AlgorithmicStemming": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "none",
"name": "none"
},
{
"value": "minimal",
"name": "minimal"
},
{
"value": "light",
"name": "light"
},
{
"value": "full",
"name": "full"
}
]
}
},
"com.amazonaws.cloudsearch#AnalysisOptions": {
"type": "structure",
"members": {
"Synonyms": {
"target": "com.amazonaws.cloudsearch#String",
"traits": {
"smithy.api#documentation": "<p>A JSON object that defines synonym groups and aliases. A synonym group is an array of arrays, where each sub-array is a group of terms where each term in the group is considered a synonym of every other term in the group. The aliases value is an object that contains a collection of string:value pairs where the string specifies a term and the array of values specifies each of the aliases for that term. An alias is considered a synonym of the specified term, but the term is not considered a synonym of the alias. For more information about specifying synonyms, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html#synonyms\">Synonyms</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>"
}
},
"Stopwords": {
"target": "com.amazonaws.cloudsearch#String",
"traits": {
"smithy.api#documentation": "<p>A JSON array of terms to ignore during indexing and searching. For example, <code>[\"a\", \"an\", \"the\", \"of\"]</code>. The stopwords dictionary must explicitly list each word you want to ignore. Wildcards and regular expressions are not supported. </p>"
}
},
"StemmingDictionary": {
"target": "com.amazonaws.cloudsearch#String",
"traits": {
"smithy.api#documentation": "<p>A JSON object that contains a collection of string:value pairs that each map a term to its stem. For example, <code>{\"term1\": \"stem1\", \"term2\": \"stem2\", \"term3\": \"stem3\"}</code>. The stemming dictionary is applied in addition to any algorithmic stemming. This enables you to override the results of the algorithmic stemming to correct specific cases of overstemming or understemming. The maximum size of a stemming dictionary is 500 KB.</p>"
}
},
"JapaneseTokenizationDictionary": {
"target": "com.amazonaws.cloudsearch#String",
"traits": {
"smithy.api#documentation": "<p>A JSON array that contains a collection of terms, tokens, readings and part of speech for Japanese Tokenizaiton. The Japanese tokenization dictionary enables you to override the default tokenization for selected terms. This is only valid for Japanese language fields.</p>"
}
},
"AlgorithmicStemming": {
"target": "com.amazonaws.cloudsearch#AlgorithmicStemming",
"traits": {
"smithy.api#documentation": "<p>The level of algorithmic stemming to perform: <code>none</code>, <code>minimal</code>, <code>light</code>, or <code>full</code>. The available levels vary depending on the language. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/text-processing.html#text-processing-settings\" target=\"_blank\">Language Specific Text Processing Settings</a> in the <i>Amazon CloudSearch Developer Guide</i> </p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Synonyms, stopwords, and stemming options for an analysis scheme. Includes tokenization dictionary for Japanese.</p>"
}
},
"com.amazonaws.cloudsearch#AnalysisScheme": {
"type": "structure",
"members": {
"AnalysisSchemeName": {
"target": "com.amazonaws.cloudsearch#StandardName",
"traits": {
"smithy.api#required": {}
}
},
"AnalysisSchemeLanguage": {
"target": "com.amazonaws.cloudsearch#AnalysisSchemeLanguage",
"traits": {
"smithy.api#required": {}
}
},
"AnalysisOptions": {
"target": "com.amazonaws.cloudsearch#AnalysisOptions"
}
},
"traits": {
"smithy.api#documentation": "<p>Configuration information for an analysis scheme. Each analysis scheme has a unique name and specifies the language of the text to be processed. The following options can be configured for an analysis scheme: <code>Synonyms</code>, <code>Stopwords</code>, <code>StemmingDictionary</code>, <code>JapaneseTokenizationDictionary</code> and <code>AlgorithmicStemming</code>.</p>"
}
},
"com.amazonaws.cloudsearch#AnalysisSchemeLanguage": {
"type": "string",
"traits": {
"smithy.api#documentation": "<p>An <a href=\"http://tools.ietf.org/html/rfc4646\" target=\"_blank\">IETF RFC 4646</a> language code or <code>mul</code> for multiple languages.</p>",
"smithy.api#enum": [
{
"value": "ar",
"name": "ar"
},
{
"value": "bg",
"name": "bg"
},
{
"value": "ca",
"name": "ca"
},
{
"value": "cs",
"name": "cs"
},
{
"value": "da",
"name": "da"
},
{
"value": "de",
"name": "de"
},
{
"value": "el",
"name": "el"
},
{
"value": "en",
"name": "en"
},
{
"value": "es",
"name": "es"
},
{
"value": "eu",
"name": "eu"
},
{
"value": "fa",
"name": "fa"
},
{
"value": "fi",
"name": "fi"
},
{
"value": "fr",
"name": "fr"
},
{
"value": "ga",
"name": "ga"
},
{
"value": "gl",
"name": "gl"
},
{
"value": "he",
"name": "he"
},
{
"value": "hi",
"name": "hi"
},
{
"value": "hu",
"name": "hu"
},
{
"value": "hy",
"name": "hy"
},
{
"value": "id",
"name": "id"
},
{
"value": "it",
"name": "it"
},
{
"value": "ja",
"name": "ja"
},
{
"value": "ko",
"name": "ko"
},
{
"value": "lv",
"name": "lv"
},
{
"value": "mul",
"name": "mul"
},
{
"value": "nl",
"name": "nl"
},
{
"value": "no",
"name": "no"
},
{
"value": "pt",
"name": "pt"
},
{
"value": "ro",
"name": "ro"
},
{
"value": "ru",
"name": "ru"
},
{
"value": "sv",
"name": "sv"
},
{
"value": "th",
"name": "th"
},
{
"value": "tr",
"name": "tr"
},
{
"value": "zh-Hans",
"name": "zh_Hans"
},
{
"value": "zh-Hant",
"name": "zh_Hant"
}
]
}
},
"com.amazonaws.cloudsearch#AnalysisSchemeStatus": {
"type": "structure",
"members": {
"Options": {
"target": "com.amazonaws.cloudsearch#AnalysisScheme",
"traits": {
"smithy.api#required": {}
}
},
"Status": {
"target": "com.amazonaws.cloudsearch#OptionStatus",
"traits": {
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>The status and configuration of an <code>AnalysisScheme</code>.</p>"
}
},
"com.amazonaws.cloudsearch#AnalysisSchemeStatusList": {
"type": "list",
"member": {
"target": "com.amazonaws.cloudsearch#AnalysisSchemeStatus"
},
"traits": {
"smithy.api#documentation": "<p>A list of the analysis schemes configured for a domain.</p>"
}
},
"com.amazonaws.cloudsearch#AvailabilityOptionsStatus": {
"type": "structure",
"members": {
"Options": {
"target": "com.amazonaws.cloudsearch#MultiAZ",
"traits": {
"smithy.api#documentation": "<p>The availability options configured for the domain.</p>",
"smithy.api#required": {}
}
},
"Status": {
"target": "com.amazonaws.cloudsearch#OptionStatus",
"traits": {
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>The status and configuration of the domain's availability options.</p>"
}
},
"com.amazonaws.cloudsearch#BaseException": {
"type": "structure",
"members": {
"Code": {
"target": "com.amazonaws.cloudsearch#ErrorCode"
},
"Message": {
"target": "com.amazonaws.cloudsearch#ErrorMessage"
}
},
"traits": {
"smithy.api#documentation": "<p>An error occurred while processing the request.</p>",
"smithy.api#error": "client"
}
},
"com.amazonaws.cloudsearch#Boolean": {
"type": "boolean",
"traits": {
"smithy.api#box": {}
}
},
"com.amazonaws.cloudsearch#BuildSuggesters": {
"type": "operation",
"input": {
"target": "com.amazonaws.cloudsearch#BuildSuggestersRequest"
},
"output": {
"target": "com.amazonaws.cloudsearch#BuildSuggestersResponse"
},
"errors": [
{
"target": "com.amazonaws.cloudsearch#BaseException"
},
{
"target": "com.amazonaws.cloudsearch#InternalException"
},
{
"target": "com.amazonaws.cloudsearch#ResourceNotFoundException"
}
],
"traits": {
"smithy.api#documentation": "<p>Indexes the search suggestions. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html#configuring-suggesters\">Configuring Suggesters</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>"
}
},
"com.amazonaws.cloudsearch#BuildSuggestersRequest": {
"type": "structure",
"members": {
"DomainName": {
"target": "com.amazonaws.cloudsearch#DomainName",
"traits": {
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Container for the parameters to the <code><a>BuildSuggester</a></code> operation. Specifies the name of the domain you want to update.</p>"
}
},
"com.amazonaws.cloudsearch#BuildSuggestersResponse": {
"type": "structure",
"members": {
"FieldNames": {
"target": "com.amazonaws.cloudsearch#FieldNameList"
}
},
"traits": {
"smithy.api#documentation": "<p>The result of a <code>BuildSuggester</code> request. Contains a list of the fields used for suggestions.</p>"
}
},
"com.amazonaws.cloudsearch#CreateDomain": {
"type": "operation",
"input": {
"target": "com.amazonaws.cloudsearch#CreateDomainRequest"
},
"output": {
"target": "com.amazonaws.cloudsearch#CreateDomainResponse"
},
"errors": [
{
"target": "com.amazonaws.cloudsearch#BaseException"
},
{
"target": "com.amazonaws.cloudsearch#InternalException"
},
{
"target": "com.amazonaws.cloudsearch#LimitExceededException"
}
],
"traits": {
"smithy.api#documentation": "<p>Creates a new search domain. For more information,\n see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/creating-domains.html\" target=\"_blank\">Creating a Search Domain</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>"
}
},
"com.amazonaws.cloudsearch#CreateDomainRequest": {
"type": "structure",
"members": {
"DomainName": {
"target": "com.amazonaws.cloudsearch#DomainName",
"traits": {
"smithy.api#documentation": "<p>A name for the domain you are creating. Allowed characters are a-z (lower-case letters), 0-9, and hyphen (-). Domain names must start with a letter or number and be at least 3 and no more than 28 characters long.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Container for the parameters to the <code><a>CreateDomain</a></code> operation. Specifies a name for the new search domain.</p>"
}
},
"com.amazonaws.cloudsearch#CreateDomainResponse": {
"type": "structure",
"members": {
"DomainStatus": {
"target": "com.amazonaws.cloudsearch#DomainStatus"
}
},
"traits": {
"smithy.api#documentation": "<p>The result of a <code>CreateDomainRequest</code>. Contains the status of a newly created domain.</p>"
}
},
"com.amazonaws.cloudsearch#DateArrayOptions": {
"type": "structure",
"members": {
"DefaultValue": {
"target": "com.amazonaws.cloudsearch#FieldValue",
"traits": {
"smithy.api#documentation": "A value to use for the field if the field isn't specified for a document."
}
},
"SourceFields": {
"target": "com.amazonaws.cloudsearch#FieldNameCommaList",
"traits": {
"smithy.api#documentation": "<p>A list of source fields to map to the field. </p>"
}
},
"FacetEnabled": {
"target": "com.amazonaws.cloudsearch#Boolean",
"traits": {
"smithy.api#documentation": "<p>Whether facet information can be returned for the field.</p>"
}
},
"SearchEnabled": {
"target": "com.amazonaws.cloudsearch#Boolean",
"traits": {
"smithy.api#documentation": "<p>Whether the contents of the field are searchable.</p>"
}
},
"ReturnEnabled": {
"target": "com.amazonaws.cloudsearch#Boolean",
"traits": {
"smithy.api#documentation": "<p>Whether the contents of the field can be returned in the search results.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Options for a field that contains an array of dates. Present if <code>IndexFieldType</code> specifies the field is of type <code>date-array</code>. All options are enabled by default.</p>"
}
},
"com.amazonaws.cloudsearch#DateOptions": {
"type": "structure",
"members": {
"DefaultValue": {
"target": "com.amazonaws.cloudsearch#FieldValue",
"traits": {
"smithy.api#documentation": "A value to use for the field if the field isn't specified for a document."
}
},
"SourceField": {
"target": "com.amazonaws.cloudsearch#FieldName"
},
"FacetEnabled": {
"target": "com.amazonaws.cloudsearch#Boolean",
"traits": {
"smithy.api#documentation": "<p>Whether facet information can be returned for the field.</p>"
}
},
"SearchEnabled": {
"target": "com.amazonaws.cloudsearch#Boolean",
"traits": {
"smithy.api#documentation": "<p>Whether the contents of the field are searchable.</p>"
}
},
"ReturnEnabled": {
"target": "com.amazonaws.cloudsearch#Boolean",
"traits": {
"smithy.api#documentation": "<p>Whether the contents of the field can be returned in the search results.</p>"
}
},
"SortEnabled": {
"target": "com.amazonaws.cloudsearch#Boolean",
"traits": {
"smithy.api#documentation": "<p>Whether the field can be used to sort the search results.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Options for a date field. Dates and times are specified in UTC (Coordinated Universal Time) according to IETF RFC3339: yyyy-mm-ddT00:00:00Z. Present if <code>IndexFieldType</code> specifies the field is of type <code>date</code>. All options are enabled by default.</p>"
}
},
"com.amazonaws.cloudsearch#DefineAnalysisScheme": {
"type": "operation",
"input": {
"target": "com.amazonaws.cloudsearch#DefineAnalysisSchemeRequest"
},
"output": {
"target": "com.amazonaws.cloudsearch#DefineAnalysisSchemeResponse"
},
"errors": [
{
"target": "com.amazonaws.cloudsearch#BaseException"
},
{
"target": "com.amazonaws.cloudsearch#InternalException"
},
{
"target": "com.amazonaws.cloudsearch#InvalidTypeException"
},
{
"target": "com.amazonaws.cloudsearch#LimitExceededException"
},
{
"target": "com.amazonaws.cloudsearch#ResourceNotFoundException"
}
],
"traits": {
"smithy.api#documentation": "<p>Configures an analysis scheme that can be applied to a <code>text</code> or <code>text-array</code> field to define language-specific text processing options. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html\" target=\"_blank\">Configuring Analysis Schemes</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>"
}
},
"com.amazonaws.cloudsearch#DefineAnalysisSchemeRequest": {
"type": "structure",
"members": {
"DomainName": {
"target": "com.amazonaws.cloudsearch#DomainName",
"traits": {
"smithy.api#required": {}
}
},
"AnalysisScheme": {
"target": "com.amazonaws.cloudsearch#AnalysisScheme",
"traits": {
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Container for the parameters to the <code><a>DefineAnalysisScheme</a></code> operation. Specifies the name of the domain you want to update and the analysis scheme configuration.</p>"
}
},
"com.amazonaws.cloudsearch#DefineAnalysisSchemeResponse": {
"type": "structure",
"members": {
"AnalysisScheme": {
"target": "com.amazonaws.cloudsearch#AnalysisSchemeStatus",
"traits": {
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>The result of a <code><a>DefineAnalysisScheme</a></code> request. Contains the status of the newly-configured analysis scheme.</p>"
}
},
"com.amazonaws.cloudsearch#DefineExpression": {
"type": "operation",
"input": {
"target": "com.amazonaws.cloudsearch#DefineExpressionRequest"
},
"output": {
"target": "com.amazonaws.cloudsearch#DefineExpressionResponse"
},
"errors": [
{
"target": "com.amazonaws.cloudsearch#BaseException"
},
{
"target": "com.amazonaws.cloudsearch#InternalException"
},
{
"target": "com.amazonaws.cloudsearch#InvalidTypeException"
},
{
"target": "com.amazonaws.cloudsearch#LimitExceededException"
},
{
"target": "com.amazonaws.cloudsearch#ResourceNotFoundException"
}
],
"traits": {
"smithy.api#documentation": "<p>Configures an <code><a>Expression</a></code> for the search domain. Used to create new expressions and modify existing ones. If the expression exists, the new configuration replaces the old one. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html\" target=\"_blank\">Configuring Expressions</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>"
}
},
"com.amazonaws.cloudsearch#DefineExpressionRequest": {
"type": "structure",
"members": {
"DomainName": {
"target": "com.amazonaws.cloudsearch#DomainName",
"traits": {
"smithy.api#required": {}
}
},
"Expression": {
"target": "com.amazonaws.cloudsearch#Expression",
"traits": {
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Container for the parameters to the <code><a>DefineExpression</a></code> operation. Specifies the name of the domain you want to update and the expression you want to configure.</p>"
}
},
"com.amazonaws.cloudsearch#DefineExpressionResponse": {
"type": "structure",
"members": {
"Expression": {
"target": "com.amazonaws.cloudsearch#ExpressionStatus",
"traits": {
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>The result of a <code>DefineExpression</code> request. Contains the status of the newly-configured expression.</p>"
}
},
"com.amazonaws.cloudsearch#DefineIndexField": {
"type": "operation",
"input": {
"target": "com.amazonaws.cloudsearch#DefineIndexFieldRequest"
},
"output": {
"target": "com.amazonaws.cloudsearch#DefineIndexFieldResponse"
},
"errors": [
{
"target": "com.amazonaws.cloudsearch#BaseException"
},
{
"target": "com.amazonaws.cloudsearch#InternalException"
},
{
"target": "com.amazonaws.cloudsearch#InvalidTypeException"
},
{
"target": "com.amazonaws.cloudsearch#LimitExceededException"
},
{
"target": "com.amazonaws.cloudsearch#ResourceNotFoundException"
}
],
"traits": {
"smithy.api#documentation": "<p>Configures an <code><a>IndexField</a></code> for the search domain. Used to create new fields and modify existing ones. You must specify the name of the domain you are configuring and an index field configuration. The index field configuration specifies a unique name, the index field type, and the options you want to configure for the field. The options you can specify depend on the <code><a>IndexFieldType</a></code>. If the field exists, the new configuration replaces the old one. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html\" target=\"_blank\">Configuring Index Fields</a> in the <i>Amazon CloudSearch Developer Guide</i>. </p>"
}
},
"com.amazonaws.cloudsearch#DefineIndexFieldRequest": {
"type": "structure",
"members": {
"DomainName": {
"target": "com.amazonaws.cloudsearch#DomainName",
"traits": {
"smithy.api#required": {}
}
},
"IndexField": {
"target": "com.amazonaws.cloudsearch#IndexField",
"traits": {
"smithy.api#documentation": "<p>The index field and field options you want to configure. </p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Container for the parameters to the <code><a>DefineIndexField</a></code> operation. Specifies the name of the domain you want to update and the index field configuration.</p>"
}
},
"com.amazonaws.cloudsearch#DefineIndexFieldResponse": {
"type": "structure",
"members": {
"IndexField": {
"target": "com.amazonaws.cloudsearch#IndexFieldStatus",
"traits": {
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>The result of a <code><a>DefineIndexField</a></code> request. Contains the status of the newly-configured index field.</p>"
}
},
"com.amazonaws.cloudsearch#DefineSuggester": {
"type": "operation",
"input": {
"target": "com.amazonaws.cloudsearch#DefineSuggesterRequest"
},
"output": {
"target": "com.amazonaws.cloudsearch#DefineSuggesterResponse"
},
"errors": [
{
"target": "com.amazonaws.cloudsearch#BaseException"
},
{
"target": "com.amazonaws.cloudsearch#InternalException"
},
{
"target": "com.amazonaws.cloudsearch#InvalidTypeException"
},
{
"target": "com.amazonaws.cloudsearch#LimitExceededException"
},
{
"target": "com.amazonaws.cloudsearch#ResourceNotFoundException"
}
],
"traits": {
"smithy.api#documentation": "<p>Configures a suggester for a domain. A suggester enables you to display possible matches before users finish typing their queries. When you configure a suggester, you must specify the name of the text field you want to search for possible matches and a unique name for the suggester. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html\" target=\"_blank\">Getting Search Suggestions</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>"
}
},
"com.amazonaws.cloudsearch#DefineSuggesterRequest": {
"type": "structure",
"members": {
"DomainName": {
"target": "com.amazonaws.cloudsearch#DomainName",
"traits": {
"smithy.api#required": {}
}
},
"Suggester": {
"target": "com.amazonaws.cloudsearch#Suggester",
"traits": {
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Container for the parameters to the <code><a>DefineSuggester</a></code> operation. Specifies the name of the domain you want to update and the suggester configuration.</p>"
}
},
"com.amazonaws.cloudsearch#DefineSuggesterResponse": {
"type": "structure",
"members": {
"Suggester": {
"target": "com.amazonaws.cloudsearch#SuggesterStatus",
"traits": {
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>The result of a <code>DefineSuggester</code> request. Contains the status of the newly-configured suggester.</p>"
}
},
"com.amazonaws.cloudsearch#DeleteAnalysisScheme": {
"type": "operation",
"input": {
"target": "com.amazonaws.cloudsearch#DeleteAnalysisSchemeRequest"
},
"output": {
"target": "com.amazonaws.cloudsearch#DeleteAnalysisSchemeResponse"
},
"errors": [
{
"target": "com.amazonaws.cloudsearch#BaseException"
},
{
"target": "com.amazonaws.cloudsearch#InternalException"
},
{
"target": "com.amazonaws.cloudsearch#InvalidTypeException"
},
{
"target": "com.amazonaws.cloudsearch#ResourceNotFoundException"
}
],
"traits": {
"smithy.api#documentation": "<p>Deletes an analysis scheme. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html\" target=\"_blank\">Configuring Analysis Schemes</a> in the <i>Amazon CloudSearch Developer Guide</i>. </p>"
}
},
"com.amazonaws.cloudsearch#DeleteAnalysisSchemeRequest": {
"type": "structure",
"members": {
"DomainName": {
"target": "com.amazonaws.cloudsearch#DomainName",
"traits": {
"smithy.api#required": {}
}
},
"AnalysisSchemeName": {
"target": "com.amazonaws.cloudsearch#StandardName",
"traits": {
"smithy.api#documentation": "<p>The name of the analysis scheme you want to delete.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Container for the parameters to the <code><a>DeleteAnalysisScheme</a></code> operation. Specifies the name of the domain you want to update and the analysis scheme you want to delete. </p>"
}
},
"com.amazonaws.cloudsearch#DeleteAnalysisSchemeResponse": {
"type": "structure",
"members": {
"AnalysisScheme": {
"target": "com.amazonaws.cloudsearch#AnalysisSchemeStatus",
"traits": {
"smithy.api#documentation": "<p>The status of the analysis scheme being deleted.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>The result of a <code>DeleteAnalysisScheme</code> request. Contains the status of the deleted analysis scheme.</p>"
}
},
"com.amazonaws.cloudsearch#DeleteDomain": {
"type": "operation",
"input": {
"target": "com.amazonaws.cloudsearch#DeleteDomainRequest"
},
"output": {
"target": "com.amazonaws.cloudsearch#DeleteDomainResponse"
},
"errors": [
{
"target": "com.amazonaws.cloudsearch#BaseException"
},
{
"target": "com.amazonaws.cloudsearch#InternalException"
}
],
"traits": {
"smithy.api#documentation": "<p>Permanently deletes a search domain and all of its data. Once a domain has been deleted, it cannot be recovered. For more information,\n see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/deleting-domains.html\" target=\"_blank\">Deleting a Search Domain</a> in the <i>Amazon CloudSearch Developer Guide</i>. </p>"
}
},
"com.amazonaws.cloudsearch#DeleteDomainRequest": {
"type": "structure",
"members": {
"DomainName": {
"target": "com.amazonaws.cloudsearch#DomainName",
"traits": {
"smithy.api#documentation": "<p>The name of the domain you want to permanently delete.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Container for the parameters to the <code><a>DeleteDomain</a></code> operation. Specifies the name of the domain you want to delete.</p>"
}
},
"com.amazonaws.cloudsearch#DeleteDomainResponse": {
"type": "structure",
"members": {
"DomainStatus": {
"target": "com.amazonaws.cloudsearch#DomainStatus"
}
},
"traits": {
"smithy.api#documentation": "<p>The result of a <code>DeleteDomain</code> request. Contains the status of a newly deleted domain, or no status if the domain has already been completely deleted.</p>"
}
},
"com.amazonaws.cloudsearch#DeleteExpression": {
"type": "operation",
"input": {
"target": "com.amazonaws.cloudsearch#DeleteExpressionRequest"
},
"output": {
"target": "com.amazonaws.cloudsearch#DeleteExpressionResponse"
},
"errors": [
{
"target": "com.amazonaws.cloudsearch#BaseException"
},
{
"target": "com.amazonaws.cloudsearch#InternalException"
},
{
"target": "com.amazonaws.cloudsearch#InvalidTypeException"
},
{
"target": "com.amazonaws.cloudsearch#ResourceNotFoundException"
}
],
"traits": {
"smithy.api#documentation": "<p>Removes an <code><a>Expression</a></code> from the search domain. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html\" target=\"_blank\">Configuring Expressions</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>"
}
},
"com.amazonaws.cloudsearch#DeleteExpressionRequest": {
"type": "structure",
"members": {
"DomainName": {
"target": "com.amazonaws.cloudsearch#DomainName",
"traits": {
"smithy.api#required": {}
}
},
"ExpressionName": {
"target": "com.amazonaws.cloudsearch#StandardName",
"traits": {
"smithy.api#documentation": "<p>The name of the <code><a>Expression</a></code> to delete.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Container for the parameters to the <code><a>DeleteExpression</a></code> operation. Specifies the name of the domain you want to update and the name of the expression you want to delete.</p>"
}
},
"com.amazonaws.cloudsearch#DeleteExpressionResponse": {
"type": "structure",
"members": {
"Expression": {
"target": "com.amazonaws.cloudsearch#ExpressionStatus",
"traits": {
"smithy.api#documentation": "<p>The status of the expression being deleted.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>The result of a <code><a>DeleteExpression</a></code> request. Specifies the expression being deleted.</p>"
}
},
"com.amazonaws.cloudsearch#DeleteIndexField": {
"type": "operation",
"input": {
"target": "com.amazonaws.cloudsearch#DeleteIndexFieldRequest"
},
"output": {
"target": "com.amazonaws.cloudsearch#DeleteIndexFieldResponse"
},
"errors": [
{
"target": "com.amazonaws.cloudsearch#BaseException"
},
{
"target": "com.amazonaws.cloudsearch#InternalException"
},
{
"target": "com.amazonaws.cloudsearch#InvalidTypeException"
},
{
"target": "com.amazonaws.cloudsearch#ResourceNotFoundException"
}
],
"traits": {
"smithy.api#documentation": "<p>Removes an <code><a>IndexField</a></code> from the search domain. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html\" target=\"_blank\">Configuring Index Fields</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>"
}
},
"com.amazonaws.cloudsearch#DeleteIndexFieldRequest": {
"type": "structure",
"members": {
"DomainName": {
"target": "com.amazonaws.cloudsearch#DomainName",
"traits": {
"smithy.api#required": {}
}
},
"IndexFieldName": {
"target": "com.amazonaws.cloudsearch#DynamicFieldName",
"traits": {
"smithy.api#documentation": "<p>The name of the index field your want to remove from the domain's indexing options.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Container for the parameters to the <code><a>DeleteIndexField</a></code> operation. Specifies the name of the domain you want to update and the name of the index field you want to delete.</p>"
}
},
"com.amazonaws.cloudsearch#DeleteIndexFieldResponse": {
"type": "structure",
"members": {
"IndexField": {
"target": "com.amazonaws.cloudsearch#IndexFieldStatus",
"traits": {
"smithy.api#documentation": "<p>The status of the index field being deleted.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>The result of a <code><a>DeleteIndexField</a></code> request.</p>"
}
},
"com.amazonaws.cloudsearch#DeleteSuggester": {
"type": "operation",
"input": {
"target": "com.amazonaws.cloudsearch#DeleteSuggesterRequest"
},
"output": {
"target": "com.amazonaws.cloudsearch#DeleteSuggesterResponse"
},
"errors": [
{
"target": "com.amazonaws.cloudsearch#BaseException"
},
{
"target": "com.amazonaws.cloudsearch#InternalException"
},
{
"target": "com.amazonaws.cloudsearch#InvalidTypeException"
},
{
"target": "com.amazonaws.cloudsearch#ResourceNotFoundException"
}
],
"traits": {
"smithy.api#documentation": "<p>Deletes a suggester. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html\" target=\"_blank\">Getting Search Suggestions</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>"
}
},
"com.amazonaws.cloudsearch#DeleteSuggesterRequest": {
"type": "structure",
"members": {
"DomainName": {
"target": "com.amazonaws.cloudsearch#DomainName",
"traits": {
"smithy.api#required": {}
}
},
"SuggesterName": {
"target": "com.amazonaws.cloudsearch#StandardName",
"traits": {
"smithy.api#documentation": "<p>Specifies the name of the suggester you want to delete.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Container for the parameters to the <code><a>DeleteSuggester</a></code> operation. Specifies the name of the domain you want to update and name of the suggester you want to delete.</p>"
}
},
"com.amazonaws.cloudsearch#DeleteSuggesterResponse": {
"type": "structure",
"members": {
"Suggester": {
"target": "com.amazonaws.cloudsearch#SuggesterStatus",
"traits": {
"smithy.api#documentation": "<p>The status of the suggester being deleted.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>The result of a <code>DeleteSuggester</code> request. Contains the status of the deleted suggester.</p>"
}
},
"com.amazonaws.cloudsearch#DescribeAnalysisSchemes": {
"type": "operation",
"input": {
"target": "com.amazonaws.cloudsearch#DescribeAnalysisSchemesRequest"
},
"output": {
"target": "com.amazonaws.cloudsearch#DescribeAnalysisSchemesResponse"
},
"errors": [
{
"target": "com.amazonaws.cloudsearch#BaseException"
},
{
"target": "com.amazonaws.cloudsearch#InternalException"
},
{
"target": "com.amazonaws.cloudsearch#ResourceNotFoundException"
}
],
"traits": {
"smithy.api#documentation": "<p>Gets the analysis schemes configured for a domain. An analysis scheme defines language-specific text processing options for a <code>text</code> field. Can be limited to specific analysis schemes by name. By default, shows all analysis schemes and includes any pending changes to the configuration. Set the <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html\" target=\"_blank\">Configuring Analysis Schemes</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>"
}
},
"com.amazonaws.cloudsearch#DescribeAnalysisSchemesRequest": {
"type": "structure",
"members": {
"DomainName": {
"target": "com.amazonaws.cloudsearch#DomainName",
"traits": {
"smithy.api#documentation": "<p>The name of the domain you want to describe.</p>",
"smithy.api#required": {}
}
},
"AnalysisSchemeNames": {
"target": "com.amazonaws.cloudsearch#StandardNameList",
"traits": {
"smithy.api#documentation": "<p>The analysis schemes you want to describe.</p>"
}
},
"Deployed": {
"target": "com.amazonaws.cloudsearch#Boolean",
"traits": {
"smithy.api#documentation": "<p>Whether to display the deployed configuration (<code>true</code>) or include any pending changes (<code>false</code>). Defaults to <code>false</code>.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Container for the parameters to the <code><a>DescribeAnalysisSchemes</a></code> operation. Specifies the name of the domain you want to describe. To limit the response to particular analysis schemes, specify the names of the analysis schemes you want to describe. To show the active configuration and exclude any pending changes, set the <code>Deployed</code> option to <code>true</code>. </p>"
}
},
"com.amazonaws.cloudsearch#DescribeAnalysisSchemesResponse": {
"type": "structure",
"members": {
"AnalysisSchemes": {
"target": "com.amazonaws.cloudsearch#AnalysisSchemeStatusList",
"traits": {
"smithy.api#documentation": "<p>The analysis scheme descriptions.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>The result of a <code>DescribeAnalysisSchemes</code> request. Contains the analysis schemes configured for the domain specified in the request.</p>"
}
},
"com.amazonaws.cloudsearch#DescribeAvailabilityOptions": {
"type": "operation",
"input": {
"target": "com.amazonaws.cloudsearch#DescribeAvailabilityOptionsRequest"
},
"output": {
"target": "com.amazonaws.cloudsearch#DescribeAvailabilityOptionsResponse"
},
"errors": [
{
"target": "com.amazonaws.cloudsearch#BaseException"
},
{
"target": "com.amazonaws.cloudsearch#DisabledOperationException"
},
{
"target": "com.amazonaws.cloudsearch#InternalException"
},
{
"target": "com.amazonaws.cloudsearch#InvalidTypeException"
},
{
"target": "com.amazonaws.cloudsearch#LimitExceededException"
},
{
"target": "com.amazonaws.cloudsearch#ResourceNotFoundException"
}
],
"traits": {
"smithy.api#documentation": "<p>Gets the availability options configured for a domain. By default, shows the configuration with any pending changes. Set the <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-availability-options.html\" target=\"_blank\">Configuring Availability Options</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>"
}
},
"com.amazonaws.cloudsearch#DescribeAvailabilityOptionsRequest": {
"type": "structure",
"members": {
"DomainName": {
"target": "com.amazonaws.cloudsearch#DomainName",
"traits": {
"smithy.api#documentation": "<p>The name of the domain you want to describe.</p>",
"smithy.api#required": {}
}
},
"Deployed": {
"target": "com.amazonaws.cloudsearch#Boolean",
"traits": {
"smithy.api#documentation": "<p>Whether to display the deployed configuration (<code>true</code>) or include any pending changes (<code>false</code>). Defaults to <code>false</code>.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Container for the parameters to the <code><a>DescribeAvailabilityOptions</a></code> 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 <code>true</code>.</p>"
}
},
"com.amazonaws.cloudsearch#DescribeAvailabilityOptionsResponse": {
"type": "structure",
"members": {
"AvailabilityOptions": {
"target": "com.amazonaws.cloudsearch#AvailabilityOptionsStatus",
"traits": {
"smithy.api#documentation": "<p>The availability options configured for the domain. Indicates whether Multi-AZ is enabled for the domain. </p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The result of a <code>DescribeAvailabilityOptions</code> request. Indicates whether or not the Multi-AZ option is enabled for the domain specified in the request. </p>"
}
},
"com.amazonaws.cloudsearch#DescribeDomainEndpointOptions": {
"type": "operation",
"input": {
"target": "com.amazonaws.cloudsearch#DescribeDomainEndpointOptionsRequest"
},
"output": {
"target": "com.amazonaws.cloudsearch#DescribeDomainEndpointOptionsResponse"
},
"errors": [
{
"target": "com.amazonaws.cloudsearch#BaseException"
},
{
"target": "com.amazonaws.cloudsearch#DisabledOperationException"
},
{
"target": "com.amazonaws.cloudsearch#InternalException"
},
{
"target": "com.amazonaws.cloudsearch#LimitExceededException"
},
{
"target": "com.amazonaws.cloudsearch#ResourceNotFoundException"
}
],
"traits": {
"smithy.api#documentation": "<p>Returns the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-domain-endpoint-options.html\" target=\"_blank\">Configuring Domain Endpoint Options</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>"
}
},
"com.amazonaws.cloudsearch#DescribeDomainEndpointOptionsRequest": {
"type": "structure",
"members": {
"DomainName": {
"target": "com.amazonaws.cloudsearch#DomainName",
"traits": {
"smithy.api#documentation": "<p>A string that represents the name of a domain.</p>",
"smithy.api#required": {}
}
},
"Deployed": {
"target": "com.amazonaws.cloudsearch#Boolean",
"traits": {
"smithy.api#documentation": "<p>Whether to retrieve the latest configuration (which might be in a Processing state) or the current, active configuration. Defaults to <code>false</code>.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Container for the parameters to the <code><a>DescribeDomainEndpointOptions</a></code> operation. Specify the name of the domain you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to <code>true</code>.</p>"
}
},
"com.amazonaws.cloudsearch#DescribeDomainEndpointOptionsResponse": {
"type": "structure",
"members": {
"DomainEndpointOptions": {
"target": "com.amazonaws.cloudsearch#DomainEndpointOptionsStatus",
"traits": {
"smithy.api#documentation": "<p>The status and configuration of a search domain's endpoint options.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The result of a <code>DescribeDomainEndpointOptions</code> request. Contains the status and configuration of a search domain's endpoint options. </p>"
}
},
"com.amazonaws.cloudsearch#DescribeDomains": {
"type": "operation",
"input": {
"target": "com.amazonaws.cloudsearch#DescribeDomainsRequest"
},
"output": {
"target": "com.amazonaws.cloudsearch#DescribeDomainsResponse"
},
"errors": [
{
"target": "com.amazonaws.cloudsearch#BaseException"
},
{
"target": "com.amazonaws.cloudsearch#InternalException"
}
],
"traits": {
"smithy.api#documentation": "<p>Gets information about the search domains owned by this account. Can be limited to specific domains. Shows\n all domains by default. To get the number of searchable documents in a domain, use the console or submit a <code>matchall</code> request to your domain's search endpoint: <code>q=matchall&amp;q.parser=structured&amp;size=0</code>. For more information,\n see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-domain-info.html\" target=\"_blank\">Getting Information about a Search Domain</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>"
}
},
"com.amazonaws.cloudsearch#DescribeDomainsRequest": {
"type": "structure",
"members": {
"DomainNames": {
"target": "com.amazonaws.cloudsearch#DomainNameList",
"traits": {
"smithy.api#documentation": "<p>The names of the domains you want to include in the response.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Container for the parameters to the <code><a>DescribeDomains</a></code> operation. By default shows the status of all domains. To restrict the response to particular domains, specify the names of the domains you want to describe.</p>"
}
},
"com.amazonaws.cloudsearch#DescribeDomainsResponse": {
"type": "structure",
"members": {
"DomainStatusList": {
"target": "com.amazonaws.cloudsearch#DomainStatusList",
"traits": {
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>The result of a <code>DescribeDomains</code> request. Contains the status of the domains specified in the request or all domains owned by the account.</p>"
}
},
"com.amazonaws.cloudsearch#DescribeExpressions": {
"type": "operation",
"input": {
"target": "com.amazonaws.cloudsearch#DescribeExpressionsRequest"
},
"output": {
"target": "com.amazonaws.cloudsearch#DescribeExpressionsResponse"
},
"errors": [
{
"target": "com.amazonaws.cloudsearch#BaseException"
},
{
"target": "com.amazonaws.cloudsearch#InternalException"
},
{
"target": "com.amazonaws.cloudsearch#ResourceNotFoundException"
}
],
"traits": {
"smithy.api#documentation": "<p>Gets the expressions configured for the search domain. Can be limited to specific expressions by name. By default, shows all expressions and includes any pending changes to the configuration. Set the <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html\" target=\"_blank\">Configuring Expressions</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>"
}
},
"com.amazonaws.cloudsearch#DescribeExpressionsRequest": {
"type": "structure",
"members": {
"DomainName": {
"target": "com.amazonaws.cloudsearch#DomainName",
"traits": {
"smithy.api#documentation": "<p>The name of the domain you want to describe.</p>",
"smithy.api#required": {}
}
},
"ExpressionNames": {
"target": "com.amazonaws.cloudsearch#StandardNameList",
"traits": {
"smithy.api#documentation": "<p>Limits the <code><a>DescribeExpressions</a></code> response to the specified expressions. If not specified, all expressions are shown.</p>"
}
},
"Deployed": {
"target": "com.amazonaws.cloudsearch#Boolean",
"traits": {
"smithy.api#documentation": "<p>Whether to display the deployed configuration (<code>true</code>) or include any pending changes (<code>false</code>). Defaults to <code>false</code>.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Container for the parameters to the <code><a>DescribeDomains</a></code> operation.\n Specifies the name of the domain you want to describe. To restrict the response to particular expressions, specify the names of the expressions you want to describe. To show the active configuration and exclude any pending changes, set the <code>Deployed</code> option to <code>true</code>.</p>"
}
},
"com.amazonaws.cloudsearch#DescribeExpressionsResponse": {
"type": "structure",
"members": {
"Expressions": {
"target": "com.amazonaws.cloudsearch#ExpressionStatusList",
"traits": {
"smithy.api#documentation": "<p>The expressions configured for the domain.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>The result of a <code>DescribeExpressions</code> request. Contains the expressions configured for the domain specified in the request.</p>"
}
},
"com.amazonaws.cloudsearch#DescribeIndexFields": {
"type": "operation",
"input": {
"target": "com.amazonaws.cloudsearch#DescribeIndexFieldsRequest"
},
"output": {
"target": "com.amazonaws.cloudsearch#DescribeIndexFieldsResponse"
},
"errors": [
{
"target": "com.amazonaws.cloudsearch#BaseException"
},
{
"target": "com.amazonaws.cloudsearch#InternalException"
},
{
"target": "com.amazonaws.cloudsearch#ResourceNotFoundException"
}
],
"traits": {
"smithy.api#documentation": "<p>Gets information about the index fields configured for the search domain.\n Can be limited to specific fields by name. By default, shows all fields and includes any pending changes to the configuration. Set the <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information,\n see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-domain-info.html\" target=\"_blank\">Getting Domain Information</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>"
}
},
"com.amazonaws.cloudsearch#DescribeIndexFieldsRequest": {
"type": "structure",
"members": {
"DomainName": {
"target": "com.amazonaws.cloudsearch#DomainName",
"traits": {
"smithy.api#documentation": "<p>The name of the domain you want to describe.</p>",
"smithy.api#required": {}
}
},
"FieldNames": {
"target": "com.amazonaws.cloudsearch#DynamicFieldNameList",
"traits": {
"smithy.api#documentation": "<p>A list of the index fields you want to describe. If not specified, information is returned for all configured index fields.</p>"
}
},
"Deployed": {
"target": "com.amazonaws.cloudsearch#Boolean",
"traits": {
"smithy.api#documentation": "<p>Whether to display the deployed configuration (<code>true</code>) or include any pending changes (<code>false</code>). Defaults to <code>false</code>.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Container for the parameters to the <code><a>DescribeIndexFields</a></code> operation. Specifies the name of the domain you want to describe. To restrict the response to particular index fields, specify the names of the index fields you want to describe. To show the active configuration and exclude any pending changes, set the <code>Deployed</code> option to <code>true</code>.</p>"
}
},
"com.amazonaws.cloudsearch#DescribeIndexFieldsResponse": {
"type": "structure",
"members": {
"IndexFields": {
"target": "com.amazonaws.cloudsearch#IndexFieldStatusList",
"traits": {
"smithy.api#documentation": "<p>The index fields configured for the domain.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>The result of a <code>DescribeIndexFields</code> request. Contains the index fields configured for the domain specified in the request.</p>"
}
},
"com.amazonaws.cloudsearch#DescribeScalingParameters": {
"type": "operation",
"input": {
"target": "com.amazonaws.cloudsearch#DescribeScalingParametersRequest"
},
"output": {
"target": "com.amazonaws.cloudsearch#DescribeScalingParametersResponse"
},
"errors": [
{
"target": "com.amazonaws.cloudsearch#BaseException"
},
{
"target": "com.amazonaws.cloudsearch#InternalException"
},
{
"target": "com.amazonaws.cloudsearch#ResourceNotFoundException"
}
],
"traits": {
"smithy.api#documentation": "<p>Gets the scaling parameters configured for a domain. A domain's scaling parameters specify the desired search instance type and replication count. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-scaling-options.html\" target=\"_blank\">Configuring Scaling Options</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>"
}
},
"com.amazonaws.cloudsearch#DescribeScalingParametersRequest": {
"type": "structure",
"members": {
"DomainName": {
"target": "com.amazonaws.cloudsearch#DomainName",
"traits": {
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Container for the parameters to the <code><a>DescribeScalingParameters</a></code> operation. Specifies the name of the domain you want to describe. </p>"
}
},
"com.amazonaws.cloudsearch#DescribeScalingParametersResponse": {
"type": "structure",
"members": {
"ScalingParameters": {
"target": "com.amazonaws.cloudsearch#ScalingParametersStatus",
"traits": {
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>The result of a <code>DescribeScalingParameters</code> request. Contains the scaling parameters configured for the domain specified in the request.</p>"
}
},
"com.amazonaws.cloudsearch#DescribeServiceAccessPolicies": {
"type": "operation",
"input": {
"target": "com.amazonaws.cloudsearch#DescribeServiceAccessPoliciesRequest"
},
"output": {
"target": "com.amazonaws.cloudsearch#DescribeServiceAccessPoliciesResponse"
},
"errors": [
{
"target": "com.amazonaws.cloudsearch#BaseException"
},
{
"target": "com.amazonaws.cloudsearch#InternalException"
},
{
"target": "com.amazonaws.cloudsearch#ResourceNotFoundException"
}
],
"traits": {
"smithy.api#documentation": "<p>Gets information about the access policies that control access to the domain's document and search endpoints. By default, shows the configuration with any pending changes. Set the <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information,\n see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html\" target=\"_blank\">Configuring Access for a Search Domain</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>"
}
},
"com.amazonaws.cloudsearch#DescribeServiceAccessPoliciesRequest": {
"type": "structure",
"members": {
"DomainName": {
"target": "com.amazonaws.cloudsearch#DomainName",
"traits": {
"smithy.api#documentation": "<p>The name of the domain you want to describe.</p>",
"smithy.api#required": {}
}
},
"Deployed": {
"target": "com.amazonaws.cloudsearch#Boolean",
"traits": {
"smithy.api#documentation": "<p>Whether to display the deployed configuration (<code>true</code>) or include any pending changes (<code>false</code>). Defaults to <code>false</code>.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Container for the parameters to the <code><a>DescribeServiceAccessPolicies</a></code> operation. Specifies the name of the domain you want to describe. To show the active configuration and exclude any pending changes, set the <code>Deployed</code> option to <code>true</code>.</p>"
}
},
"com.amazonaws.cloudsearch#DescribeServiceAccessPoliciesResponse": {
"type": "structure",
"members": {
"AccessPolicies": {
"target": "com.amazonaws.cloudsearch#AccessPoliciesStatus",
"traits": {
"smithy.api#documentation": "<p>The access rules configured for the domain specified in the request.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>The result of a <code>DescribeServiceAccessPolicies</code> request.</p>"
}
},
"com.amazonaws.cloudsearch#DescribeSuggesters": {
"type": "operation",
"input": {
"target": "com.amazonaws.cloudsearch#DescribeSuggestersRequest"
},
"output": {
"target": "com.amazonaws.cloudsearch#DescribeSuggestersResponse"
},
"errors": [
{
"target": "com.amazonaws.cloudsearch#BaseException"
},
{
"target": "com.amazonaws.cloudsearch#InternalException"
},
{
"target": "com.amazonaws.cloudsearch#ResourceNotFoundException"
}
],
"traits": {
"smithy.api#documentation": "<p>Gets the suggesters configured for a domain. A suggester enables you to display possible matches before users finish typing their queries. Can be limited to specific suggesters by name. By default, shows all suggesters and includes any pending changes to the configuration. Set the <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html\" target=\"_blank\">Getting Search Suggestions</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>"
}
},
"com.amazonaws.cloudsearch#DescribeSuggestersRequest": {
"type": "structure",
"members": {
"DomainName": {
"target": "com.amazonaws.cloudsearch#DomainName",
"traits": {
"smithy.api#documentation": "<p>The name of the domain you want to describe.</p>",
"smithy.api#required": {}
}
},
"SuggesterNames": {
"target": "com.amazonaws.cloudsearch#StandardNameList",
"traits": {
"smithy.api#documentation": "<p>The suggesters you want to describe.</p>"
}
},
"Deployed": {
"target": "com.amazonaws.cloudsearch#Boolean",
"traits": {
"smithy.api#documentation": "<p>Whether to display the deployed configuration (<code>true</code>) or include any pending changes (<code>false</code>). Defaults to <code>false</code>.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Container for the parameters to the <code><a>DescribeSuggester</a></code> operation. Specifies the name of the domain you want to describe. To restrict the response to particular suggesters, specify the names of the suggesters you want to describe. To show the active configuration and exclude any pending changes, set the <code>Deployed</code> option to <code>true</code>.</p>"
}
},
"com.amazonaws.cloudsearch#DescribeSuggestersResponse": {
"type": "structure",
"members": {
"Suggesters": {
"target": "com.amazonaws.cloudsearch#SuggesterStatusList",
"traits": {
"smithy.api#documentation": "<p>The suggesters configured for the domain specified in the request.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>The result of a <code>DescribeSuggesters</code> request.</p>"
}
},
"com.amazonaws.cloudsearch#DisabledOperationException": {
"type": "structure",
"members": {
"Code": {
"target": "com.amazonaws.cloudsearch#ErrorCode"
},
"Message": {
"target": "com.amazonaws.cloudsearch#ErrorMessage"
}
},
"traits": {
"smithy.api#documentation": "<p>The request was rejected because it attempted an operation which is not enabled.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 409
}
},
"com.amazonaws.cloudsearch#DocumentSuggesterOptions": {
"type": "structure",
"members": {
"SourceField": {
"target": "com.amazonaws.cloudsearch#FieldName",
"traits": {
"smithy.api#documentation": "<p>The name of the index field you want to use for suggestions.\n </p>",
"smithy.api#required": {}
}
},
"FuzzyMatching": {
"target": "com.amazonaws.cloudsearch#SuggesterFuzzyMatching",
"traits": {
"smithy.api#documentation": "<p>The level of fuzziness allowed when suggesting matches for a string: <code>none</code>, <code>low</code>, or <code>high</code>. With none, the specified string is treated as an exact prefix. With low, suggestions must differ from the specified string by no more than one character. With high, suggestions can differ by up to two characters. The default is none. </p>"
}
},
"SortExpression": {
"target": "com.amazonaws.cloudsearch#String",
"traits": {
"smithy.api#documentation": "<p>An expression that computes a score for each suggestion to control how they are sorted. The scores are rounded to the nearest\n integer, with a floor of 0 and a ceiling of 2^31-1. A document's relevance score is not computed\n for suggestions, so sort expressions cannot reference the <code>_score</code> value.\n To sort suggestions using a numeric field or existing expression, simply specify\n the name of the field or expression. If no expression is configured for the suggester, the\n suggestions are sorted with the closest matches listed first.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Options for a search suggester.</p>"
}
},
"com.amazonaws.cloudsearch#DomainEndpointOptions": {
"type": "structure",
"members": {
"EnforceHTTPS": {
"target": "com.amazonaws.cloudsearch#Boolean",
"traits": {
"smithy.api#documentation": "<p>Whether the domain is HTTPS only enabled.</p>"
}
},
"TLSSecurityPolicy": {
"target": "com.amazonaws.cloudsearch#TLSSecurityPolicy",
"traits": {
"smithy.api#documentation": "<p>The minimum required TLS version</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The domain's endpoint options.</p>"
}
},
"com.amazonaws.cloudsearch#DomainEndpointOptionsStatus": {
"type": "structure",
"members": {
"Options": {
"target": "com.amazonaws.cloudsearch#DomainEndpointOptions",
"traits": {
"smithy.api#documentation": "<p>The domain endpoint options configured for the domain.</p>",
"smithy.api#required": {}
}
},
"Status": {
"target": "com.amazonaws.cloudsearch#OptionStatus",
"traits": {
"smithy.api#documentation": "<p>The status of the configured domain endpoint options.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>The configuration and status of the domain's endpoint options.</p>"
}
},
"com.amazonaws.cloudsearch#DomainId": {
"type": "string",
"traits": {
"smithy.api#documentation": "<p>An internally generated unique identifier for a domain.</p>",
"smithy.api#length": {
"min": 1,
"max": 64
}
}
},
"com.amazonaws.cloudsearch#DomainName": {
"type": "string",
"traits": {
"smithy.api#documentation": "<p>A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).</p>",
"smithy.api#length": {
"min": 3,
"max": 28
},
"smithy.api#pattern": "[a-z][a-z0-9\\-]+"
}
},
"com.amazonaws.cloudsearch#DomainNameList": {
"type": "list",
"member": {
"target": "com.amazonaws.cloudsearch#DomainName"
},
"traits": {
"smithy.api#documentation": "<p>A list of domain names.</p>"
}
},
"com.amazonaws.cloudsearch#DomainNameMap": {
"type": "map",
"key": {
"target": "com.amazonaws.cloudsearch#DomainName"
},
"value": {
"target": "com.amazonaws.cloudsearch#APIVersion"
},
"traits": {
"smithy.api#documentation": "<p>A collection of domain names.</p>"
}
},
"com.amazonaws.cloudsearch#DomainStatus": {
"type": "structure",
"members": {
"DomainId": {
"target": "com.amazonaws.cloudsearch#DomainId",
"traits": {
"smithy.api#required": {}
}
},
"DomainName": {
"target": "com.amazonaws.cloudsearch#DomainName",
"traits": {
"smithy.api#required": {}
}
},
"ARN": {
"target": "com.amazonaws.cloudsearch#ARN"
},
"Created": {
"target": "com.amazonaws.cloudsearch#Boolean",
"traits": {
"smithy.api#documentation": "<p>True if the search domain is created. It can take several minutes to initialize a domain when <a>CreateDomain</a> is called. Newly created search domains are returned from <a>DescribeDomains</a> with a false value for Created until domain creation is complete.</p>"
}
},
"Deleted": {
"target": "com.amazonaws.cloudsearch#Boolean",
"traits": {
"smithy.api#documentation": "<p>True if the search domain has been deleted. The system must clean up resources dedicated to the search domain when <a>DeleteDomain</a> is called. Newly deleted search domains are returned from <a>DescribeDomains</a> with a true value for IsDeleted for several minutes until resource cleanup is complete.</p>"
}
},
"DocService": {
"target": "com.amazonaws.cloudsearch#ServiceEndpoint",
"traits": {
"smithy.api#documentation": "<p>The service endpoint for updating documents in a search domain.</p>"
}
},
"SearchService": {
"target": "com.amazonaws.cloudsearch#ServiceEndpoint",
"traits": {
"smithy.api#documentation": "<p>The service endpoint for requesting search results from a search domain.</p>"
}
},
"RequiresIndexDocuments": {
"target": "com.amazonaws.cloudsearch#Boolean",
"traits": {
"smithy.api#documentation": "<p>True if <a>IndexDocuments</a> needs to be called to activate the current domain configuration.</p>",
"smithy.api#required": {}
}
},
"Processing": {
"target": "com.amazonaws.cloudsearch#Boolean",
"traits": {
"smithy.api#documentation": "<p>True if processing is being done to activate the current domain configuration.</p>"
}
},
"SearchInstanceType": {
"target": "com.amazonaws.cloudsearch#SearchInstanceType",
"traits": {
"smithy.api#documentation": "<p>The instance type that is being used to process search requests.</p>"
}
},
"SearchPartitionCount": {
"target": "com.amazonaws.cloudsearch#PartitionCount",
"traits": {
"smithy.api#documentation": "<p>The number of partitions across which the search index is spread.</p>"
}
},
"SearchInstanceCount": {
"target": "com.amazonaws.cloudsearch#InstanceCount",
"traits": {
"smithy.api#documentation": "<p>The number of search instances that are available to process search requests.</p>"
}
},
"Limits": {
"target": "com.amazonaws.cloudsearch#Limits"
}
},
"traits": {
"smithy.api#documentation": "<p>The current status of the search domain.</p>"
}
},
"com.amazonaws.cloudsearch#DomainStatusList": {
"type": "list",
"member": {
"target": "com.amazonaws.cloudsearch#DomainStatus"
},
"traits": {
"smithy.api#documentation": "<p>A list that contains the status of each requested domain.</p>"
}
},
"com.amazonaws.cloudsearch#Double": {
"type": "double",
"traits": {
"smithy.api#box": {}
}
},
"com.amazonaws.cloudsearch#DoubleArrayOptions": {
"type": "structure",
"members": {
"DefaultValue": {
"target": "com.amazonaws.cloudsearch#Double",
"traits": {
"smithy.api#documentation": "A value to use for the field if the field isn't specified for a document."
}
},
"SourceFields": {
"target": "com.amazonaws.cloudsearch#FieldNameCommaList",
"traits": {
"smithy.api#documentation": "<p>A list of source fields to map to the field. </p>"
}
},
"FacetEnabled": {
"target": "com.amazonaws.cloudsearch#Boolean",
"traits": {
"smithy.api#documentation": "<p>Whether facet information can be returned for the field.</p>"
}
},
"SearchEnabled": {
"target": "com.amazonaws.cloudsearch#Boolean",
"traits": {
"smithy.api#documentation": "<p>Whether the contents of the field are searchable.</p>"
}
},
"ReturnEnabled": {
"target": "com.amazonaws.cloudsearch#Boolean",
"traits": {
"smithy.api#documentation": "<p>Whether the contents of the field can be returned in the search results.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Options for a field that contains an array of double-precision 64-bit floating point values. Present if <code>IndexFieldType</code> specifies the field is of type <code>double-array</code>. All options are enabled by default.</p>"
}
},
"com.amazonaws.cloudsearch#DoubleOptions": {
"type": "structure",
"members": {
"DefaultValue": {
"target": "com.amazonaws.cloudsearch#Double",
"traits": {
"smithy.api#documentation": "<p>A value to use for the field if the field isn't specified for a document. This can be important if you are using the field in an expression and that field is not present in every document.</p>"
}
},
"SourceField": {
"target": "com.amazonaws.cloudsearch#FieldName",
"traits": {
"smithy.api#documentation": "<p>The name of the source field to map to the field. </p>"
}
},
"FacetEnabled": {
"target": "com.amazonaws.cloudsearch#Boolean",
"traits": {
"smithy.api#documentation": "<p>Whether facet information can be returned for the field.</p>"
}
},
"SearchEnabled": {
"target": "com.amazonaws.cloudsearch#Boolean",
"traits": {
"smithy.api#documentation": "<p>Whether the contents of the field are searchable.</p>"
}
},
"ReturnEnabled": {
"target": "com.amazonaws.cloudsearch#Boolean",
"traits": {
"smithy.api#documentation": "<p>Whether the contents of the field can be returned in the search results.</p>"
}
},
"SortEnabled": {
"target": "com.amazonaws.cloudsearch#Boolean",
"traits": {
"smithy.api#documentation": "<p>Whether the field can be used to sort the search results.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Options for a double-precision 64-bit floating point field. Present if <code>IndexFieldType</code> specifies the field is of type <code>double</code>. All options are enabled by default.</p>"
}
},
"com.amazonaws.cloudsearch#DynamicFieldName": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 64
},
"smithy.api#pattern": "([a-z][a-z0-9_]*\\*?|\\*[a-z0-9_]*)"
}
},
"com.amazonaws.cloudsearch#DynamicFieldNameList": {
"type": "list",
"member": {
"target": "com.amazonaws.cloudsearch#DynamicFieldName"
}
},
"com.amazonaws.cloudsearch#ErrorCode": {
"type": "string",
"traits": {
"smithy.api#documentation": "<p>A machine-parsable string error or warning code.</p>"
}
},
"com.amazonaws.cloudsearch#ErrorMessage": {
"type": "string",
"traits": {
"smithy.api#documentation": "<p>A human-readable string error or warning message.</p>"
}
},
"com.amazonaws.cloudsearch#Expression": {
"type": "structure",
"members": {
"ExpressionName": {
"target": "com.amazonaws.cloudsearch#StandardName",
"traits": {
"smithy.api#required": {}
}
},
"ExpressionValue": {
"target": "com.amazonaws.cloudsearch#ExpressionValue",
"traits": {
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>A named expression that can be evaluated at search time. Can be used to sort the search results, define other expressions, or return computed information in the search results. </p>"
}
},
"com.amazonaws.cloudsearch#ExpressionStatus": {
"type": "structure",
"members": {
"Options": {
"target": "com.amazonaws.cloudsearch#Expression",
"traits": {
"smithy.api#documentation": "<p>The expression that is evaluated for sorting while processing a search request.</p>",
"smithy.api#required": {}
}
},
"Status": {
"target": "com.amazonaws.cloudsearch#OptionStatus",
"traits": {
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>The value of an <code>Expression</code> and its current status.</p>"
}
},
"com.amazonaws.cloudsearch#ExpressionStatusList": {
"type": "list",
"member": {
"target": "com.amazonaws.cloudsearch#ExpressionStatus"
},
"traits": {
"smithy.api#documentation": "<p>Contains the status of multiple expressions.</p>"
}
},
"com.amazonaws.cloudsearch#ExpressionValue": {
"type": "string",
"traits": {
"smithy.api#documentation": "<p>The expression to evaluate for sorting while processing a search request. The <code>Expression</code> syntax is based on JavaScript expressions. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html\" target=\"_blank\">Configuring Expressions</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>",
"smithy.api#length": {
"min": 1,
"max": 10240
}
}
},
"com.amazonaws.cloudsearch#FieldName": {
"type": "string",
"traits": {
"smithy.api#documentation": "<p>A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields.\n A dynamic field's name defines a pattern that begins or ends with a wildcard.\n Any document fields that don't map to a regular index field but do match a\t\n dynamic field's pattern are configured with the dynamic field's indexing options.\n </p>\n <p>Regular field names begin with a letter and can contain the following characters:\n a-z (lowercase), 0-9, and _ (underscore).\n Dynamic field names must begin or end with a wildcard (*).\n The wildcard can also be the only character in a dynamic field name.\n Multiple wildcards, and wildcards embedded within a string are not supported.\n </p>\n <p>The name <code>score</code> is reserved and cannot be used as a field name.\n To reference a document's ID, you can use the name <code>_id</code>.\n </p>",
"smithy.api#length": {
"min": 1,
"max": 64
},
"smithy.api#pattern": "[a-z][a-z0-9_]*"
}
},
"com.amazonaws.cloudsearch#FieldNameCommaList": {
"type": "string",
"traits": {
"smithy.api#pattern": "\\s*[a-z*][a-z0-9_]*\\*?\\s*(,\\s*[a-z*][a-z0-9_]*\\*?\\s*)*"
}
},
"com.amazonaws.cloudsearch#FieldNameList": {
"type": "list",
"member": {
"target": "com.amazonaws.cloudsearch#FieldName"
},
"traits": {
"smithy.api#documentation": "<p>A list of field names.</p>"
}
},
"com.amazonaws.cloudsearch#FieldValue": {
"type": "string",
"traits": {
"smithy.api#documentation": "<p>The value of a field attribute.</p>",
"smithy.api#length": {
"min": 0,
"max": 1024
}
}
},
"com.amazonaws.cloudsearch#IndexDocuments": {
"type": "operation",
"input": {
"target": "com.amazonaws.cloudsearch#IndexDocumentsRequest"
},
"output": {
"target": "com.amazonaws.cloudsearch#IndexDocumentsResponse"
},
"errors": [
{
"target": "com.amazonaws.cloudsearch#BaseException"
},
{
"target": "com.amazonaws.cloudsearch#InternalException"
},
{
"target": "com.amazonaws.cloudsearch#ResourceNotFoundException"
}
],
"traits": {
"smithy.api#documentation": "<p>Tells the search domain to start indexing its documents using the latest indexing options. This operation must be invoked to activate options whose <a>OptionStatus</a> is <code>RequiresIndexDocuments</code>.</p>"
}
},
"com.amazonaws.cloudsearch#IndexDocumentsRequest": {
"type": "structure",
"members": {
"DomainName": {
"target": "com.amazonaws.cloudsearch#DomainName",
"traits": {
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Container for the parameters to the <code><a>IndexDocuments</a></code> operation. Specifies the name of the domain you want to re-index.</p>"
}
},
"com.amazonaws.cloudsearch#IndexDocumentsResponse": {
"type": "structure",
"members": {
"FieldNames": {
"target": "com.amazonaws.cloudsearch#FieldNameList",
"traits": {
"smithy.api#documentation": "<p>The names of the fields that are currently being indexed.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The result of an <code>IndexDocuments</code> request. Contains the status of the indexing operation, including the fields being indexed.</p>"
}
},
"com.amazonaws.cloudsearch#IndexField": {
"type": "structure",
"members": {
"IndexFieldName": {
"target": "com.amazonaws.cloudsearch#DynamicFieldName",
"traits": {
"smithy.api#documentation": "<p>A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields.\n A dynamic field's name defines a pattern that begins or ends with a wildcard.\n Any document fields that don't map to a regular index field but do match a\t\n dynamic field's pattern are configured with the dynamic field's indexing options.\n </p>\n <p>Regular field names begin with a letter and can contain the following characters:\n a-z (lowercase), 0-9, and _ (underscore).\n Dynamic field names must begin or end with a wildcard (*).\n The wildcard can also be the only character in a dynamic field name.\n Multiple wildcards, and wildcards embedded within a string are not supported.\n </p>\n <p>The name <code>score</code> is reserved and cannot be used as a field name.\n To reference a document's ID, you can use the name <code>_id</code>.\n </p>",
"smithy.api#required": {}
}
},
"IndexFieldType": {
"target": "com.amazonaws.cloudsearch#IndexFieldType",
"traits": {
"smithy.api#required": {}
}
},
"IntOptions": {
"target": "com.amazonaws.cloudsearch#IntOptions"
},
"DoubleOptions": {
"target": "com.amazonaws.cloudsearch#DoubleOptions"
},
"LiteralOptions": {
"target": "com.amazonaws.cloudsearch#LiteralOptions"
},
"TextOptions": {
"target": "com.amazonaws.cloudsearch#TextOptions"
},
"DateOptions": {
"target": "com.amazonaws.cloudsearch#DateOptions"
},
"LatLonOptions": {
"target": "com.amazonaws.cloudsearch#LatLonOptions"
},
"IntArrayOptions": {
"target": "com.amazonaws.cloudsearch#IntArrayOptions"
},
"DoubleArrayOptions": {
"target": "com.amazonaws.cloudsearch#DoubleArrayOptions"
},
"LiteralArrayOptions": {
"target": "com.amazonaws.cloudsearch#LiteralArrayOptions"
},
"TextArrayOptions": {
"target": "com.amazonaws.cloudsearch#TextArrayOptions"
},
"DateArrayOptions": {
"target": "com.amazonaws.cloudsearch#DateArrayOptions"
}
},
"traits": {
"smithy.api#documentation": "<p>Configuration information for a field in the index, including its name, type, and options. The supported options depend on the <code><a>IndexFieldType</a></code>.</p>"
}
},
"com.amazonaws.cloudsearch#IndexFieldStatus": {
"type": "structure",
"members": {
"Options": {
"target": "com.amazonaws.cloudsearch#IndexField",
"traits": {
"smithy.api#required": {}
}
},
"Status": {
"target": "com.amazonaws.cloudsearch#OptionStatus",
"traits": {
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>The value of an <code>IndexField</code> and its current status.</p>"
}
},
"com.amazonaws.cloudsearch#IndexFieldStatusList": {
"type": "list",
"member": {
"target": "com.amazonaws.cloudsearch#IndexFieldStatus"
},
"traits": {
"smithy.api#documentation": "<p>Contains the status of multiple index fields.</p>"
}
},
"com.amazonaws.cloudsearch#IndexFieldType": {
"type": "string",
"traits": {
"smithy.api#documentation": "<p>The type of field. The valid options for a field depend on the field type. For more information about the supported field types, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html\" target=\"_blank\">Configuring Index Fields</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>",
"smithy.api#enum": [
{
"value": "int",
"name": "int"
},
{
"value": "double",
"name": "double"
},
{
"value": "literal",
"name": "literal"
},
{
"value": "text",
"name": "text"
},
{
"value": "date",
"name": "date"
},
{
"value": "latlon",
"name": "latlon"
},
{
"value": "int-array",
"name": "int_array"
},
{
"value": "double-array",
"name": "double_array"
},
{
"value": "literal-array",
"name": "literal_array"
},
{
"value": "text-array",
"name": "text_array"
},
{
"value": "date-array",
"name": "date_array"
}
]
}
},
"com.amazonaws.cloudsearch#InstanceCount": {
"type": "integer",
"traits": {
"smithy.api#range": {
"min": 1
}
}
},
"com.amazonaws.cloudsearch#IntArrayOptions": {
"type": "structure",
"members": {
"DefaultValue": {
"target": "com.amazonaws.cloudsearch#Long",
"traits": {
"smithy.api#documentation": "A value to use for the field if the field isn't specified for a document."
}
},
"SourceFields": {
"target": "com.amazonaws.cloudsearch#FieldNameCommaList",
"traits": {
"smithy.api#documentation": "<p>A list of source fields to map to the field. </p>"
}
},
"FacetEnabled": {
"target": "com.amazonaws.cloudsearch#Boolean",
"traits": {
"smithy.api#documentation": "<p>Whether facet information can be returned for the field.</p>"
}
},
"SearchEnabled": {
"target": "com.amazonaws.cloudsearch#Boolean",
"traits": {
"smithy.api#documentation": "<p>Whether the contents of the field are searchable.</p>"
}
},
"ReturnEnabled": {
"target": "com.amazonaws.cloudsearch#Boolean",
"traits": {
"smithy.api#documentation": "<p>Whether the contents of the field can be returned in the search results.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Options for a field that contains an array of 64-bit signed integers. Present if <code>IndexFieldType</code> specifies the field is of type <code>int-array</code>. All options are enabled by default.</p>"
}
},
"com.amazonaws.cloudsearch#IntOptions": {
"type": "structure",
"members": {
"DefaultValue": {
"target": "com.amazonaws.cloudsearch#Long",
"traits": {
"smithy.api#documentation": "A value to use for the field if the field isn't specified for a document. This can be important if you are using the field in an expression and that field is not present in every document."
}
},
"SourceField": {
"target": "com.amazonaws.cloudsearch#FieldName",
"traits": {
"smithy.api#documentation": "<p>The name of the source field to map to the field. </p>"
}
},
"FacetEnabled": {
"target": "com.amazonaws.cloudsearch#Boolean",
"traits": {
"smithy.api#documentation": "<p>Whether facet information can be returned for the field.</p>"
}
},
"SearchEnabled": {
"target": "com.amazonaws.cloudsearch#Boolean",
"traits": {
"smithy.api#documentation": "<p>Whether the contents of the field are searchable.</p>"
}
},
"ReturnEnabled": {
"target": "com.amazonaws.cloudsearch#Boolean",
"traits": {
"smithy.api#documentation": "<p>Whether the contents of the field can be returned in the search results.</p>"
}
},
"SortEnabled": {
"target": "com.amazonaws.cloudsearch#Boolean",
"traits": {
"smithy.api#documentation": "<p>Whether the field can be used to sort the search results.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Options for a 64-bit signed integer field. Present if <code>IndexFieldType</code> specifies the field is of type <code>int</code>. All options are enabled by default.</p>"
}
},
"com.amazonaws.cloudsearch#InternalException": {
"type": "structure",
"members": {
"Code": {
"target": "com.amazonaws.cloudsearch#ErrorCode"
},
"Message": {
"target": "com.amazonaws.cloudsearch#ErrorMessage"
}
},
"traits": {
"smithy.api#documentation": "<p>An internal error occurred while processing the request. If this problem persists,\n report an issue from the <a href=\"http://status.aws.amazon.com/\" target=\"_blank\">Service Health Dashboard</a>.</p>",
"smithy.api#error": "server",
"smithy.api#httpError": 500
}
},
"com.amazonaws.cloudsearch#InvalidTypeException": {
"type": "structure",
"members": {
"Code": {
"target": "com.amazonaws.cloudsearch#ErrorCode"
},
"Message": {
"target": "com.amazonaws.cloudsearch#ErrorMessage"
}
},
"traits": {
"smithy.api#documentation": "<p>The request was rejected because it specified an invalid type definition.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 409
}
},
"com.amazonaws.cloudsearch#LatLonOptions": {
"type": "structure",
"members": {
"DefaultValue": {
"target": "com.amazonaws.cloudsearch#FieldValue",
"traits": {
"smithy.api#documentation": "A value to use for the field if the field isn't specified for a document."
}
},
"SourceField": {
"target": "com.amazonaws.cloudsearch#FieldName"
},
"FacetEnabled": {
"target": "com.amazonaws.cloudsearch#Boolean",
"traits": {
"smithy.api#documentation": "<p>Whether facet information can be returned for the field.</p>"
}
},
"SearchEnabled": {
"target": "com.amazonaws.cloudsearch#Boolean",
"traits": {
"smithy.api#documentation": "<p>Whether the contents of the field are searchable.</p>"
}
},
"ReturnEnabled": {
"target": "com.amazonaws.cloudsearch#Boolean",
"traits": {
"smithy.api#documentation": "<p>Whether the contents of the field can be returned in the search results.</p>"
}
},
"SortEnabled": {
"target": "com.amazonaws.cloudsearch#Boolean",
"traits": {
"smithy.api#documentation": "<p>Whether the field can be used to sort the search results.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Options for a latlon field. A latlon field contains a location stored as a latitude and longitude value pair. Present if <code>IndexFieldType</code> specifies the field is of type <code>latlon</code>. All options are enabled by default.</p>"
}
},
"com.amazonaws.cloudsearch#LimitExceededException": {
"type": "structure",
"members": {
"Code": {
"target": "com.amazonaws.cloudsearch#ErrorCode"
},
"Message": {
"target": "com.amazonaws.cloudsearch#ErrorMessage"
}
},
"traits": {
"smithy.api#documentation": "<p>The request was rejected because a resource limit has already been met.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 409
}
},
"com.amazonaws.cloudsearch#Limits": {
"type": "structure",
"members": {
"MaximumReplicationCount": {
"target": "com.amazonaws.cloudsearch#MaximumReplicationCount",
"traits": {
"smithy.api#required": {}
}
},
"MaximumPartitionCount": {
"target": "com.amazonaws.cloudsearch#MaximumPartitionCount",
"traits": {
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.cloudsearch#ListDomainNames": {
"type": "operation",
"output": {
"target": "com.amazonaws.cloudsearch#ListDomainNamesResponse"
},
"errors": [
{
"target": "com.amazonaws.cloudsearch#BaseException"
}
],
"traits": {
"smithy.api#documentation": "<p>Lists all search domains owned by an account.</p>"
}
},
"com.amazonaws.cloudsearch#ListDomainNamesResponse": {
"type": "structure",
"members": {
"DomainNames": {
"target": "com.amazonaws.cloudsearch#DomainNameMap",
"traits": {
"smithy.api#documentation": "<p>The names of the search domains owned by an account.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The result of a <code>ListDomainNames</code> request. Contains a list of the domains owned by an account.</p>"
}
},
"com.amazonaws.cloudsearch#LiteralArrayOptions": {
"type": "structure",
"members": {
"DefaultValue": {
"target": "com.amazonaws.cloudsearch#FieldValue",
"traits": {
"smithy.api#documentation": "A value to use for the field if the field isn't specified for a document."
}
},
"SourceFields": {
"target": "com.amazonaws.cloudsearch#FieldNameCommaList",
"traits": {
"smithy.api#documentation": "<p>A list of source fields to map to the field. </p>"
}
},
"FacetEnabled": {
"target": "com.amazonaws.cloudsearch#Boolean",
"traits": {
"smithy.api#documentation": "<p>Whether facet information can be returned for the field.</p>"
}
},
"SearchEnabled": {
"target": "com.amazonaws.cloudsearch#Boolean",
"traits": {
"smithy.api#documentation": "<p>Whether the contents of the field are searchable.</p>"
}
},
"ReturnEnabled": {
"target": "com.amazonaws.cloudsearch#Boolean",
"traits": {
"smithy.api#documentation": "<p>Whether the contents of the field can be returned in the search results.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Options for a field that contains an array of literal strings. Present if <code>IndexFieldType</code> specifies the field is of type <code>literal-array</code>. All options are enabled by default.</p>"
}
},
"com.amazonaws.cloudsearch#LiteralOptions": {
"type": "structure",
"members": {
"DefaultValue": {
"target": "com.amazonaws.cloudsearch#FieldValue",
"traits": {
"smithy.api#documentation": "A value to use for the field if the field isn't specified for a document."
}
},
"SourceField": {
"target": "com.amazonaws.cloudsearch#FieldName"
},
"FacetEnabled": {
"target": "com.amazonaws.cloudsearch#Boolean",
"traits": {
"smithy.api#documentation": "<p>Whether facet information can be returned for the field.</p>"
}
},
"SearchEnabled": {
"target": "com.amazonaws.cloudsearch#Boolean",
"traits": {
"smithy.api#documentation": "<p>Whether the contents of the field are searchable.</p>"
}
},
"ReturnEnabled": {
"target": "com.amazonaws.cloudsearch#Boolean",
"traits": {
"smithy.api#documentation": "<p>Whether the contents of the field can be returned in the search results.</p>"
}
},
"SortEnabled": {
"target": "com.amazonaws.cloudsearch#Boolean",
"traits": {
"smithy.api#documentation": "<p>Whether the field can be used to sort the search results.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Options for literal field. Present if <code>IndexFieldType</code> specifies the field is of type <code>literal</code>. All options are enabled by default.</p>"
}
},
"com.amazonaws.cloudsearch#Long": {
"type": "long",
"traits": {
"smithy.api#box": {}
}
},
"com.amazonaws.cloudsearch#MaximumPartitionCount": {
"type": "integer",
"traits": {
"smithy.api#range": {
"min": 1
}
}
},
"com.amazonaws.cloudsearch#MaximumReplicationCount": {
"type": "integer",
"traits": {
"smithy.api#range": {
"min": 1
}
}
},
"com.amazonaws.cloudsearch#MultiAZ": {
"type": "boolean"
},
"com.amazonaws.cloudsearch#OptionState": {
"type": "string",
"traits": {
"smithy.api#documentation": "<p>The state of processing a change to an option. One of:</p>\n <ul>\n <li>RequiresIndexDocuments: The option's latest value will not be deployed until <a>IndexDocuments</a> has been called and indexing is complete.</li>\n <li>Processing: The option's latest value is in the process of being activated.</li>\n <li>Active: The option's latest value is fully deployed. </li>\n <li>FailedToValidate: The option value is not compatible with the domain's data and cannot be used to index the data. You must either modify the option value or update or remove the incompatible documents.</li>\n </ul>",
"smithy.api#enum": [
{
"value": "RequiresIndexDocuments",
"name": "RequiresIndexDocuments"
},
{
"value": "Processing",
"name": "Processing"
},
{
"value": "Active",
"name": "Active"
},
{
"value": "FailedToValidate",
"name": "FailedToValidate"
}
]
}
},
"com.amazonaws.cloudsearch#OptionStatus": {
"type": "structure",
"members": {
"CreationDate": {
"target": "com.amazonaws.cloudsearch#UpdateTimestamp",
"traits": {
"smithy.api#documentation": "<p>A timestamp for when this option was created.</p>",
"smithy.api#required": {}
}
},
"UpdateDate": {
"target": "com.amazonaws.cloudsearch#UpdateTimestamp",
"traits": {
"smithy.api#documentation": "<p>A timestamp for when this option was last updated.</p>",
"smithy.api#required": {}
}
},
"UpdateVersion": {
"target": "com.amazonaws.cloudsearch#UIntValue",
"traits": {
"smithy.api#documentation": "<p>A unique integer that indicates when this option was last updated.</p>"
}
},
"State": {
"target": "com.amazonaws.cloudsearch#OptionState",
"traits": {
"smithy.api#documentation": "<p>The state of processing a change to an option. Possible values:</p><ul>\n <li><code>RequiresIndexDocuments</code>: the option's latest value will not be deployed until <a>IndexDocuments</a> has been called and indexing is complete.</li>\n <li><code>Processing</code>: the option's latest value is in the process of being activated. </li>\n <li><code>Active</code>: the option's latest value is completely deployed.</li>\n <li><code>FailedToValidate</code>: the option value is not compatible with the domain's data and cannot be used to index the data. You must either modify the option value or update or remove the incompatible documents.</li>\n </ul>",
"smithy.api#required": {}
}
},
"PendingDeletion": {
"target": "com.amazonaws.cloudsearch#Boolean",
"traits": {
"smithy.api#documentation": "<p>Indicates that the option will be deleted once processing is complete.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The status of domain configuration option.</p>"
}
},
"com.amazonaws.cloudsearch#PartitionCount": {
"type": "integer",
"traits": {
"smithy.api#documentation": "<p>The number of partitions used to hold the domain's index.</p>",
"smithy.api#range": {
"min": 1
}
}
},
"com.amazonaws.cloudsearch#PartitionInstanceType": {
"type": "string",
"traits": {
"smithy.api#documentation": "<p>The instance type (such as <code>search.m1.small</code>) on which an index partition is hosted.</p>",
"smithy.api#enum": [
{
"value": "search.m1.small",
"name": "search_m1_small"
},
{
"value": "search.m1.large",
"name": "search_m1_large"
},
{
"value": "search.m2.xlarge",
"name": "search_m2_xlarge"
},
{
"value": "search.m2.2xlarge",
"name": "search_m2_2xlarge"
},
{
"value": "search.m3.medium",
"name": "search_m3_medium"
},
{
"value": "search.m3.large",
"name": "search_m3_large"
},
{
"value": "search.m3.xlarge",
"name": "search_m3_xlarge"
},
{
"value": "search.m3.2xlarge",
"name": "search_m3_2xlarge"
},
{
"value": "search.small",
"name": "search_small"
},
{
"value": "search.medium",
"name": "search_medium"
},
{
"value": "search.large",
"name": "search_large"
},
{
"value": "search.xlarge",
"name": "search_xlarge"
},
{
"value": "search.2xlarge",
"name": "search_2xlarge"
}
]
}
},
"com.amazonaws.cloudsearch#PolicyDocument": {
"type": "string",
"traits": {
"smithy.api#documentation": "<p>Access rules for a domain's document or search service endpoints. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html\" target=\"_blank\">Configuring Access for a Search Domain</a> in the <i>Amazon CloudSearch Developer Guide</i>. The maximum size of a policy document is 100 KB.</p>"
}
},
"com.amazonaws.cloudsearch#ResourceNotFoundException": {
"type": "structure",
"members": {
"Code": {
"target": "com.amazonaws.cloudsearch#ErrorCode"
},
"Message": {
"target": "com.amazonaws.cloudsearch#ErrorMessage"
}
},
"traits": {
"smithy.api#documentation": "<p>The request was rejected because it attempted to reference a resource that does not exist.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 409
}
},
"com.amazonaws.cloudsearch#ScalingParameters": {
"type": "structure",
"members": {
"DesiredInstanceType": {
"target": "com.amazonaws.cloudsearch#PartitionInstanceType",
"traits": {
"smithy.api#documentation": "<p>The instance type that you want to preconfigure for your domain. For example, <code>search.m1.small</code>.</p>"
}
},
"DesiredReplicationCount": {
"target": "com.amazonaws.cloudsearch#UIntValue",
"traits": {
"smithy.api#documentation": "<p>The number of replicas you want to preconfigure for each index partition.</p>"
}
},
"DesiredPartitionCount": {
"target": "com.amazonaws.cloudsearch#UIntValue",
"traits": {
"smithy.api#documentation": "<p>The number of partitions you want to preconfigure for your domain. Only valid when\n you select <code>m2.2xlarge</code> as the desired instance type.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The desired instance type and desired number of replicas of each index partition.</p>"
}
},
"com.amazonaws.cloudsearch#ScalingParametersStatus": {
"type": "structure",
"members": {
"Options": {
"target": "com.amazonaws.cloudsearch#ScalingParameters",
"traits": {
"smithy.api#required": {}
}
},
"Status": {
"target": "com.amazonaws.cloudsearch#OptionStatus",
"traits": {
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>The status and configuration of a search domain's scaling parameters. </p>"
}
},
"com.amazonaws.cloudsearch#SearchInstanceType": {
"type": "string",
"traits": {
"smithy.api#documentation": "<p>The instance type (such as <code>search.m1.small</code>) that is being used to process search requests.</p>"
}
},
"com.amazonaws.cloudsearch#ServiceEndpoint": {
"type": "structure",
"members": {
"Endpoint": {
"target": "com.amazonaws.cloudsearch#ServiceUrl"
}
},
"traits": {
"smithy.api#documentation": "<p>The endpoint to which service requests can be submitted.</p>"
}
},
"com.amazonaws.cloudsearch#ServiceUrl": {
"type": "string",
"traits": {
"smithy.api#documentation": "<p>The endpoint to which service requests can be submitted. For example, <code>search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com</code> or <code>doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com</code>.</p>"
}
},
"com.amazonaws.cloudsearch#StandardName": {
"type": "string",
"traits": {
"smithy.api#documentation": "<p>Names must begin with a letter and can contain the following characters:\n a-z (lowercase), 0-9, and _ (underscore).</p>",
"smithy.api#length": {
"min": 1,
"max": 64
},
"smithy.api#pattern": "[a-z][a-z0-9_]*"
}
},
"com.amazonaws.cloudsearch#StandardNameList": {
"type": "list",
"member": {
"target": "com.amazonaws.cloudsearch#StandardName"
}
},
"com.amazonaws.cloudsearch#String": {
"type": "string"
},
"com.amazonaws.cloudsearch#Suggester": {
"type": "structure",
"members": {
"SuggesterName": {
"target": "com.amazonaws.cloudsearch#StandardName",
"traits": {
"smithy.api#required": {}
}
},
"DocumentSuggesterOptions": {
"target": "com.amazonaws.cloudsearch#DocumentSuggesterOptions",
"traits": {
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Configuration information for a search suggester. Each suggester has a unique name and specifies the text field you want to use for suggestions. The following options can be configured for a suggester: <code>FuzzyMatching</code>, <code>SortExpression</code>. </p>"
}
},
"com.amazonaws.cloudsearch#SuggesterFuzzyMatching": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "none",
"name": "none"
},
{
"value": "low",
"name": "low"
},
{
"value": "high",
"name": "high"
}
]
}
},
"com.amazonaws.cloudsearch#SuggesterStatus": {
"type": "structure",
"members": {
"Options": {
"target": "com.amazonaws.cloudsearch#Suggester",
"traits": {
"smithy.api#required": {}
}
},
"Status": {
"target": "com.amazonaws.cloudsearch#OptionStatus",
"traits": {
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>The value of a <code>Suggester</code> and its current status.</p>"
}
},
"com.amazonaws.cloudsearch#SuggesterStatusList": {
"type": "list",
"member": {
"target": "com.amazonaws.cloudsearch#SuggesterStatus"
},
"traits": {
"smithy.api#documentation": "<p>Contains the status of multiple suggesters.</p>"
}
},
"com.amazonaws.cloudsearch#TLSSecurityPolicy": {
"type": "string",
"traits": {
"smithy.api#documentation": "<p>The minimum required TLS version.</p>",
"smithy.api#enum": [
{
"value": "Policy-Min-TLS-1-0-2019-07",
"name": "POLICY_MIN_TLS_1_0_2019_07"
},
{
"value": "Policy-Min-TLS-1-2-2019-07",
"name": "POLICY_MIN_TLS_1_2_2019_07"
}
]
}
},
"com.amazonaws.cloudsearch#TextArrayOptions": {
"type": "structure",
"members": {
"DefaultValue": {
"target": "com.amazonaws.cloudsearch#FieldValue",
"traits": {
"smithy.api#documentation": "A value to use for the field if the field isn't specified for a document."
}
},
"SourceFields": {
"target": "com.amazonaws.cloudsearch#FieldNameCommaList",
"traits": {
"smithy.api#documentation": "<p>A list of source fields to map to the field. </p>"
}
},
"ReturnEnabled": {
"target": "com.amazonaws.cloudsearch#Boolean",
"traits": {
"smithy.api#documentation": "<p>Whether the contents of the field can be returned in the search results.</p>"
}
},
"HighlightEnabled": {
"target": "com.amazonaws.cloudsearch#Boolean",
"traits": {
"smithy.api#documentation": "<p>Whether highlights can be returned for the field.</p>"
}
},
"AnalysisScheme": {
"target": "com.amazonaws.cloudsearch#Word",
"traits": {
"smithy.api#documentation": "<p>The name of an analysis scheme for a <code>text-array</code> field.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Options for a field that contains an array of text strings. Present if <code>IndexFieldType</code> specifies the field is of type <code>text-array</code>. A <code>text-array</code> field is always searchable. All options are enabled by default.</p>"
}
},
"com.amazonaws.cloudsearch#TextOptions": {
"type": "structure",
"members": {
"DefaultValue": {
"target": "com.amazonaws.cloudsearch#FieldValue",
"traits": {
"smithy.api#documentation": "A value to use for the field if the field isn't specified for a document."
}
},
"SourceField": {
"target": "com.amazonaws.cloudsearch#FieldName"
},
"ReturnEnabled": {
"target": "com.amazonaws.cloudsearch#Boolean",
"traits": {
"smithy.api#documentation": "<p>Whether the contents of the field can be returned in the search results.</p>"
}
},
"SortEnabled": {
"target": "com.amazonaws.cloudsearch#Boolean",
"traits": {
"smithy.api#documentation": "<p>Whether the field can be used to sort the search results.</p>"
}
},
"HighlightEnabled": {
"target": "com.amazonaws.cloudsearch#Boolean",
"traits": {
"smithy.api#documentation": "<p>Whether highlights can be returned for the field.</p>"
}
},
"AnalysisScheme": {
"target": "com.amazonaws.cloudsearch#Word",
"traits": {
"smithy.api#documentation": "<p>The name of an analysis scheme for a <code>text</code> field.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Options for text field. Present if <code>IndexFieldType</code> specifies the field is of type <code>text</code>. A <code>text</code> field is always searchable. All options are enabled by default.</p>"
}
},
"com.amazonaws.cloudsearch#UIntValue": {
"type": "integer",
"traits": {
"smithy.api#range": {
"min": 0
}
}
},
"com.amazonaws.cloudsearch#UpdateAvailabilityOptions": {
"type": "operation",
"input": {
"target": "com.amazonaws.cloudsearch#UpdateAvailabilityOptionsRequest"
},
"output": {
"target": "com.amazonaws.cloudsearch#UpdateAvailabilityOptionsResponse"
},
"errors": [
{
"target": "com.amazonaws.cloudsearch#BaseException"
},
{
"target": "com.amazonaws.cloudsearch#DisabledOperationException"
},
{
"target": "com.amazonaws.cloudsearch#InternalException"
},
{
"target": "com.amazonaws.cloudsearch#InvalidTypeException"
},
{
"target": "com.amazonaws.cloudsearch#LimitExceededException"
},
{
"target": "com.amazonaws.cloudsearch#ResourceNotFoundException"
},
{
"target": "com.amazonaws.cloudsearch#ValidationException"
}
],
"traits": {
"smithy.api#documentation": "<p>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 <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-availability-options.html\" target=\"_blank\">Configuring Availability Options</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>"
}
},
"com.amazonaws.cloudsearch#UpdateAvailabilityOptionsRequest": {
"type": "structure",
"members": {
"DomainName": {
"target": "com.amazonaws.cloudsearch#DomainName",
"traits": {
"smithy.api#required": {}
}
},
"MultiAZ": {
"target": "com.amazonaws.cloudsearch#Boolean",
"traits": {
"smithy.api#documentation": "<p>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 <code>false</code>. </p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Container for the parameters to the <code><a>UpdateAvailabilityOptions</a></code> operation. Specifies the name of the domain you want to update and the Multi-AZ availability option.</p>"
}
},
"com.amazonaws.cloudsearch#UpdateAvailabilityOptionsResponse": {
"type": "structure",
"members": {
"AvailabilityOptions": {
"target": "com.amazonaws.cloudsearch#AvailabilityOptionsStatus",
"traits": {
"smithy.api#documentation": "<p>The newly-configured availability options. Indicates whether Multi-AZ is enabled for the domain. </p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The result of a <code>UpdateAvailabilityOptions</code> request. Contains the status of the domain's availability options. </p>"
}
},
"com.amazonaws.cloudsearch#UpdateDomainEndpointOptions": {
"type": "operation",
"input": {
"target": "com.amazonaws.cloudsearch#UpdateDomainEndpointOptionsRequest"
},
"output": {
"target": "com.amazonaws.cloudsearch#UpdateDomainEndpointOptionsResponse"
},
"errors": [
{
"target": "com.amazonaws.cloudsearch#BaseException"
},
{
"target": "com.amazonaws.cloudsearch#DisabledOperationException"
},
{
"target": "com.amazonaws.cloudsearch#InternalException"
},
{
"target": "com.amazonaws.cloudsearch#InvalidTypeException"
},
{
"target": "com.amazonaws.cloudsearch#LimitExceededException"
},
{
"target": "com.amazonaws.cloudsearch#ResourceNotFoundException"
},
{
"target": "com.amazonaws.cloudsearch#ValidationException"
}
],
"traits": {
"smithy.api#documentation": "<p>Updates the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-domain-endpoint-options.html\" target=\"_blank\">Configuring Domain Endpoint Options</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>"
}
},
"com.amazonaws.cloudsearch#UpdateDomainEndpointOptionsRequest": {
"type": "structure",
"members": {
"DomainName": {
"target": "com.amazonaws.cloudsearch#DomainName",
"traits": {
"smithy.api#documentation": "<p>A string that represents the name of a domain.</p>",
"smithy.api#required": {}
}
},
"DomainEndpointOptions": {
"target": "com.amazonaws.cloudsearch#DomainEndpointOptions",
"traits": {
"smithy.api#documentation": "<p>Whether to require that all requests to the domain arrive over HTTPS. We recommend Policy-Min-TLS-1-2-2019-07 for TLSSecurityPolicy. For compatibility with older clients, the default is Policy-Min-TLS-1-0-2019-07. </p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Container for the parameters to the <code><a>UpdateDomainEndpointOptions</a></code> operation. Specifies the name of the domain you want to update and the domain endpoint options.</p>"
}
},
"com.amazonaws.cloudsearch#UpdateDomainEndpointOptionsResponse": {
"type": "structure",
"members": {
"DomainEndpointOptions": {
"target": "com.amazonaws.cloudsearch#DomainEndpointOptionsStatus",
"traits": {
"smithy.api#documentation": "<p>The newly-configured domain endpoint options.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The result of a <code>UpdateDomainEndpointOptions</code> request. Contains the configuration and status of the domain's endpoint options. </p>"
}
},
"com.amazonaws.cloudsearch#UpdateScalingParameters": {
"type": "operation",
"input": {
"target": "com.amazonaws.cloudsearch#UpdateScalingParametersRequest"
},
"output": {
"target": "com.amazonaws.cloudsearch#UpdateScalingParametersResponse"
},
"errors": [
{
"target": "com.amazonaws.cloudsearch#BaseException"
},
{
"target": "com.amazonaws.cloudsearch#InternalException"
},
{
"target": "com.amazonaws.cloudsearch#InvalidTypeException"
},
{
"target": "com.amazonaws.cloudsearch#LimitExceededException"
},
{
"target": "com.amazonaws.cloudsearch#ResourceNotFoundException"
}
],
"traits": {
"smithy.api#documentation": "<p>Configures scaling parameters for a domain. A domain's scaling parameters specify the desired search instance type and replication count. Amazon CloudSearch will still automatically scale your domain based on the volume of data and traffic, but not below the desired instance type and replication count. If the Multi-AZ option is enabled, these values control the resources used per Availability Zone. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-scaling-options.html\" target=\"_blank\">Configuring Scaling Options</a> in the <i>Amazon CloudSearch Developer Guide</i>. </p>"
}
},
"com.amazonaws.cloudsearch#UpdateScalingParametersRequest": {
"type": "structure",
"members": {
"DomainName": {
"target": "com.amazonaws.cloudsearch#DomainName",
"traits": {
"smithy.api#required": {}
}
},
"ScalingParameters": {
"target": "com.amazonaws.cloudsearch#ScalingParameters",
"traits": {
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Container for the parameters to the <code><a>UpdateScalingParameters</a></code> operation. Specifies the name of the domain you want to update and the scaling parameters you want to configure.</p>"
}
},
"com.amazonaws.cloudsearch#UpdateScalingParametersResponse": {
"type": "structure",
"members": {
"ScalingParameters": {
"target": "com.amazonaws.cloudsearch#ScalingParametersStatus",
"traits": {
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>The result of a <code>UpdateScalingParameters</code> request. Contains the status of the newly-configured scaling parameters.</p>"
}
},
"com.amazonaws.cloudsearch#UpdateServiceAccessPolicies": {
"type": "operation",
"input": {
"target": "com.amazonaws.cloudsearch#UpdateServiceAccessPoliciesRequest"
},
"output": {
"target": "com.amazonaws.cloudsearch#UpdateServiceAccessPoliciesResponse"
},
"errors": [
{
"target": "com.amazonaws.cloudsearch#BaseException"
},
{
"target": "com.amazonaws.cloudsearch#InternalException"
},
{
"target": "com.amazonaws.cloudsearch#InvalidTypeException"
},
{
"target": "com.amazonaws.cloudsearch#LimitExceededException"
},
{
"target": "com.amazonaws.cloudsearch#ResourceNotFoundException"
}
],
"traits": {
"smithy.api#documentation": "<p>Configures the access rules that control access to the domain's document and search endpoints.\n For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html\" target=\"_blank\">\n Configuring Access for an Amazon CloudSearch Domain</a>.</p>"
}
},
"com.amazonaws.cloudsearch#UpdateServiceAccessPoliciesRequest": {
"type": "structure",
"members": {
"DomainName": {
"target": "com.amazonaws.cloudsearch#DomainName",
"traits": {
"smithy.api#required": {}
}
},
"AccessPolicies": {
"target": "com.amazonaws.cloudsearch#PolicyDocument",
"traits": {
"smithy.api#documentation": "<p>The access rules you want to configure. These rules replace any existing rules. </p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Container for the parameters to the <code><a>UpdateServiceAccessPolicies</a></code> operation. Specifies the name of the domain you want to update and the access rules you want to configure.</p>"
}
},
"com.amazonaws.cloudsearch#UpdateServiceAccessPoliciesResponse": {
"type": "structure",
"members": {
"AccessPolicies": {
"target": "com.amazonaws.cloudsearch#AccessPoliciesStatus",
"traits": {
"smithy.api#documentation": "<p>The access rules configured for the domain.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>The result of an <code>UpdateServiceAccessPolicies</code> request. Contains the new access policies.</p>"
}
},
"com.amazonaws.cloudsearch#UpdateTimestamp": {
"type": "timestamp"
},
"com.amazonaws.cloudsearch#ValidationException": {
"type": "structure",
"members": {
"Code": {
"target": "com.amazonaws.cloudsearch#ErrorCode"
},
"Message": {
"target": "com.amazonaws.cloudsearch#ErrorMessage"
}
},
"traits": {
"smithy.api#documentation": "<p>The request was rejected because it has invalid parameters.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 400
}
},
"com.amazonaws.cloudsearch#Word": {
"type": "string",
"traits": {
"smithy.api#pattern": "[\\S]+"
}
}
}
}
Reference in New Issue Copy Permalink