@aws-sdk/client-resource-explorer-2 3.206.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 (163) hide show
  1. package/LICENSE +201 -0
  2. package/README.md +241 -0
  3. package/dist-cjs/ResourceExplorer2.js +292 -0
  4. package/dist-cjs/ResourceExplorer2Client.js +40 -0
  5. package/dist-cjs/commands/AssociateDefaultViewCommand.js +45 -0
  6. package/dist-cjs/commands/BatchGetViewCommand.js +45 -0
  7. package/dist-cjs/commands/CreateIndexCommand.js +45 -0
  8. package/dist-cjs/commands/CreateViewCommand.js +45 -0
  9. package/dist-cjs/commands/DeleteIndexCommand.js +45 -0
  10. package/dist-cjs/commands/DeleteViewCommand.js +45 -0
  11. package/dist-cjs/commands/DisassociateDefaultViewCommand.js +44 -0
  12. package/dist-cjs/commands/GetDefaultViewCommand.js +45 -0
  13. package/dist-cjs/commands/GetIndexCommand.js +45 -0
  14. package/dist-cjs/commands/GetViewCommand.js +45 -0
  15. package/dist-cjs/commands/ListIndexesCommand.js +45 -0
  16. package/dist-cjs/commands/ListSupportedResourceTypesCommand.js +45 -0
  17. package/dist-cjs/commands/ListTagsForResourceCommand.js +45 -0
  18. package/dist-cjs/commands/ListViewsCommand.js +45 -0
  19. package/dist-cjs/commands/SearchCommand.js +45 -0
  20. package/dist-cjs/commands/TagResourceCommand.js +45 -0
  21. package/dist-cjs/commands/UntagResourceCommand.js +45 -0
  22. package/dist-cjs/commands/UpdateIndexTypeCommand.js +45 -0
  23. package/dist-cjs/commands/UpdateViewCommand.js +45 -0
  24. package/dist-cjs/commands/index.js +22 -0
  25. package/dist-cjs/endpoint/EndpointParameters.js +11 -0
  26. package/dist-cjs/endpoint/endpointResolver.js +12 -0
  27. package/dist-cjs/endpoint/ruleset.js +251 -0
  28. package/dist-cjs/index.js +11 -0
  29. package/dist-cjs/models/ResourceExplorer2ServiceException.js +11 -0
  30. package/dist-cjs/models/index.js +4 -0
  31. package/dist-cjs/models/models_0.js +318 -0
  32. package/dist-cjs/pagination/Interfaces.js +2 -0
  33. package/dist-cjs/pagination/ListIndexesPaginator.js +36 -0
  34. package/dist-cjs/pagination/ListSupportedResourceTypesPaginator.js +36 -0
  35. package/dist-cjs/pagination/ListViewsPaginator.js +36 -0
  36. package/dist-cjs/pagination/SearchPaginator.js +36 -0
  37. package/dist-cjs/pagination/index.js +8 -0
  38. package/dist-cjs/protocols/Aws_restJson1.js +1771 -0
  39. package/dist-cjs/runtimeConfig.browser.js +42 -0
  40. package/dist-cjs/runtimeConfig.js +50 -0
  41. package/dist-cjs/runtimeConfig.native.js +15 -0
  42. package/dist-cjs/runtimeConfig.shared.js +17 -0
  43. package/dist-es/ResourceExplorer2.js +288 -0
  44. package/dist-es/ResourceExplorer2Client.js +36 -0
  45. package/dist-es/commands/AssociateDefaultViewCommand.js +41 -0
  46. package/dist-es/commands/BatchGetViewCommand.js +41 -0
  47. package/dist-es/commands/CreateIndexCommand.js +41 -0
  48. package/dist-es/commands/CreateViewCommand.js +41 -0
  49. package/dist-es/commands/DeleteIndexCommand.js +41 -0
  50. package/dist-es/commands/DeleteViewCommand.js +41 -0
  51. package/dist-es/commands/DisassociateDefaultViewCommand.js +40 -0
  52. package/dist-es/commands/GetDefaultViewCommand.js +41 -0
  53. package/dist-es/commands/GetIndexCommand.js +41 -0
  54. package/dist-es/commands/GetViewCommand.js +41 -0
  55. package/dist-es/commands/ListIndexesCommand.js +41 -0
  56. package/dist-es/commands/ListSupportedResourceTypesCommand.js +41 -0
  57. package/dist-es/commands/ListTagsForResourceCommand.js +41 -0
  58. package/dist-es/commands/ListViewsCommand.js +41 -0
  59. package/dist-es/commands/SearchCommand.js +41 -0
  60. package/dist-es/commands/TagResourceCommand.js +41 -0
  61. package/dist-es/commands/UntagResourceCommand.js +41 -0
  62. package/dist-es/commands/UpdateIndexTypeCommand.js +41 -0
  63. package/dist-es/commands/UpdateViewCommand.js +41 -0
  64. package/dist-es/commands/index.js +19 -0
  65. package/dist-es/endpoint/EndpointParameters.js +7 -0
  66. package/dist-es/endpoint/endpointResolver.js +8 -0
  67. package/dist-es/endpoint/ruleset.js +248 -0
  68. package/dist-es/index.js +6 -0
  69. package/dist-es/models/ResourceExplorer2ServiceException.js +7 -0
  70. package/dist-es/models/index.js +1 -0
  71. package/dist-es/models/models_0.js +262 -0
  72. package/dist-es/pagination/Interfaces.js +1 -0
  73. package/dist-es/pagination/ListIndexesPaginator.js +32 -0
  74. package/dist-es/pagination/ListSupportedResourceTypesPaginator.js +32 -0
  75. package/dist-es/pagination/ListViewsPaginator.js +32 -0
  76. package/dist-es/pagination/SearchPaginator.js +32 -0
  77. package/dist-es/pagination/index.js +5 -0
  78. package/dist-es/protocols/Aws_restJson1.js +1730 -0
  79. package/dist-es/runtimeConfig.browser.js +37 -0
  80. package/dist-es/runtimeConfig.js +45 -0
  81. package/dist-es/runtimeConfig.native.js +11 -0
  82. package/dist-es/runtimeConfig.shared.js +13 -0
  83. package/dist-types/ResourceExplorer2.d.ts +336 -0
  84. package/dist-types/ResourceExplorer2Client.d.ts +196 -0
  85. package/dist-types/commands/AssociateDefaultViewCommand.d.ts +43 -0
  86. package/dist-types/commands/BatchGetViewCommand.d.ts +37 -0
  87. package/dist-types/commands/CreateIndexCommand.d.ts +90 -0
  88. package/dist-types/commands/CreateViewCommand.d.ts +44 -0
  89. package/dist-types/commands/DeleteIndexCommand.d.ts +42 -0
  90. package/dist-types/commands/DeleteViewCommand.d.ts +40 -0
  91. package/dist-types/commands/DisassociateDefaultViewCommand.d.ts +41 -0
  92. package/dist-types/commands/GetDefaultViewCommand.d.ts +38 -0
  93. package/dist-types/commands/GetIndexCommand.d.ts +38 -0
  94. package/dist-types/commands/GetViewCommand.d.ts +37 -0
  95. package/dist-types/commands/ListIndexesCommand.d.ts +38 -0
  96. package/dist-types/commands/ListSupportedResourceTypesCommand.d.ts +37 -0
  97. package/dist-types/commands/ListTagsForResourceCommand.d.ts +37 -0
  98. package/dist-types/commands/ListViewsCommand.d.ts +46 -0
  99. package/dist-types/commands/SearchCommand.d.ts +49 -0
  100. package/dist-types/commands/TagResourceCommand.d.ts +37 -0
  101. package/dist-types/commands/UntagResourceCommand.d.ts +37 -0
  102. package/dist-types/commands/UpdateIndexTypeCommand.d.ts +93 -0
  103. package/dist-types/commands/UpdateViewCommand.d.ts +38 -0
  104. package/dist-types/commands/index.d.ts +19 -0
  105. package/dist-types/endpoint/EndpointParameters.d.ts +17 -0
  106. package/dist-types/endpoint/endpointResolver.d.ts +5 -0
  107. package/dist-types/endpoint/ruleset.d.ts +2 -0
  108. package/dist-types/index.d.ts +6 -0
  109. package/dist-types/models/ResourceExplorer2ServiceException.d.ts +10 -0
  110. package/dist-types/models/index.d.ts +1 -0
  111. package/dist-types/models/models_0.d.ts +1080 -0
  112. package/dist-types/pagination/Interfaces.d.ts +6 -0
  113. package/dist-types/pagination/ListIndexesPaginator.d.ts +4 -0
  114. package/dist-types/pagination/ListSupportedResourceTypesPaginator.d.ts +4 -0
  115. package/dist-types/pagination/ListViewsPaginator.d.ts +4 -0
  116. package/dist-types/pagination/SearchPaginator.d.ts +4 -0
  117. package/dist-types/pagination/index.d.ts +5 -0
  118. package/dist-types/protocols/Aws_restJson1.d.ts +59 -0
  119. package/dist-types/runtimeConfig.browser.d.ts +42 -0
  120. package/dist-types/runtimeConfig.d.ts +42 -0
  121. package/dist-types/runtimeConfig.native.d.ts +41 -0
  122. package/dist-types/runtimeConfig.shared.d.ts +17 -0
  123. package/dist-types/ts3.4/ResourceExplorer2.d.ts +327 -0
  124. package/dist-types/ts3.4/ResourceExplorer2Client.d.ts +226 -0
  125. package/dist-types/ts3.4/commands/AssociateDefaultViewCommand.d.ts +41 -0
  126. package/dist-types/ts3.4/commands/BatchGetViewCommand.d.ts +34 -0
  127. package/dist-types/ts3.4/commands/CreateIndexCommand.d.ts +34 -0
  128. package/dist-types/ts3.4/commands/CreateViewCommand.d.ts +34 -0
  129. package/dist-types/ts3.4/commands/DeleteIndexCommand.d.ts +34 -0
  130. package/dist-types/ts3.4/commands/DeleteViewCommand.d.ts +34 -0
  131. package/dist-types/ts3.4/commands/DisassociateDefaultViewCommand.d.ts +35 -0
  132. package/dist-types/ts3.4/commands/GetDefaultViewCommand.d.ts +34 -0
  133. package/dist-types/ts3.4/commands/GetIndexCommand.d.ts +34 -0
  134. package/dist-types/ts3.4/commands/GetViewCommand.d.ts +32 -0
  135. package/dist-types/ts3.4/commands/ListIndexesCommand.d.ts +34 -0
  136. package/dist-types/ts3.4/commands/ListSupportedResourceTypesCommand.d.ts +41 -0
  137. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +38 -0
  138. package/dist-types/ts3.4/commands/ListViewsCommand.d.ts +34 -0
  139. package/dist-types/ts3.4/commands/SearchCommand.d.ts +32 -0
  140. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +34 -0
  141. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +34 -0
  142. package/dist-types/ts3.4/commands/UpdateIndexTypeCommand.d.ts +37 -0
  143. package/dist-types/ts3.4/commands/UpdateViewCommand.d.ts +34 -0
  144. package/dist-types/ts3.4/commands/index.d.ts +19 -0
  145. package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +32 -0
  146. package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +8 -0
  147. package/dist-types/ts3.4/endpoint/ruleset.d.ts +2 -0
  148. package/dist-types/ts3.4/index.d.ts +6 -0
  149. package/dist-types/ts3.4/models/ResourceExplorer2ServiceException.d.ts +7 -0
  150. package/dist-types/ts3.4/models/index.d.ts +1 -0
  151. package/dist-types/ts3.4/models/models_0.d.ts +384 -0
  152. package/dist-types/ts3.4/pagination/Interfaces.d.ts +7 -0
  153. package/dist-types/ts3.4/pagination/ListIndexesPaginator.d.ts +11 -0
  154. package/dist-types/ts3.4/pagination/ListSupportedResourceTypesPaginator.d.ts +11 -0
  155. package/dist-types/ts3.4/pagination/ListViewsPaginator.d.ts +11 -0
  156. package/dist-types/ts3.4/pagination/SearchPaginator.d.ts +11 -0
  157. package/dist-types/ts3.4/pagination/index.d.ts +5 -0
  158. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +233 -0
  159. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +88 -0
  160. package/dist-types/ts3.4/runtimeConfig.d.ts +88 -0
  161. package/dist-types/ts3.4/runtimeConfig.native.d.ts +77 -0
  162. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +19 -0
  163. package/package.json +105 -0
@@ -0,0 +1,37 @@
1
+ import packageInfo from "../package.json";
2
+ import { Sha256 } from "@aws-crypto/sha256-browser";
3
+ import { DEFAULT_USE_DUALSTACK_ENDPOINT, DEFAULT_USE_FIPS_ENDPOINT } from "@aws-sdk/config-resolver";
4
+ import { FetchHttpHandler as RequestHandler, streamCollector } from "@aws-sdk/fetch-http-handler";
5
+ import { invalidProvider } from "@aws-sdk/invalid-dependency";
6
+ import { DEFAULT_MAX_ATTEMPTS, DEFAULT_RETRY_MODE } from "@aws-sdk/middleware-retry";
7
+ import { calculateBodyLength } from "@aws-sdk/util-body-length-browser";
8
+ import { defaultUserAgent } from "@aws-sdk/util-user-agent-browser";
9
+ import { fromUtf8, toUtf8 } from "@aws-sdk/util-utf8-browser";
10
+ import { getRuntimeConfig as getSharedRuntimeConfig } from "./runtimeConfig.shared";
11
+ import { loadConfigsForDefaultMode } from "@aws-sdk/smithy-client";
12
+ import { resolveDefaultsModeConfig } from "@aws-sdk/util-defaults-mode-browser";
13
+ export const getRuntimeConfig = (config) => {
14
+ const defaultsMode = resolveDefaultsModeConfig(config);
15
+ const defaultConfigProvider = () => defaultsMode().then(loadConfigsForDefaultMode);
16
+ const clientSharedValues = getSharedRuntimeConfig(config);
17
+ return {
18
+ ...clientSharedValues,
19
+ ...config,
20
+ runtime: "browser",
21
+ defaultsMode,
22
+ bodyLengthChecker: config?.bodyLengthChecker ?? calculateBodyLength,
23
+ credentialDefaultProvider: config?.credentialDefaultProvider ?? ((_) => () => Promise.reject(new Error("Credential is missing"))),
24
+ defaultUserAgentProvider: config?.defaultUserAgentProvider ??
25
+ defaultUserAgent({ serviceId: clientSharedValues.serviceId, clientVersion: packageInfo.version }),
26
+ maxAttempts: config?.maxAttempts ?? DEFAULT_MAX_ATTEMPTS,
27
+ region: config?.region ?? invalidProvider("Region is missing"),
28
+ requestHandler: config?.requestHandler ?? new RequestHandler(defaultConfigProvider),
29
+ retryMode: config?.retryMode ?? (async () => (await defaultConfigProvider()).retryMode || DEFAULT_RETRY_MODE),
30
+ sha256: config?.sha256 ?? Sha256,
31
+ streamCollector: config?.streamCollector ?? streamCollector,
32
+ useDualstackEndpoint: config?.useDualstackEndpoint ?? (() => Promise.resolve(DEFAULT_USE_DUALSTACK_ENDPOINT)),
33
+ useFipsEndpoint: config?.useFipsEndpoint ?? (() => Promise.resolve(DEFAULT_USE_FIPS_ENDPOINT)),
34
+ utf8Decoder: config?.utf8Decoder ?? fromUtf8,
35
+ utf8Encoder: config?.utf8Encoder ?? toUtf8,
36
+ };
37
+ };
@@ -0,0 +1,45 @@
1
+ import packageInfo from "../package.json";
2
+ import { decorateDefaultCredentialProvider } from "@aws-sdk/client-sts";
3
+ import { NODE_REGION_CONFIG_FILE_OPTIONS, NODE_REGION_CONFIG_OPTIONS, NODE_USE_DUALSTACK_ENDPOINT_CONFIG_OPTIONS, NODE_USE_FIPS_ENDPOINT_CONFIG_OPTIONS, } from "@aws-sdk/config-resolver";
4
+ import { defaultProvider as credentialDefaultProvider } from "@aws-sdk/credential-provider-node";
5
+ import { Hash } from "@aws-sdk/hash-node";
6
+ import { DEFAULT_RETRY_MODE, NODE_MAX_ATTEMPT_CONFIG_OPTIONS, NODE_RETRY_MODE_CONFIG_OPTIONS, } from "@aws-sdk/middleware-retry";
7
+ import { loadConfig as loadNodeConfig } from "@aws-sdk/node-config-provider";
8
+ import { NodeHttpHandler as RequestHandler, streamCollector } from "@aws-sdk/node-http-handler";
9
+ import { calculateBodyLength } from "@aws-sdk/util-body-length-node";
10
+ import { defaultUserAgent } from "@aws-sdk/util-user-agent-node";
11
+ import { fromUtf8, toUtf8 } from "@aws-sdk/util-utf8-node";
12
+ import { getRuntimeConfig as getSharedRuntimeConfig } from "./runtimeConfig.shared";
13
+ import { loadConfigsForDefaultMode } from "@aws-sdk/smithy-client";
14
+ import { resolveDefaultsModeConfig } from "@aws-sdk/util-defaults-mode-node";
15
+ import { emitWarningIfUnsupportedVersion } from "@aws-sdk/smithy-client";
16
+ export const getRuntimeConfig = (config) => {
17
+ emitWarningIfUnsupportedVersion(process.version);
18
+ const defaultsMode = resolveDefaultsModeConfig(config);
19
+ const defaultConfigProvider = () => defaultsMode().then(loadConfigsForDefaultMode);
20
+ const clientSharedValues = getSharedRuntimeConfig(config);
21
+ return {
22
+ ...clientSharedValues,
23
+ ...config,
24
+ runtime: "node",
25
+ defaultsMode,
26
+ bodyLengthChecker: config?.bodyLengthChecker ?? calculateBodyLength,
27
+ credentialDefaultProvider: config?.credentialDefaultProvider ?? decorateDefaultCredentialProvider(credentialDefaultProvider),
28
+ defaultUserAgentProvider: config?.defaultUserAgentProvider ??
29
+ defaultUserAgent({ serviceId: clientSharedValues.serviceId, clientVersion: packageInfo.version }),
30
+ maxAttempts: config?.maxAttempts ?? loadNodeConfig(NODE_MAX_ATTEMPT_CONFIG_OPTIONS),
31
+ region: config?.region ?? loadNodeConfig(NODE_REGION_CONFIG_OPTIONS, NODE_REGION_CONFIG_FILE_OPTIONS),
32
+ requestHandler: config?.requestHandler ?? new RequestHandler(defaultConfigProvider),
33
+ retryMode: config?.retryMode ??
34
+ loadNodeConfig({
35
+ ...NODE_RETRY_MODE_CONFIG_OPTIONS,
36
+ default: async () => (await defaultConfigProvider()).retryMode || DEFAULT_RETRY_MODE,
37
+ }),
38
+ sha256: config?.sha256 ?? Hash.bind(null, "sha256"),
39
+ streamCollector: config?.streamCollector ?? streamCollector,
40
+ useDualstackEndpoint: config?.useDualstackEndpoint ?? loadNodeConfig(NODE_USE_DUALSTACK_ENDPOINT_CONFIG_OPTIONS),
41
+ useFipsEndpoint: config?.useFipsEndpoint ?? loadNodeConfig(NODE_USE_FIPS_ENDPOINT_CONFIG_OPTIONS),
42
+ utf8Decoder: config?.utf8Decoder ?? fromUtf8,
43
+ utf8Encoder: config?.utf8Encoder ?? toUtf8,
44
+ };
45
+ };
@@ -0,0 +1,11 @@
1
+ import { Sha256 } from "@aws-crypto/sha256-js";
2
+ import { getRuntimeConfig as getBrowserRuntimeConfig } from "./runtimeConfig.browser";
3
+ export const getRuntimeConfig = (config) => {
4
+ const browserDefaults = getBrowserRuntimeConfig(config);
5
+ return {
6
+ ...browserDefaults,
7
+ ...config,
8
+ runtime: "react-native",
9
+ sha256: config?.sha256 ?? Sha256,
10
+ };
11
+ };
@@ -0,0 +1,13 @@
1
+ import { parseUrl } from "@aws-sdk/url-parser";
2
+ import { fromBase64, toBase64 } from "@aws-sdk/util-base64";
3
+ import { defaultEndpointResolver } from "./endpoint/endpointResolver";
4
+ export const getRuntimeConfig = (config) => ({
5
+ apiVersion: "2022-07-28",
6
+ base64Decoder: config?.base64Decoder ?? fromBase64,
7
+ base64Encoder: config?.base64Encoder ?? toBase64,
8
+ disableHostPrefix: config?.disableHostPrefix ?? false,
9
+ endpointProvider: config?.endpointProvider ?? defaultEndpointResolver,
10
+ logger: config?.logger ?? {},
11
+ serviceId: config?.serviceId ?? "Resource Explorer 2",
12
+ urlParser: config?.urlParser ?? parseUrl,
13
+ });
@@ -0,0 +1,336 @@
1
+ import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types";
2
+ import { AssociateDefaultViewCommandInput, AssociateDefaultViewCommandOutput } from "./commands/AssociateDefaultViewCommand";
3
+ import { BatchGetViewCommandInput, BatchGetViewCommandOutput } from "./commands/BatchGetViewCommand";
4
+ import { CreateIndexCommandInput, CreateIndexCommandOutput } from "./commands/CreateIndexCommand";
5
+ import { CreateViewCommandInput, CreateViewCommandOutput } from "./commands/CreateViewCommand";
6
+ import { DeleteIndexCommandInput, DeleteIndexCommandOutput } from "./commands/DeleteIndexCommand";
7
+ import { DeleteViewCommandInput, DeleteViewCommandOutput } from "./commands/DeleteViewCommand";
8
+ import { DisassociateDefaultViewCommandInput, DisassociateDefaultViewCommandOutput } from "./commands/DisassociateDefaultViewCommand";
9
+ import { GetDefaultViewCommandInput, GetDefaultViewCommandOutput } from "./commands/GetDefaultViewCommand";
10
+ import { GetIndexCommandInput, GetIndexCommandOutput } from "./commands/GetIndexCommand";
11
+ import { GetViewCommandInput, GetViewCommandOutput } from "./commands/GetViewCommand";
12
+ import { ListIndexesCommandInput, ListIndexesCommandOutput } from "./commands/ListIndexesCommand";
13
+ import { ListSupportedResourceTypesCommandInput, ListSupportedResourceTypesCommandOutput } from "./commands/ListSupportedResourceTypesCommand";
14
+ import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
15
+ import { ListViewsCommandInput, ListViewsCommandOutput } from "./commands/ListViewsCommand";
16
+ import { SearchCommandInput, SearchCommandOutput } from "./commands/SearchCommand";
17
+ import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
18
+ import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
19
+ import { UpdateIndexTypeCommandInput, UpdateIndexTypeCommandOutput } from "./commands/UpdateIndexTypeCommand";
20
+ import { UpdateViewCommandInput, UpdateViewCommandOutput } from "./commands/UpdateViewCommand";
21
+ import { ResourceExplorer2Client } from "./ResourceExplorer2Client";
22
+ /**
23
+ * <p>Amazon Web Services Resource Explorer is a resource search and discovery service. By using Resource Explorer, you can
24
+ * explore your resources using an internet search engine-like experience. Examples of
25
+ * resources include Amazon Relational Database Service (Amazon RDS) instances, Amazon Simple Storage Service (Amazon S3) buckets, or Amazon DynamoDB
26
+ * tables. You can search for your resources using resource metadata like names, tags, and
27
+ * IDs. Resource Explorer can search across all of the Amazon Web Services Regions in your account in which you turn
28
+ * the service on, to simplify your cross-Region workloads.</p>
29
+ * <p>Resource Explorer scans the resources in each of the Amazon Web Services Regions in your Amazon Web Services account in which
30
+ * you turn on Resource Explorer. Resource Explorer <a href="https://docs.aws.amazon.com/arexug/mainline/getting-started-terms-and-concepts.html#term-index">creates and
31
+ * maintains an index</a> in each Region, with the details of that Region's
32
+ * resources.</p>
33
+ * <p>You can <a href="https://docs.aws.amazon.com/arexug/mainline/manage-aggregator-region.html">search across all of the indexed
34
+ * Regions in your account</a> by designating one of your Amazon Web Services Regions to contain
35
+ * the aggregator index for the account. When you <a href="https://docs.aws.amazon.com/arexug/mainline/manage-aggregator-region-turn-on.html">promote a local index in
36
+ * a Region to become the aggregator index for the account</a>, Resource Explorer automatically
37
+ * replicates the index information from all local indexes in the other Regions to the
38
+ * aggregator index. Therefore, the Region with the aggregator index has a copy of all resource
39
+ * information for all Regions in the account where you turned on Resource Explorer. As a result,
40
+ * views in the aggregator index Region include resources from all of the indexed Regions in your
41
+ * account.</p>
42
+ *
43
+ * <p>For more information about Amazon Web Services Resource Explorer, including how to enable and configure the
44
+ * service, see the <a href="https://docs.aws.amazon.com/resource-explorer/latest/userguide/">Amazon Web Services Resource Explorer User Guide</a>.</p>
45
+ * <note>
46
+ * <p>The example HTTP query requests and responses in this guide are displayed with the
47
+ * <a href="https://json.org">JSON</a> formatted across multiple lines for
48
+ * readability. The actual query responses from the Resource Explorer service do not include this
49
+ * extra whitespace.</p>
50
+ * </note>
51
+ * <p>
52
+ * <b>We want your feedback about this documentation</b>
53
+ * </p>
54
+ * <p>Our goal is to help you get everything you can from Resource Explorer. If this guide helps you to
55
+ * do that, then let us know. If the guide isn't helping you, then we want to hear from you
56
+ * so we can address the issue. Use the <b>Feedback</b> link
57
+ * that's in the upper-right corner of every page. That sends your comments directly to the
58
+ * writers of this guide. We review every submission, looking for opportunities to improve
59
+ * the documentation. Thank you in advance for your help!</p>
60
+ */
61
+ export declare class ResourceExplorer2 extends ResourceExplorer2Client {
62
+ /**
63
+ * <p>Sets the specified view as the default for the Amazon Web Services Region in which you call this
64
+ * operation. When a user performs a <a>Search</a> that doesn't explicitly
65
+ * specify which view to use, then Amazon Web Services Resource Explorer automatically chooses this default view for
66
+ * searches performed in this Amazon Web Services Region.</p>
67
+ * <p>If an Amazon Web Services Region doesn't have a default view
68
+ * configured, then users must explicitly specify a view with every <code>Search</code>
69
+ * operation performed in that Region.</p>
70
+ */
71
+ associateDefaultView(args: AssociateDefaultViewCommandInput, options?: __HttpHandlerOptions): Promise<AssociateDefaultViewCommandOutput>;
72
+ associateDefaultView(args: AssociateDefaultViewCommandInput, cb: (err: any, data?: AssociateDefaultViewCommandOutput) => void): void;
73
+ associateDefaultView(args: AssociateDefaultViewCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateDefaultViewCommandOutput) => void): void;
74
+ /**
75
+ * <p>Retrieves details about a list of views.</p>
76
+ */
77
+ batchGetView(args: BatchGetViewCommandInput, options?: __HttpHandlerOptions): Promise<BatchGetViewCommandOutput>;
78
+ batchGetView(args: BatchGetViewCommandInput, cb: (err: any, data?: BatchGetViewCommandOutput) => void): void;
79
+ batchGetView(args: BatchGetViewCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetViewCommandOutput) => void): void;
80
+ /**
81
+ * <p>Turns on Amazon Web Services Resource Explorer in the Amazon Web Services Region in which you called this operation by creating
82
+ * an index. Resource Explorer begins discovering the resources in this Region and stores the details
83
+ * about the resources in the index so that they can be queried by using the <a>Search</a> operation. You can create only one index in a Region.</p>
84
+ * <note>
85
+ * <p>This operation creates only a <i>local</i> index. To promote the
86
+ * local index in one Amazon Web Services Region into the aggregator index for the Amazon Web Services account, use the
87
+ * <a>UpdateIndexType</a> operation. For more information, see <a href="https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-aggregator-region.html">Turning on cross-Region search by creating an aggregator index</a> in the
88
+ * <i>Amazon Web Services Resource Explorer User Guide</i>.</p>
89
+ * </note>
90
+ * <p>For more details about what happens when you turn on Resource Explorer in an Amazon Web Services Region, see
91
+ * <a href="https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-service-activate.html">Turn
92
+ * on Resource Explorer to index your resources in an Amazon Web Services Region</a> in the
93
+ * <i>Amazon Web Services Resource Explorer User Guide</i>.</p>
94
+ * <p>If this is the first Amazon Web Services Region in which you've created an index for Resource Explorer, then
95
+ * this operation also <a href="https://docs.aws.amazon.com/arexug/mainline/security_iam_service-linked-roles.html">creates a
96
+ * service-linked role</a> in your Amazon Web Services account that allows Resource Explorer to enumerate
97
+ * your resources to populate the index.</p>
98
+ *
99
+ *
100
+ *
101
+ * <ul>
102
+ * <li>
103
+ * <p>
104
+ * <b>Action</b>:
105
+ * <code>resource-explorer-2:CreateIndex</code>
106
+ * </p>
107
+ * <p>
108
+ * <b>Resource</b>: The ARN of the index (as it will
109
+ * exist after the operation completes) in the Amazon Web Services Region and account in which
110
+ * you're trying to create the index. Use the wildcard character (<code>*</code>)
111
+ * at the end of the string to match the eventual UUID. For example, the following
112
+ * <code>Resource</code> element restricts the role or user to creating an
113
+ * index in only the <code>us-east-2</code> Region of the specified account.</p>
114
+ * <p>
115
+ * <code>"Resource":
116
+ * "arn:aws:resource-explorer-2:us-east-2:<i>&lt;account-id&gt;</i>:index/*"</code>
117
+ * </p>
118
+ * <p>Alternatively, you can use <code>"Resource": "*"</code> to allow the role or
119
+ * user to create an index in any Region.</p>
120
+ * </li>
121
+ * <li>
122
+ * <p>
123
+ * <b>Action</b>:
124
+ * <code>iam:CreateServiceLinkedRole</code>
125
+ * </p>
126
+ * <p>
127
+ * <b>Resource</b>: No specific resource (*). </p>
128
+ * <p>This permission is required only the first time you create an index to turn on
129
+ * Resource Explorer in the account. Resource Explorer uses this to create the <a href="https://docs.aws.amazon.com/resource-explorer/latest/userguide/security_iam_service-linked-roles.html">service-linked
130
+ * role needed to index the resources in your account</a>. Resource Explorer uses the
131
+ * same service-linked role for all additional indexes you create
132
+ * afterwards.</p>
133
+ * </li>
134
+ * </ul>
135
+ */
136
+ createIndex(args: CreateIndexCommandInput, options?: __HttpHandlerOptions): Promise<CreateIndexCommandOutput>;
137
+ createIndex(args: CreateIndexCommandInput, cb: (err: any, data?: CreateIndexCommandOutput) => void): void;
138
+ createIndex(args: CreateIndexCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateIndexCommandOutput) => void): void;
139
+ /**
140
+ * <p>Creates a view that users can query by using the <a>Search</a> operation.
141
+ * Results from queries that you make using this view include only resources that match the
142
+ * view's <code>Filters</code>. For more information about Amazon Web Services Resource Explorer views, see <a href="https://docs.aws.amazon.com/arexug/mainline/manage-views.html">Managing views</a>
143
+ * in the <i>Amazon Web Services Resource Explorer User Guide</i>.</p>
144
+ * <p>Only the principals with an IAM identity-based policy that grants <code>Allow</code>
145
+ * to the <code>Search</code> action on a <code>Resource</code> with the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon resource name (ARN)</a> of
146
+ * this view can <a>Search</a> using views you create with this
147
+ * operation.</p>
148
+ */
149
+ createView(args: CreateViewCommandInput, options?: __HttpHandlerOptions): Promise<CreateViewCommandOutput>;
150
+ createView(args: CreateViewCommandInput, cb: (err: any, data?: CreateViewCommandOutput) => void): void;
151
+ createView(args: CreateViewCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateViewCommandOutput) => void): void;
152
+ /**
153
+ * <p>Deletes the specified index and turns off Amazon Web Services Resource Explorer in the specified Amazon Web Services Region.
154
+ * When you delete an index, Resource Explorer stops discovering and indexing resources in that
155
+ * Region. Resource Explorer also deletes all views in that Region. These actions occur as
156
+ * asynchronous background tasks. You can check to see when the actions are complete by
157
+ * using the <a>GetIndex</a> operation and checking the <code>Status</code>
158
+ * response value.</p>
159
+ */
160
+ deleteIndex(args: DeleteIndexCommandInput, options?: __HttpHandlerOptions): Promise<DeleteIndexCommandOutput>;
161
+ deleteIndex(args: DeleteIndexCommandInput, cb: (err: any, data?: DeleteIndexCommandOutput) => void): void;
162
+ deleteIndex(args: DeleteIndexCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteIndexCommandOutput) => void): void;
163
+ /**
164
+ * <p>Deletes the specified view.</p>
165
+ * <p>If the specified view is the default view for its Amazon Web Services Region, then all <a>Search</a> operations in that Region must explicitly specify the view to use
166
+ * until you configure a new default by calling the <a>AssociateDefaultView</a>
167
+ * operation.</p>
168
+ */
169
+ deleteView(args: DeleteViewCommandInput, options?: __HttpHandlerOptions): Promise<DeleteViewCommandOutput>;
170
+ deleteView(args: DeleteViewCommandInput, cb: (err: any, data?: DeleteViewCommandOutput) => void): void;
171
+ deleteView(args: DeleteViewCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteViewCommandOutput) => void): void;
172
+ /**
173
+ * <p>After you call this operation, the affected Amazon Web Services Region no longer has a default view.
174
+ * All <a>Search</a> operations in that Region must explicitly specify a view or
175
+ * the operation fails. You can configure a new default by calling the <a>AssociateDefaultView</a> operation.</p>
176
+ * <p>If an Amazon Web Services Region doesn't have a default view
177
+ * configured, then users must explicitly specify a view with every <code>Search</code>
178
+ * operation performed in that Region.</p>
179
+ */
180
+ disassociateDefaultView(args: DisassociateDefaultViewCommandInput, options?: __HttpHandlerOptions): Promise<DisassociateDefaultViewCommandOutput>;
181
+ disassociateDefaultView(args: DisassociateDefaultViewCommandInput, cb: (err: any, data?: DisassociateDefaultViewCommandOutput) => void): void;
182
+ disassociateDefaultView(args: DisassociateDefaultViewCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateDefaultViewCommandOutput) => void): void;
183
+ /**
184
+ * <p>Retrieves the Amazon Resource Name (ARN) of the view that is the default for the
185
+ * Amazon Web Services Region in which you call this operation. You can then call <a>GetView</a> to retrieve the details of that view.</p>
186
+ */
187
+ getDefaultView(args: GetDefaultViewCommandInput, options?: __HttpHandlerOptions): Promise<GetDefaultViewCommandOutput>;
188
+ getDefaultView(args: GetDefaultViewCommandInput, cb: (err: any, data?: GetDefaultViewCommandOutput) => void): void;
189
+ getDefaultView(args: GetDefaultViewCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDefaultViewCommandOutput) => void): void;
190
+ /**
191
+ * <p>Retrieves details about the Amazon Web Services Resource Explorer index in the Amazon Web Services Region in which you invoked
192
+ * the operation.</p>
193
+ */
194
+ getIndex(args: GetIndexCommandInput, options?: __HttpHandlerOptions): Promise<GetIndexCommandOutput>;
195
+ getIndex(args: GetIndexCommandInput, cb: (err: any, data?: GetIndexCommandOutput) => void): void;
196
+ getIndex(args: GetIndexCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetIndexCommandOutput) => void): void;
197
+ /**
198
+ * <p>Retrieves details of the specified view.</p>
199
+ */
200
+ getView(args: GetViewCommandInput, options?: __HttpHandlerOptions): Promise<GetViewCommandOutput>;
201
+ getView(args: GetViewCommandInput, cb: (err: any, data?: GetViewCommandOutput) => void): void;
202
+ getView(args: GetViewCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetViewCommandOutput) => void): void;
203
+ /**
204
+ * <p>Retrieves a list of all of the indexes in Amazon Web Services Regions that are currently collecting
205
+ * resource information for Amazon Web Services Resource Explorer.</p>
206
+ */
207
+ listIndexes(args: ListIndexesCommandInput, options?: __HttpHandlerOptions): Promise<ListIndexesCommandOutput>;
208
+ listIndexes(args: ListIndexesCommandInput, cb: (err: any, data?: ListIndexesCommandOutput) => void): void;
209
+ listIndexes(args: ListIndexesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListIndexesCommandOutput) => void): void;
210
+ /**
211
+ * <p>Retrieves a list of all resource types currently supported by Amazon Web Services Resource Explorer.</p>
212
+ */
213
+ listSupportedResourceTypes(args: ListSupportedResourceTypesCommandInput, options?: __HttpHandlerOptions): Promise<ListSupportedResourceTypesCommandOutput>;
214
+ listSupportedResourceTypes(args: ListSupportedResourceTypesCommandInput, cb: (err: any, data?: ListSupportedResourceTypesCommandOutput) => void): void;
215
+ listSupportedResourceTypes(args: ListSupportedResourceTypesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSupportedResourceTypesCommandOutput) => void): void;
216
+ /**
217
+ * <p>Lists the tags that are attached to the specified resource.</p>
218
+ */
219
+ listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
220
+ listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
221
+ listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
222
+ /**
223
+ * <p>Lists the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon resource names (ARNs)</a> of the views available in the Amazon Web Services Region in which you
224
+ * call this operation.</p>
225
+ * <note>
226
+ * <p>Always check the <code>NextToken</code> response parameter
227
+ * for a <code>null</code> value when calling a paginated operation. These operations can
228
+ * occasionally return an empty set of results even when there are more results available. The
229
+ * <code>NextToken</code> response parameter value is <code>null</code>
230
+ * <i>only</i>
231
+ * when there are no more results to display.</p>
232
+ * </note>
233
+ */
234
+ listViews(args: ListViewsCommandInput, options?: __HttpHandlerOptions): Promise<ListViewsCommandOutput>;
235
+ listViews(args: ListViewsCommandInput, cb: (err: any, data?: ListViewsCommandOutput) => void): void;
236
+ listViews(args: ListViewsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListViewsCommandOutput) => void): void;
237
+ /**
238
+ * <p>Searches for resources and displays details about all resources that match the
239
+ * specified criteria. You must specify a query string.</p>
240
+ * <p>All search queries must use a view. If you don't explicitly specify a view, then
241
+ * Amazon Web Services Resource Explorer uses the default view for the Amazon Web Services Region in which you call this operation.
242
+ * The results are the logical intersection of the results that match both the
243
+ * <code>QueryString</code> parameter supplied to this operation and the
244
+ * <code>SearchFilter</code> parameter attached to the view.</p>
245
+ * <p>For the complete syntax supported by the <code>QueryString</code> parameter, see
246
+ * <a href="https://docs.aws.amazon.com/resource-explorer/latest/APIReference/about-query-syntax.html">Search
247
+ * query syntax reference for Resource Explorer</a>.</p>
248
+ * <p>If your search results are empty, or are missing results that you think should be
249
+ * there, see <a href="https://docs.aws.amazon.com/resource-explorer/latest/userguide/troubleshooting_search.html">Troubleshooting Resource Explorer
250
+ * search</a>.</p>
251
+ */
252
+ search(args: SearchCommandInput, options?: __HttpHandlerOptions): Promise<SearchCommandOutput>;
253
+ search(args: SearchCommandInput, cb: (err: any, data?: SearchCommandOutput) => void): void;
254
+ search(args: SearchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchCommandOutput) => void): void;
255
+ /**
256
+ * <p>Adds one or more tag key and value pairs to an Amazon Web Services Resource Explorer view or index.</p>
257
+ */
258
+ tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
259
+ tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
260
+ tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
261
+ /**
262
+ * <p>Removes one or more tag key and value pairs from an Amazon Web Services Resource Explorer view or index.</p>
263
+ */
264
+ untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
265
+ untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
266
+ untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
267
+ /**
268
+ * <p>Changes the type of the index from one of the following types to the other. For more
269
+ * information about indexes and the role they perform in Amazon Web Services Resource Explorer, see <a href="https://docs.aws.amazon.com/arexug/mainline/manage-aggregator-region.html">Turning on
270
+ * cross-Region search by creating an aggregator index</a> in the
271
+ * <i>Amazon Web Services Resource Explorer User Guide</i>.</p>
272
+ * <ul>
273
+ * <li>
274
+ * <p>
275
+ * <b>
276
+ * <code>AGGREGATOR</code> index type</b>
277
+ * </p>
278
+ * <p>The index contains information about resources from all Amazon Web Services Regions in the
279
+ * Amazon Web Services account in which you've created a Resource Explorer index. Resource information from
280
+ * all other Regions is replicated to this Region's index.</p>
281
+ * <p>When you change the index type to <code>AGGREGATOR</code>, Resource Explorer turns on
282
+ * replication of all discovered resource information from the other Amazon Web Services Regions
283
+ * in your account to this index. You can then, from this Region only, perform
284
+ * resource search queries that span all Amazon Web Services Regions in the Amazon Web Services account.
285
+ * Turning on replication from all other Regions is performed by asynchronous
286
+ * background tasks. You can check the status of the asynchronous tasks by using
287
+ * the <a>GetIndex</a> operation. When the asynchronous tasks complete,
288
+ * the <code>Status</code> response of that operation changes from
289
+ * <code>UPDATING</code> to <code>ACTIVE</code>. After that, you can start to
290
+ * see results from other Amazon Web Services Regions in query results. However, it can take
291
+ * several hours for replication from all other Regions to complete.</p>
292
+ * <important>
293
+ * <p>You can have only one aggregator index per Amazon Web Services account. Before you can
294
+ * promote a different index to be the aggregator index for the account, you must
295
+ * first demote the existing aggregator index to type <code>LOCAL</code>.</p>
296
+ * </important>
297
+ * </li>
298
+ * <li>
299
+ * <p>
300
+ * <b>
301
+ * <code>LOCAL</code> index type</b>
302
+ * </p>
303
+ * <p>The index contains information about resources in only the Amazon Web Services Region in
304
+ * which the index exists. If an aggregator index in another Region exists, then
305
+ * information in this local index is replicated to the aggregator index.</p>
306
+ * <p>When you change the index type to <code>LOCAL</code>, Resource Explorer turns off the
307
+ * replication of resource information from all other Amazon Web Services Regions in the
308
+ * Amazon Web Services account to this Region. The aggregator index remains in the
309
+ * <code>UPDATING</code> state until all replication with other Regions
310
+ * successfully stops. You can check the status of the asynchronous task by using
311
+ * the <a>GetIndex</a> operation. When Resource Explorer successfully stops all
312
+ * replication with other Regions, the <code>Status</code> response of that
313
+ * operation changes from <code>UPDATING</code> to <code>ACTIVE</code>. Separately,
314
+ * the resource information from other Regions that was previously stored in the
315
+ * index is deleted within 30 days by another background task. Until that
316
+ * asynchronous task completes, some results from other Regions can continue to
317
+ * appear in search results.</p>
318
+ * <important>
319
+ * <p>After you demote an aggregator index to a local index, you must wait
320
+ * 24 hours before you can promote another index to be the new
321
+ * aggregator index for the account.</p>
322
+ * </important>
323
+ * </li>
324
+ * </ul>
325
+ */
326
+ updateIndexType(args: UpdateIndexTypeCommandInput, options?: __HttpHandlerOptions): Promise<UpdateIndexTypeCommandOutput>;
327
+ updateIndexType(args: UpdateIndexTypeCommandInput, cb: (err: any, data?: UpdateIndexTypeCommandOutput) => void): void;
328
+ updateIndexType(args: UpdateIndexTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateIndexTypeCommandOutput) => void): void;
329
+ /**
330
+ * <p>Modifies some of the details of a view. You can change the filter string and the list
331
+ * of included properties. You can't change the name of the view.</p>
332
+ */
333
+ updateView(args: UpdateViewCommandInput, options?: __HttpHandlerOptions): Promise<UpdateViewCommandOutput>;
334
+ updateView(args: UpdateViewCommandInput, cb: (err: any, data?: UpdateViewCommandOutput) => void): void;
335
+ updateView(args: UpdateViewCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateViewCommandOutput) => void): void;
336
+ }