aws-sdk-resourceexplorer2 1.0.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.
@@ -0,0 +1,1554 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ module Aws::ResourceExplorer2
11
+ module Types
12
+
13
+ # The credentials that you used to call this operation don't have the
14
+ # minimum required permissions.
15
+ #
16
+ # @!attribute [rw] message
17
+ # @return [String]
18
+ #
19
+ # @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/AccessDeniedException AWS API Documentation
20
+ #
21
+ class AccessDeniedException < Struct.new(
22
+ :message)
23
+ SENSITIVE = []
24
+ include Aws::Structure
25
+ end
26
+
27
+ # @note When making an API call, you may pass AssociateDefaultViewInput
28
+ # data as a hash:
29
+ #
30
+ # {
31
+ # view_arn: "AssociateDefaultViewInputViewArnString", # required
32
+ # }
33
+ #
34
+ # @!attribute [rw] view_arn
35
+ # The [Amazon resource name (ARN)][1] of the view to set as the
36
+ # default for the Amazon Web Services Region and Amazon Web Services
37
+ # account in which you call this operation. The specified view must
38
+ # already exist in the called Region.
39
+ #
40
+ #
41
+ #
42
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
43
+ # @return [String]
44
+ #
45
+ # @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/AssociateDefaultViewInput AWS API Documentation
46
+ #
47
+ class AssociateDefaultViewInput < Struct.new(
48
+ :view_arn)
49
+ SENSITIVE = []
50
+ include Aws::Structure
51
+ end
52
+
53
+ # @!attribute [rw] view_arn
54
+ # The [Amazon resource name (ARN)][1] of the view that the operation
55
+ # set as the default for queries made in the Amazon Web Services
56
+ # Region and Amazon Web Services account in which you called this
57
+ # operation.
58
+ #
59
+ #
60
+ #
61
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
62
+ # @return [String]
63
+ #
64
+ # @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/AssociateDefaultViewOutput AWS API Documentation
65
+ #
66
+ class AssociateDefaultViewOutput < Struct.new(
67
+ :view_arn)
68
+ SENSITIVE = []
69
+ include Aws::Structure
70
+ end
71
+
72
+ # A collection of error messages for any views that Amazon Web Services
73
+ # Resource Explorer couldn't retrieve details.
74
+ #
75
+ # @!attribute [rw] error_message
76
+ # The description of the error for the specified view.
77
+ # @return [String]
78
+ #
79
+ # @!attribute [rw] view_arn
80
+ # The [Amazon resource name (ARN)][1] of the view for which Resource
81
+ # Explorer failed to retrieve details.
82
+ #
83
+ #
84
+ #
85
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
86
+ # @return [String]
87
+ #
88
+ # @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/BatchGetViewError AWS API Documentation
89
+ #
90
+ class BatchGetViewError < Struct.new(
91
+ :error_message,
92
+ :view_arn)
93
+ SENSITIVE = []
94
+ include Aws::Structure
95
+ end
96
+
97
+ # @note When making an API call, you may pass BatchGetViewInput
98
+ # data as a hash:
99
+ #
100
+ # {
101
+ # view_arns: ["String"],
102
+ # }
103
+ #
104
+ # @!attribute [rw] view_arns
105
+ # A list of [Amazon resource names (ARNs)][1] that identify the views
106
+ # you want details for.
107
+ #
108
+ #
109
+ #
110
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
111
+ # @return [Array<String>]
112
+ #
113
+ # @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/BatchGetViewInput AWS API Documentation
114
+ #
115
+ class BatchGetViewInput < Struct.new(
116
+ :view_arns)
117
+ SENSITIVE = []
118
+ include Aws::Structure
119
+ end
120
+
121
+ # @!attribute [rw] errors
122
+ # If any of the specified ARNs result in an error, then this structure
123
+ # describes the error.
124
+ # @return [Array<Types::BatchGetViewError>]
125
+ #
126
+ # @!attribute [rw] views
127
+ # A structure with a list of objects with details for each of the
128
+ # specified views.
129
+ # @return [Array<Types::View>]
130
+ #
131
+ # @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/BatchGetViewOutput AWS API Documentation
132
+ #
133
+ class BatchGetViewOutput < Struct.new(
134
+ :errors,
135
+ :views)
136
+ SENSITIVE = []
137
+ include Aws::Structure
138
+ end
139
+
140
+ # You tried to create a new view or index when one already exists, and
141
+ # you either didn't specify or specified a different idempotency token
142
+ # as the original request.
143
+ #
144
+ # @!attribute [rw] message
145
+ # @return [String]
146
+ #
147
+ # @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/ConflictException AWS API Documentation
148
+ #
149
+ class ConflictException < Struct.new(
150
+ :message)
151
+ SENSITIVE = []
152
+ include Aws::Structure
153
+ end
154
+
155
+ # @note When making an API call, you may pass CreateIndexInput
156
+ # data as a hash:
157
+ #
158
+ # {
159
+ # client_token: "String",
160
+ # tags: {
161
+ # "String" => "String",
162
+ # },
163
+ # }
164
+ #
165
+ # @!attribute [rw] client_token
166
+ # This value helps ensure idempotency. Resource Explorer uses this
167
+ # value to prevent the accidental creation of duplicate versions. We
168
+ # recommend that you generate a [UUID-type value][1] to ensure the
169
+ # uniqueness of your views.
170
+ #
171
+ # **A suitable default value is auto-generated.** You should normally
172
+ # not need to pass this option.
173
+ #
174
+ #
175
+ #
176
+ # [1]: https://wikipedia.org/wiki/Universally_unique_identifier
177
+ # @return [String]
178
+ #
179
+ # @!attribute [rw] tags
180
+ # The specified tags are attached only to the index created in this
181
+ # Amazon Web Services Region. The tags aren't attached to any of the
182
+ # resources listed in the index.
183
+ # @return [Hash<String,String>]
184
+ #
185
+ # @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/CreateIndexInput AWS API Documentation
186
+ #
187
+ class CreateIndexInput < Struct.new(
188
+ :client_token,
189
+ :tags)
190
+ SENSITIVE = []
191
+ include Aws::Structure
192
+ end
193
+
194
+ # @!attribute [rw] arn
195
+ # The ARN of the new local index for the Region. You can reference
196
+ # this ARN in IAM permission policies to authorize the following
197
+ # operations: DeleteIndex \| GetIndex \| UpdateIndexType \| CreateView
198
+ # @return [String]
199
+ #
200
+ # @!attribute [rw] created_at
201
+ # The date and timestamp when the index was created.
202
+ # @return [Time]
203
+ #
204
+ # @!attribute [rw] state
205
+ # Indicates the current state of the index. You can check for changes
206
+ # to the state for asynchronous operations by calling the GetIndex
207
+ # operation.
208
+ #
209
+ # <note markdown="1"> The state can remain in the `CREATING` or `UPDATING` state for
210
+ # several hours as Resource Explorer discovers the information about
211
+ # your resources and populates the index.
212
+ #
213
+ # </note>
214
+ # @return [String]
215
+ #
216
+ # @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/CreateIndexOutput AWS API Documentation
217
+ #
218
+ class CreateIndexOutput < Struct.new(
219
+ :arn,
220
+ :created_at,
221
+ :state)
222
+ SENSITIVE = []
223
+ include Aws::Structure
224
+ end
225
+
226
+ # @note When making an API call, you may pass CreateViewInput
227
+ # data as a hash:
228
+ #
229
+ # {
230
+ # client_token: "CreateViewInputClientTokenString",
231
+ # filters: {
232
+ # filter_string: "SearchFilterFilterStringString", # required
233
+ # },
234
+ # included_properties: [
235
+ # {
236
+ # name: "IncludedPropertyNameString", # required
237
+ # },
238
+ # ],
239
+ # tags: {
240
+ # "String" => "String",
241
+ # },
242
+ # view_name: "ViewName", # required
243
+ # }
244
+ #
245
+ # @!attribute [rw] client_token
246
+ # This value helps ensure idempotency. Resource Explorer uses this
247
+ # value to prevent the accidental creation of duplicate versions. We
248
+ # recommend that you generate a [UUID-type value][1] to ensure the
249
+ # uniqueness of your views.
250
+ #
251
+ # **A suitable default value is auto-generated.** You should normally
252
+ # not need to pass this option.
253
+ #
254
+ #
255
+ #
256
+ # [1]: https://wikipedia.org/wiki/Universally_unique_identifier
257
+ # @return [String]
258
+ #
259
+ # @!attribute [rw] filters
260
+ # An array of strings that specify which resources are included in the
261
+ # results of queries made using this view. When you use this view in a
262
+ # Search operation, the filter string is combined with the search's
263
+ # `QueryString` parameter using a logical `AND` operator.
264
+ #
265
+ # For information about the supported syntax, see [Search query
266
+ # reference for Resource Explorer][1] in the *Amazon Web Services
267
+ # Resource Explorer User Guide*.
268
+ #
269
+ # This query string in the context of this operation supports only
270
+ # [filter prefixes][2] with optional [operators][3]. It doesn't
271
+ # support free-form text. For example, the string `region:us*
272
+ # service:ec2 -tag:stage=prod` includes all Amazon EC2 resources in
273
+ # any Amazon Web Services Region that begins with the letters `us` and
274
+ # is *not* tagged with a key `Stage` that has the value `prod`.
275
+ #
276
+ #
277
+ #
278
+ # [1]: https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html
279
+ # [2]: https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html#query-syntax-filters
280
+ # [3]: https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html#query-syntax-operators
281
+ # @return [Types::SearchFilter]
282
+ #
283
+ # @!attribute [rw] included_properties
284
+ # Specifies optional fields that you want included in search results
285
+ # from this view. It is a list of objects that each describe a field
286
+ # to include.
287
+ #
288
+ # The default is an empty list, with no optional fields included in
289
+ # the results.
290
+ # @return [Array<Types::IncludedProperty>]
291
+ #
292
+ # @!attribute [rw] tags
293
+ # Tag key and value pairs that are attached to the view.
294
+ # @return [Hash<String,String>]
295
+ #
296
+ # @!attribute [rw] view_name
297
+ # The name of the new view. This name appears in the list of views in
298
+ # Resource Explorer.
299
+ #
300
+ # The name must be no more than 64 characters long, and can include
301
+ # letters, digits, and the dash (-) character. The name must be unique
302
+ # within its Amazon Web Services Region.
303
+ # @return [String]
304
+ #
305
+ # @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/CreateViewInput AWS API Documentation
306
+ #
307
+ class CreateViewInput < Struct.new(
308
+ :client_token,
309
+ :filters,
310
+ :included_properties,
311
+ :tags,
312
+ :view_name)
313
+ SENSITIVE = [:filters]
314
+ include Aws::Structure
315
+ end
316
+
317
+ # @!attribute [rw] view
318
+ # A structure that contains the details about the new view.
319
+ # @return [Types::View]
320
+ #
321
+ # @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/CreateViewOutput AWS API Documentation
322
+ #
323
+ class CreateViewOutput < Struct.new(
324
+ :view)
325
+ SENSITIVE = []
326
+ include Aws::Structure
327
+ end
328
+
329
+ # @note When making an API call, you may pass DeleteIndexInput
330
+ # data as a hash:
331
+ #
332
+ # {
333
+ # arn: "String", # required
334
+ # }
335
+ #
336
+ # @!attribute [rw] arn
337
+ # The [Amazon resource name (ARN)][1] of the index that you want to
338
+ # delete.
339
+ #
340
+ #
341
+ #
342
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
343
+ # @return [String]
344
+ #
345
+ # @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/DeleteIndexInput AWS API Documentation
346
+ #
347
+ class DeleteIndexInput < Struct.new(
348
+ :arn)
349
+ SENSITIVE = []
350
+ include Aws::Structure
351
+ end
352
+
353
+ # @!attribute [rw] arn
354
+ # The [Amazon resource name (ARN)][1] of the index that you
355
+ # successfully started the deletion process.
356
+ #
357
+ # <note markdown="1"> This operation is asynchronous. To check its status, call the
358
+ # GetIndex operation.
359
+ #
360
+ # </note>
361
+ #
362
+ #
363
+ #
364
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
365
+ # @return [String]
366
+ #
367
+ # @!attribute [rw] last_updated_at
368
+ # The date and time when you last updated this index.
369
+ # @return [Time]
370
+ #
371
+ # @!attribute [rw] state
372
+ # Indicates the current state of the index.
373
+ # @return [String]
374
+ #
375
+ # @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/DeleteIndexOutput AWS API Documentation
376
+ #
377
+ class DeleteIndexOutput < Struct.new(
378
+ :arn,
379
+ :last_updated_at,
380
+ :state)
381
+ SENSITIVE = []
382
+ include Aws::Structure
383
+ end
384
+
385
+ # @note When making an API call, you may pass DeleteViewInput
386
+ # data as a hash:
387
+ #
388
+ # {
389
+ # view_arn: "DeleteViewInputViewArnString", # required
390
+ # }
391
+ #
392
+ # @!attribute [rw] view_arn
393
+ # The [Amazon resource name (ARN)][1] of the view that you want to
394
+ # delete.
395
+ #
396
+ #
397
+ #
398
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
399
+ # @return [String]
400
+ #
401
+ # @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/DeleteViewInput AWS API Documentation
402
+ #
403
+ class DeleteViewInput < Struct.new(
404
+ :view_arn)
405
+ SENSITIVE = []
406
+ include Aws::Structure
407
+ end
408
+
409
+ # @!attribute [rw] view_arn
410
+ # The [Amazon resource name (ARN)][1] of the view that you
411
+ # successfully deleted.
412
+ #
413
+ #
414
+ #
415
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
416
+ # @return [String]
417
+ #
418
+ # @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/DeleteViewOutput AWS API Documentation
419
+ #
420
+ class DeleteViewOutput < Struct.new(
421
+ :view_arn)
422
+ SENSITIVE = []
423
+ include Aws::Structure
424
+ end
425
+
426
+ # @!attribute [rw] view_arn
427
+ # The [Amazon resource name (ARN)][1] of the view that is the current
428
+ # default for the Amazon Web Services Region in which you called this
429
+ # operation.
430
+ #
431
+ #
432
+ #
433
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
434
+ # @return [String]
435
+ #
436
+ # @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/GetDefaultViewOutput AWS API Documentation
437
+ #
438
+ class GetDefaultViewOutput < Struct.new(
439
+ :view_arn)
440
+ SENSITIVE = []
441
+ include Aws::Structure
442
+ end
443
+
444
+ # @!attribute [rw] arn
445
+ # The [Amazon resource name (ARN)][1] of the index.
446
+ #
447
+ #
448
+ #
449
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
450
+ # @return [String]
451
+ #
452
+ # @!attribute [rw] created_at
453
+ # The date and time when the index was originally created.
454
+ # @return [Time]
455
+ #
456
+ # @!attribute [rw] last_updated_at
457
+ # The date and time when the index was last updated.
458
+ # @return [Time]
459
+ #
460
+ # @!attribute [rw] replicating_from
461
+ # If this index is `Type=AGGREGATOR`, then this response value
462
+ # contains a list of the Amazon Web Services Regions that replicate
463
+ # their content to the index in this Region. Not present for a local
464
+ # index.
465
+ # @return [Array<String>]
466
+ #
467
+ # @!attribute [rw] replicating_to
468
+ # Identifies the Amazon Web Services Region that has an index set to
469
+ # `Type=AGGREGATOR`, if one exists. If it does, then the Region you
470
+ # called this operation in replicates its index information to the
471
+ # Region specified in this response value. Not present if there isn't
472
+ # an aggregator index in the account.
473
+ # @return [Array<String>]
474
+ #
475
+ # @!attribute [rw] state
476
+ # Indicates the current state of the index in this Amazon Web Services
477
+ # Region.
478
+ # @return [String]
479
+ #
480
+ # @!attribute [rw] tags
481
+ # Tag key and value pairs that are attached to the index.
482
+ # @return [Hash<String,String>]
483
+ #
484
+ # @!attribute [rw] type
485
+ # Specifies the type of the index in this Region. For information
486
+ # about the aggregator index and how it differs from a local index,
487
+ # see [Turning on cross-Region search by creating an aggregator
488
+ # index][1].
489
+ #
490
+ #
491
+ #
492
+ # [1]: https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-aggregator-region.html
493
+ # @return [String]
494
+ #
495
+ # @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/GetIndexOutput AWS API Documentation
496
+ #
497
+ class GetIndexOutput < Struct.new(
498
+ :arn,
499
+ :created_at,
500
+ :last_updated_at,
501
+ :replicating_from,
502
+ :replicating_to,
503
+ :state,
504
+ :tags,
505
+ :type)
506
+ SENSITIVE = []
507
+ include Aws::Structure
508
+ end
509
+
510
+ # @note When making an API call, you may pass GetViewInput
511
+ # data as a hash:
512
+ #
513
+ # {
514
+ # view_arn: "GetViewInputViewArnString", # required
515
+ # }
516
+ #
517
+ # @!attribute [rw] view_arn
518
+ # The [Amazon resource name (ARN)][1] of the view that you want
519
+ # information about.
520
+ #
521
+ #
522
+ #
523
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
524
+ # @return [String]
525
+ #
526
+ # @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/GetViewInput AWS API Documentation
527
+ #
528
+ class GetViewInput < Struct.new(
529
+ :view_arn)
530
+ SENSITIVE = []
531
+ include Aws::Structure
532
+ end
533
+
534
+ # @!attribute [rw] tags
535
+ # Tag key and value pairs that are attached to the view.
536
+ # @return [Hash<String,String>]
537
+ #
538
+ # @!attribute [rw] view
539
+ # A structure that contains the details for the requested view.
540
+ # @return [Types::View]
541
+ #
542
+ # @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/GetViewOutput AWS API Documentation
543
+ #
544
+ class GetViewOutput < Struct.new(
545
+ :tags,
546
+ :view)
547
+ SENSITIVE = []
548
+ include Aws::Structure
549
+ end
550
+
551
+ # Information about an additional property that describes a resource,
552
+ # that you can optionally include in the view. This lets you view that
553
+ # property in search results, and filter your search results based on
554
+ # the value of the property.
555
+ #
556
+ # @note When making an API call, you may pass IncludedProperty
557
+ # data as a hash:
558
+ #
559
+ # {
560
+ # name: "IncludedPropertyNameString", # required
561
+ # }
562
+ #
563
+ # @!attribute [rw] name
564
+ # The name of the property that is included in this view.
565
+ #
566
+ # You can specify the following property names for this field:
567
+ #
568
+ # * `Tags`
569
+ #
570
+ # ^
571
+ # @return [String]
572
+ #
573
+ # @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/IncludedProperty AWS API Documentation
574
+ #
575
+ class IncludedProperty < Struct.new(
576
+ :name)
577
+ SENSITIVE = []
578
+ include Aws::Structure
579
+ end
580
+
581
+ # An index is the data store used by Amazon Web Services Resource
582
+ # Explorer to hold information about your Amazon Web Services resources
583
+ # that the service discovers. Creating an index in an Amazon Web
584
+ # Services Region turns on Resource Explorer and lets it discover your
585
+ # resources.
586
+ #
587
+ # By default, an index is *local*, meaning that it contains information
588
+ # about resources in only the same Region as the index. However, you can
589
+ # promote the index of one Region in the account by calling
590
+ # UpdateIndexType to convert it into an aggregator index. The aggregator
591
+ # index receives a replicated copy of the index information from all
592
+ # other Regions where Resource Explorer is turned on. This allows search
593
+ # operations in that Region to return results from all Regions in the
594
+ # account.
595
+ #
596
+ # @!attribute [rw] arn
597
+ # The [Amazon resource name (ARN)][1] of the index.
598
+ #
599
+ #
600
+ #
601
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
602
+ # @return [String]
603
+ #
604
+ # @!attribute [rw] region
605
+ # The Amazon Web Services Region in which the index exists.
606
+ # @return [String]
607
+ #
608
+ # @!attribute [rw] type
609
+ # The type of index. It can be one of the following values:
610
+ #
611
+ # * **LOCAL** – The index contains information about resources from
612
+ # only the same Amazon Web Services Region.
613
+ #
614
+ # * **AGGREGATOR** – Resource Explorer replicates copies of the
615
+ # indexed information about resources in all other Amazon Web
616
+ # Services Regions to the aggregator index. This lets search results
617
+ # in the Region with the aggregator index to include resources from
618
+ # all Regions in the account where Resource Explorer is turned on.
619
+ # @return [String]
620
+ #
621
+ # @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/Index AWS API Documentation
622
+ #
623
+ class Index < Struct.new(
624
+ :arn,
625
+ :region,
626
+ :type)
627
+ SENSITIVE = []
628
+ include Aws::Structure
629
+ end
630
+
631
+ # The request failed because of internal service error. Try your request
632
+ # again later.
633
+ #
634
+ # @!attribute [rw] message
635
+ # @return [String]
636
+ #
637
+ # @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/InternalServerException AWS API Documentation
638
+ #
639
+ class InternalServerException < Struct.new(
640
+ :message)
641
+ SENSITIVE = []
642
+ include Aws::Structure
643
+ end
644
+
645
+ # @note When making an API call, you may pass ListIndexesInput
646
+ # data as a hash:
647
+ #
648
+ # {
649
+ # max_results: 1,
650
+ # next_token: "ListIndexesInputNextTokenString",
651
+ # regions: ["String"],
652
+ # type: "LOCAL", # accepts LOCAL, AGGREGATOR
653
+ # }
654
+ #
655
+ # @!attribute [rw] max_results
656
+ # The maximum number of results that you want included on each page of
657
+ # the response. If you do not include this parameter, it defaults to a
658
+ # value appropriate to the operation. If additional items exist beyond
659
+ # those included in the current response, the `NextToken` response
660
+ # element is present and has a value (is not null). Include that value
661
+ # as the `NextToken` request parameter in the next call to the
662
+ # operation to get the next part of the results.
663
+ #
664
+ # <note markdown="1"> An API operation can return fewer results than the maximum even when
665
+ # there are more results available. You should check `NextToken` after
666
+ # every operation to ensure that you receive all of the results.
667
+ #
668
+ # </note>
669
+ # @return [Integer]
670
+ #
671
+ # @!attribute [rw] next_token
672
+ # The parameter for receiving additional results if you receive a
673
+ # `NextToken` response in a previous request. A `NextToken` response
674
+ # indicates that more output is available. Set this parameter to the
675
+ # value of the previous call's `NextToken` response to indicate where
676
+ # the output should continue from.
677
+ # @return [String]
678
+ #
679
+ # @!attribute [rw] regions
680
+ # If specified, limits the response to only information about the
681
+ # index in the specified list of Amazon Web Services Regions.
682
+ # @return [Array<String>]
683
+ #
684
+ # @!attribute [rw] type
685
+ # If specified, limits the output to only indexes of the specified
686
+ # Type, either `LOCAL` or `AGGREGATOR`.
687
+ #
688
+ # Use this option to discover the aggregator index for your account.
689
+ # @return [String]
690
+ #
691
+ # @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/ListIndexesInput AWS API Documentation
692
+ #
693
+ class ListIndexesInput < Struct.new(
694
+ :max_results,
695
+ :next_token,
696
+ :regions,
697
+ :type)
698
+ SENSITIVE = []
699
+ include Aws::Structure
700
+ end
701
+
702
+ # @!attribute [rw] indexes
703
+ # A structure that contains the details and status of each index.
704
+ # @return [Array<Types::Index>]
705
+ #
706
+ # @!attribute [rw] next_token
707
+ # If present, indicates that more output is available than is included
708
+ # in the current response. Use this value in the `NextToken` request
709
+ # parameter in a subsequent call to the operation to get the next part
710
+ # of the output. You should repeat this until the `NextToken` response
711
+ # element comes back as `null`.
712
+ # @return [String]
713
+ #
714
+ # @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/ListIndexesOutput AWS API Documentation
715
+ #
716
+ class ListIndexesOutput < Struct.new(
717
+ :indexes,
718
+ :next_token)
719
+ SENSITIVE = []
720
+ include Aws::Structure
721
+ end
722
+
723
+ # @note When making an API call, you may pass ListSupportedResourceTypesInput
724
+ # data as a hash:
725
+ #
726
+ # {
727
+ # max_results: 1,
728
+ # next_token: "String",
729
+ # }
730
+ #
731
+ # @!attribute [rw] max_results
732
+ # The maximum number of results that you want included on each page of
733
+ # the response. If you do not include this parameter, it defaults to a
734
+ # value appropriate to the operation. If additional items exist beyond
735
+ # those included in the current response, the `NextToken` response
736
+ # element is present and has a value (is not null). Include that value
737
+ # as the `NextToken` request parameter in the next call to the
738
+ # operation to get the next part of the results.
739
+ #
740
+ # <note markdown="1"> An API operation can return fewer results than the maximum even when
741
+ # there are more results available. You should check `NextToken` after
742
+ # every operation to ensure that you receive all of the results.
743
+ #
744
+ # </note>
745
+ # @return [Integer]
746
+ #
747
+ # @!attribute [rw] next_token
748
+ # The parameter for receiving additional results if you receive a
749
+ # `NextToken` response in a previous request. A `NextToken` response
750
+ # indicates that more output is available. Set this parameter to the
751
+ # value of the previous call's `NextToken` response to indicate where
752
+ # the output should continue from.
753
+ # @return [String]
754
+ #
755
+ # @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/ListSupportedResourceTypesInput AWS API Documentation
756
+ #
757
+ class ListSupportedResourceTypesInput < Struct.new(
758
+ :max_results,
759
+ :next_token)
760
+ SENSITIVE = []
761
+ include Aws::Structure
762
+ end
763
+
764
+ # @!attribute [rw] next_token
765
+ # If present, indicates that more output is available than is included
766
+ # in the current response. Use this value in the `NextToken` request
767
+ # parameter in a subsequent call to the operation to get the next part
768
+ # of the output. You should repeat this until the `NextToken` response
769
+ # element comes back as `null`.
770
+ # @return [String]
771
+ #
772
+ # @!attribute [rw] resource_types
773
+ # The list of resource types supported by Resource Explorer.
774
+ # @return [Array<Types::SupportedResourceType>]
775
+ #
776
+ # @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/ListSupportedResourceTypesOutput AWS API Documentation
777
+ #
778
+ class ListSupportedResourceTypesOutput < Struct.new(
779
+ :next_token,
780
+ :resource_types)
781
+ SENSITIVE = []
782
+ include Aws::Structure
783
+ end
784
+
785
+ # @note When making an API call, you may pass ListTagsForResourceInput
786
+ # data as a hash:
787
+ #
788
+ # {
789
+ # resource_arn: "String", # required
790
+ # }
791
+ #
792
+ # @!attribute [rw] resource_arn
793
+ # The [Amazon resource name (ARN)][1] of the view or index that you
794
+ # want to attach tags to.
795
+ #
796
+ #
797
+ #
798
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
799
+ # @return [String]
800
+ #
801
+ # @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/ListTagsForResourceInput AWS API Documentation
802
+ #
803
+ class ListTagsForResourceInput < Struct.new(
804
+ :resource_arn)
805
+ SENSITIVE = []
806
+ include Aws::Structure
807
+ end
808
+
809
+ # @!attribute [rw] tags
810
+ # The tag key and value pairs that you want to attach to the specified
811
+ # view or index.
812
+ # @return [Hash<String,String>]
813
+ #
814
+ # @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/ListTagsForResourceOutput AWS API Documentation
815
+ #
816
+ class ListTagsForResourceOutput < Struct.new(
817
+ :tags)
818
+ SENSITIVE = []
819
+ include Aws::Structure
820
+ end
821
+
822
+ # @note When making an API call, you may pass ListViewsInput
823
+ # data as a hash:
824
+ #
825
+ # {
826
+ # max_results: 1,
827
+ # next_token: "String",
828
+ # }
829
+ #
830
+ # @!attribute [rw] max_results
831
+ # The maximum number of results that you want included on each page of
832
+ # the response. If you do not include this parameter, it defaults to a
833
+ # value appropriate to the operation. If additional items exist beyond
834
+ # those included in the current response, the `NextToken` response
835
+ # element is present and has a value (is not null). Include that value
836
+ # as the `NextToken` request parameter in the next call to the
837
+ # operation to get the next part of the results.
838
+ #
839
+ # <note markdown="1"> An API operation can return fewer results than the maximum even when
840
+ # there are more results available. You should check `NextToken` after
841
+ # every operation to ensure that you receive all of the results.
842
+ #
843
+ # </note>
844
+ # @return [Integer]
845
+ #
846
+ # @!attribute [rw] next_token
847
+ # The parameter for receiving additional results if you receive a
848
+ # `NextToken` response in a previous request. A `NextToken` response
849
+ # indicates that more output is available. Set this parameter to the
850
+ # value of the previous call's `NextToken` response to indicate where
851
+ # the output should continue from.
852
+ # @return [String]
853
+ #
854
+ # @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/ListViewsInput AWS API Documentation
855
+ #
856
+ class ListViewsInput < Struct.new(
857
+ :max_results,
858
+ :next_token)
859
+ SENSITIVE = []
860
+ include Aws::Structure
861
+ end
862
+
863
+ # @!attribute [rw] next_token
864
+ # If present, indicates that more output is available than is included
865
+ # in the current response. Use this value in the `NextToken` request
866
+ # parameter in a subsequent call to the operation to get the next part
867
+ # of the output. You should repeat this until the `NextToken` response
868
+ # element comes back as `null`.
869
+ # @return [String]
870
+ #
871
+ # @!attribute [rw] views
872
+ # The list of views available in the Amazon Web Services Region in
873
+ # which you called this operation.
874
+ # @return [Array<String>]
875
+ #
876
+ # @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/ListViewsOutput AWS API Documentation
877
+ #
878
+ class ListViewsOutput < Struct.new(
879
+ :next_token,
880
+ :views)
881
+ SENSITIVE = []
882
+ include Aws::Structure
883
+ end
884
+
885
+ # A resource in Amazon Web Services that Amazon Web Services Resource
886
+ # Explorer has discovered, and for which it has stored information in
887
+ # the index of the Amazon Web Services Region that contains the
888
+ # resource.
889
+ #
890
+ # @!attribute [rw] arn
891
+ # The [Amazon resource name (ARN)][1] of the resource.
892
+ #
893
+ #
894
+ #
895
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
896
+ # @return [String]
897
+ #
898
+ # @!attribute [rw] last_reported_at
899
+ # The date and time that Resource Explorer last queried this resource
900
+ # and updated the index with the latest information about the
901
+ # resource.
902
+ # @return [Time]
903
+ #
904
+ # @!attribute [rw] owning_account_id
905
+ # The Amazon Web Services account that owns the resource.
906
+ # @return [String]
907
+ #
908
+ # @!attribute [rw] properties
909
+ # A structure with additional type-specific details about the
910
+ # resource. These properties can be added by turning on integration
911
+ # between Resource Explorer and other Amazon Web Services services.
912
+ # @return [Array<Types::ResourceProperty>]
913
+ #
914
+ # @!attribute [rw] region
915
+ # The Amazon Web Services Region in which the resource was created and
916
+ # exists.
917
+ # @return [String]
918
+ #
919
+ # @!attribute [rw] resource_type
920
+ # The type of the resource.
921
+ # @return [String]
922
+ #
923
+ # @!attribute [rw] service
924
+ # The Amazon Web Service that owns the resource and is responsible for
925
+ # creating and updating it.
926
+ # @return [String]
927
+ #
928
+ # @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/Resource AWS API Documentation
929
+ #
930
+ class Resource < Struct.new(
931
+ :arn,
932
+ :last_reported_at,
933
+ :owning_account_id,
934
+ :properties,
935
+ :region,
936
+ :resource_type,
937
+ :service)
938
+ SENSITIVE = []
939
+ include Aws::Structure
940
+ end
941
+
942
+ # Information about the number of results that match the query. At this
943
+ # time, Amazon Web Services Resource Explorer doesn't count more than
944
+ # 1,000 matches for any query. This structure provides information about
945
+ # whether the query exceeded this limit.
946
+ #
947
+ # This field is included in every page when you paginate the results.
948
+ #
949
+ # @!attribute [rw] complete
950
+ # Indicates whether the `TotalResources` value represents an
951
+ # exhaustive count of search results.
952
+ #
953
+ # * If `True`, it indicates that the search was exhaustive. Every
954
+ # resource that matches the query was counted.
955
+ #
956
+ # * If `False`, then the search reached the limit of 1,000 matching
957
+ # results, and stopped counting.
958
+ # @return [Boolean]
959
+ #
960
+ # @!attribute [rw] total_resources
961
+ # The number of resources that match the search query. This value
962
+ # can't exceed 1,000. If there are more than 1,000 resources that
963
+ # match the query, then only 1,000 are counted and the `Complete`
964
+ # field is set to false. We recommend that you refine your query to
965
+ # return a smaller number of results.
966
+ # @return [Integer]
967
+ #
968
+ # @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/ResourceCount AWS API Documentation
969
+ #
970
+ class ResourceCount < Struct.new(
971
+ :complete,
972
+ :total_resources)
973
+ SENSITIVE = []
974
+ include Aws::Structure
975
+ end
976
+
977
+ # You specified a resource that doesn't exist. Check the ID or ARN that
978
+ # you used to identity the resource, and try again.
979
+ #
980
+ # @!attribute [rw] message
981
+ # @return [String]
982
+ #
983
+ # @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/ResourceNotFoundException AWS API Documentation
984
+ #
985
+ class ResourceNotFoundException < Struct.new(
986
+ :message)
987
+ SENSITIVE = []
988
+ include Aws::Structure
989
+ end
990
+
991
+ # A structure that describes a property of a resource.
992
+ #
993
+ # @!attribute [rw] data
994
+ # Details about this property. The content of this field is a JSON
995
+ # object that varies based on the resource type.
996
+ # @return [Hash,Array,String,Numeric,Boolean]
997
+ #
998
+ # @!attribute [rw] last_reported_at
999
+ # The date and time that the information about this resource property
1000
+ # was last updated.
1001
+ # @return [Time]
1002
+ #
1003
+ # @!attribute [rw] name
1004
+ # The name of this property of the resource.
1005
+ # @return [String]
1006
+ #
1007
+ # @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/ResourceProperty AWS API Documentation
1008
+ #
1009
+ class ResourceProperty < Struct.new(
1010
+ :data,
1011
+ :last_reported_at,
1012
+ :name)
1013
+ SENSITIVE = []
1014
+ include Aws::Structure
1015
+ end
1016
+
1017
+ # A search filter defines which resources can be part of a search query
1018
+ # result set.
1019
+ #
1020
+ # @note When making an API call, you may pass SearchFilter
1021
+ # data as a hash:
1022
+ #
1023
+ # {
1024
+ # filter_string: "SearchFilterFilterStringString", # required
1025
+ # }
1026
+ #
1027
+ # @!attribute [rw] filter_string
1028
+ # The string that contains the search keywords, prefixes, and
1029
+ # operators to control the results that can be returned by a Search
1030
+ # operation. For more details, see [Search query syntax][1].
1031
+ #
1032
+ #
1033
+ #
1034
+ # [1]: https://docs.aws.amazon.com/resource-explorer/latest/APIReference/about-query-syntax.html
1035
+ # @return [String]
1036
+ #
1037
+ # @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/SearchFilter AWS API Documentation
1038
+ #
1039
+ class SearchFilter < Struct.new(
1040
+ :filter_string)
1041
+ SENSITIVE = []
1042
+ include Aws::Structure
1043
+ end
1044
+
1045
+ # @note When making an API call, you may pass SearchInput
1046
+ # data as a hash:
1047
+ #
1048
+ # {
1049
+ # max_results: 1,
1050
+ # next_token: "SearchInputNextTokenString",
1051
+ # query_string: "QueryString", # required
1052
+ # view_arn: "SearchInputViewArnString",
1053
+ # }
1054
+ #
1055
+ # @!attribute [rw] max_results
1056
+ # The maximum number of results that you want included on each page of
1057
+ # the response. If you do not include this parameter, it defaults to a
1058
+ # value appropriate to the operation. If additional items exist beyond
1059
+ # those included in the current response, the `NextToken` response
1060
+ # element is present and has a value (is not null). Include that value
1061
+ # as the `NextToken` request parameter in the next call to the
1062
+ # operation to get the next part of the results.
1063
+ #
1064
+ # <note markdown="1"> An API operation can return fewer results than the maximum even when
1065
+ # there are more results available. You should check `NextToken` after
1066
+ # every operation to ensure that you receive all of the results.
1067
+ #
1068
+ # </note>
1069
+ # @return [Integer]
1070
+ #
1071
+ # @!attribute [rw] next_token
1072
+ # The parameter for receiving additional results if you receive a
1073
+ # `NextToken` response in a previous request. A `NextToken` response
1074
+ # indicates that more output is available. Set this parameter to the
1075
+ # value of the previous call's `NextToken` response to indicate where
1076
+ # the output should continue from.
1077
+ # @return [String]
1078
+ #
1079
+ # @!attribute [rw] query_string
1080
+ # A string that includes keywords and filters that specify the
1081
+ # resources that you want to include in the results.
1082
+ #
1083
+ # For the complete syntax supported by the `QueryString` parameter,
1084
+ # see [Search query syntax reference for Resource Explorer][1].
1085
+ #
1086
+ # The search is completely case insensitive. You can specify an empty
1087
+ # string to return all results up to the limit of 1,000 total results.
1088
+ #
1089
+ # <note markdown="1"> The operation can return only the first 1,000 results. If the
1090
+ # resource you want is not included, then use a different value for
1091
+ # `QueryString` to refine the results.
1092
+ #
1093
+ # </note>
1094
+ #
1095
+ #
1096
+ #
1097
+ # [1]: https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html
1098
+ # @return [String]
1099
+ #
1100
+ # @!attribute [rw] view_arn
1101
+ # Specifies the [Amazon resource name (ARN)][1] of the view to use for
1102
+ # the query. If you don't specify a value for this parameter, then
1103
+ # the operation automatically uses the default view for the Amazon Web
1104
+ # Services Region in which you called this operation. If the Region
1105
+ # either doesn't have a default view or if you don't have permission
1106
+ # to use the default view, then the operation fails with a `401
1107
+ # Unauthorized` exception.
1108
+ #
1109
+ #
1110
+ #
1111
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
1112
+ # @return [String]
1113
+ #
1114
+ # @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/SearchInput AWS API Documentation
1115
+ #
1116
+ class SearchInput < Struct.new(
1117
+ :max_results,
1118
+ :next_token,
1119
+ :query_string,
1120
+ :view_arn)
1121
+ SENSITIVE = [:query_string]
1122
+ include Aws::Structure
1123
+ end
1124
+
1125
+ # @!attribute [rw] count
1126
+ # The number of resources that match the query.
1127
+ # @return [Types::ResourceCount]
1128
+ #
1129
+ # @!attribute [rw] next_token
1130
+ # If present, indicates that more output is available than is included
1131
+ # in the current response. Use this value in the `NextToken` request
1132
+ # parameter in a subsequent call to the operation to get the next part
1133
+ # of the output. You should repeat this until the `NextToken` response
1134
+ # element comes back as `null`.
1135
+ # @return [String]
1136
+ #
1137
+ # @!attribute [rw] resources
1138
+ # The list of structures that describe the resources that match the
1139
+ # query.
1140
+ # @return [Array<Types::Resource>]
1141
+ #
1142
+ # @!attribute [rw] view_arn
1143
+ # The [Amazon resource name (ARN)][1] of the view that this operation
1144
+ # used to perform the search.
1145
+ #
1146
+ #
1147
+ #
1148
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
1149
+ # @return [String]
1150
+ #
1151
+ # @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/SearchOutput AWS API Documentation
1152
+ #
1153
+ class SearchOutput < Struct.new(
1154
+ :count,
1155
+ :next_token,
1156
+ :resources,
1157
+ :view_arn)
1158
+ SENSITIVE = []
1159
+ include Aws::Structure
1160
+ end
1161
+
1162
+ # The request failed because it exceeds a service quota.
1163
+ #
1164
+ # @!attribute [rw] message
1165
+ # @return [String]
1166
+ #
1167
+ # @!attribute [rw] name
1168
+ # The name of the service quota that was exceeded by the request.
1169
+ # @return [String]
1170
+ #
1171
+ # @!attribute [rw] value
1172
+ # The current value for the quota that the request tried to exceed.
1173
+ # @return [String]
1174
+ #
1175
+ # @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/ServiceQuotaExceededException AWS API Documentation
1176
+ #
1177
+ class ServiceQuotaExceededException < Struct.new(
1178
+ :message,
1179
+ :name,
1180
+ :value)
1181
+ SENSITIVE = []
1182
+ include Aws::Structure
1183
+ end
1184
+
1185
+ # A structure that describes a resource type supported by Amazon Web
1186
+ # Services Resource Explorer.
1187
+ #
1188
+ # @!attribute [rw] resource_type
1189
+ # The unique identifier of the resource type.
1190
+ # @return [String]
1191
+ #
1192
+ # @!attribute [rw] service
1193
+ # The Amazon Web Service that is associated with the resource type.
1194
+ # This is the primary service that lets you create and interact with
1195
+ # resources of this type.
1196
+ # @return [String]
1197
+ #
1198
+ # @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/SupportedResourceType AWS API Documentation
1199
+ #
1200
+ class SupportedResourceType < Struct.new(
1201
+ :resource_type,
1202
+ :service)
1203
+ SENSITIVE = []
1204
+ include Aws::Structure
1205
+ end
1206
+
1207
+ # @note When making an API call, you may pass TagResourceInput
1208
+ # data as a hash:
1209
+ #
1210
+ # {
1211
+ # tags: {
1212
+ # "String" => "String",
1213
+ # },
1214
+ # resource_arn: "String", # required
1215
+ # }
1216
+ #
1217
+ # @!attribute [rw] tags
1218
+ # A list of tag key and value pairs that you want to attach to the
1219
+ # specified view or index.
1220
+ # @return [Hash<String,String>]
1221
+ #
1222
+ # @!attribute [rw] resource_arn
1223
+ # The Amazon Resource Name (ARN) of the view or index that you want to
1224
+ # attach tags to.
1225
+ # @return [String]
1226
+ #
1227
+ # @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/TagResourceInput AWS API Documentation
1228
+ #
1229
+ class TagResourceInput < Struct.new(
1230
+ :tags,
1231
+ :resource_arn)
1232
+ SENSITIVE = []
1233
+ include Aws::Structure
1234
+ end
1235
+
1236
+ # @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/TagResourceOutput AWS API Documentation
1237
+ #
1238
+ class TagResourceOutput < Aws::EmptyStructure; end
1239
+
1240
+ # The request failed because you exceeded a rate limit for this
1241
+ # operation. For more information, see [Quotas for Resource
1242
+ # Explorer][1].
1243
+ #
1244
+ #
1245
+ #
1246
+ # [1]: https://docs.aws.amazon.com/arexug/mainline/quotas.html
1247
+ #
1248
+ # @!attribute [rw] message
1249
+ # @return [String]
1250
+ #
1251
+ # @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/ThrottlingException AWS API Documentation
1252
+ #
1253
+ class ThrottlingException < Struct.new(
1254
+ :message)
1255
+ SENSITIVE = []
1256
+ include Aws::Structure
1257
+ end
1258
+
1259
+ # The principal making the request isn't permitted to perform the
1260
+ # operation.
1261
+ #
1262
+ # @!attribute [rw] message
1263
+ # @return [String]
1264
+ #
1265
+ # @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/UnauthorizedException AWS API Documentation
1266
+ #
1267
+ class UnauthorizedException < Struct.new(
1268
+ :message)
1269
+ SENSITIVE = []
1270
+ include Aws::Structure
1271
+ end
1272
+
1273
+ # @note When making an API call, you may pass UntagResourceInput
1274
+ # data as a hash:
1275
+ #
1276
+ # {
1277
+ # resource_arn: "String", # required
1278
+ # tag_keys: ["String"], # required
1279
+ # }
1280
+ #
1281
+ # @!attribute [rw] resource_arn
1282
+ # The Amazon Resource Name (ARN) of the view or index that you want to
1283
+ # remove tags from.
1284
+ # @return [String]
1285
+ #
1286
+ # @!attribute [rw] tag_keys
1287
+ # A list of the keys for the tags that you want to remove from the
1288
+ # specified view or index.
1289
+ # @return [Array<String>]
1290
+ #
1291
+ # @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/UntagResourceInput AWS API Documentation
1292
+ #
1293
+ class UntagResourceInput < Struct.new(
1294
+ :resource_arn,
1295
+ :tag_keys)
1296
+ SENSITIVE = []
1297
+ include Aws::Structure
1298
+ end
1299
+
1300
+ # @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/UntagResourceOutput AWS API Documentation
1301
+ #
1302
+ class UntagResourceOutput < Aws::EmptyStructure; end
1303
+
1304
+ # @note When making an API call, you may pass UpdateIndexTypeInput
1305
+ # data as a hash:
1306
+ #
1307
+ # {
1308
+ # arn: "String", # required
1309
+ # type: "LOCAL", # required, accepts LOCAL, AGGREGATOR
1310
+ # }
1311
+ #
1312
+ # @!attribute [rw] arn
1313
+ # The [Amazon resource name (ARN)][1] of the index that you want to
1314
+ # update.
1315
+ #
1316
+ #
1317
+ #
1318
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
1319
+ # @return [String]
1320
+ #
1321
+ # @!attribute [rw] type
1322
+ # The type of the index. To understand the difference between `LOCAL`
1323
+ # and `AGGREGATOR`, see [Turning on cross-Region search][1] in the
1324
+ # *Amazon Web Services Resource Explorer User Guide*.
1325
+ #
1326
+ #
1327
+ #
1328
+ # [1]: https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-aggregator-region.html
1329
+ # @return [String]
1330
+ #
1331
+ # @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/UpdateIndexTypeInput AWS API Documentation
1332
+ #
1333
+ class UpdateIndexTypeInput < Struct.new(
1334
+ :arn,
1335
+ :type)
1336
+ SENSITIVE = []
1337
+ include Aws::Structure
1338
+ end
1339
+
1340
+ # @!attribute [rw] arn
1341
+ # The [Amazon resource name (ARN)][1] of the index that you updated.
1342
+ #
1343
+ #
1344
+ #
1345
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
1346
+ # @return [String]
1347
+ #
1348
+ # @!attribute [rw] last_updated_at
1349
+ # The date and timestamp when the index was last updated.
1350
+ # @return [Time]
1351
+ #
1352
+ # @!attribute [rw] state
1353
+ # Indicates the state of the request to update the index. This
1354
+ # operation is asynchronous. Call the GetIndex operation to check for
1355
+ # changes.
1356
+ # @return [String]
1357
+ #
1358
+ # @!attribute [rw] type
1359
+ # Specifies the type of the specified index after the operation
1360
+ # completes.
1361
+ # @return [String]
1362
+ #
1363
+ # @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/UpdateIndexTypeOutput AWS API Documentation
1364
+ #
1365
+ class UpdateIndexTypeOutput < Struct.new(
1366
+ :arn,
1367
+ :last_updated_at,
1368
+ :state,
1369
+ :type)
1370
+ SENSITIVE = []
1371
+ include Aws::Structure
1372
+ end
1373
+
1374
+ # @note When making an API call, you may pass UpdateViewInput
1375
+ # data as a hash:
1376
+ #
1377
+ # {
1378
+ # filters: {
1379
+ # filter_string: "SearchFilterFilterStringString", # required
1380
+ # },
1381
+ # included_properties: [
1382
+ # {
1383
+ # name: "IncludedPropertyNameString", # required
1384
+ # },
1385
+ # ],
1386
+ # view_arn: "UpdateViewInputViewArnString", # required
1387
+ # }
1388
+ #
1389
+ # @!attribute [rw] filters
1390
+ # An array of strings that specify which resources are included in the
1391
+ # results of queries made using this view. When you use this view in a
1392
+ # Search operation, the filter string is combined with the search's
1393
+ # `QueryString` parameter using a logical `AND` operator.
1394
+ #
1395
+ # For information about the supported syntax, see [Search query
1396
+ # reference for Resource Explorer][1] in the *Amazon Web Services
1397
+ # Resource Explorer User Guide*.
1398
+ #
1399
+ # This query string in the context of this operation supports only
1400
+ # [filter prefixes][2] with optional [operators][3]. It doesn't
1401
+ # support free-form text. For example, the string `region:us*
1402
+ # service:ec2 -tag:stage=prod` includes all Amazon EC2 resources in
1403
+ # any Amazon Web Services Region that begins with the letters `us` and
1404
+ # is *not* tagged with a key `Stage` that has the value `prod`.
1405
+ #
1406
+ #
1407
+ #
1408
+ # [1]: https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html
1409
+ # [2]: https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html#query-syntax-filters
1410
+ # [3]: https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html#query-syntax-operators
1411
+ # @return [Types::SearchFilter]
1412
+ #
1413
+ # @!attribute [rw] included_properties
1414
+ # Specifies optional fields that you want included in search results
1415
+ # from this view. It is a list of objects that each describe a field
1416
+ # to include.
1417
+ #
1418
+ # The default is an empty list, with no optional fields included in
1419
+ # the results.
1420
+ # @return [Array<Types::IncludedProperty>]
1421
+ #
1422
+ # @!attribute [rw] view_arn
1423
+ # The [Amazon resource name (ARN)][1] of the view that you want to
1424
+ # modify.
1425
+ #
1426
+ #
1427
+ #
1428
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
1429
+ # @return [String]
1430
+ #
1431
+ # @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/UpdateViewInput AWS API Documentation
1432
+ #
1433
+ class UpdateViewInput < Struct.new(
1434
+ :filters,
1435
+ :included_properties,
1436
+ :view_arn)
1437
+ SENSITIVE = [:filters]
1438
+ include Aws::Structure
1439
+ end
1440
+
1441
+ # @!attribute [rw] view
1442
+ # Details about the view that you changed with this operation.
1443
+ # @return [Types::View]
1444
+ #
1445
+ # @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/UpdateViewOutput AWS API Documentation
1446
+ #
1447
+ class UpdateViewOutput < Struct.new(
1448
+ :view)
1449
+ SENSITIVE = []
1450
+ include Aws::Structure
1451
+ end
1452
+
1453
+ # You provided an invalid value for one of the operation's parameters.
1454
+ # Check the syntax for the operation, and try again.
1455
+ #
1456
+ # @!attribute [rw] field_list
1457
+ # An array of the request fields that had validation errors.
1458
+ # @return [Array<Types::ValidationExceptionField>]
1459
+ #
1460
+ # @!attribute [rw] message
1461
+ # @return [String]
1462
+ #
1463
+ # @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/ValidationException AWS API Documentation
1464
+ #
1465
+ class ValidationException < Struct.new(
1466
+ :field_list,
1467
+ :message)
1468
+ SENSITIVE = []
1469
+ include Aws::Structure
1470
+ end
1471
+
1472
+ # A structure that describes a request field with a validation error.
1473
+ #
1474
+ # @!attribute [rw] name
1475
+ # The name of the request field that had a validation error.
1476
+ # @return [String]
1477
+ #
1478
+ # @!attribute [rw] validation_issue
1479
+ # The validation error caused by the request field.
1480
+ # @return [String]
1481
+ #
1482
+ # @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/ValidationExceptionField AWS API Documentation
1483
+ #
1484
+ class ValidationExceptionField < Struct.new(
1485
+ :name,
1486
+ :validation_issue)
1487
+ SENSITIVE = []
1488
+ include Aws::Structure
1489
+ end
1490
+
1491
+ # A view is a structure that defines a set of filters that provide a
1492
+ # view into the information in the Amazon Web Services Resource Explorer
1493
+ # index. The filters specify which information from the index is visible
1494
+ # to the users of the view. For example, you can specify filters that
1495
+ # include only resources that are tagged with the key "ENV" and the
1496
+ # value "DEVELOPMENT" in the results returned by this view. You could
1497
+ # also create a second view that includes only resources that are tagged
1498
+ # with "ENV" and "PRODUCTION".
1499
+ #
1500
+ # @!attribute [rw] filters
1501
+ # An array of SearchFilter objects that specify which resources can be
1502
+ # included in the results of queries made using this view.
1503
+ # @return [Types::SearchFilter]
1504
+ #
1505
+ # @!attribute [rw] included_properties
1506
+ # A structure that contains additional information about the view.
1507
+ # @return [Array<Types::IncludedProperty>]
1508
+ #
1509
+ # @!attribute [rw] last_updated_at
1510
+ # The date and time when this view was last modified.
1511
+ # @return [Time]
1512
+ #
1513
+ # @!attribute [rw] owner
1514
+ # The Amazon Web Services account that owns this view.
1515
+ # @return [String]
1516
+ #
1517
+ # @!attribute [rw] scope
1518
+ # An [Amazon resource name (ARN)][1] of an Amazon Web Services
1519
+ # account, an organization, or an organizational unit (OU) that
1520
+ # specifies whether this view includes resources from only the
1521
+ # specified Amazon Web Services account, all accounts in the specified
1522
+ # organization, or all accounts in the specified OU.
1523
+ #
1524
+ # If not specified, the value defaults to the Amazon Web Services
1525
+ # account used to call this operation.
1526
+ #
1527
+ #
1528
+ #
1529
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
1530
+ # @return [String]
1531
+ #
1532
+ # @!attribute [rw] view_arn
1533
+ # The [Amazon resource name (ARN)][1] of the view.
1534
+ #
1535
+ #
1536
+ #
1537
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
1538
+ # @return [String]
1539
+ #
1540
+ # @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/View AWS API Documentation
1541
+ #
1542
+ class View < Struct.new(
1543
+ :filters,
1544
+ :included_properties,
1545
+ :last_updated_at,
1546
+ :owner,
1547
+ :scope,
1548
+ :view_arn)
1549
+ SENSITIVE = [:filters]
1550
+ include Aws::Structure
1551
+ end
1552
+
1553
+ end
1554
+ end