aws-sdk-wellarchitected 1.10.0 → 1.11.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-wellarchitected/client.rb +679 -97
- 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 +2 -2
@@ -338,12 +338,25 @@ module Aws::WellArchitected
|
|
338
338
|
|
339
339
|
# Associate a lens to a workload.
|
340
340
|
#
|
341
|
+
# Up to 10 lenses can be associated with a workload in a single API
|
342
|
+
# operation. A maximum of 20 lenses can be associated with a workload.
|
343
|
+
#
|
344
|
+
# <note markdown="1"> **Disclaimer**
|
345
|
+
#
|
346
|
+
# By accessing and/or applying custom lenses created by another Amazon
|
347
|
+
# Web Services user or account, you acknowledge that custom lenses
|
348
|
+
# created by other users and shared with you are Third Party Content as
|
349
|
+
# defined in the Amazon Web Services Customer Agreement.
|
350
|
+
#
|
351
|
+
# </note>
|
352
|
+
#
|
341
353
|
# @option params [required, String] :workload_id
|
342
|
-
# The ID assigned to the workload. This ID is unique within an
|
343
|
-
# Region.
|
354
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
355
|
+
# Web Services Region.
|
344
356
|
#
|
345
357
|
# @option params [required, Array<String>] :lens_aliases
|
346
|
-
# List of lens aliases to associate or disassociate with a workload.
|
358
|
+
# List of lens aliases to associate or disassociate with a workload. Up
|
359
|
+
# to 10 lenses can be specified.
|
347
360
|
#
|
348
361
|
# Identify a lens using its LensSummary$LensAlias.
|
349
362
|
#
|
@@ -365,11 +378,144 @@ module Aws::WellArchitected
|
|
365
378
|
req.send_request(options)
|
366
379
|
end
|
367
380
|
|
381
|
+
# Create a lens share.
|
382
|
+
#
|
383
|
+
# The owner of a lens can share it with other Amazon Web Services
|
384
|
+
# accounts and IAM users in the same Amazon Web Services Region. Shared
|
385
|
+
# access to a lens is not removed until the lens invitation is deleted.
|
386
|
+
#
|
387
|
+
# <note markdown="1"> **Disclaimer**
|
388
|
+
#
|
389
|
+
# By sharing your custom lenses with other Amazon Web Services accounts,
|
390
|
+
# you acknowledge that Amazon Web Services will make your custom lenses
|
391
|
+
# available to those other accounts. Those other accounts may continue
|
392
|
+
# to access and use your shared custom lenses even if you delete the
|
393
|
+
# custom lenses from your own Amazon Web Services account or terminate
|
394
|
+
# your Amazon Web Services account.
|
395
|
+
#
|
396
|
+
# </note>
|
397
|
+
#
|
398
|
+
# @option params [required, String] :lens_alias
|
399
|
+
# The alias of the lens, for example, `serverless`.
|
400
|
+
#
|
401
|
+
# Each lens is identified by its LensSummary$LensAlias.
|
402
|
+
#
|
403
|
+
# @option params [required, String] :shared_with
|
404
|
+
# The Amazon Web Services account ID or IAM role with which the workload
|
405
|
+
# is shared.
|
406
|
+
#
|
407
|
+
# @option params [required, String] :client_request_token
|
408
|
+
# A unique case-sensitive string used to ensure that this request is
|
409
|
+
# idempotent (executes only once).
|
410
|
+
#
|
411
|
+
# You should not reuse the same token for other requests. If you retry a
|
412
|
+
# request with the same client request token and the same parameters
|
413
|
+
# after it has completed successfully, the result of the original
|
414
|
+
# request is returned.
|
415
|
+
#
|
416
|
+
# This token is listed as required, however, if you do not specify it,
|
417
|
+
# the Amazon Web Services SDKs automatically generate one for you. If
|
418
|
+
# you are not using the Amazon Web Services SDK or the CLI, you must
|
419
|
+
# provide this token or the request will fail.
|
420
|
+
#
|
421
|
+
# **A suitable default value is auto-generated.** You should normally
|
422
|
+
# not need to pass this option.**
|
423
|
+
#
|
424
|
+
# @return [Types::CreateLensShareOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
425
|
+
#
|
426
|
+
# * {Types::CreateLensShareOutput#share_id #share_id} => String
|
427
|
+
#
|
428
|
+
# @example Request syntax with placeholder values
|
429
|
+
#
|
430
|
+
# resp = client.create_lens_share({
|
431
|
+
# lens_alias: "LensAlias", # required
|
432
|
+
# shared_with: "SharedWith", # required
|
433
|
+
# client_request_token: "ClientRequestToken", # required
|
434
|
+
# })
|
435
|
+
#
|
436
|
+
# @example Response structure
|
437
|
+
#
|
438
|
+
# resp.share_id #=> String
|
439
|
+
#
|
440
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/CreateLensShare AWS API Documentation
|
441
|
+
#
|
442
|
+
# @overload create_lens_share(params = {})
|
443
|
+
# @param [Hash] params ({})
|
444
|
+
def create_lens_share(params = {}, options = {})
|
445
|
+
req = build_request(:create_lens_share, params)
|
446
|
+
req.send_request(options)
|
447
|
+
end
|
448
|
+
|
449
|
+
# Create a new lens version.
|
450
|
+
#
|
451
|
+
# A lens can have up to 100 versions.
|
452
|
+
#
|
453
|
+
# After a lens has been imported, create a new lens version to publish
|
454
|
+
# it. The owner of a lens can share the lens with other Amazon Web
|
455
|
+
# Services accounts and IAM users in the same Amazon Web Services
|
456
|
+
# Region. Only the owner of a lens can delete it.
|
457
|
+
#
|
458
|
+
# @option params [required, String] :lens_alias
|
459
|
+
# The alias of the lens, for example, `serverless`.
|
460
|
+
#
|
461
|
+
# Each lens is identified by its LensSummary$LensAlias.
|
462
|
+
#
|
463
|
+
# @option params [required, String] :lens_version
|
464
|
+
# The version of the lens being created.
|
465
|
+
#
|
466
|
+
# @option params [Boolean] :is_major_version
|
467
|
+
# Set to true if this new major lens version.
|
468
|
+
#
|
469
|
+
# @option params [required, String] :client_request_token
|
470
|
+
# A unique case-sensitive string used to ensure that this request is
|
471
|
+
# idempotent (executes only once).
|
472
|
+
#
|
473
|
+
# You should not reuse the same token for other requests. If you retry a
|
474
|
+
# request with the same client request token and the same parameters
|
475
|
+
# after it has completed successfully, the result of the original
|
476
|
+
# request is returned.
|
477
|
+
#
|
478
|
+
# This token is listed as required, however, if you do not specify it,
|
479
|
+
# the Amazon Web Services SDKs automatically generate one for you. If
|
480
|
+
# you are not using the Amazon Web Services SDK or the CLI, you must
|
481
|
+
# provide this token or the request will fail.
|
482
|
+
#
|
483
|
+
# **A suitable default value is auto-generated.** You should normally
|
484
|
+
# not need to pass this option.**
|
485
|
+
#
|
486
|
+
# @return [Types::CreateLensVersionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
487
|
+
#
|
488
|
+
# * {Types::CreateLensVersionOutput#lens_arn #lens_arn} => String
|
489
|
+
# * {Types::CreateLensVersionOutput#lens_version #lens_version} => String
|
490
|
+
#
|
491
|
+
# @example Request syntax with placeholder values
|
492
|
+
#
|
493
|
+
# resp = client.create_lens_version({
|
494
|
+
# lens_alias: "LensAlias", # required
|
495
|
+
# lens_version: "LensVersion", # required
|
496
|
+
# is_major_version: false,
|
497
|
+
# client_request_token: "ClientRequestToken", # required
|
498
|
+
# })
|
499
|
+
#
|
500
|
+
# @example Response structure
|
501
|
+
#
|
502
|
+
# resp.lens_arn #=> String
|
503
|
+
# resp.lens_version #=> String
|
504
|
+
#
|
505
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/CreateLensVersion AWS API Documentation
|
506
|
+
#
|
507
|
+
# @overload create_lens_version(params = {})
|
508
|
+
# @param [Hash] params ({})
|
509
|
+
def create_lens_version(params = {}, options = {})
|
510
|
+
req = build_request(:create_lens_version, params)
|
511
|
+
req.send_request(options)
|
512
|
+
end
|
513
|
+
|
368
514
|
# Create a milestone for an existing workload.
|
369
515
|
#
|
370
516
|
# @option params [required, String] :workload_id
|
371
|
-
# The ID assigned to the workload. This ID is unique within an
|
372
|
-
# Region.
|
517
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
518
|
+
# Web Services Region.
|
373
519
|
#
|
374
520
|
# @option params [required, String] :milestone_name
|
375
521
|
# The name of the milestone in a workload.
|
@@ -386,9 +532,9 @@ module Aws::WellArchitected
|
|
386
532
|
# request is returned.
|
387
533
|
#
|
388
534
|
# This token is listed as required, however, if you do not specify it,
|
389
|
-
# the
|
390
|
-
# the
|
391
|
-
# will fail.
|
535
|
+
# the Amazon Web Services SDKs automatically generate one for you. If
|
536
|
+
# you are not using the Amazon Web Services SDK or the CLI, you must
|
537
|
+
# provide this token or the request will fail.
|
392
538
|
#
|
393
539
|
# **A suitable default value is auto-generated.** You should normally
|
394
540
|
# not need to pass this option.**
|
@@ -422,12 +568,12 @@ module Aws::WellArchitected
|
|
422
568
|
|
423
569
|
# Create a new workload.
|
424
570
|
#
|
425
|
-
# The owner of a workload can share the workload with other
|
426
|
-
# and IAM users in the same
|
427
|
-
# delete it.
|
571
|
+
# The owner of a workload can share the workload with other Amazon Web
|
572
|
+
# Services accounts and IAM users in the same Amazon Web Services
|
573
|
+
# Region. Only the owner of a workload can delete it.
|
428
574
|
#
|
429
|
-
# For more information, see [Defining a Workload][1] in the
|
430
|
-
# Well-Architected Tool User Guide*.
|
575
|
+
# For more information, see [Defining a Workload][1] in the
|
576
|
+
# *Well-Architected Tool User Guide*.
|
431
577
|
#
|
432
578
|
#
|
433
579
|
#
|
@@ -436,8 +582,9 @@ module Aws::WellArchitected
|
|
436
582
|
# @option params [required, String] :workload_name
|
437
583
|
# The name of the workload.
|
438
584
|
#
|
439
|
-
# The name must be unique within an account within
|
440
|
-
# capitalization are ignored when checking
|
585
|
+
# The name must be unique within an account within an Amazon Web
|
586
|
+
# Services Region. Spaces and capitalization are ignored when checking
|
587
|
+
# for uniqueness.
|
441
588
|
#
|
442
589
|
# @option params [required, String] :description
|
443
590
|
# The description for the workload.
|
@@ -446,14 +593,16 @@ module Aws::WellArchitected
|
|
446
593
|
# The environment for the workload.
|
447
594
|
#
|
448
595
|
# @option params [Array<String>] :account_ids
|
449
|
-
# The list of
|
596
|
+
# The list of Amazon Web Services account IDs associated with the
|
597
|
+
# workload.
|
450
598
|
#
|
451
599
|
# @option params [Array<String>] :aws_regions
|
452
|
-
# The list of
|
453
|
-
# `us-east-2`, or `ca-central-1`.
|
600
|
+
# The list of Amazon Web Services Regions associated with the workload,
|
601
|
+
# for example, `us-east-2`, or `ca-central-1`.
|
454
602
|
#
|
455
603
|
# @option params [Array<String>] :non_aws_regions
|
456
|
-
# The list of non-
|
604
|
+
# The list of non-Amazon Web Services Regions associated with the
|
605
|
+
# workload.
|
457
606
|
#
|
458
607
|
# @option params [Array<String>] :pillar_priorities
|
459
608
|
# The priorities of the pillars, which are used to order items in the
|
@@ -547,9 +696,9 @@ module Aws::WellArchitected
|
|
547
696
|
# request is returned.
|
548
697
|
#
|
549
698
|
# This token is listed as required, however, if you do not specify it,
|
550
|
-
# the
|
551
|
-
# the
|
552
|
-
# will fail.
|
699
|
+
# the Amazon Web Services SDKs automatically generate one for you. If
|
700
|
+
# you are not using the Amazon Web Services SDK or the CLI, you must
|
701
|
+
# provide this token or the request will fail.
|
553
702
|
#
|
554
703
|
# **A suitable default value is auto-generated.** You should normally
|
555
704
|
# not need to pass this option.**
|
@@ -600,23 +749,25 @@ module Aws::WellArchitected
|
|
600
749
|
|
601
750
|
# Create a workload share.
|
602
751
|
#
|
603
|
-
# The owner of a workload can share it with other
|
604
|
-
# users in the same
|
605
|
-
# removed until the workload invitation is
|
752
|
+
# The owner of a workload can share it with other Amazon Web Services
|
753
|
+
# accounts and IAM users in the same Amazon Web Services Region. Shared
|
754
|
+
# access to a workload is not removed until the workload invitation is
|
755
|
+
# deleted.
|
606
756
|
#
|
607
|
-
# For more information, see [Sharing a Workload][1] in the
|
608
|
-
# Well-Architected Tool User Guide*.
|
757
|
+
# For more information, see [Sharing a Workload][1] in the
|
758
|
+
# *Well-Architected Tool User Guide*.
|
609
759
|
#
|
610
760
|
#
|
611
761
|
#
|
612
762
|
# [1]: https://docs.aws.amazon.com/wellarchitected/latest/userguide/workloads-sharing.html
|
613
763
|
#
|
614
764
|
# @option params [required, String] :workload_id
|
615
|
-
# The ID assigned to the workload. This ID is unique within an
|
616
|
-
# Region.
|
765
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
766
|
+
# Web Services Region.
|
617
767
|
#
|
618
768
|
# @option params [required, String] :shared_with
|
619
|
-
# The
|
769
|
+
# The Amazon Web Services account ID or IAM role with which the workload
|
770
|
+
# is shared.
|
620
771
|
#
|
621
772
|
# @option params [required, String] :permission_type
|
622
773
|
# Permission granted on a workload share.
|
@@ -631,9 +782,9 @@ module Aws::WellArchitected
|
|
631
782
|
# request is returned.
|
632
783
|
#
|
633
784
|
# This token is listed as required, however, if you do not specify it,
|
634
|
-
# the
|
635
|
-
# the
|
636
|
-
# will fail.
|
785
|
+
# the Amazon Web Services SDKs automatically generate one for you. If
|
786
|
+
# you are not using the Amazon Web Services SDK or the CLI, you must
|
787
|
+
# provide this token or the request will fail.
|
637
788
|
#
|
638
789
|
# **A suitable default value is auto-generated.** You should normally
|
639
790
|
# not need to pass this option.**
|
@@ -666,11 +817,134 @@ module Aws::WellArchitected
|
|
666
817
|
req.send_request(options)
|
667
818
|
end
|
668
819
|
|
820
|
+
# Delete an existing lens.
|
821
|
+
#
|
822
|
+
# Only the owner of a lens can delete it. After the lens is deleted,
|
823
|
+
# Amazon Web Services accounts and IAM users that you shared the lens
|
824
|
+
# with can continue to use it, but they will no longer be able to apply
|
825
|
+
# it to new workloads.
|
826
|
+
#
|
827
|
+
# <note markdown="1"> **Disclaimer**
|
828
|
+
#
|
829
|
+
# By sharing your custom lenses with other Amazon Web Services accounts,
|
830
|
+
# you acknowledge that Amazon Web Services will make your custom lenses
|
831
|
+
# available to those other accounts. Those other accounts may continue
|
832
|
+
# to access and use your shared custom lenses even if you delete the
|
833
|
+
# custom lenses from your own Amazon Web Services account or terminate
|
834
|
+
# your Amazon Web Services account.
|
835
|
+
#
|
836
|
+
# </note>
|
837
|
+
#
|
838
|
+
# @option params [required, String] :lens_alias
|
839
|
+
# The alias of the lens, for example, `serverless`.
|
840
|
+
#
|
841
|
+
# Each lens is identified by its LensSummary$LensAlias.
|
842
|
+
#
|
843
|
+
# @option params [required, String] :client_request_token
|
844
|
+
# A unique case-sensitive string used to ensure that this request is
|
845
|
+
# idempotent (executes only once).
|
846
|
+
#
|
847
|
+
# You should not reuse the same token for other requests. If you retry a
|
848
|
+
# request with the same client request token and the same parameters
|
849
|
+
# after it has completed successfully, the result of the original
|
850
|
+
# request is returned.
|
851
|
+
#
|
852
|
+
# This token is listed as required, however, if you do not specify it,
|
853
|
+
# the Amazon Web Services SDKs automatically generate one for you. If
|
854
|
+
# you are not using the Amazon Web Services SDK or the CLI, you must
|
855
|
+
# provide this token or the request will fail.
|
856
|
+
#
|
857
|
+
# **A suitable default value is auto-generated.** You should normally
|
858
|
+
# not need to pass this option.**
|
859
|
+
#
|
860
|
+
# @option params [required, String] :lens_status
|
861
|
+
# The status of the lens to be deleted.
|
862
|
+
#
|
863
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
864
|
+
#
|
865
|
+
# @example Request syntax with placeholder values
|
866
|
+
#
|
867
|
+
# resp = client.delete_lens({
|
868
|
+
# lens_alias: "LensAlias", # required
|
869
|
+
# client_request_token: "ClientRequestToken", # required
|
870
|
+
# lens_status: "ALL", # required, accepts ALL, DRAFT, PUBLISHED
|
871
|
+
# })
|
872
|
+
#
|
873
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/DeleteLens AWS API Documentation
|
874
|
+
#
|
875
|
+
# @overload delete_lens(params = {})
|
876
|
+
# @param [Hash] params ({})
|
877
|
+
def delete_lens(params = {}, options = {})
|
878
|
+
req = build_request(:delete_lens, params)
|
879
|
+
req.send_request(options)
|
880
|
+
end
|
881
|
+
|
882
|
+
# Delete a lens share.
|
883
|
+
#
|
884
|
+
# After the lens share is deleted, Amazon Web Services accounts and IAM
|
885
|
+
# users that you shared the lens with can continue to use it, but they
|
886
|
+
# will no longer be able to apply it to new workloads.
|
887
|
+
#
|
888
|
+
# <note markdown="1"> **Disclaimer**
|
889
|
+
#
|
890
|
+
# By sharing your custom lenses with other Amazon Web Services accounts,
|
891
|
+
# you acknowledge that Amazon Web Services will make your custom lenses
|
892
|
+
# available to those other accounts. Those other accounts may continue
|
893
|
+
# to access and use your shared custom lenses even if you delete the
|
894
|
+
# custom lenses from your own Amazon Web Services account or terminate
|
895
|
+
# your Amazon Web Services account.
|
896
|
+
#
|
897
|
+
# </note>
|
898
|
+
#
|
899
|
+
# @option params [required, String] :share_id
|
900
|
+
# The ID associated with the workload share.
|
901
|
+
#
|
902
|
+
# @option params [required, String] :lens_alias
|
903
|
+
# The alias of the lens, for example, `serverless`.
|
904
|
+
#
|
905
|
+
# Each lens is identified by its LensSummary$LensAlias.
|
906
|
+
#
|
907
|
+
# @option params [required, String] :client_request_token
|
908
|
+
# A unique case-sensitive string used to ensure that this request is
|
909
|
+
# idempotent (executes only once).
|
910
|
+
#
|
911
|
+
# You should not reuse the same token for other requests. If you retry a
|
912
|
+
# request with the same client request token and the same parameters
|
913
|
+
# after it has completed successfully, the result of the original
|
914
|
+
# request is returned.
|
915
|
+
#
|
916
|
+
# This token is listed as required, however, if you do not specify it,
|
917
|
+
# the Amazon Web Services SDKs automatically generate one for you. If
|
918
|
+
# you are not using the Amazon Web Services SDK or the CLI, you must
|
919
|
+
# provide this token or the request will fail.
|
920
|
+
#
|
921
|
+
# **A suitable default value is auto-generated.** You should normally
|
922
|
+
# not need to pass this option.**
|
923
|
+
#
|
924
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
925
|
+
#
|
926
|
+
# @example Request syntax with placeholder values
|
927
|
+
#
|
928
|
+
# resp = client.delete_lens_share({
|
929
|
+
# share_id: "ShareId", # required
|
930
|
+
# lens_alias: "LensAlias", # required
|
931
|
+
# client_request_token: "ClientRequestToken", # required
|
932
|
+
# })
|
933
|
+
#
|
934
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/DeleteLensShare AWS API Documentation
|
935
|
+
#
|
936
|
+
# @overload delete_lens_share(params = {})
|
937
|
+
# @param [Hash] params ({})
|
938
|
+
def delete_lens_share(params = {}, options = {})
|
939
|
+
req = build_request(:delete_lens_share, params)
|
940
|
+
req.send_request(options)
|
941
|
+
end
|
942
|
+
|
669
943
|
# Delete an existing workload.
|
670
944
|
#
|
671
945
|
# @option params [required, String] :workload_id
|
672
|
-
# The ID assigned to the workload. This ID is unique within an
|
673
|
-
# Region.
|
946
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
947
|
+
# Web Services Region.
|
674
948
|
#
|
675
949
|
# @option params [required, String] :client_request_token
|
676
950
|
# A unique case-sensitive string used to ensure that this request is
|
@@ -682,9 +956,9 @@ module Aws::WellArchitected
|
|
682
956
|
# request is returned.
|
683
957
|
#
|
684
958
|
# This token is listed as required, however, if you do not specify it,
|
685
|
-
# the
|
686
|
-
# the
|
687
|
-
# will fail.
|
959
|
+
# the Amazon Web Services SDKs automatically generate one for you. If
|
960
|
+
# you are not using the Amazon Web Services SDK or the CLI, you must
|
961
|
+
# provide this token or the request will fail.
|
688
962
|
#
|
689
963
|
# **A suitable default value is auto-generated.** You should normally
|
690
964
|
# not need to pass this option.**
|
@@ -713,8 +987,8 @@ module Aws::WellArchitected
|
|
713
987
|
# The ID associated with the workload share.
|
714
988
|
#
|
715
989
|
# @option params [required, String] :workload_id
|
716
|
-
# The ID assigned to the workload. This ID is unique within an
|
717
|
-
# Region.
|
990
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
991
|
+
# Web Services Region.
|
718
992
|
#
|
719
993
|
# @option params [required, String] :client_request_token
|
720
994
|
# A unique case-sensitive string used to ensure that this request is
|
@@ -726,9 +1000,9 @@ module Aws::WellArchitected
|
|
726
1000
|
# request is returned.
|
727
1001
|
#
|
728
1002
|
# This token is listed as required, however, if you do not specify it,
|
729
|
-
# the
|
730
|
-
# the
|
731
|
-
# will fail.
|
1003
|
+
# the Amazon Web Services SDKs automatically generate one for you. If
|
1004
|
+
# you are not using the Amazon Web Services SDK or the CLI, you must
|
1005
|
+
# provide this token or the request will fail.
|
732
1006
|
#
|
733
1007
|
# **A suitable default value is auto-generated.** You should normally
|
734
1008
|
# not need to pass this option.**
|
@@ -754,17 +1028,21 @@ module Aws::WellArchitected
|
|
754
1028
|
|
755
1029
|
# Disassociate a lens from a workload.
|
756
1030
|
#
|
757
|
-
#
|
758
|
-
#
|
1031
|
+
# Up to 10 lenses can be disassociated from a workload in a single API
|
1032
|
+
# operation.
|
1033
|
+
#
|
1034
|
+
# <note markdown="1"> The Amazon Web Services Well-Architected Framework lens
|
1035
|
+
# (`wellarchitected`) cannot be removed from a workload.
|
759
1036
|
#
|
760
1037
|
# </note>
|
761
1038
|
#
|
762
1039
|
# @option params [required, String] :workload_id
|
763
|
-
# The ID assigned to the workload. This ID is unique within an
|
764
|
-
# Region.
|
1040
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
1041
|
+
# Web Services Region.
|
765
1042
|
#
|
766
1043
|
# @option params [required, Array<String>] :lens_aliases
|
767
|
-
# List of lens aliases to associate or disassociate with a workload.
|
1044
|
+
# List of lens aliases to associate or disassociate with a workload. Up
|
1045
|
+
# to 10 lenses can be specified.
|
768
1046
|
#
|
769
1047
|
# Identify a lens using its LensSummary$LensAlias.
|
770
1048
|
#
|
@@ -786,11 +1064,65 @@ module Aws::WellArchitected
|
|
786
1064
|
req.send_request(options)
|
787
1065
|
end
|
788
1066
|
|
1067
|
+
# Export an existing lens.
|
1068
|
+
#
|
1069
|
+
# Lenses are defined in JSON. For more information, see [JSON format
|
1070
|
+
# specification][1] in the *Well-Architected Tool User Guide*. Only the
|
1071
|
+
# owner of a lens can export it.
|
1072
|
+
#
|
1073
|
+
# <note markdown="1"> **Disclaimer**
|
1074
|
+
#
|
1075
|
+
# Do not include or gather personal identifiable information (PII) of
|
1076
|
+
# end users or other identifiable individuals in or via your custom
|
1077
|
+
# lenses. If your custom lens or those shared with you and used in your
|
1078
|
+
# account do include or collect PII you are responsible for: ensuring
|
1079
|
+
# that the included PII is processed in accordance with applicable law,
|
1080
|
+
# providing adequate privacy notices, and obtaining necessary consents
|
1081
|
+
# for processing such data.
|
1082
|
+
#
|
1083
|
+
# </note>
|
1084
|
+
#
|
1085
|
+
#
|
1086
|
+
#
|
1087
|
+
# [1]: https://docs.aws.amazon.com/wellarchitected/latest/userguide/lenses-format-specification.html
|
1088
|
+
#
|
1089
|
+
# @option params [required, String] :lens_alias
|
1090
|
+
# The alias of the lens, for example, `serverless`.
|
1091
|
+
#
|
1092
|
+
# Each lens is identified by its LensSummary$LensAlias.
|
1093
|
+
#
|
1094
|
+
# @option params [String] :lens_version
|
1095
|
+
# The lens version to be exported.
|
1096
|
+
#
|
1097
|
+
# @return [Types::ExportLensOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1098
|
+
#
|
1099
|
+
# * {Types::ExportLensOutput#lens_json #lens_json} => String
|
1100
|
+
#
|
1101
|
+
# @example Request syntax with placeholder values
|
1102
|
+
#
|
1103
|
+
# resp = client.export_lens({
|
1104
|
+
# lens_alias: "LensAlias", # required
|
1105
|
+
# lens_version: "LensVersion",
|
1106
|
+
# })
|
1107
|
+
#
|
1108
|
+
# @example Response structure
|
1109
|
+
#
|
1110
|
+
# resp.lens_json #=> String
|
1111
|
+
#
|
1112
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ExportLens AWS API Documentation
|
1113
|
+
#
|
1114
|
+
# @overload export_lens(params = {})
|
1115
|
+
# @param [Hash] params ({})
|
1116
|
+
def export_lens(params = {}, options = {})
|
1117
|
+
req = build_request(:export_lens, params)
|
1118
|
+
req.send_request(options)
|
1119
|
+
end
|
1120
|
+
|
789
1121
|
# Get the answer to a specific question in a workload review.
|
790
1122
|
#
|
791
1123
|
# @option params [required, String] :workload_id
|
792
|
-
# The ID assigned to the workload. This ID is unique within an
|
793
|
-
# Region.
|
1124
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
1125
|
+
# Web Services Region.
|
794
1126
|
#
|
795
1127
|
# @option params [required, String] :lens_alias
|
796
1128
|
# The alias of the lens, for example, `serverless`.
|
@@ -810,6 +1142,7 @@ module Aws::WellArchitected
|
|
810
1142
|
# * {Types::GetAnswerOutput#workload_id #workload_id} => String
|
811
1143
|
# * {Types::GetAnswerOutput#milestone_number #milestone_number} => Integer
|
812
1144
|
# * {Types::GetAnswerOutput#lens_alias #lens_alias} => String
|
1145
|
+
# * {Types::GetAnswerOutput#lens_arn #lens_arn} => String
|
813
1146
|
# * {Types::GetAnswerOutput#answer #answer} => Types::Answer
|
814
1147
|
#
|
815
1148
|
# @example Request syntax with placeholder values
|
@@ -826,16 +1159,22 @@ module Aws::WellArchitected
|
|
826
1159
|
# resp.workload_id #=> String
|
827
1160
|
# resp.milestone_number #=> Integer
|
828
1161
|
# resp.lens_alias #=> String
|
1162
|
+
# resp.lens_arn #=> String
|
829
1163
|
# resp.answer.question_id #=> String
|
830
1164
|
# resp.answer.pillar_id #=> String
|
831
1165
|
# resp.answer.question_title #=> String
|
832
1166
|
# resp.answer.question_description #=> String
|
833
1167
|
# resp.answer.improvement_plan_url #=> String
|
834
1168
|
# resp.answer.helpful_resource_url #=> String
|
1169
|
+
# resp.answer.helpful_resource_display_text #=> String
|
835
1170
|
# resp.answer.choices #=> Array
|
836
1171
|
# resp.answer.choices[0].choice_id #=> String
|
837
1172
|
# resp.answer.choices[0].title #=> String
|
838
1173
|
# resp.answer.choices[0].description #=> String
|
1174
|
+
# resp.answer.choices[0].helpful_resource.display_text #=> String
|
1175
|
+
# resp.answer.choices[0].helpful_resource.url #=> String
|
1176
|
+
# resp.answer.choices[0].improvement_plan.display_text #=> String
|
1177
|
+
# resp.answer.choices[0].improvement_plan.url #=> String
|
839
1178
|
# resp.answer.selected_choices #=> Array
|
840
1179
|
# resp.answer.selected_choices[0] #=> String
|
841
1180
|
# resp.answer.choice_answers #=> Array
|
@@ -857,11 +1196,50 @@ module Aws::WellArchitected
|
|
857
1196
|
req.send_request(options)
|
858
1197
|
end
|
859
1198
|
|
1199
|
+
# Get an existing lens.
|
1200
|
+
#
|
1201
|
+
# @option params [required, String] :lens_alias
|
1202
|
+
# The alias of the lens, for example, `serverless`.
|
1203
|
+
#
|
1204
|
+
# Each lens is identified by its LensSummary$LensAlias.
|
1205
|
+
#
|
1206
|
+
# @option params [String] :lens_version
|
1207
|
+
# The lens version to be retrieved.
|
1208
|
+
#
|
1209
|
+
# @return [Types::GetLensOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1210
|
+
#
|
1211
|
+
# * {Types::GetLensOutput#lens #lens} => Types::Lens
|
1212
|
+
#
|
1213
|
+
# @example Request syntax with placeholder values
|
1214
|
+
#
|
1215
|
+
# resp = client.get_lens({
|
1216
|
+
# lens_alias: "LensAlias", # required
|
1217
|
+
# lens_version: "LensVersion",
|
1218
|
+
# })
|
1219
|
+
#
|
1220
|
+
# @example Response structure
|
1221
|
+
#
|
1222
|
+
# resp.lens.lens_arn #=> String
|
1223
|
+
# resp.lens.lens_version #=> String
|
1224
|
+
# resp.lens.name #=> String
|
1225
|
+
# resp.lens.description #=> String
|
1226
|
+
# resp.lens.owner #=> String
|
1227
|
+
# resp.lens.share_invitation_id #=> String
|
1228
|
+
#
|
1229
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetLens AWS API Documentation
|
1230
|
+
#
|
1231
|
+
# @overload get_lens(params = {})
|
1232
|
+
# @param [Hash] params ({})
|
1233
|
+
def get_lens(params = {}, options = {})
|
1234
|
+
req = build_request(:get_lens, params)
|
1235
|
+
req.send_request(options)
|
1236
|
+
end
|
1237
|
+
|
860
1238
|
# Get lens review.
|
861
1239
|
#
|
862
1240
|
# @option params [required, String] :workload_id
|
863
|
-
# The ID assigned to the workload. This ID is unique within an
|
864
|
-
# Region.
|
1241
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
1242
|
+
# Web Services Region.
|
865
1243
|
#
|
866
1244
|
# @option params [required, String] :lens_alias
|
867
1245
|
# The alias of the lens, for example, `serverless`.
|
@@ -892,9 +1270,10 @@ module Aws::WellArchitected
|
|
892
1270
|
# resp.workload_id #=> String
|
893
1271
|
# resp.milestone_number #=> Integer
|
894
1272
|
# resp.lens_review.lens_alias #=> String
|
1273
|
+
# resp.lens_review.lens_arn #=> String
|
895
1274
|
# resp.lens_review.lens_version #=> String
|
896
1275
|
# resp.lens_review.lens_name #=> String
|
897
|
-
# resp.lens_review.lens_status #=> String, one of "CURRENT", "NOT_CURRENT", "DEPRECATED"
|
1276
|
+
# resp.lens_review.lens_status #=> String, one of "CURRENT", "NOT_CURRENT", "DEPRECATED", "DELETED", "UNSHARED"
|
898
1277
|
# resp.lens_review.pillar_review_summaries #=> Array
|
899
1278
|
# resp.lens_review.pillar_review_summaries[0].pillar_id #=> String
|
900
1279
|
# resp.lens_review.pillar_review_summaries[0].pillar_name #=> String
|
@@ -919,8 +1298,8 @@ module Aws::WellArchitected
|
|
919
1298
|
# Get lens review report.
|
920
1299
|
#
|
921
1300
|
# @option params [required, String] :workload_id
|
922
|
-
# The ID assigned to the workload. This ID is unique within an
|
923
|
-
# Region.
|
1301
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
1302
|
+
# Web Services Region.
|
924
1303
|
#
|
925
1304
|
# @option params [required, String] :lens_alias
|
926
1305
|
# The alias of the lens, for example, `serverless`.
|
@@ -951,6 +1330,7 @@ module Aws::WellArchitected
|
|
951
1330
|
# resp.workload_id #=> String
|
952
1331
|
# resp.milestone_number #=> Integer
|
953
1332
|
# resp.lens_review_report.lens_alias #=> String
|
1333
|
+
# resp.lens_review_report.lens_arn #=> String
|
954
1334
|
# resp.lens_review_report.base_64_string #=> String
|
955
1335
|
#
|
956
1336
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetLensReviewReport AWS API Documentation
|
@@ -969,13 +1349,18 @@ module Aws::WellArchitected
|
|
969
1349
|
#
|
970
1350
|
# Each lens is identified by its LensSummary$LensAlias.
|
971
1351
|
#
|
972
|
-
# @option params [
|
1352
|
+
# @option params [String] :base_lens_version
|
973
1353
|
# The base version of the lens.
|
974
1354
|
#
|
1355
|
+
# @option params [String] :target_lens_version
|
1356
|
+
# The lens version to target a difference for.
|
1357
|
+
#
|
975
1358
|
# @return [Types::GetLensVersionDifferenceOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
976
1359
|
#
|
977
1360
|
# * {Types::GetLensVersionDifferenceOutput#lens_alias #lens_alias} => String
|
1361
|
+
# * {Types::GetLensVersionDifferenceOutput#lens_arn #lens_arn} => String
|
978
1362
|
# * {Types::GetLensVersionDifferenceOutput#base_lens_version #base_lens_version} => String
|
1363
|
+
# * {Types::GetLensVersionDifferenceOutput#target_lens_version #target_lens_version} => String
|
979
1364
|
# * {Types::GetLensVersionDifferenceOutput#latest_lens_version #latest_lens_version} => String
|
980
1365
|
# * {Types::GetLensVersionDifferenceOutput#version_differences #version_differences} => Types::VersionDifferences
|
981
1366
|
#
|
@@ -983,16 +1368,20 @@ module Aws::WellArchitected
|
|
983
1368
|
#
|
984
1369
|
# resp = client.get_lens_version_difference({
|
985
1370
|
# lens_alias: "LensAlias", # required
|
986
|
-
# base_lens_version: "LensVersion",
|
1371
|
+
# base_lens_version: "LensVersion",
|
1372
|
+
# target_lens_version: "LensVersion",
|
987
1373
|
# })
|
988
1374
|
#
|
989
1375
|
# @example Response structure
|
990
1376
|
#
|
991
1377
|
# resp.lens_alias #=> String
|
1378
|
+
# resp.lens_arn #=> String
|
992
1379
|
# resp.base_lens_version #=> String
|
1380
|
+
# resp.target_lens_version #=> String
|
993
1381
|
# resp.latest_lens_version #=> String
|
994
1382
|
# resp.version_differences.pillar_differences #=> Array
|
995
1383
|
# resp.version_differences.pillar_differences[0].pillar_id #=> String
|
1384
|
+
# resp.version_differences.pillar_differences[0].pillar_name #=> String
|
996
1385
|
# resp.version_differences.pillar_differences[0].difference_status #=> String, one of "UPDATED", "NEW", "DELETED"
|
997
1386
|
# resp.version_differences.pillar_differences[0].question_differences #=> Array
|
998
1387
|
# resp.version_differences.pillar_differences[0].question_differences[0].question_id #=> String
|
@@ -1011,8 +1400,8 @@ module Aws::WellArchitected
|
|
1011
1400
|
# Get a milestone for an existing workload.
|
1012
1401
|
#
|
1013
1402
|
# @option params [required, String] :workload_id
|
1014
|
-
# The ID assigned to the workload. This ID is unique within an
|
1015
|
-
# Region.
|
1403
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
1404
|
+
# Web Services Region.
|
1016
1405
|
#
|
1017
1406
|
# @option params [required, Integer] :milestone_number
|
1018
1407
|
# The milestone number.
|
@@ -1080,8 +1469,8 @@ module Aws::WellArchitected
|
|
1080
1469
|
# Get an existing workload.
|
1081
1470
|
#
|
1082
1471
|
# @option params [required, String] :workload_id
|
1083
|
-
# The ID assigned to the workload. This ID is unique within an
|
1084
|
-
# Region.
|
1472
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
1473
|
+
# Web Services Region.
|
1085
1474
|
#
|
1086
1475
|
# @return [Types::GetWorkloadOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1087
1476
|
#
|
@@ -1135,11 +1524,95 @@ module Aws::WellArchitected
|
|
1135
1524
|
req.send_request(options)
|
1136
1525
|
end
|
1137
1526
|
|
1527
|
+
# Import a new lens.
|
1528
|
+
#
|
1529
|
+
# The lens cannot be applied to workloads or shared with other Amazon
|
1530
|
+
# Web Services accounts until it's published with CreateLensVersion
|
1531
|
+
#
|
1532
|
+
# Lenses are defined in JSON. For more information, see [JSON format
|
1533
|
+
# specification][1] in the *Well-Architected Tool User Guide*.
|
1534
|
+
#
|
1535
|
+
# A custom lens cannot exceed 500 KB in size.
|
1536
|
+
#
|
1537
|
+
# <note markdown="1"> **Disclaimer**
|
1538
|
+
#
|
1539
|
+
# Do not include or gather personal identifiable information (PII) of
|
1540
|
+
# end users or other identifiable individuals in or via your custom
|
1541
|
+
# lenses. If your custom lens or those shared with you and used in your
|
1542
|
+
# account do include or collect PII you are responsible for: ensuring
|
1543
|
+
# that the included PII is processed in accordance with applicable law,
|
1544
|
+
# providing adequate privacy notices, and obtaining necessary consents
|
1545
|
+
# for processing such data.
|
1546
|
+
#
|
1547
|
+
# </note>
|
1548
|
+
#
|
1549
|
+
#
|
1550
|
+
#
|
1551
|
+
# [1]: https://docs.aws.amazon.com/wellarchitected/latest/userguide/lenses-format-specification.html
|
1552
|
+
#
|
1553
|
+
# @option params [String] :lens_alias
|
1554
|
+
# The alias of the lens, for example, `serverless`.
|
1555
|
+
#
|
1556
|
+
# Each lens is identified by its LensSummary$LensAlias.
|
1557
|
+
#
|
1558
|
+
# @option params [required, String] :json_string
|
1559
|
+
# The JSON representation of a lens.
|
1560
|
+
#
|
1561
|
+
# @option params [required, String] :client_request_token
|
1562
|
+
# A unique case-sensitive string used to ensure that this request is
|
1563
|
+
# idempotent (executes only once).
|
1564
|
+
#
|
1565
|
+
# You should not reuse the same token for other requests. If you retry a
|
1566
|
+
# request with the same client request token and the same parameters
|
1567
|
+
# after it has completed successfully, the result of the original
|
1568
|
+
# request is returned.
|
1569
|
+
#
|
1570
|
+
# This token is listed as required, however, if you do not specify it,
|
1571
|
+
# the Amazon Web Services SDKs automatically generate one for you. If
|
1572
|
+
# you are not using the Amazon Web Services SDK or the CLI, you must
|
1573
|
+
# provide this token or the request will fail.
|
1574
|
+
#
|
1575
|
+
# **A suitable default value is auto-generated.** You should normally
|
1576
|
+
# not need to pass this option.**
|
1577
|
+
#
|
1578
|
+
# @option params [Hash<String,String>] :tags
|
1579
|
+
# Tags to associate to a lens.
|
1580
|
+
#
|
1581
|
+
# @return [Types::ImportLensOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1582
|
+
#
|
1583
|
+
# * {Types::ImportLensOutput#lens_arn #lens_arn} => String
|
1584
|
+
# * {Types::ImportLensOutput#status #status} => String
|
1585
|
+
#
|
1586
|
+
# @example Request syntax with placeholder values
|
1587
|
+
#
|
1588
|
+
# resp = client.import_lens({
|
1589
|
+
# lens_alias: "LensAlias",
|
1590
|
+
# json_string: "LensJSON", # required
|
1591
|
+
# client_request_token: "ClientRequestToken", # required
|
1592
|
+
# tags: {
|
1593
|
+
# "TagKey" => "TagValue",
|
1594
|
+
# },
|
1595
|
+
# })
|
1596
|
+
#
|
1597
|
+
# @example Response structure
|
1598
|
+
#
|
1599
|
+
# resp.lens_arn #=> String
|
1600
|
+
# resp.status #=> String, one of "IN_PROGRESS", "COMPLETE", "ERROR"
|
1601
|
+
#
|
1602
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ImportLens AWS API Documentation
|
1603
|
+
#
|
1604
|
+
# @overload import_lens(params = {})
|
1605
|
+
# @param [Hash] params ({})
|
1606
|
+
def import_lens(params = {}, options = {})
|
1607
|
+
req = build_request(:import_lens, params)
|
1608
|
+
req.send_request(options)
|
1609
|
+
end
|
1610
|
+
|
1138
1611
|
# List of answers.
|
1139
1612
|
#
|
1140
1613
|
# @option params [required, String] :workload_id
|
1141
|
-
# The ID assigned to the workload. This ID is unique within an
|
1142
|
-
# Region.
|
1614
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
1615
|
+
# Web Services Region.
|
1143
1616
|
#
|
1144
1617
|
# @option params [required, String] :lens_alias
|
1145
1618
|
# The alias of the lens, for example, `serverless`.
|
@@ -1167,6 +1640,7 @@ module Aws::WellArchitected
|
|
1167
1640
|
# * {Types::ListAnswersOutput#workload_id #workload_id} => String
|
1168
1641
|
# * {Types::ListAnswersOutput#milestone_number #milestone_number} => Integer
|
1169
1642
|
# * {Types::ListAnswersOutput#lens_alias #lens_alias} => String
|
1643
|
+
# * {Types::ListAnswersOutput#lens_arn #lens_arn} => String
|
1170
1644
|
# * {Types::ListAnswersOutput#answer_summaries #answer_summaries} => Array<Types::AnswerSummary>
|
1171
1645
|
# * {Types::ListAnswersOutput#next_token #next_token} => String
|
1172
1646
|
#
|
@@ -1188,6 +1662,7 @@ module Aws::WellArchitected
|
|
1188
1662
|
# resp.workload_id #=> String
|
1189
1663
|
# resp.milestone_number #=> Integer
|
1190
1664
|
# resp.lens_alias #=> String
|
1665
|
+
# resp.lens_arn #=> String
|
1191
1666
|
# resp.answer_summaries #=> Array
|
1192
1667
|
# resp.answer_summaries[0].question_id #=> String
|
1193
1668
|
# resp.answer_summaries[0].pillar_id #=> String
|
@@ -1196,6 +1671,10 @@ module Aws::WellArchitected
|
|
1196
1671
|
# resp.answer_summaries[0].choices[0].choice_id #=> String
|
1197
1672
|
# resp.answer_summaries[0].choices[0].title #=> String
|
1198
1673
|
# resp.answer_summaries[0].choices[0].description #=> String
|
1674
|
+
# resp.answer_summaries[0].choices[0].helpful_resource.display_text #=> String
|
1675
|
+
# resp.answer_summaries[0].choices[0].helpful_resource.url #=> String
|
1676
|
+
# resp.answer_summaries[0].choices[0].improvement_plan.display_text #=> String
|
1677
|
+
# resp.answer_summaries[0].choices[0].improvement_plan.url #=> String
|
1199
1678
|
# resp.answer_summaries[0].selected_choices #=> Array
|
1200
1679
|
# resp.answer_summaries[0].selected_choices[0] #=> String
|
1201
1680
|
# resp.answer_summaries[0].choice_answer_summaries #=> Array
|
@@ -1219,8 +1698,8 @@ module Aws::WellArchitected
|
|
1219
1698
|
# List lens review improvements.
|
1220
1699
|
#
|
1221
1700
|
# @option params [required, String] :workload_id
|
1222
|
-
# The ID assigned to the workload. This ID is unique within an
|
1223
|
-
# Region.
|
1701
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
1702
|
+
# Web Services Region.
|
1224
1703
|
#
|
1225
1704
|
# @option params [required, String] :lens_alias
|
1226
1705
|
# The alias of the lens, for example, `serverless`.
|
@@ -1248,6 +1727,7 @@ module Aws::WellArchitected
|
|
1248
1727
|
# * {Types::ListLensReviewImprovementsOutput#workload_id #workload_id} => String
|
1249
1728
|
# * {Types::ListLensReviewImprovementsOutput#milestone_number #milestone_number} => Integer
|
1250
1729
|
# * {Types::ListLensReviewImprovementsOutput#lens_alias #lens_alias} => String
|
1730
|
+
# * {Types::ListLensReviewImprovementsOutput#lens_arn #lens_arn} => String
|
1251
1731
|
# * {Types::ListLensReviewImprovementsOutput#improvement_summaries #improvement_summaries} => Array<Types::ImprovementSummary>
|
1252
1732
|
# * {Types::ListLensReviewImprovementsOutput#next_token #next_token} => String
|
1253
1733
|
#
|
@@ -1269,12 +1749,17 @@ module Aws::WellArchitected
|
|
1269
1749
|
# resp.workload_id #=> String
|
1270
1750
|
# resp.milestone_number #=> Integer
|
1271
1751
|
# resp.lens_alias #=> String
|
1752
|
+
# resp.lens_arn #=> String
|
1272
1753
|
# resp.improvement_summaries #=> Array
|
1273
1754
|
# resp.improvement_summaries[0].question_id #=> String
|
1274
1755
|
# resp.improvement_summaries[0].pillar_id #=> String
|
1275
1756
|
# resp.improvement_summaries[0].question_title #=> String
|
1276
1757
|
# resp.improvement_summaries[0].risk #=> String, one of "UNANSWERED", "HIGH", "MEDIUM", "NONE", "NOT_APPLICABLE"
|
1277
1758
|
# resp.improvement_summaries[0].improvement_plan_url #=> String
|
1759
|
+
# resp.improvement_summaries[0].improvement_plans #=> Array
|
1760
|
+
# resp.improvement_summaries[0].improvement_plans[0].choice_id #=> String
|
1761
|
+
# resp.improvement_summaries[0].improvement_plans[0].display_text #=> String
|
1762
|
+
# resp.improvement_summaries[0].improvement_plans[0].improvement_plan_url #=> String
|
1278
1763
|
# resp.next_token #=> String
|
1279
1764
|
#
|
1280
1765
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListLensReviewImprovements AWS API Documentation
|
@@ -1289,8 +1774,8 @@ module Aws::WellArchitected
|
|
1289
1774
|
# List lens reviews.
|
1290
1775
|
#
|
1291
1776
|
# @option params [required, String] :workload_id
|
1292
|
-
# The ID assigned to the workload. This ID is unique within an
|
1293
|
-
# Region.
|
1777
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
1778
|
+
# Web Services Region.
|
1294
1779
|
#
|
1295
1780
|
# @option params [Integer] :milestone_number
|
1296
1781
|
# The milestone number.
|
@@ -1327,9 +1812,10 @@ module Aws::WellArchitected
|
|
1327
1812
|
# resp.milestone_number #=> Integer
|
1328
1813
|
# resp.lens_review_summaries #=> Array
|
1329
1814
|
# resp.lens_review_summaries[0].lens_alias #=> String
|
1815
|
+
# resp.lens_review_summaries[0].lens_arn #=> String
|
1330
1816
|
# resp.lens_review_summaries[0].lens_version #=> String
|
1331
1817
|
# resp.lens_review_summaries[0].lens_name #=> String
|
1332
|
-
# resp.lens_review_summaries[0].lens_status #=> String, one of "CURRENT", "NOT_CURRENT", "DEPRECATED"
|
1818
|
+
# resp.lens_review_summaries[0].lens_status #=> String, one of "CURRENT", "NOT_CURRENT", "DEPRECATED", "DELETED", "UNSHARED"
|
1333
1819
|
# resp.lens_review_summaries[0].updated_at #=> Time
|
1334
1820
|
# resp.lens_review_summaries[0].risk_counts #=> Hash
|
1335
1821
|
# resp.lens_review_summaries[0].risk_counts["Risk"] #=> Integer
|
@@ -1344,6 +1830,56 @@ module Aws::WellArchitected
|
|
1344
1830
|
req.send_request(options)
|
1345
1831
|
end
|
1346
1832
|
|
1833
|
+
# List the lens shares associated with the lens.
|
1834
|
+
#
|
1835
|
+
# @option params [required, String] :lens_alias
|
1836
|
+
# The alias of the lens, for example, `serverless`.
|
1837
|
+
#
|
1838
|
+
# Each lens is identified by its LensSummary$LensAlias.
|
1839
|
+
#
|
1840
|
+
# @option params [String] :shared_with_prefix
|
1841
|
+
# The Amazon Web Services account ID or IAM role with which the lens is
|
1842
|
+
# shared.
|
1843
|
+
#
|
1844
|
+
# @option params [String] :next_token
|
1845
|
+
# The token to use to retrieve the next set of results.
|
1846
|
+
#
|
1847
|
+
# @option params [Integer] :max_results
|
1848
|
+
# The maximum number of results to return for this request.
|
1849
|
+
#
|
1850
|
+
# @return [Types::ListLensSharesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1851
|
+
#
|
1852
|
+
# * {Types::ListLensSharesOutput#lens_share_summaries #lens_share_summaries} => Array<Types::LensShareSummary>
|
1853
|
+
# * {Types::ListLensSharesOutput#next_token #next_token} => String
|
1854
|
+
#
|
1855
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1856
|
+
#
|
1857
|
+
# @example Request syntax with placeholder values
|
1858
|
+
#
|
1859
|
+
# resp = client.list_lens_shares({
|
1860
|
+
# lens_alias: "LensAlias", # required
|
1861
|
+
# shared_with_prefix: "SharedWithPrefix",
|
1862
|
+
# next_token: "NextToken",
|
1863
|
+
# max_results: 1,
|
1864
|
+
# })
|
1865
|
+
#
|
1866
|
+
# @example Response structure
|
1867
|
+
#
|
1868
|
+
# resp.lens_share_summaries #=> Array
|
1869
|
+
# resp.lens_share_summaries[0].share_id #=> String
|
1870
|
+
# resp.lens_share_summaries[0].shared_with #=> String
|
1871
|
+
# resp.lens_share_summaries[0].status #=> String, one of "ACCEPTED", "REJECTED", "PENDING", "REVOKED", "EXPIRED"
|
1872
|
+
# resp.next_token #=> String
|
1873
|
+
#
|
1874
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListLensShares AWS API Documentation
|
1875
|
+
#
|
1876
|
+
# @overload list_lens_shares(params = {})
|
1877
|
+
# @param [Hash] params ({})
|
1878
|
+
def list_lens_shares(params = {}, options = {})
|
1879
|
+
req = build_request(:list_lens_shares, params)
|
1880
|
+
req.send_request(options)
|
1881
|
+
end
|
1882
|
+
|
1347
1883
|
# List the available lenses.
|
1348
1884
|
#
|
1349
1885
|
# @option params [String] :next_token
|
@@ -1352,6 +1888,15 @@ module Aws::WellArchitected
|
|
1352
1888
|
# @option params [Integer] :max_results
|
1353
1889
|
# The maximum number of results to return for this request.
|
1354
1890
|
#
|
1891
|
+
# @option params [String] :lens_type
|
1892
|
+
# The type of lenses to be returned.
|
1893
|
+
#
|
1894
|
+
# @option params [String] :lens_status
|
1895
|
+
# The status of lenses to be returned.
|
1896
|
+
#
|
1897
|
+
# @option params [String] :lens_name
|
1898
|
+
# The full name of the lens.
|
1899
|
+
#
|
1355
1900
|
# @return [Types::ListLensesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1356
1901
|
#
|
1357
1902
|
# * {Types::ListLensesOutput#lens_summaries #lens_summaries} => Array<Types::LensSummary>
|
@@ -1364,15 +1909,24 @@ module Aws::WellArchitected
|
|
1364
1909
|
# resp = client.list_lenses({
|
1365
1910
|
# next_token: "NextToken",
|
1366
1911
|
# max_results: 1,
|
1912
|
+
# lens_type: "AWS_OFFICIAL", # accepts AWS_OFFICIAL, CUSTOM_SHARED, CUSTOM_SELF
|
1913
|
+
# lens_status: "ALL", # accepts ALL, DRAFT, PUBLISHED
|
1914
|
+
# lens_name: "LensName",
|
1367
1915
|
# })
|
1368
1916
|
#
|
1369
1917
|
# @example Response structure
|
1370
1918
|
#
|
1371
1919
|
# resp.lens_summaries #=> Array
|
1920
|
+
# resp.lens_summaries[0].lens_arn #=> String
|
1372
1921
|
# resp.lens_summaries[0].lens_alias #=> String
|
1373
|
-
# resp.lens_summaries[0].lens_version #=> String
|
1374
1922
|
# resp.lens_summaries[0].lens_name #=> String
|
1923
|
+
# resp.lens_summaries[0].lens_type #=> String, one of "AWS_OFFICIAL", "CUSTOM_SHARED", "CUSTOM_SELF"
|
1375
1924
|
# resp.lens_summaries[0].description #=> String
|
1925
|
+
# resp.lens_summaries[0].created_at #=> Time
|
1926
|
+
# resp.lens_summaries[0].updated_at #=> Time
|
1927
|
+
# resp.lens_summaries[0].lens_version #=> String
|
1928
|
+
# resp.lens_summaries[0].owner #=> String
|
1929
|
+
# resp.lens_summaries[0].lens_status #=> String, one of "CURRENT", "NOT_CURRENT", "DEPRECATED", "DELETED", "UNSHARED"
|
1376
1930
|
# resp.next_token #=> String
|
1377
1931
|
#
|
1378
1932
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListLenses AWS API Documentation
|
@@ -1387,8 +1941,8 @@ module Aws::WellArchitected
|
|
1387
1941
|
# List all milestones for an existing workload.
|
1388
1942
|
#
|
1389
1943
|
# @option params [required, String] :workload_id
|
1390
|
-
# The ID assigned to the workload. This ID is unique within an
|
1391
|
-
# Region.
|
1944
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
1945
|
+
# Web Services Region.
|
1392
1946
|
#
|
1393
1947
|
# @option params [String] :next_token
|
1394
1948
|
# The token to use to retrieve the next set of results.
|
@@ -1443,8 +1997,8 @@ module Aws::WellArchitected
|
|
1443
1997
|
# List lens notifications.
|
1444
1998
|
#
|
1445
1999
|
# @option params [String] :workload_id
|
1446
|
-
# The ID assigned to the workload. This ID is unique within an
|
1447
|
-
# Region.
|
2000
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
2001
|
+
# Web Services Region.
|
1448
2002
|
#
|
1449
2003
|
# @option params [String] :next_token
|
1450
2004
|
# The token to use to retrieve the next set of results.
|
@@ -1474,6 +2028,7 @@ module Aws::WellArchitected
|
|
1474
2028
|
# resp.notification_summaries[0].lens_upgrade_summary.workload_id #=> String
|
1475
2029
|
# resp.notification_summaries[0].lens_upgrade_summary.workload_name #=> String
|
1476
2030
|
# resp.notification_summaries[0].lens_upgrade_summary.lens_alias #=> String
|
2031
|
+
# resp.notification_summaries[0].lens_upgrade_summary.lens_arn #=> String
|
1477
2032
|
# resp.notification_summaries[0].lens_upgrade_summary.current_lens_version #=> String
|
1478
2033
|
# resp.notification_summaries[0].lens_upgrade_summary.latest_lens_version #=> String
|
1479
2034
|
# resp.next_token #=> String
|
@@ -1493,6 +2048,13 @@ module Aws::WellArchitected
|
|
1493
2048
|
# An optional string added to the beginning of each workload name
|
1494
2049
|
# returned in the results.
|
1495
2050
|
#
|
2051
|
+
# @option params [String] :lens_name_prefix
|
2052
|
+
# An optional string added to the beginning of each lens name returned
|
2053
|
+
# in the results.
|
2054
|
+
#
|
2055
|
+
# @option params [String] :share_resource_type
|
2056
|
+
# The type of share invitations to be returned.
|
2057
|
+
#
|
1496
2058
|
# @option params [String] :next_token
|
1497
2059
|
# The token to use to retrieve the next set of results.
|
1498
2060
|
#
|
@@ -1510,6 +2072,8 @@ module Aws::WellArchitected
|
|
1510
2072
|
#
|
1511
2073
|
# resp = client.list_share_invitations({
|
1512
2074
|
# workload_name_prefix: "WorkloadNamePrefix",
|
2075
|
+
# lens_name_prefix: "LensNamePrefix",
|
2076
|
+
# share_resource_type: "WORKLOAD", # accepts WORKLOAD, LENS
|
1513
2077
|
# next_token: "NextToken",
|
1514
2078
|
# max_results: 1,
|
1515
2079
|
# })
|
@@ -1521,8 +2085,11 @@ module Aws::WellArchitected
|
|
1521
2085
|
# resp.share_invitation_summaries[0].shared_by #=> String
|
1522
2086
|
# resp.share_invitation_summaries[0].shared_with #=> String
|
1523
2087
|
# resp.share_invitation_summaries[0].permission_type #=> String, one of "READONLY", "CONTRIBUTOR"
|
2088
|
+
# resp.share_invitation_summaries[0].share_resource_type #=> String, one of "WORKLOAD", "LENS"
|
1524
2089
|
# resp.share_invitation_summaries[0].workload_name #=> String
|
1525
2090
|
# resp.share_invitation_summaries[0].workload_id #=> String
|
2091
|
+
# resp.share_invitation_summaries[0].lens_name #=> String
|
2092
|
+
# resp.share_invitation_summaries[0].lens_arn #=> String
|
1526
2093
|
# resp.next_token #=> String
|
1527
2094
|
#
|
1528
2095
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListShareInvitations AWS API Documentation
|
@@ -1566,11 +2133,12 @@ module Aws::WellArchitected
|
|
1566
2133
|
# List the workload shares associated with the workload.
|
1567
2134
|
#
|
1568
2135
|
# @option params [required, String] :workload_id
|
1569
|
-
# The ID assigned to the workload. This ID is unique within an
|
1570
|
-
# Region.
|
2136
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
2137
|
+
# Web Services Region.
|
1571
2138
|
#
|
1572
2139
|
# @option params [String] :shared_with_prefix
|
1573
|
-
# The
|
2140
|
+
# The Amazon Web Services account ID or IAM role with which the workload
|
2141
|
+
# is shared.
|
1574
2142
|
#
|
1575
2143
|
# @option params [String] :next_token
|
1576
2144
|
# The token to use to retrieve the next set of results.
|
@@ -1728,8 +2296,8 @@ module Aws::WellArchitected
|
|
1728
2296
|
# Update the answer to a specific question in a workload review.
|
1729
2297
|
#
|
1730
2298
|
# @option params [required, String] :workload_id
|
1731
|
-
# The ID assigned to the workload. This ID is unique within an
|
1732
|
-
# Region.
|
2299
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
2300
|
+
# Web Services Region.
|
1733
2301
|
#
|
1734
2302
|
# @option params [required, String] :lens_alias
|
1735
2303
|
# The alias of the lens, for example, `serverless`.
|
@@ -1761,6 +2329,7 @@ module Aws::WellArchitected
|
|
1761
2329
|
#
|
1762
2330
|
# * {Types::UpdateAnswerOutput#workload_id #workload_id} => String
|
1763
2331
|
# * {Types::UpdateAnswerOutput#lens_alias #lens_alias} => String
|
2332
|
+
# * {Types::UpdateAnswerOutput#lens_arn #lens_arn} => String
|
1764
2333
|
# * {Types::UpdateAnswerOutput#answer #answer} => Types::Answer
|
1765
2334
|
#
|
1766
2335
|
# @example Request syntax with placeholder values
|
@@ -1786,16 +2355,22 @@ module Aws::WellArchitected
|
|
1786
2355
|
#
|
1787
2356
|
# resp.workload_id #=> String
|
1788
2357
|
# resp.lens_alias #=> String
|
2358
|
+
# resp.lens_arn #=> String
|
1789
2359
|
# resp.answer.question_id #=> String
|
1790
2360
|
# resp.answer.pillar_id #=> String
|
1791
2361
|
# resp.answer.question_title #=> String
|
1792
2362
|
# resp.answer.question_description #=> String
|
1793
2363
|
# resp.answer.improvement_plan_url #=> String
|
1794
2364
|
# resp.answer.helpful_resource_url #=> String
|
2365
|
+
# resp.answer.helpful_resource_display_text #=> String
|
1795
2366
|
# resp.answer.choices #=> Array
|
1796
2367
|
# resp.answer.choices[0].choice_id #=> String
|
1797
2368
|
# resp.answer.choices[0].title #=> String
|
1798
2369
|
# resp.answer.choices[0].description #=> String
|
2370
|
+
# resp.answer.choices[0].helpful_resource.display_text #=> String
|
2371
|
+
# resp.answer.choices[0].helpful_resource.url #=> String
|
2372
|
+
# resp.answer.choices[0].improvement_plan.display_text #=> String
|
2373
|
+
# resp.answer.choices[0].improvement_plan.url #=> String
|
1799
2374
|
# resp.answer.selected_choices #=> Array
|
1800
2375
|
# resp.answer.selected_choices[0] #=> String
|
1801
2376
|
# resp.answer.choice_answers #=> Array
|
@@ -1820,8 +2395,8 @@ module Aws::WellArchitected
|
|
1820
2395
|
# Update lens review.
|
1821
2396
|
#
|
1822
2397
|
# @option params [required, String] :workload_id
|
1823
|
-
# The ID assigned to the workload. This ID is unique within an
|
1824
|
-
# Region.
|
2398
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
2399
|
+
# Web Services Region.
|
1825
2400
|
#
|
1826
2401
|
# @option params [required, String] :lens_alias
|
1827
2402
|
# The alias of the lens, for example, `serverless`.
|
@@ -1854,9 +2429,10 @@ module Aws::WellArchitected
|
|
1854
2429
|
#
|
1855
2430
|
# resp.workload_id #=> String
|
1856
2431
|
# resp.lens_review.lens_alias #=> String
|
2432
|
+
# resp.lens_review.lens_arn #=> String
|
1857
2433
|
# resp.lens_review.lens_version #=> String
|
1858
2434
|
# resp.lens_review.lens_name #=> String
|
1859
|
-
# resp.lens_review.lens_status #=> String, one of "CURRENT", "NOT_CURRENT", "DEPRECATED"
|
2435
|
+
# resp.lens_review.lens_status #=> String, one of "CURRENT", "NOT_CURRENT", "DEPRECATED", "DELETED", "UNSHARED"
|
1860
2436
|
# resp.lens_review.pillar_review_summaries #=> Array
|
1861
2437
|
# resp.lens_review.pillar_review_summaries[0].pillar_id #=> String
|
1862
2438
|
# resp.lens_review.pillar_review_summaries[0].pillar_name #=> String
|
@@ -1900,7 +2476,10 @@ module Aws::WellArchitected
|
|
1900
2476
|
# @example Response structure
|
1901
2477
|
#
|
1902
2478
|
# resp.share_invitation.share_invitation_id #=> String
|
2479
|
+
# resp.share_invitation.share_resource_type #=> String, one of "WORKLOAD", "LENS"
|
1903
2480
|
# resp.share_invitation.workload_id #=> String
|
2481
|
+
# resp.share_invitation.lens_alias #=> String
|
2482
|
+
# resp.share_invitation.lens_arn #=> String
|
1904
2483
|
#
|
1905
2484
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/UpdateShareInvitation AWS API Documentation
|
1906
2485
|
#
|
@@ -1914,14 +2493,15 @@ module Aws::WellArchitected
|
|
1914
2493
|
# Update an existing workload.
|
1915
2494
|
#
|
1916
2495
|
# @option params [required, String] :workload_id
|
1917
|
-
# The ID assigned to the workload. This ID is unique within an
|
1918
|
-
# Region.
|
2496
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
2497
|
+
# Web Services Region.
|
1919
2498
|
#
|
1920
2499
|
# @option params [String] :workload_name
|
1921
2500
|
# The name of the workload.
|
1922
2501
|
#
|
1923
|
-
# The name must be unique within an account within
|
1924
|
-
# capitalization are ignored when checking
|
2502
|
+
# The name must be unique within an account within an Amazon Web
|
2503
|
+
# Services Region. Spaces and capitalization are ignored when checking
|
2504
|
+
# for uniqueness.
|
1925
2505
|
#
|
1926
2506
|
# @option params [String] :description
|
1927
2507
|
# The description for the workload.
|
@@ -1930,14 +2510,16 @@ module Aws::WellArchitected
|
|
1930
2510
|
# The environment for the workload.
|
1931
2511
|
#
|
1932
2512
|
# @option params [Array<String>] :account_ids
|
1933
|
-
# The list of
|
2513
|
+
# The list of Amazon Web Services account IDs associated with the
|
2514
|
+
# workload.
|
1934
2515
|
#
|
1935
2516
|
# @option params [Array<String>] :aws_regions
|
1936
|
-
# The list of
|
1937
|
-
# `us-east-2`, or `ca-central-1`.
|
2517
|
+
# The list of Amazon Web Services Regions associated with the workload,
|
2518
|
+
# for example, `us-east-2`, or `ca-central-1`.
|
1938
2519
|
#
|
1939
2520
|
# @option params [Array<String>] :non_aws_regions
|
1940
|
-
# The list of non-
|
2521
|
+
# The list of non-Amazon Web Services Regions associated with the
|
2522
|
+
# workload.
|
1941
2523
|
#
|
1942
2524
|
# @option params [Array<String>] :pillar_priorities
|
1943
2525
|
# The priorities of the pillars, which are used to order items in the
|
@@ -2100,8 +2682,8 @@ module Aws::WellArchitected
|
|
2100
2682
|
# The ID associated with the workload share.
|
2101
2683
|
#
|
2102
2684
|
# @option params [required, String] :workload_id
|
2103
|
-
# The ID assigned to the workload. This ID is unique within an
|
2104
|
-
# Region.
|
2685
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
2686
|
+
# Web Services Region.
|
2105
2687
|
#
|
2106
2688
|
# @option params [required, String] :permission_type
|
2107
2689
|
# Permission granted on a workload share.
|
@@ -2142,8 +2724,8 @@ module Aws::WellArchitected
|
|
2142
2724
|
# Upgrade lens review.
|
2143
2725
|
#
|
2144
2726
|
# @option params [required, String] :workload_id
|
2145
|
-
# The ID assigned to the workload. This ID is unique within an
|
2146
|
-
# Region.
|
2727
|
+
# The ID assigned to the workload. This ID is unique within an Amazon
|
2728
|
+
# Web Services Region.
|
2147
2729
|
#
|
2148
2730
|
# @option params [required, String] :lens_alias
|
2149
2731
|
# The alias of the lens, for example, `serverless`.
|
@@ -2165,9 +2747,9 @@ module Aws::WellArchitected
|
|
2165
2747
|
# request is returned.
|
2166
2748
|
#
|
2167
2749
|
# This token is listed as required, however, if you do not specify it,
|
2168
|
-
# the
|
2169
|
-
# the
|
2170
|
-
# will fail.
|
2750
|
+
# the Amazon Web Services SDKs automatically generate one for you. If
|
2751
|
+
# you are not using the Amazon Web Services SDK or the CLI, you must
|
2752
|
+
# provide this token or the request will fail.
|
2171
2753
|
#
|
2172
2754
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2173
2755
|
#
|
@@ -2202,7 +2784,7 @@ module Aws::WellArchitected
|
|
2202
2784
|
params: params,
|
2203
2785
|
config: config)
|
2204
2786
|
context[:gem_name] = 'aws-sdk-wellarchitected'
|
2205
|
-
context[:gem_version] = '1.
|
2787
|
+
context[:gem_version] = '1.11.0'
|
2206
2788
|
Seahorse::Client::Request.new(handlers, context)
|
2207
2789
|
end
|
2208
2790
|
|