@aws-sdk/client-opensearch 3.926.0 → 3.928.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.
- package/README.md +20 -4
- package/dist-cjs/index.js +88 -0
- package/dist-es/OpenSearch.js +4 -0
- package/dist-es/commands/GetDefaultApplicationSettingCommand.js +22 -0
- package/dist-es/commands/PutDefaultApplicationSettingCommand.js +22 -0
- package/dist-es/commands/index.js +2 -0
- package/dist-es/protocols/Aws_restJson1.js +50 -0
- package/dist-types/OpenSearch.d.ts +19 -4
- package/dist-types/OpenSearchClient.d.ts +8 -6
- package/dist-types/commands/AcceptInboundConnectionCommand.d.ts +1 -2
- package/dist-types/commands/AddDataSourceCommand.d.ts +3 -2
- package/dist-types/commands/AddDirectQueryDataSourceCommand.d.ts +2 -4
- package/dist-types/commands/AddTagsCommand.d.ts +4 -4
- package/dist-types/commands/AssociatePackageCommand.d.ts +3 -3
- package/dist-types/commands/AssociatePackagesCommand.d.ts +2 -1
- package/dist-types/commands/AuthorizeVpcEndpointAccessCommand.d.ts +2 -2
- package/dist-types/commands/CancelServiceSoftwareUpdateCommand.d.ts +5 -3
- package/dist-types/commands/CreateDomainCommand.d.ts +2 -1
- package/dist-types/commands/CreateOutboundConnectionCommand.d.ts +2 -3
- package/dist-types/commands/CreatePackageCommand.d.ts +3 -2
- package/dist-types/commands/DeleteDataSourceCommand.d.ts +2 -1
- package/dist-types/commands/DeleteDirectQueryDataSourceCommand.d.ts +2 -4
- package/dist-types/commands/DeleteDomainCommand.d.ts +2 -2
- package/dist-types/commands/DeleteInboundConnectionCommand.d.ts +2 -3
- package/dist-types/commands/DeleteOutboundConnectionCommand.d.ts +2 -3
- package/dist-types/commands/DeletePackageCommand.d.ts +2 -2
- package/dist-types/commands/DescribeDomainAutoTunesCommand.d.ts +3 -3
- package/dist-types/commands/DescribeDomainChangeProgressCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDomainCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDomainHealthCommand.d.ts +2 -1
- package/dist-types/commands/DescribeDomainNodesCommand.d.ts +3 -2
- package/dist-types/commands/DescribeDomainsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDryRunProgressCommand.d.ts +1 -1
- package/dist-types/commands/DescribeInboundConnectionsCommand.d.ts +2 -3
- package/dist-types/commands/DescribeInstanceTypeLimitsCommand.d.ts +2 -2
- package/dist-types/commands/DescribeOutboundConnectionsCommand.d.ts +2 -3
- package/dist-types/commands/DescribePackagesCommand.d.ts +3 -2
- package/dist-types/commands/DescribeReservedInstanceOfferingsCommand.d.ts +3 -2
- package/dist-types/commands/DescribeReservedInstancesCommand.d.ts +3 -3
- package/dist-types/commands/DissociatePackageCommand.d.ts +5 -4
- package/dist-types/commands/GetCompatibleVersionsCommand.d.ts +2 -2
- package/dist-types/commands/GetDefaultApplicationSettingCommand.d.ts +86 -0
- package/dist-types/commands/GetDirectQueryDataSourceCommand.d.ts +2 -4
- package/dist-types/commands/GetPackageVersionHistoryCommand.d.ts +4 -3
- package/dist-types/commands/GetUpgradeHistoryCommand.d.ts +2 -2
- package/dist-types/commands/GetUpgradeStatusCommand.d.ts +2 -2
- package/dist-types/commands/ListDataSourcesCommand.d.ts +3 -3
- package/dist-types/commands/ListDirectQueryDataSourcesCommand.d.ts +2 -4
- package/dist-types/commands/ListDomainNamesCommand.d.ts +3 -4
- package/dist-types/commands/ListDomainsForPackageCommand.d.ts +2 -2
- package/dist-types/commands/ListInstanceTypeDetailsCommand.d.ts +2 -2
- package/dist-types/commands/ListPackagesForDomainCommand.d.ts +2 -2
- package/dist-types/commands/ListScheduledActionsCommand.d.ts +3 -4
- package/dist-types/commands/ListTagsCommand.d.ts +1 -2
- package/dist-types/commands/ListVersionsCommand.d.ts +1 -1
- package/dist-types/commands/ListVpcEndpointAccessCommand.d.ts +3 -2
- package/dist-types/commands/ListVpcEndpointsForDomainCommand.d.ts +2 -2
- package/dist-types/commands/PutDefaultApplicationSettingCommand.d.ts +91 -0
- package/dist-types/commands/RejectInboundConnectionCommand.d.ts +2 -2
- package/dist-types/commands/RemoveTagsCommand.d.ts +2 -2
- package/dist-types/commands/RevokeVpcEndpointAccessCommand.d.ts +2 -2
- package/dist-types/commands/StartDomainMaintenanceCommand.d.ts +3 -2
- package/dist-types/commands/StartServiceSoftwareUpdateCommand.d.ts +2 -2
- package/dist-types/commands/UpdateDataSourceCommand.d.ts +3 -2
- package/dist-types/commands/UpdateDirectQueryDataSourceCommand.d.ts +2 -4
- package/dist-types/commands/UpdateDomainConfigCommand.d.ts +1 -1
- package/dist-types/commands/UpdatePackageCommand.d.ts +3 -2
- package/dist-types/commands/UpdatePackageScopeCommand.d.ts +2 -1
- package/dist-types/commands/UpdateScheduledActionCommand.d.ts +3 -4
- package/dist-types/commands/UpgradeDomainCommand.d.ts +2 -2
- package/dist-types/commands/index.d.ts +2 -0
- package/dist-types/index.d.ts +4 -4
- package/dist-types/models/models_0.d.ts +904 -793
- package/dist-types/models/models_1.d.ts +257 -183
- package/dist-types/protocols/Aws_restJson1.d.ts +18 -0
- package/dist-types/ts3.4/OpenSearch.d.ts +35 -0
- package/dist-types/ts3.4/OpenSearchClient.d.ts +12 -0
- package/dist-types/ts3.4/commands/GetDefaultApplicationSettingCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListDomainNamesCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/PutDefaultApplicationSettingCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +2 -0
- package/dist-types/ts3.4/models/models_0.d.ts +4 -7
- package/dist-types/ts3.4/models/models_1.d.ts +15 -1
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +24 -0
- package/package.json +5 -5
|
@@ -27,9 +27,8 @@ declare const CreateOutboundConnectionCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Creates a new cross-cluster search connection from a source Amazon OpenSearch Service
|
|
31
|
-
*
|
|
32
|
-
* for Amazon OpenSearch Service</a>.</p>
|
|
30
|
+
* <p>Creates a new cross-cluster search connection from a source Amazon OpenSearch Service
|
|
31
|
+
* domain to a destination domain. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cross-cluster-search.html">Cross-cluster search for Amazon OpenSearch Service</a>.</p>
|
|
33
32
|
* @example
|
|
34
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
34
|
* ```javascript
|
|
@@ -27,8 +27,9 @@ declare const CreatePackageCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Creates a package for use with Amazon OpenSearch Service domains. For more
|
|
31
|
-
*
|
|
30
|
+
* <p>Creates a package for use with Amazon OpenSearch Service domains. For more
|
|
31
|
+
* information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html">Custom packages
|
|
32
|
+
* for Amazon OpenSearch Service</a>.</p>
|
|
32
33
|
* @example
|
|
33
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
35
|
* ```javascript
|
|
@@ -27,7 +27,8 @@ declare const DeleteDataSourceCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Deletes a direct-query data source. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/direct-query-s3-delete.html">Deleting
|
|
30
|
+
* <p>Deletes a direct-query data source. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/direct-query-s3-delete.html">Deleting
|
|
31
|
+
* an Amazon OpenSearch Service data source with Amazon S3</a>.</p>
|
|
31
32
|
* @example
|
|
32
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
34
|
* ```javascript
|
|
@@ -27,10 +27,8 @@ declare const DeleteDirectQueryDataSourceCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>
|
|
31
|
-
*
|
|
32
|
-
* source from Amazon OpenSearch Service.
|
|
33
|
-
* </p>
|
|
30
|
+
* <p> Deletes a previously configured direct query data source from Amazon OpenSearch
|
|
31
|
+
* Service. </p>
|
|
34
32
|
* @example
|
|
35
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
36
34
|
* ```javascript
|
|
@@ -27,8 +27,8 @@ declare const DeleteDomainCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Deletes an Amazon OpenSearch Service domain and all of its data. You can't recover a
|
|
31
|
-
*
|
|
30
|
+
* <p>Deletes an Amazon OpenSearch Service domain and all of its data. You can't recover a
|
|
31
|
+
* domain after you delete it.</p>
|
|
32
32
|
* @example
|
|
33
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
34
|
* ```javascript
|
|
@@ -27,9 +27,8 @@ declare const DeleteInboundConnectionCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Allows the destination Amazon OpenSearch Service domain owner to delete an existing
|
|
31
|
-
*
|
|
32
|
-
* for Amazon OpenSearch Service</a>.</p>
|
|
30
|
+
* <p>Allows the destination Amazon OpenSearch Service domain owner to delete an existing
|
|
31
|
+
* inbound cross-cluster search connection. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cross-cluster-search.html">Cross-cluster search for Amazon OpenSearch Service</a>.</p>
|
|
33
32
|
* @example
|
|
34
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
34
|
* ```javascript
|
|
@@ -27,9 +27,8 @@ declare const DeleteOutboundConnectionCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Allows the source Amazon OpenSearch Service domain owner to delete an existing
|
|
31
|
-
*
|
|
32
|
-
* for Amazon OpenSearch Service</a>.</p>
|
|
30
|
+
* <p>Allows the source Amazon OpenSearch Service domain owner to delete an existing
|
|
31
|
+
* outbound cross-cluster search connection. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cross-cluster-search.html">Cross-cluster search for Amazon OpenSearch Service</a>.</p>
|
|
33
32
|
* @example
|
|
34
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
34
|
* ```javascript
|
|
@@ -27,8 +27,8 @@ declare const DeletePackageCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Deletes an Amazon OpenSearch Service package. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html">Custom
|
|
31
|
-
*
|
|
30
|
+
* <p>Deletes an Amazon OpenSearch Service package. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html">Custom packages
|
|
31
|
+
* for Amazon OpenSearch Service</a>.</p>
|
|
32
32
|
* @example
|
|
33
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
34
|
* ```javascript
|
|
@@ -27,9 +27,9 @@ declare const DescribeDomainAutoTunesCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Returns the list of optimizations that Auto-Tune has made to an Amazon OpenSearch
|
|
31
|
-
*
|
|
32
|
-
*
|
|
30
|
+
* <p>Returns the list of optimizations that Auto-Tune has made to an Amazon OpenSearch
|
|
31
|
+
* Service domain. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html">Auto-Tune for Amazon
|
|
32
|
+
* OpenSearch Service</a>.</p>
|
|
33
33
|
* @example
|
|
34
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
35
|
* ```javascript
|
|
@@ -28,7 +28,7 @@ declare const DescribeDomainChangeProgressCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <p>Returns information about the current blue/green deployment happening on an Amazon
|
|
31
|
-
*
|
|
31
|
+
* OpenSearch Service domain. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-configuration-changes.html">Making configuration changes in Amazon OpenSearch Service</a>.</p>
|
|
32
32
|
* @example
|
|
33
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
34
|
* ```javascript
|
|
@@ -28,7 +28,7 @@ declare const DescribeDomainCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <p>Describes the domain configuration for the specified Amazon OpenSearch Service domain,
|
|
31
|
-
*
|
|
31
|
+
* including the domain ID, domain service endpoint, and domain ARN.</p>
|
|
32
32
|
* @example
|
|
33
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
34
|
* ```javascript
|
|
@@ -27,7 +27,8 @@ declare const DescribeDomainHealthCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Returns information about domain and node health, the standby Availability Zone,
|
|
30
|
+
* <p>Returns information about domain and node health, the standby Availability Zone,
|
|
31
|
+
* number of nodes per Availability Zone, and shard count per node.</p>
|
|
31
32
|
* @example
|
|
32
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
34
|
* ```javascript
|
|
@@ -27,8 +27,9 @@ declare const DescribeDomainNodesCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Returns information about domain and nodes, including data nodes, master nodes,
|
|
31
|
-
*
|
|
30
|
+
* <p>Returns information about domain and nodes, including data nodes, master nodes,
|
|
31
|
+
* ultrawarm nodes, Availability Zone(s), standby nodes, node configurations, and node
|
|
32
|
+
* states.</p>
|
|
32
33
|
* @example
|
|
33
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
35
|
* ```javascript
|
|
@@ -28,7 +28,7 @@ declare const DescribeDomainsCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <p>Returns domain configuration information about the specified Amazon OpenSearch Service
|
|
31
|
-
*
|
|
31
|
+
* domains.</p>
|
|
32
32
|
* @example
|
|
33
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
34
|
* ```javascript
|
|
@@ -28,7 +28,7 @@ declare const DescribeDryRunProgressCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <p>Describes the progress of a pre-update dry run analysis on an Amazon OpenSearch
|
|
31
|
-
*
|
|
31
|
+
* Service domain. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-configuration-changes#dryrun">Determining whether a change will cause a blue/green deployment</a>.</p>
|
|
32
32
|
* @example
|
|
33
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
34
|
* ```javascript
|
|
@@ -27,9 +27,8 @@ declare const DescribeInboundConnectionsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Lists all the inbound cross-cluster search connections for a destination (remote)
|
|
31
|
-
*
|
|
32
|
-
* for Amazon OpenSearch Service</a>.</p>
|
|
30
|
+
* <p>Lists all the inbound cross-cluster search connections for a destination (remote)
|
|
31
|
+
* Amazon OpenSearch Service domain. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cross-cluster-search.html">Cross-cluster search for Amazon OpenSearch Service</a>.</p>
|
|
33
32
|
* @example
|
|
34
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
34
|
* ```javascript
|
|
@@ -27,8 +27,8 @@ declare const DescribeInstanceTypeLimitsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Describes the instance count, storage, and master node limits for a given OpenSearch
|
|
31
|
-
*
|
|
30
|
+
* <p>Describes the instance count, storage, and master node limits for a given OpenSearch
|
|
31
|
+
* or Elasticsearch version and instance type.</p>
|
|
32
32
|
* @example
|
|
33
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
34
|
* ```javascript
|
|
@@ -27,9 +27,8 @@ declare const DescribeOutboundConnectionsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Lists all the outbound cross-cluster connections for a local (source) Amazon
|
|
31
|
-
*
|
|
32
|
-
* for Amazon OpenSearch Service</a>.</p>
|
|
30
|
+
* <p>Lists all the outbound cross-cluster connections for a local (source) Amazon
|
|
31
|
+
* OpenSearch Service domain. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cross-cluster-search.html">Cross-cluster search for Amazon OpenSearch Service</a>.</p>
|
|
33
32
|
* @example
|
|
34
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
34
|
* ```javascript
|
|
@@ -27,8 +27,9 @@ declare const DescribePackagesCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Describes all packages available to OpenSearch Service. For more information, see
|
|
31
|
-
*
|
|
30
|
+
* <p>Describes all packages available to OpenSearch Service. For more information, see
|
|
31
|
+
* <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html">Custom packages
|
|
32
|
+
* for Amazon OpenSearch Service</a>.</p>
|
|
32
33
|
* @example
|
|
33
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
35
|
* ```javascript
|
|
@@ -27,8 +27,9 @@ declare const DescribeReservedInstanceOfferingsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Describes the available Amazon OpenSearch Service Reserved Instance offerings for a
|
|
31
|
-
*
|
|
30
|
+
* <p>Describes the available Amazon OpenSearch Service Reserved Instance offerings for a
|
|
31
|
+
* given Region. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/ri.html">Reserved Instances in Amazon
|
|
32
|
+
* OpenSearch Service</a>.</p>
|
|
32
33
|
* @example
|
|
33
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
35
|
* ```javascript
|
|
@@ -27,9 +27,9 @@ declare const DescribeReservedInstancesCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Describes the Amazon OpenSearch Service instances that you have reserved in a given
|
|
31
|
-
*
|
|
32
|
-
*
|
|
30
|
+
* <p>Describes the Amazon OpenSearch Service instances that you have reserved in a given
|
|
31
|
+
* Region. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/ri.html">Reserved Instances in Amazon
|
|
32
|
+
* OpenSearch Service</a>.</p>
|
|
33
33
|
* @example
|
|
34
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
35
|
* ```javascript
|
|
@@ -27,10 +27,11 @@ declare const DissociatePackageCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Removes a package from the specified Amazon OpenSearch Service domain. The package
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
*
|
|
30
|
+
* <p>Removes a package from the specified Amazon OpenSearch Service domain. The package
|
|
31
|
+
* can't be in use with any OpenSearch index for the dissociation to succeed. The package
|
|
32
|
+
* is still available in OpenSearch Service for association later. For more information,
|
|
33
|
+
* see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html">Custom packages
|
|
34
|
+
* for Amazon OpenSearch Service</a>.</p>
|
|
34
35
|
* @example
|
|
35
36
|
* Use a bare-bones client and the command you need to make an API call.
|
|
36
37
|
* ```javascript
|
|
@@ -27,8 +27,8 @@ declare const GetCompatibleVersionsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Returns a map of OpenSearch or Elasticsearch versions and the versions you can upgrade
|
|
31
|
-
*
|
|
30
|
+
* <p>Returns a map of OpenSearch or Elasticsearch versions and the versions you can upgrade
|
|
31
|
+
* them to.</p>
|
|
32
32
|
* @example
|
|
33
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
34
|
* ```javascript
|
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { GetDefaultApplicationSettingRequest, GetDefaultApplicationSettingResponse } from "../models/models_0";
|
|
4
|
+
import { OpenSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OpenSearchClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetDefaultApplicationSettingCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetDefaultApplicationSettingCommandInput extends GetDefaultApplicationSettingRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetDefaultApplicationSettingCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetDefaultApplicationSettingCommandOutput extends GetDefaultApplicationSettingResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetDefaultApplicationSettingCommand_base: {
|
|
25
|
+
new (input: GetDefaultApplicationSettingCommandInput): import("@smithy/smithy-client").CommandImpl<GetDefaultApplicationSettingCommandInput, GetDefaultApplicationSettingCommandOutput, OpenSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (...[input]: [] | [GetDefaultApplicationSettingCommandInput]): import("@smithy/smithy-client").CommandImpl<GetDefaultApplicationSettingCommandInput, GetDefaultApplicationSettingCommandOutput, OpenSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Gets the ARN of the current default application.</p>
|
|
31
|
+
* <p> If the default application isn't set, the operation returns a resource not found
|
|
32
|
+
* error.</p>
|
|
33
|
+
* @example
|
|
34
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
35
|
+
* ```javascript
|
|
36
|
+
* import { OpenSearchClient, GetDefaultApplicationSettingCommand } from "@aws-sdk/client-opensearch"; // ES Modules import
|
|
37
|
+
* // const { OpenSearchClient, GetDefaultApplicationSettingCommand } = require("@aws-sdk/client-opensearch"); // CommonJS import
|
|
38
|
+
* // import type { OpenSearchClientConfig } from "@aws-sdk/client-opensearch";
|
|
39
|
+
* const config = {}; // type is OpenSearchClientConfig
|
|
40
|
+
* const client = new OpenSearchClient(config);
|
|
41
|
+
* const input = {};
|
|
42
|
+
* const command = new GetDefaultApplicationSettingCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // { // GetDefaultApplicationSettingResponse
|
|
45
|
+
* // applicationArn: "STRING_VALUE",
|
|
46
|
+
* // };
|
|
47
|
+
*
|
|
48
|
+
* ```
|
|
49
|
+
*
|
|
50
|
+
* @param GetDefaultApplicationSettingCommandInput - {@link GetDefaultApplicationSettingCommandInput}
|
|
51
|
+
* @returns {@link GetDefaultApplicationSettingCommandOutput}
|
|
52
|
+
* @see {@link GetDefaultApplicationSettingCommandInput} for command's `input` shape.
|
|
53
|
+
* @see {@link GetDefaultApplicationSettingCommandOutput} for command's `response` shape.
|
|
54
|
+
* @see {@link OpenSearchClientResolvedConfig | config} for OpenSearchClient's `config` shape.
|
|
55
|
+
*
|
|
56
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
57
|
+
* <p>An error occurred because you don't have permissions to access the resource.</p>
|
|
58
|
+
*
|
|
59
|
+
* @throws {@link InternalException} (server fault)
|
|
60
|
+
* <p>Request processing failed because of an unknown error, exception, or internal failure.</p>
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
63
|
+
* <p>An exception for accessing or deleting a resource that doesn't exist.</p>
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link ValidationException} (client fault)
|
|
66
|
+
* <p>An exception for accessing or deleting a resource that doesn't exist.</p>
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link OpenSearchServiceException}
|
|
69
|
+
* <p>Base exception class for all service exceptions from OpenSearch service.</p>
|
|
70
|
+
*
|
|
71
|
+
*
|
|
72
|
+
* @public
|
|
73
|
+
*/
|
|
74
|
+
export declare class GetDefaultApplicationSettingCommand extends GetDefaultApplicationSettingCommand_base {
|
|
75
|
+
/** @internal type navigation helper, not in runtime. */
|
|
76
|
+
protected static __types: {
|
|
77
|
+
api: {
|
|
78
|
+
input: {};
|
|
79
|
+
output: GetDefaultApplicationSettingResponse;
|
|
80
|
+
};
|
|
81
|
+
sdk: {
|
|
82
|
+
input: GetDefaultApplicationSettingCommandInput;
|
|
83
|
+
output: GetDefaultApplicationSettingCommandOutput;
|
|
84
|
+
};
|
|
85
|
+
};
|
|
86
|
+
}
|
|
@@ -27,10 +27,8 @@ declare const GetDirectQueryDataSourceCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>
|
|
31
|
-
*
|
|
32
|
-
* a specific direct query data source in Amazon OpenSearch Service.
|
|
33
|
-
* </p>
|
|
30
|
+
* <p> Returns detailed configuration information for a specific direct query data source in
|
|
31
|
+
* Amazon OpenSearch Service. </p>
|
|
34
32
|
* @example
|
|
35
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
36
34
|
* ```javascript
|
|
@@ -27,9 +27,10 @@ declare const GetPackageVersionHistoryCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Returns a list of Amazon OpenSearch Service package versions, along with their
|
|
31
|
-
*
|
|
32
|
-
*
|
|
30
|
+
* <p>Returns a list of Amazon OpenSearch Service package versions, along with their
|
|
31
|
+
* creation time, commit message, and plugin properties (if the package is a zip plugin
|
|
32
|
+
* package). For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html">Custom packages
|
|
33
|
+
* for Amazon OpenSearch Service</a>.</p>
|
|
33
34
|
* @example
|
|
34
35
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
36
|
* ```javascript
|
|
@@ -27,8 +27,8 @@ declare const GetUpgradeHistoryCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Retrieves the complete history of the last 10 upgrades performed on an Amazon
|
|
31
|
-
*
|
|
30
|
+
* <p>Retrieves the complete history of the last 10 upgrades performed on an Amazon
|
|
31
|
+
* OpenSearch Service domain.</p>
|
|
32
32
|
* @example
|
|
33
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
34
|
* ```javascript
|
|
@@ -27,8 +27,8 @@ declare const GetUpgradeStatusCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Returns the most recent status of the last upgrade or upgrade eligibility check
|
|
31
|
-
*
|
|
30
|
+
* <p>Returns the most recent status of the last upgrade or upgrade eligibility check
|
|
31
|
+
* performed on an Amazon OpenSearch Service domain.</p>
|
|
32
32
|
* @example
|
|
33
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
34
|
* ```javascript
|
|
@@ -27,9 +27,9 @@ declare const ListDataSourcesCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Lists direct-query data sources for a specific domain. For more information, see
|
|
31
|
-
*
|
|
32
|
-
*
|
|
30
|
+
* <p>Lists direct-query data sources for a specific domain. For more information, see For
|
|
31
|
+
* more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/direct-query-s3.html">Working with
|
|
32
|
+
* Amazon OpenSearch Service direct queries with Amazon S3</a>.</p>
|
|
33
33
|
* @example
|
|
34
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
35
|
* ```javascript
|
|
@@ -27,10 +27,8 @@ declare const ListDirectQueryDataSourcesCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>
|
|
31
|
-
*
|
|
32
|
-
* have configured within Amazon OpenSearch Service.
|
|
33
|
-
* </p>
|
|
30
|
+
* <p> Lists an inventory of all the direct query data sources that you have configured
|
|
31
|
+
* within Amazon OpenSearch Service. </p>
|
|
34
32
|
* @example
|
|
35
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
36
34
|
* ```javascript
|
|
@@ -1,7 +1,6 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
-
import { ListDomainNamesRequest } from "../models/
|
|
4
|
-
import { ListDomainNamesResponse } from "../models/models_1";
|
|
3
|
+
import { ListDomainNamesRequest, ListDomainNamesResponse } from "../models/models_1";
|
|
5
4
|
import { OpenSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OpenSearchClient";
|
|
6
5
|
/**
|
|
7
6
|
* @public
|
|
@@ -28,8 +27,8 @@ declare const ListDomainNamesCommand_base: {
|
|
|
28
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
29
28
|
};
|
|
30
29
|
/**
|
|
31
|
-
* <p>Returns the names of all Amazon OpenSearch Service domains owned by the current user
|
|
32
|
-
*
|
|
30
|
+
* <p>Returns the names of all Amazon OpenSearch Service domains owned by the current user
|
|
31
|
+
* in the active Region.</p>
|
|
33
32
|
* @example
|
|
34
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
34
|
* ```javascript
|
|
@@ -28,8 +28,8 @@ declare const ListDomainsForPackageCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <p>Lists all Amazon OpenSearch Service domains associated with a given package. For more
|
|
31
|
-
*
|
|
32
|
-
*
|
|
31
|
+
* information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html">Custom packages
|
|
32
|
+
* for Amazon OpenSearch Service</a>.</p>
|
|
33
33
|
* @example
|
|
34
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
35
|
* ```javascript
|
|
@@ -27,8 +27,8 @@ declare const ListInstanceTypeDetailsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Lists all instance types and available features for a given OpenSearch or
|
|
31
|
-
*
|
|
30
|
+
* <p>Lists all instance types and available features for a given OpenSearch or
|
|
31
|
+
* Elasticsearch version.</p>
|
|
32
32
|
* @example
|
|
33
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
34
|
* ```javascript
|
|
@@ -28,8 +28,8 @@ declare const ListPackagesForDomainCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <p>Lists all packages associated with an Amazon OpenSearch Service domain. For more
|
|
31
|
-
*
|
|
32
|
-
*
|
|
31
|
+
* information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html">Custom packages
|
|
32
|
+
* for Amazon OpenSearch Service</a>.</p>
|
|
33
33
|
* @example
|
|
34
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
35
|
* ```javascript
|
|
@@ -27,10 +27,9 @@ declare const ListScheduledActionsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Retrieves a list of configuration changes that are scheduled for a domain. These
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
* Auto-Tune enhancements</a>.</p>
|
|
30
|
+
* <p>Retrieves a list of configuration changes that are scheduled for a domain. These
|
|
31
|
+
* changes can be <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/service-software.html">service
|
|
32
|
+
* software updates</a> or <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html#auto-tune-types">blue/green Auto-Tune enhancements</a>.</p>
|
|
34
33
|
* @example
|
|
35
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
36
35
|
* ```javascript
|
|
@@ -28,8 +28,7 @@ declare const ListTagsCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <p>Returns all resource tags for an Amazon OpenSearch Service domain, data source, or
|
|
31
|
-
*
|
|
32
|
-
* Amazon OpenSearch Service resources</a>.</p>
|
|
31
|
+
* application. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-awsresourcetagging.html">Tagging Amazon OpenSearch Service resources</a>.</p>
|
|
33
32
|
* @example
|
|
34
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
34
|
* ```javascript
|
|
@@ -28,7 +28,7 @@ declare const ListVersionsCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <p>Lists all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service
|
|
31
|
-
*
|
|
31
|
+
* supports.</p>
|
|
32
32
|
* @example
|
|
33
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
34
|
* ```javascript
|
|
@@ -27,8 +27,9 @@ declare const ListVpcEndpointAccessCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Retrieves information about each Amazon Web Services principal that is allowed to
|
|
31
|
-
*
|
|
30
|
+
* <p>Retrieves information about each Amazon Web Services principal that is allowed to
|
|
31
|
+
* access a given Amazon OpenSearch Service domain through the use of an interface VPC
|
|
32
|
+
* endpoint.</p>
|
|
32
33
|
* @example
|
|
33
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
35
|
* ```javascript
|
|
@@ -27,8 +27,8 @@ declare const ListVpcEndpointsForDomainCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a
|
|
31
|
-
*
|
|
30
|
+
* <p>Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a
|
|
31
|
+
* particular domain.</p>
|
|
32
32
|
* @example
|
|
33
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
34
|
* ```javascript
|