feat(client-backupsearch): Using recommended smithy trait to generate regional endpoints for Backup Search

awstools · awstools · commit 6e6a0a6e3068 · 2025-08-12T18:12:54.000Z
diff --git a/clients/client-backupsearch/README.md b/clients/client-backupsearch/README.md
@@ -6,23 +6,7 @@
 
 AWS SDK for JavaScript BackupSearch Client for Node.js, Browser and React Native.
 
-<fullname>Backup Search</fullname>
-
-<p>Backup Search is the recovery point and item level search for Backup.</p>
-<p>For additional information, see:</p>
-<ul>
-<li>
-<p>
-<a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/api-reference.html">Backup API Reference</a>
-</p>
-</li>
-<li>
-<p>
-<a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html">Backup
-Developer Guide</a>
-</p>
-</li>
-</ul>
+<fullname>Backup Search</fullname> <p>Backup Search is the recovery point and item level search for Backup.</p> <p>For additional information, see:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/api-reference.html">Backup API Reference</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html">Backup Developer Guide</a> </p> </li> </ul>
 
 ## Installing
 
diff --git a/clients/client-backupsearch/src/BackupSearch.ts b/clients/client-backupsearch/src/BackupSearch.ts
@@ -254,22 +254,7 @@ export interface BackupSearch {
 }
 
 /**
- * <fullname>Backup Search</fullname>
- *          <p>Backup Search is the recovery point and item level search for Backup.</p>
- *          <p>For additional information, see:</p>
- *          <ul>
- *             <li>
- *                <p>
- *                   <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/api-reference.html">Backup API Reference</a>
- *                </p>
- *             </li>
- *             <li>
- *                <p>
- *                   <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html">Backup
- *             Developer Guide</a>
- *                </p>
- *             </li>
- *          </ul>
+ * <fullname>Backup Search</fullname> <p>Backup Search is the recovery point and item level search for Backup.</p> <p>For additional information, see:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/api-reference.html">Backup API Reference</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html">Backup Developer Guide</a> </p> </li> </ul>
  * @public
  */
 export class BackupSearch extends BackupSearchClient implements BackupSearch {}
diff --git a/clients/client-backupsearch/src/BackupSearchClient.ts b/clients/client-backupsearch/src/BackupSearchClient.ts
@@ -319,22 +319,7 @@ export type BackupSearchClientResolvedConfigType = __SmithyResolvedConfiguration
 export interface BackupSearchClientResolvedConfig extends BackupSearchClientResolvedConfigType {}
 
 /**
- * <fullname>Backup Search</fullname>
- *          <p>Backup Search is the recovery point and item level search for Backup.</p>
- *          <p>For additional information, see:</p>
- *          <ul>
- *             <li>
- *                <p>
- *                   <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/api-reference.html">Backup API Reference</a>
- *                </p>
- *             </li>
- *             <li>
- *                <p>
- *                   <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html">Backup
- *             Developer Guide</a>
- *                </p>
- *             </li>
- *          </ul>
+ * <fullname>Backup Search</fullname> <p>Backup Search is the recovery point and item level search for Backup.</p> <p>For additional information, see:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/api-reference.html">Backup API Reference</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html">Backup Developer Guide</a> </p> </li> </ul>
  * @public
  */
 export class BackupSearchClient extends __Client<
diff --git a/clients/client-backupsearch/src/commands/GetSearchJobCommand.ts b/clients/client-backupsearch/src/commands/GetSearchJobCommand.ts
@@ -28,8 +28,7 @@ export interface GetSearchJobCommandInput extends GetSearchJobInput {}
 export interface GetSearchJobCommandOutput extends GetSearchJobOutput, __MetadataBearer {}
 
 /**
- * <p>This operation retrieves metadata of a search job,
- *       including its progress.</p>
+ * <p>This operation retrieves metadata of a search job, including its progress.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -152,9 +151,7 @@ export interface GetSearchJobCommandOutput extends GetSearchJobOutput, __Metadat
  * @see {@link BackupSearchClientResolvedConfig | config} for BackupSearchClient's `config` shape.
  *
  * @throws {@link ResourceNotFoundException} (client fault)
- *  <p>The resource was not found for this request.</p>
- *          <p>Confirm the resource information, such as the ARN or type is correct
- *             and exists, then retry the request.</p>
+ *  <p>The resource was not found for this request.</p> <p>Confirm the resource information, such as the ARN or type is correct and exists, then retry the request.</p>
  *
  * @throws {@link AccessDeniedException} (client fault)
  *  <p>You do not have sufficient access to perform this action.</p>
diff --git a/clients/client-backupsearch/src/commands/GetSearchResultExportJobCommand.ts b/clients/client-backupsearch/src/commands/GetSearchResultExportJobCommand.ts
@@ -28,12 +28,7 @@ export interface GetSearchResultExportJobCommandInput extends GetSearchResultExp
 export interface GetSearchResultExportJobCommandOutput extends GetSearchResultExportJobOutput, __MetadataBearer {}
 
 /**
- * <p>This operation retrieves the metadata of an export job.</p>
- *          <p>An export job is an operation that transmits the results
- *       of a search job to a specified S3 bucket in a
- *       .csv file.</p>
- *          <p>An export job allows you to retain results of a search
- *       beyond the search job's scheduled retention of 7 days.</p>
+ * <p>This operation retrieves the metadata of an export job.</p> <p>An export job is an operation that transmits the results of a search job to a specified S3 bucket in a .csv file.</p> <p>An export job allows you to retain results of a search beyond the search job's scheduled retention of 7 days.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -70,9 +65,7 @@ export interface GetSearchResultExportJobCommandOutput extends GetSearchResultEx
  * @see {@link BackupSearchClientResolvedConfig | config} for BackupSearchClient's `config` shape.
  *
  * @throws {@link ResourceNotFoundException} (client fault)
- *  <p>The resource was not found for this request.</p>
- *          <p>Confirm the resource information, such as the ARN or type is correct
- *             and exists, then retry the request.</p>
+ *  <p>The resource was not found for this request.</p> <p>Confirm the resource information, such as the ARN or type is correct and exists, then retry the request.</p>
  *
  * @throws {@link AccessDeniedException} (client fault)
  *  <p>You do not have sufficient access to perform this action.</p>
diff --git a/clients/client-backupsearch/src/commands/ListSearchJobBackupsCommand.ts b/clients/client-backupsearch/src/commands/ListSearchJobBackupsCommand.ts
@@ -28,19 +28,7 @@ export interface ListSearchJobBackupsCommandInput extends ListSearchJobBackupsIn
 export interface ListSearchJobBackupsCommandOutput extends ListSearchJobBackupsOutput, __MetadataBearer {}
 
 /**
- * <p>This operation returns a list of all backups (recovery
- *       points) in a paginated format that were included in
- *       the search job.</p>
- *          <p>If a search does not display an expected backup in
- *       the results, you can call this operation to display each
- *       backup included in the search. Any backups that were not
- *       included because they have a <code>FAILED</code> status
- *       from a permissions issue will be displayed, along with a
- *       status message.</p>
- *          <p>Only recovery points with a backup index that has
- *       a status of <code>ACTIVE</code> will be included in search results.
- *       If the index has any other status, its status will be
- *       displayed along with a status message.</p>
+ * <p>This operation returns a list of all backups (recovery points) in a paginated format that were included in the search job.</p> <p>If a search does not display an expected backup in the results, you can call this operation to display each backup included in the search. Any backups that were not included because they have a <code>FAILED</code> status from a permissions issue will be displayed, along with a status message.</p> <p>Only recovery points with a backup index that has a status of <code>ACTIVE</code> will be included in search results. If the index has any other status, its status will be displayed along with a status message.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -78,9 +66,7 @@ export interface ListSearchJobBackupsCommandOutput extends ListSearchJobBackupsO
  * @see {@link BackupSearchClientResolvedConfig | config} for BackupSearchClient's `config` shape.
  *
  * @throws {@link ResourceNotFoundException} (client fault)
- *  <p>The resource was not found for this request.</p>
- *          <p>Confirm the resource information, such as the ARN or type is correct
- *             and exists, then retry the request.</p>
+ *  <p>The resource was not found for this request.</p> <p>Confirm the resource information, such as the ARN or type is correct and exists, then retry the request.</p>
  *
  * @throws {@link AccessDeniedException} (client fault)
  *  <p>You do not have sufficient access to perform this action.</p>
diff --git a/clients/client-backupsearch/src/commands/ListSearchJobResultsCommand.ts b/clients/client-backupsearch/src/commands/ListSearchJobResultsCommand.ts
@@ -83,9 +83,7 @@ export interface ListSearchJobResultsCommandOutput extends ListSearchJobResultsO
  * @see {@link BackupSearchClientResolvedConfig | config} for BackupSearchClient's `config` shape.
  *
  * @throws {@link ResourceNotFoundException} (client fault)
- *  <p>The resource was not found for this request.</p>
- *          <p>Confirm the resource information, such as the ARN or type is correct
- *             and exists, then retry the request.</p>
+ *  <p>The resource was not found for this request.</p> <p>Confirm the resource information, such as the ARN or type is correct and exists, then retry the request.</p>
  *
  * @throws {@link AccessDeniedException} (client fault)
  *  <p>You do not have sufficient access to perform this action.</p>
diff --git a/clients/client-backupsearch/src/commands/ListSearchJobsCommand.ts b/clients/client-backupsearch/src/commands/ListSearchJobsCommand.ts
@@ -28,8 +28,7 @@ export interface ListSearchJobsCommandInput extends ListSearchJobsInput {}
 export interface ListSearchJobsCommandOutput extends ListSearchJobsOutput, __MetadataBearer {}
 
 /**
- * <p>This operation returns a list of search jobs belonging
- *       to an account.</p>
+ * <p>This operation returns a list of search jobs belonging to an account.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
diff --git a/clients/client-backupsearch/src/commands/ListSearchResultExportJobsCommand.ts b/clients/client-backupsearch/src/commands/ListSearchResultExportJobsCommand.ts
@@ -28,8 +28,7 @@ export interface ListSearchResultExportJobsCommandInput extends ListSearchResult
 export interface ListSearchResultExportJobsCommandOutput extends ListSearchResultExportJobsOutput, __MetadataBearer {}
 
 /**
- * <p>This operation exports search results of a search job
- *       to a specified destination S3 bucket.</p>
+ * <p>This operation exports search results of a search job to a specified destination S3 bucket.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -68,9 +67,7 @@ export interface ListSearchResultExportJobsCommandOutput extends ListSearchResul
  * @see {@link BackupSearchClientResolvedConfig | config} for BackupSearchClient's `config` shape.
  *
  * @throws {@link ResourceNotFoundException} (client fault)
- *  <p>The resource was not found for this request.</p>
- *          <p>Confirm the resource information, such as the ARN or type is correct
- *             and exists, then retry the request.</p>
+ *  <p>The resource was not found for this request.</p> <p>Confirm the resource information, such as the ARN or type is correct and exists, then retry the request.</p>
  *
  * @throws {@link ServiceQuotaExceededException} (client fault)
  *  <p>The request denied due to exceeding the quota limits permitted.</p>
diff --git a/clients/client-backupsearch/src/commands/ListTagsForResourceCommand.ts b/clients/client-backupsearch/src/commands/ListTagsForResourceCommand.ts
@@ -55,9 +55,7 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
  * @see {@link BackupSearchClientResolvedConfig | config} for BackupSearchClient's `config` shape.
  *
  * @throws {@link ResourceNotFoundException} (client fault)
- *  <p>The resource was not found for this request.</p>
- *          <p>Confirm the resource information, such as the ARN or type is correct
- *             and exists, then retry the request.</p>
+ *  <p>The resource was not found for this request.</p> <p>Confirm the resource information, such as the ARN or type is correct and exists, then retry the request.</p>
  *
  * @throws {@link AccessDeniedException} (client fault)
  *  <p>You do not have sufficient access to perform this action.</p>
diff --git a/clients/client-backupsearch/src/commands/StartSearchJobCommand.ts b/clients/client-backupsearch/src/commands/StartSearchJobCommand.ts
@@ -28,11 +28,7 @@ export interface StartSearchJobCommandInput extends StartSearchJobInput {}
 export interface StartSearchJobCommandOutput extends StartSearchJobOutput, __MetadataBearer {}
 
 /**
- * <p>This operation creates a search job which returns
- *       recovery points filtered by SearchScope and items
- *       filtered by ItemFilters.</p>
- *          <p>You can optionally include ClientToken,
- *       EncryptionKeyArn, Name, and/or Tags.</p>
+ * <p>This operation creates a search job which returns recovery points filtered by SearchScope and items filtered by ItemFilters.</p> <p>You can optionally include ClientToken, EncryptionKeyArn, Name, and/or Tags.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -146,12 +142,10 @@ export interface StartSearchJobCommandOutput extends StartSearchJobOutput, __Met
  * @see {@link BackupSearchClientResolvedConfig | config} for BackupSearchClient's `config` shape.
  *
  * @throws {@link ConflictException} (client fault)
- *  <p>This exception occurs when a conflict with a previous successful
- *             operation is detected. This generally occurs when the previous
- *             operation did not have time to propagate to the host serving the
- *             current request.</p>
- *          <p>A retry (with appropriate backoff logic) is the recommended
- *             response to this exception.</p>
+ *  <p>This exception occurs when a conflict with a previous successful operation is detected. This generally occurs when the previous operation did not have time to propagate to the host serving the current request.</p> <p>A retry (with appropriate backoff logic) is the recommended response to this exception.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The resource was not found for this request.</p> <p>Confirm the resource information, such as the ARN or type is correct and exists, then retry the request.</p>
  *
  * @throws {@link ServiceQuotaExceededException} (client fault)
  *  <p>The request denied due to exceeding the quota limits permitted.</p>
diff --git a/clients/client-backupsearch/src/commands/StartSearchResultExportJobCommand.ts b/clients/client-backupsearch/src/commands/StartSearchResultExportJobCommand.ts
@@ -28,8 +28,7 @@ export interface StartSearchResultExportJobCommandInput extends StartSearchResul
 export interface StartSearchResultExportJobCommandOutput extends StartSearchResultExportJobOutput, __MetadataBearer {}
 
 /**
- * <p>This operations starts a job to export the results
- *       of search job to a designated S3 bucket.</p>
+ * <p>This operations starts a job to export the results of search job to a designated S3 bucket.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -66,17 +65,10 @@ export interface StartSearchResultExportJobCommandOutput extends StartSearchResu
  * @see {@link BackupSearchClientResolvedConfig | config} for BackupSearchClient's `config` shape.
  *
  * @throws {@link ConflictException} (client fault)
- *  <p>This exception occurs when a conflict with a previous successful
- *             operation is detected. This generally occurs when the previous
- *             operation did not have time to propagate to the host serving the
- *             current request.</p>
- *          <p>A retry (with appropriate backoff logic) is the recommended
- *             response to this exception.</p>
+ *  <p>This exception occurs when a conflict with a previous successful operation is detected. This generally occurs when the previous operation did not have time to propagate to the host serving the current request.</p> <p>A retry (with appropriate backoff logic) is the recommended response to this exception.</p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
- *  <p>The resource was not found for this request.</p>
- *          <p>Confirm the resource information, such as the ARN or type is correct
- *             and exists, then retry the request.</p>
+ *  <p>The resource was not found for this request.</p> <p>Confirm the resource information, such as the ARN or type is correct and exists, then retry the request.</p>
  *
  * @throws {@link ServiceQuotaExceededException} (client fault)
  *  <p>The request denied due to exceeding the quota limits permitted.</p>
diff --git a/clients/client-backupsearch/src/commands/StopSearchJobCommand.ts b/clients/client-backupsearch/src/commands/StopSearchJobCommand.ts
@@ -28,9 +28,7 @@ export interface StopSearchJobCommandInput extends StopSearchJobInput {}
 export interface StopSearchJobCommandOutput extends StopSearchJobOutput, __MetadataBearer {}
 
 /**
- * <p>This operations ends a search job.</p>
- *          <p>Only a search job with a status of <code>RUNNING</code>
- *       can be stopped.</p>
+ * <p>This operations ends a search job.</p> <p>Only a search job with a status of <code>RUNNING</code> can be stopped.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -53,17 +51,10 @@ export interface StopSearchJobCommandOutput extends StopSearchJobOutput, __Metad
  * @see {@link BackupSearchClientResolvedConfig | config} for BackupSearchClient's `config` shape.
  *
  * @throws {@link ConflictException} (client fault)
- *  <p>This exception occurs when a conflict with a previous successful
- *             operation is detected. This generally occurs when the previous
- *             operation did not have time to propagate to the host serving the
- *             current request.</p>
- *          <p>A retry (with appropriate backoff logic) is the recommended
- *             response to this exception.</p>
+ *  <p>This exception occurs when a conflict with a previous successful operation is detected. This generally occurs when the previous operation did not have time to propagate to the host serving the current request.</p> <p>A retry (with appropriate backoff logic) is the recommended response to this exception.</p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
- *  <p>The resource was not found for this request.</p>
- *          <p>Confirm the resource information, such as the ARN or type is correct
- *             and exists, then retry the request.</p>
+ *  <p>The resource was not found for this request.</p> <p>Confirm the resource information, such as the ARN or type is correct and exists, then retry the request.</p>
  *
  * @throws {@link AccessDeniedException} (client fault)
  *  <p>You do not have sufficient access to perform this action.</p>
diff --git a/clients/client-backupsearch/src/commands/TagResourceCommand.ts b/clients/client-backupsearch/src/commands/TagResourceCommand.ts
@@ -54,9 +54,7 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
  * @see {@link BackupSearchClientResolvedConfig | config} for BackupSearchClient's `config` shape.
  *
  * @throws {@link ResourceNotFoundException} (client fault)
- *  <p>The resource was not found for this request.</p>
- *          <p>Confirm the resource information, such as the ARN or type is correct
- *             and exists, then retry the request.</p>
+ *  <p>The resource was not found for this request.</p> <p>Confirm the resource information, such as the ARN or type is correct and exists, then retry the request.</p>
  *
  * @throws {@link AccessDeniedException} (client fault)
  *  <p>You do not have sufficient access to perform this action.</p>
diff --git a/clients/client-backupsearch/src/commands/UntagResourceCommand.ts b/clients/client-backupsearch/src/commands/UntagResourceCommand.ts
@@ -54,9 +54,7 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
  * @see {@link BackupSearchClientResolvedConfig | config} for BackupSearchClient's `config` shape.
  *
  * @throws {@link ResourceNotFoundException} (client fault)
- *  <p>The resource was not found for this request.</p>
- *          <p>Confirm the resource information, such as the ARN or type is correct
- *             and exists, then retry the request.</p>
+ *  <p>The resource was not found for this request.</p> <p>Confirm the resource information, such as the ARN or type is correct and exists, then retry the request.</p>
  *
  * @throws {@link AccessDeniedException} (client fault)
  *  <p>You do not have sufficient access to perform this action.</p>
diff --git a/clients/client-backupsearch/src/endpoint/ruleset.ts b/clients/client-backupsearch/src/endpoint/ruleset.ts
diff --git a/clients/client-backupsearch/src/index.ts b/clients/client-backupsearch/src/index.ts
diff --git a/clients/client-backupsearch/src/models/models_0.ts b/clients/client-backupsearch/src/models/models_0.ts
diff --git a/codegen/sdk-codegen/aws-models/backupsearch.json b/codegen/sdk-codegen/aws-models/backupsearch.json

Original file line number	Diff line number	Diff line change
`@@ -83,9 +83,7 @@ export interface ListSearchJobResultsCommandOutput extends ListSearchJobResultsO`
`83`	`83`	* @see {@link BackupSearchClientResolvedConfig \| config} for BackupSearchClient's `config` shape.
`84`	`84`	`*`
`85`	`85`	`* @throws {@link ResourceNotFoundException} (client fault)`
`86`		`- * <p>The resource was not found for this request.</p>`
`87`		`- * <p>Confirm the resource information, such as the ARN or type is correct`
`88`		`- * and exists, then retry the request.</p>`
	`86`	`+ * <p>The resource was not found for this request.</p> <p>Confirm the resource information, such as the ARN or type is correct and exists, then retry the request.</p>`
`89`	`87`	`*`
`90`	`88`	`* @throws {@link AccessDeniedException} (client fault)`
`91`	`89`	`* <p>You do not have sufficient access to perform this action.</p>`
Original file line number	Diff line number	Diff line change
`@@ -55,9 +55,7 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes`
`55`	`55`	* @see {@link BackupSearchClientResolvedConfig \| config} for BackupSearchClient's `config` shape.
`56`	`56`	`*`
`57`	`57`	`* @throws {@link ResourceNotFoundException} (client fault)`
`58`		`- * <p>The resource was not found for this request.</p>`
`59`		`- * <p>Confirm the resource information, such as the ARN or type is correct`
`60`		`- * and exists, then retry the request.</p>`
	`58`	`+ * <p>The resource was not found for this request.</p> <p>Confirm the resource information, such as the ARN or type is correct and exists, then retry the request.</p>`
`61`	`59`	`*`
`62`	`60`	`* @throws {@link AccessDeniedException} (client fault)`
`63`	`61`	`* <p>You do not have sufficient access to perform this action.</p>`