@aws-sdk/client-cloudsearch 3.296.0 → 3.298.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (88) hide show
  1. package/dist-cjs/commands/BuildSuggestersCommand.js +2 -3
  2. package/dist-cjs/commands/CreateDomainCommand.js +2 -3
  3. package/dist-cjs/commands/DefineAnalysisSchemeCommand.js +2 -3
  4. package/dist-cjs/commands/DefineExpressionCommand.js +2 -3
  5. package/dist-cjs/commands/DefineIndexFieldCommand.js +2 -3
  6. package/dist-cjs/commands/DefineSuggesterCommand.js +2 -3
  7. package/dist-cjs/commands/DeleteAnalysisSchemeCommand.js +2 -3
  8. package/dist-cjs/commands/DeleteDomainCommand.js +2 -3
  9. package/dist-cjs/commands/DeleteExpressionCommand.js +2 -3
  10. package/dist-cjs/commands/DeleteIndexFieldCommand.js +2 -3
  11. package/dist-cjs/commands/DeleteSuggesterCommand.js +2 -3
  12. package/dist-cjs/commands/DescribeAnalysisSchemesCommand.js +2 -3
  13. package/dist-cjs/commands/DescribeAvailabilityOptionsCommand.js +2 -3
  14. package/dist-cjs/commands/DescribeDomainEndpointOptionsCommand.js +2 -3
  15. package/dist-cjs/commands/DescribeDomainsCommand.js +2 -3
  16. package/dist-cjs/commands/DescribeExpressionsCommand.js +2 -3
  17. package/dist-cjs/commands/DescribeIndexFieldsCommand.js +2 -3
  18. package/dist-cjs/commands/DescribeScalingParametersCommand.js +2 -3
  19. package/dist-cjs/commands/DescribeServiceAccessPoliciesCommand.js +2 -3
  20. package/dist-cjs/commands/DescribeSuggestersCommand.js +2 -3
  21. package/dist-cjs/commands/IndexDocumentsCommand.js +2 -3
  22. package/dist-cjs/commands/ListDomainNamesCommand.js +2 -3
  23. package/dist-cjs/commands/UpdateAvailabilityOptionsCommand.js +2 -3
  24. package/dist-cjs/commands/UpdateDomainEndpointOptionsCommand.js +2 -3
  25. package/dist-cjs/commands/UpdateScalingParametersCommand.js +2 -3
  26. package/dist-cjs/commands/UpdateServiceAccessPoliciesCommand.js +2 -3
  27. package/dist-cjs/models/models_0.js +1 -330
  28. package/dist-cjs/protocols/Aws_query.js +65 -303
  29. package/dist-es/commands/BuildSuggestersCommand.js +2 -3
  30. package/dist-es/commands/CreateDomainCommand.js +2 -3
  31. package/dist-es/commands/DefineAnalysisSchemeCommand.js +2 -3
  32. package/dist-es/commands/DefineExpressionCommand.js +2 -3
  33. package/dist-es/commands/DefineIndexFieldCommand.js +2 -3
  34. package/dist-es/commands/DefineSuggesterCommand.js +2 -3
  35. package/dist-es/commands/DeleteAnalysisSchemeCommand.js +2 -3
  36. package/dist-es/commands/DeleteDomainCommand.js +2 -3
  37. package/dist-es/commands/DeleteExpressionCommand.js +2 -3
  38. package/dist-es/commands/DeleteIndexFieldCommand.js +2 -3
  39. package/dist-es/commands/DeleteSuggesterCommand.js +2 -3
  40. package/dist-es/commands/DescribeAnalysisSchemesCommand.js +2 -3
  41. package/dist-es/commands/DescribeAvailabilityOptionsCommand.js +2 -3
  42. package/dist-es/commands/DescribeDomainEndpointOptionsCommand.js +2 -3
  43. package/dist-es/commands/DescribeDomainsCommand.js +2 -3
  44. package/dist-es/commands/DescribeExpressionsCommand.js +2 -3
  45. package/dist-es/commands/DescribeIndexFieldsCommand.js +2 -3
  46. package/dist-es/commands/DescribeScalingParametersCommand.js +2 -3
  47. package/dist-es/commands/DescribeServiceAccessPoliciesCommand.js +2 -3
  48. package/dist-es/commands/DescribeSuggestersCommand.js +2 -3
  49. package/dist-es/commands/IndexDocumentsCommand.js +2 -3
  50. package/dist-es/commands/ListDomainNamesCommand.js +2 -3
  51. package/dist-es/commands/UpdateAvailabilityOptionsCommand.js +2 -3
  52. package/dist-es/commands/UpdateDomainEndpointOptionsCommand.js +2 -3
  53. package/dist-es/commands/UpdateScalingParametersCommand.js +2 -3
  54. package/dist-es/commands/UpdateServiceAccessPoliciesCommand.js +2 -3
  55. package/dist-es/models/models_0.js +0 -246
  56. package/dist-es/protocols/Aws_query.js +65 -303
  57. package/dist-types/CloudSearch.d.ts +27 -0
  58. package/dist-types/CloudSearchClient.d.ts +24 -4
  59. package/dist-types/commands/BuildSuggestersCommand.d.ts +16 -0
  60. package/dist-types/commands/CreateDomainCommand.d.ts +16 -0
  61. package/dist-types/commands/DefineAnalysisSchemeCommand.d.ts +16 -0
  62. package/dist-types/commands/DefineExpressionCommand.d.ts +16 -0
  63. package/dist-types/commands/DefineIndexFieldCommand.d.ts +16 -0
  64. package/dist-types/commands/DefineSuggesterCommand.d.ts +16 -0
  65. package/dist-types/commands/DeleteAnalysisSchemeCommand.d.ts +16 -0
  66. package/dist-types/commands/DeleteDomainCommand.d.ts +16 -0
  67. package/dist-types/commands/DeleteExpressionCommand.d.ts +16 -0
  68. package/dist-types/commands/DeleteIndexFieldCommand.d.ts +16 -0
  69. package/dist-types/commands/DeleteSuggesterCommand.d.ts +16 -0
  70. package/dist-types/commands/DescribeAnalysisSchemesCommand.d.ts +16 -0
  71. package/dist-types/commands/DescribeAvailabilityOptionsCommand.d.ts +16 -0
  72. package/dist-types/commands/DescribeDomainEndpointOptionsCommand.d.ts +16 -0
  73. package/dist-types/commands/DescribeDomainsCommand.d.ts +16 -0
  74. package/dist-types/commands/DescribeExpressionsCommand.d.ts +16 -0
  75. package/dist-types/commands/DescribeIndexFieldsCommand.d.ts +16 -0
  76. package/dist-types/commands/DescribeScalingParametersCommand.d.ts +16 -0
  77. package/dist-types/commands/DescribeServiceAccessPoliciesCommand.d.ts +16 -0
  78. package/dist-types/commands/DescribeSuggestersCommand.d.ts +16 -0
  79. package/dist-types/commands/IndexDocumentsCommand.d.ts +16 -0
  80. package/dist-types/commands/ListDomainNamesCommand.d.ts +16 -0
  81. package/dist-types/commands/UpdateAvailabilityOptionsCommand.d.ts +16 -0
  82. package/dist-types/commands/UpdateDomainEndpointOptionsCommand.d.ts +16 -0
  83. package/dist-types/commands/UpdateScalingParametersCommand.d.ts +16 -0
  84. package/dist-types/commands/UpdateServiceAccessPoliciesCommand.d.ts +16 -0
  85. package/dist-types/models/CloudSearchServiceException.d.ts +2 -0
  86. package/dist-types/models/models_0.d.ts +114 -329
  87. package/dist-types/ts3.4/models/models_0.d.ts +0 -228
  88. package/package.json +4 -3
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CloudSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudSearchClient";
5
5
  import { DeleteAnalysisSchemeRequest, DeleteAnalysisSchemeResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteAnalysisSchemeCommand}.
8
10
  */
9
11
  export interface DeleteAnalysisSchemeCommandInput extends DeleteAnalysisSchemeRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteAnalysisSchemeCommand}.
13
17
  */
14
18
  export interface DeleteAnalysisSchemeCommandOutput extends DeleteAnalysisSchemeResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <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>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DeleteAnalysisSchemeCommandOutput extends DeleteAnalysisSchemeR
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteAnalysisSchemeCommandInput - {@link DeleteAnalysisSchemeCommandInput}
34
+ * @returns {@link DeleteAnalysisSchemeCommandOutput}
28
35
  * @see {@link DeleteAnalysisSchemeCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteAnalysisSchemeCommandOutput} for command's `response` shape.
30
37
  * @see {@link CloudSearchClientResolvedConfig | config} for CloudSearchClient's `config` shape.
@@ -50,11 +57,20 @@ export interface DeleteAnalysisSchemeCommandOutput extends DeleteAnalysisSchemeR
50
57
  export declare class DeleteAnalysisSchemeCommand extends $Command<DeleteAnalysisSchemeCommandInput, DeleteAnalysisSchemeCommandOutput, CloudSearchClientResolvedConfig> {
51
58
  readonly input: DeleteAnalysisSchemeCommandInput;
52
59
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
60
+ /**
61
+ * @public
62
+ */
53
63
  constructor(input: DeleteAnalysisSchemeCommandInput);
54
64
  /**
55
65
  * @internal
56
66
  */
57
67
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudSearchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteAnalysisSchemeCommandInput, DeleteAnalysisSchemeCommandOutput>;
68
+ /**
69
+ * @internal
70
+ */
58
71
  private serialize;
72
+ /**
73
+ * @internal
74
+ */
59
75
  private deserialize;
60
76
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CloudSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudSearchClient";
5
5
  import { DeleteDomainRequest, DeleteDomainResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteDomainCommand}.
8
10
  */
9
11
  export interface DeleteDomainCommandInput extends DeleteDomainRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteDomainCommand}.
13
17
  */
14
18
  export interface DeleteDomainCommandOutput extends DeleteDomainResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Permanently deletes a search domain and all of its data. Once a domain has been deleted, it cannot be recovered. For more information,
18
23
  * 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>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface DeleteDomainCommandOutput extends DeleteDomainResponse, __Metad
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param DeleteDomainCommandInput - {@link DeleteDomainCommandInput}
35
+ * @returns {@link DeleteDomainCommandOutput}
29
36
  * @see {@link DeleteDomainCommandInput} for command's `input` shape.
30
37
  * @see {@link DeleteDomainCommandOutput} for command's `response` shape.
31
38
  * @see {@link CloudSearchClientResolvedConfig | config} for CloudSearchClient's `config` shape.
@@ -42,11 +49,20 @@ export interface DeleteDomainCommandOutput extends DeleteDomainResponse, __Metad
42
49
  export declare class DeleteDomainCommand extends $Command<DeleteDomainCommandInput, DeleteDomainCommandOutput, CloudSearchClientResolvedConfig> {
43
50
  readonly input: DeleteDomainCommandInput;
44
51
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
52
+ /**
53
+ * @public
54
+ */
45
55
  constructor(input: DeleteDomainCommandInput);
46
56
  /**
47
57
  * @internal
48
58
  */
49
59
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudSearchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteDomainCommandInput, DeleteDomainCommandOutput>;
60
+ /**
61
+ * @internal
62
+ */
50
63
  private serialize;
64
+ /**
65
+ * @internal
66
+ */
51
67
  private deserialize;
52
68
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CloudSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudSearchClient";
5
5
  import { DeleteExpressionRequest, DeleteExpressionResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteExpressionCommand}.
8
10
  */
9
11
  export interface DeleteExpressionCommandInput extends DeleteExpressionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteExpressionCommand}.
13
17
  */
14
18
  export interface DeleteExpressionCommandOutput extends DeleteExpressionResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <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>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DeleteExpressionCommandOutput extends DeleteExpressionResponse,
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteExpressionCommandInput - {@link DeleteExpressionCommandInput}
34
+ * @returns {@link DeleteExpressionCommandOutput}
28
35
  * @see {@link DeleteExpressionCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteExpressionCommandOutput} for command's `response` shape.
30
37
  * @see {@link CloudSearchClientResolvedConfig | config} for CloudSearchClient's `config` shape.
@@ -50,11 +57,20 @@ export interface DeleteExpressionCommandOutput extends DeleteExpressionResponse,
50
57
  export declare class DeleteExpressionCommand extends $Command<DeleteExpressionCommandInput, DeleteExpressionCommandOutput, CloudSearchClientResolvedConfig> {
51
58
  readonly input: DeleteExpressionCommandInput;
52
59
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
60
+ /**
61
+ * @public
62
+ */
53
63
  constructor(input: DeleteExpressionCommandInput);
54
64
  /**
55
65
  * @internal
56
66
  */
57
67
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudSearchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteExpressionCommandInput, DeleteExpressionCommandOutput>;
68
+ /**
69
+ * @internal
70
+ */
58
71
  private serialize;
72
+ /**
73
+ * @internal
74
+ */
59
75
  private deserialize;
60
76
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CloudSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudSearchClient";
5
5
  import { DeleteIndexFieldRequest, DeleteIndexFieldResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteIndexFieldCommand}.
8
10
  */
9
11
  export interface DeleteIndexFieldCommandInput extends DeleteIndexFieldRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteIndexFieldCommand}.
13
17
  */
14
18
  export interface DeleteIndexFieldCommandOutput extends DeleteIndexFieldResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <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>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DeleteIndexFieldCommandOutput extends DeleteIndexFieldResponse,
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteIndexFieldCommandInput - {@link DeleteIndexFieldCommandInput}
34
+ * @returns {@link DeleteIndexFieldCommandOutput}
28
35
  * @see {@link DeleteIndexFieldCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteIndexFieldCommandOutput} for command's `response` shape.
30
37
  * @see {@link CloudSearchClientResolvedConfig | config} for CloudSearchClient's `config` shape.
@@ -50,11 +57,20 @@ export interface DeleteIndexFieldCommandOutput extends DeleteIndexFieldResponse,
50
57
  export declare class DeleteIndexFieldCommand extends $Command<DeleteIndexFieldCommandInput, DeleteIndexFieldCommandOutput, CloudSearchClientResolvedConfig> {
51
58
  readonly input: DeleteIndexFieldCommandInput;
52
59
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
60
+ /**
61
+ * @public
62
+ */
53
63
  constructor(input: DeleteIndexFieldCommandInput);
54
64
  /**
55
65
  * @internal
56
66
  */
57
67
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudSearchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteIndexFieldCommandInput, DeleteIndexFieldCommandOutput>;
68
+ /**
69
+ * @internal
70
+ */
58
71
  private serialize;
72
+ /**
73
+ * @internal
74
+ */
59
75
  private deserialize;
60
76
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CloudSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudSearchClient";
5
5
  import { DeleteSuggesterRequest, DeleteSuggesterResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteSuggesterCommand}.
8
10
  */
9
11
  export interface DeleteSuggesterCommandInput extends DeleteSuggesterRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteSuggesterCommand}.
13
17
  */
14
18
  export interface DeleteSuggesterCommandOutput extends DeleteSuggesterResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <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>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DeleteSuggesterCommandOutput extends DeleteSuggesterResponse, _
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteSuggesterCommandInput - {@link DeleteSuggesterCommandInput}
34
+ * @returns {@link DeleteSuggesterCommandOutput}
28
35
  * @see {@link DeleteSuggesterCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteSuggesterCommandOutput} for command's `response` shape.
30
37
  * @see {@link CloudSearchClientResolvedConfig | config} for CloudSearchClient's `config` shape.
@@ -50,11 +57,20 @@ export interface DeleteSuggesterCommandOutput extends DeleteSuggesterResponse, _
50
57
  export declare class DeleteSuggesterCommand extends $Command<DeleteSuggesterCommandInput, DeleteSuggesterCommandOutput, CloudSearchClientResolvedConfig> {
51
58
  readonly input: DeleteSuggesterCommandInput;
52
59
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
60
+ /**
61
+ * @public
62
+ */
53
63
  constructor(input: DeleteSuggesterCommandInput);
54
64
  /**
55
65
  * @internal
56
66
  */
57
67
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudSearchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteSuggesterCommandInput, DeleteSuggesterCommandOutput>;
68
+ /**
69
+ * @internal
70
+ */
58
71
  private serialize;
72
+ /**
73
+ * @internal
74
+ */
59
75
  private deserialize;
60
76
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CloudSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudSearchClient";
5
5
  import { DescribeAnalysisSchemesRequest, DescribeAnalysisSchemesResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeAnalysisSchemesCommand}.
8
10
  */
9
11
  export interface DescribeAnalysisSchemesCommandInput extends DescribeAnalysisSchemesRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeAnalysisSchemesCommand}.
13
17
  */
14
18
  export interface DescribeAnalysisSchemesCommandOutput extends DescribeAnalysisSchemesResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <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>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DescribeAnalysisSchemesCommandOutput extends DescribeAnalysisSc
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeAnalysisSchemesCommandInput - {@link DescribeAnalysisSchemesCommandInput}
34
+ * @returns {@link DescribeAnalysisSchemesCommandOutput}
28
35
  * @see {@link DescribeAnalysisSchemesCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeAnalysisSchemesCommandOutput} for command's `response` shape.
30
37
  * @see {@link CloudSearchClientResolvedConfig | config} for CloudSearchClient's `config` shape.
@@ -44,11 +51,20 @@ export interface DescribeAnalysisSchemesCommandOutput extends DescribeAnalysisSc
44
51
  export declare class DescribeAnalysisSchemesCommand extends $Command<DescribeAnalysisSchemesCommandInput, DescribeAnalysisSchemesCommandOutput, CloudSearchClientResolvedConfig> {
45
52
  readonly input: DescribeAnalysisSchemesCommandInput;
46
53
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
54
+ /**
55
+ * @public
56
+ */
47
57
  constructor(input: DescribeAnalysisSchemesCommandInput);
48
58
  /**
49
59
  * @internal
50
60
  */
51
61
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudSearchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeAnalysisSchemesCommandInput, DescribeAnalysisSchemesCommandOutput>;
62
+ /**
63
+ * @internal
64
+ */
52
65
  private serialize;
66
+ /**
67
+ * @internal
68
+ */
53
69
  private deserialize;
54
70
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CloudSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudSearchClient";
5
5
  import { DescribeAvailabilityOptionsRequest, DescribeAvailabilityOptionsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeAvailabilityOptionsCommand}.
8
10
  */
9
11
  export interface DescribeAvailabilityOptionsCommandInput extends DescribeAvailabilityOptionsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeAvailabilityOptionsCommand}.
13
17
  */
14
18
  export interface DescribeAvailabilityOptionsCommandOutput extends DescribeAvailabilityOptionsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <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>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DescribeAvailabilityOptionsCommandOutput extends DescribeAvaila
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeAvailabilityOptionsCommandInput - {@link DescribeAvailabilityOptionsCommandInput}
34
+ * @returns {@link DescribeAvailabilityOptionsCommandOutput}
28
35
  * @see {@link DescribeAvailabilityOptionsCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeAvailabilityOptionsCommandOutput} for command's `response` shape.
30
37
  * @see {@link CloudSearchClientResolvedConfig | config} for CloudSearchClient's `config` shape.
@@ -53,11 +60,20 @@ export interface DescribeAvailabilityOptionsCommandOutput extends DescribeAvaila
53
60
  export declare class DescribeAvailabilityOptionsCommand extends $Command<DescribeAvailabilityOptionsCommandInput, DescribeAvailabilityOptionsCommandOutput, CloudSearchClientResolvedConfig> {
54
61
  readonly input: DescribeAvailabilityOptionsCommandInput;
55
62
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
63
+ /**
64
+ * @public
65
+ */
56
66
  constructor(input: DescribeAvailabilityOptionsCommandInput);
57
67
  /**
58
68
  * @internal
59
69
  */
60
70
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudSearchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeAvailabilityOptionsCommandInput, DescribeAvailabilityOptionsCommandOutput>;
71
+ /**
72
+ * @internal
73
+ */
61
74
  private serialize;
75
+ /**
76
+ * @internal
77
+ */
62
78
  private deserialize;
63
79
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CloudSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudSearchClient";
5
5
  import { DescribeDomainEndpointOptionsRequest, DescribeDomainEndpointOptionsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeDomainEndpointOptionsCommand}.
8
10
  */
9
11
  export interface DescribeDomainEndpointOptionsCommandInput extends DescribeDomainEndpointOptionsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeDomainEndpointOptionsCommand}.
13
17
  */
14
18
  export interface DescribeDomainEndpointOptionsCommandOutput extends DescribeDomainEndpointOptionsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <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>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DescribeDomainEndpointOptionsCommandOutput extends DescribeDoma
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeDomainEndpointOptionsCommandInput - {@link DescribeDomainEndpointOptionsCommandInput}
34
+ * @returns {@link DescribeDomainEndpointOptionsCommandOutput}
28
35
  * @see {@link DescribeDomainEndpointOptionsCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeDomainEndpointOptionsCommandOutput} for command's `response` shape.
30
37
  * @see {@link CloudSearchClientResolvedConfig | config} for CloudSearchClient's `config` shape.
@@ -50,11 +57,20 @@ export interface DescribeDomainEndpointOptionsCommandOutput extends DescribeDoma
50
57
  export declare class DescribeDomainEndpointOptionsCommand extends $Command<DescribeDomainEndpointOptionsCommandInput, DescribeDomainEndpointOptionsCommandOutput, CloudSearchClientResolvedConfig> {
51
58
  readonly input: DescribeDomainEndpointOptionsCommandInput;
52
59
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
60
+ /**
61
+ * @public
62
+ */
53
63
  constructor(input: DescribeDomainEndpointOptionsCommandInput);
54
64
  /**
55
65
  * @internal
56
66
  */
57
67
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudSearchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeDomainEndpointOptionsCommandInput, DescribeDomainEndpointOptionsCommandOutput>;
68
+ /**
69
+ * @internal
70
+ */
58
71
  private serialize;
72
+ /**
73
+ * @internal
74
+ */
59
75
  private deserialize;
60
76
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CloudSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudSearchClient";
5
5
  import { DescribeDomainsRequest, DescribeDomainsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeDomainsCommand}.
8
10
  */
9
11
  export interface DescribeDomainsCommandInput extends DescribeDomainsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeDomainsCommand}.
13
17
  */
14
18
  export interface DescribeDomainsCommandOutput extends DescribeDomainsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets information about the search domains owned by this account. Can be limited to specific domains. Shows
18
23
  * 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,
19
24
  * 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>
@@ -27,6 +32,8 @@ export interface DescribeDomainsCommandOutput extends DescribeDomainsResponse, _
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param DescribeDomainsCommandInput - {@link DescribeDomainsCommandInput}
36
+ * @returns {@link DescribeDomainsCommandOutput}
30
37
  * @see {@link DescribeDomainsCommandInput} for command's `input` shape.
31
38
  * @see {@link DescribeDomainsCommandOutput} for command's `response` shape.
32
39
  * @see {@link CloudSearchClientResolvedConfig | config} for CloudSearchClient's `config` shape.
@@ -43,11 +50,20 @@ export interface DescribeDomainsCommandOutput extends DescribeDomainsResponse, _
43
50
  export declare class DescribeDomainsCommand extends $Command<DescribeDomainsCommandInput, DescribeDomainsCommandOutput, CloudSearchClientResolvedConfig> {
44
51
  readonly input: DescribeDomainsCommandInput;
45
52
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
53
+ /**
54
+ * @public
55
+ */
46
56
  constructor(input: DescribeDomainsCommandInput);
47
57
  /**
48
58
  * @internal
49
59
  */
50
60
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudSearchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeDomainsCommandInput, DescribeDomainsCommandOutput>;
61
+ /**
62
+ * @internal
63
+ */
51
64
  private serialize;
65
+ /**
66
+ * @internal
67
+ */
52
68
  private deserialize;
53
69
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CloudSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudSearchClient";
5
5
  import { DescribeExpressionsRequest, DescribeExpressionsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeExpressionsCommand}.
8
10
  */
9
11
  export interface DescribeExpressionsCommandInput extends DescribeExpressionsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeExpressionsCommand}.
13
17
  */
14
18
  export interface DescribeExpressionsCommandOutput extends DescribeExpressionsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <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>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DescribeExpressionsCommandOutput extends DescribeExpressionsRes
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeExpressionsCommandInput - {@link DescribeExpressionsCommandInput}
34
+ * @returns {@link DescribeExpressionsCommandOutput}
28
35
  * @see {@link DescribeExpressionsCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeExpressionsCommandOutput} for command's `response` shape.
30
37
  * @see {@link CloudSearchClientResolvedConfig | config} for CloudSearchClient's `config` shape.
@@ -44,11 +51,20 @@ export interface DescribeExpressionsCommandOutput extends DescribeExpressionsRes
44
51
  export declare class DescribeExpressionsCommand extends $Command<DescribeExpressionsCommandInput, DescribeExpressionsCommandOutput, CloudSearchClientResolvedConfig> {
45
52
  readonly input: DescribeExpressionsCommandInput;
46
53
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
54
+ /**
55
+ * @public
56
+ */
47
57
  constructor(input: DescribeExpressionsCommandInput);
48
58
  /**
49
59
  * @internal
50
60
  */
51
61
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudSearchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeExpressionsCommandInput, DescribeExpressionsCommandOutput>;
62
+ /**
63
+ * @internal
64
+ */
52
65
  private serialize;
66
+ /**
67
+ * @internal
68
+ */
53
69
  private deserialize;
54
70
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CloudSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudSearchClient";
5
5
  import { DescribeIndexFieldsRequest, DescribeIndexFieldsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeIndexFieldsCommand}.
8
10
  */
9
11
  export interface DescribeIndexFieldsCommandInput extends DescribeIndexFieldsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeIndexFieldsCommand}.
13
17
  */
14
18
  export interface DescribeIndexFieldsCommandOutput extends DescribeIndexFieldsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets information about the index fields configured for the search domain.
18
23
  * 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,
19
24
  * 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>
@@ -27,6 +32,8 @@ export interface DescribeIndexFieldsCommandOutput extends DescribeIndexFieldsRes
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param DescribeIndexFieldsCommandInput - {@link DescribeIndexFieldsCommandInput}
36
+ * @returns {@link DescribeIndexFieldsCommandOutput}
30
37
  * @see {@link DescribeIndexFieldsCommandInput} for command's `input` shape.
31
38
  * @see {@link DescribeIndexFieldsCommandOutput} for command's `response` shape.
32
39
  * @see {@link CloudSearchClientResolvedConfig | config} for CloudSearchClient's `config` shape.
@@ -46,11 +53,20 @@ export interface DescribeIndexFieldsCommandOutput extends DescribeIndexFieldsRes
46
53
  export declare class DescribeIndexFieldsCommand extends $Command<DescribeIndexFieldsCommandInput, DescribeIndexFieldsCommandOutput, CloudSearchClientResolvedConfig> {
47
54
  readonly input: DescribeIndexFieldsCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: DescribeIndexFieldsCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudSearchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeIndexFieldsCommandInput, DescribeIndexFieldsCommandOutput>;
64
+ /**
65
+ * @internal
66
+ */
54
67
  private serialize;
68
+ /**
69
+ * @internal
70
+ */
55
71
  private deserialize;
56
72
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CloudSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudSearchClient";
5
5
  import { DescribeScalingParametersRequest, DescribeScalingParametersResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeScalingParametersCommand}.
8
10
  */
9
11
  export interface DescribeScalingParametersCommandInput extends DescribeScalingParametersRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeScalingParametersCommand}.
13
17
  */
14
18
  export interface DescribeScalingParametersCommandOutput extends DescribeScalingParametersResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <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>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DescribeScalingParametersCommandOutput extends DescribeScalingP
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeScalingParametersCommandInput - {@link DescribeScalingParametersCommandInput}
34
+ * @returns {@link DescribeScalingParametersCommandOutput}
28
35
  * @see {@link DescribeScalingParametersCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeScalingParametersCommandOutput} for command's `response` shape.
30
37
  * @see {@link CloudSearchClientResolvedConfig | config} for CloudSearchClient's `config` shape.
@@ -44,11 +51,20 @@ export interface DescribeScalingParametersCommandOutput extends DescribeScalingP
44
51
  export declare class DescribeScalingParametersCommand extends $Command<DescribeScalingParametersCommandInput, DescribeScalingParametersCommandOutput, CloudSearchClientResolvedConfig> {
45
52
  readonly input: DescribeScalingParametersCommandInput;
46
53
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
54
+ /**
55
+ * @public
56
+ */
47
57
  constructor(input: DescribeScalingParametersCommandInput);
48
58
  /**
49
59
  * @internal
50
60
  */
51
61
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudSearchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeScalingParametersCommandInput, DescribeScalingParametersCommandOutput>;
62
+ /**
63
+ * @internal
64
+ */
52
65
  private serialize;
66
+ /**
67
+ * @internal
68
+ */
53
69
  private deserialize;
54
70
  }