aws-sdk-wellarchitected 1.10.0 → 1.14.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-wellarchitected/client.rb +694 -99
- data/lib/aws-sdk-wellarchitected/client_api.rb +273 -2
- data/lib/aws-sdk-wellarchitected/types.rb +887 -153
- data/lib/aws-sdk-wellarchitected.rb +1 -1
- metadata +4 -4
@@ -54,6 +54,10 @@ module Aws::WellArchitected
|
|
54
54
|
# The helpful resource URL for a question.
|
55
55
|
# @return [String]
|
56
56
|
#
|
57
|
+
# @!attribute [rw] helpful_resource_display_text
|
58
|
+
# The helpful resource text to be displayed.
|
59
|
+
# @return [String]
|
60
|
+
#
|
57
61
|
# @!attribute [rw] choices
|
58
62
|
# List of choices available for a question.
|
59
63
|
# @return [Array<Types::Choice>]
|
@@ -93,6 +97,7 @@ module Aws::WellArchitected
|
|
93
97
|
:question_description,
|
94
98
|
:improvement_plan_url,
|
95
99
|
:helpful_resource_url,
|
100
|
+
:helpful_resource_display_text,
|
96
101
|
:choices,
|
97
102
|
:selected_choices,
|
98
103
|
:choice_answers,
|
@@ -174,12 +179,13 @@ module Aws::WellArchitected
|
|
174
179
|
# }
|
175
180
|
#
|
176
181
|
# @!attribute [rw] workload_id
|
177
|
-
# The ID assigned to the workload. This ID is unique within an
|
178
|
-
# Region.
|
182
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
183
|
+
# Web Services Region.
|
179
184
|
# @return [String]
|
180
185
|
#
|
181
186
|
# @!attribute [rw] lens_aliases
|
182
187
|
# List of lens aliases to associate or disassociate with a workload.
|
188
|
+
# Up to 10 lenses can be specified.
|
183
189
|
#
|
184
190
|
# Identify a lens using its LensSummary$LensAlias.
|
185
191
|
# @return [Array<String>]
|
@@ -207,12 +213,22 @@ module Aws::WellArchitected
|
|
207
213
|
# The description of a choice.
|
208
214
|
# @return [String]
|
209
215
|
#
|
216
|
+
# @!attribute [rw] helpful_resource
|
217
|
+
# The choice level helpful resource.
|
218
|
+
# @return [Types::ChoiceContent]
|
219
|
+
#
|
220
|
+
# @!attribute [rw] improvement_plan
|
221
|
+
# The choice level improvement plan.
|
222
|
+
# @return [Types::ChoiceContent]
|
223
|
+
#
|
210
224
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/Choice AWS API Documentation
|
211
225
|
#
|
212
226
|
class Choice < Struct.new(
|
213
227
|
:choice_id,
|
214
228
|
:title,
|
215
|
-
:description
|
229
|
+
:description,
|
230
|
+
:helpful_resource,
|
231
|
+
:improvement_plan)
|
216
232
|
SENSITIVE = []
|
217
233
|
include Aws::Structure
|
218
234
|
end
|
@@ -273,6 +289,51 @@ module Aws::WellArchitected
|
|
273
289
|
include Aws::Structure
|
274
290
|
end
|
275
291
|
|
292
|
+
# The choice content.
|
293
|
+
#
|
294
|
+
# @!attribute [rw] display_text
|
295
|
+
# The display text for the choice content.
|
296
|
+
# @return [String]
|
297
|
+
#
|
298
|
+
# @!attribute [rw] url
|
299
|
+
# The URL for the choice content.
|
300
|
+
# @return [String]
|
301
|
+
#
|
302
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ChoiceContent AWS API Documentation
|
303
|
+
#
|
304
|
+
class ChoiceContent < Struct.new(
|
305
|
+
:display_text,
|
306
|
+
:url)
|
307
|
+
SENSITIVE = []
|
308
|
+
include Aws::Structure
|
309
|
+
end
|
310
|
+
|
311
|
+
# The choice level improvement plan.
|
312
|
+
#
|
313
|
+
# @!attribute [rw] choice_id
|
314
|
+
# The ID of a choice.
|
315
|
+
# @return [String]
|
316
|
+
#
|
317
|
+
# @!attribute [rw] display_text
|
318
|
+
# The display text for the improvement plan.
|
319
|
+
# @return [String]
|
320
|
+
#
|
321
|
+
# @!attribute [rw] improvement_plan_url
|
322
|
+
# The improvement plan URL for a question.
|
323
|
+
#
|
324
|
+
# This value is only available if the question has been answered.
|
325
|
+
# @return [String]
|
326
|
+
#
|
327
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ChoiceImprovementPlan AWS API Documentation
|
328
|
+
#
|
329
|
+
class ChoiceImprovementPlan < Struct.new(
|
330
|
+
:choice_id,
|
331
|
+
:display_text,
|
332
|
+
:improvement_plan_url)
|
333
|
+
SENSITIVE = []
|
334
|
+
include Aws::Structure
|
335
|
+
end
|
336
|
+
|
276
337
|
# A list of choices to be updated.
|
277
338
|
#
|
278
339
|
# @note When making an API call, you may pass ChoiceUpdate
|
@@ -331,6 +392,136 @@ module Aws::WellArchitected
|
|
331
392
|
include Aws::Structure
|
332
393
|
end
|
333
394
|
|
395
|
+
# @note When making an API call, you may pass CreateLensShareInput
|
396
|
+
# data as a hash:
|
397
|
+
#
|
398
|
+
# {
|
399
|
+
# lens_alias: "LensAlias", # required
|
400
|
+
# shared_with: "SharedWith", # required
|
401
|
+
# client_request_token: "ClientRequestToken", # required
|
402
|
+
# }
|
403
|
+
#
|
404
|
+
# @!attribute [rw] lens_alias
|
405
|
+
# The alias of the lens, for example, `serverless`.
|
406
|
+
#
|
407
|
+
# Each lens is identified by its LensSummary$LensAlias.
|
408
|
+
# @return [String]
|
409
|
+
#
|
410
|
+
# @!attribute [rw] shared_with
|
411
|
+
# The Amazon Web Services account ID or IAM role with which the
|
412
|
+
# workload is shared.
|
413
|
+
# @return [String]
|
414
|
+
#
|
415
|
+
# @!attribute [rw] client_request_token
|
416
|
+
# A unique case-sensitive string used to ensure that this request is
|
417
|
+
# idempotent (executes only once).
|
418
|
+
#
|
419
|
+
# You should not reuse the same token for other requests. If you retry
|
420
|
+
# a request with the same client request token and the same parameters
|
421
|
+
# after it has completed successfully, the result of the original
|
422
|
+
# request is returned.
|
423
|
+
#
|
424
|
+
# This token is listed as required, however, if you do not specify it,
|
425
|
+
# the Amazon Web Services SDKs automatically generate one for you. If
|
426
|
+
# you are not using the Amazon Web Services SDK or the CLI, you must
|
427
|
+
# provide this token or the request will fail.
|
428
|
+
#
|
429
|
+
# **A suitable default value is auto-generated.** You should normally
|
430
|
+
# not need to pass this option.
|
431
|
+
# @return [String]
|
432
|
+
#
|
433
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/CreateLensShareInput AWS API Documentation
|
434
|
+
#
|
435
|
+
class CreateLensShareInput < Struct.new(
|
436
|
+
:lens_alias,
|
437
|
+
:shared_with,
|
438
|
+
:client_request_token)
|
439
|
+
SENSITIVE = []
|
440
|
+
include Aws::Structure
|
441
|
+
end
|
442
|
+
|
443
|
+
# @!attribute [rw] share_id
|
444
|
+
# The ID associated with the workload share.
|
445
|
+
# @return [String]
|
446
|
+
#
|
447
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/CreateLensShareOutput AWS API Documentation
|
448
|
+
#
|
449
|
+
class CreateLensShareOutput < Struct.new(
|
450
|
+
:share_id)
|
451
|
+
SENSITIVE = []
|
452
|
+
include Aws::Structure
|
453
|
+
end
|
454
|
+
|
455
|
+
# @note When making an API call, you may pass CreateLensVersionInput
|
456
|
+
# data as a hash:
|
457
|
+
#
|
458
|
+
# {
|
459
|
+
# lens_alias: "LensAlias", # required
|
460
|
+
# lens_version: "LensVersion", # required
|
461
|
+
# is_major_version: false,
|
462
|
+
# client_request_token: "ClientRequestToken", # required
|
463
|
+
# }
|
464
|
+
#
|
465
|
+
# @!attribute [rw] lens_alias
|
466
|
+
# The alias of the lens, for example, `serverless`.
|
467
|
+
#
|
468
|
+
# Each lens is identified by its LensSummary$LensAlias.
|
469
|
+
# @return [String]
|
470
|
+
#
|
471
|
+
# @!attribute [rw] lens_version
|
472
|
+
# The version of the lens being created.
|
473
|
+
# @return [String]
|
474
|
+
#
|
475
|
+
# @!attribute [rw] is_major_version
|
476
|
+
# Set to true if this new major lens version.
|
477
|
+
# @return [Boolean]
|
478
|
+
#
|
479
|
+
# @!attribute [rw] client_request_token
|
480
|
+
# A unique case-sensitive string used to ensure that this request is
|
481
|
+
# idempotent (executes only once).
|
482
|
+
#
|
483
|
+
# You should not reuse the same token for other requests. If you retry
|
484
|
+
# a request with the same client request token and the same parameters
|
485
|
+
# after it has completed successfully, the result of the original
|
486
|
+
# request is returned.
|
487
|
+
#
|
488
|
+
# This token is listed as required, however, if you do not specify it,
|
489
|
+
# the Amazon Web Services SDKs automatically generate one for you. If
|
490
|
+
# you are not using the Amazon Web Services SDK or the CLI, you must
|
491
|
+
# provide this token or the request will fail.
|
492
|
+
#
|
493
|
+
# **A suitable default value is auto-generated.** You should normally
|
494
|
+
# not need to pass this option.
|
495
|
+
# @return [String]
|
496
|
+
#
|
497
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/CreateLensVersionInput AWS API Documentation
|
498
|
+
#
|
499
|
+
class CreateLensVersionInput < Struct.new(
|
500
|
+
:lens_alias,
|
501
|
+
:lens_version,
|
502
|
+
:is_major_version,
|
503
|
+
:client_request_token)
|
504
|
+
SENSITIVE = []
|
505
|
+
include Aws::Structure
|
506
|
+
end
|
507
|
+
|
508
|
+
# @!attribute [rw] lens_arn
|
509
|
+
# The ARN for the lens.
|
510
|
+
# @return [String]
|
511
|
+
#
|
512
|
+
# @!attribute [rw] lens_version
|
513
|
+
# The version of the lens.
|
514
|
+
# @return [String]
|
515
|
+
#
|
516
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/CreateLensVersionOutput AWS API Documentation
|
517
|
+
#
|
518
|
+
class CreateLensVersionOutput < Struct.new(
|
519
|
+
:lens_arn,
|
520
|
+
:lens_version)
|
521
|
+
SENSITIVE = []
|
522
|
+
include Aws::Structure
|
523
|
+
end
|
524
|
+
|
334
525
|
# Input for milestone creation.
|
335
526
|
#
|
336
527
|
# @note When making an API call, you may pass CreateMilestoneInput
|
@@ -343,8 +534,8 @@ module Aws::WellArchitected
|
|
343
534
|
# }
|
344
535
|
#
|
345
536
|
# @!attribute [rw] workload_id
|
346
|
-
# The ID assigned to the workload. This ID is unique within an
|
347
|
-
# Region.
|
537
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
538
|
+
# Web Services Region.
|
348
539
|
# @return [String]
|
349
540
|
#
|
350
541
|
# @!attribute [rw] milestone_name
|
@@ -363,9 +554,9 @@ module Aws::WellArchitected
|
|
363
554
|
# request is returned.
|
364
555
|
#
|
365
556
|
# This token is listed as required, however, if you do not specify it,
|
366
|
-
# the
|
367
|
-
# using the
|
368
|
-
# request will fail.
|
557
|
+
# the Amazon Web Services SDKs automatically generate one for you. If
|
558
|
+
# you are not using the Amazon Web Services SDK or the CLI, you must
|
559
|
+
# provide this token or the request will fail.
|
369
560
|
#
|
370
561
|
# **A suitable default value is auto-generated.** You should normally
|
371
562
|
# not need to pass this option.
|
@@ -384,8 +575,8 @@ module Aws::WellArchitected
|
|
384
575
|
# Output of a create milestone call.
|
385
576
|
#
|
386
577
|
# @!attribute [rw] workload_id
|
387
|
-
# The ID assigned to the workload. This ID is unique within an
|
388
|
-
# Region.
|
578
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
579
|
+
# Web Services Region.
|
389
580
|
# @return [String]
|
390
581
|
#
|
391
582
|
# @!attribute [rw] milestone_number
|
@@ -431,8 +622,9 @@ module Aws::WellArchitected
|
|
431
622
|
# @!attribute [rw] workload_name
|
432
623
|
# The name of the workload.
|
433
624
|
#
|
434
|
-
# The name must be unique within an account within
|
435
|
-
# and capitalization are ignored when checking
|
625
|
+
# The name must be unique within an account within an Amazon Web
|
626
|
+
# Services Region. Spaces and capitalization are ignored when checking
|
627
|
+
# for uniqueness.
|
436
628
|
# @return [String]
|
437
629
|
#
|
438
630
|
# @!attribute [rw] description
|
@@ -444,16 +636,18 @@ module Aws::WellArchitected
|
|
444
636
|
# @return [String]
|
445
637
|
#
|
446
638
|
# @!attribute [rw] account_ids
|
447
|
-
# The list of
|
639
|
+
# The list of Amazon Web Services account IDs associated with the
|
640
|
+
# workload.
|
448
641
|
# @return [Array<String>]
|
449
642
|
#
|
450
643
|
# @!attribute [rw] aws_regions
|
451
|
-
# The list of
|
452
|
-
# `us-east-2`, or `ca-central-1`.
|
644
|
+
# The list of Amazon Web Services Regions associated with the
|
645
|
+
# workload, for example, `us-east-2`, or `ca-central-1`.
|
453
646
|
# @return [Array<String>]
|
454
647
|
#
|
455
648
|
# @!attribute [rw] non_aws_regions
|
456
|
-
# The list of non-
|
649
|
+
# The list of non-Amazon Web Services Regions associated with the
|
650
|
+
# workload.
|
457
651
|
# @return [Array<String>]
|
458
652
|
#
|
459
653
|
# @!attribute [rw] pillar_priorities
|
@@ -555,9 +749,9 @@ module Aws::WellArchitected
|
|
555
749
|
# request is returned.
|
556
750
|
#
|
557
751
|
# This token is listed as required, however, if you do not specify it,
|
558
|
-
# the
|
559
|
-
# using the
|
560
|
-
# request will fail.
|
752
|
+
# the Amazon Web Services SDKs automatically generate one for you. If
|
753
|
+
# you are not using the Amazon Web Services SDK or the CLI, you must
|
754
|
+
# provide this token or the request will fail.
|
561
755
|
#
|
562
756
|
# **A suitable default value is auto-generated.** You should normally
|
563
757
|
# not need to pass this option.
|
@@ -592,8 +786,8 @@ module Aws::WellArchitected
|
|
592
786
|
# Output of a create workload call.
|
593
787
|
#
|
594
788
|
# @!attribute [rw] workload_id
|
595
|
-
# The ID assigned to the workload. This ID is unique within an
|
596
|
-
# Region.
|
789
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
790
|
+
# Web Services Region.
|
597
791
|
# @return [String]
|
598
792
|
#
|
599
793
|
# @!attribute [rw] workload_arn
|
@@ -622,12 +816,13 @@ module Aws::WellArchitected
|
|
622
816
|
# }
|
623
817
|
#
|
624
818
|
# @!attribute [rw] workload_id
|
625
|
-
# The ID assigned to the workload. This ID is unique within an
|
626
|
-
# Region.
|
819
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
820
|
+
# Web Services Region.
|
627
821
|
# @return [String]
|
628
822
|
#
|
629
823
|
# @!attribute [rw] shared_with
|
630
|
-
# The
|
824
|
+
# The Amazon Web Services account ID or IAM role with which the
|
825
|
+
# workload is shared.
|
631
826
|
# @return [String]
|
632
827
|
#
|
633
828
|
# @!attribute [rw] permission_type
|
@@ -644,9 +839,9 @@ module Aws::WellArchitected
|
|
644
839
|
# request is returned.
|
645
840
|
#
|
646
841
|
# This token is listed as required, however, if you do not specify it,
|
647
|
-
# the
|
648
|
-
# using the
|
649
|
-
# request will fail.
|
842
|
+
# the Amazon Web Services SDKs automatically generate one for you. If
|
843
|
+
# you are not using the Amazon Web Services SDK or the CLI, you must
|
844
|
+
# provide this token or the request will fail.
|
650
845
|
#
|
651
846
|
# **A suitable default value is auto-generated.** You should normally
|
652
847
|
# not need to pass this option.
|
@@ -666,8 +861,8 @@ module Aws::WellArchitected
|
|
666
861
|
# Input for Create Workload Share
|
667
862
|
#
|
668
863
|
# @!attribute [rw] workload_id
|
669
|
-
# The ID assigned to the workload. This ID is unique within an
|
670
|
-
# Region.
|
864
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
865
|
+
# Web Services Region.
|
671
866
|
# @return [String]
|
672
867
|
#
|
673
868
|
# @!attribute [rw] share_id
|
@@ -683,6 +878,100 @@ module Aws::WellArchitected
|
|
683
878
|
include Aws::Structure
|
684
879
|
end
|
685
880
|
|
881
|
+
# @note When making an API call, you may pass DeleteLensInput
|
882
|
+
# data as a hash:
|
883
|
+
#
|
884
|
+
# {
|
885
|
+
# lens_alias: "LensAlias", # required
|
886
|
+
# client_request_token: "ClientRequestToken", # required
|
887
|
+
# lens_status: "ALL", # required, accepts ALL, DRAFT, PUBLISHED
|
888
|
+
# }
|
889
|
+
#
|
890
|
+
# @!attribute [rw] lens_alias
|
891
|
+
# The alias of the lens, for example, `serverless`.
|
892
|
+
#
|
893
|
+
# Each lens is identified by its LensSummary$LensAlias.
|
894
|
+
# @return [String]
|
895
|
+
#
|
896
|
+
# @!attribute [rw] client_request_token
|
897
|
+
# A unique case-sensitive string used to ensure that this request is
|
898
|
+
# idempotent (executes only once).
|
899
|
+
#
|
900
|
+
# You should not reuse the same token for other requests. If you retry
|
901
|
+
# a request with the same client request token and the same parameters
|
902
|
+
# after it has completed successfully, the result of the original
|
903
|
+
# request is returned.
|
904
|
+
#
|
905
|
+
# This token is listed as required, however, if you do not specify it,
|
906
|
+
# the Amazon Web Services SDKs automatically generate one for you. If
|
907
|
+
# you are not using the Amazon Web Services SDK or the CLI, you must
|
908
|
+
# provide this token or the request will fail.
|
909
|
+
#
|
910
|
+
# **A suitable default value is auto-generated.** You should normally
|
911
|
+
# not need to pass this option.
|
912
|
+
# @return [String]
|
913
|
+
#
|
914
|
+
# @!attribute [rw] lens_status
|
915
|
+
# The status of the lens to be deleted.
|
916
|
+
# @return [String]
|
917
|
+
#
|
918
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/DeleteLensInput AWS API Documentation
|
919
|
+
#
|
920
|
+
class DeleteLensInput < Struct.new(
|
921
|
+
:lens_alias,
|
922
|
+
:client_request_token,
|
923
|
+
:lens_status)
|
924
|
+
SENSITIVE = []
|
925
|
+
include Aws::Structure
|
926
|
+
end
|
927
|
+
|
928
|
+
# @note When making an API call, you may pass DeleteLensShareInput
|
929
|
+
# data as a hash:
|
930
|
+
#
|
931
|
+
# {
|
932
|
+
# share_id: "ShareId", # required
|
933
|
+
# lens_alias: "LensAlias", # required
|
934
|
+
# client_request_token: "ClientRequestToken", # required
|
935
|
+
# }
|
936
|
+
#
|
937
|
+
# @!attribute [rw] share_id
|
938
|
+
# The ID associated with the workload share.
|
939
|
+
# @return [String]
|
940
|
+
#
|
941
|
+
# @!attribute [rw] lens_alias
|
942
|
+
# The alias of the lens, for example, `serverless`.
|
943
|
+
#
|
944
|
+
# Each lens is identified by its LensSummary$LensAlias.
|
945
|
+
# @return [String]
|
946
|
+
#
|
947
|
+
# @!attribute [rw] client_request_token
|
948
|
+
# A unique case-sensitive string used to ensure that this request is
|
949
|
+
# idempotent (executes only once).
|
950
|
+
#
|
951
|
+
# You should not reuse the same token for other requests. If you retry
|
952
|
+
# a request with the same client request token and the same parameters
|
953
|
+
# after it has completed successfully, the result of the original
|
954
|
+
# request is returned.
|
955
|
+
#
|
956
|
+
# This token is listed as required, however, if you do not specify it,
|
957
|
+
# the Amazon Web Services SDKs automatically generate one for you. If
|
958
|
+
# you are not using the Amazon Web Services SDK or the CLI, you must
|
959
|
+
# provide this token or the request will fail.
|
960
|
+
#
|
961
|
+
# **A suitable default value is auto-generated.** You should normally
|
962
|
+
# not need to pass this option.
|
963
|
+
# @return [String]
|
964
|
+
#
|
965
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/DeleteLensShareInput AWS API Documentation
|
966
|
+
#
|
967
|
+
class DeleteLensShareInput < Struct.new(
|
968
|
+
:share_id,
|
969
|
+
:lens_alias,
|
970
|
+
:client_request_token)
|
971
|
+
SENSITIVE = []
|
972
|
+
include Aws::Structure
|
973
|
+
end
|
974
|
+
|
686
975
|
# Input for workload deletion.
|
687
976
|
#
|
688
977
|
# @note When making an API call, you may pass DeleteWorkloadInput
|
@@ -694,8 +983,8 @@ module Aws::WellArchitected
|
|
694
983
|
# }
|
695
984
|
#
|
696
985
|
# @!attribute [rw] workload_id
|
697
|
-
# The ID assigned to the workload. This ID is unique within an
|
698
|
-
# Region.
|
986
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
987
|
+
# Web Services Region.
|
699
988
|
# @return [String]
|
700
989
|
#
|
701
990
|
# @!attribute [rw] client_request_token
|
@@ -708,9 +997,9 @@ module Aws::WellArchitected
|
|
708
997
|
# request is returned.
|
709
998
|
#
|
710
999
|
# This token is listed as required, however, if you do not specify it,
|
711
|
-
# the
|
712
|
-
# using the
|
713
|
-
# request will fail.
|
1000
|
+
# the Amazon Web Services SDKs automatically generate one for you. If
|
1001
|
+
# you are not using the Amazon Web Services SDK or the CLI, you must
|
1002
|
+
# provide this token or the request will fail.
|
714
1003
|
#
|
715
1004
|
# **A suitable default value is auto-generated.** You should normally
|
716
1005
|
# not need to pass this option.
|
@@ -741,8 +1030,8 @@ module Aws::WellArchitected
|
|
741
1030
|
# @return [String]
|
742
1031
|
#
|
743
1032
|
# @!attribute [rw] workload_id
|
744
|
-
# The ID assigned to the workload. This ID is unique within an
|
745
|
-
# Region.
|
1033
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
1034
|
+
# Web Services Region.
|
746
1035
|
# @return [String]
|
747
1036
|
#
|
748
1037
|
# @!attribute [rw] client_request_token
|
@@ -755,9 +1044,9 @@ module Aws::WellArchitected
|
|
755
1044
|
# request is returned.
|
756
1045
|
#
|
757
1046
|
# This token is listed as required, however, if you do not specify it,
|
758
|
-
# the
|
759
|
-
# using the
|
760
|
-
# request will fail.
|
1047
|
+
# the Amazon Web Services SDKs automatically generate one for you. If
|
1048
|
+
# you are not using the Amazon Web Services SDK or the CLI, you must
|
1049
|
+
# provide this token or the request will fail.
|
761
1050
|
#
|
762
1051
|
# **A suitable default value is auto-generated.** You should normally
|
763
1052
|
# not need to pass this option.
|
@@ -784,12 +1073,13 @@ module Aws::WellArchitected
|
|
784
1073
|
# }
|
785
1074
|
#
|
786
1075
|
# @!attribute [rw] workload_id
|
787
|
-
# The ID assigned to the workload. This ID is unique within an
|
788
|
-
# Region.
|
1076
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
1077
|
+
# Web Services Region.
|
789
1078
|
# @return [String]
|
790
1079
|
#
|
791
1080
|
# @!attribute [rw] lens_aliases
|
792
1081
|
# List of lens aliases to associate or disassociate with a workload.
|
1082
|
+
# Up to 10 lenses can be specified.
|
793
1083
|
#
|
794
1084
|
# Identify a lens using its LensSummary$LensAlias.
|
795
1085
|
# @return [Array<String>]
|
@@ -803,6 +1093,45 @@ module Aws::WellArchitected
|
|
803
1093
|
include Aws::Structure
|
804
1094
|
end
|
805
1095
|
|
1096
|
+
# @note When making an API call, you may pass ExportLensInput
|
1097
|
+
# data as a hash:
|
1098
|
+
#
|
1099
|
+
# {
|
1100
|
+
# lens_alias: "LensAlias", # required
|
1101
|
+
# lens_version: "LensVersion",
|
1102
|
+
# }
|
1103
|
+
#
|
1104
|
+
# @!attribute [rw] lens_alias
|
1105
|
+
# The alias of the lens, for example, `serverless`.
|
1106
|
+
#
|
1107
|
+
# Each lens is identified by its LensSummary$LensAlias.
|
1108
|
+
# @return [String]
|
1109
|
+
#
|
1110
|
+
# @!attribute [rw] lens_version
|
1111
|
+
# The lens version to be exported.
|
1112
|
+
# @return [String]
|
1113
|
+
#
|
1114
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ExportLensInput AWS API Documentation
|
1115
|
+
#
|
1116
|
+
class ExportLensInput < Struct.new(
|
1117
|
+
:lens_alias,
|
1118
|
+
:lens_version)
|
1119
|
+
SENSITIVE = []
|
1120
|
+
include Aws::Structure
|
1121
|
+
end
|
1122
|
+
|
1123
|
+
# @!attribute [rw] lens_json
|
1124
|
+
# The JSON for the lens.
|
1125
|
+
# @return [String]
|
1126
|
+
#
|
1127
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ExportLensOutput AWS API Documentation
|
1128
|
+
#
|
1129
|
+
class ExportLensOutput < Struct.new(
|
1130
|
+
:lens_json)
|
1131
|
+
SENSITIVE = []
|
1132
|
+
include Aws::Structure
|
1133
|
+
end
|
1134
|
+
|
806
1135
|
# Input to get answer.
|
807
1136
|
#
|
808
1137
|
# @note When making an API call, you may pass GetAnswerInput
|
@@ -816,8 +1145,8 @@ module Aws::WellArchitected
|
|
816
1145
|
# }
|
817
1146
|
#
|
818
1147
|
# @!attribute [rw] workload_id
|
819
|
-
# The ID assigned to the workload. This ID is unique within an
|
820
|
-
# Region.
|
1148
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
1149
|
+
# Web Services Region.
|
821
1150
|
# @return [String]
|
822
1151
|
#
|
823
1152
|
# @!attribute [rw] lens_alias
|
@@ -850,8 +1179,8 @@ module Aws::WellArchitected
|
|
850
1179
|
# Output of a get answer call.
|
851
1180
|
#
|
852
1181
|
# @!attribute [rw] workload_id
|
853
|
-
# The ID assigned to the workload. This ID is unique within an
|
854
|
-
# Region.
|
1182
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
1183
|
+
# Web Services Region.
|
855
1184
|
# @return [String]
|
856
1185
|
#
|
857
1186
|
# @!attribute [rw] milestone_number
|
@@ -866,6 +1195,10 @@ module Aws::WellArchitected
|
|
866
1195
|
# Each lens is identified by its LensSummary$LensAlias.
|
867
1196
|
# @return [String]
|
868
1197
|
#
|
1198
|
+
# @!attribute [rw] lens_arn
|
1199
|
+
# The ARN for the lens.
|
1200
|
+
# @return [String]
|
1201
|
+
#
|
869
1202
|
# @!attribute [rw] answer
|
870
1203
|
# An answer of the question.
|
871
1204
|
# @return [Types::Answer]
|
@@ -876,11 +1209,51 @@ module Aws::WellArchitected
|
|
876
1209
|
:workload_id,
|
877
1210
|
:milestone_number,
|
878
1211
|
:lens_alias,
|
1212
|
+
:lens_arn,
|
879
1213
|
:answer)
|
880
1214
|
SENSITIVE = []
|
881
1215
|
include Aws::Structure
|
882
1216
|
end
|
883
1217
|
|
1218
|
+
# @note When making an API call, you may pass GetLensInput
|
1219
|
+
# data as a hash:
|
1220
|
+
#
|
1221
|
+
# {
|
1222
|
+
# lens_alias: "LensAlias", # required
|
1223
|
+
# lens_version: "LensVersion",
|
1224
|
+
# }
|
1225
|
+
#
|
1226
|
+
# @!attribute [rw] lens_alias
|
1227
|
+
# The alias of the lens, for example, `serverless`.
|
1228
|
+
#
|
1229
|
+
# Each lens is identified by its LensSummary$LensAlias.
|
1230
|
+
# @return [String]
|
1231
|
+
#
|
1232
|
+
# @!attribute [rw] lens_version
|
1233
|
+
# The lens version to be retrieved.
|
1234
|
+
# @return [String]
|
1235
|
+
#
|
1236
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetLensInput AWS API Documentation
|
1237
|
+
#
|
1238
|
+
class GetLensInput < Struct.new(
|
1239
|
+
:lens_alias,
|
1240
|
+
:lens_version)
|
1241
|
+
SENSITIVE = []
|
1242
|
+
include Aws::Structure
|
1243
|
+
end
|
1244
|
+
|
1245
|
+
# @!attribute [rw] lens
|
1246
|
+
# A lens return object.
|
1247
|
+
# @return [Types::Lens]
|
1248
|
+
#
|
1249
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetLensOutput AWS API Documentation
|
1250
|
+
#
|
1251
|
+
class GetLensOutput < Struct.new(
|
1252
|
+
:lens)
|
1253
|
+
SENSITIVE = []
|
1254
|
+
include Aws::Structure
|
1255
|
+
end
|
1256
|
+
|
884
1257
|
# Input to get lens review.
|
885
1258
|
#
|
886
1259
|
# @note When making an API call, you may pass GetLensReviewInput
|
@@ -893,8 +1266,8 @@ module Aws::WellArchitected
|
|
893
1266
|
# }
|
894
1267
|
#
|
895
1268
|
# @!attribute [rw] workload_id
|
896
|
-
# The ID assigned to the workload. This ID is unique within an
|
897
|
-
# Region.
|
1269
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
1270
|
+
# Web Services Region.
|
898
1271
|
# @return [String]
|
899
1272
|
#
|
900
1273
|
# @!attribute [rw] lens_alias
|
@@ -922,8 +1295,8 @@ module Aws::WellArchitected
|
|
922
1295
|
# Output of a get lens review call.
|
923
1296
|
#
|
924
1297
|
# @!attribute [rw] workload_id
|
925
|
-
# The ID assigned to the workload. This ID is unique within an
|
926
|
-
# Region.
|
1298
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
1299
|
+
# Web Services Region.
|
927
1300
|
# @return [String]
|
928
1301
|
#
|
929
1302
|
# @!attribute [rw] milestone_number
|
@@ -958,8 +1331,8 @@ module Aws::WellArchitected
|
|
958
1331
|
# }
|
959
1332
|
#
|
960
1333
|
# @!attribute [rw] workload_id
|
961
|
-
# The ID assigned to the workload. This ID is unique within an
|
962
|
-
# Region.
|
1334
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
1335
|
+
# Web Services Region.
|
963
1336
|
# @return [String]
|
964
1337
|
#
|
965
1338
|
# @!attribute [rw] lens_alias
|
@@ -987,8 +1360,8 @@ module Aws::WellArchitected
|
|
987
1360
|
# Output of a get lens review report call.
|
988
1361
|
#
|
989
1362
|
# @!attribute [rw] workload_id
|
990
|
-
# The ID assigned to the workload. This ID is unique within an
|
991
|
-
# Region.
|
1363
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
1364
|
+
# Web Services Region.
|
992
1365
|
# @return [String]
|
993
1366
|
#
|
994
1367
|
# @!attribute [rw] milestone_number
|
@@ -1016,7 +1389,8 @@ module Aws::WellArchitected
|
|
1016
1389
|
#
|
1017
1390
|
# {
|
1018
1391
|
# lens_alias: "LensAlias", # required
|
1019
|
-
# base_lens_version: "LensVersion",
|
1392
|
+
# base_lens_version: "LensVersion",
|
1393
|
+
# target_lens_version: "LensVersion",
|
1020
1394
|
# }
|
1021
1395
|
#
|
1022
1396
|
# @!attribute [rw] lens_alias
|
@@ -1029,11 +1403,16 @@ module Aws::WellArchitected
|
|
1029
1403
|
# The base version of the lens.
|
1030
1404
|
# @return [String]
|
1031
1405
|
#
|
1406
|
+
# @!attribute [rw] target_lens_version
|
1407
|
+
# The lens version to target a difference for.
|
1408
|
+
# @return [String]
|
1409
|
+
#
|
1032
1410
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetLensVersionDifferenceInput AWS API Documentation
|
1033
1411
|
#
|
1034
1412
|
class GetLensVersionDifferenceInput < Struct.new(
|
1035
1413
|
:lens_alias,
|
1036
|
-
:base_lens_version
|
1414
|
+
:base_lens_version,
|
1415
|
+
:target_lens_version)
|
1037
1416
|
SENSITIVE = []
|
1038
1417
|
include Aws::Structure
|
1039
1418
|
end
|
@@ -1044,10 +1423,18 @@ module Aws::WellArchitected
|
|
1044
1423
|
# Each lens is identified by its LensSummary$LensAlias.
|
1045
1424
|
# @return [String]
|
1046
1425
|
#
|
1426
|
+
# @!attribute [rw] lens_arn
|
1427
|
+
# The ARN for the lens.
|
1428
|
+
# @return [String]
|
1429
|
+
#
|
1047
1430
|
# @!attribute [rw] base_lens_version
|
1048
1431
|
# The base version of the lens.
|
1049
1432
|
# @return [String]
|
1050
1433
|
#
|
1434
|
+
# @!attribute [rw] target_lens_version
|
1435
|
+
# The target lens version for the lens.
|
1436
|
+
# @return [String]
|
1437
|
+
#
|
1051
1438
|
# @!attribute [rw] latest_lens_version
|
1052
1439
|
# The latest version of the lens.
|
1053
1440
|
# @return [String]
|
@@ -1060,7 +1447,9 @@ module Aws::WellArchitected
|
|
1060
1447
|
#
|
1061
1448
|
class GetLensVersionDifferenceOutput < Struct.new(
|
1062
1449
|
:lens_alias,
|
1450
|
+
:lens_arn,
|
1063
1451
|
:base_lens_version,
|
1452
|
+
:target_lens_version,
|
1064
1453
|
:latest_lens_version,
|
1065
1454
|
:version_differences)
|
1066
1455
|
SENSITIVE = []
|
@@ -1078,8 +1467,8 @@ module Aws::WellArchitected
|
|
1078
1467
|
# }
|
1079
1468
|
#
|
1080
1469
|
# @!attribute [rw] workload_id
|
1081
|
-
# The ID assigned to the workload. This ID is unique within an
|
1082
|
-
# Region.
|
1470
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
1471
|
+
# Web Services Region.
|
1083
1472
|
# @return [String]
|
1084
1473
|
#
|
1085
1474
|
# @!attribute [rw] milestone_number
|
@@ -1100,8 +1489,8 @@ module Aws::WellArchitected
|
|
1100
1489
|
# Output of a get milestone call.
|
1101
1490
|
#
|
1102
1491
|
# @!attribute [rw] workload_id
|
1103
|
-
# The ID assigned to the workload. This ID is unique within an
|
1104
|
-
# Region.
|
1492
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
1493
|
+
# Web Services Region.
|
1105
1494
|
# @return [String]
|
1106
1495
|
#
|
1107
1496
|
# @!attribute [rw] milestone
|
@@ -1127,8 +1516,8 @@ module Aws::WellArchitected
|
|
1127
1516
|
# }
|
1128
1517
|
#
|
1129
1518
|
# @!attribute [rw] workload_id
|
1130
|
-
# The ID assigned to the workload. This ID is unique within an
|
1131
|
-
# Region.
|
1519
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
1520
|
+
# Web Services Region.
|
1132
1521
|
# @return [String]
|
1133
1522
|
#
|
1134
1523
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetWorkloadInput AWS API Documentation
|
@@ -1153,6 +1542,78 @@ module Aws::WellArchitected
|
|
1153
1542
|
include Aws::Structure
|
1154
1543
|
end
|
1155
1544
|
|
1545
|
+
# @note When making an API call, you may pass ImportLensInput
|
1546
|
+
# data as a hash:
|
1547
|
+
#
|
1548
|
+
# {
|
1549
|
+
# lens_alias: "LensAlias",
|
1550
|
+
# json_string: "LensJSON", # required
|
1551
|
+
# client_request_token: "ClientRequestToken", # required
|
1552
|
+
# tags: {
|
1553
|
+
# "TagKey" => "TagValue",
|
1554
|
+
# },
|
1555
|
+
# }
|
1556
|
+
#
|
1557
|
+
# @!attribute [rw] lens_alias
|
1558
|
+
# The alias of the lens, for example, `serverless`.
|
1559
|
+
#
|
1560
|
+
# Each lens is identified by its LensSummary$LensAlias.
|
1561
|
+
# @return [String]
|
1562
|
+
#
|
1563
|
+
# @!attribute [rw] json_string
|
1564
|
+
# The JSON representation of a lens.
|
1565
|
+
# @return [String]
|
1566
|
+
#
|
1567
|
+
# @!attribute [rw] client_request_token
|
1568
|
+
# A unique case-sensitive string used to ensure that this request is
|
1569
|
+
# idempotent (executes only once).
|
1570
|
+
#
|
1571
|
+
# You should not reuse the same token for other requests. If you retry
|
1572
|
+
# a request with the same client request token and the same parameters
|
1573
|
+
# after it has completed successfully, the result of the original
|
1574
|
+
# request is returned.
|
1575
|
+
#
|
1576
|
+
# This token is listed as required, however, if you do not specify it,
|
1577
|
+
# the Amazon Web Services SDKs automatically generate one for you. If
|
1578
|
+
# you are not using the Amazon Web Services SDK or the CLI, you must
|
1579
|
+
# provide this token or the request will fail.
|
1580
|
+
#
|
1581
|
+
# **A suitable default value is auto-generated.** You should normally
|
1582
|
+
# not need to pass this option.
|
1583
|
+
# @return [String]
|
1584
|
+
#
|
1585
|
+
# @!attribute [rw] tags
|
1586
|
+
# Tags to associate to a lens.
|
1587
|
+
# @return [Hash<String,String>]
|
1588
|
+
#
|
1589
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ImportLensInput AWS API Documentation
|
1590
|
+
#
|
1591
|
+
class ImportLensInput < Struct.new(
|
1592
|
+
:lens_alias,
|
1593
|
+
:json_string,
|
1594
|
+
:client_request_token,
|
1595
|
+
:tags)
|
1596
|
+
SENSITIVE = []
|
1597
|
+
include Aws::Structure
|
1598
|
+
end
|
1599
|
+
|
1600
|
+
# @!attribute [rw] lens_arn
|
1601
|
+
# The ARN for the lens.
|
1602
|
+
# @return [String]
|
1603
|
+
#
|
1604
|
+
# @!attribute [rw] status
|
1605
|
+
# The status of the imported lens.
|
1606
|
+
# @return [String]
|
1607
|
+
#
|
1608
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ImportLensOutput AWS API Documentation
|
1609
|
+
#
|
1610
|
+
class ImportLensOutput < Struct.new(
|
1611
|
+
:lens_arn,
|
1612
|
+
:status)
|
1613
|
+
SENSITIVE = []
|
1614
|
+
include Aws::Structure
|
1615
|
+
end
|
1616
|
+
|
1156
1617
|
# An improvement summary of a lens review in a workload.
|
1157
1618
|
#
|
1158
1619
|
# @!attribute [rw] question_id
|
@@ -1179,6 +1640,10 @@ module Aws::WellArchitected
|
|
1179
1640
|
# This value is only available if the question has been answered.
|
1180
1641
|
# @return [String]
|
1181
1642
|
#
|
1643
|
+
# @!attribute [rw] improvement_plans
|
1644
|
+
# The improvement plan details.
|
1645
|
+
# @return [Array<Types::ChoiceImprovementPlan>]
|
1646
|
+
#
|
1182
1647
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ImprovementSummary AWS API Documentation
|
1183
1648
|
#
|
1184
1649
|
class ImprovementSummary < Struct.new(
|
@@ -1186,12 +1651,13 @@ module Aws::WellArchitected
|
|
1186
1651
|
:pillar_id,
|
1187
1652
|
:question_title,
|
1188
1653
|
:risk,
|
1189
|
-
:improvement_plan_url
|
1654
|
+
:improvement_plan_url,
|
1655
|
+
:improvement_plans)
|
1190
1656
|
SENSITIVE = []
|
1191
1657
|
include Aws::Structure
|
1192
1658
|
end
|
1193
1659
|
|
1194
|
-
# There is a problem with the
|
1660
|
+
# There is a problem with the Well-Architected Tool API service.
|
1195
1661
|
#
|
1196
1662
|
# @!attribute [rw] message
|
1197
1663
|
# Description of the error.
|
@@ -1205,6 +1671,45 @@ module Aws::WellArchitected
|
|
1205
1671
|
include Aws::Structure
|
1206
1672
|
end
|
1207
1673
|
|
1674
|
+
# A lens return object.
|
1675
|
+
#
|
1676
|
+
# @!attribute [rw] lens_arn
|
1677
|
+
# The ARN of a lens.
|
1678
|
+
# @return [String]
|
1679
|
+
#
|
1680
|
+
# @!attribute [rw] lens_version
|
1681
|
+
# The version of a lens.
|
1682
|
+
# @return [String]
|
1683
|
+
#
|
1684
|
+
# @!attribute [rw] name
|
1685
|
+
# The full name of the lens.
|
1686
|
+
# @return [String]
|
1687
|
+
#
|
1688
|
+
# @!attribute [rw] description
|
1689
|
+
# The description of the lens.
|
1690
|
+
# @return [String]
|
1691
|
+
#
|
1692
|
+
# @!attribute [rw] owner
|
1693
|
+
# The Amazon Web Services account ID that owns the lens.
|
1694
|
+
# @return [String]
|
1695
|
+
#
|
1696
|
+
# @!attribute [rw] share_invitation_id
|
1697
|
+
# The ID assigned to the share invitation.
|
1698
|
+
# @return [String]
|
1699
|
+
#
|
1700
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/Lens AWS API Documentation
|
1701
|
+
#
|
1702
|
+
class Lens < Struct.new(
|
1703
|
+
:lens_arn,
|
1704
|
+
:lens_version,
|
1705
|
+
:name,
|
1706
|
+
:description,
|
1707
|
+
:owner,
|
1708
|
+
:share_invitation_id)
|
1709
|
+
SENSITIVE = []
|
1710
|
+
include Aws::Structure
|
1711
|
+
end
|
1712
|
+
|
1208
1713
|
# A lens review of a question.
|
1209
1714
|
#
|
1210
1715
|
# @!attribute [rw] lens_alias
|
@@ -1213,6 +1718,10 @@ module Aws::WellArchitected
|
|
1213
1718
|
# Each lens is identified by its LensSummary$LensAlias.
|
1214
1719
|
# @return [String]
|
1215
1720
|
#
|
1721
|
+
# @!attribute [rw] lens_arn
|
1722
|
+
# The ARN for the lens.
|
1723
|
+
# @return [String]
|
1724
|
+
#
|
1216
1725
|
# @!attribute [rw] lens_version
|
1217
1726
|
# The version of the lens.
|
1218
1727
|
# @return [String]
|
@@ -1250,6 +1759,7 @@ module Aws::WellArchitected
|
|
1250
1759
|
#
|
1251
1760
|
class LensReview < Struct.new(
|
1252
1761
|
:lens_alias,
|
1762
|
+
:lens_arn,
|
1253
1763
|
:lens_version,
|
1254
1764
|
:lens_name,
|
1255
1765
|
:lens_status,
|
@@ -1270,6 +1780,10 @@ module Aws::WellArchitected
|
|
1270
1780
|
# Each lens is identified by its LensSummary$LensAlias.
|
1271
1781
|
# @return [String]
|
1272
1782
|
#
|
1783
|
+
# @!attribute [rw] lens_arn
|
1784
|
+
# The ARN for the lens.
|
1785
|
+
# @return [String]
|
1786
|
+
#
|
1273
1787
|
# @!attribute [rw] base_64_string
|
1274
1788
|
# The Base64-encoded string representation of a lens review report.
|
1275
1789
|
#
|
@@ -1280,6 +1794,7 @@ module Aws::WellArchitected
|
|
1280
1794
|
#
|
1281
1795
|
class LensReviewReport < Struct.new(
|
1282
1796
|
:lens_alias,
|
1797
|
+
:lens_arn,
|
1283
1798
|
:base_64_string)
|
1284
1799
|
SENSITIVE = []
|
1285
1800
|
include Aws::Structure
|
@@ -1293,6 +1808,10 @@ module Aws::WellArchitected
|
|
1293
1808
|
# Each lens is identified by its LensSummary$LensAlias.
|
1294
1809
|
# @return [String]
|
1295
1810
|
#
|
1811
|
+
# @!attribute [rw] lens_arn
|
1812
|
+
# The ARN for the lens.
|
1813
|
+
# @return [String]
|
1814
|
+
#
|
1296
1815
|
# @!attribute [rw] lens_version
|
1297
1816
|
# The version of the lens.
|
1298
1817
|
# @return [String]
|
@@ -1318,6 +1837,7 @@ module Aws::WellArchitected
|
|
1318
1837
|
#
|
1319
1838
|
class LensReviewSummary < Struct.new(
|
1320
1839
|
:lens_alias,
|
1840
|
+
:lens_arn,
|
1321
1841
|
:lens_version,
|
1322
1842
|
:lens_name,
|
1323
1843
|
:lens_status,
|
@@ -1327,33 +1847,88 @@ module Aws::WellArchitected
|
|
1327
1847
|
include Aws::Structure
|
1328
1848
|
end
|
1329
1849
|
|
1850
|
+
# A lens share summary return object.
|
1851
|
+
#
|
1852
|
+
# @!attribute [rw] share_id
|
1853
|
+
# The ID associated with the workload share.
|
1854
|
+
# @return [String]
|
1855
|
+
#
|
1856
|
+
# @!attribute [rw] shared_with
|
1857
|
+
# The Amazon Web Services account ID or IAM role with which the
|
1858
|
+
# workload is shared.
|
1859
|
+
# @return [String]
|
1860
|
+
#
|
1861
|
+
# @!attribute [rw] status
|
1862
|
+
# The status of a workload share.
|
1863
|
+
# @return [String]
|
1864
|
+
#
|
1865
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/LensShareSummary AWS API Documentation
|
1866
|
+
#
|
1867
|
+
class LensShareSummary < Struct.new(
|
1868
|
+
:share_id,
|
1869
|
+
:shared_with,
|
1870
|
+
:status)
|
1871
|
+
SENSITIVE = []
|
1872
|
+
include Aws::Structure
|
1873
|
+
end
|
1874
|
+
|
1330
1875
|
# A lens summary of a lens.
|
1331
1876
|
#
|
1877
|
+
# @!attribute [rw] lens_arn
|
1878
|
+
# The ARN of the lens.
|
1879
|
+
# @return [String]
|
1880
|
+
#
|
1332
1881
|
# @!attribute [rw] lens_alias
|
1333
1882
|
# The alias of the lens, for example, `serverless`.
|
1334
1883
|
#
|
1335
1884
|
# Each lens is identified by its LensSummary$LensAlias.
|
1336
1885
|
# @return [String]
|
1337
1886
|
#
|
1338
|
-
# @!attribute [rw] lens_version
|
1339
|
-
# The version of the lens.
|
1340
|
-
# @return [String]
|
1341
|
-
#
|
1342
1887
|
# @!attribute [rw] lens_name
|
1343
1888
|
# The full name of the lens.
|
1344
1889
|
# @return [String]
|
1345
1890
|
#
|
1891
|
+
# @!attribute [rw] lens_type
|
1892
|
+
# The type of the lens.
|
1893
|
+
# @return [String]
|
1894
|
+
#
|
1346
1895
|
# @!attribute [rw] description
|
1347
1896
|
# The description of the lens.
|
1348
1897
|
# @return [String]
|
1349
1898
|
#
|
1899
|
+
# @!attribute [rw] created_at
|
1900
|
+
# The date and time recorded.
|
1901
|
+
# @return [Time]
|
1902
|
+
#
|
1903
|
+
# @!attribute [rw] updated_at
|
1904
|
+
# The date and time recorded.
|
1905
|
+
# @return [Time]
|
1906
|
+
#
|
1907
|
+
# @!attribute [rw] lens_version
|
1908
|
+
# The version of the lens.
|
1909
|
+
# @return [String]
|
1910
|
+
#
|
1911
|
+
# @!attribute [rw] owner
|
1912
|
+
# An Amazon Web Services account ID.
|
1913
|
+
# @return [String]
|
1914
|
+
#
|
1915
|
+
# @!attribute [rw] lens_status
|
1916
|
+
# The status of the lens.
|
1917
|
+
# @return [String]
|
1918
|
+
#
|
1350
1919
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/LensSummary AWS API Documentation
|
1351
1920
|
#
|
1352
1921
|
class LensSummary < Struct.new(
|
1922
|
+
:lens_arn,
|
1353
1923
|
:lens_alias,
|
1354
|
-
:lens_version,
|
1355
1924
|
:lens_name,
|
1356
|
-
:
|
1925
|
+
:lens_type,
|
1926
|
+
:description,
|
1927
|
+
:created_at,
|
1928
|
+
:updated_at,
|
1929
|
+
:lens_version,
|
1930
|
+
:owner,
|
1931
|
+
:lens_status)
|
1357
1932
|
SENSITIVE = []
|
1358
1933
|
include Aws::Structure
|
1359
1934
|
end
|
@@ -1361,15 +1936,16 @@ module Aws::WellArchitected
|
|
1361
1936
|
# Lens upgrade summary return object.
|
1362
1937
|
#
|
1363
1938
|
# @!attribute [rw] workload_id
|
1364
|
-
# The ID assigned to the workload. This ID is unique within an
|
1365
|
-
# Region.
|
1939
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
1940
|
+
# Web Services Region.
|
1366
1941
|
# @return [String]
|
1367
1942
|
#
|
1368
1943
|
# @!attribute [rw] workload_name
|
1369
1944
|
# The name of the workload.
|
1370
1945
|
#
|
1371
|
-
# The name must be unique within an account within
|
1372
|
-
# and capitalization are ignored when checking
|
1946
|
+
# The name must be unique within an account within an Amazon Web
|
1947
|
+
# Services Region. Spaces and capitalization are ignored when checking
|
1948
|
+
# for uniqueness.
|
1373
1949
|
# @return [String]
|
1374
1950
|
#
|
1375
1951
|
# @!attribute [rw] lens_alias
|
@@ -1378,6 +1954,10 @@ module Aws::WellArchitected
|
|
1378
1954
|
# Each lens is identified by its LensSummary$LensAlias.
|
1379
1955
|
# @return [String]
|
1380
1956
|
#
|
1957
|
+
# @!attribute [rw] lens_arn
|
1958
|
+
# The ARN for the lens.
|
1959
|
+
# @return [String]
|
1960
|
+
#
|
1381
1961
|
# @!attribute [rw] current_lens_version
|
1382
1962
|
# The current version of the lens.
|
1383
1963
|
# @return [String]
|
@@ -1392,6 +1972,7 @@ module Aws::WellArchitected
|
|
1392
1972
|
:workload_id,
|
1393
1973
|
:workload_name,
|
1394
1974
|
:lens_alias,
|
1975
|
+
:lens_arn,
|
1395
1976
|
:current_lens_version,
|
1396
1977
|
:latest_lens_version)
|
1397
1978
|
SENSITIVE = []
|
@@ -1413,8 +1994,8 @@ module Aws::WellArchitected
|
|
1413
1994
|
# }
|
1414
1995
|
#
|
1415
1996
|
# @!attribute [rw] workload_id
|
1416
|
-
# The ID assigned to the workload. This ID is unique within an
|
1417
|
-
# Region.
|
1997
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
1998
|
+
# Web Services Region.
|
1418
1999
|
# @return [String]
|
1419
2000
|
#
|
1420
2001
|
# @!attribute [rw] lens_alias
|
@@ -1459,8 +2040,8 @@ module Aws::WellArchitected
|
|
1459
2040
|
# Output of a list answers call.
|
1460
2041
|
#
|
1461
2042
|
# @!attribute [rw] workload_id
|
1462
|
-
# The ID assigned to the workload. This ID is unique within an
|
1463
|
-
# Region.
|
2043
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
2044
|
+
# Web Services Region.
|
1464
2045
|
# @return [String]
|
1465
2046
|
#
|
1466
2047
|
# @!attribute [rw] milestone_number
|
@@ -1475,6 +2056,10 @@ module Aws::WellArchitected
|
|
1475
2056
|
# Each lens is identified by its LensSummary$LensAlias.
|
1476
2057
|
# @return [String]
|
1477
2058
|
#
|
2059
|
+
# @!attribute [rw] lens_arn
|
2060
|
+
# The ARN for the lens.
|
2061
|
+
# @return [String]
|
2062
|
+
#
|
1478
2063
|
# @!attribute [rw] answer_summaries
|
1479
2064
|
# List of answer summaries of lens review in a workload.
|
1480
2065
|
# @return [Array<Types::AnswerSummary>]
|
@@ -1489,6 +2074,7 @@ module Aws::WellArchitected
|
|
1489
2074
|
:workload_id,
|
1490
2075
|
:milestone_number,
|
1491
2076
|
:lens_alias,
|
2077
|
+
:lens_arn,
|
1492
2078
|
:answer_summaries,
|
1493
2079
|
:next_token)
|
1494
2080
|
SENSITIVE = []
|
@@ -1510,8 +2096,8 @@ module Aws::WellArchitected
|
|
1510
2096
|
# }
|
1511
2097
|
#
|
1512
2098
|
# @!attribute [rw] workload_id
|
1513
|
-
# The ID assigned to the workload. This ID is unique within an
|
1514
|
-
# Region.
|
2099
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
2100
|
+
# Web Services Region.
|
1515
2101
|
# @return [String]
|
1516
2102
|
#
|
1517
2103
|
# @!attribute [rw] lens_alias
|
@@ -1556,8 +2142,8 @@ module Aws::WellArchitected
|
|
1556
2142
|
# Output of a list lens review improvements call.
|
1557
2143
|
#
|
1558
2144
|
# @!attribute [rw] workload_id
|
1559
|
-
# The ID assigned to the workload. This ID is unique within an
|
1560
|
-
# Region.
|
2145
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
2146
|
+
# Web Services Region.
|
1561
2147
|
# @return [String]
|
1562
2148
|
#
|
1563
2149
|
# @!attribute [rw] milestone_number
|
@@ -1572,6 +2158,10 @@ module Aws::WellArchitected
|
|
1572
2158
|
# Each lens is identified by its LensSummary$LensAlias.
|
1573
2159
|
# @return [String]
|
1574
2160
|
#
|
2161
|
+
# @!attribute [rw] lens_arn
|
2162
|
+
# The ARN for the lens.
|
2163
|
+
# @return [String]
|
2164
|
+
#
|
1575
2165
|
# @!attribute [rw] improvement_summaries
|
1576
2166
|
# List of improvement summaries of lens review in a workload.
|
1577
2167
|
# @return [Array<Types::ImprovementSummary>]
|
@@ -1586,6 +2176,7 @@ module Aws::WellArchitected
|
|
1586
2176
|
:workload_id,
|
1587
2177
|
:milestone_number,
|
1588
2178
|
:lens_alias,
|
2179
|
+
:lens_arn,
|
1589
2180
|
:improvement_summaries,
|
1590
2181
|
:next_token)
|
1591
2182
|
SENSITIVE = []
|
@@ -1605,8 +2196,8 @@ module Aws::WellArchitected
|
|
1605
2196
|
# }
|
1606
2197
|
#
|
1607
2198
|
# @!attribute [rw] workload_id
|
1608
|
-
# The ID assigned to the workload. This ID is unique within an
|
1609
|
-
# Region.
|
2199
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
2200
|
+
# Web Services Region.
|
1610
2201
|
# @return [String]
|
1611
2202
|
#
|
1612
2203
|
# @!attribute [rw] milestone_number
|
@@ -1637,8 +2228,8 @@ module Aws::WellArchitected
|
|
1637
2228
|
# Output of a list lens reviews call.
|
1638
2229
|
#
|
1639
2230
|
# @!attribute [rw] workload_id
|
1640
|
-
# The ID assigned to the workload. This ID is unique within an
|
1641
|
-
# Region.
|
2231
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
2232
|
+
# Web Services Region.
|
1642
2233
|
# @return [String]
|
1643
2234
|
#
|
1644
2235
|
# @!attribute [rw] milestone_number
|
@@ -1666,6 +2257,63 @@ module Aws::WellArchitected
|
|
1666
2257
|
include Aws::Structure
|
1667
2258
|
end
|
1668
2259
|
|
2260
|
+
# @note When making an API call, you may pass ListLensSharesInput
|
2261
|
+
# data as a hash:
|
2262
|
+
#
|
2263
|
+
# {
|
2264
|
+
# lens_alias: "LensAlias", # required
|
2265
|
+
# shared_with_prefix: "SharedWithPrefix",
|
2266
|
+
# next_token: "NextToken",
|
2267
|
+
# max_results: 1,
|
2268
|
+
# }
|
2269
|
+
#
|
2270
|
+
# @!attribute [rw] lens_alias
|
2271
|
+
# The alias of the lens, for example, `serverless`.
|
2272
|
+
#
|
2273
|
+
# Each lens is identified by its LensSummary$LensAlias.
|
2274
|
+
# @return [String]
|
2275
|
+
#
|
2276
|
+
# @!attribute [rw] shared_with_prefix
|
2277
|
+
# The Amazon Web Services account ID or IAM role with which the lens
|
2278
|
+
# is shared.
|
2279
|
+
# @return [String]
|
2280
|
+
#
|
2281
|
+
# @!attribute [rw] next_token
|
2282
|
+
# The token to use to retrieve the next set of results.
|
2283
|
+
# @return [String]
|
2284
|
+
#
|
2285
|
+
# @!attribute [rw] max_results
|
2286
|
+
# The maximum number of results to return for this request.
|
2287
|
+
# @return [Integer]
|
2288
|
+
#
|
2289
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListLensSharesInput AWS API Documentation
|
2290
|
+
#
|
2291
|
+
class ListLensSharesInput < Struct.new(
|
2292
|
+
:lens_alias,
|
2293
|
+
:shared_with_prefix,
|
2294
|
+
:next_token,
|
2295
|
+
:max_results)
|
2296
|
+
SENSITIVE = []
|
2297
|
+
include Aws::Structure
|
2298
|
+
end
|
2299
|
+
|
2300
|
+
# @!attribute [rw] lens_share_summaries
|
2301
|
+
# A list of lens share summaries.
|
2302
|
+
# @return [Array<Types::LensShareSummary>]
|
2303
|
+
#
|
2304
|
+
# @!attribute [rw] next_token
|
2305
|
+
# The token to use to retrieve the next set of results.
|
2306
|
+
# @return [String]
|
2307
|
+
#
|
2308
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListLensSharesOutput AWS API Documentation
|
2309
|
+
#
|
2310
|
+
class ListLensSharesOutput < Struct.new(
|
2311
|
+
:lens_share_summaries,
|
2312
|
+
:next_token)
|
2313
|
+
SENSITIVE = []
|
2314
|
+
include Aws::Structure
|
2315
|
+
end
|
2316
|
+
|
1669
2317
|
# Input to list lenses.
|
1670
2318
|
#
|
1671
2319
|
# @note When making an API call, you may pass ListLensesInput
|
@@ -1674,6 +2322,9 @@ module Aws::WellArchitected
|
|
1674
2322
|
# {
|
1675
2323
|
# next_token: "NextToken",
|
1676
2324
|
# max_results: 1,
|
2325
|
+
# lens_type: "AWS_OFFICIAL", # accepts AWS_OFFICIAL, CUSTOM_SHARED, CUSTOM_SELF
|
2326
|
+
# lens_status: "ALL", # accepts ALL, DRAFT, PUBLISHED
|
2327
|
+
# lens_name: "LensName",
|
1677
2328
|
# }
|
1678
2329
|
#
|
1679
2330
|
# @!attribute [rw] next_token
|
@@ -1684,11 +2335,26 @@ module Aws::WellArchitected
|
|
1684
2335
|
# The maximum number of results to return for this request.
|
1685
2336
|
# @return [Integer]
|
1686
2337
|
#
|
2338
|
+
# @!attribute [rw] lens_type
|
2339
|
+
# The type of lenses to be returned.
|
2340
|
+
# @return [String]
|
2341
|
+
#
|
2342
|
+
# @!attribute [rw] lens_status
|
2343
|
+
# The status of lenses to be returned.
|
2344
|
+
# @return [String]
|
2345
|
+
#
|
2346
|
+
# @!attribute [rw] lens_name
|
2347
|
+
# The full name of the lens.
|
2348
|
+
# @return [String]
|
2349
|
+
#
|
1687
2350
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListLensesInput AWS API Documentation
|
1688
2351
|
#
|
1689
2352
|
class ListLensesInput < Struct.new(
|
1690
2353
|
:next_token,
|
1691
|
-
:max_results
|
2354
|
+
:max_results,
|
2355
|
+
:lens_type,
|
2356
|
+
:lens_status,
|
2357
|
+
:lens_name)
|
1692
2358
|
SENSITIVE = []
|
1693
2359
|
include Aws::Structure
|
1694
2360
|
end
|
@@ -1724,8 +2390,8 @@ module Aws::WellArchitected
|
|
1724
2390
|
# }
|
1725
2391
|
#
|
1726
2392
|
# @!attribute [rw] workload_id
|
1727
|
-
# The ID assigned to the workload. This ID is unique within an
|
1728
|
-
# Region.
|
2393
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
2394
|
+
# Web Services Region.
|
1729
2395
|
# @return [String]
|
1730
2396
|
#
|
1731
2397
|
# @!attribute [rw] next_token
|
@@ -1749,8 +2415,8 @@ module Aws::WellArchitected
|
|
1749
2415
|
# Output of a list milestones call.
|
1750
2416
|
#
|
1751
2417
|
# @!attribute [rw] workload_id
|
1752
|
-
# The ID assigned to the workload. This ID is unique within an
|
1753
|
-
# Region.
|
2418
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
2419
|
+
# Web Services Region.
|
1754
2420
|
# @return [String]
|
1755
2421
|
#
|
1756
2422
|
# @!attribute [rw] milestone_summaries
|
@@ -1781,8 +2447,8 @@ module Aws::WellArchitected
|
|
1781
2447
|
# }
|
1782
2448
|
#
|
1783
2449
|
# @!attribute [rw] workload_id
|
1784
|
-
# The ID assigned to the workload. This ID is unique within an
|
1785
|
-
# Region.
|
2450
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
2451
|
+
# Web Services Region.
|
1786
2452
|
# @return [String]
|
1787
2453
|
#
|
1788
2454
|
# @!attribute [rw] next_token
|
@@ -1827,6 +2493,8 @@ module Aws::WellArchitected
|
|
1827
2493
|
#
|
1828
2494
|
# {
|
1829
2495
|
# workload_name_prefix: "WorkloadNamePrefix",
|
2496
|
+
# lens_name_prefix: "LensNamePrefix",
|
2497
|
+
# share_resource_type: "WORKLOAD", # accepts WORKLOAD, LENS
|
1830
2498
|
# next_token: "NextToken",
|
1831
2499
|
# max_results: 1,
|
1832
2500
|
# }
|
@@ -1836,6 +2504,15 @@ module Aws::WellArchitected
|
|
1836
2504
|
# returned in the results.
|
1837
2505
|
# @return [String]
|
1838
2506
|
#
|
2507
|
+
# @!attribute [rw] lens_name_prefix
|
2508
|
+
# An optional string added to the beginning of each lens name returned
|
2509
|
+
# in the results.
|
2510
|
+
# @return [String]
|
2511
|
+
#
|
2512
|
+
# @!attribute [rw] share_resource_type
|
2513
|
+
# The type of share invitations to be returned.
|
2514
|
+
# @return [String]
|
2515
|
+
#
|
1839
2516
|
# @!attribute [rw] next_token
|
1840
2517
|
# The token to use to retrieve the next set of results.
|
1841
2518
|
# @return [String]
|
@@ -1848,6 +2525,8 @@ module Aws::WellArchitected
|
|
1848
2525
|
#
|
1849
2526
|
class ListShareInvitationsInput < Struct.new(
|
1850
2527
|
:workload_name_prefix,
|
2528
|
+
:lens_name_prefix,
|
2529
|
+
:share_resource_type,
|
1851
2530
|
:next_token,
|
1852
2531
|
:max_results)
|
1853
2532
|
SENSITIVE = []
|
@@ -1917,12 +2596,13 @@ module Aws::WellArchitected
|
|
1917
2596
|
# }
|
1918
2597
|
#
|
1919
2598
|
# @!attribute [rw] workload_id
|
1920
|
-
# The ID assigned to the workload. This ID is unique within an
|
1921
|
-
# Region.
|
2599
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
2600
|
+
# Web Services Region.
|
1922
2601
|
# @return [String]
|
1923
2602
|
#
|
1924
2603
|
# @!attribute [rw] shared_with_prefix
|
1925
|
-
# The
|
2604
|
+
# The Amazon Web Services account ID or IAM role with which the
|
2605
|
+
# workload is shared.
|
1926
2606
|
# @return [String]
|
1927
2607
|
#
|
1928
2608
|
# @!attribute [rw] next_token
|
@@ -1947,8 +2627,8 @@ module Aws::WellArchitected
|
|
1947
2627
|
# Input for List Workload Share
|
1948
2628
|
#
|
1949
2629
|
# @!attribute [rw] workload_id
|
1950
|
-
# The ID assigned to the workload. This ID is unique within an
|
1951
|
-
# Region.
|
2630
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
2631
|
+
# Web Services Region.
|
1952
2632
|
# @return [String]
|
1953
2633
|
#
|
1954
2634
|
# @!attribute [rw] workload_share_summaries
|
@@ -2115,6 +2795,10 @@ module Aws::WellArchitected
|
|
2115
2795
|
# A pillar is identified by its PillarReviewSummary$PillarId.
|
2116
2796
|
# @return [String]
|
2117
2797
|
#
|
2798
|
+
# @!attribute [rw] pillar_name
|
2799
|
+
# The name of the pillar.
|
2800
|
+
# @return [String]
|
2801
|
+
#
|
2118
2802
|
# @!attribute [rw] difference_status
|
2119
2803
|
# Indicates the type of change to the pillar.
|
2120
2804
|
# @return [String]
|
@@ -2127,6 +2811,7 @@ module Aws::WellArchitected
|
|
2127
2811
|
#
|
2128
2812
|
class PillarDifference < Struct.new(
|
2129
2813
|
:pillar_id,
|
2814
|
+
:pillar_name,
|
2130
2815
|
:difference_status,
|
2131
2816
|
:question_differences)
|
2132
2817
|
SENSITIVE = []
|
@@ -2253,16 +2938,33 @@ module Aws::WellArchitected
|
|
2253
2938
|
# The ID assigned to the share invitation.
|
2254
2939
|
# @return [String]
|
2255
2940
|
#
|
2941
|
+
# @!attribute [rw] share_resource_type
|
2942
|
+
# The resource type of the share invitation.
|
2943
|
+
# @return [String]
|
2944
|
+
#
|
2256
2945
|
# @!attribute [rw] workload_id
|
2257
|
-
# The ID assigned to the workload. This ID is unique within an
|
2258
|
-
# Region.
|
2946
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
2947
|
+
# Web Services Region.
|
2948
|
+
# @return [String]
|
2949
|
+
#
|
2950
|
+
# @!attribute [rw] lens_alias
|
2951
|
+
# The alias of the lens, for example, `serverless`.
|
2952
|
+
#
|
2953
|
+
# Each lens is identified by its LensSummary$LensAlias.
|
2954
|
+
# @return [String]
|
2955
|
+
#
|
2956
|
+
# @!attribute [rw] lens_arn
|
2957
|
+
# The ARN for the lens.
|
2259
2958
|
# @return [String]
|
2260
2959
|
#
|
2261
2960
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ShareInvitation AWS API Documentation
|
2262
2961
|
#
|
2263
2962
|
class ShareInvitation < Struct.new(
|
2264
2963
|
:share_invitation_id,
|
2265
|
-
:
|
2964
|
+
:share_resource_type,
|
2965
|
+
:workload_id,
|
2966
|
+
:lens_alias,
|
2967
|
+
:lens_arn)
|
2266
2968
|
SENSITIVE = []
|
2267
2969
|
include Aws::Structure
|
2268
2970
|
end
|
@@ -2274,27 +2976,41 @@ module Aws::WellArchitected
|
|
2274
2976
|
# @return [String]
|
2275
2977
|
#
|
2276
2978
|
# @!attribute [rw] shared_by
|
2277
|
-
# An
|
2979
|
+
# An Amazon Web Services account ID.
|
2278
2980
|
# @return [String]
|
2279
2981
|
#
|
2280
2982
|
# @!attribute [rw] shared_with
|
2281
|
-
# The
|
2983
|
+
# The Amazon Web Services account ID or IAM role with which the
|
2984
|
+
# workload is shared.
|
2282
2985
|
# @return [String]
|
2283
2986
|
#
|
2284
2987
|
# @!attribute [rw] permission_type
|
2285
2988
|
# Permission granted on a workload share.
|
2286
2989
|
# @return [String]
|
2287
2990
|
#
|
2991
|
+
# @!attribute [rw] share_resource_type
|
2992
|
+
# The resource type of the share invitation.
|
2993
|
+
# @return [String]
|
2994
|
+
#
|
2288
2995
|
# @!attribute [rw] workload_name
|
2289
2996
|
# The name of the workload.
|
2290
2997
|
#
|
2291
|
-
# The name must be unique within an account within
|
2292
|
-
# and capitalization are ignored when checking
|
2998
|
+
# The name must be unique within an account within an Amazon Web
|
2999
|
+
# Services Region. Spaces and capitalization are ignored when checking
|
3000
|
+
# for uniqueness.
|
2293
3001
|
# @return [String]
|
2294
3002
|
#
|
2295
3003
|
# @!attribute [rw] workload_id
|
2296
|
-
# The ID assigned to the workload. This ID is unique within an
|
2297
|
-
# Region.
|
3004
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
3005
|
+
# Web Services Region.
|
3006
|
+
# @return [String]
|
3007
|
+
#
|
3008
|
+
# @!attribute [rw] lens_name
|
3009
|
+
# The full name of the lens.
|
3010
|
+
# @return [String]
|
3011
|
+
#
|
3012
|
+
# @!attribute [rw] lens_arn
|
3013
|
+
# The ARN for the lens.
|
2298
3014
|
# @return [String]
|
2299
3015
|
#
|
2300
3016
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ShareInvitationSummary AWS API Documentation
|
@@ -2304,8 +3020,11 @@ module Aws::WellArchitected
|
|
2304
3020
|
:shared_by,
|
2305
3021
|
:shared_with,
|
2306
3022
|
:permission_type,
|
3023
|
+
:share_resource_type,
|
2307
3024
|
:workload_name,
|
2308
|
-
:workload_id
|
3025
|
+
:workload_id,
|
3026
|
+
:lens_name,
|
3027
|
+
:lens_arn)
|
2309
3028
|
SENSITIVE = []
|
2310
3029
|
include Aws::Structure
|
2311
3030
|
end
|
@@ -2418,8 +3137,8 @@ module Aws::WellArchitected
|
|
2418
3137
|
# }
|
2419
3138
|
#
|
2420
3139
|
# @!attribute [rw] workload_id
|
2421
|
-
# The ID assigned to the workload. This ID is unique within an
|
2422
|
-
# Region.
|
3140
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
3141
|
+
# Web Services Region.
|
2423
3142
|
# @return [String]
|
2424
3143
|
#
|
2425
3144
|
# @!attribute [rw] lens_alias
|
@@ -2473,8 +3192,8 @@ module Aws::WellArchitected
|
|
2473
3192
|
# Output of a update answer call.
|
2474
3193
|
#
|
2475
3194
|
# @!attribute [rw] workload_id
|
2476
|
-
# The ID assigned to the workload. This ID is unique within an
|
2477
|
-
# Region.
|
3195
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
3196
|
+
# Web Services Region.
|
2478
3197
|
# @return [String]
|
2479
3198
|
#
|
2480
3199
|
# @!attribute [rw] lens_alias
|
@@ -2483,6 +3202,10 @@ module Aws::WellArchitected
|
|
2483
3202
|
# Each lens is identified by its LensSummary$LensAlias.
|
2484
3203
|
# @return [String]
|
2485
3204
|
#
|
3205
|
+
# @!attribute [rw] lens_arn
|
3206
|
+
# The ARN for the lens.
|
3207
|
+
# @return [String]
|
3208
|
+
#
|
2486
3209
|
# @!attribute [rw] answer
|
2487
3210
|
# An answer of the question.
|
2488
3211
|
# @return [Types::Answer]
|
@@ -2492,6 +3215,7 @@ module Aws::WellArchitected
|
|
2492
3215
|
class UpdateAnswerOutput < Struct.new(
|
2493
3216
|
:workload_id,
|
2494
3217
|
:lens_alias,
|
3218
|
+
:lens_arn,
|
2495
3219
|
:answer)
|
2496
3220
|
SENSITIVE = []
|
2497
3221
|
include Aws::Structure
|
@@ -2512,8 +3236,8 @@ module Aws::WellArchitected
|
|
2512
3236
|
# }
|
2513
3237
|
#
|
2514
3238
|
# @!attribute [rw] workload_id
|
2515
|
-
# The ID assigned to the workload. This ID is unique within an
|
2516
|
-
# Region.
|
3239
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
3240
|
+
# Web Services Region.
|
2517
3241
|
# @return [String]
|
2518
3242
|
#
|
2519
3243
|
# @!attribute [rw] lens_alias
|
@@ -2544,8 +3268,8 @@ module Aws::WellArchitected
|
|
2544
3268
|
# Output of a update lens review call.
|
2545
3269
|
#
|
2546
3270
|
# @!attribute [rw] workload_id
|
2547
|
-
# The ID assigned to the workload. This ID is unique within an
|
2548
|
-
# Region.
|
3271
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
3272
|
+
# Web Services Region.
|
2549
3273
|
# @return [String]
|
2550
3274
|
#
|
2551
3275
|
# @!attribute [rw] lens_review
|
@@ -2624,15 +3348,16 @@ module Aws::WellArchitected
|
|
2624
3348
|
# }
|
2625
3349
|
#
|
2626
3350
|
# @!attribute [rw] workload_id
|
2627
|
-
# The ID assigned to the workload. This ID is unique within an
|
2628
|
-
# Region.
|
3351
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
3352
|
+
# Web Services Region.
|
2629
3353
|
# @return [String]
|
2630
3354
|
#
|
2631
3355
|
# @!attribute [rw] workload_name
|
2632
3356
|
# The name of the workload.
|
2633
3357
|
#
|
2634
|
-
# The name must be unique within an account within
|
2635
|
-
# and capitalization are ignored when checking
|
3358
|
+
# The name must be unique within an account within an Amazon Web
|
3359
|
+
# Services Region. Spaces and capitalization are ignored when checking
|
3360
|
+
# for uniqueness.
|
2636
3361
|
# @return [String]
|
2637
3362
|
#
|
2638
3363
|
# @!attribute [rw] description
|
@@ -2644,16 +3369,18 @@ module Aws::WellArchitected
|
|
2644
3369
|
# @return [String]
|
2645
3370
|
#
|
2646
3371
|
# @!attribute [rw] account_ids
|
2647
|
-
# The list of
|
3372
|
+
# The list of Amazon Web Services account IDs associated with the
|
3373
|
+
# workload.
|
2648
3374
|
# @return [Array<String>]
|
2649
3375
|
#
|
2650
3376
|
# @!attribute [rw] aws_regions
|
2651
|
-
# The list of
|
2652
|
-
# `us-east-2`, or `ca-central-1`.
|
3377
|
+
# The list of Amazon Web Services Regions associated with the
|
3378
|
+
# workload, for example, `us-east-2`, or `ca-central-1`.
|
2653
3379
|
# @return [Array<String>]
|
2654
3380
|
#
|
2655
3381
|
# @!attribute [rw] non_aws_regions
|
2656
|
-
# The list of non-
|
3382
|
+
# The list of non-Amazon Web Services Regions associated with the
|
3383
|
+
# workload.
|
2657
3384
|
# @return [Array<String>]
|
2658
3385
|
#
|
2659
3386
|
# @!attribute [rw] pillar_priorities
|
@@ -2805,8 +3532,8 @@ module Aws::WellArchitected
|
|
2805
3532
|
# @return [String]
|
2806
3533
|
#
|
2807
3534
|
# @!attribute [rw] workload_id
|
2808
|
-
# The ID assigned to the workload. This ID is unique within an
|
2809
|
-
# Region.
|
3535
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
3536
|
+
# Web Services Region.
|
2810
3537
|
# @return [String]
|
2811
3538
|
#
|
2812
3539
|
# @!attribute [rw] permission_type
|
@@ -2826,8 +3553,8 @@ module Aws::WellArchitected
|
|
2826
3553
|
# Input for Update Workload Share
|
2827
3554
|
#
|
2828
3555
|
# @!attribute [rw] workload_id
|
2829
|
-
# The ID assigned to the workload. This ID is unique within an
|
2830
|
-
# Region.
|
3556
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
3557
|
+
# Web Services Region.
|
2831
3558
|
# @return [String]
|
2832
3559
|
#
|
2833
3560
|
# @!attribute [rw] workload_share
|
@@ -2854,8 +3581,8 @@ module Aws::WellArchitected
|
|
2854
3581
|
# }
|
2855
3582
|
#
|
2856
3583
|
# @!attribute [rw] workload_id
|
2857
|
-
# The ID assigned to the workload. This ID is unique within an
|
2858
|
-
# Region.
|
3584
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
3585
|
+
# Web Services Region.
|
2859
3586
|
# @return [String]
|
2860
3587
|
#
|
2861
3588
|
# @!attribute [rw] lens_alias
|
@@ -2880,9 +3607,9 @@ module Aws::WellArchitected
|
|
2880
3607
|
# request is returned.
|
2881
3608
|
#
|
2882
3609
|
# This token is listed as required, however, if you do not specify it,
|
2883
|
-
# the
|
2884
|
-
# using the
|
2885
|
-
# request will fail.
|
3610
|
+
# the Amazon Web Services SDKs automatically generate one for you. If
|
3611
|
+
# you are not using the Amazon Web Services SDK or the CLI, you must
|
3612
|
+
# provide this token or the request will fail.
|
2886
3613
|
# @return [String]
|
2887
3614
|
#
|
2888
3615
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/UpgradeLensReviewInput AWS API Documentation
|
@@ -2957,8 +3684,8 @@ module Aws::WellArchitected
|
|
2957
3684
|
# A workload return object.
|
2958
3685
|
#
|
2959
3686
|
# @!attribute [rw] workload_id
|
2960
|
-
# The ID assigned to the workload. This ID is unique within an
|
2961
|
-
# Region.
|
3687
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
3688
|
+
# Web Services Region.
|
2962
3689
|
# @return [String]
|
2963
3690
|
#
|
2964
3691
|
# @!attribute [rw] workload_arn
|
@@ -2968,8 +3695,9 @@ module Aws::WellArchitected
|
|
2968
3695
|
# @!attribute [rw] workload_name
|
2969
3696
|
# The name of the workload.
|
2970
3697
|
#
|
2971
|
-
# The name must be unique within an account within
|
2972
|
-
# and capitalization are ignored when checking
|
3698
|
+
# The name must be unique within an account within an Amazon Web
|
3699
|
+
# Services Region. Spaces and capitalization are ignored when checking
|
3700
|
+
# for uniqueness.
|
2973
3701
|
# @return [String]
|
2974
3702
|
#
|
2975
3703
|
# @!attribute [rw] description
|
@@ -2985,16 +3713,18 @@ module Aws::WellArchitected
|
|
2985
3713
|
# @return [Time]
|
2986
3714
|
#
|
2987
3715
|
# @!attribute [rw] account_ids
|
2988
|
-
# The list of
|
3716
|
+
# The list of Amazon Web Services account IDs associated with the
|
3717
|
+
# workload.
|
2989
3718
|
# @return [Array<String>]
|
2990
3719
|
#
|
2991
3720
|
# @!attribute [rw] aws_regions
|
2992
|
-
# The list of
|
2993
|
-
# `us-east-2`, or `ca-central-1`.
|
3721
|
+
# The list of Amazon Web Services Regions associated with the
|
3722
|
+
# workload, for example, `us-east-2`, or `ca-central-1`.
|
2994
3723
|
# @return [Array<String>]
|
2995
3724
|
#
|
2996
3725
|
# @!attribute [rw] non_aws_regions
|
2997
|
-
# The list of non-
|
3726
|
+
# The list of non-Amazon Web Services Regions associated with the
|
3727
|
+
# workload.
|
2998
3728
|
# @return [Array<String>]
|
2999
3729
|
#
|
3000
3730
|
# @!attribute [rw] architectural_design
|
@@ -3109,7 +3839,7 @@ module Aws::WellArchitected
|
|
3109
3839
|
# @return [Array<String>]
|
3110
3840
|
#
|
3111
3841
|
# @!attribute [rw] owner
|
3112
|
-
# An
|
3842
|
+
# An Amazon Web Services account ID.
|
3113
3843
|
# @return [String]
|
3114
3844
|
#
|
3115
3845
|
# @!attribute [rw] share_invitation_id
|
@@ -3157,11 +3887,12 @@ module Aws::WellArchitected
|
|
3157
3887
|
# @return [String]
|
3158
3888
|
#
|
3159
3889
|
# @!attribute [rw] shared_by
|
3160
|
-
# An
|
3890
|
+
# An Amazon Web Services account ID.
|
3161
3891
|
# @return [String]
|
3162
3892
|
#
|
3163
3893
|
# @!attribute [rw] shared_with
|
3164
|
-
# The
|
3894
|
+
# The Amazon Web Services account ID or IAM role with which the
|
3895
|
+
# workload is shared.
|
3165
3896
|
# @return [String]
|
3166
3897
|
#
|
3167
3898
|
# @!attribute [rw] permission_type
|
@@ -3175,13 +3906,14 @@ module Aws::WellArchitected
|
|
3175
3906
|
# @!attribute [rw] workload_name
|
3176
3907
|
# The name of the workload.
|
3177
3908
|
#
|
3178
|
-
# The name must be unique within an account within
|
3179
|
-
# and capitalization are ignored when checking
|
3909
|
+
# The name must be unique within an account within an Amazon Web
|
3910
|
+
# Services Region. Spaces and capitalization are ignored when checking
|
3911
|
+
# for uniqueness.
|
3180
3912
|
# @return [String]
|
3181
3913
|
#
|
3182
3914
|
# @!attribute [rw] workload_id
|
3183
|
-
# The ID assigned to the workload. This ID is unique within an
|
3184
|
-
# Region.
|
3915
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
3916
|
+
# Web Services Region.
|
3185
3917
|
# @return [String]
|
3186
3918
|
#
|
3187
3919
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/WorkloadShare AWS API Documentation
|
@@ -3205,7 +3937,8 @@ module Aws::WellArchitected
|
|
3205
3937
|
# @return [String]
|
3206
3938
|
#
|
3207
3939
|
# @!attribute [rw] shared_with
|
3208
|
-
# The
|
3940
|
+
# The Amazon Web Services account ID or IAM role with which the
|
3941
|
+
# workload is shared.
|
3209
3942
|
# @return [String]
|
3210
3943
|
#
|
3211
3944
|
# @!attribute [rw] permission_type
|
@@ -3230,8 +3963,8 @@ module Aws::WellArchitected
|
|
3230
3963
|
# A workload summary return object.
|
3231
3964
|
#
|
3232
3965
|
# @!attribute [rw] workload_id
|
3233
|
-
# The ID assigned to the workload. This ID is unique within an
|
3234
|
-
# Region.
|
3966
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
3967
|
+
# Web Services Region.
|
3235
3968
|
# @return [String]
|
3236
3969
|
#
|
3237
3970
|
# @!attribute [rw] workload_arn
|
@@ -3241,12 +3974,13 @@ module Aws::WellArchitected
|
|
3241
3974
|
# @!attribute [rw] workload_name
|
3242
3975
|
# The name of the workload.
|
3243
3976
|
#
|
3244
|
-
# The name must be unique within an account within
|
3245
|
-
# and capitalization are ignored when checking
|
3977
|
+
# The name must be unique within an account within an Amazon Web
|
3978
|
+
# Services Region. Spaces and capitalization are ignored when checking
|
3979
|
+
# for uniqueness.
|
3246
3980
|
# @return [String]
|
3247
3981
|
#
|
3248
3982
|
# @!attribute [rw] owner
|
3249
|
-
# An
|
3983
|
+
# An Amazon Web Services account ID.
|
3250
3984
|
# @return [String]
|
3251
3985
|
#
|
3252
3986
|
# @!attribute [rw] updated_at
|