@aws-sdk/client-opensearch 3.925.0 → 3.927.0

package/dist-types/commands/PutDefaultApplicationSettingCommand.d.ts

@@ -0,0 +1,91 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { PutDefaultApplicationSettingRequest, PutDefaultApplicationSettingResponse } from "../models/models_1";
+import { OpenSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OpenSearchClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link PutDefaultApplicationSettingCommand}.
+ */
+export interface PutDefaultApplicationSettingCommandInput extends PutDefaultApplicationSettingRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link PutDefaultApplicationSettingCommand}.
+ */
+export interface PutDefaultApplicationSettingCommandOutput extends PutDefaultApplicationSettingResponse, __MetadataBearer {
+}
+declare const PutDefaultApplicationSettingCommand_base: {
+    new (input: PutDefaultApplicationSettingCommandInput): import("@smithy/smithy-client").CommandImpl<PutDefaultApplicationSettingCommandInput, PutDefaultApplicationSettingCommandOutput, OpenSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: PutDefaultApplicationSettingCommandInput): import("@smithy/smithy-client").CommandImpl<PutDefaultApplicationSettingCommandInput, PutDefaultApplicationSettingCommandOutput, OpenSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Sets the default application to the application with the specified ARN.</p>
+ *          <p> To remove the default application, use the <code>GetDefaultApplicationSetting</code>
+ *             operation to get the current default and then call the
+ *                 <code>PutDefaultApplicationSetting</code> with the current applications ARN and the
+ *                 <code>setAsDefault</code> parameter set to <code>false</code>.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { OpenSearchClient, PutDefaultApplicationSettingCommand } from "@aws-sdk/client-opensearch"; // ES Modules import
+ * // const { OpenSearchClient, PutDefaultApplicationSettingCommand } = require("@aws-sdk/client-opensearch"); // CommonJS import
+ * // import type { OpenSearchClientConfig } from "@aws-sdk/client-opensearch";
+ * const config = {}; // type is OpenSearchClientConfig
+ * const client = new OpenSearchClient(config);
+ * const input = { // PutDefaultApplicationSettingRequest
+ *   applicationArn: "STRING_VALUE", // required
+ *   setAsDefault: true || false, // required
+ * };
+ * const command = new PutDefaultApplicationSettingCommand(input);
+ * const response = await client.send(command);
+ * // { // PutDefaultApplicationSettingResponse
+ * //   applicationArn: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param PutDefaultApplicationSettingCommandInput - {@link PutDefaultApplicationSettingCommandInput}
+ * @returns {@link PutDefaultApplicationSettingCommandOutput}
+ * @see {@link PutDefaultApplicationSettingCommandInput} for command's `input` shape.
+ * @see {@link PutDefaultApplicationSettingCommandOutput} for command's `response` shape.
+ * @see {@link OpenSearchClientResolvedConfig | config} for OpenSearchClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>An error occurred because you don't have permissions to access the resource.</p>
+ *
+ * @throws {@link InternalException} (server fault)
+ *  <p>Request processing failed because of an unknown error, exception, or internal failure.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>An exception for accessing or deleting a resource that doesn't exist.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>An exception for accessing or deleting a resource that doesn't exist.</p>
+ *
+ * @throws {@link OpenSearchServiceException}
+ * <p>Base exception class for all service exceptions from OpenSearch service.</p>
+ *
+ *
+ * @public
+ */
+export declare class PutDefaultApplicationSettingCommand extends PutDefaultApplicationSettingCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: PutDefaultApplicationSettingRequest;
+            output: PutDefaultApplicationSettingResponse;
+        };
+        sdk: {
+            input: PutDefaultApplicationSettingCommandInput;
+            output: PutDefaultApplicationSettingCommandOutput;
+        };
+    };
+}

package/dist-types/commands/RejectInboundConnectionCommand.d.ts

@@ -27,8 +27,8 @@ declare const RejectInboundConnectionCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Allows the remote Amazon OpenSearch Service domain owner to reject an inbound cross-cluster
- *    connection request.</p>
+ * <p>Allows the remote Amazon OpenSearch Service domain owner to reject an inbound
+ *             cross-cluster connection request.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/RemoveTagsCommand.d.ts

@@ -27,8 +27,8 @@ declare const RemoveTagsCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Removes the specified set of tags from an Amazon OpenSearch Service domain, data source, or
- *    application. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains.html#managedomains-awsresorcetagging"> Tagging Amazon OpenSearch Service resources</a>.</p>
+ * <p>Removes the specified set of tags from an Amazon OpenSearch Service domain, data
+ *             source, or application. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains.html#managedomains-awsresorcetagging"> Tagging Amazon OpenSearch Service resources</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/RevokeVpcEndpointAccessCommand.d.ts

@@ -27,8 +27,8 @@ declare const RevokeVpcEndpointAccessCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Revokes access to an Amazon OpenSearch Service domain that was provided through an interface
- *    VPC endpoint.</p>
+ * <p>Revokes access to an Amazon OpenSearch Service domain that was provided through an
+ *             interface VPC endpoint.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/StartDomainMaintenanceCommand.d.ts

@@ -27,8 +27,9 @@ declare const StartDomainMaintenanceCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Starts the node maintenance process on the data node. These processes can include a node reboot, an Opensearch or Elasticsearch process restart,
- *    or a Dashboard or Kibana restart.</p>
+ * <p>Starts the node maintenance process on the data node. These processes can include a
+ *             node reboot, an Opensearch or Elasticsearch process restart, or a Dashboard or Kibana
+ *             restart.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/StartServiceSoftwareUpdateCommand.d.ts

@@ -28,8 +28,8 @@ declare const StartServiceSoftwareUpdateCommand_base: {
 };
 /**
  * <p>Schedules a service software update for an Amazon OpenSearch Service domain. For more
- *    information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/service-software.html">Service software updates in
- *     Amazon OpenSearch Service</a>.</p>
+ *             information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/service-software.html">Service
+ *                 software updates in Amazon OpenSearch Service</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/UpdateDataSourceCommand.d.ts

@@ -27,8 +27,9 @@ declare const UpdateDataSourceCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Updates a direct-query data source. For more information, see
- *    <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/direct-query-s3-creating.html">Working with Amazon OpenSearch Service data source integrations with Amazon S3</a>.</p>
+ * <p>Updates a direct-query data source. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/direct-query-s3-creating.html">Working
+ *                 with Amazon OpenSearch Service data source integrations with Amazon
+ *             S3</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/UpdateDirectQueryDataSourceCommand.d.ts

@@ -27,10 +27,8 @@ declare const UpdateDirectQueryDataSourceCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>
- *    Updates the configuration or properties of an existing
- *    direct query data source in Amazon OpenSearch Service.
- *   </p>
+ * <p> Updates the configuration or properties of an existing direct query data source in
+ *             Amazon OpenSearch Service. </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/UpdateDomainConfigCommand.d.ts

@@ -28,7 +28,7 @@ declare const UpdateDomainConfigCommand_base: {
 };
 /**
  * <p>Modifies the cluster configuration of the specified Amazon OpenSearch Service
- *    domain.</p>
+ *             domain.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/UpdatePackageCommand.d.ts

@@ -27,8 +27,9 @@ declare const UpdatePackageCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Updates a package for use with Amazon OpenSearch Service domains. For more information, see
- *     <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html">Custom packages for Amazon OpenSearch Service</a>.</p>
+ * <p>Updates a package for use with Amazon OpenSearch Service domains. For more
+ *             information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html">Custom packages
+ *                 for Amazon OpenSearch Service</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/UpdatePackageScopeCommand.d.ts

@@ -27,7 +27,8 @@ declare const UpdatePackageScopeCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Updates the scope of a package. Scope of the package defines users who can view and associate a package.</p>
+ * <p>Updates the scope of a package. Scope of the package defines users who can view and
+ *             associate a package.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/UpdateScheduledActionCommand.d.ts

@@ -27,10 +27,9 @@ declare const UpdateScheduledActionCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Reschedules a planned domain configuration change for a later time. This change can be a
- *    scheduled <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/service-software.html">service software
- *     update</a> or a <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html#auto-tune-types">blue/green
- *      Auto-Tune enhancement</a>.</p>
+ * <p>Reschedules a planned domain configuration change for a later time. This change can be
+ *             a scheduled <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/service-software.html">service
+ *                 software update</a> or a <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html#auto-tune-types">blue/green Auto-Tune enhancement</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/UpgradeDomainCommand.d.ts

@@ -27,8 +27,8 @@ declare const UpgradeDomainCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Allows you to either upgrade your Amazon OpenSearch Service domain or perform an upgrade
- *    eligibility check to a compatible version of OpenSearch or Elasticsearch.</p>
+ * <p>Allows you to either upgrade your Amazon OpenSearch Service domain or perform an
+ *             upgrade eligibility check to a compatible version of OpenSearch or Elasticsearch.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/index.d.ts

@@ -40,6 +40,7 @@ export * from "./DissociatePackagesCommand";
 export * from "./GetApplicationCommand";
 export * from "./GetCompatibleVersionsCommand";
 export * from "./GetDataSourceCommand";
+export * from "./GetDefaultApplicationSettingCommand";
 export * from "./GetDirectQueryDataSourceCommand";
 export * from "./GetDomainMaintenanceStatusCommand";
 export * from "./GetPackageVersionHistoryCommand";
@@ -60,6 +61,7 @@ export * from "./ListVpcEndpointAccessCommand";
 export * from "./ListVpcEndpointsCommand";
 export * from "./ListVpcEndpointsForDomainCommand";
 export * from "./PurchaseReservedInstanceOfferingCommand";
+export * from "./PutDefaultApplicationSettingCommand";
 export * from "./RejectInboundConnectionCommand";
 export * from "./RemoveTagsCommand";
 export * from "./RevokeVpcEndpointAccessCommand";

package/dist-types/index.d.ts

@@ -1,9 +1,9 @@
 /**
  * <p>Use the Amazon OpenSearch Service configuration API to create, configure, and manage
- *    OpenSearch Service domains. The endpoint for configuration service requests is Region specific:
- *     es.<i>region</i>.amazonaws.com. For example, es.us-east-1.amazonaws.com. For a
- *    current list of supported Regions and endpoints, see <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html#service-regions">Amazon Web Services service
- *    endpoints</a>.</p>
+ *             OpenSearch Service domains. The endpoint for configuration service requests is Region
+ *             specific: es.<i>region</i>.amazonaws.com. For example,
+ *             es.us-east-1.amazonaws.com. For a current list of supported Regions and endpoints, see
+ *                 <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html#service-regions">Amazon Web Services service endpoints</a>.</p>
  *
  * @packageDocumentation
  */