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.
@@ -27,6 +27,8 @@ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
27
27
  require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
28
28
  require 'aws-sdk-core/plugins/transfer_encoding.rb'
29
29
  require 'aws-sdk-core/plugins/http_checksum.rb'
30
+ require 'aws-sdk-core/plugins/defaults_mode.rb'
31
+ require 'aws-sdk-core/plugins/recursion_detection.rb'
30
32
  require 'aws-sdk-core/plugins/signature_v4.rb'
31
33
  require 'aws-sdk-core/plugins/protocols/rest_json.rb'
32
34
 
@@ -73,6 +75,8 @@ module Aws::WellArchitected
73
75
  add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
74
76
  add_plugin(Aws::Plugins::TransferEncoding)
75
77
  add_plugin(Aws::Plugins::HttpChecksum)
78
+ add_plugin(Aws::Plugins::DefaultsMode)
79
+ add_plugin(Aws::Plugins::RecursionDetection)
76
80
  add_plugin(Aws::Plugins::SignatureV4)
77
81
  add_plugin(Aws::Plugins::Protocols::RestJson)
78
82
 
@@ -119,7 +123,9 @@ module Aws::WellArchitected
119
123
  # * EC2/ECS IMDS instance profile - When used by default, the timeouts
120
124
  # are very aggressive. Construct and pass an instance of
121
125
  # `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
122
- # enable retries and extended timeouts.
126
+ # enable retries and extended timeouts. Instance profile credential
127
+ # fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
128
+ # to true.
123
129
  #
124
130
  # @option options [required, String] :region
125
131
  # The AWS region to connect to. The configured `:region` is
@@ -173,6 +179,10 @@ module Aws::WellArchitected
173
179
  # Used only in `standard` and adaptive retry modes. Specifies whether to apply
174
180
  # a clock skew correction and retry requests with skewed client clocks.
175
181
  #
182
+ # @option options [String] :defaults_mode ("legacy")
183
+ # See {Aws::DefaultsModeConfiguration} for a list of the
184
+ # accepted modes and the configuration defaults that are included.
185
+ #
176
186
  # @option options [Boolean] :disable_host_prefix_injection (false)
177
187
  # Set to true to disable SDK automatically adding host prefix
178
188
  # to default service endpoint when available.
@@ -295,7 +305,7 @@ module Aws::WellArchitected
295
305
  # seconds to wait when opening a HTTP session before raising a
296
306
  # `Timeout::Error`.
297
307
  #
298
- # @option options [Integer] :http_read_timeout (60) The default
308
+ # @option options [Float] :http_read_timeout (60) The default
299
309
  # number of seconds to wait for response data. This value can
300
310
  # safely be set per-request on the session.
301
311
  #
@@ -311,6 +321,9 @@ module Aws::WellArchitected
311
321
  # disables this behaviour. This value can safely be set per
312
322
  # request on the session.
313
323
  #
324
+ # @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
325
+ # in seconds.
326
+ #
314
327
  # @option options [Boolean] :http_wire_trace (false) When `true`,
315
328
  # HTTP debug output will be sent to the `:logger`.
316
329
  #
@@ -338,12 +351,25 @@ module Aws::WellArchitected
338
351
 
339
352
  # Associate a lens to a workload.
340
353
  #
354
+ # Up to 10 lenses can be associated with a workload in a single API
355
+ # operation. A maximum of 20 lenses can be associated with a workload.
356
+ #
357
+ # <note markdown="1"> **Disclaimer**
358
+ #
359
+ # By accessing and/or applying custom lenses created by another Amazon
360
+ # Web Services user or account, you acknowledge that custom lenses
361
+ # created by other users and shared with you are Third Party Content as
362
+ # defined in the Amazon Web Services Customer Agreement.
363
+ #
364
+ # </note>
365
+ #
341
366
  # @option params [required, String] :workload_id
342
- # The ID assigned to the workload. This ID is unique within an AWS
343
- # Region.
367
+ # The ID assigned to the workload. This ID is unique within an Amazon
368
+ # Web Services Region.
344
369
  #
345
370
  # @option params [required, Array<String>] :lens_aliases
346
- # List of lens aliases to associate or disassociate with a workload.
371
+ # List of lens aliases to associate or disassociate with a workload. Up
372
+ # to 10 lenses can be specified.
347
373
  #
348
374
  # Identify a lens using its LensSummary$LensAlias.
349
375
  #
@@ -365,11 +391,144 @@ module Aws::WellArchitected
365
391
  req.send_request(options)
366
392
  end
367
393
 
394
+ # Create a lens share.
395
+ #
396
+ # The owner of a lens can share it with other Amazon Web Services
397
+ # accounts and IAM users in the same Amazon Web Services Region. Shared
398
+ # access to a lens is not removed until the lens invitation is deleted.
399
+ #
400
+ # <note markdown="1"> **Disclaimer**
401
+ #
402
+ # By sharing your custom lenses with other Amazon Web Services accounts,
403
+ # you acknowledge that Amazon Web Services will make your custom lenses
404
+ # available to those other accounts. Those other accounts may continue
405
+ # to access and use your shared custom lenses even if you delete the
406
+ # custom lenses from your own Amazon Web Services account or terminate
407
+ # your Amazon Web Services account.
408
+ #
409
+ # </note>
410
+ #
411
+ # @option params [required, String] :lens_alias
412
+ # The alias of the lens, for example, `serverless`.
413
+ #
414
+ # Each lens is identified by its LensSummary$LensAlias.
415
+ #
416
+ # @option params [required, String] :shared_with
417
+ # The Amazon Web Services account ID or IAM role with which the workload
418
+ # is shared.
419
+ #
420
+ # @option params [required, String] :client_request_token
421
+ # A unique case-sensitive string used to ensure that this request is
422
+ # idempotent (executes only once).
423
+ #
424
+ # You should not reuse the same token for other requests. If you retry a
425
+ # request with the same client request token and the same parameters
426
+ # after it has completed successfully, the result of the original
427
+ # request is returned.
428
+ #
429
+ # This token is listed as required, however, if you do not specify it,
430
+ # the Amazon Web Services SDKs automatically generate one for you. If
431
+ # you are not using the Amazon Web Services SDK or the CLI, you must
432
+ # provide this token or the request will fail.
433
+ #
434
+ # **A suitable default value is auto-generated.** You should normally
435
+ # not need to pass this option.**
436
+ #
437
+ # @return [Types::CreateLensShareOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
438
+ #
439
+ # * {Types::CreateLensShareOutput#share_id #share_id} => String
440
+ #
441
+ # @example Request syntax with placeholder values
442
+ #
443
+ # resp = client.create_lens_share({
444
+ # lens_alias: "LensAlias", # required
445
+ # shared_with: "SharedWith", # required
446
+ # client_request_token: "ClientRequestToken", # required
447
+ # })
448
+ #
449
+ # @example Response structure
450
+ #
451
+ # resp.share_id #=> String
452
+ #
453
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/CreateLensShare AWS API Documentation
454
+ #
455
+ # @overload create_lens_share(params = {})
456
+ # @param [Hash] params ({})
457
+ def create_lens_share(params = {}, options = {})
458
+ req = build_request(:create_lens_share, params)
459
+ req.send_request(options)
460
+ end
461
+
462
+ # Create a new lens version.
463
+ #
464
+ # A lens can have up to 100 versions.
465
+ #
466
+ # After a lens has been imported, create a new lens version to publish
467
+ # it. The owner of a lens can share the lens with other Amazon Web
468
+ # Services accounts and IAM users in the same Amazon Web Services
469
+ # Region. Only the owner of a lens can delete it.
470
+ #
471
+ # @option params [required, String] :lens_alias
472
+ # The alias of the lens, for example, `serverless`.
473
+ #
474
+ # Each lens is identified by its LensSummary$LensAlias.
475
+ #
476
+ # @option params [required, String] :lens_version
477
+ # The version of the lens being created.
478
+ #
479
+ # @option params [Boolean] :is_major_version
480
+ # Set to true if this new major lens version.
481
+ #
482
+ # @option params [required, String] :client_request_token
483
+ # A unique case-sensitive string used to ensure that this request is
484
+ # idempotent (executes only once).
485
+ #
486
+ # You should not reuse the same token for other requests. If you retry a
487
+ # request with the same client request token and the same parameters
488
+ # after it has completed successfully, the result of the original
489
+ # request is returned.
490
+ #
491
+ # This token is listed as required, however, if you do not specify it,
492
+ # the Amazon Web Services SDKs automatically generate one for you. If
493
+ # you are not using the Amazon Web Services SDK or the CLI, you must
494
+ # provide this token or the request will fail.
495
+ #
496
+ # **A suitable default value is auto-generated.** You should normally
497
+ # not need to pass this option.**
498
+ #
499
+ # @return [Types::CreateLensVersionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
500
+ #
501
+ # * {Types::CreateLensVersionOutput#lens_arn #lens_arn} => String
502
+ # * {Types::CreateLensVersionOutput#lens_version #lens_version} => String
503
+ #
504
+ # @example Request syntax with placeholder values
505
+ #
506
+ # resp = client.create_lens_version({
507
+ # lens_alias: "LensAlias", # required
508
+ # lens_version: "LensVersion", # required
509
+ # is_major_version: false,
510
+ # client_request_token: "ClientRequestToken", # required
511
+ # })
512
+ #
513
+ # @example Response structure
514
+ #
515
+ # resp.lens_arn #=> String
516
+ # resp.lens_version #=> String
517
+ #
518
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/CreateLensVersion AWS API Documentation
519
+ #
520
+ # @overload create_lens_version(params = {})
521
+ # @param [Hash] params ({})
522
+ def create_lens_version(params = {}, options = {})
523
+ req = build_request(:create_lens_version, params)
524
+ req.send_request(options)
525
+ end
526
+
368
527
  # Create a milestone for an existing workload.
369
528
  #
370
529
  # @option params [required, String] :workload_id
371
- # The ID assigned to the workload. This ID is unique within an AWS
372
- # Region.
530
+ # The ID assigned to the workload. This ID is unique within an Amazon
531
+ # Web Services Region.
373
532
  #
374
533
  # @option params [required, String] :milestone_name
375
534
  # The name of the milestone in a workload.
@@ -386,9 +545,9 @@ module Aws::WellArchitected
386
545
  # request is returned.
387
546
  #
388
547
  # This token is listed as required, however, if you do not specify it,
389
- # the AWS SDKs automatically generate one for you. If you are not using
390
- # the AWS SDK or the AWS CLI, you must provide this token or the request
391
- # will fail.
548
+ # the Amazon Web Services SDKs automatically generate one for you. If
549
+ # you are not using the Amazon Web Services SDK or the CLI, you must
550
+ # provide this token or the request will fail.
392
551
  #
393
552
  # **A suitable default value is auto-generated.** You should normally
394
553
  # not need to pass this option.**
@@ -422,12 +581,12 @@ module Aws::WellArchitected
422
581
 
423
582
  # Create a new workload.
424
583
  #
425
- # The owner of a workload can share the workload with other AWS accounts
426
- # and IAM users in the same AWS Region. Only the owner of a workload can
427
- # delete it.
584
+ # The owner of a workload can share the workload with other Amazon Web
585
+ # Services accounts and IAM users in the same Amazon Web Services
586
+ # Region. Only the owner of a workload can delete it.
428
587
  #
429
- # For more information, see [Defining a Workload][1] in the *AWS
430
- # Well-Architected Tool User Guide*.
588
+ # For more information, see [Defining a Workload][1] in the
589
+ # *Well-Architected Tool User Guide*.
431
590
  #
432
591
  #
433
592
  #
@@ -436,8 +595,9 @@ module Aws::WellArchitected
436
595
  # @option params [required, String] :workload_name
437
596
  # The name of the workload.
438
597
  #
439
- # The name must be unique within an account within a Region. Spaces and
440
- # capitalization are ignored when checking for uniqueness.
598
+ # The name must be unique within an account within an Amazon Web
599
+ # Services Region. Spaces and capitalization are ignored when checking
600
+ # for uniqueness.
441
601
  #
442
602
  # @option params [required, String] :description
443
603
  # The description for the workload.
@@ -446,14 +606,16 @@ module Aws::WellArchitected
446
606
  # The environment for the workload.
447
607
  #
448
608
  # @option params [Array<String>] :account_ids
449
- # The list of AWS account IDs associated with the workload.
609
+ # The list of Amazon Web Services account IDs associated with the
610
+ # workload.
450
611
  #
451
612
  # @option params [Array<String>] :aws_regions
452
- # The list of AWS Regions associated with the workload, for example,
453
- # `us-east-2`, or `ca-central-1`.
613
+ # The list of Amazon Web Services Regions associated with the workload,
614
+ # for example, `us-east-2`, or `ca-central-1`.
454
615
  #
455
616
  # @option params [Array<String>] :non_aws_regions
456
- # The list of non-AWS Regions associated with the workload.
617
+ # The list of non-Amazon Web Services Regions associated with the
618
+ # workload.
457
619
  #
458
620
  # @option params [Array<String>] :pillar_priorities
459
621
  # The priorities of the pillars, which are used to order items in the
@@ -547,9 +709,9 @@ module Aws::WellArchitected
547
709
  # request is returned.
548
710
  #
549
711
  # This token is listed as required, however, if you do not specify it,
550
- # the AWS SDKs automatically generate one for you. If you are not using
551
- # the AWS SDK or the AWS CLI, you must provide this token or the request
552
- # will fail.
712
+ # the Amazon Web Services SDKs automatically generate one for you. If
713
+ # you are not using the Amazon Web Services SDK or the CLI, you must
714
+ # provide this token or the request will fail.
553
715
  #
554
716
  # **A suitable default value is auto-generated.** You should normally
555
717
  # not need to pass this option.**
@@ -600,23 +762,25 @@ module Aws::WellArchitected
600
762
 
601
763
  # Create a workload share.
602
764
  #
603
- # The owner of a workload can share it with other AWS accounts and IAM
604
- # users in the same AWS Region. Shared access to a workload is not
605
- # removed until the workload invitation is deleted.
765
+ # The owner of a workload can share it with other Amazon Web Services
766
+ # accounts and IAM users in the same Amazon Web Services Region. Shared
767
+ # access to a workload is not removed until the workload invitation is
768
+ # deleted.
606
769
  #
607
- # For more information, see [Sharing a Workload][1] in the *AWS
608
- # Well-Architected Tool User Guide*.
770
+ # For more information, see [Sharing a Workload][1] in the
771
+ # *Well-Architected Tool User Guide*.
609
772
  #
610
773
  #
611
774
  #
612
775
  # [1]: https://docs.aws.amazon.com/wellarchitected/latest/userguide/workloads-sharing.html
613
776
  #
614
777
  # @option params [required, String] :workload_id
615
- # The ID assigned to the workload. This ID is unique within an AWS
616
- # Region.
778
+ # The ID assigned to the workload. This ID is unique within an Amazon
779
+ # Web Services Region.
617
780
  #
618
781
  # @option params [required, String] :shared_with
619
- # The AWS account ID or IAM role with which the workload is shared.
782
+ # The Amazon Web Services account ID or IAM role with which the workload
783
+ # is shared.
620
784
  #
621
785
  # @option params [required, String] :permission_type
622
786
  # Permission granted on a workload share.
@@ -631,9 +795,9 @@ module Aws::WellArchitected
631
795
  # request is returned.
632
796
  #
633
797
  # This token is listed as required, however, if you do not specify it,
634
- # the AWS SDKs automatically generate one for you. If you are not using
635
- # the AWS SDK or the AWS CLI, you must provide this token or the request
636
- # will fail.
798
+ # the Amazon Web Services SDKs automatically generate one for you. If
799
+ # you are not using the Amazon Web Services SDK or the CLI, you must
800
+ # provide this token or the request will fail.
637
801
  #
638
802
  # **A suitable default value is auto-generated.** You should normally
639
803
  # not need to pass this option.**
@@ -666,11 +830,134 @@ module Aws::WellArchitected
666
830
  req.send_request(options)
667
831
  end
668
832
 
833
+ # Delete an existing lens.
834
+ #
835
+ # Only the owner of a lens can delete it. After the lens is deleted,
836
+ # Amazon Web Services accounts and IAM users that you shared the lens
837
+ # with can continue to use it, but they will no longer be able to apply
838
+ # it to new workloads.
839
+ #
840
+ # <note markdown="1"> **Disclaimer**
841
+ #
842
+ # By sharing your custom lenses with other Amazon Web Services accounts,
843
+ # you acknowledge that Amazon Web Services will make your custom lenses
844
+ # available to those other accounts. Those other accounts may continue
845
+ # to access and use your shared custom lenses even if you delete the
846
+ # custom lenses from your own Amazon Web Services account or terminate
847
+ # your Amazon Web Services account.
848
+ #
849
+ # </note>
850
+ #
851
+ # @option params [required, String] :lens_alias
852
+ # The alias of the lens, for example, `serverless`.
853
+ #
854
+ # Each lens is identified by its LensSummary$LensAlias.
855
+ #
856
+ # @option params [required, String] :client_request_token
857
+ # A unique case-sensitive string used to ensure that this request is
858
+ # idempotent (executes only once).
859
+ #
860
+ # You should not reuse the same token for other requests. If you retry a
861
+ # request with the same client request token and the same parameters
862
+ # after it has completed successfully, the result of the original
863
+ # request is returned.
864
+ #
865
+ # This token is listed as required, however, if you do not specify it,
866
+ # the Amazon Web Services SDKs automatically generate one for you. If
867
+ # you are not using the Amazon Web Services SDK or the CLI, you must
868
+ # provide this token or the request will fail.
869
+ #
870
+ # **A suitable default value is auto-generated.** You should normally
871
+ # not need to pass this option.**
872
+ #
873
+ # @option params [required, String] :lens_status
874
+ # The status of the lens to be deleted.
875
+ #
876
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
877
+ #
878
+ # @example Request syntax with placeholder values
879
+ #
880
+ # resp = client.delete_lens({
881
+ # lens_alias: "LensAlias", # required
882
+ # client_request_token: "ClientRequestToken", # required
883
+ # lens_status: "ALL", # required, accepts ALL, DRAFT, PUBLISHED
884
+ # })
885
+ #
886
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/DeleteLens AWS API Documentation
887
+ #
888
+ # @overload delete_lens(params = {})
889
+ # @param [Hash] params ({})
890
+ def delete_lens(params = {}, options = {})
891
+ req = build_request(:delete_lens, params)
892
+ req.send_request(options)
893
+ end
894
+
895
+ # Delete a lens share.
896
+ #
897
+ # After the lens share is deleted, Amazon Web Services accounts and IAM
898
+ # users that you shared the lens with can continue to use it, but they
899
+ # will no longer be able to apply it to new workloads.
900
+ #
901
+ # <note markdown="1"> **Disclaimer**
902
+ #
903
+ # By sharing your custom lenses with other Amazon Web Services accounts,
904
+ # you acknowledge that Amazon Web Services will make your custom lenses
905
+ # available to those other accounts. Those other accounts may continue
906
+ # to access and use your shared custom lenses even if you delete the
907
+ # custom lenses from your own Amazon Web Services account or terminate
908
+ # your Amazon Web Services account.
909
+ #
910
+ # </note>
911
+ #
912
+ # @option params [required, String] :share_id
913
+ # The ID associated with the workload share.
914
+ #
915
+ # @option params [required, String] :lens_alias
916
+ # The alias of the lens, for example, `serverless`.
917
+ #
918
+ # Each lens is identified by its LensSummary$LensAlias.
919
+ #
920
+ # @option params [required, String] :client_request_token
921
+ # A unique case-sensitive string used to ensure that this request is
922
+ # idempotent (executes only once).
923
+ #
924
+ # You should not reuse the same token for other requests. If you retry a
925
+ # request with the same client request token and the same parameters
926
+ # after it has completed successfully, the result of the original
927
+ # request is returned.
928
+ #
929
+ # This token is listed as required, however, if you do not specify it,
930
+ # the Amazon Web Services SDKs automatically generate one for you. If
931
+ # you are not using the Amazon Web Services SDK or the CLI, you must
932
+ # provide this token or the request will fail.
933
+ #
934
+ # **A suitable default value is auto-generated.** You should normally
935
+ # not need to pass this option.**
936
+ #
937
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
938
+ #
939
+ # @example Request syntax with placeholder values
940
+ #
941
+ # resp = client.delete_lens_share({
942
+ # share_id: "ShareId", # required
943
+ # lens_alias: "LensAlias", # required
944
+ # client_request_token: "ClientRequestToken", # required
945
+ # })
946
+ #
947
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/DeleteLensShare AWS API Documentation
948
+ #
949
+ # @overload delete_lens_share(params = {})
950
+ # @param [Hash] params ({})
951
+ def delete_lens_share(params = {}, options = {})
952
+ req = build_request(:delete_lens_share, params)
953
+ req.send_request(options)
954
+ end
955
+
669
956
  # Delete an existing workload.
670
957
  #
671
958
  # @option params [required, String] :workload_id
672
- # The ID assigned to the workload. This ID is unique within an AWS
673
- # Region.
959
+ # The ID assigned to the workload. This ID is unique within an Amazon
960
+ # Web Services Region.
674
961
  #
675
962
  # @option params [required, String] :client_request_token
676
963
  # A unique case-sensitive string used to ensure that this request is
@@ -682,9 +969,9 @@ module Aws::WellArchitected
682
969
  # request is returned.
683
970
  #
684
971
  # This token is listed as required, however, if you do not specify it,
685
- # the AWS SDKs automatically generate one for you. If you are not using
686
- # the AWS SDK or the AWS CLI, you must provide this token or the request
687
- # will fail.
972
+ # the Amazon Web Services SDKs automatically generate one for you. If
973
+ # you are not using the Amazon Web Services SDK or the CLI, you must
974
+ # provide this token or the request will fail.
688
975
  #
689
976
  # **A suitable default value is auto-generated.** You should normally
690
977
  # not need to pass this option.**
@@ -713,8 +1000,8 @@ module Aws::WellArchitected
713
1000
  # The ID associated with the workload share.
714
1001
  #
715
1002
  # @option params [required, String] :workload_id
716
- # The ID assigned to the workload. This ID is unique within an AWS
717
- # Region.
1003
+ # The ID assigned to the workload. This ID is unique within an Amazon
1004
+ # Web Services Region.
718
1005
  #
719
1006
  # @option params [required, String] :client_request_token
720
1007
  # A unique case-sensitive string used to ensure that this request is
@@ -726,9 +1013,9 @@ module Aws::WellArchitected
726
1013
  # request is returned.
727
1014
  #
728
1015
  # This token is listed as required, however, if you do not specify it,
729
- # the AWS SDKs automatically generate one for you. If you are not using
730
- # the AWS SDK or the AWS CLI, you must provide this token or the request
731
- # will fail.
1016
+ # the Amazon Web Services SDKs automatically generate one for you. If
1017
+ # you are not using the Amazon Web Services SDK or the CLI, you must
1018
+ # provide this token or the request will fail.
732
1019
  #
733
1020
  # **A suitable default value is auto-generated.** You should normally
734
1021
  # not need to pass this option.**
@@ -754,17 +1041,21 @@ module Aws::WellArchitected
754
1041
 
755
1042
  # Disassociate a lens from a workload.
756
1043
  #
757
- # <note markdown="1"> The AWS Well-Architected Framework lens (`wellarchitected`) cannot be
758
- # removed from a workload.
1044
+ # Up to 10 lenses can be disassociated from a workload in a single API
1045
+ # operation.
1046
+ #
1047
+ # <note markdown="1"> The Amazon Web Services Well-Architected Framework lens
1048
+ # (`wellarchitected`) cannot be removed from a workload.
759
1049
  #
760
1050
  # </note>
761
1051
  #
762
1052
  # @option params [required, String] :workload_id
763
- # The ID assigned to the workload. This ID is unique within an AWS
764
- # Region.
1053
+ # The ID assigned to the workload. This ID is unique within an Amazon
1054
+ # Web Services Region.
765
1055
  #
766
1056
  # @option params [required, Array<String>] :lens_aliases
767
- # List of lens aliases to associate or disassociate with a workload.
1057
+ # List of lens aliases to associate or disassociate with a workload. Up
1058
+ # to 10 lenses can be specified.
768
1059
  #
769
1060
  # Identify a lens using its LensSummary$LensAlias.
770
1061
  #
@@ -786,11 +1077,65 @@ module Aws::WellArchitected
786
1077
  req.send_request(options)
787
1078
  end
788
1079
 
1080
+ # Export an existing lens.
1081
+ #
1082
+ # Lenses are defined in JSON. For more information, see [JSON format
1083
+ # specification][1] in the *Well-Architected Tool User Guide*. Only the
1084
+ # owner of a lens can export it.
1085
+ #
1086
+ # <note markdown="1"> **Disclaimer**
1087
+ #
1088
+ # Do not include or gather personal identifiable information (PII) of
1089
+ # end users or other identifiable individuals in or via your custom
1090
+ # lenses. If your custom lens or those shared with you and used in your
1091
+ # account do include or collect PII you are responsible for: ensuring
1092
+ # that the included PII is processed in accordance with applicable law,
1093
+ # providing adequate privacy notices, and obtaining necessary consents
1094
+ # for processing such data.
1095
+ #
1096
+ # </note>
1097
+ #
1098
+ #
1099
+ #
1100
+ # [1]: https://docs.aws.amazon.com/wellarchitected/latest/userguide/lenses-format-specification.html
1101
+ #
1102
+ # @option params [required, String] :lens_alias
1103
+ # The alias of the lens, for example, `serverless`.
1104
+ #
1105
+ # Each lens is identified by its LensSummary$LensAlias.
1106
+ #
1107
+ # @option params [String] :lens_version
1108
+ # The lens version to be exported.
1109
+ #
1110
+ # @return [Types::ExportLensOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1111
+ #
1112
+ # * {Types::ExportLensOutput#lens_json #lens_json} => String
1113
+ #
1114
+ # @example Request syntax with placeholder values
1115
+ #
1116
+ # resp = client.export_lens({
1117
+ # lens_alias: "LensAlias", # required
1118
+ # lens_version: "LensVersion",
1119
+ # })
1120
+ #
1121
+ # @example Response structure
1122
+ #
1123
+ # resp.lens_json #=> String
1124
+ #
1125
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ExportLens AWS API Documentation
1126
+ #
1127
+ # @overload export_lens(params = {})
1128
+ # @param [Hash] params ({})
1129
+ def export_lens(params = {}, options = {})
1130
+ req = build_request(:export_lens, params)
1131
+ req.send_request(options)
1132
+ end
1133
+
789
1134
  # Get the answer to a specific question in a workload review.
790
1135
  #
791
1136
  # @option params [required, String] :workload_id
792
- # The ID assigned to the workload. This ID is unique within an AWS
793
- # Region.
1137
+ # The ID assigned to the workload. This ID is unique within an Amazon
1138
+ # Web Services Region.
794
1139
  #
795
1140
  # @option params [required, String] :lens_alias
796
1141
  # The alias of the lens, for example, `serverless`.
@@ -810,6 +1155,7 @@ module Aws::WellArchitected
810
1155
  # * {Types::GetAnswerOutput#workload_id #workload_id} => String
811
1156
  # * {Types::GetAnswerOutput#milestone_number #milestone_number} => Integer
812
1157
  # * {Types::GetAnswerOutput#lens_alias #lens_alias} => String
1158
+ # * {Types::GetAnswerOutput#lens_arn #lens_arn} => String
813
1159
  # * {Types::GetAnswerOutput#answer #answer} => Types::Answer
814
1160
  #
815
1161
  # @example Request syntax with placeholder values
@@ -826,16 +1172,22 @@ module Aws::WellArchitected
826
1172
  # resp.workload_id #=> String
827
1173
  # resp.milestone_number #=> Integer
828
1174
  # resp.lens_alias #=> String
1175
+ # resp.lens_arn #=> String
829
1176
  # resp.answer.question_id #=> String
830
1177
  # resp.answer.pillar_id #=> String
831
1178
  # resp.answer.question_title #=> String
832
1179
  # resp.answer.question_description #=> String
833
1180
  # resp.answer.improvement_plan_url #=> String
834
1181
  # resp.answer.helpful_resource_url #=> String
1182
+ # resp.answer.helpful_resource_display_text #=> String
835
1183
  # resp.answer.choices #=> Array
836
1184
  # resp.answer.choices[0].choice_id #=> String
837
1185
  # resp.answer.choices[0].title #=> String
838
1186
  # resp.answer.choices[0].description #=> String
1187
+ # resp.answer.choices[0].helpful_resource.display_text #=> String
1188
+ # resp.answer.choices[0].helpful_resource.url #=> String
1189
+ # resp.answer.choices[0].improvement_plan.display_text #=> String
1190
+ # resp.answer.choices[0].improvement_plan.url #=> String
839
1191
  # resp.answer.selected_choices #=> Array
840
1192
  # resp.answer.selected_choices[0] #=> String
841
1193
  # resp.answer.choice_answers #=> Array
@@ -857,11 +1209,50 @@ module Aws::WellArchitected
857
1209
  req.send_request(options)
858
1210
  end
859
1211
 
1212
+ # Get an existing lens.
1213
+ #
1214
+ # @option params [required, String] :lens_alias
1215
+ # The alias of the lens, for example, `serverless`.
1216
+ #
1217
+ # Each lens is identified by its LensSummary$LensAlias.
1218
+ #
1219
+ # @option params [String] :lens_version
1220
+ # The lens version to be retrieved.
1221
+ #
1222
+ # @return [Types::GetLensOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1223
+ #
1224
+ # * {Types::GetLensOutput#lens #lens} => Types::Lens
1225
+ #
1226
+ # @example Request syntax with placeholder values
1227
+ #
1228
+ # resp = client.get_lens({
1229
+ # lens_alias: "LensAlias", # required
1230
+ # lens_version: "LensVersion",
1231
+ # })
1232
+ #
1233
+ # @example Response structure
1234
+ #
1235
+ # resp.lens.lens_arn #=> String
1236
+ # resp.lens.lens_version #=> String
1237
+ # resp.lens.name #=> String
1238
+ # resp.lens.description #=> String
1239
+ # resp.lens.owner #=> String
1240
+ # resp.lens.share_invitation_id #=> String
1241
+ #
1242
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetLens AWS API Documentation
1243
+ #
1244
+ # @overload get_lens(params = {})
1245
+ # @param [Hash] params ({})
1246
+ def get_lens(params = {}, options = {})
1247
+ req = build_request(:get_lens, params)
1248
+ req.send_request(options)
1249
+ end
1250
+
860
1251
  # Get lens review.
861
1252
  #
862
1253
  # @option params [required, String] :workload_id
863
- # The ID assigned to the workload. This ID is unique within an AWS
864
- # Region.
1254
+ # The ID assigned to the workload. This ID is unique within an Amazon
1255
+ # Web Services Region.
865
1256
  #
866
1257
  # @option params [required, String] :lens_alias
867
1258
  # The alias of the lens, for example, `serverless`.
@@ -892,9 +1283,10 @@ module Aws::WellArchitected
892
1283
  # resp.workload_id #=> String
893
1284
  # resp.milestone_number #=> Integer
894
1285
  # resp.lens_review.lens_alias #=> String
1286
+ # resp.lens_review.lens_arn #=> String
895
1287
  # resp.lens_review.lens_version #=> String
896
1288
  # resp.lens_review.lens_name #=> String
897
- # resp.lens_review.lens_status #=> String, one of "CURRENT", "NOT_CURRENT", "DEPRECATED"
1289
+ # resp.lens_review.lens_status #=> String, one of "CURRENT", "NOT_CURRENT", "DEPRECATED", "DELETED", "UNSHARED"
898
1290
  # resp.lens_review.pillar_review_summaries #=> Array
899
1291
  # resp.lens_review.pillar_review_summaries[0].pillar_id #=> String
900
1292
  # resp.lens_review.pillar_review_summaries[0].pillar_name #=> String
@@ -919,8 +1311,8 @@ module Aws::WellArchitected
919
1311
  # Get lens review report.
920
1312
  #
921
1313
  # @option params [required, String] :workload_id
922
- # The ID assigned to the workload. This ID is unique within an AWS
923
- # Region.
1314
+ # The ID assigned to the workload. This ID is unique within an Amazon
1315
+ # Web Services Region.
924
1316
  #
925
1317
  # @option params [required, String] :lens_alias
926
1318
  # The alias of the lens, for example, `serverless`.
@@ -951,6 +1343,7 @@ module Aws::WellArchitected
951
1343
  # resp.workload_id #=> String
952
1344
  # resp.milestone_number #=> Integer
953
1345
  # resp.lens_review_report.lens_alias #=> String
1346
+ # resp.lens_review_report.lens_arn #=> String
954
1347
  # resp.lens_review_report.base_64_string #=> String
955
1348
  #
956
1349
  # @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetLensReviewReport AWS API Documentation
@@ -969,13 +1362,18 @@ module Aws::WellArchitected
969
1362
  #
970
1363
  # Each lens is identified by its LensSummary$LensAlias.
971
1364
  #
972
- # @option params [required, String] :base_lens_version
1365
+ # @option params [String] :base_lens_version
973
1366
  # The base version of the lens.
974
1367
  #
1368
+ # @option params [String] :target_lens_version
1369
+ # The lens version to target a difference for.
1370
+ #
975
1371
  # @return [Types::GetLensVersionDifferenceOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
976
1372
  #
977
1373
  # * {Types::GetLensVersionDifferenceOutput#lens_alias #lens_alias} => String
1374
+ # * {Types::GetLensVersionDifferenceOutput#lens_arn #lens_arn} => String
978
1375
  # * {Types::GetLensVersionDifferenceOutput#base_lens_version #base_lens_version} => String
1376
+ # * {Types::GetLensVersionDifferenceOutput#target_lens_version #target_lens_version} => String
979
1377
  # * {Types::GetLensVersionDifferenceOutput#latest_lens_version #latest_lens_version} => String
980
1378
  # * {Types::GetLensVersionDifferenceOutput#version_differences #version_differences} => Types::VersionDifferences
981
1379
  #
@@ -983,16 +1381,20 @@ module Aws::WellArchitected
983
1381
  #
984
1382
  # resp = client.get_lens_version_difference({
985
1383
  # lens_alias: "LensAlias", # required
986
- # base_lens_version: "LensVersion", # required
1384
+ # base_lens_version: "LensVersion",
1385
+ # target_lens_version: "LensVersion",
987
1386
  # })
988
1387
  #
989
1388
  # @example Response structure
990
1389
  #
991
1390
  # resp.lens_alias #=> String
1391
+ # resp.lens_arn #=> String
992
1392
  # resp.base_lens_version #=> String
1393
+ # resp.target_lens_version #=> String
993
1394
  # resp.latest_lens_version #=> String
994
1395
  # resp.version_differences.pillar_differences #=> Array
995
1396
  # resp.version_differences.pillar_differences[0].pillar_id #=> String
1397
+ # resp.version_differences.pillar_differences[0].pillar_name #=> String
996
1398
  # resp.version_differences.pillar_differences[0].difference_status #=> String, one of "UPDATED", "NEW", "DELETED"
997
1399
  # resp.version_differences.pillar_differences[0].question_differences #=> Array
998
1400
  # resp.version_differences.pillar_differences[0].question_differences[0].question_id #=> String
@@ -1011,8 +1413,8 @@ module Aws::WellArchitected
1011
1413
  # Get a milestone for an existing workload.
1012
1414
  #
1013
1415
  # @option params [required, String] :workload_id
1014
- # The ID assigned to the workload. This ID is unique within an AWS
1015
- # Region.
1416
+ # The ID assigned to the workload. This ID is unique within an Amazon
1417
+ # Web Services Region.
1016
1418
  #
1017
1419
  # @option params [required, Integer] :milestone_number
1018
1420
  # The milestone number.
@@ -1080,8 +1482,8 @@ module Aws::WellArchitected
1080
1482
  # Get an existing workload.
1081
1483
  #
1082
1484
  # @option params [required, String] :workload_id
1083
- # The ID assigned to the workload. This ID is unique within an AWS
1084
- # Region.
1485
+ # The ID assigned to the workload. This ID is unique within an Amazon
1486
+ # Web Services Region.
1085
1487
  #
1086
1488
  # @return [Types::GetWorkloadOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1087
1489
  #
@@ -1135,11 +1537,95 @@ module Aws::WellArchitected
1135
1537
  req.send_request(options)
1136
1538
  end
1137
1539
 
1540
+ # Import a new lens.
1541
+ #
1542
+ # The lens cannot be applied to workloads or shared with other Amazon
1543
+ # Web Services accounts until it's published with CreateLensVersion
1544
+ #
1545
+ # Lenses are defined in JSON. For more information, see [JSON format
1546
+ # specification][1] in the *Well-Architected Tool User Guide*.
1547
+ #
1548
+ # A custom lens cannot exceed 500 KB in size.
1549
+ #
1550
+ # <note markdown="1"> **Disclaimer**
1551
+ #
1552
+ # Do not include or gather personal identifiable information (PII) of
1553
+ # end users or other identifiable individuals in or via your custom
1554
+ # lenses. If your custom lens or those shared with you and used in your
1555
+ # account do include or collect PII you are responsible for: ensuring
1556
+ # that the included PII is processed in accordance with applicable law,
1557
+ # providing adequate privacy notices, and obtaining necessary consents
1558
+ # for processing such data.
1559
+ #
1560
+ # </note>
1561
+ #
1562
+ #
1563
+ #
1564
+ # [1]: https://docs.aws.amazon.com/wellarchitected/latest/userguide/lenses-format-specification.html
1565
+ #
1566
+ # @option params [String] :lens_alias
1567
+ # The alias of the lens, for example, `serverless`.
1568
+ #
1569
+ # Each lens is identified by its LensSummary$LensAlias.
1570
+ #
1571
+ # @option params [required, String] :json_string
1572
+ # The JSON representation of a lens.
1573
+ #
1574
+ # @option params [required, String] :client_request_token
1575
+ # A unique case-sensitive string used to ensure that this request is
1576
+ # idempotent (executes only once).
1577
+ #
1578
+ # You should not reuse the same token for other requests. If you retry a
1579
+ # request with the same client request token and the same parameters
1580
+ # after it has completed successfully, the result of the original
1581
+ # request is returned.
1582
+ #
1583
+ # This token is listed as required, however, if you do not specify it,
1584
+ # the Amazon Web Services SDKs automatically generate one for you. If
1585
+ # you are not using the Amazon Web Services SDK or the CLI, you must
1586
+ # provide this token or the request will fail.
1587
+ #
1588
+ # **A suitable default value is auto-generated.** You should normally
1589
+ # not need to pass this option.**
1590
+ #
1591
+ # @option params [Hash<String,String>] :tags
1592
+ # Tags to associate to a lens.
1593
+ #
1594
+ # @return [Types::ImportLensOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1595
+ #
1596
+ # * {Types::ImportLensOutput#lens_arn #lens_arn} => String
1597
+ # * {Types::ImportLensOutput#status #status} => String
1598
+ #
1599
+ # @example Request syntax with placeholder values
1600
+ #
1601
+ # resp = client.import_lens({
1602
+ # lens_alias: "LensAlias",
1603
+ # json_string: "LensJSON", # required
1604
+ # client_request_token: "ClientRequestToken", # required
1605
+ # tags: {
1606
+ # "TagKey" => "TagValue",
1607
+ # },
1608
+ # })
1609
+ #
1610
+ # @example Response structure
1611
+ #
1612
+ # resp.lens_arn #=> String
1613
+ # resp.status #=> String, one of "IN_PROGRESS", "COMPLETE", "ERROR"
1614
+ #
1615
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ImportLens AWS API Documentation
1616
+ #
1617
+ # @overload import_lens(params = {})
1618
+ # @param [Hash] params ({})
1619
+ def import_lens(params = {}, options = {})
1620
+ req = build_request(:import_lens, params)
1621
+ req.send_request(options)
1622
+ end
1623
+
1138
1624
  # List of answers.
1139
1625
  #
1140
1626
  # @option params [required, String] :workload_id
1141
- # The ID assigned to the workload. This ID is unique within an AWS
1142
- # Region.
1627
+ # The ID assigned to the workload. This ID is unique within an Amazon
1628
+ # Web Services Region.
1143
1629
  #
1144
1630
  # @option params [required, String] :lens_alias
1145
1631
  # The alias of the lens, for example, `serverless`.
@@ -1167,6 +1653,7 @@ module Aws::WellArchitected
1167
1653
  # * {Types::ListAnswersOutput#workload_id #workload_id} => String
1168
1654
  # * {Types::ListAnswersOutput#milestone_number #milestone_number} => Integer
1169
1655
  # * {Types::ListAnswersOutput#lens_alias #lens_alias} => String
1656
+ # * {Types::ListAnswersOutput#lens_arn #lens_arn} => String
1170
1657
  # * {Types::ListAnswersOutput#answer_summaries #answer_summaries} => Array&lt;Types::AnswerSummary&gt;
1171
1658
  # * {Types::ListAnswersOutput#next_token #next_token} => String
1172
1659
  #
@@ -1188,6 +1675,7 @@ module Aws::WellArchitected
1188
1675
  # resp.workload_id #=> String
1189
1676
  # resp.milestone_number #=> Integer
1190
1677
  # resp.lens_alias #=> String
1678
+ # resp.lens_arn #=> String
1191
1679
  # resp.answer_summaries #=> Array
1192
1680
  # resp.answer_summaries[0].question_id #=> String
1193
1681
  # resp.answer_summaries[0].pillar_id #=> String
@@ -1196,6 +1684,10 @@ module Aws::WellArchitected
1196
1684
  # resp.answer_summaries[0].choices[0].choice_id #=> String
1197
1685
  # resp.answer_summaries[0].choices[0].title #=> String
1198
1686
  # resp.answer_summaries[0].choices[0].description #=> String
1687
+ # resp.answer_summaries[0].choices[0].helpful_resource.display_text #=> String
1688
+ # resp.answer_summaries[0].choices[0].helpful_resource.url #=> String
1689
+ # resp.answer_summaries[0].choices[0].improvement_plan.display_text #=> String
1690
+ # resp.answer_summaries[0].choices[0].improvement_plan.url #=> String
1199
1691
  # resp.answer_summaries[0].selected_choices #=> Array
1200
1692
  # resp.answer_summaries[0].selected_choices[0] #=> String
1201
1693
  # resp.answer_summaries[0].choice_answer_summaries #=> Array
@@ -1219,8 +1711,8 @@ module Aws::WellArchitected
1219
1711
  # List lens review improvements.
1220
1712
  #
1221
1713
  # @option params [required, String] :workload_id
1222
- # The ID assigned to the workload. This ID is unique within an AWS
1223
- # Region.
1714
+ # The ID assigned to the workload. This ID is unique within an Amazon
1715
+ # Web Services Region.
1224
1716
  #
1225
1717
  # @option params [required, String] :lens_alias
1226
1718
  # The alias of the lens, for example, `serverless`.
@@ -1248,6 +1740,7 @@ module Aws::WellArchitected
1248
1740
  # * {Types::ListLensReviewImprovementsOutput#workload_id #workload_id} => String
1249
1741
  # * {Types::ListLensReviewImprovementsOutput#milestone_number #milestone_number} => Integer
1250
1742
  # * {Types::ListLensReviewImprovementsOutput#lens_alias #lens_alias} => String
1743
+ # * {Types::ListLensReviewImprovementsOutput#lens_arn #lens_arn} => String
1251
1744
  # * {Types::ListLensReviewImprovementsOutput#improvement_summaries #improvement_summaries} => Array&lt;Types::ImprovementSummary&gt;
1252
1745
  # * {Types::ListLensReviewImprovementsOutput#next_token #next_token} => String
1253
1746
  #
@@ -1269,12 +1762,17 @@ module Aws::WellArchitected
1269
1762
  # resp.workload_id #=> String
1270
1763
  # resp.milestone_number #=> Integer
1271
1764
  # resp.lens_alias #=> String
1765
+ # resp.lens_arn #=> String
1272
1766
  # resp.improvement_summaries #=> Array
1273
1767
  # resp.improvement_summaries[0].question_id #=> String
1274
1768
  # resp.improvement_summaries[0].pillar_id #=> String
1275
1769
  # resp.improvement_summaries[0].question_title #=> String
1276
1770
  # resp.improvement_summaries[0].risk #=> String, one of "UNANSWERED", "HIGH", "MEDIUM", "NONE", "NOT_APPLICABLE"
1277
1771
  # resp.improvement_summaries[0].improvement_plan_url #=> String
1772
+ # resp.improvement_summaries[0].improvement_plans #=> Array
1773
+ # resp.improvement_summaries[0].improvement_plans[0].choice_id #=> String
1774
+ # resp.improvement_summaries[0].improvement_plans[0].display_text #=> String
1775
+ # resp.improvement_summaries[0].improvement_plans[0].improvement_plan_url #=> String
1278
1776
  # resp.next_token #=> String
1279
1777
  #
1280
1778
  # @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListLensReviewImprovements AWS API Documentation
@@ -1289,8 +1787,8 @@ module Aws::WellArchitected
1289
1787
  # List lens reviews.
1290
1788
  #
1291
1789
  # @option params [required, String] :workload_id
1292
- # The ID assigned to the workload. This ID is unique within an AWS
1293
- # Region.
1790
+ # The ID assigned to the workload. This ID is unique within an Amazon
1791
+ # Web Services Region.
1294
1792
  #
1295
1793
  # @option params [Integer] :milestone_number
1296
1794
  # The milestone number.
@@ -1327,9 +1825,10 @@ module Aws::WellArchitected
1327
1825
  # resp.milestone_number #=> Integer
1328
1826
  # resp.lens_review_summaries #=> Array
1329
1827
  # resp.lens_review_summaries[0].lens_alias #=> String
1828
+ # resp.lens_review_summaries[0].lens_arn #=> String
1330
1829
  # resp.lens_review_summaries[0].lens_version #=> String
1331
1830
  # resp.lens_review_summaries[0].lens_name #=> String
1332
- # resp.lens_review_summaries[0].lens_status #=> String, one of "CURRENT", "NOT_CURRENT", "DEPRECATED"
1831
+ # resp.lens_review_summaries[0].lens_status #=> String, one of "CURRENT", "NOT_CURRENT", "DEPRECATED", "DELETED", "UNSHARED"
1333
1832
  # resp.lens_review_summaries[0].updated_at #=> Time
1334
1833
  # resp.lens_review_summaries[0].risk_counts #=> Hash
1335
1834
  # resp.lens_review_summaries[0].risk_counts["Risk"] #=> Integer
@@ -1344,6 +1843,56 @@ module Aws::WellArchitected
1344
1843
  req.send_request(options)
1345
1844
  end
1346
1845
 
1846
+ # List the lens shares associated with the lens.
1847
+ #
1848
+ # @option params [required, String] :lens_alias
1849
+ # The alias of the lens, for example, `serverless`.
1850
+ #
1851
+ # Each lens is identified by its LensSummary$LensAlias.
1852
+ #
1853
+ # @option params [String] :shared_with_prefix
1854
+ # The Amazon Web Services account ID or IAM role with which the lens is
1855
+ # shared.
1856
+ #
1857
+ # @option params [String] :next_token
1858
+ # The token to use to retrieve the next set of results.
1859
+ #
1860
+ # @option params [Integer] :max_results
1861
+ # The maximum number of results to return for this request.
1862
+ #
1863
+ # @return [Types::ListLensSharesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1864
+ #
1865
+ # * {Types::ListLensSharesOutput#lens_share_summaries #lens_share_summaries} => Array&lt;Types::LensShareSummary&gt;
1866
+ # * {Types::ListLensSharesOutput#next_token #next_token} => String
1867
+ #
1868
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1869
+ #
1870
+ # @example Request syntax with placeholder values
1871
+ #
1872
+ # resp = client.list_lens_shares({
1873
+ # lens_alias: "LensAlias", # required
1874
+ # shared_with_prefix: "SharedWithPrefix",
1875
+ # next_token: "NextToken",
1876
+ # max_results: 1,
1877
+ # })
1878
+ #
1879
+ # @example Response structure
1880
+ #
1881
+ # resp.lens_share_summaries #=> Array
1882
+ # resp.lens_share_summaries[0].share_id #=> String
1883
+ # resp.lens_share_summaries[0].shared_with #=> String
1884
+ # resp.lens_share_summaries[0].status #=> String, one of "ACCEPTED", "REJECTED", "PENDING", "REVOKED", "EXPIRED"
1885
+ # resp.next_token #=> String
1886
+ #
1887
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListLensShares AWS API Documentation
1888
+ #
1889
+ # @overload list_lens_shares(params = {})
1890
+ # @param [Hash] params ({})
1891
+ def list_lens_shares(params = {}, options = {})
1892
+ req = build_request(:list_lens_shares, params)
1893
+ req.send_request(options)
1894
+ end
1895
+
1347
1896
  # List the available lenses.
1348
1897
  #
1349
1898
  # @option params [String] :next_token
@@ -1352,6 +1901,15 @@ module Aws::WellArchitected
1352
1901
  # @option params [Integer] :max_results
1353
1902
  # The maximum number of results to return for this request.
1354
1903
  #
1904
+ # @option params [String] :lens_type
1905
+ # The type of lenses to be returned.
1906
+ #
1907
+ # @option params [String] :lens_status
1908
+ # The status of lenses to be returned.
1909
+ #
1910
+ # @option params [String] :lens_name
1911
+ # The full name of the lens.
1912
+ #
1355
1913
  # @return [Types::ListLensesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1356
1914
  #
1357
1915
  # * {Types::ListLensesOutput#lens_summaries #lens_summaries} => Array&lt;Types::LensSummary&gt;
@@ -1364,15 +1922,24 @@ module Aws::WellArchitected
1364
1922
  # resp = client.list_lenses({
1365
1923
  # next_token: "NextToken",
1366
1924
  # max_results: 1,
1925
+ # lens_type: "AWS_OFFICIAL", # accepts AWS_OFFICIAL, CUSTOM_SHARED, CUSTOM_SELF
1926
+ # lens_status: "ALL", # accepts ALL, DRAFT, PUBLISHED
1927
+ # lens_name: "LensName",
1367
1928
  # })
1368
1929
  #
1369
1930
  # @example Response structure
1370
1931
  #
1371
1932
  # resp.lens_summaries #=> Array
1933
+ # resp.lens_summaries[0].lens_arn #=> String
1372
1934
  # resp.lens_summaries[0].lens_alias #=> String
1373
- # resp.lens_summaries[0].lens_version #=> String
1374
1935
  # resp.lens_summaries[0].lens_name #=> String
1936
+ # resp.lens_summaries[0].lens_type #=> String, one of "AWS_OFFICIAL", "CUSTOM_SHARED", "CUSTOM_SELF"
1375
1937
  # resp.lens_summaries[0].description #=> String
1938
+ # resp.lens_summaries[0].created_at #=> Time
1939
+ # resp.lens_summaries[0].updated_at #=> Time
1940
+ # resp.lens_summaries[0].lens_version #=> String
1941
+ # resp.lens_summaries[0].owner #=> String
1942
+ # resp.lens_summaries[0].lens_status #=> String, one of "CURRENT", "NOT_CURRENT", "DEPRECATED", "DELETED", "UNSHARED"
1376
1943
  # resp.next_token #=> String
1377
1944
  #
1378
1945
  # @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListLenses AWS API Documentation
@@ -1387,8 +1954,8 @@ module Aws::WellArchitected
1387
1954
  # List all milestones for an existing workload.
1388
1955
  #
1389
1956
  # @option params [required, String] :workload_id
1390
- # The ID assigned to the workload. This ID is unique within an AWS
1391
- # Region.
1957
+ # The ID assigned to the workload. This ID is unique within an Amazon
1958
+ # Web Services Region.
1392
1959
  #
1393
1960
  # @option params [String] :next_token
1394
1961
  # The token to use to retrieve the next set of results.
@@ -1443,8 +2010,8 @@ module Aws::WellArchitected
1443
2010
  # List lens notifications.
1444
2011
  #
1445
2012
  # @option params [String] :workload_id
1446
- # The ID assigned to the workload. This ID is unique within an AWS
1447
- # Region.
2013
+ # The ID assigned to the workload. This ID is unique within an Amazon
2014
+ # Web Services Region.
1448
2015
  #
1449
2016
  # @option params [String] :next_token
1450
2017
  # The token to use to retrieve the next set of results.
@@ -1474,6 +2041,7 @@ module Aws::WellArchitected
1474
2041
  # resp.notification_summaries[0].lens_upgrade_summary.workload_id #=> String
1475
2042
  # resp.notification_summaries[0].lens_upgrade_summary.workload_name #=> String
1476
2043
  # resp.notification_summaries[0].lens_upgrade_summary.lens_alias #=> String
2044
+ # resp.notification_summaries[0].lens_upgrade_summary.lens_arn #=> String
1477
2045
  # resp.notification_summaries[0].lens_upgrade_summary.current_lens_version #=> String
1478
2046
  # resp.notification_summaries[0].lens_upgrade_summary.latest_lens_version #=> String
1479
2047
  # resp.next_token #=> String
@@ -1493,6 +2061,13 @@ module Aws::WellArchitected
1493
2061
  # An optional string added to the beginning of each workload name
1494
2062
  # returned in the results.
1495
2063
  #
2064
+ # @option params [String] :lens_name_prefix
2065
+ # An optional string added to the beginning of each lens name returned
2066
+ # in the results.
2067
+ #
2068
+ # @option params [String] :share_resource_type
2069
+ # The type of share invitations to be returned.
2070
+ #
1496
2071
  # @option params [String] :next_token
1497
2072
  # The token to use to retrieve the next set of results.
1498
2073
  #
@@ -1510,6 +2085,8 @@ module Aws::WellArchitected
1510
2085
  #
1511
2086
  # resp = client.list_share_invitations({
1512
2087
  # workload_name_prefix: "WorkloadNamePrefix",
2088
+ # lens_name_prefix: "LensNamePrefix",
2089
+ # share_resource_type: "WORKLOAD", # accepts WORKLOAD, LENS
1513
2090
  # next_token: "NextToken",
1514
2091
  # max_results: 1,
1515
2092
  # })
@@ -1521,8 +2098,11 @@ module Aws::WellArchitected
1521
2098
  # resp.share_invitation_summaries[0].shared_by #=> String
1522
2099
  # resp.share_invitation_summaries[0].shared_with #=> String
1523
2100
  # resp.share_invitation_summaries[0].permission_type #=> String, one of "READONLY", "CONTRIBUTOR"
2101
+ # resp.share_invitation_summaries[0].share_resource_type #=> String, one of "WORKLOAD", "LENS"
1524
2102
  # resp.share_invitation_summaries[0].workload_name #=> String
1525
2103
  # resp.share_invitation_summaries[0].workload_id #=> String
2104
+ # resp.share_invitation_summaries[0].lens_name #=> String
2105
+ # resp.share_invitation_summaries[0].lens_arn #=> String
1526
2106
  # resp.next_token #=> String
1527
2107
  #
1528
2108
  # @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListShareInvitations AWS API Documentation
@@ -1566,11 +2146,12 @@ module Aws::WellArchitected
1566
2146
  # List the workload shares associated with the workload.
1567
2147
  #
1568
2148
  # @option params [required, String] :workload_id
1569
- # The ID assigned to the workload. This ID is unique within an AWS
1570
- # Region.
2149
+ # The ID assigned to the workload. This ID is unique within an Amazon
2150
+ # Web Services Region.
1571
2151
  #
1572
2152
  # @option params [String] :shared_with_prefix
1573
- # The AWS account ID or IAM role with which the workload is shared.
2153
+ # The Amazon Web Services account ID or IAM role with which the workload
2154
+ # is shared.
1574
2155
  #
1575
2156
  # @option params [String] :next_token
1576
2157
  # The token to use to retrieve the next set of results.
@@ -1728,8 +2309,8 @@ module Aws::WellArchitected
1728
2309
  # Update the answer to a specific question in a workload review.
1729
2310
  #
1730
2311
  # @option params [required, String] :workload_id
1731
- # The ID assigned to the workload. This ID is unique within an AWS
1732
- # Region.
2312
+ # The ID assigned to the workload. This ID is unique within an Amazon
2313
+ # Web Services Region.
1733
2314
  #
1734
2315
  # @option params [required, String] :lens_alias
1735
2316
  # The alias of the lens, for example, `serverless`.
@@ -1761,6 +2342,7 @@ module Aws::WellArchitected
1761
2342
  #
1762
2343
  # * {Types::UpdateAnswerOutput#workload_id #workload_id} => String
1763
2344
  # * {Types::UpdateAnswerOutput#lens_alias #lens_alias} => String
2345
+ # * {Types::UpdateAnswerOutput#lens_arn #lens_arn} => String
1764
2346
  # * {Types::UpdateAnswerOutput#answer #answer} => Types::Answer
1765
2347
  #
1766
2348
  # @example Request syntax with placeholder values
@@ -1786,16 +2368,22 @@ module Aws::WellArchitected
1786
2368
  #
1787
2369
  # resp.workload_id #=> String
1788
2370
  # resp.lens_alias #=> String
2371
+ # resp.lens_arn #=> String
1789
2372
  # resp.answer.question_id #=> String
1790
2373
  # resp.answer.pillar_id #=> String
1791
2374
  # resp.answer.question_title #=> String
1792
2375
  # resp.answer.question_description #=> String
1793
2376
  # resp.answer.improvement_plan_url #=> String
1794
2377
  # resp.answer.helpful_resource_url #=> String
2378
+ # resp.answer.helpful_resource_display_text #=> String
1795
2379
  # resp.answer.choices #=> Array
1796
2380
  # resp.answer.choices[0].choice_id #=> String
1797
2381
  # resp.answer.choices[0].title #=> String
1798
2382
  # resp.answer.choices[0].description #=> String
2383
+ # resp.answer.choices[0].helpful_resource.display_text #=> String
2384
+ # resp.answer.choices[0].helpful_resource.url #=> String
2385
+ # resp.answer.choices[0].improvement_plan.display_text #=> String
2386
+ # resp.answer.choices[0].improvement_plan.url #=> String
1799
2387
  # resp.answer.selected_choices #=> Array
1800
2388
  # resp.answer.selected_choices[0] #=> String
1801
2389
  # resp.answer.choice_answers #=> Array
@@ -1820,8 +2408,8 @@ module Aws::WellArchitected
1820
2408
  # Update lens review.
1821
2409
  #
1822
2410
  # @option params [required, String] :workload_id
1823
- # The ID assigned to the workload. This ID is unique within an AWS
1824
- # Region.
2411
+ # The ID assigned to the workload. This ID is unique within an Amazon
2412
+ # Web Services Region.
1825
2413
  #
1826
2414
  # @option params [required, String] :lens_alias
1827
2415
  # The alias of the lens, for example, `serverless`.
@@ -1854,9 +2442,10 @@ module Aws::WellArchitected
1854
2442
  #
1855
2443
  # resp.workload_id #=> String
1856
2444
  # resp.lens_review.lens_alias #=> String
2445
+ # resp.lens_review.lens_arn #=> String
1857
2446
  # resp.lens_review.lens_version #=> String
1858
2447
  # resp.lens_review.lens_name #=> String
1859
- # resp.lens_review.lens_status #=> String, one of "CURRENT", "NOT_CURRENT", "DEPRECATED"
2448
+ # resp.lens_review.lens_status #=> String, one of "CURRENT", "NOT_CURRENT", "DEPRECATED", "DELETED", "UNSHARED"
1860
2449
  # resp.lens_review.pillar_review_summaries #=> Array
1861
2450
  # resp.lens_review.pillar_review_summaries[0].pillar_id #=> String
1862
2451
  # resp.lens_review.pillar_review_summaries[0].pillar_name #=> String
@@ -1900,7 +2489,10 @@ module Aws::WellArchitected
1900
2489
  # @example Response structure
1901
2490
  #
1902
2491
  # resp.share_invitation.share_invitation_id #=> String
2492
+ # resp.share_invitation.share_resource_type #=> String, one of "WORKLOAD", "LENS"
1903
2493
  # resp.share_invitation.workload_id #=> String
2494
+ # resp.share_invitation.lens_alias #=> String
2495
+ # resp.share_invitation.lens_arn #=> String
1904
2496
  #
1905
2497
  # @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/UpdateShareInvitation AWS API Documentation
1906
2498
  #
@@ -1914,14 +2506,15 @@ module Aws::WellArchitected
1914
2506
  # Update an existing workload.
1915
2507
  #
1916
2508
  # @option params [required, String] :workload_id
1917
- # The ID assigned to the workload. This ID is unique within an AWS
1918
- # Region.
2509
+ # The ID assigned to the workload. This ID is unique within an Amazon
2510
+ # Web Services Region.
1919
2511
  #
1920
2512
  # @option params [String] :workload_name
1921
2513
  # The name of the workload.
1922
2514
  #
1923
- # The name must be unique within an account within a Region. Spaces and
1924
- # capitalization are ignored when checking for uniqueness.
2515
+ # The name must be unique within an account within an Amazon Web
2516
+ # Services Region. Spaces and capitalization are ignored when checking
2517
+ # for uniqueness.
1925
2518
  #
1926
2519
  # @option params [String] :description
1927
2520
  # The description for the workload.
@@ -1930,14 +2523,16 @@ module Aws::WellArchitected
1930
2523
  # The environment for the workload.
1931
2524
  #
1932
2525
  # @option params [Array<String>] :account_ids
1933
- # The list of AWS account IDs associated with the workload.
2526
+ # The list of Amazon Web Services account IDs associated with the
2527
+ # workload.
1934
2528
  #
1935
2529
  # @option params [Array<String>] :aws_regions
1936
- # The list of AWS Regions associated with the workload, for example,
1937
- # `us-east-2`, or `ca-central-1`.
2530
+ # The list of Amazon Web Services Regions associated with the workload,
2531
+ # for example, `us-east-2`, or `ca-central-1`.
1938
2532
  #
1939
2533
  # @option params [Array<String>] :non_aws_regions
1940
- # The list of non-AWS Regions associated with the workload.
2534
+ # The list of non-Amazon Web Services Regions associated with the
2535
+ # workload.
1941
2536
  #
1942
2537
  # @option params [Array<String>] :pillar_priorities
1943
2538
  # The priorities of the pillars, which are used to order items in the
@@ -2100,8 +2695,8 @@ module Aws::WellArchitected
2100
2695
  # The ID associated with the workload share.
2101
2696
  #
2102
2697
  # @option params [required, String] :workload_id
2103
- # The ID assigned to the workload. This ID is unique within an AWS
2104
- # Region.
2698
+ # The ID assigned to the workload. This ID is unique within an Amazon
2699
+ # Web Services Region.
2105
2700
  #
2106
2701
  # @option params [required, String] :permission_type
2107
2702
  # Permission granted on a workload share.
@@ -2142,8 +2737,8 @@ module Aws::WellArchitected
2142
2737
  # Upgrade lens review.
2143
2738
  #
2144
2739
  # @option params [required, String] :workload_id
2145
- # The ID assigned to the workload. This ID is unique within an AWS
2146
- # Region.
2740
+ # The ID assigned to the workload. This ID is unique within an Amazon
2741
+ # Web Services Region.
2147
2742
  #
2148
2743
  # @option params [required, String] :lens_alias
2149
2744
  # The alias of the lens, for example, `serverless`.
@@ -2165,9 +2760,9 @@ module Aws::WellArchitected
2165
2760
  # request is returned.
2166
2761
  #
2167
2762
  # This token is listed as required, however, if you do not specify it,
2168
- # the AWS SDKs automatically generate one for you. If you are not using
2169
- # the AWS SDK or the AWS CLI, you must provide this token or the request
2170
- # will fail.
2763
+ # the Amazon Web Services SDKs automatically generate one for you. If
2764
+ # you are not using the Amazon Web Services SDK or the CLI, you must
2765
+ # provide this token or the request will fail.
2171
2766
  #
2172
2767
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2173
2768
  #
@@ -2202,7 +2797,7 @@ module Aws::WellArchitected
2202
2797
  params: params,
2203
2798
  config: config)
2204
2799
  context[:gem_name] = 'aws-sdk-wellarchitected'
2205
- context[:gem_version] = '1.10.0'
2800
+ context[:gem_version] = '1.14.0'
2206
2801
  Seahorse::Client::Request.new(handlers, context)
2207
2802
  end
2208
2803