aws-sdk-resourceexplorer2 1.41.0 → 1.42.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-resourceexplorer2/client.rb +537 -192
- data/lib/aws-sdk-resourceexplorer2/client_api.rb +320 -50
- data/lib/aws-sdk-resourceexplorer2/endpoint_parameters.rb +4 -4
- data/lib/aws-sdk-resourceexplorer2/errors.rb +4 -4
- data/lib/aws-sdk-resourceexplorer2/types.rb +821 -335
- data/lib/aws-sdk-resourceexplorer2/waiters.rb +15 -0
- data/lib/aws-sdk-resourceexplorer2.rb +2 -1
- data/sig/client.rbs +131 -39
- data/sig/errors.rbs +1 -1
- data/sig/types.rbs +178 -47
- metadata +2 -1
@@ -65,10 +65,6 @@ module Aws::ResourceExplorer2
|
|
65
65
|
# A collection of error messages for any views that Amazon Web Services
|
66
66
|
# Resource Explorer couldn't retrieve details.
|
67
67
|
#
|
68
|
-
# @!attribute [rw] error_message
|
69
|
-
# The description of the error for the specified view.
|
70
|
-
# @return [String]
|
71
|
-
#
|
72
68
|
# @!attribute [rw] view_arn
|
73
69
|
# The [Amazon resource name (ARN)][1] of the view for which Resource
|
74
70
|
# Explorer failed to retrieve details.
|
@@ -78,11 +74,15 @@ module Aws::ResourceExplorer2
|
|
78
74
|
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
79
75
|
# @return [String]
|
80
76
|
#
|
77
|
+
# @!attribute [rw] error_message
|
78
|
+
# The description of the error for the specified view.
|
79
|
+
# @return [String]
|
80
|
+
#
|
81
81
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/BatchGetViewError AWS API Documentation
|
82
82
|
#
|
83
83
|
class BatchGetViewError < Struct.new(
|
84
|
-
:
|
85
|
-
:
|
84
|
+
:view_arn,
|
85
|
+
:error_message)
|
86
86
|
SENSITIVE = []
|
87
87
|
include Aws::Structure
|
88
88
|
end
|
@@ -104,21 +104,21 @@ module Aws::ResourceExplorer2
|
|
104
104
|
include Aws::Structure
|
105
105
|
end
|
106
106
|
|
107
|
-
# @!attribute [rw] errors
|
108
|
-
# If any of the specified ARNs result in an error, then this structure
|
109
|
-
# describes the error.
|
110
|
-
# @return [Array<Types::BatchGetViewError>]
|
111
|
-
#
|
112
107
|
# @!attribute [rw] views
|
113
108
|
# A structure with a list of objects with details for each of the
|
114
109
|
# specified views.
|
115
110
|
# @return [Array<Types::View>]
|
116
111
|
#
|
112
|
+
# @!attribute [rw] errors
|
113
|
+
# If any of the specified ARNs result in an error, then this structure
|
114
|
+
# describes the error.
|
115
|
+
# @return [Array<Types::BatchGetViewError>]
|
116
|
+
#
|
117
117
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/BatchGetViewOutput AWS API Documentation
|
118
118
|
#
|
119
119
|
class BatchGetViewOutput < Struct.new(
|
120
|
-
:
|
121
|
-
:
|
120
|
+
:views,
|
121
|
+
:errors)
|
122
122
|
SENSITIVE = []
|
123
123
|
include Aws::Structure
|
124
124
|
end
|
@@ -183,10 +183,6 @@ module Aws::ResourceExplorer2
|
|
183
183
|
# operations: DeleteIndex \| GetIndex \| UpdateIndexType \| CreateView
|
184
184
|
# @return [String]
|
185
185
|
#
|
186
|
-
# @!attribute [rw] created_at
|
187
|
-
# The date and timestamp when the index was created.
|
188
|
-
# @return [Time]
|
189
|
-
#
|
190
186
|
# @!attribute [rw] state
|
191
187
|
# Indicates the current state of the index. You can check for changes
|
192
188
|
# to the state for asynchronous operations by calling the GetIndex
|
@@ -199,12 +195,59 @@ module Aws::ResourceExplorer2
|
|
199
195
|
# </note>
|
200
196
|
# @return [String]
|
201
197
|
#
|
198
|
+
# @!attribute [rw] created_at
|
199
|
+
# The date and timestamp when the index was created.
|
200
|
+
# @return [Time]
|
201
|
+
#
|
202
202
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/CreateIndexOutput AWS API Documentation
|
203
203
|
#
|
204
204
|
class CreateIndexOutput < Struct.new(
|
205
205
|
:arn,
|
206
|
-
:
|
207
|
-
:
|
206
|
+
:state,
|
207
|
+
:created_at)
|
208
|
+
SENSITIVE = []
|
209
|
+
include Aws::Structure
|
210
|
+
end
|
211
|
+
|
212
|
+
# @!attribute [rw] region_list
|
213
|
+
# A list of Amazon Web Services Regions where Resource Explorer should
|
214
|
+
# be configured. Each Region in the list will have a user-owned index
|
215
|
+
# created.
|
216
|
+
# @return [Array<String>]
|
217
|
+
#
|
218
|
+
# @!attribute [rw] aggregator_regions
|
219
|
+
# A list of Amazon Web Services Regions that should be configured as
|
220
|
+
# aggregator Regions. Aggregator Regions receive replicated index
|
221
|
+
# information from all other Regions where there is a user-owned
|
222
|
+
# index.
|
223
|
+
# @return [Array<String>]
|
224
|
+
#
|
225
|
+
# @!attribute [rw] view_name
|
226
|
+
# The name for the view to be created as part of the Resource Explorer
|
227
|
+
# setup. The view name must be unique within the Amazon Web Services
|
228
|
+
# account and Region.
|
229
|
+
# @return [String]
|
230
|
+
#
|
231
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/CreateResourceExplorerSetupInput AWS API Documentation
|
232
|
+
#
|
233
|
+
class CreateResourceExplorerSetupInput < Struct.new(
|
234
|
+
:region_list,
|
235
|
+
:aggregator_regions,
|
236
|
+
:view_name)
|
237
|
+
SENSITIVE = []
|
238
|
+
include Aws::Structure
|
239
|
+
end
|
240
|
+
|
241
|
+
# @!attribute [rw] task_id
|
242
|
+
# The unique identifier for the setup task. Use this ID with
|
243
|
+
# `GetResourceExplorerSetup` to monitor the progress of the
|
244
|
+
# configuration operation.
|
245
|
+
# @return [String]
|
246
|
+
#
|
247
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/CreateResourceExplorerSetupOutput AWS API Documentation
|
248
|
+
#
|
249
|
+
class CreateResourceExplorerSetupOutput < Struct.new(
|
250
|
+
:task_id)
|
208
251
|
SENSITIVE = []
|
209
252
|
include Aws::Structure
|
210
253
|
end
|
@@ -223,6 +266,29 @@ module Aws::ResourceExplorer2
|
|
223
266
|
# [1]: https://wikipedia.org/wiki/Universally_unique_identifier
|
224
267
|
# @return [String]
|
225
268
|
#
|
269
|
+
# @!attribute [rw] view_name
|
270
|
+
# The name of the new view. This name appears in the list of views in
|
271
|
+
# Resource Explorer.
|
272
|
+
#
|
273
|
+
# The name must be no more than 64 characters long, and can include
|
274
|
+
# letters, digits, and the dash (-) character. The name must be unique
|
275
|
+
# within its Amazon Web Services Region.
|
276
|
+
# @return [String]
|
277
|
+
#
|
278
|
+
# @!attribute [rw] included_properties
|
279
|
+
# Specifies optional fields that you want included in search results
|
280
|
+
# from this view. It is a list of objects that each describe a field
|
281
|
+
# to include.
|
282
|
+
#
|
283
|
+
# The default is an empty list, with no optional fields included in
|
284
|
+
# the results.
|
285
|
+
# @return [Array<Types::IncludedProperty>]
|
286
|
+
#
|
287
|
+
# @!attribute [rw] scope
|
288
|
+
# The root ARN of the account, an organizational unit (OU), or an
|
289
|
+
# organization ARN. If left empty, the default is account.
|
290
|
+
# @return [String]
|
291
|
+
#
|
226
292
|
# @!attribute [rw] filters
|
227
293
|
# An array of strings that specify which resources are included in the
|
228
294
|
# results of queries made using this view. When you use this view in a
|
@@ -247,42 +313,19 @@ module Aws::ResourceExplorer2
|
|
247
313
|
# [3]: https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html#query-syntax-operators
|
248
314
|
# @return [Types::SearchFilter]
|
249
315
|
#
|
250
|
-
# @!attribute [rw] included_properties
|
251
|
-
# Specifies optional fields that you want included in search results
|
252
|
-
# from this view. It is a list of objects that each describe a field
|
253
|
-
# to include.
|
254
|
-
#
|
255
|
-
# The default is an empty list, with no optional fields included in
|
256
|
-
# the results.
|
257
|
-
# @return [Array<Types::IncludedProperty>]
|
258
|
-
#
|
259
|
-
# @!attribute [rw] scope
|
260
|
-
# The root ARN of the account, an organizational unit (OU), or an
|
261
|
-
# organization ARN. If left empty, the default is account.
|
262
|
-
# @return [String]
|
263
|
-
#
|
264
316
|
# @!attribute [rw] tags
|
265
317
|
# Tag key and value pairs that are attached to the view.
|
266
318
|
# @return [Hash<String,String>]
|
267
319
|
#
|
268
|
-
# @!attribute [rw] view_name
|
269
|
-
# The name of the new view. This name appears in the list of views in
|
270
|
-
# Resource Explorer.
|
271
|
-
#
|
272
|
-
# The name must be no more than 64 characters long, and can include
|
273
|
-
# letters, digits, and the dash (-) character. The name must be unique
|
274
|
-
# within its Amazon Web Services Region.
|
275
|
-
# @return [String]
|
276
|
-
#
|
277
320
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/CreateViewInput AWS API Documentation
|
278
321
|
#
|
279
322
|
class CreateViewInput < Struct.new(
|
280
323
|
:client_token,
|
281
|
-
:
|
324
|
+
:view_name,
|
282
325
|
:included_properties,
|
283
326
|
:scope,
|
284
|
-
:
|
285
|
-
:
|
327
|
+
:filters,
|
328
|
+
:tags)
|
286
329
|
SENSITIVE = [:filters, :tags]
|
287
330
|
include Aws::Structure
|
288
331
|
end
|
@@ -330,20 +373,56 @@ module Aws::ResourceExplorer2
|
|
330
373
|
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
331
374
|
# @return [String]
|
332
375
|
#
|
333
|
-
# @!attribute [rw] last_updated_at
|
334
|
-
# The date and time when you last updated this index.
|
335
|
-
# @return [Time]
|
336
|
-
#
|
337
376
|
# @!attribute [rw] state
|
338
377
|
# Indicates the current state of the index.
|
339
378
|
# @return [String]
|
340
379
|
#
|
380
|
+
# @!attribute [rw] last_updated_at
|
381
|
+
# The date and time when you last updated this index.
|
382
|
+
# @return [Time]
|
383
|
+
#
|
341
384
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/DeleteIndexOutput AWS API Documentation
|
342
385
|
#
|
343
386
|
class DeleteIndexOutput < Struct.new(
|
344
387
|
:arn,
|
345
|
-
:
|
346
|
-
:
|
388
|
+
:state,
|
389
|
+
:last_updated_at)
|
390
|
+
SENSITIVE = []
|
391
|
+
include Aws::Structure
|
392
|
+
end
|
393
|
+
|
394
|
+
# @!attribute [rw] region_list
|
395
|
+
# A list of Amazon Web Services Regions from which to delete the
|
396
|
+
# Resource Explorer configuration. If not specified, the operation
|
397
|
+
# uses the `DeleteInAllRegions` parameter to determine scope.
|
398
|
+
# @return [Array<String>]
|
399
|
+
#
|
400
|
+
# @!attribute [rw] delete_in_all_regions
|
401
|
+
# Specifies whether to delete Resource Explorer configuration from all
|
402
|
+
# Regions where it is currently enabled. If this parameter is set to
|
403
|
+
# `true`, a value for `RegionList` must not be provided. Otherwise,
|
404
|
+
# the operation fails with a `ValidationException` error.
|
405
|
+
# @return [Boolean]
|
406
|
+
#
|
407
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/DeleteResourceExplorerSetupInput AWS API Documentation
|
408
|
+
#
|
409
|
+
class DeleteResourceExplorerSetupInput < Struct.new(
|
410
|
+
:region_list,
|
411
|
+
:delete_in_all_regions)
|
412
|
+
SENSITIVE = []
|
413
|
+
include Aws::Structure
|
414
|
+
end
|
415
|
+
|
416
|
+
# @!attribute [rw] task_id
|
417
|
+
# The unique identifier for the deletion task. Use this ID with
|
418
|
+
# `GetResourceExplorerSetup` to monitor the progress of the deletion
|
419
|
+
# operation.
|
420
|
+
# @return [String]
|
421
|
+
#
|
422
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/DeleteResourceExplorerSetupOutput AWS API Documentation
|
423
|
+
#
|
424
|
+
class DeleteResourceExplorerSetupOutput < Struct.new(
|
425
|
+
:task_id)
|
347
426
|
SENSITIVE = []
|
348
427
|
include Aws::Structure
|
349
428
|
end
|
@@ -382,6 +461,26 @@ module Aws::ResourceExplorer2
|
|
382
461
|
include Aws::Structure
|
383
462
|
end
|
384
463
|
|
464
|
+
# Contains information about an error that occurred during a Resource
|
465
|
+
# Explorer setup operation.
|
466
|
+
#
|
467
|
+
# @!attribute [rw] code
|
468
|
+
# The error code that identifies the type of error that occurred.
|
469
|
+
# @return [String]
|
470
|
+
#
|
471
|
+
# @!attribute [rw] message
|
472
|
+
# A human-readable description of the error that occurred.
|
473
|
+
# @return [String]
|
474
|
+
#
|
475
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/ErrorDetails AWS API Documentation
|
476
|
+
#
|
477
|
+
class ErrorDetails < Struct.new(
|
478
|
+
:code,
|
479
|
+
:message)
|
480
|
+
SENSITIVE = []
|
481
|
+
include Aws::Structure
|
482
|
+
end
|
483
|
+
|
385
484
|
# @!attribute [rw] org_configuration
|
386
485
|
# Details about the organization, and whether configuration is
|
387
486
|
# `ENABLED` or `DISABLED`.
|
@@ -421,13 +520,19 @@ module Aws::ResourceExplorer2
|
|
421
520
|
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
422
521
|
# @return [String]
|
423
522
|
#
|
424
|
-
# @!attribute [rw]
|
425
|
-
# The
|
426
|
-
#
|
523
|
+
# @!attribute [rw] type
|
524
|
+
# The type of the index in this Region. For information about the
|
525
|
+
# aggregator index and how it differs from a local index, see [Turning
|
526
|
+
# on cross-Region search by creating an aggregator index][1].
|
427
527
|
#
|
428
|
-
#
|
429
|
-
#
|
430
|
-
#
|
528
|
+
#
|
529
|
+
#
|
530
|
+
# [1]: https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-aggregator-region.html
|
531
|
+
# @return [String]
|
532
|
+
#
|
533
|
+
# @!attribute [rw] state
|
534
|
+
# The current state of the index in this Amazon Web Services Region.
|
535
|
+
# @return [String]
|
431
536
|
#
|
432
537
|
# @!attribute [rw] replicating_from
|
433
538
|
# This response value is present only if this index is
|
@@ -446,35 +551,29 @@ module Aws::ResourceExplorer2
|
|
446
551
|
# the Region specified in this response value.
|
447
552
|
# @return [Array<String>]
|
448
553
|
#
|
449
|
-
# @!attribute [rw]
|
450
|
-
# The
|
451
|
-
# @return [
|
554
|
+
# @!attribute [rw] created_at
|
555
|
+
# The date and time when the index was originally created.
|
556
|
+
# @return [Time]
|
557
|
+
#
|
558
|
+
# @!attribute [rw] last_updated_at
|
559
|
+
# The date and time when the index was last updated.
|
560
|
+
# @return [Time]
|
452
561
|
#
|
453
562
|
# @!attribute [rw] tags
|
454
563
|
# Tag key and value pairs that are attached to the index.
|
455
564
|
# @return [Hash<String,String>]
|
456
565
|
#
|
457
|
-
# @!attribute [rw] type
|
458
|
-
# The type of the index in this Region. For information about the
|
459
|
-
# aggregator index and how it differs from a local index, see [Turning
|
460
|
-
# on cross-Region search by creating an aggregator index][1].
|
461
|
-
#
|
462
|
-
#
|
463
|
-
#
|
464
|
-
# [1]: https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-aggregator-region.html
|
465
|
-
# @return [String]
|
466
|
-
#
|
467
566
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/GetIndexOutput AWS API Documentation
|
468
567
|
#
|
469
568
|
class GetIndexOutput < Struct.new(
|
470
569
|
:arn,
|
471
|
-
:
|
472
|
-
:
|
570
|
+
:type,
|
571
|
+
:state,
|
473
572
|
:replicating_from,
|
474
573
|
:replicating_to,
|
475
|
-
:
|
476
|
-
:
|
477
|
-
:
|
574
|
+
:created_at,
|
575
|
+
:last_updated_at,
|
576
|
+
:tags)
|
478
577
|
SENSITIVE = [:tags]
|
479
578
|
include Aws::Structure
|
480
579
|
end
|
@@ -503,6 +602,99 @@ module Aws::ResourceExplorer2
|
|
503
602
|
include Aws::Structure
|
504
603
|
end
|
505
604
|
|
605
|
+
# @!attribute [rw] task_id
|
606
|
+
# The unique identifier of the setup task to retrieve status
|
607
|
+
# information for. This ID is returned by
|
608
|
+
# `CreateResourceExplorerSetup` or `DeleteResourceExplorerSetup`
|
609
|
+
# operations.
|
610
|
+
# @return [String]
|
611
|
+
#
|
612
|
+
# @!attribute [rw] max_results
|
613
|
+
# The maximum number of Region status results to return in a single
|
614
|
+
# response. Valid values are between `1` and `100`.
|
615
|
+
# @return [Integer]
|
616
|
+
#
|
617
|
+
# @!attribute [rw] next_token
|
618
|
+
# The pagination token from a previous `GetResourceExplorerSetup`
|
619
|
+
# response. Use this token to retrieve the next set of results.
|
620
|
+
# @return [String]
|
621
|
+
#
|
622
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/GetResourceExplorerSetupInput AWS API Documentation
|
623
|
+
#
|
624
|
+
class GetResourceExplorerSetupInput < Struct.new(
|
625
|
+
:task_id,
|
626
|
+
:max_results,
|
627
|
+
:next_token)
|
628
|
+
SENSITIVE = []
|
629
|
+
include Aws::Structure
|
630
|
+
end
|
631
|
+
|
632
|
+
# @!attribute [rw] regions
|
633
|
+
# A list of Region status objects that describe the current state of
|
634
|
+
# Resource Explorer configuration in each Region.
|
635
|
+
# @return [Array<Types::RegionStatus>]
|
636
|
+
#
|
637
|
+
# @!attribute [rw] next_token
|
638
|
+
# The pagination token to use in a subsequent
|
639
|
+
# `GetResourceExplorerSetup` request to retrieve the next set of
|
640
|
+
# results.
|
641
|
+
# @return [String]
|
642
|
+
#
|
643
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/GetResourceExplorerSetupOutput AWS API Documentation
|
644
|
+
#
|
645
|
+
class GetResourceExplorerSetupOutput < Struct.new(
|
646
|
+
:regions,
|
647
|
+
:next_token)
|
648
|
+
SENSITIVE = []
|
649
|
+
include Aws::Structure
|
650
|
+
end
|
651
|
+
|
652
|
+
# @!attribute [rw] arn
|
653
|
+
# The Amazon Resource Name (ARN) of the Resource Explorer index in the
|
654
|
+
# current Region.
|
655
|
+
# @return [String]
|
656
|
+
#
|
657
|
+
# @!attribute [rw] type
|
658
|
+
# The type of the index. Valid values are `LOCAL` (contains resources
|
659
|
+
# from the current Region only) or `AGGREGATOR` (contains replicated
|
660
|
+
# resource information from all Regions).
|
661
|
+
# @return [String]
|
662
|
+
#
|
663
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/GetServiceIndexOutput AWS API Documentation
|
664
|
+
#
|
665
|
+
class GetServiceIndexOutput < Struct.new(
|
666
|
+
:arn,
|
667
|
+
:type)
|
668
|
+
SENSITIVE = []
|
669
|
+
include Aws::Structure
|
670
|
+
end
|
671
|
+
|
672
|
+
# @!attribute [rw] service_view_arn
|
673
|
+
# The Amazon Resource Name (ARN) of the service view to retrieve
|
674
|
+
# details for.
|
675
|
+
# @return [String]
|
676
|
+
#
|
677
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/GetServiceViewInput AWS API Documentation
|
678
|
+
#
|
679
|
+
class GetServiceViewInput < Struct.new(
|
680
|
+
:service_view_arn)
|
681
|
+
SENSITIVE = []
|
682
|
+
include Aws::Structure
|
683
|
+
end
|
684
|
+
|
685
|
+
# @!attribute [rw] view
|
686
|
+
# A `ServiceView` object that contains the details and configuration
|
687
|
+
# of the requested service view.
|
688
|
+
# @return [Types::ServiceView]
|
689
|
+
#
|
690
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/GetServiceViewOutput AWS API Documentation
|
691
|
+
#
|
692
|
+
class GetServiceViewOutput < Struct.new(
|
693
|
+
:view)
|
694
|
+
SENSITIVE = []
|
695
|
+
include Aws::Structure
|
696
|
+
end
|
697
|
+
|
506
698
|
# @!attribute [rw] view_arn
|
507
699
|
# The [Amazon resource name (ARN)][1] of the view that you want
|
508
700
|
# information about.
|
@@ -520,19 +712,19 @@ module Aws::ResourceExplorer2
|
|
520
712
|
include Aws::Structure
|
521
713
|
end
|
522
714
|
|
523
|
-
# @!attribute [rw] tags
|
524
|
-
# Tag key and value pairs that are attached to the view.
|
525
|
-
# @return [Hash<String,String>]
|
526
|
-
#
|
527
715
|
# @!attribute [rw] view
|
528
716
|
# A structure that contains the details for the requested view.
|
529
717
|
# @return [Types::View]
|
530
718
|
#
|
719
|
+
# @!attribute [rw] tags
|
720
|
+
# Tag key and value pairs that are attached to the view.
|
721
|
+
# @return [Hash<String,String>]
|
722
|
+
#
|
531
723
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/GetViewOutput AWS API Documentation
|
532
724
|
#
|
533
725
|
class GetViewOutput < Struct.new(
|
534
|
-
:
|
535
|
-
:
|
726
|
+
:view,
|
727
|
+
:tags)
|
536
728
|
SENSITIVE = [:tags]
|
537
729
|
include Aws::Structure
|
538
730
|
end
|
@@ -575,6 +767,10 @@ module Aws::ResourceExplorer2
|
|
575
767
|
# operations in that Region to return results from all Regions in the
|
576
768
|
# account.
|
577
769
|
#
|
770
|
+
# @!attribute [rw] region
|
771
|
+
# The Amazon Web Services Region in which the index exists.
|
772
|
+
# @return [String]
|
773
|
+
#
|
578
774
|
# @!attribute [rw] arn
|
579
775
|
# The [Amazon resource name (ARN)][1] of the index.
|
580
776
|
#
|
@@ -583,10 +779,6 @@ module Aws::ResourceExplorer2
|
|
583
779
|
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
584
780
|
# @return [String]
|
585
781
|
#
|
586
|
-
# @!attribute [rw] region
|
587
|
-
# The Amazon Web Services Region in which the index exists.
|
588
|
-
# @return [String]
|
589
|
-
#
|
590
782
|
# @!attribute [rw] type
|
591
783
|
# The type of index. It can be one of the following values:
|
592
784
|
#
|
@@ -603,13 +795,52 @@ module Aws::ResourceExplorer2
|
|
603
795
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/Index AWS API Documentation
|
604
796
|
#
|
605
797
|
class Index < Struct.new(
|
606
|
-
:arn,
|
607
798
|
:region,
|
799
|
+
:arn,
|
608
800
|
:type)
|
609
801
|
SENSITIVE = []
|
610
802
|
include Aws::Structure
|
611
803
|
end
|
612
804
|
|
805
|
+
# Contains information about the status of a Resource Explorer index
|
806
|
+
# operation in a specific Region.
|
807
|
+
#
|
808
|
+
# @!attribute [rw] status
|
809
|
+
# The current status of the index operation. Valid values are
|
810
|
+
# `SUCCEEDED`, `FAILED`, `IN_PROGRESS`, or `SKIPPED`.
|
811
|
+
# @return [String]
|
812
|
+
#
|
813
|
+
# @!attribute [rw] index
|
814
|
+
# An index is the data store used by Amazon Web Services Resource
|
815
|
+
# Explorer to hold information about your Amazon Web Services
|
816
|
+
# resources that the service discovers. Creating an index in an Amazon
|
817
|
+
# Web Services Region turns on Resource Explorer and lets it discover
|
818
|
+
# your resources.
|
819
|
+
#
|
820
|
+
# By default, an index is *local*, meaning that it contains
|
821
|
+
# information about resources in only the same Region as the index.
|
822
|
+
# However, you can promote the index of one Region in the account by
|
823
|
+
# calling UpdateIndexType to convert it into an aggregator index. The
|
824
|
+
# aggregator index receives a replicated copy of the index information
|
825
|
+
# from all other Regions where Resource Explorer is turned on. This
|
826
|
+
# allows search operations in that Region to return results from all
|
827
|
+
# Regions in the account.
|
828
|
+
# @return [Types::Index]
|
829
|
+
#
|
830
|
+
# @!attribute [rw] error_details
|
831
|
+
# Details about any error that occurred during the index operation.
|
832
|
+
# @return [Types::ErrorDetails]
|
833
|
+
#
|
834
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/IndexStatus AWS API Documentation
|
835
|
+
#
|
836
|
+
class IndexStatus < Struct.new(
|
837
|
+
:status,
|
838
|
+
:index,
|
839
|
+
:error_details)
|
840
|
+
SENSITIVE = []
|
841
|
+
include Aws::Structure
|
842
|
+
end
|
843
|
+
|
613
844
|
# The request failed because of internal service error. Try your request
|
614
845
|
# again later.
|
615
846
|
#
|
@@ -686,6 +917,18 @@ module Aws::ResourceExplorer2
|
|
686
917
|
include Aws::Structure
|
687
918
|
end
|
688
919
|
|
920
|
+
# @!attribute [rw] type
|
921
|
+
# If specified, limits the output to only indexes of the specified
|
922
|
+
# Type, either `LOCAL` or `AGGREGATOR`.
|
923
|
+
#
|
924
|
+
# Use this option to discover the aggregator index for your account.
|
925
|
+
# @return [String]
|
926
|
+
#
|
927
|
+
# @!attribute [rw] regions
|
928
|
+
# If specified, limits the response to only information about the
|
929
|
+
# index in the specified list of Amazon Web Services Regions.
|
930
|
+
# @return [Array<String>]
|
931
|
+
#
|
689
932
|
# @!attribute [rw] max_results
|
690
933
|
# The maximum number of results that you want included on each page of
|
691
934
|
# the response. If you do not include this parameter, it defaults to a
|
@@ -711,25 +954,13 @@ module Aws::ResourceExplorer2
|
|
711
954
|
# 24 hours.
|
712
955
|
# @return [String]
|
713
956
|
#
|
714
|
-
# @!attribute [rw] regions
|
715
|
-
# If specified, limits the response to only information about the
|
716
|
-
# index in the specified list of Amazon Web Services Regions.
|
717
|
-
# @return [Array<String>]
|
718
|
-
#
|
719
|
-
# @!attribute [rw] type
|
720
|
-
# If specified, limits the output to only indexes of the specified
|
721
|
-
# Type, either `LOCAL` or `AGGREGATOR`.
|
722
|
-
#
|
723
|
-
# Use this option to discover the aggregator index for your account.
|
724
|
-
# @return [String]
|
725
|
-
#
|
726
957
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/ListIndexesInput AWS API Documentation
|
727
958
|
#
|
728
959
|
class ListIndexesInput < Struct.new(
|
729
|
-
:
|
730
|
-
:next_token,
|
960
|
+
:type,
|
731
961
|
:regions,
|
732
|
-
:
|
962
|
+
:max_results,
|
963
|
+
:next_token)
|
733
964
|
SENSITIVE = []
|
734
965
|
include Aws::Structure
|
735
966
|
end
|
@@ -797,11 +1028,6 @@ module Aws::ResourceExplorer2
|
|
797
1028
|
include Aws::Structure
|
798
1029
|
end
|
799
1030
|
|
800
|
-
# @!attribute [rw] managed_views
|
801
|
-
# The list of managed views available in the Amazon Web Services
|
802
|
-
# Region in which you called this operation.
|
803
|
-
# @return [Array<String>]
|
804
|
-
#
|
805
1031
|
# @!attribute [rw] next_token
|
806
1032
|
# If present, indicates that more output is available than is included
|
807
1033
|
# in the current response. Use this value in the `NextToken` request
|
@@ -811,11 +1037,16 @@ module Aws::ResourceExplorer2
|
|
811
1037
|
# hours.
|
812
1038
|
# @return [String]
|
813
1039
|
#
|
1040
|
+
# @!attribute [rw] managed_views
|
1041
|
+
# The list of managed views available in the Amazon Web Services
|
1042
|
+
# Region in which you called this operation.
|
1043
|
+
# @return [Array<String>]
|
1044
|
+
#
|
814
1045
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/ListManagedViewsOutput AWS API Documentation
|
815
1046
|
#
|
816
1047
|
class ListManagedViewsOutput < Struct.new(
|
817
|
-
:
|
818
|
-
:
|
1048
|
+
:next_token,
|
1049
|
+
:managed_views)
|
819
1050
|
SENSITIVE = []
|
820
1051
|
include Aws::Structure
|
821
1052
|
end
|
@@ -860,6 +1091,16 @@ module Aws::ResourceExplorer2
|
|
860
1091
|
# </note>
|
861
1092
|
# @return [Integer]
|
862
1093
|
#
|
1094
|
+
# @!attribute [rw] view_arn
|
1095
|
+
# Specifies the Amazon resource name (ARN) of the view to use for the
|
1096
|
+
# query. If you don't specify a value for this parameter, then the
|
1097
|
+
# operation automatically uses the default view for the Amazon Web
|
1098
|
+
# Services Region in which you called this operation. If the Region
|
1099
|
+
# either doesn't have a default view or if you don't have permission
|
1100
|
+
# to use the default view, then the operation fails with a 401
|
1101
|
+
# Unauthorized exception.
|
1102
|
+
# @return [String]
|
1103
|
+
#
|
863
1104
|
# @!attribute [rw] next_token
|
864
1105
|
# The parameter for receiving additional results if you receive a
|
865
1106
|
# `NextToken` response in a previous request. A `NextToken` response
|
@@ -874,27 +1115,22 @@ module Aws::ResourceExplorer2
|
|
874
1115
|
# </note>
|
875
1116
|
# @return [String]
|
876
1117
|
#
|
877
|
-
# @!attribute [rw] view_arn
|
878
|
-
# Specifies the Amazon resource name (ARN) of the view to use for the
|
879
|
-
# query. If you don't specify a value for this parameter, then the
|
880
|
-
# operation automatically uses the default view for the Amazon Web
|
881
|
-
# Services Region in which you called this operation. If the Region
|
882
|
-
# either doesn't have a default view or if you don't have permission
|
883
|
-
# to use the default view, then the operation fails with a 401
|
884
|
-
# Unauthorized exception.
|
885
|
-
# @return [String]
|
886
|
-
#
|
887
1118
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/ListResourcesInput AWS API Documentation
|
888
1119
|
#
|
889
1120
|
class ListResourcesInput < Struct.new(
|
890
1121
|
:filters,
|
891
1122
|
:max_results,
|
892
|
-
:
|
893
|
-
:
|
1123
|
+
:view_arn,
|
1124
|
+
:next_token)
|
894
1125
|
SENSITIVE = [:filters]
|
895
1126
|
include Aws::Structure
|
896
1127
|
end
|
897
1128
|
|
1129
|
+
# @!attribute [rw] resources
|
1130
|
+
# The list of structures that describe the resources that match the
|
1131
|
+
# query.
|
1132
|
+
# @return [Array<Types::Resource>]
|
1133
|
+
#
|
898
1134
|
# @!attribute [rw] next_token
|
899
1135
|
# If present, indicates that more output is available than is included
|
900
1136
|
# in the current response. Use this value in the `NextToken` request
|
@@ -904,11 +1140,6 @@ module Aws::ResourceExplorer2
|
|
904
1140
|
# hours.
|
905
1141
|
# @return [String]
|
906
1142
|
#
|
907
|
-
# @!attribute [rw] resources
|
908
|
-
# The list of structures that describe the resources that match the
|
909
|
-
# query.
|
910
|
-
# @return [Array<Types::Resource>]
|
911
|
-
#
|
912
1143
|
# @!attribute [rw] view_arn
|
913
1144
|
# The Amazon resource name (ARN) of the view that this operation used
|
914
1145
|
# to perform the search.
|
@@ -917,27 +1148,101 @@ module Aws::ResourceExplorer2
|
|
917
1148
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/ListResourcesOutput AWS API Documentation
|
918
1149
|
#
|
919
1150
|
class ListResourcesOutput < Struct.new(
|
920
|
-
:next_token,
|
921
1151
|
:resources,
|
1152
|
+
:next_token,
|
922
1153
|
:view_arn)
|
923
1154
|
SENSITIVE = []
|
924
1155
|
include Aws::Structure
|
925
1156
|
end
|
926
1157
|
|
1158
|
+
# @!attribute [rw] regions
|
1159
|
+
# A list of Amazon Web Services Regions to include in the search for
|
1160
|
+
# indexes. If not specified, indexes from all Regions are returned.
|
1161
|
+
# @return [Array<String>]
|
1162
|
+
#
|
927
1163
|
# @!attribute [rw] max_results
|
928
|
-
# The maximum number of results
|
929
|
-
#
|
930
|
-
#
|
931
|
-
# those included in the current response, the `NextToken` response
|
932
|
-
# element is present and has a value (is not null). Include that value
|
933
|
-
# as the `NextToken` request parameter in the next call to the
|
934
|
-
# operation to get the next part of the results.
|
1164
|
+
# The maximum number of index results to return in a single response.
|
1165
|
+
# Valid values are between `1` and `100`.
|
1166
|
+
# @return [Integer]
|
935
1167
|
#
|
936
|
-
#
|
937
|
-
#
|
938
|
-
#
|
1168
|
+
# @!attribute [rw] next_token
|
1169
|
+
# The pagination token from a previous `ListServiceIndexes` response.
|
1170
|
+
# Use this token to retrieve the next set of results.
|
1171
|
+
# @return [String]
|
939
1172
|
#
|
940
|
-
#
|
1173
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/ListServiceIndexesInput AWS API Documentation
|
1174
|
+
#
|
1175
|
+
class ListServiceIndexesInput < Struct.new(
|
1176
|
+
:regions,
|
1177
|
+
:max_results,
|
1178
|
+
:next_token)
|
1179
|
+
SENSITIVE = []
|
1180
|
+
include Aws::Structure
|
1181
|
+
end
|
1182
|
+
|
1183
|
+
# @!attribute [rw] indexes
|
1184
|
+
# A list of `Index` objects that describe the Resource Explorer
|
1185
|
+
# indexes found in the specified Regions.
|
1186
|
+
# @return [Array<Types::Index>]
|
1187
|
+
#
|
1188
|
+
# @!attribute [rw] next_token
|
1189
|
+
# The pagination token to use in a subsequent `ListServiceIndexes`
|
1190
|
+
# request to retrieve the next set of results.
|
1191
|
+
# @return [String]
|
1192
|
+
#
|
1193
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/ListServiceIndexesOutput AWS API Documentation
|
1194
|
+
#
|
1195
|
+
class ListServiceIndexesOutput < Struct.new(
|
1196
|
+
:indexes,
|
1197
|
+
:next_token)
|
1198
|
+
SENSITIVE = []
|
1199
|
+
include Aws::Structure
|
1200
|
+
end
|
1201
|
+
|
1202
|
+
# @!attribute [rw] max_results
|
1203
|
+
# The maximum number of service view results to return in a single
|
1204
|
+
# response. Valid values are between `1` and `50`.
|
1205
|
+
# @return [Integer]
|
1206
|
+
#
|
1207
|
+
# @!attribute [rw] next_token
|
1208
|
+
# The pagination token from a previous `ListServiceViews` response.
|
1209
|
+
# Use this token to retrieve the next set of results.
|
1210
|
+
# @return [String]
|
1211
|
+
#
|
1212
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/ListServiceViewsInput AWS API Documentation
|
1213
|
+
#
|
1214
|
+
class ListServiceViewsInput < Struct.new(
|
1215
|
+
:max_results,
|
1216
|
+
:next_token)
|
1217
|
+
SENSITIVE = []
|
1218
|
+
include Aws::Structure
|
1219
|
+
end
|
1220
|
+
|
1221
|
+
# @!attribute [rw] next_token
|
1222
|
+
# The pagination token to use in a subsequent `ListServiceViews`
|
1223
|
+
# request to retrieve the next set of results.
|
1224
|
+
# @return [String]
|
1225
|
+
#
|
1226
|
+
# @!attribute [rw] service_views
|
1227
|
+
# A list of Amazon Resource Names (ARNs) for the service views
|
1228
|
+
# available in the current Amazon Web Services account.
|
1229
|
+
# @return [Array<String>]
|
1230
|
+
#
|
1231
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/ListServiceViewsOutput AWS API Documentation
|
1232
|
+
#
|
1233
|
+
class ListServiceViewsOutput < Struct.new(
|
1234
|
+
:next_token,
|
1235
|
+
:service_views)
|
1236
|
+
SENSITIVE = []
|
1237
|
+
include Aws::Structure
|
1238
|
+
end
|
1239
|
+
|
1240
|
+
# @!attribute [rw] max_results
|
1241
|
+
# The maximum number of streaming access entries to return in the
|
1242
|
+
# response. If there are more results available, the response includes
|
1243
|
+
# a NextToken value that you can use in a subsequent call to get the
|
1244
|
+
# next set of results. The value must be between 1 and 50. If you
|
1245
|
+
# don't specify a value, the default is 50.
|
941
1246
|
# @return [Integer]
|
942
1247
|
#
|
943
1248
|
# @!attribute [rw] next_token
|
@@ -949,15 +1254,21 @@ module Aws::ResourceExplorer2
|
|
949
1254
|
# 24 hours.
|
950
1255
|
# @return [String]
|
951
1256
|
#
|
952
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/
|
1257
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/ListStreamingAccessForServicesInput AWS API Documentation
|
953
1258
|
#
|
954
|
-
class
|
1259
|
+
class ListStreamingAccessForServicesInput < Struct.new(
|
955
1260
|
:max_results,
|
956
1261
|
:next_token)
|
957
1262
|
SENSITIVE = []
|
958
1263
|
include Aws::Structure
|
959
1264
|
end
|
960
1265
|
|
1266
|
+
# @!attribute [rw] streaming_access_for_services
|
1267
|
+
# A list of Amazon Web Services services that have streaming access to
|
1268
|
+
# your Resource Explorer data, including details about when the access
|
1269
|
+
# was granted.
|
1270
|
+
# @return [Array<Types::StreamingAccessDetails>]
|
1271
|
+
#
|
961
1272
|
# @!attribute [rw] next_token
|
962
1273
|
# If present, indicates that more output is available than is included
|
963
1274
|
# in the current response. Use this value in the `NextToken` request
|
@@ -967,15 +1278,67 @@ module Aws::ResourceExplorer2
|
|
967
1278
|
# hours.
|
968
1279
|
# @return [String]
|
969
1280
|
#
|
1281
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/ListStreamingAccessForServicesOutput AWS API Documentation
|
1282
|
+
#
|
1283
|
+
class ListStreamingAccessForServicesOutput < Struct.new(
|
1284
|
+
:streaming_access_for_services,
|
1285
|
+
:next_token)
|
1286
|
+
SENSITIVE = []
|
1287
|
+
include Aws::Structure
|
1288
|
+
end
|
1289
|
+
|
1290
|
+
# @!attribute [rw] next_token
|
1291
|
+
# The parameter for receiving additional results if you receive a
|
1292
|
+
# `NextToken` response in a previous request. A `NextToken` response
|
1293
|
+
# indicates that more output is available. Set this parameter to the
|
1294
|
+
# value of the previous call's `NextToken` response to indicate where
|
1295
|
+
# the output should continue from. The pagination tokens expire after
|
1296
|
+
# 24 hours.
|
1297
|
+
# @return [String]
|
1298
|
+
#
|
1299
|
+
# @!attribute [rw] max_results
|
1300
|
+
# The maximum number of results that you want included on each page of
|
1301
|
+
# the response. If you do not include this parameter, it defaults to a
|
1302
|
+
# value appropriate to the operation. If additional items exist beyond
|
1303
|
+
# those included in the current response, the `NextToken` response
|
1304
|
+
# element is present and has a value (is not null). Include that value
|
1305
|
+
# as the `NextToken` request parameter in the next call to the
|
1306
|
+
# operation to get the next part of the results.
|
1307
|
+
#
|
1308
|
+
# <note markdown="1"> An API operation can return fewer results than the maximum even when
|
1309
|
+
# there are more results available. You should check `NextToken` after
|
1310
|
+
# every operation to ensure that you receive all of the results.
|
1311
|
+
#
|
1312
|
+
# </note>
|
1313
|
+
# @return [Integer]
|
1314
|
+
#
|
1315
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/ListSupportedResourceTypesInput AWS API Documentation
|
1316
|
+
#
|
1317
|
+
class ListSupportedResourceTypesInput < Struct.new(
|
1318
|
+
:next_token,
|
1319
|
+
:max_results)
|
1320
|
+
SENSITIVE = []
|
1321
|
+
include Aws::Structure
|
1322
|
+
end
|
1323
|
+
|
970
1324
|
# @!attribute [rw] resource_types
|
971
1325
|
# The list of resource types supported by Resource Explorer.
|
972
1326
|
# @return [Array<Types::SupportedResourceType>]
|
973
1327
|
#
|
1328
|
+
# @!attribute [rw] next_token
|
1329
|
+
# If present, indicates that more output is available than is included
|
1330
|
+
# in the current response. Use this value in the `NextToken` request
|
1331
|
+
# parameter in a subsequent call to the operation to get the next part
|
1332
|
+
# of the output. You should repeat this until the `NextToken` response
|
1333
|
+
# element comes back as `null`. The pagination tokens expire after 24
|
1334
|
+
# hours.
|
1335
|
+
# @return [String]
|
1336
|
+
#
|
974
1337
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/ListSupportedResourceTypesOutput AWS API Documentation
|
975
1338
|
#
|
976
1339
|
class ListSupportedResourceTypesOutput < Struct.new(
|
977
|
-
:
|
978
|
-
:
|
1340
|
+
:resource_types,
|
1341
|
+
:next_token)
|
979
1342
|
SENSITIVE = []
|
980
1343
|
include Aws::Structure
|
981
1344
|
end
|
@@ -1010,6 +1373,15 @@ module Aws::ResourceExplorer2
|
|
1010
1373
|
include Aws::Structure
|
1011
1374
|
end
|
1012
1375
|
|
1376
|
+
# @!attribute [rw] next_token
|
1377
|
+
# The parameter for receiving additional results if you receive a
|
1378
|
+
# `NextToken` response in a previous request. A `NextToken` response
|
1379
|
+
# indicates that more output is available. Set this parameter to the
|
1380
|
+
# value of the previous call's `NextToken` response to indicate where
|
1381
|
+
# the output should continue from. The pagination tokens expire after
|
1382
|
+
# 24 hours.
|
1383
|
+
# @return [String]
|
1384
|
+
#
|
1013
1385
|
# @!attribute [rw] max_results
|
1014
1386
|
# The maximum number of results that you want included on each page of
|
1015
1387
|
# the response. If you do not include this parameter, it defaults to a
|
@@ -1026,24 +1398,20 @@ module Aws::ResourceExplorer2
|
|
1026
1398
|
# </note>
|
1027
1399
|
# @return [Integer]
|
1028
1400
|
#
|
1029
|
-
# @!attribute [rw] next_token
|
1030
|
-
# The parameter for receiving additional results if you receive a
|
1031
|
-
# `NextToken` response in a previous request. A `NextToken` response
|
1032
|
-
# indicates that more output is available. Set this parameter to the
|
1033
|
-
# value of the previous call's `NextToken` response to indicate where
|
1034
|
-
# the output should continue from. The pagination tokens expire after
|
1035
|
-
# 24 hours.
|
1036
|
-
# @return [String]
|
1037
|
-
#
|
1038
1401
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/ListViewsInput AWS API Documentation
|
1039
1402
|
#
|
1040
1403
|
class ListViewsInput < Struct.new(
|
1041
|
-
:
|
1042
|
-
:
|
1404
|
+
:next_token,
|
1405
|
+
:max_results)
|
1043
1406
|
SENSITIVE = []
|
1044
1407
|
include Aws::Structure
|
1045
1408
|
end
|
1046
1409
|
|
1410
|
+
# @!attribute [rw] views
|
1411
|
+
# The list of views available in the Amazon Web Services Region in
|
1412
|
+
# which you called this operation.
|
1413
|
+
# @return [Array<String>]
|
1414
|
+
#
|
1047
1415
|
# @!attribute [rw] next_token
|
1048
1416
|
# If present, indicates that more output is available than is included
|
1049
1417
|
# in the current response. Use this value in the `NextToken` request
|
@@ -1053,16 +1421,11 @@ module Aws::ResourceExplorer2
|
|
1053
1421
|
# hours.
|
1054
1422
|
# @return [String]
|
1055
1423
|
#
|
1056
|
-
# @!attribute [rw] views
|
1057
|
-
# The list of views available in the Amazon Web Services Region in
|
1058
|
-
# which you called this operation.
|
1059
|
-
# @return [Array<String>]
|
1060
|
-
#
|
1061
1424
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/ListViewsOutput AWS API Documentation
|
1062
1425
|
#
|
1063
1426
|
class ListViewsOutput < Struct.new(
|
1064
|
-
:
|
1065
|
-
:
|
1427
|
+
:views,
|
1428
|
+
:next_token)
|
1066
1429
|
SENSITIVE = []
|
1067
1430
|
include Aws::Structure
|
1068
1431
|
end
|
@@ -1076,20 +1439,6 @@ module Aws::ResourceExplorer2
|
|
1076
1439
|
#
|
1077
1440
|
# [1]: https://docs.aws.amazon.com/resource-explorer/latest/userguide/aws-managed-views.html
|
1078
1441
|
#
|
1079
|
-
# @!attribute [rw] filters
|
1080
|
-
# A search filter defines which resources can be part of a search
|
1081
|
-
# query result set.
|
1082
|
-
# @return [Types::SearchFilter]
|
1083
|
-
#
|
1084
|
-
# @!attribute [rw] included_properties
|
1085
|
-
# A structure that contains additional information about the managed
|
1086
|
-
# view.
|
1087
|
-
# @return [Array<Types::IncludedProperty>]
|
1088
|
-
#
|
1089
|
-
# @!attribute [rw] last_updated_at
|
1090
|
-
# The date and time when this managed view was last modified.
|
1091
|
-
# @return [Time]
|
1092
|
-
#
|
1093
1442
|
# @!attribute [rw] managed_view_arn
|
1094
1443
|
# The [Amazon resource name (ARN)][1] of the managed view.
|
1095
1444
|
#
|
@@ -1102,19 +1451,19 @@ module Aws::ResourceExplorer2
|
|
1102
1451
|
# The name of the managed view.
|
1103
1452
|
# @return [String]
|
1104
1453
|
#
|
1454
|
+
# @!attribute [rw] trusted_service
|
1455
|
+
# The service principal of the Amazon Web Services service that
|
1456
|
+
# created and manages the managed view.
|
1457
|
+
# @return [String]
|
1458
|
+
#
|
1459
|
+
# @!attribute [rw] last_updated_at
|
1460
|
+
# The date and time when this managed view was last modified.
|
1461
|
+
# @return [Time]
|
1462
|
+
#
|
1105
1463
|
# @!attribute [rw] owner
|
1106
1464
|
# The Amazon Web Services account that owns this managed view.
|
1107
1465
|
# @return [String]
|
1108
1466
|
#
|
1109
|
-
# @!attribute [rw] resource_policy
|
1110
|
-
# The resource policy that defines access to the managed view. To
|
1111
|
-
# learn more about this policy, review [Managed views][1].
|
1112
|
-
#
|
1113
|
-
#
|
1114
|
-
#
|
1115
|
-
# [1]: https://docs.aws.amazon.com/resource-explorer/latest/userguide/aws-managed-views.html
|
1116
|
-
# @return [String]
|
1117
|
-
#
|
1118
1467
|
# @!attribute [rw] scope
|
1119
1468
|
# An [Amazon resource name (ARN)][1] of an Amazon Web Services account
|
1120
1469
|
# or organization that specifies whether this managed view includes
|
@@ -1126,9 +1475,23 @@ module Aws::ResourceExplorer2
|
|
1126
1475
|
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
1127
1476
|
# @return [String]
|
1128
1477
|
#
|
1129
|
-
# @!attribute [rw]
|
1130
|
-
#
|
1131
|
-
#
|
1478
|
+
# @!attribute [rw] included_properties
|
1479
|
+
# A structure that contains additional information about the managed
|
1480
|
+
# view.
|
1481
|
+
# @return [Array<Types::IncludedProperty>]
|
1482
|
+
#
|
1483
|
+
# @!attribute [rw] filters
|
1484
|
+
# A search filter defines which resources can be part of a search
|
1485
|
+
# query result set.
|
1486
|
+
# @return [Types::SearchFilter]
|
1487
|
+
#
|
1488
|
+
# @!attribute [rw] resource_policy
|
1489
|
+
# The resource policy that defines access to the managed view. To
|
1490
|
+
# learn more about this policy, review [Managed views][1].
|
1491
|
+
#
|
1492
|
+
#
|
1493
|
+
#
|
1494
|
+
# [1]: https://docs.aws.amazon.com/resource-explorer/latest/userguide/aws-managed-views.html
|
1132
1495
|
# @return [String]
|
1133
1496
|
#
|
1134
1497
|
# @!attribute [rw] version
|
@@ -1138,15 +1501,15 @@ module Aws::ResourceExplorer2
|
|
1138
1501
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/ManagedView AWS API Documentation
|
1139
1502
|
#
|
1140
1503
|
class ManagedView < Struct.new(
|
1141
|
-
:filters,
|
1142
|
-
:included_properties,
|
1143
|
-
:last_updated_at,
|
1144
1504
|
:managed_view_arn,
|
1145
1505
|
:managed_view_name,
|
1506
|
+
:trusted_service,
|
1507
|
+
:last_updated_at,
|
1146
1508
|
:owner,
|
1147
|
-
:resource_policy,
|
1148
1509
|
:scope,
|
1149
|
-
:
|
1510
|
+
:included_properties,
|
1511
|
+
:filters,
|
1512
|
+
:resource_policy,
|
1150
1513
|
:version)
|
1151
1514
|
SENSITIVE = [:filters]
|
1152
1515
|
include Aws::Structure
|
@@ -1160,6 +1523,10 @@ module Aws::ResourceExplorer2
|
|
1160
1523
|
# The account ID for the index.
|
1161
1524
|
# @return [String]
|
1162
1525
|
#
|
1526
|
+
# @!attribute [rw] region
|
1527
|
+
# The Amazon Web Services Region in which the index exists.
|
1528
|
+
# @return [String]
|
1529
|
+
#
|
1163
1530
|
# @!attribute [rw] arn
|
1164
1531
|
# The [Amazon resource name (ARN)][1] of the index.
|
1165
1532
|
#
|
@@ -1168,10 +1535,6 @@ module Aws::ResourceExplorer2
|
|
1168
1535
|
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
1169
1536
|
# @return [String]
|
1170
1537
|
#
|
1171
|
-
# @!attribute [rw] region
|
1172
|
-
# The Amazon Web Services Region in which the index exists.
|
1173
|
-
# @return [String]
|
1174
|
-
#
|
1175
1538
|
# @!attribute [rw] type
|
1176
1539
|
# The type of index. It can be one of the following values:
|
1177
1540
|
#
|
@@ -1189,8 +1552,8 @@ module Aws::ResourceExplorer2
|
|
1189
1552
|
#
|
1190
1553
|
class MemberIndex < Struct.new(
|
1191
1554
|
:account_id,
|
1192
|
-
:arn,
|
1193
1555
|
:region,
|
1556
|
+
:arn,
|
1194
1557
|
:type)
|
1195
1558
|
SENSITIVE = []
|
1196
1559
|
include Aws::Structure
|
@@ -1219,6 +1582,34 @@ module Aws::ResourceExplorer2
|
|
1219
1582
|
include Aws::Structure
|
1220
1583
|
end
|
1221
1584
|
|
1585
|
+
# Contains information about the status of Resource Explorer
|
1586
|
+
# configuration in a specific Amazon Web Services Region.
|
1587
|
+
#
|
1588
|
+
# @!attribute [rw] region
|
1589
|
+
# The Amazon Web Services Region for which this status information
|
1590
|
+
# applies.
|
1591
|
+
# @return [String]
|
1592
|
+
#
|
1593
|
+
# @!attribute [rw] index
|
1594
|
+
# The status information for the Resource Explorer index in this
|
1595
|
+
# Region.
|
1596
|
+
# @return [Types::IndexStatus]
|
1597
|
+
#
|
1598
|
+
# @!attribute [rw] view
|
1599
|
+
# The status information for the Resource Explorer view in this
|
1600
|
+
# Region.
|
1601
|
+
# @return [Types::ViewStatus]
|
1602
|
+
#
|
1603
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/RegionStatus AWS API Documentation
|
1604
|
+
#
|
1605
|
+
class RegionStatus < Struct.new(
|
1606
|
+
:region,
|
1607
|
+
:index,
|
1608
|
+
:view)
|
1609
|
+
SENSITIVE = []
|
1610
|
+
include Aws::Structure
|
1611
|
+
end
|
1612
|
+
|
1222
1613
|
# A resource in Amazon Web Services that Amazon Web Services Resource
|
1223
1614
|
# Explorer has discovered, and for which it has stored information in
|
1224
1615
|
# the index of the Amazon Web Services Region that contains the
|
@@ -1232,22 +1623,10 @@ module Aws::ResourceExplorer2
|
|
1232
1623
|
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
1233
1624
|
# @return [String]
|
1234
1625
|
#
|
1235
|
-
# @!attribute [rw] last_reported_at
|
1236
|
-
# The date and time that Resource Explorer last queried this resource
|
1237
|
-
# and updated the index with the latest information about the
|
1238
|
-
# resource.
|
1239
|
-
# @return [Time]
|
1240
|
-
#
|
1241
1626
|
# @!attribute [rw] owning_account_id
|
1242
1627
|
# The Amazon Web Services account that owns the resource.
|
1243
1628
|
# @return [String]
|
1244
1629
|
#
|
1245
|
-
# @!attribute [rw] properties
|
1246
|
-
# A structure with additional type-specific details about the
|
1247
|
-
# resource. These properties can be added by turning on integration
|
1248
|
-
# between Resource Explorer and other Amazon Web Services services.
|
1249
|
-
# @return [Array<Types::ResourceProperty>]
|
1250
|
-
#
|
1251
1630
|
# @!attribute [rw] region
|
1252
1631
|
# The Amazon Web Services Region in which the resource was created and
|
1253
1632
|
# exists.
|
@@ -1262,16 +1641,28 @@ module Aws::ResourceExplorer2
|
|
1262
1641
|
# responsible for creating and updating it.
|
1263
1642
|
# @return [String]
|
1264
1643
|
#
|
1644
|
+
# @!attribute [rw] last_reported_at
|
1645
|
+
# The date and time that Resource Explorer last queried this resource
|
1646
|
+
# and updated the index with the latest information about the
|
1647
|
+
# resource.
|
1648
|
+
# @return [Time]
|
1649
|
+
#
|
1650
|
+
# @!attribute [rw] properties
|
1651
|
+
# A structure with additional type-specific details about the
|
1652
|
+
# resource. These properties can be added by turning on integration
|
1653
|
+
# between Resource Explorer and other Amazon Web Services services.
|
1654
|
+
# @return [Array<Types::ResourceProperty>]
|
1655
|
+
#
|
1265
1656
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/Resource AWS API Documentation
|
1266
1657
|
#
|
1267
1658
|
class Resource < Struct.new(
|
1268
1659
|
:arn,
|
1269
|
-
:last_reported_at,
|
1270
1660
|
:owning_account_id,
|
1271
|
-
:properties,
|
1272
1661
|
:region,
|
1273
1662
|
:resource_type,
|
1274
|
-
:service
|
1663
|
+
:service,
|
1664
|
+
:last_reported_at,
|
1665
|
+
:properties)
|
1275
1666
|
SENSITIVE = []
|
1276
1667
|
include Aws::Structure
|
1277
1668
|
end
|
@@ -1283,6 +1674,14 @@ module Aws::ResourceExplorer2
|
|
1283
1674
|
#
|
1284
1675
|
# This field is included in every page when you paginate the results.
|
1285
1676
|
#
|
1677
|
+
# @!attribute [rw] total_resources
|
1678
|
+
# The number of resources that match the search query. This value
|
1679
|
+
# can't exceed 1,000. If there are more than 1,000 resources that
|
1680
|
+
# match the query, then only 1,000 are counted and the `Complete`
|
1681
|
+
# field is set to false. We recommend that you refine your query to
|
1682
|
+
# return a smaller number of results.
|
1683
|
+
# @return [Integer]
|
1684
|
+
#
|
1286
1685
|
# @!attribute [rw] complete
|
1287
1686
|
# Indicates whether the `TotalResources` value represents an
|
1288
1687
|
# exhaustive count of search results.
|
@@ -1294,19 +1693,11 @@ module Aws::ResourceExplorer2
|
|
1294
1693
|
# results, and stopped counting.
|
1295
1694
|
# @return [Boolean]
|
1296
1695
|
#
|
1297
|
-
# @!attribute [rw] total_resources
|
1298
|
-
# The number of resources that match the search query. This value
|
1299
|
-
# can't exceed 1,000. If there are more than 1,000 resources that
|
1300
|
-
# match the query, then only 1,000 are counted and the `Complete`
|
1301
|
-
# field is set to false. We recommend that you refine your query to
|
1302
|
-
# return a smaller number of results.
|
1303
|
-
# @return [Integer]
|
1304
|
-
#
|
1305
1696
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/ResourceCount AWS API Documentation
|
1306
1697
|
#
|
1307
1698
|
class ResourceCount < Struct.new(
|
1308
|
-
:
|
1309
|
-
:
|
1699
|
+
:total_resources,
|
1700
|
+
:complete)
|
1310
1701
|
SENSITIVE = []
|
1311
1702
|
include Aws::Structure
|
1312
1703
|
end
|
@@ -1327,26 +1718,26 @@ module Aws::ResourceExplorer2
|
|
1327
1718
|
|
1328
1719
|
# A structure that describes a property of a resource.
|
1329
1720
|
#
|
1330
|
-
# @!attribute [rw]
|
1331
|
-
#
|
1332
|
-
#
|
1333
|
-
# @return [Hash,Array,String,Numeric,Boolean]
|
1721
|
+
# @!attribute [rw] name
|
1722
|
+
# The name of this property of the resource.
|
1723
|
+
# @return [String]
|
1334
1724
|
#
|
1335
1725
|
# @!attribute [rw] last_reported_at
|
1336
1726
|
# The date and time that the information about this resource property
|
1337
1727
|
# was last updated.
|
1338
1728
|
# @return [Time]
|
1339
1729
|
#
|
1340
|
-
# @!attribute [rw]
|
1341
|
-
# The
|
1342
|
-
#
|
1730
|
+
# @!attribute [rw] data
|
1731
|
+
# Details about this property. The content of this field is a JSON
|
1732
|
+
# object that varies based on the resource type.
|
1733
|
+
# @return [Hash,Array,String,Numeric,Boolean]
|
1343
1734
|
#
|
1344
1735
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/ResourceProperty AWS API Documentation
|
1345
1736
|
#
|
1346
1737
|
class ResourceProperty < Struct.new(
|
1347
|
-
:
|
1738
|
+
:name,
|
1348
1739
|
:last_reported_at,
|
1349
|
-
:
|
1740
|
+
:data)
|
1350
1741
|
SENSITIVE = []
|
1351
1742
|
include Aws::Structure
|
1352
1743
|
end
|
@@ -1372,31 +1763,6 @@ module Aws::ResourceExplorer2
|
|
1372
1763
|
include Aws::Structure
|
1373
1764
|
end
|
1374
1765
|
|
1375
|
-
# @!attribute [rw] max_results
|
1376
|
-
# The maximum number of results that you want included on each page of
|
1377
|
-
# the response. If you do not include this parameter, it defaults to a
|
1378
|
-
# value appropriate to the operation. If additional items exist beyond
|
1379
|
-
# those included in the current response, the `NextToken` response
|
1380
|
-
# element is present and has a value (is not null). Include that value
|
1381
|
-
# as the `NextToken` request parameter in the next call to the
|
1382
|
-
# operation to get the next part of the results.
|
1383
|
-
#
|
1384
|
-
# <note markdown="1"> An API operation can return fewer results than the maximum even when
|
1385
|
-
# there are more results available. You should check `NextToken` after
|
1386
|
-
# every operation to ensure that you receive all of the results.
|
1387
|
-
#
|
1388
|
-
# </note>
|
1389
|
-
# @return [Integer]
|
1390
|
-
#
|
1391
|
-
# @!attribute [rw] next_token
|
1392
|
-
# The parameter for receiving additional results if you receive a
|
1393
|
-
# `NextToken` response in a previous request. A `NextToken` response
|
1394
|
-
# indicates that more output is available. Set this parameter to the
|
1395
|
-
# value of the previous call's `NextToken` response to indicate where
|
1396
|
-
# the output should continue from. The pagination tokens expire after
|
1397
|
-
# 24 hours.
|
1398
|
-
# @return [String]
|
1399
|
-
#
|
1400
1766
|
# @!attribute [rw] query_string
|
1401
1767
|
# A string that includes keywords and filters that specify the
|
1402
1768
|
# resources that you want to include in the results.
|
@@ -1418,6 +1784,22 @@ module Aws::ResourceExplorer2
|
|
1418
1784
|
# [1]: https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html
|
1419
1785
|
# @return [String]
|
1420
1786
|
#
|
1787
|
+
# @!attribute [rw] max_results
|
1788
|
+
# The maximum number of results that you want included on each page of
|
1789
|
+
# the response. If you do not include this parameter, it defaults to a
|
1790
|
+
# value appropriate to the operation. If additional items exist beyond
|
1791
|
+
# those included in the current response, the `NextToken` response
|
1792
|
+
# element is present and has a value (is not null). Include that value
|
1793
|
+
# as the `NextToken` request parameter in the next call to the
|
1794
|
+
# operation to get the next part of the results.
|
1795
|
+
#
|
1796
|
+
# <note markdown="1"> An API operation can return fewer results than the maximum even when
|
1797
|
+
# there are more results available. You should check `NextToken` after
|
1798
|
+
# every operation to ensure that you receive all of the results.
|
1799
|
+
#
|
1800
|
+
# </note>
|
1801
|
+
# @return [Integer]
|
1802
|
+
#
|
1421
1803
|
# @!attribute [rw] view_arn
|
1422
1804
|
# Specifies the [Amazon resource name (ARN)][1] of the view to use for
|
1423
1805
|
# the query. If you don't specify a value for this parameter, then
|
@@ -1432,20 +1814,30 @@ module Aws::ResourceExplorer2
|
|
1432
1814
|
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
1433
1815
|
# @return [String]
|
1434
1816
|
#
|
1817
|
+
# @!attribute [rw] next_token
|
1818
|
+
# The parameter for receiving additional results if you receive a
|
1819
|
+
# `NextToken` response in a previous request. A `NextToken` response
|
1820
|
+
# indicates that more output is available. Set this parameter to the
|
1821
|
+
# value of the previous call's `NextToken` response to indicate where
|
1822
|
+
# the output should continue from. The pagination tokens expire after
|
1823
|
+
# 24 hours.
|
1824
|
+
# @return [String]
|
1825
|
+
#
|
1435
1826
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/SearchInput AWS API Documentation
|
1436
1827
|
#
|
1437
1828
|
class SearchInput < Struct.new(
|
1438
|
-
:max_results,
|
1439
|
-
:next_token,
|
1440
1829
|
:query_string,
|
1441
|
-
:
|
1830
|
+
:max_results,
|
1831
|
+
:view_arn,
|
1832
|
+
:next_token)
|
1442
1833
|
SENSITIVE = [:query_string]
|
1443
1834
|
include Aws::Structure
|
1444
1835
|
end
|
1445
1836
|
|
1446
|
-
# @!attribute [rw]
|
1447
|
-
# The
|
1448
|
-
#
|
1837
|
+
# @!attribute [rw] resources
|
1838
|
+
# The list of structures that describe the resources that match the
|
1839
|
+
# query.
|
1840
|
+
# @return [Array<Types::Resource>]
|
1449
1841
|
#
|
1450
1842
|
# @!attribute [rw] next_token
|
1451
1843
|
# If present, indicates that more output is available than is included
|
@@ -1456,11 +1848,6 @@ module Aws::ResourceExplorer2
|
|
1456
1848
|
# hours.
|
1457
1849
|
# @return [String]
|
1458
1850
|
#
|
1459
|
-
# @!attribute [rw] resources
|
1460
|
-
# The list of structures that describe the resources that match the
|
1461
|
-
# query.
|
1462
|
-
# @return [Array<Types::Resource>]
|
1463
|
-
#
|
1464
1851
|
# @!attribute [rw] view_arn
|
1465
1852
|
# The [Amazon resource name (ARN)][1] of the view that this operation
|
1466
1853
|
# used to perform the search.
|
@@ -1470,13 +1857,17 @@ module Aws::ResourceExplorer2
|
|
1470
1857
|
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
1471
1858
|
# @return [String]
|
1472
1859
|
#
|
1860
|
+
# @!attribute [rw] count
|
1861
|
+
# The number of resources that match the query.
|
1862
|
+
# @return [Types::ResourceCount]
|
1863
|
+
#
|
1473
1864
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/SearchOutput AWS API Documentation
|
1474
1865
|
#
|
1475
1866
|
class SearchOutput < Struct.new(
|
1476
|
-
:count,
|
1477
|
-
:next_token,
|
1478
1867
|
:resources,
|
1479
|
-
:
|
1868
|
+
:next_token,
|
1869
|
+
:view_arn,
|
1870
|
+
:count)
|
1480
1871
|
SENSITIVE = []
|
1481
1872
|
include Aws::Structure
|
1482
1873
|
end
|
@@ -1504,43 +1895,105 @@ module Aws::ResourceExplorer2
|
|
1504
1895
|
include Aws::Structure
|
1505
1896
|
end
|
1506
1897
|
|
1507
|
-
#
|
1508
|
-
#
|
1898
|
+
# Contains the configuration and properties of a Resource Explorer
|
1899
|
+
# service view.
|
1509
1900
|
#
|
1510
|
-
# @!attribute [rw]
|
1511
|
-
# The
|
1901
|
+
# @!attribute [rw] service_view_arn
|
1902
|
+
# The Amazon Resource Name (ARN) of the service view.
|
1903
|
+
# @return [String]
|
1904
|
+
#
|
1905
|
+
# @!attribute [rw] filters
|
1906
|
+
# A search filter defines which resources can be part of a search
|
1907
|
+
# query result set.
|
1908
|
+
# @return [Types::SearchFilter]
|
1909
|
+
#
|
1910
|
+
# @!attribute [rw] included_properties
|
1911
|
+
# A list of additional resource properties that are included in this
|
1912
|
+
# view for search and filtering purposes.
|
1913
|
+
# @return [Array<Types::IncludedProperty>]
|
1914
|
+
#
|
1915
|
+
# @!attribute [rw] streaming_access_for_service
|
1916
|
+
# The Amazon Web Services service that has streaming access to this
|
1917
|
+
# view's data.
|
1918
|
+
# @return [String]
|
1919
|
+
#
|
1920
|
+
# @!attribute [rw] scope_type
|
1921
|
+
# The scope type of the service view, which determines what resources
|
1922
|
+
# are included.
|
1512
1923
|
# @return [String]
|
1513
1924
|
#
|
1925
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/ServiceView AWS API Documentation
|
1926
|
+
#
|
1927
|
+
class ServiceView < Struct.new(
|
1928
|
+
:service_view_arn,
|
1929
|
+
:filters,
|
1930
|
+
:included_properties,
|
1931
|
+
:streaming_access_for_service,
|
1932
|
+
:scope_type)
|
1933
|
+
SENSITIVE = [:filters]
|
1934
|
+
include Aws::Structure
|
1935
|
+
end
|
1936
|
+
|
1937
|
+
# Contains information about an Amazon Web Services service that has
|
1938
|
+
# been granted streaming access to your Resource Explorer data.
|
1939
|
+
#
|
1940
|
+
# @!attribute [rw] service_principal
|
1941
|
+
# The service principal of the Amazon Web Services service that has
|
1942
|
+
# streaming access to your Resource Explorer data. A service principal
|
1943
|
+
# is a unique identifier for an Amazon Web Services service.
|
1944
|
+
# @return [String]
|
1945
|
+
#
|
1946
|
+
# @!attribute [rw] created_at
|
1947
|
+
# The date and time when streaming access was granted to the Amazon
|
1948
|
+
# Web Services service, in ISO 8601 format.
|
1949
|
+
# @return [Time]
|
1950
|
+
#
|
1951
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/StreamingAccessDetails AWS API Documentation
|
1952
|
+
#
|
1953
|
+
class StreamingAccessDetails < Struct.new(
|
1954
|
+
:service_principal,
|
1955
|
+
:created_at)
|
1956
|
+
SENSITIVE = []
|
1957
|
+
include Aws::Structure
|
1958
|
+
end
|
1959
|
+
|
1960
|
+
# A structure that describes a resource type supported by Amazon Web
|
1961
|
+
# Services Resource Explorer.
|
1962
|
+
#
|
1514
1963
|
# @!attribute [rw] service
|
1515
1964
|
# The Amazon Web Services service that is associated with the resource
|
1516
1965
|
# type. This is the primary service that lets you create and interact
|
1517
1966
|
# with resources of this type.
|
1518
1967
|
# @return [String]
|
1519
1968
|
#
|
1969
|
+
# @!attribute [rw] resource_type
|
1970
|
+
# The unique identifier of the resource type.
|
1971
|
+
# @return [String]
|
1972
|
+
#
|
1520
1973
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/SupportedResourceType AWS API Documentation
|
1521
1974
|
#
|
1522
1975
|
class SupportedResourceType < Struct.new(
|
1523
|
-
:
|
1524
|
-
:
|
1976
|
+
:service,
|
1977
|
+
:resource_type)
|
1525
1978
|
SENSITIVE = []
|
1526
1979
|
include Aws::Structure
|
1527
1980
|
end
|
1528
1981
|
|
1529
|
-
# @!attribute [rw] tags
|
1530
|
-
# A list of tag key and value pairs that you want to attach to the
|
1531
|
-
# specified view or index.
|
1532
|
-
# @return [Hash<String,String>]
|
1533
|
-
#
|
1534
1982
|
# @!attribute [rw] resource_arn
|
1535
1983
|
# The Amazon Resource Name (ARN) of the view or index that you want to
|
1536
1984
|
# attach tags to.
|
1537
1985
|
# @return [String]
|
1538
1986
|
#
|
1987
|
+
# @!attribute [rw] tags
|
1988
|
+
# A list of tag key and value pairs that you want to attach to the
|
1989
|
+
# specified view or index.
|
1990
|
+
# @return [Hash<String,String>]
|
1991
|
+
#
|
1539
1992
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/TagResourceInput AWS API Documentation
|
1540
1993
|
#
|
1541
1994
|
class TagResourceInput < Struct.new(
|
1542
|
-
:
|
1543
|
-
:
|
1995
|
+
:resource_arn,
|
1996
|
+
:tags)
|
1544
1997
|
SENSITIVE = [:tags]
|
1545
1998
|
include Aws::Structure
|
1546
1999
|
end
|
@@ -1641,9 +2094,10 @@ module Aws::ResourceExplorer2
|
|
1641
2094
|
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
1642
2095
|
# @return [String]
|
1643
2096
|
#
|
1644
|
-
# @!attribute [rw]
|
1645
|
-
#
|
1646
|
-
#
|
2097
|
+
# @!attribute [rw] type
|
2098
|
+
# Specifies the type of the specified index after the operation
|
2099
|
+
# completes.
|
2100
|
+
# @return [String]
|
1647
2101
|
#
|
1648
2102
|
# @!attribute [rw] state
|
1649
2103
|
# Indicates the state of the request to update the index. This
|
@@ -1651,22 +2105,39 @@ module Aws::ResourceExplorer2
|
|
1651
2105
|
# changes.
|
1652
2106
|
# @return [String]
|
1653
2107
|
#
|
1654
|
-
# @!attribute [rw]
|
1655
|
-
#
|
1656
|
-
#
|
1657
|
-
# @return [String]
|
2108
|
+
# @!attribute [rw] last_updated_at
|
2109
|
+
# The date and timestamp when the index was last updated.
|
2110
|
+
# @return [Time]
|
1658
2111
|
#
|
1659
2112
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/UpdateIndexTypeOutput AWS API Documentation
|
1660
2113
|
#
|
1661
2114
|
class UpdateIndexTypeOutput < Struct.new(
|
1662
2115
|
:arn,
|
1663
|
-
:
|
2116
|
+
:type,
|
1664
2117
|
:state,
|
1665
|
-
:
|
2118
|
+
:last_updated_at)
|
1666
2119
|
SENSITIVE = []
|
1667
2120
|
include Aws::Structure
|
1668
2121
|
end
|
1669
2122
|
|
2123
|
+
# @!attribute [rw] view_arn
|
2124
|
+
# The [Amazon resource name (ARN)][1] of the view that you want to
|
2125
|
+
# modify.
|
2126
|
+
#
|
2127
|
+
#
|
2128
|
+
#
|
2129
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
2130
|
+
# @return [String]
|
2131
|
+
#
|
2132
|
+
# @!attribute [rw] included_properties
|
2133
|
+
# Specifies optional fields that you want included in search results
|
2134
|
+
# from this view. It is a list of objects that each describe a field
|
2135
|
+
# to include.
|
2136
|
+
#
|
2137
|
+
# The default is an empty list, with no optional fields included in
|
2138
|
+
# the results.
|
2139
|
+
# @return [Array<Types::IncludedProperty>]
|
2140
|
+
#
|
1670
2141
|
# @!attribute [rw] filters
|
1671
2142
|
# An array of strings that specify which resources are included in the
|
1672
2143
|
# results of queries made using this view. When you use this view in a
|
@@ -1691,30 +2162,12 @@ module Aws::ResourceExplorer2
|
|
1691
2162
|
# [3]: https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html#query-syntax-operators
|
1692
2163
|
# @return [Types::SearchFilter]
|
1693
2164
|
#
|
1694
|
-
# @!attribute [rw] included_properties
|
1695
|
-
# Specifies optional fields that you want included in search results
|
1696
|
-
# from this view. It is a list of objects that each describe a field
|
1697
|
-
# to include.
|
1698
|
-
#
|
1699
|
-
# The default is an empty list, with no optional fields included in
|
1700
|
-
# the results.
|
1701
|
-
# @return [Array<Types::IncludedProperty>]
|
1702
|
-
#
|
1703
|
-
# @!attribute [rw] view_arn
|
1704
|
-
# The [Amazon resource name (ARN)][1] of the view that you want to
|
1705
|
-
# modify.
|
1706
|
-
#
|
1707
|
-
#
|
1708
|
-
#
|
1709
|
-
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
1710
|
-
# @return [String]
|
1711
|
-
#
|
1712
2165
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/UpdateViewInput AWS API Documentation
|
1713
2166
|
#
|
1714
2167
|
class UpdateViewInput < Struct.new(
|
1715
|
-
:
|
2168
|
+
:view_arn,
|
1716
2169
|
:included_properties,
|
1717
|
-
:
|
2170
|
+
:filters)
|
1718
2171
|
SENSITIVE = [:filters]
|
1719
2172
|
include Aws::Structure
|
1720
2173
|
end
|
@@ -1734,18 +2187,18 @@ module Aws::ResourceExplorer2
|
|
1734
2187
|
# You provided an invalid value for one of the operation's parameters.
|
1735
2188
|
# Check the syntax for the operation, and try again.
|
1736
2189
|
#
|
2190
|
+
# @!attribute [rw] message
|
2191
|
+
# @return [String]
|
2192
|
+
#
|
1737
2193
|
# @!attribute [rw] field_list
|
1738
2194
|
# An array of the request fields that had validation errors.
|
1739
2195
|
# @return [Array<Types::ValidationExceptionField>]
|
1740
2196
|
#
|
1741
|
-
# @!attribute [rw] message
|
1742
|
-
# @return [String]
|
1743
|
-
#
|
1744
2197
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/ValidationException AWS API Documentation
|
1745
2198
|
#
|
1746
2199
|
class ValidationException < Struct.new(
|
1747
|
-
:
|
1748
|
-
:
|
2200
|
+
:message,
|
2201
|
+
:field_list)
|
1749
2202
|
SENSITIVE = []
|
1750
2203
|
include Aws::Structure
|
1751
2204
|
end
|
@@ -1778,23 +2231,22 @@ module Aws::ResourceExplorer2
|
|
1778
2231
|
# also create a second view that includes only resources that are tagged
|
1779
2232
|
# with "ENV" and "PRODUCTION".
|
1780
2233
|
#
|
1781
|
-
# @!attribute [rw]
|
1782
|
-
#
|
1783
|
-
# included in the results of queries made using this view.
|
1784
|
-
# @return [Types::SearchFilter]
|
2234
|
+
# @!attribute [rw] view_arn
|
2235
|
+
# The [Amazon resource name (ARN)][1] of the view.
|
1785
2236
|
#
|
1786
|
-
# @!attribute [rw] included_properties
|
1787
|
-
# A structure that contains additional information about the view.
|
1788
|
-
# @return [Array<Types::IncludedProperty>]
|
1789
2237
|
#
|
1790
|
-
#
|
1791
|
-
#
|
1792
|
-
# @return [
|
2238
|
+
#
|
2239
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
2240
|
+
# @return [String]
|
1793
2241
|
#
|
1794
2242
|
# @!attribute [rw] owner
|
1795
2243
|
# The Amazon Web Services account that owns this view.
|
1796
2244
|
# @return [String]
|
1797
2245
|
#
|
2246
|
+
# @!attribute [rw] last_updated_at
|
2247
|
+
# The date and time when this view was last modified.
|
2248
|
+
# @return [Time]
|
2249
|
+
#
|
1798
2250
|
# @!attribute [rw] scope
|
1799
2251
|
# An [Amazon resource name (ARN)][1] of an Amazon Web Services
|
1800
2252
|
# account, an organization, or an organizational unit (OU) that
|
@@ -1810,27 +2262,61 @@ module Aws::ResourceExplorer2
|
|
1810
2262
|
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
1811
2263
|
# @return [String]
|
1812
2264
|
#
|
1813
|
-
# @!attribute [rw]
|
1814
|
-
#
|
1815
|
-
#
|
1816
|
-
#
|
2265
|
+
# @!attribute [rw] included_properties
|
2266
|
+
# A structure that contains additional information about the view.
|
2267
|
+
# @return [Array<Types::IncludedProperty>]
|
1817
2268
|
#
|
1818
|
-
#
|
1819
|
-
#
|
2269
|
+
# @!attribute [rw] filters
|
2270
|
+
# An array of SearchFilter objects that specify which resources can be
|
2271
|
+
# included in the results of queries made using this view.
|
2272
|
+
# @return [Types::SearchFilter]
|
1820
2273
|
#
|
1821
2274
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/View AWS API Documentation
|
1822
2275
|
#
|
1823
2276
|
class View < Struct.new(
|
1824
|
-
:
|
1825
|
-
:included_properties,
|
1826
|
-
:last_updated_at,
|
2277
|
+
:view_arn,
|
1827
2278
|
:owner,
|
2279
|
+
:last_updated_at,
|
1828
2280
|
:scope,
|
1829
|
-
:
|
2281
|
+
:included_properties,
|
2282
|
+
:filters)
|
1830
2283
|
SENSITIVE = [:filters]
|
1831
2284
|
include Aws::Structure
|
1832
2285
|
end
|
1833
2286
|
|
2287
|
+
# Contains information about the status of a Resource Explorer view
|
2288
|
+
# operation in a specific Region.
|
2289
|
+
#
|
2290
|
+
# @!attribute [rw] status
|
2291
|
+
# The current status of the view operation. Valid values are
|
2292
|
+
# `SUCCEEDED`, `FAILED`, `IN_PROGRESS`, or `SKIPPED`.
|
2293
|
+
# @return [String]
|
2294
|
+
#
|
2295
|
+
# @!attribute [rw] view
|
2296
|
+
# A view is a structure that defines a set of filters that provide a
|
2297
|
+
# view into the information in the Amazon Web Services Resource
|
2298
|
+
# Explorer index. The filters specify which information from the index
|
2299
|
+
# is visible to the users of the view. For example, you can specify
|
2300
|
+
# filters that include only resources that are tagged with the key
|
2301
|
+
# "ENV" and the value "DEVELOPMENT" in the results returned by
|
2302
|
+
# this view. You could also create a second view that includes only
|
2303
|
+
# resources that are tagged with "ENV" and "PRODUCTION".
|
2304
|
+
# @return [Types::View]
|
2305
|
+
#
|
2306
|
+
# @!attribute [rw] error_details
|
2307
|
+
# Details about any error that occurred during the view operation.
|
2308
|
+
# @return [Types::ErrorDetails]
|
2309
|
+
#
|
2310
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/ViewStatus AWS API Documentation
|
2311
|
+
#
|
2312
|
+
class ViewStatus < Struct.new(
|
2313
|
+
:status,
|
2314
|
+
:view,
|
2315
|
+
:error_details)
|
2316
|
+
SENSITIVE = []
|
2317
|
+
include Aws::Structure
|
2318
|
+
end
|
2319
|
+
|
1834
2320
|
end
|
1835
2321
|
end
|
1836
2322
|
|