aws-sdk-oam 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,1024 @@
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::OAM
11
+ module Types
12
+
13
+ # A resource was in an inconsistent state during an update or a
14
+ # deletion.
15
+ #
16
+ # @!attribute [rw] message
17
+ # @return [String]
18
+ #
19
+ # @!attribute [rw] amzn_error_type
20
+ # The name of the exception.
21
+ # @return [String]
22
+ #
23
+ # @see http://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/ConflictException AWS API Documentation
24
+ #
25
+ class ConflictException < Struct.new(
26
+ :message,
27
+ :amzn_error_type)
28
+ SENSITIVE = []
29
+ include Aws::Structure
30
+ end
31
+
32
+ # @note When making an API call, you may pass CreateLinkInput
33
+ # data as a hash:
34
+ #
35
+ # {
36
+ # label_template: "LabelTemplate", # required
37
+ # resource_types: ["AWS::CloudWatch::Metric"], # required, accepts AWS::CloudWatch::Metric, AWS::Logs::LogGroup, AWS::XRay::Trace
38
+ # sink_identifier: "ResourceIdentifier", # required
39
+ # tags: {
40
+ # "TagKey" => "TagValue",
41
+ # },
42
+ # }
43
+ #
44
+ # @!attribute [rw] label_template
45
+ # Specify a friendly human-readable name to use to identify this
46
+ # source account when you are viewing data from it in the monitoring
47
+ # account.
48
+ #
49
+ # You can use a custom label or use the following variables:
50
+ #
51
+ # * `$AccountName` is the name of the account
52
+ #
53
+ # * `$AccountEmail` is the globally unique email address of the
54
+ # account
55
+ #
56
+ # * `$AccountEmailNoDomain` is the email address of the account
57
+ # without the domain name
58
+ # @return [String]
59
+ #
60
+ # @!attribute [rw] resource_types
61
+ # An array of strings that define which types of data that the source
62
+ # account shares with the monitoring account.
63
+ # @return [Array<String>]
64
+ #
65
+ # @!attribute [rw] sink_identifier
66
+ # The ARN of the sink to use to create this link. You can use
67
+ # [ListSinks][1] to find the ARNs of sinks.
68
+ #
69
+ # For more information about sinks, see [CreateSink][2].
70
+ #
71
+ #
72
+ #
73
+ # [1]: https://docs.aws.amazon.com/OAM/latest/APIReference/API_ListSinks.html
74
+ # [2]: https://docs.aws.amazon.com/OAM/latest/APIReference/API_CreateSink.html
75
+ # @return [String]
76
+ #
77
+ # @!attribute [rw] tags
78
+ # Assigns one or more tags (key-value pairs) to the link.
79
+ #
80
+ # Tags can help you organize and categorize your resources. You can
81
+ # also use them to scope user permissions by granting a user
82
+ # permission to access or change only resources with certain tag
83
+ # values.
84
+ #
85
+ # For more information about using tags to control access, see
86
+ # [Controlling access to Amazon Web Services resources using tags][1].
87
+ #
88
+ #
89
+ #
90
+ # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html
91
+ # @return [Hash<String,String>]
92
+ #
93
+ # @see http://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/CreateLinkInput AWS API Documentation
94
+ #
95
+ class CreateLinkInput < Struct.new(
96
+ :label_template,
97
+ :resource_types,
98
+ :sink_identifier,
99
+ :tags)
100
+ SENSITIVE = []
101
+ include Aws::Structure
102
+ end
103
+
104
+ # @!attribute [rw] arn
105
+ # The ARN of the link that is newly created.
106
+ # @return [String]
107
+ #
108
+ # @!attribute [rw] id
109
+ # The random ID string that Amazon Web Services generated as part of
110
+ # the link ARN.
111
+ # @return [String]
112
+ #
113
+ # @!attribute [rw] label
114
+ # The label that you assigned to this link. If the `labelTemplate`
115
+ # includes variables, this field displays the variables resolved to
116
+ # their actual values.
117
+ # @return [String]
118
+ #
119
+ # @!attribute [rw] label_template
120
+ # The exact label template that you specified, with the variables not
121
+ # resolved.
122
+ # @return [String]
123
+ #
124
+ # @!attribute [rw] resource_types
125
+ # The resource types supported by this link.
126
+ # @return [Array<String>]
127
+ #
128
+ # @!attribute [rw] sink_arn
129
+ # The ARN of the sink that is used for this link.
130
+ # @return [String]
131
+ #
132
+ # @!attribute [rw] tags
133
+ # The tags assigned to the link.
134
+ # @return [Hash<String,String>]
135
+ #
136
+ # @see http://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/CreateLinkOutput AWS API Documentation
137
+ #
138
+ class CreateLinkOutput < Struct.new(
139
+ :arn,
140
+ :id,
141
+ :label,
142
+ :label_template,
143
+ :resource_types,
144
+ :sink_arn,
145
+ :tags)
146
+ SENSITIVE = []
147
+ include Aws::Structure
148
+ end
149
+
150
+ # @note When making an API call, you may pass CreateSinkInput
151
+ # data as a hash:
152
+ #
153
+ # {
154
+ # name: "SinkName", # required
155
+ # tags: {
156
+ # "TagKey" => "TagValue",
157
+ # },
158
+ # }
159
+ #
160
+ # @!attribute [rw] name
161
+ # A name for the sink.
162
+ # @return [String]
163
+ #
164
+ # @!attribute [rw] tags
165
+ # Assigns one or more tags (key-value pairs) to the link.
166
+ #
167
+ # Tags can help you organize and categorize your resources. You can
168
+ # also use them to scope user permissions by granting a user
169
+ # permission to access or change only resources with certain tag
170
+ # values.
171
+ #
172
+ # For more information about using tags to control access, see
173
+ # [Controlling access to Amazon Web Services resources using tags][1].
174
+ #
175
+ #
176
+ #
177
+ # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html
178
+ # @return [Hash<String,String>]
179
+ #
180
+ # @see http://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/CreateSinkInput AWS API Documentation
181
+ #
182
+ class CreateSinkInput < Struct.new(
183
+ :name,
184
+ :tags)
185
+ SENSITIVE = []
186
+ include Aws::Structure
187
+ end
188
+
189
+ # @!attribute [rw] arn
190
+ # The ARN of the sink that is newly created.
191
+ # @return [String]
192
+ #
193
+ # @!attribute [rw] id
194
+ # The random ID string that Amazon Web Services generated as part of
195
+ # the sink ARN.
196
+ # @return [String]
197
+ #
198
+ # @!attribute [rw] name
199
+ # The name of the sink.
200
+ # @return [String]
201
+ #
202
+ # @!attribute [rw] tags
203
+ # The tags assigned to the sink.
204
+ # @return [Hash<String,String>]
205
+ #
206
+ # @see http://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/CreateSinkOutput AWS API Documentation
207
+ #
208
+ class CreateSinkOutput < Struct.new(
209
+ :arn,
210
+ :id,
211
+ :name,
212
+ :tags)
213
+ SENSITIVE = []
214
+ include Aws::Structure
215
+ end
216
+
217
+ # @note When making an API call, you may pass DeleteLinkInput
218
+ # data as a hash:
219
+ #
220
+ # {
221
+ # identifier: "ResourceIdentifier", # required
222
+ # }
223
+ #
224
+ # @!attribute [rw] identifier
225
+ # The ARN of the link to delete.
226
+ # @return [String]
227
+ #
228
+ # @see http://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/DeleteLinkInput AWS API Documentation
229
+ #
230
+ class DeleteLinkInput < Struct.new(
231
+ :identifier)
232
+ SENSITIVE = []
233
+ include Aws::Structure
234
+ end
235
+
236
+ # @see http://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/DeleteLinkOutput AWS API Documentation
237
+ #
238
+ class DeleteLinkOutput < Aws::EmptyStructure; end
239
+
240
+ # @note When making an API call, you may pass DeleteSinkInput
241
+ # data as a hash:
242
+ #
243
+ # {
244
+ # identifier: "ResourceIdentifier", # required
245
+ # }
246
+ #
247
+ # @!attribute [rw] identifier
248
+ # The ARN of the sink to delete.
249
+ # @return [String]
250
+ #
251
+ # @see http://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/DeleteSinkInput AWS API Documentation
252
+ #
253
+ class DeleteSinkInput < Struct.new(
254
+ :identifier)
255
+ SENSITIVE = []
256
+ include Aws::Structure
257
+ end
258
+
259
+ # @see http://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/DeleteSinkOutput AWS API Documentation
260
+ #
261
+ class DeleteSinkOutput < Aws::EmptyStructure; end
262
+
263
+ # @note When making an API call, you may pass GetLinkInput
264
+ # data as a hash:
265
+ #
266
+ # {
267
+ # identifier: "ResourceIdentifier", # required
268
+ # }
269
+ #
270
+ # @!attribute [rw] identifier
271
+ # The ARN of the link to retrieve information for.
272
+ # @return [String]
273
+ #
274
+ # @see http://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/GetLinkInput AWS API Documentation
275
+ #
276
+ class GetLinkInput < Struct.new(
277
+ :identifier)
278
+ SENSITIVE = []
279
+ include Aws::Structure
280
+ end
281
+
282
+ # @!attribute [rw] arn
283
+ # The ARN of the link.
284
+ # @return [String]
285
+ #
286
+ # @!attribute [rw] id
287
+ # The random ID string that Amazon Web Services generated as part of
288
+ # the link ARN.
289
+ # @return [String]
290
+ #
291
+ # @!attribute [rw] label
292
+ # The label that you assigned to this link, with the variables
293
+ # resolved to their actual values.
294
+ # @return [String]
295
+ #
296
+ # @!attribute [rw] label_template
297
+ # The exact label template that was specified when the link was
298
+ # created, with the template variables not resolved.
299
+ # @return [String]
300
+ #
301
+ # @!attribute [rw] resource_types
302
+ # The resource types supported by this link.
303
+ # @return [Array<String>]
304
+ #
305
+ # @!attribute [rw] sink_arn
306
+ # The ARN of the sink that is used for this link.
307
+ # @return [String]
308
+ #
309
+ # @!attribute [rw] tags
310
+ # The tags assigned to the link.
311
+ # @return [Hash<String,String>]
312
+ #
313
+ # @see http://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/GetLinkOutput AWS API Documentation
314
+ #
315
+ class GetLinkOutput < Struct.new(
316
+ :arn,
317
+ :id,
318
+ :label,
319
+ :label_template,
320
+ :resource_types,
321
+ :sink_arn,
322
+ :tags)
323
+ SENSITIVE = []
324
+ include Aws::Structure
325
+ end
326
+
327
+ # @note When making an API call, you may pass GetSinkInput
328
+ # data as a hash:
329
+ #
330
+ # {
331
+ # identifier: "ResourceIdentifier", # required
332
+ # }
333
+ #
334
+ # @!attribute [rw] identifier
335
+ # The ARN of the sink to retrieve information for.
336
+ # @return [String]
337
+ #
338
+ # @see http://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/GetSinkInput AWS API Documentation
339
+ #
340
+ class GetSinkInput < Struct.new(
341
+ :identifier)
342
+ SENSITIVE = []
343
+ include Aws::Structure
344
+ end
345
+
346
+ # @!attribute [rw] arn
347
+ # The ARN of the sink.
348
+ # @return [String]
349
+ #
350
+ # @!attribute [rw] id
351
+ # The random ID string that Amazon Web Services generated as part of
352
+ # the sink ARN.
353
+ # @return [String]
354
+ #
355
+ # @!attribute [rw] name
356
+ # The name of the sink.
357
+ # @return [String]
358
+ #
359
+ # @!attribute [rw] tags
360
+ # The tags assigned to the sink.
361
+ # @return [Hash<String,String>]
362
+ #
363
+ # @see http://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/GetSinkOutput AWS API Documentation
364
+ #
365
+ class GetSinkOutput < Struct.new(
366
+ :arn,
367
+ :id,
368
+ :name,
369
+ :tags)
370
+ SENSITIVE = []
371
+ include Aws::Structure
372
+ end
373
+
374
+ # @note When making an API call, you may pass GetSinkPolicyInput
375
+ # data as a hash:
376
+ #
377
+ # {
378
+ # sink_identifier: "ResourceIdentifier", # required
379
+ # }
380
+ #
381
+ # @!attribute [rw] sink_identifier
382
+ # The ARN of the sink to retrieve the policy of.
383
+ # @return [String]
384
+ #
385
+ # @see http://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/GetSinkPolicyInput AWS API Documentation
386
+ #
387
+ class GetSinkPolicyInput < Struct.new(
388
+ :sink_identifier)
389
+ SENSITIVE = []
390
+ include Aws::Structure
391
+ end
392
+
393
+ # @!attribute [rw] sink_arn
394
+ # The ARN of the sink.
395
+ # @return [String]
396
+ #
397
+ # @!attribute [rw] sink_id
398
+ # The random ID string that Amazon Web Services generated as part of
399
+ # the sink ARN.
400
+ # @return [String]
401
+ #
402
+ # @!attribute [rw] policy
403
+ # The policy that you specified, in JSON format.
404
+ # @return [String]
405
+ #
406
+ # @see http://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/GetSinkPolicyOutput AWS API Documentation
407
+ #
408
+ class GetSinkPolicyOutput < Struct.new(
409
+ :sink_arn,
410
+ :sink_id,
411
+ :policy)
412
+ SENSITIVE = []
413
+ include Aws::Structure
414
+ end
415
+
416
+ # Unexpected error while processing the request. Retry the request.
417
+ #
418
+ # @!attribute [rw] message
419
+ # @return [String]
420
+ #
421
+ # @!attribute [rw] amzn_error_type
422
+ # The name of the exception.
423
+ # @return [String]
424
+ #
425
+ # @see http://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/InternalServiceFault AWS API Documentation
426
+ #
427
+ class InternalServiceFault < Struct.new(
428
+ :message,
429
+ :amzn_error_type)
430
+ SENSITIVE = []
431
+ include Aws::Structure
432
+ end
433
+
434
+ # A parameter is specified incorrectly.
435
+ #
436
+ # @!attribute [rw] message
437
+ # @return [String]
438
+ #
439
+ # @!attribute [rw] amzn_error_type
440
+ # The name of the exception.
441
+ # @return [String]
442
+ #
443
+ # @see http://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/InvalidParameterException AWS API Documentation
444
+ #
445
+ class InvalidParameterException < Struct.new(
446
+ :message,
447
+ :amzn_error_type)
448
+ SENSITIVE = []
449
+ include Aws::Structure
450
+ end
451
+
452
+ # @note When making an API call, you may pass ListAttachedLinksInput
453
+ # data as a hash:
454
+ #
455
+ # {
456
+ # max_results: 1,
457
+ # next_token: "NextToken",
458
+ # sink_identifier: "ResourceIdentifier", # required
459
+ # }
460
+ #
461
+ # @!attribute [rw] max_results
462
+ # Limits the number of returned links to the specified number.
463
+ # @return [Integer]
464
+ #
465
+ # @!attribute [rw] next_token
466
+ # The token for the next set of items to return. You received this
467
+ # token from a previous call.
468
+ # @return [String]
469
+ #
470
+ # @!attribute [rw] sink_identifier
471
+ # The ARN of the sink that you want to retrieve links for.
472
+ # @return [String]
473
+ #
474
+ # @see http://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/ListAttachedLinksInput AWS API Documentation
475
+ #
476
+ class ListAttachedLinksInput < Struct.new(
477
+ :max_results,
478
+ :next_token,
479
+ :sink_identifier)
480
+ SENSITIVE = []
481
+ include Aws::Structure
482
+ end
483
+
484
+ # A structure that contains information about one link attached to this
485
+ # monitoring account sink.
486
+ #
487
+ # @!attribute [rw] label
488
+ # The label that was assigned to this link at creation, with the
489
+ # variables resolved to their actual values.
490
+ # @return [String]
491
+ #
492
+ # @!attribute [rw] link_arn
493
+ # The ARN of the link.
494
+ # @return [String]
495
+ #
496
+ # @!attribute [rw] resource_types
497
+ # The resource types supported by this link.
498
+ # @return [Array<String>]
499
+ #
500
+ # @see http://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/ListAttachedLinksItem AWS API Documentation
501
+ #
502
+ class ListAttachedLinksItem < Struct.new(
503
+ :label,
504
+ :link_arn,
505
+ :resource_types)
506
+ SENSITIVE = []
507
+ include Aws::Structure
508
+ end
509
+
510
+ # @!attribute [rw] items
511
+ # An array of structures that contain the information about the
512
+ # attached links.
513
+ # @return [Array<Types::ListAttachedLinksItem>]
514
+ #
515
+ # @!attribute [rw] next_token
516
+ # The token to use when requesting the next set of links.
517
+ # @return [String]
518
+ #
519
+ # @see http://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/ListAttachedLinksOutput AWS API Documentation
520
+ #
521
+ class ListAttachedLinksOutput < Struct.new(
522
+ :items,
523
+ :next_token)
524
+ SENSITIVE = []
525
+ include Aws::Structure
526
+ end
527
+
528
+ # @note When making an API call, you may pass ListLinksInput
529
+ # data as a hash:
530
+ #
531
+ # {
532
+ # max_results: 1,
533
+ # next_token: "NextToken",
534
+ # }
535
+ #
536
+ # @!attribute [rw] max_results
537
+ # Limits the number of returned links to the specified number.
538
+ # @return [Integer]
539
+ #
540
+ # @!attribute [rw] next_token
541
+ # The token for the next set of items to return. You received this
542
+ # token from a previous call.
543
+ # @return [String]
544
+ #
545
+ # @see http://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/ListLinksInput AWS API Documentation
546
+ #
547
+ class ListLinksInput < Struct.new(
548
+ :max_results,
549
+ :next_token)
550
+ SENSITIVE = []
551
+ include Aws::Structure
552
+ end
553
+
554
+ # A structure that contains information about one of this source
555
+ # account's links to a monitoring account.
556
+ #
557
+ # @!attribute [rw] arn
558
+ # The ARN of the link.
559
+ # @return [String]
560
+ #
561
+ # @!attribute [rw] id
562
+ # The random ID string that Amazon Web Services generated as part of
563
+ # the link ARN.
564
+ # @return [String]
565
+ #
566
+ # @!attribute [rw] label
567
+ # The label that was assigned to this link at creation, with the
568
+ # variables resolved to their actual values.
569
+ # @return [String]
570
+ #
571
+ # @!attribute [rw] resource_types
572
+ # The resource types supported by this link.
573
+ # @return [Array<String>]
574
+ #
575
+ # @!attribute [rw] sink_arn
576
+ # The ARN of the sink that this link is attached to.
577
+ # @return [String]
578
+ #
579
+ # @see http://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/ListLinksItem AWS API Documentation
580
+ #
581
+ class ListLinksItem < Struct.new(
582
+ :arn,
583
+ :id,
584
+ :label,
585
+ :resource_types,
586
+ :sink_arn)
587
+ SENSITIVE = []
588
+ include Aws::Structure
589
+ end
590
+
591
+ # @!attribute [rw] items
592
+ # An array of structures that contain the information about the
593
+ # returned links.
594
+ # @return [Array<Types::ListLinksItem>]
595
+ #
596
+ # @!attribute [rw] next_token
597
+ # The token to use when requesting the next set of links.
598
+ # @return [String]
599
+ #
600
+ # @see http://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/ListLinksOutput AWS API Documentation
601
+ #
602
+ class ListLinksOutput < Struct.new(
603
+ :items,
604
+ :next_token)
605
+ SENSITIVE = []
606
+ include Aws::Structure
607
+ end
608
+
609
+ # @note When making an API call, you may pass ListSinksInput
610
+ # data as a hash:
611
+ #
612
+ # {
613
+ # max_results: 1,
614
+ # next_token: "NextToken",
615
+ # }
616
+ #
617
+ # @!attribute [rw] max_results
618
+ # Limits the number of returned links to the specified number.
619
+ # @return [Integer]
620
+ #
621
+ # @!attribute [rw] next_token
622
+ # The token for the next set of items to return. You received this
623
+ # token from a previous call.
624
+ # @return [String]
625
+ #
626
+ # @see http://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/ListSinksInput AWS API Documentation
627
+ #
628
+ class ListSinksInput < Struct.new(
629
+ :max_results,
630
+ :next_token)
631
+ SENSITIVE = []
632
+ include Aws::Structure
633
+ end
634
+
635
+ # A structure that contains information about one of this monitoring
636
+ # account's sinks.
637
+ #
638
+ # @!attribute [rw] arn
639
+ # The ARN of the sink.
640
+ # @return [String]
641
+ #
642
+ # @!attribute [rw] id
643
+ # The random ID string that Amazon Web Services generated as part of
644
+ # the sink ARN.
645
+ # @return [String]
646
+ #
647
+ # @!attribute [rw] name
648
+ # The name of the sink.
649
+ # @return [String]
650
+ #
651
+ # @see http://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/ListSinksItem AWS API Documentation
652
+ #
653
+ class ListSinksItem < Struct.new(
654
+ :arn,
655
+ :id,
656
+ :name)
657
+ SENSITIVE = []
658
+ include Aws::Structure
659
+ end
660
+
661
+ # @!attribute [rw] items
662
+ # An array of structures that contain the information about the
663
+ # returned sinks.
664
+ # @return [Array<Types::ListSinksItem>]
665
+ #
666
+ # @!attribute [rw] next_token
667
+ # The token to use when requesting the next set of sinks.
668
+ # @return [String]
669
+ #
670
+ # @see http://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/ListSinksOutput AWS API Documentation
671
+ #
672
+ class ListSinksOutput < Struct.new(
673
+ :items,
674
+ :next_token)
675
+ SENSITIVE = []
676
+ include Aws::Structure
677
+ end
678
+
679
+ # @note When making an API call, you may pass ListTagsForResourceInput
680
+ # data as a hash:
681
+ #
682
+ # {
683
+ # resource_arn: "Arn", # required
684
+ # }
685
+ #
686
+ # @!attribute [rw] resource_arn
687
+ # The ARN of the resource that you want to view tags for.
688
+ #
689
+ # The ARN format of a sink is
690
+ # `arn:aws:oam:Region:account-id:sink/sink-id `
691
+ #
692
+ # The ARN format of a link is
693
+ # `arn:aws:oam:Region:account-id:link/link-id `
694
+ #
695
+ # For more information about ARN format, see [CloudWatch Logs
696
+ # resources and operations][1].
697
+ #
698
+ # Unlike tagging permissions in other Amazon Web Services services, to
699
+ # retrieve the list of tags for links or sinks you must have the
700
+ # `oam:RequestTag` permission. The `aws:ReguestTag` permission does
701
+ # not allow you to tag and untag links and sinks.
702
+ #
703
+ #
704
+ #
705
+ # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/iam-access-control-overview-cwl.html
706
+ # @return [String]
707
+ #
708
+ # @see http://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/ListTagsForResourceInput AWS API Documentation
709
+ #
710
+ class ListTagsForResourceInput < Struct.new(
711
+ :resource_arn)
712
+ SENSITIVE = []
713
+ include Aws::Structure
714
+ end
715
+
716
+ # @!attribute [rw] tags
717
+ # The list of tags associated with the requested resource.&gt;
718
+ # @return [Hash<String,String>]
719
+ #
720
+ # @see http://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/ListTagsForResourceOutput AWS API Documentation
721
+ #
722
+ class ListTagsForResourceOutput < Struct.new(
723
+ :tags)
724
+ SENSITIVE = []
725
+ include Aws::Structure
726
+ end
727
+
728
+ # A required parameter is missing from the request.
729
+ #
730
+ # @!attribute [rw] message
731
+ # @return [String]
732
+ #
733
+ # @!attribute [rw] amzn_error_type
734
+ # The name of the exception.
735
+ # @return [String]
736
+ #
737
+ # @see http://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/MissingRequiredParameterException AWS API Documentation
738
+ #
739
+ class MissingRequiredParameterException < Struct.new(
740
+ :message,
741
+ :amzn_error_type)
742
+ SENSITIVE = []
743
+ include Aws::Structure
744
+ end
745
+
746
+ # @note When making an API call, you may pass PutSinkPolicyInput
747
+ # data as a hash:
748
+ #
749
+ # {
750
+ # sink_identifier: "ResourceIdentifier", # required
751
+ # policy: "SinkPolicy", # required
752
+ # }
753
+ #
754
+ # @!attribute [rw] sink_identifier
755
+ # The ARN of the sink to attach this policy to.
756
+ # @return [String]
757
+ #
758
+ # @!attribute [rw] policy
759
+ # The JSON policy to use. If you are updating an existing policy, the
760
+ # entire existing policy is replaced by what you specify here.
761
+ #
762
+ # The policy must be in JSON string format with quotation marks
763
+ # escaped and no newlines.
764
+ #
765
+ # For examples of different types of policies, see the **Examples**
766
+ # section on this page.
767
+ # @return [String]
768
+ #
769
+ # @see http://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/PutSinkPolicyInput AWS API Documentation
770
+ #
771
+ class PutSinkPolicyInput < Struct.new(
772
+ :sink_identifier,
773
+ :policy)
774
+ SENSITIVE = []
775
+ include Aws::Structure
776
+ end
777
+
778
+ # @!attribute [rw] sink_arn
779
+ # The ARN of the sink.
780
+ # @return [String]
781
+ #
782
+ # @!attribute [rw] sink_id
783
+ # The random ID string that Amazon Web Services generated as part of
784
+ # the sink ARN.
785
+ # @return [String]
786
+ #
787
+ # @!attribute [rw] policy
788
+ # The policy that you specified.
789
+ # @return [String]
790
+ #
791
+ # @see http://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/PutSinkPolicyOutput AWS API Documentation
792
+ #
793
+ class PutSinkPolicyOutput < Struct.new(
794
+ :sink_arn,
795
+ :sink_id,
796
+ :policy)
797
+ SENSITIVE = []
798
+ include Aws::Structure
799
+ end
800
+
801
+ # The request references a resource that does not exist.
802
+ #
803
+ # @!attribute [rw] message
804
+ # @return [String]
805
+ #
806
+ # @!attribute [rw] amzn_error_type
807
+ # The name of the exception.
808
+ # @return [String]
809
+ #
810
+ # @see http://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/ResourceNotFoundException AWS API Documentation
811
+ #
812
+ class ResourceNotFoundException < Struct.new(
813
+ :message,
814
+ :amzn_error_type)
815
+ SENSITIVE = []
816
+ include Aws::Structure
817
+ end
818
+
819
+ # The request would cause a service quota to be exceeded.
820
+ #
821
+ # @!attribute [rw] message
822
+ # @return [String]
823
+ #
824
+ # @!attribute [rw] amzn_error_type
825
+ # The name of the exception.
826
+ # @return [String]
827
+ #
828
+ # @see http://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/ServiceQuotaExceededException AWS API Documentation
829
+ #
830
+ class ServiceQuotaExceededException < Struct.new(
831
+ :message,
832
+ :amzn_error_type)
833
+ SENSITIVE = []
834
+ include Aws::Structure
835
+ end
836
+
837
+ # @note When making an API call, you may pass TagResourceInput
838
+ # data as a hash:
839
+ #
840
+ # {
841
+ # resource_arn: "Arn", # required
842
+ # tags: { # required
843
+ # "TagKey" => "TagValue",
844
+ # },
845
+ # }
846
+ #
847
+ # @!attribute [rw] resource_arn
848
+ # The ARN of the resource that you're adding tags to.
849
+ #
850
+ # The ARN format of a sink is
851
+ # `arn:aws:oam:Region:account-id:sink/sink-id `
852
+ #
853
+ # The ARN format of a link is
854
+ # `arn:aws:oam:Region:account-id:link/link-id `
855
+ #
856
+ # For more information about ARN format, see [CloudWatch Logs
857
+ # resources and operations][1].
858
+ #
859
+ #
860
+ #
861
+ # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/iam-access-control-overview-cwl.html
862
+ # @return [String]
863
+ #
864
+ # @!attribute [rw] tags
865
+ # The list of key-value pairs to associate with the resource.
866
+ # @return [Hash<String,String>]
867
+ #
868
+ # @see http://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/TagResourceInput AWS API Documentation
869
+ #
870
+ class TagResourceInput < Struct.new(
871
+ :resource_arn,
872
+ :tags)
873
+ SENSITIVE = []
874
+ include Aws::Structure
875
+ end
876
+
877
+ # @see http://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/TagResourceOutput AWS API Documentation
878
+ #
879
+ class TagResourceOutput < Aws::EmptyStructure; end
880
+
881
+ # A resource can have no more than 50 tags.
882
+ #
883
+ # @!attribute [rw] message
884
+ # @return [String]
885
+ #
886
+ # @see http://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/TooManyTagsException AWS API Documentation
887
+ #
888
+ class TooManyTagsException < Struct.new(
889
+ :message)
890
+ SENSITIVE = []
891
+ include Aws::Structure
892
+ end
893
+
894
+ # @note When making an API call, you may pass UntagResourceInput
895
+ # data as a hash:
896
+ #
897
+ # {
898
+ # resource_arn: "Arn", # required
899
+ # tag_keys: ["TagKey"], # required
900
+ # }
901
+ #
902
+ # @!attribute [rw] resource_arn
903
+ # The ARN of the resource that you're removing tags from.
904
+ #
905
+ # The ARN format of a sink is
906
+ # `arn:aws:oam:Region:account-id:sink/sink-id `
907
+ #
908
+ # The ARN format of a link is
909
+ # `arn:aws:oam:Region:account-id:link/link-id `
910
+ #
911
+ # For more information about ARN format, see [CloudWatch Logs
912
+ # resources and operations][1].
913
+ #
914
+ #
915
+ #
916
+ # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/iam-access-control-overview-cwl.html
917
+ # @return [String]
918
+ #
919
+ # @!attribute [rw] tag_keys
920
+ # The list of tag keys to remove from the resource.
921
+ # @return [Array<String>]
922
+ #
923
+ # @see http://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/UntagResourceInput AWS API Documentation
924
+ #
925
+ class UntagResourceInput < Struct.new(
926
+ :resource_arn,
927
+ :tag_keys)
928
+ SENSITIVE = []
929
+ include Aws::Structure
930
+ end
931
+
932
+ # @see http://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/UntagResourceOutput AWS API Documentation
933
+ #
934
+ class UntagResourceOutput < Aws::EmptyStructure; end
935
+
936
+ # @note When making an API call, you may pass UpdateLinkInput
937
+ # data as a hash:
938
+ #
939
+ # {
940
+ # identifier: "ResourceIdentifier", # required
941
+ # resource_types: ["AWS::CloudWatch::Metric"], # required, accepts AWS::CloudWatch::Metric, AWS::Logs::LogGroup, AWS::XRay::Trace
942
+ # }
943
+ #
944
+ # @!attribute [rw] identifier
945
+ # The ARN of the link that you want to update.
946
+ # @return [String]
947
+ #
948
+ # @!attribute [rw] resource_types
949
+ # An array of strings that define which types of data that the source
950
+ # account will send to the monitoring account.
951
+ #
952
+ # Your input here replaces the current set of data types that are
953
+ # shared.
954
+ # @return [Array<String>]
955
+ #
956
+ # @see http://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/UpdateLinkInput AWS API Documentation
957
+ #
958
+ class UpdateLinkInput < Struct.new(
959
+ :identifier,
960
+ :resource_types)
961
+ SENSITIVE = []
962
+ include Aws::Structure
963
+ end
964
+
965
+ # @!attribute [rw] arn
966
+ # The ARN of the link that you have updated.
967
+ # @return [String]
968
+ #
969
+ # @!attribute [rw] id
970
+ # The random ID string that Amazon Web Services generated as part of
971
+ # the sink ARN.
972
+ # @return [String]
973
+ #
974
+ # @!attribute [rw] label
975
+ # The label assigned to this link, with the variables resolved to
976
+ # their actual values.
977
+ # @return [String]
978
+ #
979
+ # @!attribute [rw] label_template
980
+ # The exact label template that was specified when the link was
981
+ # created, with the template variables not resolved.
982
+ # @return [String]
983
+ #
984
+ # @!attribute [rw] resource_types
985
+ # The resource types now supported by this link.
986
+ # @return [Array<String>]
987
+ #
988
+ # @!attribute [rw] sink_arn
989
+ # The ARN of the sink that is used for this link.
990
+ # @return [String]
991
+ #
992
+ # @!attribute [rw] tags
993
+ # The tags assigned to the link.
994
+ # @return [Hash<String,String>]
995
+ #
996
+ # @see http://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/UpdateLinkOutput AWS API Documentation
997
+ #
998
+ class UpdateLinkOutput < Struct.new(
999
+ :arn,
1000
+ :id,
1001
+ :label,
1002
+ :label_template,
1003
+ :resource_types,
1004
+ :sink_arn,
1005
+ :tags)
1006
+ SENSITIVE = []
1007
+ include Aws::Structure
1008
+ end
1009
+
1010
+ # The value of a parameter in the request caused an error.
1011
+ #
1012
+ # @!attribute [rw] message
1013
+ # @return [String]
1014
+ #
1015
+ # @see http://docs.aws.amazon.com/goto/WebAPI/oam-2022-06-10/ValidationException AWS API Documentation
1016
+ #
1017
+ class ValidationException < Struct.new(
1018
+ :message)
1019
+ SENSITIVE = []
1020
+ include Aws::Structure
1021
+ end
1022
+
1023
+ end
1024
+ end