@aws-sdk/client-backupsearch 3.714.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 (151) hide show
  1. package/LICENSE +201 -0
  2. package/README.md +317 -0
  3. package/dist-cjs/BackupSearch.js +35 -0
  4. package/dist-cjs/BackupSearchClient.js +50 -0
  5. package/dist-cjs/auth/httpAuthExtensionConfiguration.js +43 -0
  6. package/dist-cjs/auth/httpAuthSchemeProvider.js +47 -0
  7. package/dist-cjs/commands/GetSearchJobCommand.js +26 -0
  8. package/dist-cjs/commands/GetSearchResultExportJobCommand.js +26 -0
  9. package/dist-cjs/commands/ListSearchJobBackupsCommand.js +26 -0
  10. package/dist-cjs/commands/ListSearchJobResultsCommand.js +27 -0
  11. package/dist-cjs/commands/ListSearchJobsCommand.js +26 -0
  12. package/dist-cjs/commands/ListSearchResultExportJobsCommand.js +26 -0
  13. package/dist-cjs/commands/ListTagsForResourceCommand.js +26 -0
  14. package/dist-cjs/commands/StartSearchJobCommand.js +26 -0
  15. package/dist-cjs/commands/StartSearchResultExportJobCommand.js +26 -0
  16. package/dist-cjs/commands/StopSearchJobCommand.js +26 -0
  17. package/dist-cjs/commands/TagResourceCommand.js +26 -0
  18. package/dist-cjs/commands/UntagResourceCommand.js +26 -0
  19. package/dist-cjs/commands/index.js +15 -0
  20. package/dist-cjs/endpoint/EndpointParameters.js +16 -0
  21. package/dist-cjs/endpoint/endpointResolver.js +18 -0
  22. package/dist-cjs/endpoint/ruleset.js +7 -0
  23. package/dist-cjs/extensionConfiguration.js +2 -0
  24. package/dist-cjs/index.js +11 -0
  25. package/dist-cjs/models/BackupSearchServiceException.js +12 -0
  26. package/dist-cjs/models/index.js +4 -0
  27. package/dist-cjs/models/models_0.js +192 -0
  28. package/dist-cjs/pagination/Interfaces.js +2 -0
  29. package/dist-cjs/pagination/ListSearchJobBackupsPaginator.js +7 -0
  30. package/dist-cjs/pagination/ListSearchJobResultsPaginator.js +7 -0
  31. package/dist-cjs/pagination/ListSearchJobsPaginator.js +7 -0
  32. package/dist-cjs/pagination/ListSearchResultExportJobsPaginator.js +7 -0
  33. package/dist-cjs/pagination/index.js +8 -0
  34. package/dist-cjs/protocols/Aws_restJson1.js +780 -0
  35. package/dist-cjs/runtimeConfig.browser.js +39 -0
  36. package/dist-cjs/runtimeConfig.js +52 -0
  37. package/dist-cjs/runtimeConfig.native.js +15 -0
  38. package/dist-cjs/runtimeConfig.shared.js +34 -0
  39. package/dist-cjs/runtimeExtensions.js +25 -0
  40. package/dist-es/BackupSearch.js +31 -0
  41. package/dist-es/BackupSearchClient.js +46 -0
  42. package/dist-es/auth/httpAuthExtensionConfiguration.js +38 -0
  43. package/dist-es/auth/httpAuthSchemeProvider.js +41 -0
  44. package/dist-es/commands/GetSearchJobCommand.js +22 -0
  45. package/dist-es/commands/GetSearchResultExportJobCommand.js +22 -0
  46. package/dist-es/commands/ListSearchJobBackupsCommand.js +22 -0
  47. package/dist-es/commands/ListSearchJobResultsCommand.js +23 -0
  48. package/dist-es/commands/ListSearchJobsCommand.js +22 -0
  49. package/dist-es/commands/ListSearchResultExportJobsCommand.js +22 -0
  50. package/dist-es/commands/ListTagsForResourceCommand.js +22 -0
  51. package/dist-es/commands/StartSearchJobCommand.js +22 -0
  52. package/dist-es/commands/StartSearchResultExportJobCommand.js +22 -0
  53. package/dist-es/commands/StopSearchJobCommand.js +22 -0
  54. package/dist-es/commands/TagResourceCommand.js +22 -0
  55. package/dist-es/commands/UntagResourceCommand.js +22 -0
  56. package/dist-es/commands/index.js +12 -0
  57. package/dist-es/endpoint/EndpointParameters.js +12 -0
  58. package/dist-es/endpoint/endpointResolver.js +14 -0
  59. package/dist-es/endpoint/ruleset.js +4 -0
  60. package/dist-es/extensionConfiguration.js +1 -0
  61. package/dist-es/index.js +6 -0
  62. package/dist-es/models/BackupSearchServiceException.js +8 -0
  63. package/dist-es/models/index.js +1 -0
  64. package/dist-es/models/models_0.js +178 -0
  65. package/dist-es/pagination/Interfaces.js +1 -0
  66. package/dist-es/pagination/ListSearchJobBackupsPaginator.js +4 -0
  67. package/dist-es/pagination/ListSearchJobResultsPaginator.js +4 -0
  68. package/dist-es/pagination/ListSearchJobsPaginator.js +4 -0
  69. package/dist-es/pagination/ListSearchResultExportJobsPaginator.js +4 -0
  70. package/dist-es/pagination/index.js +5 -0
  71. package/dist-es/protocols/Aws_restJson1.js +753 -0
  72. package/dist-es/runtimeConfig.browser.js +34 -0
  73. package/dist-es/runtimeConfig.js +47 -0
  74. package/dist-es/runtimeConfig.native.js +11 -0
  75. package/dist-es/runtimeConfig.shared.js +30 -0
  76. package/dist-es/runtimeExtensions.js +21 -0
  77. package/dist-types/BackupSearch.d.ts +111 -0
  78. package/dist-types/BackupSearchClient.d.ts +214 -0
  79. package/dist-types/auth/httpAuthExtensionConfiguration.d.ts +29 -0
  80. package/dist-types/auth/httpAuthSchemeProvider.d.ts +61 -0
  81. package/dist-types/commands/GetSearchJobCommand.d.ts +187 -0
  82. package/dist-types/commands/GetSearchResultExportJobCommand.d.ts +105 -0
  83. package/dist-types/commands/ListSearchJobBackupsCommand.d.ts +113 -0
  84. package/dist-types/commands/ListSearchJobResultsCommand.d.ts +114 -0
  85. package/dist-types/commands/ListSearchJobsCommand.d.ts +101 -0
  86. package/dist-types/commands/ListSearchResultExportJobsCommand.d.ts +106 -0
  87. package/dist-types/commands/ListTagsForResourceCommand.d.ts +90 -0
  88. package/dist-types/commands/StartSearchJobCommand.d.ts +187 -0
  89. package/dist-types/commands/StartSearchResultExportJobCommand.d.ts +112 -0
  90. package/dist-types/commands/StopSearchJobCommand.d.ts +96 -0
  91. package/dist-types/commands/TagResourceCommand.d.ts +89 -0
  92. package/dist-types/commands/UntagResourceCommand.d.ts +89 -0
  93. package/dist-types/commands/index.d.ts +12 -0
  94. package/dist-types/endpoint/EndpointParameters.d.ts +34 -0
  95. package/dist-types/endpoint/endpointResolver.d.ts +5 -0
  96. package/dist-types/endpoint/ruleset.d.ts +2 -0
  97. package/dist-types/extensionConfiguration.d.ts +9 -0
  98. package/dist-types/index.d.ts +29 -0
  99. package/dist-types/models/BackupSearchServiceException.d.ts +14 -0
  100. package/dist-types/models/index.d.ts +1 -0
  101. package/dist-types/models/models_0.d.ts +1535 -0
  102. package/dist-types/pagination/Interfaces.d.ts +8 -0
  103. package/dist-types/pagination/ListSearchJobBackupsPaginator.d.ts +7 -0
  104. package/dist-types/pagination/ListSearchJobResultsPaginator.d.ts +7 -0
  105. package/dist-types/pagination/ListSearchJobsPaginator.d.ts +7 -0
  106. package/dist-types/pagination/ListSearchResultExportJobsPaginator.d.ts +7 -0
  107. package/dist-types/pagination/index.d.ts +5 -0
  108. package/dist-types/protocols/Aws_restJson1.d.ts +110 -0
  109. package/dist-types/runtimeConfig.browser.d.ts +49 -0
  110. package/dist-types/runtimeConfig.d.ts +49 -0
  111. package/dist-types/runtimeConfig.native.d.ts +48 -0
  112. package/dist-types/runtimeConfig.shared.d.ts +21 -0
  113. package/dist-types/runtimeExtensions.d.ts +17 -0
  114. package/dist-types/ts3.4/BackupSearch.d.ts +213 -0
  115. package/dist-types/ts3.4/BackupSearchClient.d.ts +192 -0
  116. package/dist-types/ts3.4/auth/httpAuthExtensionConfiguration.d.ts +32 -0
  117. package/dist-types/ts3.4/auth/httpAuthSchemeProvider.d.ts +44 -0
  118. package/dist-types/ts3.4/commands/GetSearchJobCommand.d.ts +47 -0
  119. package/dist-types/ts3.4/commands/GetSearchResultExportJobCommand.d.ts +51 -0
  120. package/dist-types/ts3.4/commands/ListSearchJobBackupsCommand.d.ts +51 -0
  121. package/dist-types/ts3.4/commands/ListSearchJobResultsCommand.d.ts +51 -0
  122. package/dist-types/ts3.4/commands/ListSearchJobsCommand.d.ts +47 -0
  123. package/dist-types/ts3.4/commands/ListSearchResultExportJobsCommand.d.ts +51 -0
  124. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +51 -0
  125. package/dist-types/ts3.4/commands/StartSearchJobCommand.d.ts +47 -0
  126. package/dist-types/ts3.4/commands/StartSearchResultExportJobCommand.d.ts +51 -0
  127. package/dist-types/ts3.4/commands/StopSearchJobCommand.d.ts +47 -0
  128. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +47 -0
  129. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +50 -0
  130. package/dist-types/ts3.4/commands/index.d.ts +12 -0
  131. package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +45 -0
  132. package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +8 -0
  133. package/dist-types/ts3.4/endpoint/ruleset.d.ts +2 -0
  134. package/dist-types/ts3.4/extensionConfiguration.d.ts +9 -0
  135. package/dist-types/ts3.4/index.d.ts +9 -0
  136. package/dist-types/ts3.4/models/BackupSearchServiceException.d.ts +9 -0
  137. package/dist-types/ts3.4/models/index.d.ts +1 -0
  138. package/dist-types/ts3.4/models/models_0.d.ts +379 -0
  139. package/dist-types/ts3.4/pagination/Interfaces.d.ts +6 -0
  140. package/dist-types/ts3.4/pagination/ListSearchJobBackupsPaginator.d.ts +11 -0
  141. package/dist-types/ts3.4/pagination/ListSearchJobResultsPaginator.d.ts +11 -0
  142. package/dist-types/ts3.4/pagination/ListSearchJobsPaginator.d.ts +11 -0
  143. package/dist-types/ts3.4/pagination/ListSearchResultExportJobsPaginator.d.ts +11 -0
  144. package/dist-types/ts3.4/pagination/index.d.ts +5 -0
  145. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +149 -0
  146. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +94 -0
  147. package/dist-types/ts3.4/runtimeConfig.d.ts +95 -0
  148. package/dist-types/ts3.4/runtimeConfig.native.d.ts +88 -0
  149. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +21 -0
  150. package/dist-types/ts3.4/runtimeExtensions.d.ts +11 -0
  151. package/package.json +101 -0
@@ -0,0 +1,106 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { BackupSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BackupSearchClient";
4
+ import { ListSearchResultExportJobsInput, ListSearchResultExportJobsOutput } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link ListSearchResultExportJobsCommand}.
14
+ */
15
+ export interface ListSearchResultExportJobsCommandInput extends ListSearchResultExportJobsInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link ListSearchResultExportJobsCommand}.
21
+ */
22
+ export interface ListSearchResultExportJobsCommandOutput extends ListSearchResultExportJobsOutput, __MetadataBearer {
23
+ }
24
+ declare const ListSearchResultExportJobsCommand_base: {
25
+ new (input: ListSearchResultExportJobsCommandInput): import("@smithy/smithy-client").CommandImpl<ListSearchResultExportJobsCommandInput, ListSearchResultExportJobsCommandOutput, BackupSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (...[input]: [] | [ListSearchResultExportJobsCommandInput]): import("@smithy/smithy-client").CommandImpl<ListSearchResultExportJobsCommandInput, ListSearchResultExportJobsCommandOutput, BackupSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>This operation exports search results of a search job
31
+ * to a specified destination S3 bucket.</p>
32
+ * @example
33
+ * Use a bare-bones client and the command you need to make an API call.
34
+ * ```javascript
35
+ * import { BackupSearchClient, ListSearchResultExportJobsCommand } from "@aws-sdk/client-backupsearch"; // ES Modules import
36
+ * // const { BackupSearchClient, ListSearchResultExportJobsCommand } = require("@aws-sdk/client-backupsearch"); // CommonJS import
37
+ * const client = new BackupSearchClient(config);
38
+ * const input = { // ListSearchResultExportJobsInput
39
+ * Status: "RUNNING" || "FAILED" || "COMPLETED",
40
+ * SearchJobIdentifier: "STRING_VALUE",
41
+ * NextToken: "STRING_VALUE",
42
+ * MaxResults: Number("int"),
43
+ * };
44
+ * const command = new ListSearchResultExportJobsCommand(input);
45
+ * const response = await client.send(command);
46
+ * // { // ListSearchResultExportJobsOutput
47
+ * // ExportJobs: [ // ExportJobSummaries // required
48
+ * // { // ExportJobSummary
49
+ * // ExportJobIdentifier: "STRING_VALUE", // required
50
+ * // ExportJobArn: "STRING_VALUE",
51
+ * // Status: "RUNNING" || "FAILED" || "COMPLETED",
52
+ * // CreationTime: new Date("TIMESTAMP"),
53
+ * // CompletionTime: new Date("TIMESTAMP"),
54
+ * // StatusMessage: "STRING_VALUE",
55
+ * // SearchJobArn: "STRING_VALUE",
56
+ * // },
57
+ * // ],
58
+ * // NextToken: "STRING_VALUE",
59
+ * // };
60
+ *
61
+ * ```
62
+ *
63
+ * @param ListSearchResultExportJobsCommandInput - {@link ListSearchResultExportJobsCommandInput}
64
+ * @returns {@link ListSearchResultExportJobsCommandOutput}
65
+ * @see {@link ListSearchResultExportJobsCommandInput} for command's `input` shape.
66
+ * @see {@link ListSearchResultExportJobsCommandOutput} for command's `response` shape.
67
+ * @see {@link BackupSearchClientResolvedConfig | config} for BackupSearchClient's `config` shape.
68
+ *
69
+ * @throws {@link ResourceNotFoundException} (client fault)
70
+ * <p>The resource was not found for this request.</p>
71
+ * <p>Confirm the resource information, such as the ARN or type is correct
72
+ * and exists, then retry the request.</p>
73
+ *
74
+ * @throws {@link ServiceQuotaExceededException} (client fault)
75
+ * <p>The request denied due to exceeding the quota limits permitted.</p>
76
+ *
77
+ * @throws {@link AccessDeniedException} (client fault)
78
+ * <p>You do not have sufficient access to perform this action.</p>
79
+ *
80
+ * @throws {@link InternalServerException} (server fault)
81
+ * <p>An internal server error occurred. Retry your request.</p>
82
+ *
83
+ * @throws {@link ThrottlingException} (client fault)
84
+ * <p>The request was denied due to request throttling.</p>
85
+ *
86
+ * @throws {@link ValidationException} (client fault)
87
+ * <p>The input fails to satisfy the constraints specified by a service.</p>
88
+ *
89
+ * @throws {@link BackupSearchServiceException}
90
+ * <p>Base exception class for all service exceptions from BackupSearch service.</p>
91
+ *
92
+ * @public
93
+ */
94
+ export declare class ListSearchResultExportJobsCommand extends ListSearchResultExportJobsCommand_base {
95
+ /** @internal type navigation helper, not in runtime. */
96
+ protected static __types: {
97
+ api: {
98
+ input: ListSearchResultExportJobsInput;
99
+ output: ListSearchResultExportJobsOutput;
100
+ };
101
+ sdk: {
102
+ input: ListSearchResultExportJobsCommandInput;
103
+ output: ListSearchResultExportJobsCommandOutput;
104
+ };
105
+ };
106
+ }
@@ -0,0 +1,90 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { BackupSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BackupSearchClient";
4
+ import { ListTagsForResourceRequest, ListTagsForResourceResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link ListTagsForResourceCommand}.
14
+ */
15
+ export interface ListTagsForResourceCommandInput extends ListTagsForResourceRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link ListTagsForResourceCommand}.
21
+ */
22
+ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceResponse, __MetadataBearer {
23
+ }
24
+ declare const ListTagsForResourceCommand_base: {
25
+ new (input: ListTagsForResourceCommandInput): import("@smithy/smithy-client").CommandImpl<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, BackupSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: ListTagsForResourceCommandInput): import("@smithy/smithy-client").CommandImpl<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, BackupSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>This operation returns the tags for a resource type.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { BackupSearchClient, ListTagsForResourceCommand } from "@aws-sdk/client-backupsearch"; // ES Modules import
35
+ * // const { BackupSearchClient, ListTagsForResourceCommand } = require("@aws-sdk/client-backupsearch"); // CommonJS import
36
+ * const client = new BackupSearchClient(config);
37
+ * const input = { // ListTagsForResourceRequest
38
+ * ResourceArn: "STRING_VALUE", // required
39
+ * };
40
+ * const command = new ListTagsForResourceCommand(input);
41
+ * const response = await client.send(command);
42
+ * // { // ListTagsForResourceResponse
43
+ * // Tags: { // TagMap
44
+ * // "<keys>": "STRING_VALUE",
45
+ * // },
46
+ * // };
47
+ *
48
+ * ```
49
+ *
50
+ * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
51
+ * @returns {@link ListTagsForResourceCommandOutput}
52
+ * @see {@link ListTagsForResourceCommandInput} for command's `input` shape.
53
+ * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
54
+ * @see {@link BackupSearchClientResolvedConfig | config} for BackupSearchClient's `config` shape.
55
+ *
56
+ * @throws {@link ResourceNotFoundException} (client fault)
57
+ * <p>The resource was not found for this request.</p>
58
+ * <p>Confirm the resource information, such as the ARN or type is correct
59
+ * and exists, then retry the request.</p>
60
+ *
61
+ * @throws {@link AccessDeniedException} (client fault)
62
+ * <p>You do not have sufficient access to perform this action.</p>
63
+ *
64
+ * @throws {@link InternalServerException} (server fault)
65
+ * <p>An internal server error occurred. Retry your request.</p>
66
+ *
67
+ * @throws {@link ThrottlingException} (client fault)
68
+ * <p>The request was denied due to request throttling.</p>
69
+ *
70
+ * @throws {@link ValidationException} (client fault)
71
+ * <p>The input fails to satisfy the constraints specified by a service.</p>
72
+ *
73
+ * @throws {@link BackupSearchServiceException}
74
+ * <p>Base exception class for all service exceptions from BackupSearch service.</p>
75
+ *
76
+ * @public
77
+ */
78
+ export declare class ListTagsForResourceCommand extends ListTagsForResourceCommand_base {
79
+ /** @internal type navigation helper, not in runtime. */
80
+ protected static __types: {
81
+ api: {
82
+ input: ListTagsForResourceRequest;
83
+ output: ListTagsForResourceResponse;
84
+ };
85
+ sdk: {
86
+ input: ListTagsForResourceCommandInput;
87
+ output: ListTagsForResourceCommandOutput;
88
+ };
89
+ };
90
+ }
@@ -0,0 +1,187 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { BackupSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BackupSearchClient";
4
+ import { StartSearchJobInput, StartSearchJobOutput } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link StartSearchJobCommand}.
14
+ */
15
+ export interface StartSearchJobCommandInput extends StartSearchJobInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link StartSearchJobCommand}.
21
+ */
22
+ export interface StartSearchJobCommandOutput extends StartSearchJobOutput, __MetadataBearer {
23
+ }
24
+ declare const StartSearchJobCommand_base: {
25
+ new (input: StartSearchJobCommandInput): import("@smithy/smithy-client").CommandImpl<StartSearchJobCommandInput, StartSearchJobCommandOutput, BackupSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: StartSearchJobCommandInput): import("@smithy/smithy-client").CommandImpl<StartSearchJobCommandInput, StartSearchJobCommandOutput, BackupSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>This operation creates a search job which returns
31
+ * recovery points filtered by SearchScope and items
32
+ * filtered by ItemFilters.</p>
33
+ * <p>You can optionally include ClientToken,
34
+ * EncryptionKeyArn, Name, and/or Tags.</p>
35
+ * @example
36
+ * Use a bare-bones client and the command you need to make an API call.
37
+ * ```javascript
38
+ * import { BackupSearchClient, StartSearchJobCommand } from "@aws-sdk/client-backupsearch"; // ES Modules import
39
+ * // const { BackupSearchClient, StartSearchJobCommand } = require("@aws-sdk/client-backupsearch"); // CommonJS import
40
+ * const client = new BackupSearchClient(config);
41
+ * const input = { // StartSearchJobInput
42
+ * Tags: { // TagMap
43
+ * "<keys>": "STRING_VALUE",
44
+ * },
45
+ * Name: "STRING_VALUE",
46
+ * EncryptionKeyArn: "STRING_VALUE",
47
+ * ClientToken: "STRING_VALUE",
48
+ * SearchScope: { // SearchScope
49
+ * BackupResourceTypes: [ // ResourceTypeList // required
50
+ * "S3" || "EBS",
51
+ * ],
52
+ * BackupResourceCreationTime: { // BackupCreationTimeFilter
53
+ * CreatedAfter: new Date("TIMESTAMP"),
54
+ * CreatedBefore: new Date("TIMESTAMP"),
55
+ * },
56
+ * SourceResourceArns: [ // ResourceArnList
57
+ * "STRING_VALUE",
58
+ * ],
59
+ * BackupResourceArns: [ // RecoveryPointArnList
60
+ * "STRING_VALUE",
61
+ * ],
62
+ * BackupResourceTags: {
63
+ * "<keys>": "STRING_VALUE",
64
+ * },
65
+ * },
66
+ * ItemFilters: { // ItemFilters
67
+ * S3ItemFilters: [ // S3ItemFilters
68
+ * { // S3ItemFilter
69
+ * ObjectKeys: [ // StringConditionList
70
+ * { // StringCondition
71
+ * Value: "STRING_VALUE", // required
72
+ * Operator: "EQUALS_TO" || "NOT_EQUALS_TO" || "CONTAINS" || "DOES_NOT_CONTAIN" || "BEGINS_WITH" || "ENDS_WITH" || "DOES_NOT_BEGIN_WITH" || "DOES_NOT_END_WITH",
73
+ * },
74
+ * ],
75
+ * Sizes: [ // LongConditionList
76
+ * { // LongCondition
77
+ * Value: Number("long"), // required
78
+ * Operator: "EQUALS_TO" || "NOT_EQUALS_TO" || "LESS_THAN_EQUAL_TO" || "GREATER_THAN_EQUAL_TO",
79
+ * },
80
+ * ],
81
+ * CreationTimes: [ // TimeConditionList
82
+ * { // TimeCondition
83
+ * Value: new Date("TIMESTAMP"), // required
84
+ * Operator: "EQUALS_TO" || "NOT_EQUALS_TO" || "LESS_THAN_EQUAL_TO" || "GREATER_THAN_EQUAL_TO",
85
+ * },
86
+ * ],
87
+ * VersionIds: [
88
+ * {
89
+ * Value: "STRING_VALUE", // required
90
+ * Operator: "EQUALS_TO" || "NOT_EQUALS_TO" || "CONTAINS" || "DOES_NOT_CONTAIN" || "BEGINS_WITH" || "ENDS_WITH" || "DOES_NOT_BEGIN_WITH" || "DOES_NOT_END_WITH",
91
+ * },
92
+ * ],
93
+ * ETags: [
94
+ * {
95
+ * Value: "STRING_VALUE", // required
96
+ * Operator: "EQUALS_TO" || "NOT_EQUALS_TO" || "CONTAINS" || "DOES_NOT_CONTAIN" || "BEGINS_WITH" || "ENDS_WITH" || "DOES_NOT_BEGIN_WITH" || "DOES_NOT_END_WITH",
97
+ * },
98
+ * ],
99
+ * },
100
+ * ],
101
+ * EBSItemFilters: [ // EBSItemFilters
102
+ * { // EBSItemFilter
103
+ * FilePaths: [
104
+ * {
105
+ * Value: "STRING_VALUE", // required
106
+ * Operator: "EQUALS_TO" || "NOT_EQUALS_TO" || "CONTAINS" || "DOES_NOT_CONTAIN" || "BEGINS_WITH" || "ENDS_WITH" || "DOES_NOT_BEGIN_WITH" || "DOES_NOT_END_WITH",
107
+ * },
108
+ * ],
109
+ * Sizes: [
110
+ * {
111
+ * Value: Number("long"), // required
112
+ * Operator: "EQUALS_TO" || "NOT_EQUALS_TO" || "LESS_THAN_EQUAL_TO" || "GREATER_THAN_EQUAL_TO",
113
+ * },
114
+ * ],
115
+ * CreationTimes: [
116
+ * {
117
+ * Value: new Date("TIMESTAMP"), // required
118
+ * Operator: "EQUALS_TO" || "NOT_EQUALS_TO" || "LESS_THAN_EQUAL_TO" || "GREATER_THAN_EQUAL_TO",
119
+ * },
120
+ * ],
121
+ * LastModificationTimes: [
122
+ * {
123
+ * Value: new Date("TIMESTAMP"), // required
124
+ * Operator: "EQUALS_TO" || "NOT_EQUALS_TO" || "LESS_THAN_EQUAL_TO" || "GREATER_THAN_EQUAL_TO",
125
+ * },
126
+ * ],
127
+ * },
128
+ * ],
129
+ * },
130
+ * };
131
+ * const command = new StartSearchJobCommand(input);
132
+ * const response = await client.send(command);
133
+ * // { // StartSearchJobOutput
134
+ * // SearchJobArn: "STRING_VALUE",
135
+ * // CreationTime: new Date("TIMESTAMP"),
136
+ * // SearchJobIdentifier: "STRING_VALUE",
137
+ * // };
138
+ *
139
+ * ```
140
+ *
141
+ * @param StartSearchJobCommandInput - {@link StartSearchJobCommandInput}
142
+ * @returns {@link StartSearchJobCommandOutput}
143
+ * @see {@link StartSearchJobCommandInput} for command's `input` shape.
144
+ * @see {@link StartSearchJobCommandOutput} for command's `response` shape.
145
+ * @see {@link BackupSearchClientResolvedConfig | config} for BackupSearchClient's `config` shape.
146
+ *
147
+ * @throws {@link ConflictException} (client fault)
148
+ * <p>This exception occurs when a conflict with a previous successful
149
+ * operation is detected. This generally occurs when the previous
150
+ * operation did not have time to propagate to the host serving the
151
+ * current request.</p>
152
+ * <p>A retry (with appropriate backoff logic) is the recommended
153
+ * response to this exception.</p>
154
+ *
155
+ * @throws {@link ServiceQuotaExceededException} (client fault)
156
+ * <p>The request denied due to exceeding the quota limits permitted.</p>
157
+ *
158
+ * @throws {@link AccessDeniedException} (client fault)
159
+ * <p>You do not have sufficient access to perform this action.</p>
160
+ *
161
+ * @throws {@link InternalServerException} (server fault)
162
+ * <p>An internal server error occurred. Retry your request.</p>
163
+ *
164
+ * @throws {@link ThrottlingException} (client fault)
165
+ * <p>The request was denied due to request throttling.</p>
166
+ *
167
+ * @throws {@link ValidationException} (client fault)
168
+ * <p>The input fails to satisfy the constraints specified by a service.</p>
169
+ *
170
+ * @throws {@link BackupSearchServiceException}
171
+ * <p>Base exception class for all service exceptions from BackupSearch service.</p>
172
+ *
173
+ * @public
174
+ */
175
+ export declare class StartSearchJobCommand extends StartSearchJobCommand_base {
176
+ /** @internal type navigation helper, not in runtime. */
177
+ protected static __types: {
178
+ api: {
179
+ input: StartSearchJobInput;
180
+ output: StartSearchJobOutput;
181
+ };
182
+ sdk: {
183
+ input: StartSearchJobCommandInput;
184
+ output: StartSearchJobCommandOutput;
185
+ };
186
+ };
187
+ }
@@ -0,0 +1,112 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { BackupSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BackupSearchClient";
4
+ import { StartSearchResultExportJobInput, StartSearchResultExportJobOutput } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link StartSearchResultExportJobCommand}.
14
+ */
15
+ export interface StartSearchResultExportJobCommandInput extends StartSearchResultExportJobInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link StartSearchResultExportJobCommand}.
21
+ */
22
+ export interface StartSearchResultExportJobCommandOutput extends StartSearchResultExportJobOutput, __MetadataBearer {
23
+ }
24
+ declare const StartSearchResultExportJobCommand_base: {
25
+ new (input: StartSearchResultExportJobCommandInput): import("@smithy/smithy-client").CommandImpl<StartSearchResultExportJobCommandInput, StartSearchResultExportJobCommandOutput, BackupSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: StartSearchResultExportJobCommandInput): import("@smithy/smithy-client").CommandImpl<StartSearchResultExportJobCommandInput, StartSearchResultExportJobCommandOutput, BackupSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>This operations starts a job to export the results
31
+ * of search job to a designated S3 bucket.</p>
32
+ * @example
33
+ * Use a bare-bones client and the command you need to make an API call.
34
+ * ```javascript
35
+ * import { BackupSearchClient, StartSearchResultExportJobCommand } from "@aws-sdk/client-backupsearch"; // ES Modules import
36
+ * // const { BackupSearchClient, StartSearchResultExportJobCommand } = require("@aws-sdk/client-backupsearch"); // CommonJS import
37
+ * const client = new BackupSearchClient(config);
38
+ * const input = { // StartSearchResultExportJobInput
39
+ * SearchJobIdentifier: "STRING_VALUE", // required
40
+ * ExportSpecification: { // ExportSpecification Union: only one key present
41
+ * s3ExportSpecification: { // S3ExportSpecification
42
+ * DestinationBucket: "STRING_VALUE", // required
43
+ * DestinationPrefix: "STRING_VALUE",
44
+ * },
45
+ * },
46
+ * ClientToken: "STRING_VALUE",
47
+ * Tags: { // TagMap
48
+ * "<keys>": "STRING_VALUE",
49
+ * },
50
+ * RoleArn: "STRING_VALUE",
51
+ * };
52
+ * const command = new StartSearchResultExportJobCommand(input);
53
+ * const response = await client.send(command);
54
+ * // { // StartSearchResultExportJobOutput
55
+ * // ExportJobArn: "STRING_VALUE",
56
+ * // ExportJobIdentifier: "STRING_VALUE", // required
57
+ * // };
58
+ *
59
+ * ```
60
+ *
61
+ * @param StartSearchResultExportJobCommandInput - {@link StartSearchResultExportJobCommandInput}
62
+ * @returns {@link StartSearchResultExportJobCommandOutput}
63
+ * @see {@link StartSearchResultExportJobCommandInput} for command's `input` shape.
64
+ * @see {@link StartSearchResultExportJobCommandOutput} for command's `response` shape.
65
+ * @see {@link BackupSearchClientResolvedConfig | config} for BackupSearchClient's `config` shape.
66
+ *
67
+ * @throws {@link ConflictException} (client fault)
68
+ * <p>This exception occurs when a conflict with a previous successful
69
+ * operation is detected. This generally occurs when the previous
70
+ * operation did not have time to propagate to the host serving the
71
+ * current request.</p>
72
+ * <p>A retry (with appropriate backoff logic) is the recommended
73
+ * response to this exception.</p>
74
+ *
75
+ * @throws {@link ResourceNotFoundException} (client fault)
76
+ * <p>The resource was not found for this request.</p>
77
+ * <p>Confirm the resource information, such as the ARN or type is correct
78
+ * and exists, then retry the request.</p>
79
+ *
80
+ * @throws {@link ServiceQuotaExceededException} (client fault)
81
+ * <p>The request denied due to exceeding the quota limits permitted.</p>
82
+ *
83
+ * @throws {@link AccessDeniedException} (client fault)
84
+ * <p>You do not have sufficient access to perform this action.</p>
85
+ *
86
+ * @throws {@link InternalServerException} (server fault)
87
+ * <p>An internal server error occurred. Retry your request.</p>
88
+ *
89
+ * @throws {@link ThrottlingException} (client fault)
90
+ * <p>The request was denied due to request throttling.</p>
91
+ *
92
+ * @throws {@link ValidationException} (client fault)
93
+ * <p>The input fails to satisfy the constraints specified by a service.</p>
94
+ *
95
+ * @throws {@link BackupSearchServiceException}
96
+ * <p>Base exception class for all service exceptions from BackupSearch service.</p>
97
+ *
98
+ * @public
99
+ */
100
+ export declare class StartSearchResultExportJobCommand extends StartSearchResultExportJobCommand_base {
101
+ /** @internal type navigation helper, not in runtime. */
102
+ protected static __types: {
103
+ api: {
104
+ input: StartSearchResultExportJobInput;
105
+ output: StartSearchResultExportJobOutput;
106
+ };
107
+ sdk: {
108
+ input: StartSearchResultExportJobCommandInput;
109
+ output: StartSearchResultExportJobCommandOutput;
110
+ };
111
+ };
112
+ }
@@ -0,0 +1,96 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { BackupSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BackupSearchClient";
4
+ import { StopSearchJobInput, StopSearchJobOutput } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link StopSearchJobCommand}.
14
+ */
15
+ export interface StopSearchJobCommandInput extends StopSearchJobInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link StopSearchJobCommand}.
21
+ */
22
+ export interface StopSearchJobCommandOutput extends StopSearchJobOutput, __MetadataBearer {
23
+ }
24
+ declare const StopSearchJobCommand_base: {
25
+ new (input: StopSearchJobCommandInput): import("@smithy/smithy-client").CommandImpl<StopSearchJobCommandInput, StopSearchJobCommandOutput, BackupSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: StopSearchJobCommandInput): import("@smithy/smithy-client").CommandImpl<StopSearchJobCommandInput, StopSearchJobCommandOutput, BackupSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>This operations ends a search job.</p>
31
+ * <p>Only a search job with a status of <code>RUNNING</code>
32
+ * can be stopped.</p>
33
+ * @example
34
+ * Use a bare-bones client and the command you need to make an API call.
35
+ * ```javascript
36
+ * import { BackupSearchClient, StopSearchJobCommand } from "@aws-sdk/client-backupsearch"; // ES Modules import
37
+ * // const { BackupSearchClient, StopSearchJobCommand } = require("@aws-sdk/client-backupsearch"); // CommonJS import
38
+ * const client = new BackupSearchClient(config);
39
+ * const input = { // StopSearchJobInput
40
+ * SearchJobIdentifier: "STRING_VALUE", // required
41
+ * };
42
+ * const command = new StopSearchJobCommand(input);
43
+ * const response = await client.send(command);
44
+ * // {};
45
+ *
46
+ * ```
47
+ *
48
+ * @param StopSearchJobCommandInput - {@link StopSearchJobCommandInput}
49
+ * @returns {@link StopSearchJobCommandOutput}
50
+ * @see {@link StopSearchJobCommandInput} for command's `input` shape.
51
+ * @see {@link StopSearchJobCommandOutput} for command's `response` shape.
52
+ * @see {@link BackupSearchClientResolvedConfig | config} for BackupSearchClient's `config` shape.
53
+ *
54
+ * @throws {@link ConflictException} (client fault)
55
+ * <p>This exception occurs when a conflict with a previous successful
56
+ * operation is detected. This generally occurs when the previous
57
+ * operation did not have time to propagate to the host serving the
58
+ * current request.</p>
59
+ * <p>A retry (with appropriate backoff logic) is the recommended
60
+ * response to this exception.</p>
61
+ *
62
+ * @throws {@link ResourceNotFoundException} (client fault)
63
+ * <p>The resource was not found for this request.</p>
64
+ * <p>Confirm the resource information, such as the ARN or type is correct
65
+ * and exists, then retry the request.</p>
66
+ *
67
+ * @throws {@link AccessDeniedException} (client fault)
68
+ * <p>You do not have sufficient access to perform this action.</p>
69
+ *
70
+ * @throws {@link InternalServerException} (server fault)
71
+ * <p>An internal server error occurred. Retry your request.</p>
72
+ *
73
+ * @throws {@link ThrottlingException} (client fault)
74
+ * <p>The request was denied due to request throttling.</p>
75
+ *
76
+ * @throws {@link ValidationException} (client fault)
77
+ * <p>The input fails to satisfy the constraints specified by a service.</p>
78
+ *
79
+ * @throws {@link BackupSearchServiceException}
80
+ * <p>Base exception class for all service exceptions from BackupSearch service.</p>
81
+ *
82
+ * @public
83
+ */
84
+ export declare class StopSearchJobCommand extends StopSearchJobCommand_base {
85
+ /** @internal type navigation helper, not in runtime. */
86
+ protected static __types: {
87
+ api: {
88
+ input: StopSearchJobInput;
89
+ output: {};
90
+ };
91
+ sdk: {
92
+ input: StopSearchJobCommandInput;
93
+ output: StopSearchJobCommandOutput;
94
+ };
95
+ };
96
+ }