aws-sdk-trustedadvisor 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,1247 @@
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::TrustedAdvisor
11
+ module Types
12
+
13
+ # Exception that access has been denied due to insufficient access
14
+ #
15
+ # @!attribute [rw] message
16
+ # @return [String]
17
+ #
18
+ # @see http://docs.aws.amazon.com/goto/WebAPI/trustedadvisor-2022-09-15/AccessDeniedException AWS API Documentation
19
+ #
20
+ class AccessDeniedException < Struct.new(
21
+ :message)
22
+ SENSITIVE = []
23
+ include Aws::Structure
24
+ end
25
+
26
+ # Summary of an AccountRecommendationLifecycle for an Organization
27
+ # Recommendation
28
+ #
29
+ # @!attribute [rw] account_id
30
+ # The AWS account ID
31
+ # @return [String]
32
+ #
33
+ # @!attribute [rw] account_recommendation_arn
34
+ # The Recommendation ARN
35
+ # @return [String]
36
+ #
37
+ # @!attribute [rw] last_updated_at
38
+ # When the Recommendation was last updated
39
+ # @return [Time]
40
+ #
41
+ # @!attribute [rw] lifecycle_stage
42
+ # The lifecycle stage from AWS Trusted Advisor Priority
43
+ # @return [String]
44
+ #
45
+ # @!attribute [rw] update_reason
46
+ # Reason for the lifecycle stage change
47
+ # @return [String]
48
+ #
49
+ # @!attribute [rw] update_reason_code
50
+ # Reason code for the lifecycle state change
51
+ # @return [String]
52
+ #
53
+ # @!attribute [rw] updated_on_behalf_of
54
+ # The person on whose behalf a Technical Account Manager (TAM) updated
55
+ # the recommendation. This information is only available when a
56
+ # Technical Account Manager takes an action on a recommendation
57
+ # managed by AWS Trusted Advisor Priority
58
+ # @return [String]
59
+ #
60
+ # @!attribute [rw] updated_on_behalf_of_job_title
61
+ # The job title of the person on whose behalf a Technical Account
62
+ # Manager (TAM) updated the recommendation. This information is only
63
+ # available when a Technical Account Manager takes an action on a
64
+ # recommendation managed by AWS Trusted Advisor Priority
65
+ # @return [String]
66
+ #
67
+ # @see http://docs.aws.amazon.com/goto/WebAPI/trustedadvisor-2022-09-15/AccountRecommendationLifecycleSummary AWS API Documentation
68
+ #
69
+ class AccountRecommendationLifecycleSummary < Struct.new(
70
+ :account_id,
71
+ :account_recommendation_arn,
72
+ :last_updated_at,
73
+ :lifecycle_stage,
74
+ :update_reason,
75
+ :update_reason_code,
76
+ :updated_on_behalf_of,
77
+ :updated_on_behalf_of_job_title)
78
+ SENSITIVE = [:update_reason]
79
+ include Aws::Structure
80
+ end
81
+
82
+ # A summary of an AWS Trusted Advisor Check
83
+ #
84
+ # @!attribute [rw] arn
85
+ # The ARN of the AWS Trusted Advisor Check
86
+ # @return [String]
87
+ #
88
+ # @!attribute [rw] aws_services
89
+ # The AWS Services that the Check applies to
90
+ # @return [Array<String>]
91
+ #
92
+ # @!attribute [rw] description
93
+ # A description of what the AWS Trusted Advisor Check is monitoring
94
+ # @return [String]
95
+ #
96
+ # @!attribute [rw] id
97
+ # The unique identifier of the AWS Trusted Advisor Check
98
+ # @return [String]
99
+ #
100
+ # @!attribute [rw] metadata
101
+ # The column headings for the metadata returned in the resource
102
+ # @return [Hash<String,String>]
103
+ #
104
+ # @!attribute [rw] name
105
+ # The name of the AWS Trusted Advisor Check
106
+ # @return [String]
107
+ #
108
+ # @!attribute [rw] pillars
109
+ # The Recommendation pillars that the AWS Trusted Advisor Check falls
110
+ # under
111
+ # @return [Array<String>]
112
+ #
113
+ # @!attribute [rw] source
114
+ # The source of the Recommendation
115
+ # @return [String]
116
+ #
117
+ # @see http://docs.aws.amazon.com/goto/WebAPI/trustedadvisor-2022-09-15/CheckSummary AWS API Documentation
118
+ #
119
+ class CheckSummary < Struct.new(
120
+ :arn,
121
+ :aws_services,
122
+ :description,
123
+ :id,
124
+ :metadata,
125
+ :name,
126
+ :pillars,
127
+ :source)
128
+ SENSITIVE = []
129
+ include Aws::Structure
130
+ end
131
+
132
+ # Exception that the request was denied due to conflictions in state
133
+ #
134
+ # @!attribute [rw] message
135
+ # @return [String]
136
+ #
137
+ # @see http://docs.aws.amazon.com/goto/WebAPI/trustedadvisor-2022-09-15/ConflictException AWS API Documentation
138
+ #
139
+ class ConflictException < Struct.new(
140
+ :message)
141
+ SENSITIVE = []
142
+ include Aws::Structure
143
+ end
144
+
145
+ # @!attribute [rw] organization_recommendation_identifier
146
+ # The Recommendation identifier
147
+ # @return [String]
148
+ #
149
+ # @see http://docs.aws.amazon.com/goto/WebAPI/trustedadvisor-2022-09-15/GetOrganizationRecommendationRequest AWS API Documentation
150
+ #
151
+ class GetOrganizationRecommendationRequest < Struct.new(
152
+ :organization_recommendation_identifier)
153
+ SENSITIVE = []
154
+ include Aws::Structure
155
+ end
156
+
157
+ # @!attribute [rw] organization_recommendation
158
+ # The Recommendation
159
+ # @return [Types::OrganizationRecommendation]
160
+ #
161
+ # @see http://docs.aws.amazon.com/goto/WebAPI/trustedadvisor-2022-09-15/GetOrganizationRecommendationResponse AWS API Documentation
162
+ #
163
+ class GetOrganizationRecommendationResponse < Struct.new(
164
+ :organization_recommendation)
165
+ SENSITIVE = []
166
+ include Aws::Structure
167
+ end
168
+
169
+ # @!attribute [rw] recommendation_identifier
170
+ # The Recommendation identifier
171
+ # @return [String]
172
+ #
173
+ # @see http://docs.aws.amazon.com/goto/WebAPI/trustedadvisor-2022-09-15/GetRecommendationRequest AWS API Documentation
174
+ #
175
+ class GetRecommendationRequest < Struct.new(
176
+ :recommendation_identifier)
177
+ SENSITIVE = []
178
+ include Aws::Structure
179
+ end
180
+
181
+ # @!attribute [rw] recommendation
182
+ # The Recommendation
183
+ # @return [Types::Recommendation]
184
+ #
185
+ # @see http://docs.aws.amazon.com/goto/WebAPI/trustedadvisor-2022-09-15/GetRecommendationResponse AWS API Documentation
186
+ #
187
+ class GetRecommendationResponse < Struct.new(
188
+ :recommendation)
189
+ SENSITIVE = []
190
+ include Aws::Structure
191
+ end
192
+
193
+ # Exception to notify that an unexpected internal error occurred during
194
+ # processing of the request
195
+ #
196
+ # @!attribute [rw] message
197
+ # @return [String]
198
+ #
199
+ # @see http://docs.aws.amazon.com/goto/WebAPI/trustedadvisor-2022-09-15/InternalServerException AWS API Documentation
200
+ #
201
+ class InternalServerException < Struct.new(
202
+ :message)
203
+ SENSITIVE = []
204
+ include Aws::Structure
205
+ end
206
+
207
+ # @!attribute [rw] aws_service
208
+ # The aws service associated with the check
209
+ # @return [String]
210
+ #
211
+ # @!attribute [rw] language
212
+ # The ISO 639-1 code for the language that you want your checks to
213
+ # appear in.
214
+ # @return [String]
215
+ #
216
+ # @!attribute [rw] max_results
217
+ # The maximum number of results to return per page.
218
+ # @return [Integer]
219
+ #
220
+ # @!attribute [rw] next_token
221
+ # The token for the next set of results. Use the value returned in the
222
+ # previous response in the next request to retrieve the next set of
223
+ # results.
224
+ # @return [String]
225
+ #
226
+ # @!attribute [rw] pillar
227
+ # The pillar of the check
228
+ # @return [String]
229
+ #
230
+ # @!attribute [rw] source
231
+ # The source of the check
232
+ # @return [String]
233
+ #
234
+ # @see http://docs.aws.amazon.com/goto/WebAPI/trustedadvisor-2022-09-15/ListChecksRequest AWS API Documentation
235
+ #
236
+ class ListChecksRequest < Struct.new(
237
+ :aws_service,
238
+ :language,
239
+ :max_results,
240
+ :next_token,
241
+ :pillar,
242
+ :source)
243
+ SENSITIVE = []
244
+ include Aws::Structure
245
+ end
246
+
247
+ # @!attribute [rw] check_summaries
248
+ # The list of Checks
249
+ # @return [Array<Types::CheckSummary>]
250
+ #
251
+ # @!attribute [rw] next_token
252
+ # The token for the next set of results. Use the value returned in the
253
+ # previous response in the next request to retrieve the next set of
254
+ # results.
255
+ # @return [String]
256
+ #
257
+ # @see http://docs.aws.amazon.com/goto/WebAPI/trustedadvisor-2022-09-15/ListChecksResponse AWS API Documentation
258
+ #
259
+ class ListChecksResponse < Struct.new(
260
+ :check_summaries,
261
+ :next_token)
262
+ SENSITIVE = []
263
+ include Aws::Structure
264
+ end
265
+
266
+ # @!attribute [rw] affected_account_id
267
+ # An account affected by this organization recommendation
268
+ # @return [String]
269
+ #
270
+ # @!attribute [rw] max_results
271
+ # The maximum number of results to return per page.
272
+ # @return [Integer]
273
+ #
274
+ # @!attribute [rw] next_token
275
+ # The token for the next set of results. Use the value returned in the
276
+ # previous response in the next request to retrieve the next set of
277
+ # results.
278
+ # @return [String]
279
+ #
280
+ # @!attribute [rw] organization_recommendation_identifier
281
+ # The Recommendation identifier
282
+ # @return [String]
283
+ #
284
+ # @see http://docs.aws.amazon.com/goto/WebAPI/trustedadvisor-2022-09-15/ListOrganizationRecommendationAccountsRequest AWS API Documentation
285
+ #
286
+ class ListOrganizationRecommendationAccountsRequest < Struct.new(
287
+ :affected_account_id,
288
+ :max_results,
289
+ :next_token,
290
+ :organization_recommendation_identifier)
291
+ SENSITIVE = []
292
+ include Aws::Structure
293
+ end
294
+
295
+ # @!attribute [rw] account_recommendation_lifecycle_summaries
296
+ # The account recommendations lifecycles that are applicable to the
297
+ # Recommendation
298
+ # @return [Array<Types::AccountRecommendationLifecycleSummary>]
299
+ #
300
+ # @!attribute [rw] next_token
301
+ # The token for the next set of results. Use the value returned in the
302
+ # previous response in the next request to retrieve the next set of
303
+ # results.
304
+ # @return [String]
305
+ #
306
+ # @see http://docs.aws.amazon.com/goto/WebAPI/trustedadvisor-2022-09-15/ListOrganizationRecommendationAccountsResponse AWS API Documentation
307
+ #
308
+ class ListOrganizationRecommendationAccountsResponse < Struct.new(
309
+ :account_recommendation_lifecycle_summaries,
310
+ :next_token)
311
+ SENSITIVE = []
312
+ include Aws::Structure
313
+ end
314
+
315
+ # @!attribute [rw] affected_account_id
316
+ # An account affected by this organization recommendation
317
+ # @return [String]
318
+ #
319
+ # @!attribute [rw] max_results
320
+ # The maximum number of results to return per page.
321
+ # @return [Integer]
322
+ #
323
+ # @!attribute [rw] next_token
324
+ # The token for the next set of results. Use the value returned in the
325
+ # previous response in the next request to retrieve the next set of
326
+ # results.
327
+ # @return [String]
328
+ #
329
+ # @!attribute [rw] organization_recommendation_identifier
330
+ # The AWS Organization organization's Recommendation identifier
331
+ # @return [String]
332
+ #
333
+ # @!attribute [rw] region_code
334
+ # The AWS Region code of the resource
335
+ # @return [String]
336
+ #
337
+ # @!attribute [rw] status
338
+ # The status of the resource
339
+ # @return [String]
340
+ #
341
+ # @see http://docs.aws.amazon.com/goto/WebAPI/trustedadvisor-2022-09-15/ListOrganizationRecommendationResourcesRequest AWS API Documentation
342
+ #
343
+ class ListOrganizationRecommendationResourcesRequest < Struct.new(
344
+ :affected_account_id,
345
+ :max_results,
346
+ :next_token,
347
+ :organization_recommendation_identifier,
348
+ :region_code,
349
+ :status)
350
+ SENSITIVE = []
351
+ include Aws::Structure
352
+ end
353
+
354
+ # @!attribute [rw] next_token
355
+ # The token for the next set of results. Use the value returned in the
356
+ # previous response in the next request to retrieve the next set of
357
+ # results.
358
+ # @return [String]
359
+ #
360
+ # @!attribute [rw] organization_recommendation_resource_summaries
361
+ # A list of Recommendation Resources
362
+ # @return [Array<Types::OrganizationRecommendationResourceSummary>]
363
+ #
364
+ # @see http://docs.aws.amazon.com/goto/WebAPI/trustedadvisor-2022-09-15/ListOrganizationRecommendationResourcesResponse AWS API Documentation
365
+ #
366
+ class ListOrganizationRecommendationResourcesResponse < Struct.new(
367
+ :next_token,
368
+ :organization_recommendation_resource_summaries)
369
+ SENSITIVE = []
370
+ include Aws::Structure
371
+ end
372
+
373
+ # @!attribute [rw] after_last_updated_at
374
+ # After the last update of the Recommendation
375
+ # @return [Time]
376
+ #
377
+ # @!attribute [rw] aws_service
378
+ # The aws service associated with the Recommendation
379
+ # @return [String]
380
+ #
381
+ # @!attribute [rw] before_last_updated_at
382
+ # Before the last update of the Recommendation
383
+ # @return [Time]
384
+ #
385
+ # @!attribute [rw] check_identifier
386
+ # The check identifier of the Recommendation
387
+ # @return [String]
388
+ #
389
+ # @!attribute [rw] max_results
390
+ # The maximum number of results to return per page.
391
+ # @return [Integer]
392
+ #
393
+ # @!attribute [rw] next_token
394
+ # The token for the next set of results. Use the value returned in the
395
+ # previous response in the next request to retrieve the next set of
396
+ # results.
397
+ # @return [String]
398
+ #
399
+ # @!attribute [rw] pillar
400
+ # The pillar of the Recommendation
401
+ # @return [String]
402
+ #
403
+ # @!attribute [rw] source
404
+ # The source of the Recommendation
405
+ # @return [String]
406
+ #
407
+ # @!attribute [rw] status
408
+ # The status of the Recommendation
409
+ # @return [String]
410
+ #
411
+ # @!attribute [rw] type
412
+ # The type of the Recommendation
413
+ # @return [String]
414
+ #
415
+ # @see http://docs.aws.amazon.com/goto/WebAPI/trustedadvisor-2022-09-15/ListOrganizationRecommendationsRequest AWS API Documentation
416
+ #
417
+ class ListOrganizationRecommendationsRequest < Struct.new(
418
+ :after_last_updated_at,
419
+ :aws_service,
420
+ :before_last_updated_at,
421
+ :check_identifier,
422
+ :max_results,
423
+ :next_token,
424
+ :pillar,
425
+ :source,
426
+ :status,
427
+ :type)
428
+ SENSITIVE = []
429
+ include Aws::Structure
430
+ end
431
+
432
+ # @!attribute [rw] next_token
433
+ # The token for the next set of results. Use the value returned in the
434
+ # previous response in the next request to retrieve the next set of
435
+ # results.
436
+ # @return [String]
437
+ #
438
+ # @!attribute [rw] organization_recommendation_summaries
439
+ # The list of Recommendations
440
+ # @return [Array<Types::OrganizationRecommendationSummary>]
441
+ #
442
+ # @see http://docs.aws.amazon.com/goto/WebAPI/trustedadvisor-2022-09-15/ListOrganizationRecommendationsResponse AWS API Documentation
443
+ #
444
+ class ListOrganizationRecommendationsResponse < Struct.new(
445
+ :next_token,
446
+ :organization_recommendation_summaries)
447
+ SENSITIVE = []
448
+ include Aws::Structure
449
+ end
450
+
451
+ # @!attribute [rw] max_results
452
+ # The maximum number of results to return per page.
453
+ # @return [Integer]
454
+ #
455
+ # @!attribute [rw] next_token
456
+ # The token for the next set of results. Use the value returned in the
457
+ # previous response in the next request to retrieve the next set of
458
+ # results.
459
+ # @return [String]
460
+ #
461
+ # @!attribute [rw] recommendation_identifier
462
+ # The Recommendation identifier
463
+ # @return [String]
464
+ #
465
+ # @!attribute [rw] region_code
466
+ # The AWS Region code of the resource
467
+ # @return [String]
468
+ #
469
+ # @!attribute [rw] status
470
+ # The status of the resource
471
+ # @return [String]
472
+ #
473
+ # @see http://docs.aws.amazon.com/goto/WebAPI/trustedadvisor-2022-09-15/ListRecommendationResourcesRequest AWS API Documentation
474
+ #
475
+ class ListRecommendationResourcesRequest < Struct.new(
476
+ :max_results,
477
+ :next_token,
478
+ :recommendation_identifier,
479
+ :region_code,
480
+ :status)
481
+ SENSITIVE = []
482
+ include Aws::Structure
483
+ end
484
+
485
+ # @!attribute [rw] next_token
486
+ # The token for the next set of results. Use the value returned in the
487
+ # previous response in the next request to retrieve the next set of
488
+ # results.
489
+ # @return [String]
490
+ #
491
+ # @!attribute [rw] recommendation_resource_summaries
492
+ # A list of Recommendation Resources
493
+ # @return [Array<Types::RecommendationResourceSummary>]
494
+ #
495
+ # @see http://docs.aws.amazon.com/goto/WebAPI/trustedadvisor-2022-09-15/ListRecommendationResourcesResponse AWS API Documentation
496
+ #
497
+ class ListRecommendationResourcesResponse < Struct.new(
498
+ :next_token,
499
+ :recommendation_resource_summaries)
500
+ SENSITIVE = []
501
+ include Aws::Structure
502
+ end
503
+
504
+ # @!attribute [rw] after_last_updated_at
505
+ # After the last update of the Recommendation
506
+ # @return [Time]
507
+ #
508
+ # @!attribute [rw] aws_service
509
+ # The aws service associated with the Recommendation
510
+ # @return [String]
511
+ #
512
+ # @!attribute [rw] before_last_updated_at
513
+ # Before the last update of the Recommendation
514
+ # @return [Time]
515
+ #
516
+ # @!attribute [rw] check_identifier
517
+ # The check identifier of the Recommendation
518
+ # @return [String]
519
+ #
520
+ # @!attribute [rw] max_results
521
+ # The maximum number of results to return per page.
522
+ # @return [Integer]
523
+ #
524
+ # @!attribute [rw] next_token
525
+ # The token for the next set of results. Use the value returned in the
526
+ # previous response in the next request to retrieve the next set of
527
+ # results.
528
+ # @return [String]
529
+ #
530
+ # @!attribute [rw] pillar
531
+ # The pillar of the Recommendation
532
+ # @return [String]
533
+ #
534
+ # @!attribute [rw] source
535
+ # The source of the Recommendation
536
+ # @return [String]
537
+ #
538
+ # @!attribute [rw] status
539
+ # The status of the Recommendation
540
+ # @return [String]
541
+ #
542
+ # @!attribute [rw] type
543
+ # The type of the Recommendation
544
+ # @return [String]
545
+ #
546
+ # @see http://docs.aws.amazon.com/goto/WebAPI/trustedadvisor-2022-09-15/ListRecommendationsRequest AWS API Documentation
547
+ #
548
+ class ListRecommendationsRequest < Struct.new(
549
+ :after_last_updated_at,
550
+ :aws_service,
551
+ :before_last_updated_at,
552
+ :check_identifier,
553
+ :max_results,
554
+ :next_token,
555
+ :pillar,
556
+ :source,
557
+ :status,
558
+ :type)
559
+ SENSITIVE = []
560
+ include Aws::Structure
561
+ end
562
+
563
+ # @!attribute [rw] next_token
564
+ # The token for the next set of results. Use the value returned in the
565
+ # previous response in the next request to retrieve the next set of
566
+ # results.
567
+ # @return [String]
568
+ #
569
+ # @!attribute [rw] recommendation_summaries
570
+ # The list of Recommendations
571
+ # @return [Array<Types::RecommendationSummary>]
572
+ #
573
+ # @see http://docs.aws.amazon.com/goto/WebAPI/trustedadvisor-2022-09-15/ListRecommendationsResponse AWS API Documentation
574
+ #
575
+ class ListRecommendationsResponse < Struct.new(
576
+ :next_token,
577
+ :recommendation_summaries)
578
+ SENSITIVE = []
579
+ include Aws::Structure
580
+ end
581
+
582
+ # A Recommendation for accounts within an Organization
583
+ #
584
+ # @!attribute [rw] arn
585
+ # The ARN of the Recommendation
586
+ # @return [String]
587
+ #
588
+ # @!attribute [rw] aws_services
589
+ # The AWS Services that the Recommendation applies to
590
+ # @return [Array<String>]
591
+ #
592
+ # @!attribute [rw] check_arn
593
+ # The AWS Trusted Advisor Check ARN that relates to the Recommendation
594
+ # @return [String]
595
+ #
596
+ # @!attribute [rw] created_at
597
+ # When the Recommendation was created, if created by AWS Trusted
598
+ # Advisor Priority
599
+ # @return [Time]
600
+ #
601
+ # @!attribute [rw] created_by
602
+ # The creator, if created by AWS Trusted Advisor Priority
603
+ # @return [String]
604
+ #
605
+ # @!attribute [rw] description
606
+ # A description for AWS Trusted Advisor recommendations
607
+ # @return [String]
608
+ #
609
+ # @!attribute [rw] id
610
+ # The ID which identifies where the Recommendation was produced
611
+ # @return [String]
612
+ #
613
+ # @!attribute [rw] last_updated_at
614
+ # When the Recommendation was last updated
615
+ # @return [Time]
616
+ #
617
+ # @!attribute [rw] lifecycle_stage
618
+ # The lifecycle stage from AWS Trusted Advisor Priority
619
+ # @return [String]
620
+ #
621
+ # @!attribute [rw] name
622
+ # The name of the AWS Trusted Advisor Recommendation
623
+ # @return [String]
624
+ #
625
+ # @!attribute [rw] pillar_specific_aggregates
626
+ # The pillar aggregations for cost savings
627
+ # @return [Types::RecommendationPillarSpecificAggregates]
628
+ #
629
+ # @!attribute [rw] pillars
630
+ # The Pillars that the Recommendation is optimizing
631
+ # @return [Array<String>]
632
+ #
633
+ # @!attribute [rw] resolved_at
634
+ # When the Recommendation was resolved
635
+ # @return [Time]
636
+ #
637
+ # @!attribute [rw] resources_aggregates
638
+ # An aggregation of all resources
639
+ # @return [Types::RecommendationResourcesAggregates]
640
+ #
641
+ # @!attribute [rw] source
642
+ # The source of the Recommendation
643
+ # @return [String]
644
+ #
645
+ # @!attribute [rw] status
646
+ # The status of the Recommendation
647
+ # @return [String]
648
+ #
649
+ # @!attribute [rw] type
650
+ # Whether the Recommendation was automated or generated by AWS Trusted
651
+ # Advisor Priority
652
+ # @return [String]
653
+ #
654
+ # @!attribute [rw] update_reason
655
+ # Reason for the lifecycle stage change
656
+ # @return [String]
657
+ #
658
+ # @!attribute [rw] update_reason_code
659
+ # Reason code for the lifecycle state change
660
+ # @return [String]
661
+ #
662
+ # @!attribute [rw] updated_on_behalf_of
663
+ # The person on whose behalf a Technical Account Manager (TAM) updated
664
+ # the recommendation. This information is only available when a
665
+ # Technical Account Manager takes an action on a recommendation
666
+ # managed by AWS Trusted Advisor Priority
667
+ # @return [String]
668
+ #
669
+ # @!attribute [rw] updated_on_behalf_of_job_title
670
+ # The job title of the person on whose behalf a Technical Account
671
+ # Manager (TAM) updated the recommendation. This information is only
672
+ # available when a Technical Account Manager takes an action on a
673
+ # recommendation managed by AWS Trusted Advisor Priority
674
+ # @return [String]
675
+ #
676
+ # @see http://docs.aws.amazon.com/goto/WebAPI/trustedadvisor-2022-09-15/OrganizationRecommendation AWS API Documentation
677
+ #
678
+ class OrganizationRecommendation < Struct.new(
679
+ :arn,
680
+ :aws_services,
681
+ :check_arn,
682
+ :created_at,
683
+ :created_by,
684
+ :description,
685
+ :id,
686
+ :last_updated_at,
687
+ :lifecycle_stage,
688
+ :name,
689
+ :pillar_specific_aggregates,
690
+ :pillars,
691
+ :resolved_at,
692
+ :resources_aggregates,
693
+ :source,
694
+ :status,
695
+ :type,
696
+ :update_reason,
697
+ :update_reason_code,
698
+ :updated_on_behalf_of,
699
+ :updated_on_behalf_of_job_title)
700
+ SENSITIVE = [:update_reason]
701
+ include Aws::Structure
702
+ end
703
+
704
+ # Organization Recommendation Resource Summary
705
+ #
706
+ # @!attribute [rw] account_id
707
+ # The AWS account ID
708
+ # @return [String]
709
+ #
710
+ # @!attribute [rw] arn
711
+ # The ARN of the Recommendation Resource
712
+ # @return [String]
713
+ #
714
+ # @!attribute [rw] aws_resource_id
715
+ # The AWS resource identifier
716
+ # @return [String]
717
+ #
718
+ # @!attribute [rw] id
719
+ # The ID of the Recommendation Resource
720
+ # @return [String]
721
+ #
722
+ # @!attribute [rw] last_updated_at
723
+ # When the Recommendation Resource was last updated
724
+ # @return [Time]
725
+ #
726
+ # @!attribute [rw] metadata
727
+ # Metadata associated with the Recommendation Resource
728
+ # @return [Hash<String,String>]
729
+ #
730
+ # @!attribute [rw] recommendation_arn
731
+ # The Recommendation ARN
732
+ # @return [String]
733
+ #
734
+ # @!attribute [rw] region_code
735
+ # The AWS Region code that the Recommendation Resource is in
736
+ # @return [String]
737
+ #
738
+ # @!attribute [rw] status
739
+ # The current status of the Recommendation Resource
740
+ # @return [String]
741
+ #
742
+ # @see http://docs.aws.amazon.com/goto/WebAPI/trustedadvisor-2022-09-15/OrganizationRecommendationResourceSummary AWS API Documentation
743
+ #
744
+ class OrganizationRecommendationResourceSummary < Struct.new(
745
+ :account_id,
746
+ :arn,
747
+ :aws_resource_id,
748
+ :id,
749
+ :last_updated_at,
750
+ :metadata,
751
+ :recommendation_arn,
752
+ :region_code,
753
+ :status)
754
+ SENSITIVE = []
755
+ include Aws::Structure
756
+ end
757
+
758
+ # Summary of recommendation for accounts within an Organization
759
+ #
760
+ # @!attribute [rw] arn
761
+ # The ARN of the Recommendation
762
+ # @return [String]
763
+ #
764
+ # @!attribute [rw] aws_services
765
+ # The AWS Services that the Recommendation applies to
766
+ # @return [Array<String>]
767
+ #
768
+ # @!attribute [rw] check_arn
769
+ # The AWS Trusted Advisor Check ARN that relates to the Recommendation
770
+ # @return [String]
771
+ #
772
+ # @!attribute [rw] created_at
773
+ # When the Recommendation was created, if created by AWS Trusted
774
+ # Advisor Priority
775
+ # @return [Time]
776
+ #
777
+ # @!attribute [rw] id
778
+ # The ID which identifies where the Recommendation was produced
779
+ # @return [String]
780
+ #
781
+ # @!attribute [rw] last_updated_at
782
+ # When the Recommendation was last updated
783
+ # @return [Time]
784
+ #
785
+ # @!attribute [rw] lifecycle_stage
786
+ # The lifecycle stage from AWS Trusted Advisor Priority
787
+ # @return [String]
788
+ #
789
+ # @!attribute [rw] name
790
+ # The name of the AWS Trusted Advisor Recommendation
791
+ # @return [String]
792
+ #
793
+ # @!attribute [rw] pillar_specific_aggregates
794
+ # The pillar aggregations for cost savings
795
+ # @return [Types::RecommendationPillarSpecificAggregates]
796
+ #
797
+ # @!attribute [rw] pillars
798
+ # The Pillars that the Recommendation is optimizing
799
+ # @return [Array<String>]
800
+ #
801
+ # @!attribute [rw] resources_aggregates
802
+ # An aggregation of all resources
803
+ # @return [Types::RecommendationResourcesAggregates]
804
+ #
805
+ # @!attribute [rw] source
806
+ # The source of the Recommendation
807
+ # @return [String]
808
+ #
809
+ # @!attribute [rw] status
810
+ # The status of the Recommendation
811
+ # @return [String]
812
+ #
813
+ # @!attribute [rw] type
814
+ # Whether the Recommendation was automated or generated by AWS Trusted
815
+ # Advisor Priority
816
+ # @return [String]
817
+ #
818
+ # @see http://docs.aws.amazon.com/goto/WebAPI/trustedadvisor-2022-09-15/OrganizationRecommendationSummary AWS API Documentation
819
+ #
820
+ class OrganizationRecommendationSummary < Struct.new(
821
+ :arn,
822
+ :aws_services,
823
+ :check_arn,
824
+ :created_at,
825
+ :id,
826
+ :last_updated_at,
827
+ :lifecycle_stage,
828
+ :name,
829
+ :pillar_specific_aggregates,
830
+ :pillars,
831
+ :resources_aggregates,
832
+ :source,
833
+ :status,
834
+ :type)
835
+ SENSITIVE = []
836
+ include Aws::Structure
837
+ end
838
+
839
+ # A Recommendation for an Account
840
+ #
841
+ # @!attribute [rw] arn
842
+ # The ARN of the Recommendation
843
+ # @return [String]
844
+ #
845
+ # @!attribute [rw] aws_services
846
+ # The AWS Services that the Recommendation applies to
847
+ # @return [Array<String>]
848
+ #
849
+ # @!attribute [rw] check_arn
850
+ # The AWS Trusted Advisor Check ARN that relates to the Recommendation
851
+ # @return [String]
852
+ #
853
+ # @!attribute [rw] created_at
854
+ # When the Recommendation was created, if created by AWS Trusted
855
+ # Advisor Priority
856
+ # @return [Time]
857
+ #
858
+ # @!attribute [rw] created_by
859
+ # The creator, if created by AWS Trusted Advisor Priority
860
+ # @return [String]
861
+ #
862
+ # @!attribute [rw] description
863
+ # A description for AWS Trusted Advisor recommendations
864
+ # @return [String]
865
+ #
866
+ # @!attribute [rw] id
867
+ # The ID which identifies where the Recommendation was produced
868
+ # @return [String]
869
+ #
870
+ # @!attribute [rw] last_updated_at
871
+ # When the Recommendation was last updated
872
+ # @return [Time]
873
+ #
874
+ # @!attribute [rw] lifecycle_stage
875
+ # The lifecycle stage from AWS Trusted Advisor Priority
876
+ # @return [String]
877
+ #
878
+ # @!attribute [rw] name
879
+ # The name of the AWS Trusted Advisor Recommendation
880
+ # @return [String]
881
+ #
882
+ # @!attribute [rw] pillar_specific_aggregates
883
+ # The pillar aggregations for cost savings
884
+ # @return [Types::RecommendationPillarSpecificAggregates]
885
+ #
886
+ # @!attribute [rw] pillars
887
+ # The Pillars that the Recommendation is optimizing
888
+ # @return [Array<String>]
889
+ #
890
+ # @!attribute [rw] resolved_at
891
+ # When the Recommendation was resolved
892
+ # @return [Time]
893
+ #
894
+ # @!attribute [rw] resources_aggregates
895
+ # An aggregation of all resources
896
+ # @return [Types::RecommendationResourcesAggregates]
897
+ #
898
+ # @!attribute [rw] source
899
+ # The source of the Recommendation
900
+ # @return [String]
901
+ #
902
+ # @!attribute [rw] status
903
+ # The status of the Recommendation
904
+ # @return [String]
905
+ #
906
+ # @!attribute [rw] type
907
+ # Whether the Recommendation was automated or generated by AWS Trusted
908
+ # Advisor Priority
909
+ # @return [String]
910
+ #
911
+ # @!attribute [rw] update_reason
912
+ # Reason for the lifecycle stage change
913
+ # @return [String]
914
+ #
915
+ # @!attribute [rw] update_reason_code
916
+ # Reason code for the lifecycle state change
917
+ # @return [String]
918
+ #
919
+ # @!attribute [rw] updated_on_behalf_of
920
+ # The person on whose behalf a Technical Account Manager (TAM) updated
921
+ # the recommendation. This information is only available when a
922
+ # Technical Account Manager takes an action on a recommendation
923
+ # managed by AWS Trusted Advisor Priority
924
+ # @return [String]
925
+ #
926
+ # @!attribute [rw] updated_on_behalf_of_job_title
927
+ # The job title of the person on whose behalf a Technical Account
928
+ # Manager (TAM) updated the recommendation. This information is only
929
+ # available when a Technical Account Manager takes an action on a
930
+ # recommendation managed by AWS Trusted Advisor Priority
931
+ # @return [String]
932
+ #
933
+ # @see http://docs.aws.amazon.com/goto/WebAPI/trustedadvisor-2022-09-15/Recommendation AWS API Documentation
934
+ #
935
+ class Recommendation < Struct.new(
936
+ :arn,
937
+ :aws_services,
938
+ :check_arn,
939
+ :created_at,
940
+ :created_by,
941
+ :description,
942
+ :id,
943
+ :last_updated_at,
944
+ :lifecycle_stage,
945
+ :name,
946
+ :pillar_specific_aggregates,
947
+ :pillars,
948
+ :resolved_at,
949
+ :resources_aggregates,
950
+ :source,
951
+ :status,
952
+ :type,
953
+ :update_reason,
954
+ :update_reason_code,
955
+ :updated_on_behalf_of,
956
+ :updated_on_behalf_of_job_title)
957
+ SENSITIVE = [:update_reason]
958
+ include Aws::Structure
959
+ end
960
+
961
+ # Cost optimizing aggregates for a Recommendation
962
+ #
963
+ # @!attribute [rw] estimated_monthly_savings
964
+ # The estimated monthly savings
965
+ # @return [Float]
966
+ #
967
+ # @!attribute [rw] estimated_percent_monthly_savings
968
+ # The estimated percently monthly savings
969
+ # @return [Float]
970
+ #
971
+ # @see http://docs.aws.amazon.com/goto/WebAPI/trustedadvisor-2022-09-15/RecommendationCostOptimizingAggregates AWS API Documentation
972
+ #
973
+ class RecommendationCostOptimizingAggregates < Struct.new(
974
+ :estimated_monthly_savings,
975
+ :estimated_percent_monthly_savings)
976
+ SENSITIVE = []
977
+ include Aws::Structure
978
+ end
979
+
980
+ # Recommendation pillar aggregates
981
+ #
982
+ # @!attribute [rw] cost_optimizing
983
+ # Cost optimizing aggregates
984
+ # @return [Types::RecommendationCostOptimizingAggregates]
985
+ #
986
+ # @see http://docs.aws.amazon.com/goto/WebAPI/trustedadvisor-2022-09-15/RecommendationPillarSpecificAggregates AWS API Documentation
987
+ #
988
+ class RecommendationPillarSpecificAggregates < Struct.new(
989
+ :cost_optimizing)
990
+ SENSITIVE = []
991
+ include Aws::Structure
992
+ end
993
+
994
+ # Summary of a Recommendation Resource
995
+ #
996
+ # @!attribute [rw] arn
997
+ # The ARN of the Recommendation Resource
998
+ # @return [String]
999
+ #
1000
+ # @!attribute [rw] aws_resource_id
1001
+ # The AWS resource identifier
1002
+ # @return [String]
1003
+ #
1004
+ # @!attribute [rw] id
1005
+ # The ID of the Recommendation Resource
1006
+ # @return [String]
1007
+ #
1008
+ # @!attribute [rw] last_updated_at
1009
+ # When the Recommendation Resource was last updated
1010
+ # @return [Time]
1011
+ #
1012
+ # @!attribute [rw] metadata
1013
+ # Metadata associated with the Recommendation Resource
1014
+ # @return [Hash<String,String>]
1015
+ #
1016
+ # @!attribute [rw] recommendation_arn
1017
+ # The Recommendation ARN
1018
+ # @return [String]
1019
+ #
1020
+ # @!attribute [rw] region_code
1021
+ # The AWS Region code that the Recommendation Resource is in
1022
+ # @return [String]
1023
+ #
1024
+ # @!attribute [rw] status
1025
+ # The current status of the Recommendation Resource
1026
+ # @return [String]
1027
+ #
1028
+ # @see http://docs.aws.amazon.com/goto/WebAPI/trustedadvisor-2022-09-15/RecommendationResourceSummary AWS API Documentation
1029
+ #
1030
+ class RecommendationResourceSummary < Struct.new(
1031
+ :arn,
1032
+ :aws_resource_id,
1033
+ :id,
1034
+ :last_updated_at,
1035
+ :metadata,
1036
+ :recommendation_arn,
1037
+ :region_code,
1038
+ :status)
1039
+ SENSITIVE = []
1040
+ include Aws::Structure
1041
+ end
1042
+
1043
+ # Aggregation of Recommendation Resources
1044
+ #
1045
+ # @!attribute [rw] error_count
1046
+ # The number of AWS resources that were flagged to have errors
1047
+ # according to the Trusted Advisor check
1048
+ # @return [Integer]
1049
+ #
1050
+ # @!attribute [rw] ok_count
1051
+ # The number of AWS resources that were flagged to be OK according to
1052
+ # the Trusted Advisor check
1053
+ # @return [Integer]
1054
+ #
1055
+ # @!attribute [rw] warning_count
1056
+ # The number of AWS resources that were flagged to have warning
1057
+ # according to the Trusted Advisor check
1058
+ # @return [Integer]
1059
+ #
1060
+ # @see http://docs.aws.amazon.com/goto/WebAPI/trustedadvisor-2022-09-15/RecommendationResourcesAggregates AWS API Documentation
1061
+ #
1062
+ class RecommendationResourcesAggregates < Struct.new(
1063
+ :error_count,
1064
+ :ok_count,
1065
+ :warning_count)
1066
+ SENSITIVE = []
1067
+ include Aws::Structure
1068
+ end
1069
+
1070
+ # Summary of Recommendation for an Account
1071
+ #
1072
+ # @!attribute [rw] arn
1073
+ # The ARN of the Recommendation
1074
+ # @return [String]
1075
+ #
1076
+ # @!attribute [rw] aws_services
1077
+ # The AWS Services that the Recommendation applies to
1078
+ # @return [Array<String>]
1079
+ #
1080
+ # @!attribute [rw] check_arn
1081
+ # The AWS Trusted Advisor Check ARN that relates to the Recommendation
1082
+ # @return [String]
1083
+ #
1084
+ # @!attribute [rw] created_at
1085
+ # When the Recommendation was created, if created by AWS Trusted
1086
+ # Advisor Priority
1087
+ # @return [Time]
1088
+ #
1089
+ # @!attribute [rw] id
1090
+ # The ID which identifies where the Recommendation was produced
1091
+ # @return [String]
1092
+ #
1093
+ # @!attribute [rw] last_updated_at
1094
+ # When the Recommendation was last updated
1095
+ # @return [Time]
1096
+ #
1097
+ # @!attribute [rw] lifecycle_stage
1098
+ # The lifecycle stage from AWS Trusted Advisor Priority
1099
+ # @return [String]
1100
+ #
1101
+ # @!attribute [rw] name
1102
+ # The name of the AWS Trusted Advisor Recommendation
1103
+ # @return [String]
1104
+ #
1105
+ # @!attribute [rw] pillar_specific_aggregates
1106
+ # The pillar aggregations for cost savings
1107
+ # @return [Types::RecommendationPillarSpecificAggregates]
1108
+ #
1109
+ # @!attribute [rw] pillars
1110
+ # The Pillars that the Recommendation is optimizing
1111
+ # @return [Array<String>]
1112
+ #
1113
+ # @!attribute [rw] resources_aggregates
1114
+ # An aggregation of all resources
1115
+ # @return [Types::RecommendationResourcesAggregates]
1116
+ #
1117
+ # @!attribute [rw] source
1118
+ # The source of the Recommendation
1119
+ # @return [String]
1120
+ #
1121
+ # @!attribute [rw] status
1122
+ # The status of the Recommendation
1123
+ # @return [String]
1124
+ #
1125
+ # @!attribute [rw] type
1126
+ # Whether the Recommendation was automated or generated by AWS Trusted
1127
+ # Advisor Priority
1128
+ # @return [String]
1129
+ #
1130
+ # @see http://docs.aws.amazon.com/goto/WebAPI/trustedadvisor-2022-09-15/RecommendationSummary AWS API Documentation
1131
+ #
1132
+ class RecommendationSummary < Struct.new(
1133
+ :arn,
1134
+ :aws_services,
1135
+ :check_arn,
1136
+ :created_at,
1137
+ :id,
1138
+ :last_updated_at,
1139
+ :lifecycle_stage,
1140
+ :name,
1141
+ :pillar_specific_aggregates,
1142
+ :pillars,
1143
+ :resources_aggregates,
1144
+ :source,
1145
+ :status,
1146
+ :type)
1147
+ SENSITIVE = []
1148
+ include Aws::Structure
1149
+ end
1150
+
1151
+ # Exception that the requested resource has not been found
1152
+ #
1153
+ # @!attribute [rw] message
1154
+ # @return [String]
1155
+ #
1156
+ # @see http://docs.aws.amazon.com/goto/WebAPI/trustedadvisor-2022-09-15/ResourceNotFoundException AWS API Documentation
1157
+ #
1158
+ class ResourceNotFoundException < Struct.new(
1159
+ :message)
1160
+ SENSITIVE = []
1161
+ include Aws::Structure
1162
+ end
1163
+
1164
+ # Exception to notify that requests are being throttled
1165
+ #
1166
+ # @!attribute [rw] message
1167
+ # @return [String]
1168
+ #
1169
+ # @see http://docs.aws.amazon.com/goto/WebAPI/trustedadvisor-2022-09-15/ThrottlingException AWS API Documentation
1170
+ #
1171
+ class ThrottlingException < Struct.new(
1172
+ :message)
1173
+ SENSITIVE = []
1174
+ include Aws::Structure
1175
+ end
1176
+
1177
+ # @!attribute [rw] lifecycle_stage
1178
+ # The new lifecycle stage
1179
+ # @return [String]
1180
+ #
1181
+ # @!attribute [rw] organization_recommendation_identifier
1182
+ # The Recommendation identifier for AWS Trusted Advisor Priority
1183
+ # recommendations
1184
+ # @return [String]
1185
+ #
1186
+ # @!attribute [rw] update_reason
1187
+ # Reason for the lifecycle stage change
1188
+ # @return [String]
1189
+ #
1190
+ # @!attribute [rw] update_reason_code
1191
+ # Reason code for the lifecycle state change
1192
+ # @return [String]
1193
+ #
1194
+ # @see http://docs.aws.amazon.com/goto/WebAPI/trustedadvisor-2022-09-15/UpdateOrganizationRecommendationLifecycleRequest AWS API Documentation
1195
+ #
1196
+ class UpdateOrganizationRecommendationLifecycleRequest < Struct.new(
1197
+ :lifecycle_stage,
1198
+ :organization_recommendation_identifier,
1199
+ :update_reason,
1200
+ :update_reason_code)
1201
+ SENSITIVE = [:update_reason]
1202
+ include Aws::Structure
1203
+ end
1204
+
1205
+ # @!attribute [rw] lifecycle_stage
1206
+ # The new lifecycle stage
1207
+ # @return [String]
1208
+ #
1209
+ # @!attribute [rw] recommendation_identifier
1210
+ # The Recommendation identifier for AWS Trusted Advisor Priority
1211
+ # recommendations
1212
+ # @return [String]
1213
+ #
1214
+ # @!attribute [rw] update_reason
1215
+ # Reason for the lifecycle stage change
1216
+ # @return [String]
1217
+ #
1218
+ # @!attribute [rw] update_reason_code
1219
+ # Reason code for the lifecycle state change
1220
+ # @return [String]
1221
+ #
1222
+ # @see http://docs.aws.amazon.com/goto/WebAPI/trustedadvisor-2022-09-15/UpdateRecommendationLifecycleRequest AWS API Documentation
1223
+ #
1224
+ class UpdateRecommendationLifecycleRequest < Struct.new(
1225
+ :lifecycle_stage,
1226
+ :recommendation_identifier,
1227
+ :update_reason,
1228
+ :update_reason_code)
1229
+ SENSITIVE = [:update_reason]
1230
+ include Aws::Structure
1231
+ end
1232
+
1233
+ # Exception that the request failed to satisfy service constraints
1234
+ #
1235
+ # @!attribute [rw] message
1236
+ # @return [String]
1237
+ #
1238
+ # @see http://docs.aws.amazon.com/goto/WebAPI/trustedadvisor-2022-09-15/ValidationException AWS API Documentation
1239
+ #
1240
+ class ValidationException < Struct.new(
1241
+ :message)
1242
+ SENSITIVE = []
1243
+ include Aws::Structure
1244
+ end
1245
+
1246
+ end
1247
+ end