+293
-794
lines changedFilter options
+293
-794
lines changed Original file line number Diff line number Diff line change
@@ -6,23 +6,7 @@
6 6 7 7
AWS SDK for JavaScript BackupSearch Client for Node.js, Browser and React Native.
8 8 9 -
<fullname>Backup Search</fullname>
10 - 11 -
<p>Backup Search is the recovery point and item level search for Backup.</p>
12 -
<p>For additional information, see:</p>
13 -
<ul>
14 -
<li>
15 -
<p>
16 -
<a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/api-reference.html">Backup API Reference</a>
17 -
</p>
18 -
</li>
19 -
<li>
20 -
<p>
21 -
<a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html">Backup
22 -
Developer Guide</a>
23 -
</p>
24 -
</li>
25 -
</ul>
9 +
<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>
26 10 27 11
## Installing
28 12
@@ -254,22 +254,7 @@ export interface BackupSearch {
254 254
}
255 255 256 256
/**
257 -
* <fullname>Backup Search</fullname>
258 -
* <p>Backup Search is the recovery point and item level search for Backup.</p>
259 -
* <p>For additional information, see:</p>
260 -
* <ul>
261 -
* <li>
262 -
* <p>
263 -
* <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/api-reference.html">Backup API Reference</a>
264 -
* </p>
265 -
* </li>
266 -
* <li>
267 -
* <p>
268 -
* <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html">Backup
269 -
* Developer Guide</a>
270 -
* </p>
271 -
* </li>
272 -
* </ul>
257 +
* <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>
273 258
* @public
274 259
*/
275 260
export class BackupSearch extends BackupSearchClient implements BackupSearch {}
@@ -319,22 +319,7 @@ export type BackupSearchClientResolvedConfigType = __SmithyResolvedConfiguration
319 319
export interface BackupSearchClientResolvedConfig extends BackupSearchClientResolvedConfigType {}
320 320 321 321
/**
322 -
* <fullname>Backup Search</fullname>
323 -
* <p>Backup Search is the recovery point and item level search for Backup.</p>
324 -
* <p>For additional information, see:</p>
325 -
* <ul>
326 -
* <li>
327 -
* <p>
328 -
* <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/api-reference.html">Backup API Reference</a>
329 -
* </p>
330 -
* </li>
331 -
* <li>
332 -
* <p>
333 -
* <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html">Backup
334 -
* Developer Guide</a>
335 -
* </p>
336 -
* </li>
337 -
* </ul>
322 +
* <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>
338 323
* @public
339 324
*/
340 325
export class BackupSearchClient extends __Client<
@@ -28,8 +28,7 @@ export interface GetSearchJobCommandInput extends GetSearchJobInput {}
28 28
export interface GetSearchJobCommandOutput extends GetSearchJobOutput, __MetadataBearer {}
29 29 30 30
/**
31 -
* <p>This operation retrieves metadata of a search job,
32 -
* including its progress.</p>
31 +
* <p>This operation retrieves metadata of a search job, including its progress.</p>
33 32
* @example
34 33
* Use a bare-bones client and the command you need to make an API call.
35 34
* ```javascript
@@ -152,9 +151,7 @@ export interface GetSearchJobCommandOutput extends GetSearchJobOutput, __Metadat
152 151
* @see {@link BackupSearchClientResolvedConfig | config} for BackupSearchClient's `config` shape.
153 152
*
154 153
* @throws {@link ResourceNotFoundException} (client fault)
155 -
* <p>The resource was not found for this request.</p>
156 -
* <p>Confirm the resource information, such as the ARN or type is correct
157 -
* and exists, then retry the request.</p>
154 +
* <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>
158 155
*
159 156
* @throws {@link AccessDeniedException} (client fault)
160 157
* <p>You do not have sufficient access to perform this action.</p>
@@ -28,12 +28,7 @@ export interface GetSearchResultExportJobCommandInput extends GetSearchResultExp
28 28
export interface GetSearchResultExportJobCommandOutput extends GetSearchResultExportJobOutput, __MetadataBearer {}
29 29 30 30
/**
31 -
* <p>This operation retrieves the metadata of an export job.</p>
32 -
* <p>An export job is an operation that transmits the results
33 -
* of a search job to a specified S3 bucket in a
34 -
* .csv file.</p>
35 -
* <p>An export job allows you to retain results of a search
36 -
* beyond the search job's scheduled retention of 7 days.</p>
31 +
* <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>
37 32
* @example
38 33
* Use a bare-bones client and the command you need to make an API call.
39 34
* ```javascript
@@ -70,9 +65,7 @@ export interface GetSearchResultExportJobCommandOutput extends GetSearchResultEx
70 65
* @see {@link BackupSearchClientResolvedConfig | config} for BackupSearchClient's `config` shape.
71 66
*
72 67
* @throws {@link ResourceNotFoundException} (client fault)
73 -
* <p>The resource was not found for this request.</p>
74 -
* <p>Confirm the resource information, such as the ARN or type is correct
75 -
* and exists, then retry the request.</p>
68 +
* <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>
76 69
*
77 70
* @throws {@link AccessDeniedException} (client fault)
78 71
* <p>You do not have sufficient access to perform this action.</p>
@@ -28,19 +28,7 @@ export interface ListSearchJobBackupsCommandInput extends ListSearchJobBackupsIn
28 28
export interface ListSearchJobBackupsCommandOutput extends ListSearchJobBackupsOutput, __MetadataBearer {}
29 29 30 30
/**
31 -
* <p>This operation returns a list of all backups (recovery
32 -
* points) in a paginated format that were included in
33 -
* the search job.</p>
34 -
* <p>If a search does not display an expected backup in
35 -
* the results, you can call this operation to display each
36 -
* backup included in the search. Any backups that were not
37 -
* included because they have a <code>FAILED</code> status
38 -
* from a permissions issue will be displayed, along with a
39 -
* status message.</p>
40 -
* <p>Only recovery points with a backup index that has
41 -
* a status of <code>ACTIVE</code> will be included in search results.
42 -
* If the index has any other status, its status will be
43 -
* displayed along with a status message.</p>
31 +
* <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>
44 32
* @example
45 33
* Use a bare-bones client and the command you need to make an API call.
46 34
* ```javascript
@@ -78,9 +66,7 @@ export interface ListSearchJobBackupsCommandOutput extends ListSearchJobBackupsO
78 66
* @see {@link BackupSearchClientResolvedConfig | config} for BackupSearchClient's `config` shape.
79 67
*
80 68
* @throws {@link ResourceNotFoundException} (client fault)
81 -
* <p>The resource was not found for this request.</p>
82 -
* <p>Confirm the resource information, such as the ARN or type is correct
83 -
* and exists, then retry the request.</p>
69 +
* <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>
84 70
*
85 71
* @throws {@link AccessDeniedException} (client fault)
86 72
* <p>You do not have sufficient access to perform this action.</p>
@@ -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>
@@ -28,8 +28,7 @@ export interface ListSearchJobsCommandInput extends ListSearchJobsInput {}
28 28
export interface ListSearchJobsCommandOutput extends ListSearchJobsOutput, __MetadataBearer {}
29 29 30 30
/**
31 -
* <p>This operation returns a list of search jobs belonging
32 -
* to an account.</p>
31 +
* <p>This operation returns a list of search jobs belonging to an account.</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,7 @@ export interface ListSearchResultExportJobsCommandInput extends ListSearchResult
28 28
export interface ListSearchResultExportJobsCommandOutput extends ListSearchResultExportJobsOutput, __MetadataBearer {}
29 29 30 30
/**
31 -
* <p>This operation exports search results of a search job
32 -
* to a specified destination S3 bucket.</p>
31 +
* <p>This operation exports search results of a search job to a specified destination S3 bucket.</p>
33 32
* @example
34 33
* Use a bare-bones client and the command you need to make an API call.
35 34
* ```javascript
@@ -68,9 +67,7 @@ export interface ListSearchResultExportJobsCommandOutput extends ListSearchResul
68 67
* @see {@link BackupSearchClientResolvedConfig | config} for BackupSearchClient's `config` shape.
69 68
*
70 69
* @throws {@link ResourceNotFoundException} (client fault)
71 -
* <p>The resource was not found for this request.</p>
72 -
* <p>Confirm the resource information, such as the ARN or type is correct
73 -
* and exists, then retry the request.</p>
70 +
* <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>
74 71
*
75 72
* @throws {@link ServiceQuotaExceededException} (client fault)
76 73
* <p>The request denied due to exceeding the quota limits permitted.</p>
@@ -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>
You can’t perform that action at this time.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4