@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,1080 @@
1
+ import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
2
+ import { DocumentType as __DocumentType } from "@aws-sdk/types";
3
+ import { ResourceExplorer2ServiceException as __BaseException } from "./ResourceExplorer2ServiceException";
4
+ /**
5
+ * <p>The credentials that you used to call this operation don't have the minimum required
6
+ * permissions.</p>
7
+ */
8
+ export declare class AccessDeniedException extends __BaseException {
9
+ readonly name: "AccessDeniedException";
10
+ readonly $fault: "client";
11
+ Message?: string;
12
+ /**
13
+ * @internal
14
+ */
15
+ constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
16
+ }
17
+ export interface AssociateDefaultViewInput {
18
+ /**
19
+ * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon resource name (ARN)</a> of the view to set as the default for the Amazon Web Services Region and
20
+ * Amazon Web Services account in which you call this operation. The specified view must already exist in
21
+ * the called Region.</p>
22
+ */
23
+ ViewArn: string | undefined;
24
+ }
25
+ export interface AssociateDefaultViewOutput {
26
+ /**
27
+ * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon resource name (ARN)</a> of the view that the operation set as the default for queries made
28
+ * in the Amazon Web Services Region and Amazon Web Services account in which you called this operation.</p>
29
+ */
30
+ ViewArn?: string;
31
+ }
32
+ /**
33
+ * <p>The request failed because of internal service error. Try your request again
34
+ * later.</p>
35
+ */
36
+ export declare class InternalServerException extends __BaseException {
37
+ readonly name: "InternalServerException";
38
+ readonly $fault: "server";
39
+ Message?: string;
40
+ /**
41
+ * @internal
42
+ */
43
+ constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
44
+ }
45
+ /**
46
+ * <p>You specified a resource that doesn't exist. Check the ID or ARN that you used to
47
+ * identity the resource, and try again.</p>
48
+ */
49
+ export declare class ResourceNotFoundException extends __BaseException {
50
+ readonly name: "ResourceNotFoundException";
51
+ readonly $fault: "client";
52
+ Message?: string;
53
+ /**
54
+ * @internal
55
+ */
56
+ constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
57
+ }
58
+ /**
59
+ * <p>The request failed because you exceeded a rate limit for this operation. For more
60
+ * information, see <a href="https://docs.aws.amazon.com/arexug/mainline/quotas.html">Quotas
61
+ * for Resource Explorer</a>.</p>
62
+ */
63
+ export declare class ThrottlingException extends __BaseException {
64
+ readonly name: "ThrottlingException";
65
+ readonly $fault: "client";
66
+ Message?: string;
67
+ /**
68
+ * @internal
69
+ */
70
+ constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
71
+ }
72
+ /**
73
+ * <p>A structure that describes a request field with a validation error.</p>
74
+ */
75
+ export interface ValidationExceptionField {
76
+ /**
77
+ * <p>The name of the request field that had a validation error.</p>
78
+ */
79
+ Name: string | undefined;
80
+ /**
81
+ * <p>The validation error caused by the request field.</p>
82
+ */
83
+ ValidationIssue: string | undefined;
84
+ }
85
+ /**
86
+ * <p>You provided an invalid value for one of the operation's parameters. Check the syntax
87
+ * for the operation, and try again.</p>
88
+ */
89
+ export declare class ValidationException extends __BaseException {
90
+ readonly name: "ValidationException";
91
+ readonly $fault: "client";
92
+ Message: string | undefined;
93
+ /**
94
+ * <p>An array of the request fields that had validation errors.</p>
95
+ */
96
+ FieldList?: ValidationExceptionField[];
97
+ /**
98
+ * @internal
99
+ */
100
+ constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
101
+ }
102
+ export interface BatchGetViewInput {
103
+ /**
104
+ * <p>A list of <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon resource names (ARNs)</a> that identify the views you want details for.</p>
105
+ */
106
+ ViewArns?: string[];
107
+ }
108
+ /**
109
+ * <p>A collection of error messages for any views that Amazon Web Services Resource Explorer couldn't retrieve
110
+ * details.</p>
111
+ */
112
+ export interface BatchGetViewError {
113
+ /**
114
+ * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon resource name (ARN)</a> of the view for which Resource Explorer failed to retrieve details.</p>
115
+ */
116
+ ViewArn: string | undefined;
117
+ /**
118
+ * <p>The description of the error for the specified view.</p>
119
+ */
120
+ ErrorMessage: string | undefined;
121
+ }
122
+ /**
123
+ * <p>A search filter defines which resources can be part of a search query result
124
+ * set.</p>
125
+ */
126
+ export interface SearchFilter {
127
+ /**
128
+ * <p>The string that contains the search keywords, prefixes, and operators to control the
129
+ * results that can be returned by a <a>Search</a> operation. For more details,
130
+ * see <a href="https://docs.aws.amazon.com/resource-explorer/latest/APIReference/about-query-syntax.html">Search
131
+ * query syntax</a>.</p>
132
+ */
133
+ FilterString: string | undefined;
134
+ }
135
+ /**
136
+ * <p>Information about an additional property that describes a resource, that you can
137
+ * optionally include in the view. This lets you view that property in search results, and
138
+ * filter your search results based on the value of the property.</p>
139
+ */
140
+ export interface IncludedProperty {
141
+ /**
142
+ * <p>The name of the property that is included in this view.</p>
143
+ * <p>You can specify the following property names for this field:</p>
144
+ * <ul>
145
+ * <li>
146
+ * <p>
147
+ * <code>Tags</code>
148
+ * </p>
149
+ * </li>
150
+ * </ul>
151
+ */
152
+ Name: string | undefined;
153
+ }
154
+ /**
155
+ * <p>A view is a structure that defines a set of filters that provide a view into the
156
+ * information in the Amazon Web Services Resource Explorer index. The filters specify which information from the
157
+ * index is visible to the users of the view. For example, you can specify filters that
158
+ * include only resources that are tagged with the key "ENV" and the value "DEVELOPMENT" in
159
+ * the results returned by this view. You could also create a second view that includes
160
+ * only resources that are tagged with "ENV" and "PRODUCTION".</p>
161
+ */
162
+ export interface View {
163
+ /**
164
+ * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon resource name (ARN)</a> of the view.</p>
165
+ */
166
+ ViewArn?: string;
167
+ /**
168
+ * <p>The Amazon Web Services account that owns this view.</p>
169
+ */
170
+ Owner?: string;
171
+ /**
172
+ * <p>The date and time when this view was last modified.</p>
173
+ */
174
+ LastUpdatedAt?: Date;
175
+ /**
176
+ * <p>An <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon resource name (ARN)</a> of an Amazon Web Services account, an organization, or an
177
+ * organizational unit (OU) that specifies whether this view includes resources from only
178
+ * the specified Amazon Web Services account, all accounts in the specified organization, or all accounts in
179
+ * the specified OU.</p>
180
+ * <p>If not specified, the value defaults to the Amazon Web Services account used to call this
181
+ * operation.</p>
182
+ */
183
+ Scope?: string;
184
+ /**
185
+ * <p>A structure that contains additional information about the view.</p>
186
+ */
187
+ IncludedProperties?: IncludedProperty[];
188
+ /**
189
+ * <p>An array of <a>SearchFilter</a> objects that specify which resources can be
190
+ * included in the results of queries made using this view.</p>
191
+ */
192
+ Filters?: SearchFilter;
193
+ }
194
+ export interface BatchGetViewOutput {
195
+ /**
196
+ * <p>A structure with a list of objects with details for each of the specified
197
+ * views.</p>
198
+ */
199
+ Views?: View[];
200
+ /**
201
+ * <p>If any of the specified ARNs result in an error, then this structure describes the
202
+ * error.</p>
203
+ */
204
+ Errors?: BatchGetViewError[];
205
+ }
206
+ /**
207
+ * <p>The principal making the request isn't permitted to perform the operation.</p>
208
+ */
209
+ export declare class UnauthorizedException extends __BaseException {
210
+ readonly name: "UnauthorizedException";
211
+ readonly $fault: "client";
212
+ Message?: string;
213
+ /**
214
+ * @internal
215
+ */
216
+ constructor(opts: __ExceptionOptionType<UnauthorizedException, __BaseException>);
217
+ }
218
+ /**
219
+ * <p>You tried to create a new view or index when one already exists, and you either didn't
220
+ * specify or specified a different idempotency token as the original request.</p>
221
+ */
222
+ export declare class ConflictException extends __BaseException {
223
+ readonly name: "ConflictException";
224
+ readonly $fault: "client";
225
+ Message: string | undefined;
226
+ /**
227
+ * @internal
228
+ */
229
+ constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
230
+ }
231
+ export interface CreateIndexInput {
232
+ /**
233
+ * <p>This value helps ensure idempotency. Resource Explorer uses this value to prevent the
234
+ * accidental creation of duplicate versions. We recommend that you generate a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID-type
235
+ * value</a> to ensure the uniqueness of your views.</p>
236
+ */
237
+ ClientToken?: string;
238
+ /**
239
+ * <p>The specified tags are attached only to the index created in this Amazon Web Services Region. The
240
+ * tags aren't attached to any of the resources listed in the index.</p>
241
+ */
242
+ Tags?: Record<string, string>;
243
+ }
244
+ export declare enum IndexState {
245
+ /**
246
+ * Index is active.
247
+ */
248
+ ACTIVE = "ACTIVE",
249
+ /**
250
+ * Resource Explorer is creating the index.
251
+ */
252
+ CREATING = "CREATING",
253
+ /**
254
+ * Resource Explorer successfully deleted the index.
255
+ */
256
+ DELETED = "DELETED",
257
+ /**
258
+ * Resource Explorer is deleting the index.
259
+ */
260
+ DELETING = "DELETING",
261
+ /**
262
+ * Resource Explorer is switching the index type between local and aggregator.
263
+ */
264
+ UPDATING = "UPDATING"
265
+ }
266
+ export interface CreateIndexOutput {
267
+ /**
268
+ * <p>The ARN of the new local index for the Region. You can reference this ARN in IAM
269
+ * permission policies to authorize the following operations: <a>DeleteIndex</a>
270
+ * | <a>GetIndex</a> | <a>UpdateIndexType</a> | <a>CreateView</a>
271
+ * </p>
272
+ */
273
+ Arn?: string;
274
+ /**
275
+ * <p>Indicates the current state of the index. You can check for changes to the state for
276
+ * asynchronous operations by calling the <a>GetIndex</a> operation.</p>
277
+ * <note>
278
+ * <p>The state can remain in the <code>CREATING</code> or <code>UPDATING</code> state
279
+ * for several hours as Resource Explorer discovers the information about your resources and
280
+ * populates the index.</p>
281
+ * </note>
282
+ */
283
+ State?: IndexState | string;
284
+ /**
285
+ * <p>The date and timestamp when the index was created.</p>
286
+ */
287
+ CreatedAt?: Date;
288
+ }
289
+ export interface DeleteIndexInput {
290
+ /**
291
+ * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon resource name (ARN)</a> of the index that you want to delete.</p>
292
+ */
293
+ Arn: string | undefined;
294
+ }
295
+ export interface DeleteIndexOutput {
296
+ /**
297
+ * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon resource name (ARN)</a> of the index that you successfully started the deletion
298
+ * process.</p>
299
+ * <note>
300
+ * <p>This operation is asynchronous. To check its status, call the <a>GetIndex</a> operation.</p>
301
+ * </note>
302
+ */
303
+ Arn?: string;
304
+ /**
305
+ * <p>Indicates the current state of the index. </p>
306
+ */
307
+ State?: IndexState | string;
308
+ /**
309
+ * <p>The date and time when you last updated this index.</p>
310
+ */
311
+ LastUpdatedAt?: Date;
312
+ }
313
+ export declare enum IndexType {
314
+ /**
315
+ * aggregator index
316
+ */
317
+ AGGREGATOR = "AGGREGATOR",
318
+ /**
319
+ * local index
320
+ */
321
+ LOCAL = "LOCAL"
322
+ }
323
+ export interface ListIndexesInput {
324
+ /**
325
+ * <p>If specified, limits the output to only indexes of the specified Type, either
326
+ * <code>LOCAL</code> or <code>AGGREGATOR</code>.</p>
327
+ * <p>Use this option to discover the aggregator index for your account.</p>
328
+ */
329
+ Type?: IndexType | string;
330
+ /**
331
+ * <p>If specified, limits the response to only information about the index in the specified
332
+ * list of Amazon Web Services Regions.</p>
333
+ */
334
+ Regions?: string[];
335
+ /**
336
+ * <p>The maximum number of results that you want included on each page of the
337
+ * response. If you do not include this parameter, it defaults to a value appropriate to the
338
+ * operation. If additional items exist beyond those included in the current response, the
339
+ * <code>NextToken</code> response element is present and has a value (is not null). Include that
340
+ * value as the <code>NextToken</code> request parameter in the next call to the operation to get
341
+ * the next part of the results.</p>
342
+ * <note>
343
+ * <p>An API operation can return fewer results than the maximum even when there are
344
+ * more results available. You should check <code>NextToken</code> after every operation to ensure
345
+ * that you receive all of the results.</p>
346
+ * </note>
347
+ */
348
+ MaxResults?: number;
349
+ /**
350
+ * <p>The parameter for receiving additional results if you receive a
351
+ * <code>NextToken</code> response in a previous request. A <code>NextToken</code> response
352
+ * indicates that more output is available. Set this parameter to the value of the previous
353
+ * call's <code>NextToken</code> response to indicate where the output should continue
354
+ * from.</p>
355
+ */
356
+ NextToken?: string;
357
+ }
358
+ /**
359
+ * <p>An index is the data store used by Amazon Web Services Resource Explorer to hold information about your Amazon Web Services
360
+ * resources that the service discovers. Creating an index in an Amazon Web Services Region turns on
361
+ * Resource Explorer and lets it discover your resources.</p>
362
+ * <p>By default, an index is <i>local</i>, meaning that it contains
363
+ * information about resources in only the same Region as the index. However, you can
364
+ * promote the index of one Region in the account by calling <a>UpdateIndexType</a> to convert it into an aggregator index. The aggregator index
365
+ * receives a replicated copy of the index information from all other Regions where Resource Explorer
366
+ * is turned on. This allows search operations in that Region to return results from all
367
+ * Regions in the account.</p>
368
+ */
369
+ export interface Index {
370
+ /**
371
+ * <p>The Amazon Web Services Region in which the index exists.</p>
372
+ */
373
+ Region?: string;
374
+ /**
375
+ * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon resource name (ARN)</a> of the index.</p>
376
+ */
377
+ Arn?: string;
378
+ /**
379
+ * <p>The type of index. It can be one of the following
380
+ * values:</p>
381
+ * <ul>
382
+ * <li>
383
+ * <p>
384
+ * <b>LOCAL</b> – The index contains information
385
+ * about resources from only the same Amazon Web Services Region.</p>
386
+ * </li>
387
+ * <li>
388
+ * <p>
389
+ * <b>AGGREGATOR</b> – Resource Explorer replicates copies
390
+ * of the indexed information about resources in all other Amazon Web Services Regions to the
391
+ * aggregator index. This lets search results in the Region with the aggregator index to
392
+ * include resources from all Regions in the account where Resource Explorer is turned
393
+ * on.</p>
394
+ * </li>
395
+ * </ul>
396
+ */
397
+ Type?: IndexType | string;
398
+ }
399
+ export interface ListIndexesOutput {
400
+ /**
401
+ * <p>A structure that contains the details and status of each index.</p>
402
+ */
403
+ Indexes?: Index[];
404
+ /**
405
+ * <p>If present, indicates that more output is available than is
406
+ * included in the current response. Use this value in the <code>NextToken</code> request parameter
407
+ * in a subsequent call to the operation to get the next part of the output. You should repeat this
408
+ * until the <code>NextToken</code> response element comes back as <code>null</code>.</p>
409
+ */
410
+ NextToken?: string;
411
+ }
412
+ /**
413
+ * <p>The request failed because it exceeds a service quota.</p>
414
+ */
415
+ export declare class ServiceQuotaExceededException extends __BaseException {
416
+ readonly name: "ServiceQuotaExceededException";
417
+ readonly $fault: "client";
418
+ Message: string | undefined;
419
+ /**
420
+ * <p>The name of the service quota that was exceeded by the request.</p>
421
+ */
422
+ Name: string | undefined;
423
+ /**
424
+ * <p>The current value for the quota that the request tried to exceed.</p>
425
+ */
426
+ Value: string | undefined;
427
+ /**
428
+ * @internal
429
+ */
430
+ constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
431
+ }
432
+ export interface UpdateIndexTypeInput {
433
+ /**
434
+ * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon resource name (ARN)</a> of the index that you want to update.</p>
435
+ */
436
+ Arn: string | undefined;
437
+ /**
438
+ * <p>The type of the index. To understand the difference between <code>LOCAL</code> and
439
+ * <code>AGGREGATOR</code>, see <a href="https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-aggregator-region.html">Turning on cross-Region
440
+ * search</a> in the <i>Amazon Web Services Resource Explorer User Guide</i>.</p>
441
+ */
442
+ Type: IndexType | string | undefined;
443
+ }
444
+ export interface UpdateIndexTypeOutput {
445
+ /**
446
+ * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon resource name (ARN)</a> of the index that you updated.</p>
447
+ */
448
+ Arn?: string;
449
+ /**
450
+ * <p>Specifies the type of the specified index after the operation completes.</p>
451
+ */
452
+ Type?: IndexType | string;
453
+ /**
454
+ * <p>Indicates the state of the request to update the index. This operation is
455
+ * asynchronous. Call the <a>GetIndex</a> operation to check for changes.</p>
456
+ */
457
+ State?: IndexState | string;
458
+ /**
459
+ * <p>The date and timestamp when the index was last updated.</p>
460
+ */
461
+ LastUpdatedAt?: Date;
462
+ }
463
+ export interface CreateViewInput {
464
+ /**
465
+ * <p>This value helps ensure idempotency. Resource Explorer uses this value to prevent the
466
+ * accidental creation of duplicate versions. We recommend that you generate a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID-type
467
+ * value</a> to ensure the uniqueness of your views.</p>
468
+ */
469
+ ClientToken?: string;
470
+ /**
471
+ * <p>The name of the new view. This name appears in the list of views in Resource Explorer.</p>
472
+ * <p>The name must be no more than 64 characters long, and can include letters, digits, and
473
+ * the dash (-) character. The name must be unique within its Amazon Web Services Region.</p>
474
+ */
475
+ ViewName: string | undefined;
476
+ /**
477
+ * <p>Specifies optional fields that you want included in search results from this
478
+ * view. It is a list of objects that each describe a field to include.</p>
479
+ * <p>The default is an empty list, with no optional fields included in the results.</p>
480
+ */
481
+ IncludedProperties?: IncludedProperty[];
482
+ /**
483
+ * <p>An array of strings that specify which resources are included in the results of
484
+ * queries made using this view. When you use this view in a <a>Search</a>
485
+ * operation, the filter string is combined with the search's <code>QueryString</code>
486
+ * parameter using a logical <code>AND</code> operator.</p>
487
+ * <p>For information about the supported syntax, see <a href="https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html">Search query reference for
488
+ * Resource Explorer</a> in the <i>Amazon Web Services Resource Explorer User Guide</i>.</p>
489
+ * <important>
490
+ * <p>This query string in the context of this operation supports only <a href="https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html#query-syntax-filters">filter
491
+ * prefixes</a> with optional <a href="https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html#query-syntax-operators">operators</a>. It doesn't support free-form text. For example, the
492
+ * string <code>region:us* service:ec2 -tag:stage=prod</code> includes all Amazon EC2
493
+ * resources in any Amazon Web Services Region that begins with the letters <code>us</code> and is
494
+ * <i>not</i> tagged with a key <code>Stage</code> that has the value
495
+ * <code>prod</code>.</p>
496
+ * </important>
497
+ */
498
+ Filters?: SearchFilter;
499
+ /**
500
+ * <p>Tag key and value pairs that are attached to the view.</p>
501
+ */
502
+ Tags?: Record<string, string>;
503
+ }
504
+ export interface CreateViewOutput {
505
+ /**
506
+ * <p>A structure that contains the details about the new view.</p>
507
+ */
508
+ View?: View;
509
+ }
510
+ export interface DeleteViewInput {
511
+ /**
512
+ * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon resource name (ARN)</a> of the view that you want to delete.</p>
513
+ */
514
+ ViewArn: string | undefined;
515
+ }
516
+ export interface DeleteViewOutput {
517
+ /**
518
+ * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon resource name (ARN)</a> of the view that you successfully deleted.</p>
519
+ */
520
+ ViewArn?: string;
521
+ }
522
+ export interface GetViewInput {
523
+ /**
524
+ * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon resource name (ARN)</a> of the view that you want information about.</p>
525
+ */
526
+ ViewArn: string | undefined;
527
+ }
528
+ export interface GetViewOutput {
529
+ /**
530
+ * <p>A structure that contains the details for the requested view.</p>
531
+ */
532
+ View?: View;
533
+ /**
534
+ * <p>Tag key and value pairs that are attached to the view.</p>
535
+ */
536
+ Tags?: Record<string, string>;
537
+ }
538
+ export interface ListViewsInput {
539
+ /**
540
+ * <p>The parameter for receiving additional results if you receive a
541
+ * <code>NextToken</code> response in a previous request. A <code>NextToken</code> response
542
+ * indicates that more output is available. Set this parameter to the value of the previous
543
+ * call's <code>NextToken</code> response to indicate where the output should continue
544
+ * from.</p>
545
+ */
546
+ NextToken?: string;
547
+ /**
548
+ * <p>The maximum number of results that you want included on each page of the
549
+ * response. If you do not include this parameter, it defaults to a value appropriate to the
550
+ * operation. If additional items exist beyond those included in the current response, the
551
+ * <code>NextToken</code> response element is present and has a value (is not null). Include that
552
+ * value as the <code>NextToken</code> request parameter in the next call to the operation to get
553
+ * the next part of the results.</p>
554
+ * <note>
555
+ * <p>An API operation can return fewer results than the maximum even when there are
556
+ * more results available. You should check <code>NextToken</code> after every operation to ensure
557
+ * that you receive all of the results.</p>
558
+ * </note>
559
+ */
560
+ MaxResults?: number;
561
+ }
562
+ export interface ListViewsOutput {
563
+ /**
564
+ * <p>The list of views available in the Amazon Web Services Region in which you called this
565
+ * operation.</p>
566
+ */
567
+ Views?: string[];
568
+ /**
569
+ * <p>If present, indicates that more output is available than is
570
+ * included in the current response. Use this value in the <code>NextToken</code> request parameter
571
+ * in a subsequent call to the operation to get the next part of the output. You should repeat this
572
+ * until the <code>NextToken</code> response element comes back as <code>null</code>.</p>
573
+ */
574
+ NextToken?: string;
575
+ }
576
+ export interface UpdateViewInput {
577
+ /**
578
+ * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon resource name (ARN)</a> of the view that you want to modify.</p>
579
+ */
580
+ ViewArn: string | undefined;
581
+ /**
582
+ * <p>Specifies optional fields that you want included in search results from this
583
+ * view. It is a list of objects that each describe a field to include.</p>
584
+ * <p>The default is an empty list, with no optional fields included in the results.</p>
585
+ */
586
+ IncludedProperties?: IncludedProperty[];
587
+ /**
588
+ * <p>An array of strings that specify which resources are included in the results of
589
+ * queries made using this view. When you use this view in a <a>Search</a>
590
+ * operation, the filter string is combined with the search's <code>QueryString</code>
591
+ * parameter using a logical <code>AND</code> operator.</p>
592
+ * <p>For information about the supported syntax, see <a href="https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html">Search query reference for
593
+ * Resource Explorer</a> in the <i>Amazon Web Services Resource Explorer User Guide</i>.</p>
594
+ * <important>
595
+ * <p>This query string in the context of this operation supports only <a href="https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html#query-syntax-filters">filter
596
+ * prefixes</a> with optional <a href="https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html#query-syntax-operators">operators</a>. It doesn't support free-form text. For example, the
597
+ * string <code>region:us* service:ec2 -tag:stage=prod</code> includes all Amazon EC2
598
+ * resources in any Amazon Web Services Region that begins with the letters <code>us</code> and is
599
+ * <i>not</i> tagged with a key <code>Stage</code> that has the value
600
+ * <code>prod</code>.</p>
601
+ * </important>
602
+ */
603
+ Filters?: SearchFilter;
604
+ }
605
+ export interface UpdateViewOutput {
606
+ /**
607
+ * <p>Details about the view that you changed with this operation.</p>
608
+ */
609
+ View?: View;
610
+ }
611
+ export interface GetDefaultViewOutput {
612
+ /**
613
+ * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon resource name (ARN)</a> of the view that is the current default for the Amazon Web Services Region in
614
+ * which you called this operation.</p>
615
+ */
616
+ ViewArn?: string;
617
+ }
618
+ export interface GetIndexOutput {
619
+ /**
620
+ * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon resource name (ARN)</a> of the index.</p>
621
+ */
622
+ Arn?: string;
623
+ /**
624
+ * <p>Specifies the type of the index in this Region. For information about the aggregator
625
+ * index and how it differs from a local index, see <a href="https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-aggregator-region.html">Turning on cross-Region search
626
+ * by creating an aggregator index</a>.</p>
627
+ */
628
+ Type?: IndexType | string;
629
+ /**
630
+ * <p>Indicates the current state of the index in this Amazon Web Services Region.</p>
631
+ */
632
+ State?: IndexState | string;
633
+ /**
634
+ * <p>If this index is <code>Type=AGGREGATOR</code>, then this response value contains a
635
+ * list of the Amazon Web Services Regions that replicate their content to the index in this Region. Not
636
+ * present for a local index.</p>
637
+ */
638
+ ReplicatingFrom?: string[];
639
+ /**
640
+ * <p>Identifies the Amazon Web Services Region that has an index set to <code>Type=AGGREGATOR</code>, if
641
+ * one exists. If it does, then the Region you called this operation in replicates its
642
+ * index information to the Region specified in this response value. Not present if there
643
+ * isn't an aggregator index in the account.</p>
644
+ */
645
+ ReplicatingTo?: string[];
646
+ /**
647
+ * <p>The date and time when the index was originally created.</p>
648
+ */
649
+ CreatedAt?: Date;
650
+ /**
651
+ * <p>The date and time when the index was last updated.</p>
652
+ */
653
+ LastUpdatedAt?: Date;
654
+ /**
655
+ * <p>Tag key and value pairs that are attached to the index.</p>
656
+ */
657
+ Tags?: Record<string, string>;
658
+ }
659
+ export interface ListSupportedResourceTypesInput {
660
+ /**
661
+ * <p>The parameter for receiving additional results if you receive a
662
+ * <code>NextToken</code> response in a previous request. A <code>NextToken</code> response
663
+ * indicates that more output is available. Set this parameter to the value of the previous
664
+ * call's <code>NextToken</code> response to indicate where the output should continue
665
+ * from.</p>
666
+ */
667
+ NextToken?: string;
668
+ /**
669
+ * <p>The maximum number of results that you want included on each page of the
670
+ * response. If you do not include this parameter, it defaults to a value appropriate to the
671
+ * operation. If additional items exist beyond those included in the current response, the
672
+ * <code>NextToken</code> response element is present and has a value (is not null). Include that
673
+ * value as the <code>NextToken</code> request parameter in the next call to the operation to get
674
+ * the next part of the results.</p>
675
+ * <note>
676
+ * <p>An API operation can return fewer results than the maximum even when there are
677
+ * more results available. You should check <code>NextToken</code> after every operation to ensure
678
+ * that you receive all of the results.</p>
679
+ * </note>
680
+ */
681
+ MaxResults?: number;
682
+ }
683
+ /**
684
+ * <p>A structure that describes a resource type supported by Amazon Web Services Resource Explorer.</p>
685
+ */
686
+ export interface SupportedResourceType {
687
+ /**
688
+ * <p>The Amazon Web Service that is associated with the resource type. This is the primary
689
+ * service that lets you create and interact with resources of this type.</p>
690
+ */
691
+ Service?: string;
692
+ /**
693
+ * <p>The unique identifier of the resource type.</p>
694
+ */
695
+ ResourceType?: string;
696
+ }
697
+ export interface ListSupportedResourceTypesOutput {
698
+ /**
699
+ * <p>The list of resource types supported by Resource Explorer.</p>
700
+ */
701
+ ResourceTypes?: SupportedResourceType[];
702
+ /**
703
+ * <p>If present, indicates that more output is available than is
704
+ * included in the current response. Use this value in the <code>NextToken</code> request parameter
705
+ * in a subsequent call to the operation to get the next part of the output. You should repeat this
706
+ * until the <code>NextToken</code> response element comes back as <code>null</code>.</p>
707
+ */
708
+ NextToken?: string;
709
+ }
710
+ export interface ListTagsForResourceInput {
711
+ /**
712
+ * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon resource name (ARN)</a> of the view or index that you want to attach tags to.</p>
713
+ */
714
+ resourceArn: string | undefined;
715
+ }
716
+ export interface ListTagsForResourceOutput {
717
+ /**
718
+ * <p>The tag key and value pairs that you want to attach to the specified view or
719
+ * index.</p>
720
+ */
721
+ Tags?: Record<string, string>;
722
+ }
723
+ /**
724
+ * <p>A structure that describes a property of a resource.</p>
725
+ */
726
+ export interface ResourceProperty {
727
+ /**
728
+ * <p>The name of this property of the resource.</p>
729
+ */
730
+ Name?: string;
731
+ /**
732
+ * <p>The date and time that the information about this resource property was last
733
+ * updated.</p>
734
+ */
735
+ LastReportedAt?: Date;
736
+ /**
737
+ * <p>Details about this property. The content of this field is a JSON object that varies
738
+ * based on the resource type.</p>
739
+ */
740
+ Data?: __DocumentType;
741
+ }
742
+ /**
743
+ * <p>A resource in Amazon Web Services that Amazon Web Services Resource Explorer has discovered, and for which it has stored
744
+ * information in the index of the Amazon Web Services Region that contains the resource.</p>
745
+ */
746
+ export interface Resource {
747
+ /**
748
+ * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon resource name (ARN)</a> of the resource.</p>
749
+ */
750
+ Arn?: string;
751
+ /**
752
+ * <p>The Amazon Web Services account that owns the resource.</p>
753
+ */
754
+ OwningAccountId?: string;
755
+ /**
756
+ * <p>The Amazon Web Services Region in which the resource was created and exists.</p>
757
+ */
758
+ Region?: string;
759
+ /**
760
+ * <p>The type of the resource.</p>
761
+ */
762
+ ResourceType?: string;
763
+ /**
764
+ * <p>The Amazon Web Service that owns the resource and is responsible for creating and updating
765
+ * it.</p>
766
+ */
767
+ Service?: string;
768
+ /**
769
+ * <p>The date and time that Resource Explorer last queried this resource and updated the index with
770
+ * the latest information about the resource.</p>
771
+ */
772
+ LastReportedAt?: Date;
773
+ /**
774
+ * <p>A structure with additional type-specific details about the resource. These properties
775
+ * can be added by turning on integration between Resource Explorer and other Amazon Web Services services.</p>
776
+ */
777
+ Properties?: ResourceProperty[];
778
+ }
779
+ /**
780
+ * <p>Information about the number of results that match the query. At this time, Amazon Web Services Resource Explorer
781
+ * doesn't count more than 1,000 matches for any query. This structure
782
+ * provides information about whether the query exceeded this limit.</p>
783
+ * <p>This field is included in every page when you paginate the results.</p>
784
+ */
785
+ export interface ResourceCount {
786
+ /**
787
+ * <p>The number of resources that match the search query. This value can't exceed
788
+ * 1,000. If there are more than 1,000 resources that match
789
+ * the query, then only 1,000 are counted and the <code>Complete</code>
790
+ * field is set to false. We recommend that you refine your query to return a smaller
791
+ * number of results.</p>
792
+ */
793
+ TotalResources?: number;
794
+ /**
795
+ * <p>Indicates whether the <code>TotalResources</code> value represents an exhaustive count
796
+ * of search results.</p>
797
+ * <ul>
798
+ * <li>
799
+ * <p>If <code>True</code>, it indicates that the search was exhaustive. Every
800
+ * resource that matches the query was counted.</p>
801
+ * </li>
802
+ * <li>
803
+ * <p>If <code>False</code>, then the search reached the limit of
804
+ * 1,000 matching results, and stopped counting.</p>
805
+ * </li>
806
+ * </ul>
807
+ */
808
+ Complete?: boolean;
809
+ }
810
+ export interface SearchInput {
811
+ /**
812
+ * <p>A string that includes keywords and filters that specify the resources that you want
813
+ * to include in the results.</p>
814
+ * <p>For the complete syntax supported by the <code>QueryString</code> parameter, see
815
+ * <a href="https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html">Search query syntax reference for Resource Explorer</a>.</p>
816
+ * <p>The search is completely case insensitive. You can specify an empty string to return
817
+ * all results up to the limit of 1,000 total results.</p>
818
+ * <note>
819
+ * <p>The operation can return only the first 1,000 results. If the
820
+ * resource you want is not included, then use a different value for
821
+ * <code>QueryString</code> to refine the results.</p>
822
+ * </note>
823
+ */
824
+ QueryString: string | undefined;
825
+ /**
826
+ * <p>The maximum number of results that you want included on each page of the
827
+ * response. If you do not include this parameter, it defaults to a value appropriate to the
828
+ * operation. If additional items exist beyond those included in the current response, the
829
+ * <code>NextToken</code> response element is present and has a value (is not null). Include that
830
+ * value as the <code>NextToken</code> request parameter in the next call to the operation to get
831
+ * the next part of the results.</p>
832
+ * <note>
833
+ * <p>An API operation can return fewer results than the maximum even when there are
834
+ * more results available. You should check <code>NextToken</code> after every operation to ensure
835
+ * that you receive all of the results.</p>
836
+ * </note>
837
+ */
838
+ MaxResults?: number;
839
+ /**
840
+ * <p>Specifies the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon resource name (ARN)</a> of the view to use for the query. If you don't specify a
841
+ * value for this parameter, then the operation automatically uses the default view for the
842
+ * Amazon Web Services Region in which you called this operation. If the Region either doesn't have a
843
+ * default view or if you don't have permission to use the default view, then the operation
844
+ * fails with a <code>401 Unauthorized</code> exception.</p>
845
+ */
846
+ ViewArn?: string;
847
+ /**
848
+ * <p>The parameter for receiving additional results if you receive a
849
+ * <code>NextToken</code> response in a previous request. A <code>NextToken</code> response
850
+ * indicates that more output is available. Set this parameter to the value of the previous
851
+ * call's <code>NextToken</code> response to indicate where the output should continue
852
+ * from.</p>
853
+ */
854
+ NextToken?: string;
855
+ }
856
+ export interface SearchOutput {
857
+ /**
858
+ * <p>The list of structures that describe the resources that match the query.</p>
859
+ */
860
+ Resources?: Resource[];
861
+ /**
862
+ * <p>If present, indicates that more output is available than is
863
+ * included in the current response. Use this value in the <code>NextToken</code> request parameter
864
+ * in a subsequent call to the operation to get the next part of the output. You should repeat this
865
+ * until the <code>NextToken</code> response element comes back as <code>null</code>.</p>
866
+ */
867
+ NextToken?: string;
868
+ /**
869
+ * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon resource name (ARN)</a> of the view that this operation used to perform the search.</p>
870
+ */
871
+ ViewArn?: string;
872
+ /**
873
+ * <p>The number of resources that match the query.</p>
874
+ */
875
+ Count?: ResourceCount;
876
+ }
877
+ export interface TagResourceInput {
878
+ /**
879
+ * <p>The Amazon Resource Name (ARN) of the view or index that you want to attach tags
880
+ * to.</p>
881
+ */
882
+ resourceArn: string | undefined;
883
+ /**
884
+ * <p>A list of tag key and value pairs that you want to attach to the specified view or
885
+ * index.</p>
886
+ */
887
+ Tags?: Record<string, string>;
888
+ }
889
+ export interface TagResourceOutput {
890
+ }
891
+ export interface UntagResourceInput {
892
+ /**
893
+ * <p>The Amazon Resource Name (ARN) of the view or index that you want to remove tags
894
+ * from.</p>
895
+ */
896
+ resourceArn: string | undefined;
897
+ /**
898
+ * <p>A list of the keys for the tags that you want to remove from the specified view or
899
+ * index.</p>
900
+ */
901
+ tagKeys: string[] | undefined;
902
+ }
903
+ export interface UntagResourceOutput {
904
+ }
905
+ /**
906
+ * @internal
907
+ */
908
+ export declare const AssociateDefaultViewInputFilterSensitiveLog: (obj: AssociateDefaultViewInput) => any;
909
+ /**
910
+ * @internal
911
+ */
912
+ export declare const AssociateDefaultViewOutputFilterSensitiveLog: (obj: AssociateDefaultViewOutput) => any;
913
+ /**
914
+ * @internal
915
+ */
916
+ export declare const ValidationExceptionFieldFilterSensitiveLog: (obj: ValidationExceptionField) => any;
917
+ /**
918
+ * @internal
919
+ */
920
+ export declare const BatchGetViewInputFilterSensitiveLog: (obj: BatchGetViewInput) => any;
921
+ /**
922
+ * @internal
923
+ */
924
+ export declare const BatchGetViewErrorFilterSensitiveLog: (obj: BatchGetViewError) => any;
925
+ /**
926
+ * @internal
927
+ */
928
+ export declare const SearchFilterFilterSensitiveLog: (obj: SearchFilter) => any;
929
+ /**
930
+ * @internal
931
+ */
932
+ export declare const IncludedPropertyFilterSensitiveLog: (obj: IncludedProperty) => any;
933
+ /**
934
+ * @internal
935
+ */
936
+ export declare const ViewFilterSensitiveLog: (obj: View) => any;
937
+ /**
938
+ * @internal
939
+ */
940
+ export declare const BatchGetViewOutputFilterSensitiveLog: (obj: BatchGetViewOutput) => any;
941
+ /**
942
+ * @internal
943
+ */
944
+ export declare const CreateIndexInputFilterSensitiveLog: (obj: CreateIndexInput) => any;
945
+ /**
946
+ * @internal
947
+ */
948
+ export declare const CreateIndexOutputFilterSensitiveLog: (obj: CreateIndexOutput) => any;
949
+ /**
950
+ * @internal
951
+ */
952
+ export declare const DeleteIndexInputFilterSensitiveLog: (obj: DeleteIndexInput) => any;
953
+ /**
954
+ * @internal
955
+ */
956
+ export declare const DeleteIndexOutputFilterSensitiveLog: (obj: DeleteIndexOutput) => any;
957
+ /**
958
+ * @internal
959
+ */
960
+ export declare const ListIndexesInputFilterSensitiveLog: (obj: ListIndexesInput) => any;
961
+ /**
962
+ * @internal
963
+ */
964
+ export declare const IndexFilterSensitiveLog: (obj: Index) => any;
965
+ /**
966
+ * @internal
967
+ */
968
+ export declare const ListIndexesOutputFilterSensitiveLog: (obj: ListIndexesOutput) => any;
969
+ /**
970
+ * @internal
971
+ */
972
+ export declare const UpdateIndexTypeInputFilterSensitiveLog: (obj: UpdateIndexTypeInput) => any;
973
+ /**
974
+ * @internal
975
+ */
976
+ export declare const UpdateIndexTypeOutputFilterSensitiveLog: (obj: UpdateIndexTypeOutput) => any;
977
+ /**
978
+ * @internal
979
+ */
980
+ export declare const CreateViewInputFilterSensitiveLog: (obj: CreateViewInput) => any;
981
+ /**
982
+ * @internal
983
+ */
984
+ export declare const CreateViewOutputFilterSensitiveLog: (obj: CreateViewOutput) => any;
985
+ /**
986
+ * @internal
987
+ */
988
+ export declare const DeleteViewInputFilterSensitiveLog: (obj: DeleteViewInput) => any;
989
+ /**
990
+ * @internal
991
+ */
992
+ export declare const DeleteViewOutputFilterSensitiveLog: (obj: DeleteViewOutput) => any;
993
+ /**
994
+ * @internal
995
+ */
996
+ export declare const GetViewInputFilterSensitiveLog: (obj: GetViewInput) => any;
997
+ /**
998
+ * @internal
999
+ */
1000
+ export declare const GetViewOutputFilterSensitiveLog: (obj: GetViewOutput) => any;
1001
+ /**
1002
+ * @internal
1003
+ */
1004
+ export declare const ListViewsInputFilterSensitiveLog: (obj: ListViewsInput) => any;
1005
+ /**
1006
+ * @internal
1007
+ */
1008
+ export declare const ListViewsOutputFilterSensitiveLog: (obj: ListViewsOutput) => any;
1009
+ /**
1010
+ * @internal
1011
+ */
1012
+ export declare const UpdateViewInputFilterSensitiveLog: (obj: UpdateViewInput) => any;
1013
+ /**
1014
+ * @internal
1015
+ */
1016
+ export declare const UpdateViewOutputFilterSensitiveLog: (obj: UpdateViewOutput) => any;
1017
+ /**
1018
+ * @internal
1019
+ */
1020
+ export declare const GetDefaultViewOutputFilterSensitiveLog: (obj: GetDefaultViewOutput) => any;
1021
+ /**
1022
+ * @internal
1023
+ */
1024
+ export declare const GetIndexOutputFilterSensitiveLog: (obj: GetIndexOutput) => any;
1025
+ /**
1026
+ * @internal
1027
+ */
1028
+ export declare const ListSupportedResourceTypesInputFilterSensitiveLog: (obj: ListSupportedResourceTypesInput) => any;
1029
+ /**
1030
+ * @internal
1031
+ */
1032
+ export declare const SupportedResourceTypeFilterSensitiveLog: (obj: SupportedResourceType) => any;
1033
+ /**
1034
+ * @internal
1035
+ */
1036
+ export declare const ListSupportedResourceTypesOutputFilterSensitiveLog: (obj: ListSupportedResourceTypesOutput) => any;
1037
+ /**
1038
+ * @internal
1039
+ */
1040
+ export declare const ListTagsForResourceInputFilterSensitiveLog: (obj: ListTagsForResourceInput) => any;
1041
+ /**
1042
+ * @internal
1043
+ */
1044
+ export declare const ListTagsForResourceOutputFilterSensitiveLog: (obj: ListTagsForResourceOutput) => any;
1045
+ /**
1046
+ * @internal
1047
+ */
1048
+ export declare const ResourcePropertyFilterSensitiveLog: (obj: ResourceProperty) => any;
1049
+ /**
1050
+ * @internal
1051
+ */
1052
+ export declare const ResourceFilterSensitiveLog: (obj: Resource) => any;
1053
+ /**
1054
+ * @internal
1055
+ */
1056
+ export declare const ResourceCountFilterSensitiveLog: (obj: ResourceCount) => any;
1057
+ /**
1058
+ * @internal
1059
+ */
1060
+ export declare const SearchInputFilterSensitiveLog: (obj: SearchInput) => any;
1061
+ /**
1062
+ * @internal
1063
+ */
1064
+ export declare const SearchOutputFilterSensitiveLog: (obj: SearchOutput) => any;
1065
+ /**
1066
+ * @internal
1067
+ */
1068
+ export declare const TagResourceInputFilterSensitiveLog: (obj: TagResourceInput) => any;
1069
+ /**
1070
+ * @internal
1071
+ */
1072
+ export declare const TagResourceOutputFilterSensitiveLog: (obj: TagResourceOutput) => any;
1073
+ /**
1074
+ * @internal
1075
+ */
1076
+ export declare const UntagResourceInputFilterSensitiveLog: (obj: UntagResourceInput) => any;
1077
+ /**
1078
+ * @internal
1079
+ */
1080
+ export declare const UntagResourceOutputFilterSensitiveLog: (obj: UntagResourceOutput) => any;