@aws-sdk/client-resource-explorer-2 3.295.0 → 3.297.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 (29) hide show
  1. package/dist-types/ResourceExplorer2.d.ts +20 -0
  2. package/dist-types/ResourceExplorer2Client.d.ts +24 -4
  3. package/dist-types/commands/AssociateDefaultViewCommand.d.ts +16 -0
  4. package/dist-types/commands/BatchGetViewCommand.d.ts +16 -0
  5. package/dist-types/commands/CreateIndexCommand.d.ts +16 -0
  6. package/dist-types/commands/CreateViewCommand.d.ts +16 -0
  7. package/dist-types/commands/DeleteIndexCommand.d.ts +16 -0
  8. package/dist-types/commands/DeleteViewCommand.d.ts +16 -0
  9. package/dist-types/commands/DisassociateDefaultViewCommand.d.ts +16 -0
  10. package/dist-types/commands/GetDefaultViewCommand.d.ts +16 -0
  11. package/dist-types/commands/GetIndexCommand.d.ts +16 -0
  12. package/dist-types/commands/GetViewCommand.d.ts +16 -0
  13. package/dist-types/commands/ListIndexesCommand.d.ts +16 -0
  14. package/dist-types/commands/ListSupportedResourceTypesCommand.d.ts +16 -0
  15. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  16. package/dist-types/commands/ListViewsCommand.d.ts +16 -0
  17. package/dist-types/commands/SearchCommand.d.ts +16 -0
  18. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  19. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  20. package/dist-types/commands/UpdateIndexTypeCommand.d.ts +16 -0
  21. package/dist-types/commands/UpdateViewCommand.d.ts +16 -0
  22. package/dist-types/models/ResourceExplorer2ServiceException.d.ts +2 -0
  23. package/dist-types/models/models_0.d.ts +126 -0
  24. package/dist-types/pagination/Interfaces.d.ts +3 -0
  25. package/dist-types/pagination/ListIndexesPaginator.d.ts +3 -0
  26. package/dist-types/pagination/ListSupportedResourceTypesPaginator.d.ts +3 -0
  27. package/dist-types/pagination/ListViewsPaginator.d.ts +3 -0
  28. package/dist-types/pagination/SearchPaginator.d.ts +3 -0
  29. package/package.json +29 -29
@@ -20,6 +20,7 @@ import { UpdateIndexTypeCommandInput, UpdateIndexTypeCommandOutput } from "./com
20
20
  import { UpdateViewCommandInput, UpdateViewCommandOutput } from "./commands/UpdateViewCommand";
21
21
  import { ResourceExplorer2Client } from "./ResourceExplorer2Client";
22
22
  /**
23
+ * @public
23
24
  * <p>Amazon Web Services Resource Explorer is a resource search and discovery service. By using Resource Explorer, you can
24
25
  * explore your resources using an internet search engine-like experience. Examples of
25
26
  * resources include Amazon Relational Database Service (Amazon RDS) instances, Amazon Simple Storage Service (Amazon S3) buckets, or Amazon DynamoDB
@@ -44,6 +45,7 @@ import { ResourceExplorer2Client } from "./ResourceExplorer2Client";
44
45
  */
45
46
  export declare class ResourceExplorer2 extends ResourceExplorer2Client {
46
47
  /**
48
+ * @public
47
49
  * <p>Sets the specified view as the default for the Amazon Web Services Region in which you call this
48
50
  * operation. When a user performs a <a>Search</a> that doesn't explicitly
49
51
  * specify which view to use, then Amazon Web Services Resource Explorer automatically chooses this default view for
@@ -56,12 +58,14 @@ export declare class ResourceExplorer2 extends ResourceExplorer2Client {
56
58
  associateDefaultView(args: AssociateDefaultViewCommandInput, cb: (err: any, data?: AssociateDefaultViewCommandOutput) => void): void;
57
59
  associateDefaultView(args: AssociateDefaultViewCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateDefaultViewCommandOutput) => void): void;
58
60
  /**
61
+ * @public
59
62
  * <p>Retrieves details about a list of views.</p>
60
63
  */
61
64
  batchGetView(args: BatchGetViewCommandInput, options?: __HttpHandlerOptions): Promise<BatchGetViewCommandOutput>;
62
65
  batchGetView(args: BatchGetViewCommandInput, cb: (err: any, data?: BatchGetViewCommandOutput) => void): void;
63
66
  batchGetView(args: BatchGetViewCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetViewCommandOutput) => void): void;
64
67
  /**
68
+ * @public
65
69
  * <p>Turns on Amazon Web Services Resource Explorer in the Amazon Web Services Region in which you called this operation by creating
66
70
  * an index. Resource Explorer begins discovering the resources in this Region and stores the details
67
71
  * 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>
@@ -118,6 +122,7 @@ export declare class ResourceExplorer2 extends ResourceExplorer2Client {
118
122
  createIndex(args: CreateIndexCommandInput, cb: (err: any, data?: CreateIndexCommandOutput) => void): void;
119
123
  createIndex(args: CreateIndexCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateIndexCommandOutput) => void): void;
120
124
  /**
125
+ * @public
121
126
  * <p>Creates a view that users can query by using the <a>Search</a> operation.
122
127
  * Results from queries that you make using this view include only resources that match the
123
128
  * view's <code>Filters</code>. For more information about Amazon Web Services Resource Explorer views, see <a href="https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-views.html">Managing views</a>
@@ -131,6 +136,7 @@ export declare class ResourceExplorer2 extends ResourceExplorer2Client {
131
136
  createView(args: CreateViewCommandInput, cb: (err: any, data?: CreateViewCommandOutput) => void): void;
132
137
  createView(args: CreateViewCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateViewCommandOutput) => void): void;
133
138
  /**
139
+ * @public
134
140
  * <p>Deletes the specified index and turns off Amazon Web Services Resource Explorer in the specified Amazon Web Services Region.
135
141
  * When you delete an index, Resource Explorer stops discovering and indexing resources in that
136
142
  * Region. Resource Explorer also deletes all views in that Region. These actions occur as
@@ -148,6 +154,7 @@ export declare class ResourceExplorer2 extends ResourceExplorer2Client {
148
154
  deleteIndex(args: DeleteIndexCommandInput, cb: (err: any, data?: DeleteIndexCommandOutput) => void): void;
149
155
  deleteIndex(args: DeleteIndexCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteIndexCommandOutput) => void): void;
150
156
  /**
157
+ * @public
151
158
  * <p>Deletes the specified view.</p>
152
159
  * <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
153
160
  * until you configure a new default by calling the <a>AssociateDefaultView</a>
@@ -157,6 +164,7 @@ export declare class ResourceExplorer2 extends ResourceExplorer2Client {
157
164
  deleteView(args: DeleteViewCommandInput, cb: (err: any, data?: DeleteViewCommandOutput) => void): void;
158
165
  deleteView(args: DeleteViewCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteViewCommandOutput) => void): void;
159
166
  /**
167
+ * @public
160
168
  * <p>After you call this operation, the affected Amazon Web Services Region no longer has a default view.
161
169
  * All <a>Search</a> operations in that Region must explicitly specify a view or
162
170
  * the operation fails. You can configure a new default by calling the <a>AssociateDefaultView</a> operation.</p>
@@ -168,6 +176,7 @@ export declare class ResourceExplorer2 extends ResourceExplorer2Client {
168
176
  disassociateDefaultView(args: DisassociateDefaultViewCommandInput, cb: (err: any, data?: DisassociateDefaultViewCommandOutput) => void): void;
169
177
  disassociateDefaultView(args: DisassociateDefaultViewCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateDefaultViewCommandOutput) => void): void;
170
178
  /**
179
+ * @public
171
180
  * <p>Retrieves the Amazon Resource Name (ARN) of the view that is the default for the
172
181
  * 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>
173
182
  */
@@ -175,6 +184,7 @@ export declare class ResourceExplorer2 extends ResourceExplorer2Client {
175
184
  getDefaultView(args: GetDefaultViewCommandInput, cb: (err: any, data?: GetDefaultViewCommandOutput) => void): void;
176
185
  getDefaultView(args: GetDefaultViewCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDefaultViewCommandOutput) => void): void;
177
186
  /**
187
+ * @public
178
188
  * <p>Retrieves details about the Amazon Web Services Resource Explorer index in the Amazon Web Services Region in which you invoked
179
189
  * the operation.</p>
180
190
  */
@@ -182,12 +192,14 @@ export declare class ResourceExplorer2 extends ResourceExplorer2Client {
182
192
  getIndex(args: GetIndexCommandInput, cb: (err: any, data?: GetIndexCommandOutput) => void): void;
183
193
  getIndex(args: GetIndexCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetIndexCommandOutput) => void): void;
184
194
  /**
195
+ * @public
185
196
  * <p>Retrieves details of the specified view.</p>
186
197
  */
187
198
  getView(args: GetViewCommandInput, options?: __HttpHandlerOptions): Promise<GetViewCommandOutput>;
188
199
  getView(args: GetViewCommandInput, cb: (err: any, data?: GetViewCommandOutput) => void): void;
189
200
  getView(args: GetViewCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetViewCommandOutput) => void): void;
190
201
  /**
202
+ * @public
191
203
  * <p>Retrieves a list of all of the indexes in Amazon Web Services Regions that are currently collecting
192
204
  * resource information for Amazon Web Services Resource Explorer.</p>
193
205
  */
@@ -195,18 +207,21 @@ export declare class ResourceExplorer2 extends ResourceExplorer2Client {
195
207
  listIndexes(args: ListIndexesCommandInput, cb: (err: any, data?: ListIndexesCommandOutput) => void): void;
196
208
  listIndexes(args: ListIndexesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListIndexesCommandOutput) => void): void;
197
209
  /**
210
+ * @public
198
211
  * <p>Retrieves a list of all resource types currently supported by Amazon Web Services Resource Explorer.</p>
199
212
  */
200
213
  listSupportedResourceTypes(args: ListSupportedResourceTypesCommandInput, options?: __HttpHandlerOptions): Promise<ListSupportedResourceTypesCommandOutput>;
201
214
  listSupportedResourceTypes(args: ListSupportedResourceTypesCommandInput, cb: (err: any, data?: ListSupportedResourceTypesCommandOutput) => void): void;
202
215
  listSupportedResourceTypes(args: ListSupportedResourceTypesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSupportedResourceTypesCommandOutput) => void): void;
203
216
  /**
217
+ * @public
204
218
  * <p>Lists the tags that are attached to the specified resource.</p>
205
219
  */
206
220
  listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
207
221
  listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
208
222
  listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
209
223
  /**
224
+ * @public
210
225
  * <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
211
226
  * call this operation.</p>
212
227
  * <note>
@@ -222,6 +237,7 @@ export declare class ResourceExplorer2 extends ResourceExplorer2Client {
222
237
  listViews(args: ListViewsCommandInput, cb: (err: any, data?: ListViewsCommandOutput) => void): void;
223
238
  listViews(args: ListViewsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListViewsCommandOutput) => void): void;
224
239
  /**
240
+ * @public
225
241
  * <p>Searches for resources and displays details about all resources that match the
226
242
  * specified criteria. You must specify a query string.</p>
227
243
  * <p>All search queries must use a view. If you don't explicitly specify a view, then
@@ -240,18 +256,21 @@ export declare class ResourceExplorer2 extends ResourceExplorer2Client {
240
256
  search(args: SearchCommandInput, cb: (err: any, data?: SearchCommandOutput) => void): void;
241
257
  search(args: SearchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchCommandOutput) => void): void;
242
258
  /**
259
+ * @public
243
260
  * <p>Adds one or more tag key and value pairs to an Amazon Web Services Resource Explorer view or index.</p>
244
261
  */
245
262
  tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
246
263
  tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
247
264
  tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
248
265
  /**
266
+ * @public
249
267
  * <p>Removes one or more tag key and value pairs from an Amazon Web Services Resource Explorer view or index.</p>
250
268
  */
251
269
  untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
252
270
  untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
253
271
  untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
254
272
  /**
273
+ * @public
255
274
  * <p>Changes the type of the index from one of the following types to the other. For more
256
275
  * information about indexes and the role they perform in Amazon Web Services Resource Explorer, see <a href="https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-aggregator-region.html">Turning on
257
276
  * cross-Region search by creating an aggregator index</a> in the
@@ -314,6 +333,7 @@ export declare class ResourceExplorer2 extends ResourceExplorer2Client {
314
333
  updateIndexType(args: UpdateIndexTypeCommandInput, cb: (err: any, data?: UpdateIndexTypeCommandOutput) => void): void;
315
334
  updateIndexType(args: UpdateIndexTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateIndexTypeCommandOutput) => void): void;
316
335
  /**
336
+ * @public
317
337
  * <p>Modifies some of the details of a view. You can change the filter string and the list
318
338
  * of included properties. You can't change the name of the view.</p>
319
339
  */
@@ -27,15 +27,24 @@ import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./command
27
27
  import { UpdateIndexTypeCommandInput, UpdateIndexTypeCommandOutput } from "./commands/UpdateIndexTypeCommand";
28
28
  import { UpdateViewCommandInput, UpdateViewCommandOutput } from "./commands/UpdateViewCommand";
29
29
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
30
+ /**
31
+ * @public
32
+ */
30
33
  export type ServiceInputTypes = AssociateDefaultViewCommandInput | BatchGetViewCommandInput | CreateIndexCommandInput | CreateViewCommandInput | DeleteIndexCommandInput | DeleteViewCommandInput | DisassociateDefaultViewCommandInput | GetDefaultViewCommandInput | GetIndexCommandInput | GetViewCommandInput | ListIndexesCommandInput | ListSupportedResourceTypesCommandInput | ListTagsForResourceCommandInput | ListViewsCommandInput | SearchCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateIndexTypeCommandInput | UpdateViewCommandInput;
34
+ /**
35
+ * @public
36
+ */
31
37
  export type ServiceOutputTypes = AssociateDefaultViewCommandOutput | BatchGetViewCommandOutput | CreateIndexCommandOutput | CreateViewCommandOutput | DeleteIndexCommandOutput | DeleteViewCommandOutput | DisassociateDefaultViewCommandOutput | GetDefaultViewCommandOutput | GetIndexCommandOutput | GetViewCommandOutput | ListIndexesCommandOutput | ListSupportedResourceTypesCommandOutput | ListTagsForResourceCommandOutput | ListViewsCommandOutput | SearchCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateIndexTypeCommandOutput | UpdateViewCommandOutput;
38
+ /**
39
+ * @public
40
+ */
32
41
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
33
42
  /**
34
43
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
35
44
  */
36
45
  requestHandler?: __HttpHandler;
37
46
  /**
38
- * A constructor for a class implementing the {@link __Checksum} interface
47
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
39
48
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
40
49
  * @internal
41
50
  */
@@ -125,23 +134,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
125
134
  */
126
135
  logger?: __Logger;
127
136
  /**
128
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
137
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
129
138
  */
130
139
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
131
140
  }
141
+ /**
142
+ * @public
143
+ */
132
144
  type ResourceExplorer2ClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
133
145
  /**
134
- * The configuration interface of ResourceExplorer2Client class constructor that set the region, credentials and other options.
146
+ * @public
147
+ *
148
+ * The configuration interface of ResourceExplorer2Client class constructor that set the region, credentials and other options.
135
149
  */
136
150
  export interface ResourceExplorer2ClientConfig extends ResourceExplorer2ClientConfigType {
137
151
  }
152
+ /**
153
+ * @public
154
+ */
138
155
  type ResourceExplorer2ClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
139
156
  /**
140
- * The resolved configuration interface of ResourceExplorer2Client class. This is resolved and normalized from the {@link ResourceExplorer2ClientConfig | constructor configuration interface}.
157
+ * @public
158
+ *
159
+ * The resolved configuration interface of ResourceExplorer2Client class. This is resolved and normalized from the {@link ResourceExplorer2ClientConfig | constructor configuration interface}.
141
160
  */
142
161
  export interface ResourceExplorer2ClientResolvedConfig extends ResourceExplorer2ClientResolvedConfigType {
143
162
  }
144
163
  /**
164
+ * @public
145
165
  * <p>Amazon Web Services Resource Explorer is a resource search and discovery service. By using Resource Explorer, you can
146
166
  * explore your resources using an internet search engine-like experience. Examples of
147
167
  * resources include Amazon Relational Database Service (Amazon RDS) instances, Amazon Simple Storage Service (Amazon S3) buckets, or Amazon DynamoDB
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AssociateDefaultViewInput, AssociateDefaultViewOutput } from "../models/models_0";
5
5
  import { ResourceExplorer2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ResourceExplorer2Client";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link AssociateDefaultViewCommand}.
8
10
  */
9
11
  export interface AssociateDefaultViewCommandInput extends AssociateDefaultViewInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link AssociateDefaultViewCommand}.
13
17
  */
14
18
  export interface AssociateDefaultViewCommandOutput extends AssociateDefaultViewOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Sets the specified view as the default for the Amazon Web Services Region in which you call this
18
23
  * operation. When a user performs a <a>Search</a> that doesn't explicitly
19
24
  * specify which view to use, then Amazon Web Services Resource Explorer automatically chooses this default view for
@@ -31,6 +36,8 @@ export interface AssociateDefaultViewCommandOutput extends AssociateDefaultViewO
31
36
  * const response = await client.send(command);
32
37
  * ```
33
38
  *
39
+ * @param AssociateDefaultViewCommandInput - {@link AssociateDefaultViewCommandInput}
40
+ * @returns {@link AssociateDefaultViewCommandOutput}
34
41
  * @see {@link AssociateDefaultViewCommandInput} for command's `input` shape.
35
42
  * @see {@link AssociateDefaultViewCommandOutput} for command's `response` shape.
36
43
  * @see {@link ResourceExplorer2ClientResolvedConfig | config} for ResourceExplorer2Client's `config` shape.
@@ -61,11 +68,20 @@ export interface AssociateDefaultViewCommandOutput extends AssociateDefaultViewO
61
68
  export declare class AssociateDefaultViewCommand extends $Command<AssociateDefaultViewCommandInput, AssociateDefaultViewCommandOutput, ResourceExplorer2ClientResolvedConfig> {
62
69
  readonly input: AssociateDefaultViewCommandInput;
63
70
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
71
+ /**
72
+ * @public
73
+ */
64
74
  constructor(input: AssociateDefaultViewCommandInput);
65
75
  /**
66
76
  * @internal
67
77
  */
68
78
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ResourceExplorer2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AssociateDefaultViewCommandInput, AssociateDefaultViewCommandOutput>;
79
+ /**
80
+ * @internal
81
+ */
69
82
  private serialize;
83
+ /**
84
+ * @internal
85
+ */
70
86
  private deserialize;
71
87
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { BatchGetViewInput, BatchGetViewOutput } from "../models/models_0";
5
5
  import { ResourceExplorer2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ResourceExplorer2Client";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link BatchGetViewCommand}.
8
10
  */
9
11
  export interface BatchGetViewCommandInput extends BatchGetViewInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link BatchGetViewCommand}.
13
17
  */
14
18
  export interface BatchGetViewCommandOutput extends BatchGetViewOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves details about a list of views.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface BatchGetViewCommandOutput extends BatchGetViewOutput, __Metadat
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param BatchGetViewCommandInput - {@link BatchGetViewCommandInput}
34
+ * @returns {@link BatchGetViewCommandOutput}
28
35
  * @see {@link BatchGetViewCommandInput} for command's `input` shape.
29
36
  * @see {@link BatchGetViewCommandOutput} for command's `response` shape.
30
37
  * @see {@link ResourceExplorer2ClientResolvedConfig | config} for ResourceExplorer2Client's `config` shape.
@@ -54,11 +61,20 @@ export interface BatchGetViewCommandOutput extends BatchGetViewOutput, __Metadat
54
61
  export declare class BatchGetViewCommand extends $Command<BatchGetViewCommandInput, BatchGetViewCommandOutput, ResourceExplorer2ClientResolvedConfig> {
55
62
  readonly input: BatchGetViewCommandInput;
56
63
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
64
+ /**
65
+ * @public
66
+ */
57
67
  constructor(input: BatchGetViewCommandInput);
58
68
  /**
59
69
  * @internal
60
70
  */
61
71
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ResourceExplorer2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<BatchGetViewCommandInput, BatchGetViewCommandOutput>;
72
+ /**
73
+ * @internal
74
+ */
62
75
  private serialize;
76
+ /**
77
+ * @internal
78
+ */
63
79
  private deserialize;
64
80
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CreateIndexInput, CreateIndexOutput } from "../models/models_0";
5
5
  import { ResourceExplorer2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ResourceExplorer2Client";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateIndexCommand}.
8
10
  */
9
11
  export interface CreateIndexCommandInput extends CreateIndexInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateIndexCommand}.
13
17
  */
14
18
  export interface CreateIndexCommandOutput extends CreateIndexOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Turns on Amazon Web Services Resource Explorer in the Amazon Web Services Region in which you called this operation by creating
18
23
  * an index. Resource Explorer begins discovering the resources in this Region and stores the details
19
24
  * 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>
@@ -75,6 +80,8 @@ export interface CreateIndexCommandOutput extends CreateIndexOutput, __MetadataB
75
80
  * const response = await client.send(command);
76
81
  * ```
77
82
  *
83
+ * @param CreateIndexCommandInput - {@link CreateIndexCommandInput}
84
+ * @returns {@link CreateIndexCommandOutput}
78
85
  * @see {@link CreateIndexCommandInput} for command's `input` shape.
79
86
  * @see {@link CreateIndexCommandOutput} for command's `response` shape.
80
87
  * @see {@link ResourceExplorer2ClientResolvedConfig | config} for ResourceExplorer2Client's `config` shape.
@@ -106,11 +113,20 @@ export interface CreateIndexCommandOutput extends CreateIndexOutput, __MetadataB
106
113
  export declare class CreateIndexCommand extends $Command<CreateIndexCommandInput, CreateIndexCommandOutput, ResourceExplorer2ClientResolvedConfig> {
107
114
  readonly input: CreateIndexCommandInput;
108
115
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
116
+ /**
117
+ * @public
118
+ */
109
119
  constructor(input: CreateIndexCommandInput);
110
120
  /**
111
121
  * @internal
112
122
  */
113
123
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ResourceExplorer2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateIndexCommandInput, CreateIndexCommandOutput>;
124
+ /**
125
+ * @internal
126
+ */
114
127
  private serialize;
128
+ /**
129
+ * @internal
130
+ */
115
131
  private deserialize;
116
132
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CreateViewInput, CreateViewOutput } from "../models/models_0";
5
5
  import { ResourceExplorer2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ResourceExplorer2Client";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateViewCommand}.
8
10
  */
9
11
  export interface CreateViewCommandInput extends CreateViewInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateViewCommand}.
13
17
  */
14
18
  export interface CreateViewCommandOutput extends CreateViewOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a view that users can query by using the <a>Search</a> operation.
18
23
  * Results from queries that you make using this view include only resources that match the
19
24
  * view's <code>Filters</code>. For more information about Amazon Web Services Resource Explorer views, see <a href="https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-views.html">Managing views</a>
@@ -32,6 +37,8 @@ export interface CreateViewCommandOutput extends CreateViewOutput, __MetadataBea
32
37
  * const response = await client.send(command);
33
38
  * ```
34
39
  *
40
+ * @param CreateViewCommandInput - {@link CreateViewCommandInput}
41
+ * @returns {@link CreateViewCommandOutput}
35
42
  * @see {@link CreateViewCommandInput} for command's `input` shape.
36
43
  * @see {@link CreateViewCommandOutput} for command's `response` shape.
37
44
  * @see {@link ResourceExplorer2ClientResolvedConfig | config} for ResourceExplorer2Client's `config` shape.
@@ -69,11 +76,20 @@ export interface CreateViewCommandOutput extends CreateViewOutput, __MetadataBea
69
76
  export declare class CreateViewCommand extends $Command<CreateViewCommandInput, CreateViewCommandOutput, ResourceExplorer2ClientResolvedConfig> {
70
77
  readonly input: CreateViewCommandInput;
71
78
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
79
+ /**
80
+ * @public
81
+ */
72
82
  constructor(input: CreateViewCommandInput);
73
83
  /**
74
84
  * @internal
75
85
  */
76
86
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ResourceExplorer2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateViewCommandInput, CreateViewCommandOutput>;
87
+ /**
88
+ * @internal
89
+ */
77
90
  private serialize;
91
+ /**
92
+ * @internal
93
+ */
78
94
  private deserialize;
79
95
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteIndexInput, DeleteIndexOutput } from "../models/models_0";
5
5
  import { ResourceExplorer2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ResourceExplorer2Client";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteIndexCommand}.
8
10
  */
9
11
  export interface DeleteIndexCommandInput extends DeleteIndexInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteIndexCommand}.
13
17
  */
14
18
  export interface DeleteIndexCommandOutput extends DeleteIndexOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes the specified index and turns off Amazon Web Services Resource Explorer in the specified Amazon Web Services Region.
18
23
  * When you delete an index, Resource Explorer stops discovering and indexing resources in that
19
24
  * Region. Resource Explorer also deletes all views in that Region. These actions occur as
@@ -36,6 +41,8 @@ export interface DeleteIndexCommandOutput extends DeleteIndexOutput, __MetadataB
36
41
  * const response = await client.send(command);
37
42
  * ```
38
43
  *
44
+ * @param DeleteIndexCommandInput - {@link DeleteIndexCommandInput}
45
+ * @returns {@link DeleteIndexCommandOutput}
39
46
  * @see {@link DeleteIndexCommandInput} for command's `input` shape.
40
47
  * @see {@link DeleteIndexCommandOutput} for command's `response` shape.
41
48
  * @see {@link ResourceExplorer2ClientResolvedConfig | config} for ResourceExplorer2Client's `config` shape.
@@ -66,11 +73,20 @@ export interface DeleteIndexCommandOutput extends DeleteIndexOutput, __MetadataB
66
73
  export declare class DeleteIndexCommand extends $Command<DeleteIndexCommandInput, DeleteIndexCommandOutput, ResourceExplorer2ClientResolvedConfig> {
67
74
  readonly input: DeleteIndexCommandInput;
68
75
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
76
+ /**
77
+ * @public
78
+ */
69
79
  constructor(input: DeleteIndexCommandInput);
70
80
  /**
71
81
  * @internal
72
82
  */
73
83
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ResourceExplorer2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteIndexCommandInput, DeleteIndexCommandOutput>;
84
+ /**
85
+ * @internal
86
+ */
74
87
  private serialize;
88
+ /**
89
+ * @internal
90
+ */
75
91
  private deserialize;
76
92
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteViewInput, DeleteViewOutput } from "../models/models_0";
5
5
  import { ResourceExplorer2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ResourceExplorer2Client";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteViewCommand}.
8
10
  */
9
11
  export interface DeleteViewCommandInput extends DeleteViewInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteViewCommand}.
13
17
  */
14
18
  export interface DeleteViewCommandOutput extends DeleteViewOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes the specified view.</p>
18
23
  * <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
19
24
  * until you configure a new default by calling the <a>AssociateDefaultView</a>
@@ -28,6 +33,8 @@ export interface DeleteViewCommandOutput extends DeleteViewOutput, __MetadataBea
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param DeleteViewCommandInput - {@link DeleteViewCommandInput}
37
+ * @returns {@link DeleteViewCommandOutput}
31
38
  * @see {@link DeleteViewCommandInput} for command's `input` shape.
32
39
  * @see {@link DeleteViewCommandOutput} for command's `response` shape.
33
40
  * @see {@link ResourceExplorer2ClientResolvedConfig | config} for ResourceExplorer2Client's `config` shape.
@@ -61,11 +68,20 @@ export interface DeleteViewCommandOutput extends DeleteViewOutput, __MetadataBea
61
68
  export declare class DeleteViewCommand extends $Command<DeleteViewCommandInput, DeleteViewCommandOutput, ResourceExplorer2ClientResolvedConfig> {
62
69
  readonly input: DeleteViewCommandInput;
63
70
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
71
+ /**
72
+ * @public
73
+ */
64
74
  constructor(input: DeleteViewCommandInput);
65
75
  /**
66
76
  * @internal
67
77
  */
68
78
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ResourceExplorer2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteViewCommandInput, DeleteViewCommandOutput>;
79
+ /**
80
+ * @internal
81
+ */
69
82
  private serialize;
83
+ /**
84
+ * @internal
85
+ */
70
86
  private deserialize;
71
87
  }
@@ -3,16 +3,21 @@ import { Command as $Command } from "@aws-sdk/smithy-client";
3
3
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
4
  import { ResourceExplorer2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ResourceExplorer2Client";
5
5
  /**
6
+ * @public
7
+ *
6
8
  * The input for {@link DisassociateDefaultViewCommand}.
7
9
  */
8
10
  export interface DisassociateDefaultViewCommandInput {
9
11
  }
10
12
  /**
13
+ * @public
14
+ *
11
15
  * The output of {@link DisassociateDefaultViewCommand}.
12
16
  */
13
17
  export interface DisassociateDefaultViewCommandOutput extends __MetadataBearer {
14
18
  }
15
19
  /**
20
+ * @public
16
21
  * <p>After you call this operation, the affected Amazon Web Services Region no longer has a default view.
17
22
  * All <a>Search</a> operations in that Region must explicitly specify a view or
18
23
  * the operation fails. You can configure a new default by calling the <a>AssociateDefaultView</a> operation.</p>
@@ -29,6 +34,8 @@ export interface DisassociateDefaultViewCommandOutput extends __MetadataBearer {
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param DisassociateDefaultViewCommandInput - {@link DisassociateDefaultViewCommandInput}
38
+ * @returns {@link DisassociateDefaultViewCommandOutput}
32
39
  * @see {@link DisassociateDefaultViewCommandInput} for command's `input` shape.
33
40
  * @see {@link DisassociateDefaultViewCommandOutput} for command's `response` shape.
34
41
  * @see {@link ResourceExplorer2ClientResolvedConfig | config} for ResourceExplorer2Client's `config` shape.
@@ -55,11 +62,20 @@ export interface DisassociateDefaultViewCommandOutput extends __MetadataBearer {
55
62
  export declare class DisassociateDefaultViewCommand extends $Command<DisassociateDefaultViewCommandInput, DisassociateDefaultViewCommandOutput, ResourceExplorer2ClientResolvedConfig> {
56
63
  readonly input: DisassociateDefaultViewCommandInput;
57
64
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
65
+ /**
66
+ * @public
67
+ */
58
68
  constructor(input: DisassociateDefaultViewCommandInput);
59
69
  /**
60
70
  * @internal
61
71
  */
62
72
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ResourceExplorer2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DisassociateDefaultViewCommandInput, DisassociateDefaultViewCommandOutput>;
73
+ /**
74
+ * @internal
75
+ */
63
76
  private serialize;
77
+ /**
78
+ * @internal
79
+ */
64
80
  private deserialize;
65
81
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetDefaultViewOutput } from "../models/models_0";
5
5
  import { ResourceExplorer2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ResourceExplorer2Client";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetDefaultViewCommand}.
8
10
  */
9
11
  export interface GetDefaultViewCommandInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetDefaultViewCommand}.
13
17
  */
14
18
  export interface GetDefaultViewCommandOutput extends GetDefaultViewOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves the Amazon Resource Name (ARN) of the view that is the default for the
18
23
  * 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>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface GetDefaultViewCommandOutput extends GetDefaultViewOutput, __Met
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param GetDefaultViewCommandInput - {@link GetDefaultViewCommandInput}
35
+ * @returns {@link GetDefaultViewCommandOutput}
29
36
  * @see {@link GetDefaultViewCommandInput} for command's `input` shape.
30
37
  * @see {@link GetDefaultViewCommandOutput} for command's `response` shape.
31
38
  * @see {@link ResourceExplorer2ClientResolvedConfig | config} for ResourceExplorer2Client's `config` shape.
@@ -56,11 +63,20 @@ export interface GetDefaultViewCommandOutput extends GetDefaultViewOutput, __Met
56
63
  export declare class GetDefaultViewCommand extends $Command<GetDefaultViewCommandInput, GetDefaultViewCommandOutput, ResourceExplorer2ClientResolvedConfig> {
57
64
  readonly input: GetDefaultViewCommandInput;
58
65
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
66
+ /**
67
+ * @public
68
+ */
59
69
  constructor(input: GetDefaultViewCommandInput);
60
70
  /**
61
71
  * @internal
62
72
  */
63
73
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ResourceExplorer2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetDefaultViewCommandInput, GetDefaultViewCommandOutput>;
74
+ /**
75
+ * @internal
76
+ */
64
77
  private serialize;
78
+ /**
79
+ * @internal
80
+ */
65
81
  private deserialize;
66
82
  }