aws-sdk-wellarchitected 1.8.0 → 1.12.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -119,7 +119,9 @@ module Aws::WellArchitected
119
119
  # * EC2/ECS IMDS instance profile - When used by default, the timeouts
120
120
  # are very aggressive. Construct and pass an instance of
121
121
  # `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
122
- # enable retries and extended timeouts.
122
+ # enable retries and extended timeouts. Instance profile credential
123
+ # fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
124
+ # to true.
123
125
  #
124
126
  # @option options [required, String] :region
125
127
  # The AWS region to connect to. The configured `:region` is
@@ -275,6 +277,15 @@ module Aws::WellArchitected
275
277
  # ** Please note ** When response stubbing is enabled, no HTTP
276
278
  # requests are made, and retries are disabled.
277
279
  #
280
+ # @option options [Boolean] :use_dualstack_endpoint
281
+ # When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
282
+ # will be used if available.
283
+ #
284
+ # @option options [Boolean] :use_fips_endpoint
285
+ # When set to `true`, fips compatible endpoints will be used if available.
286
+ # When a `fips` region is used, the region is normalized and this config
287
+ # is set to `true`.
288
+ #
278
289
  # @option options [Boolean] :validate_params (true)
279
290
  # When `true`, request parameters are validated before
280
291
  # sending the request.
@@ -329,12 +340,25 @@ module Aws::WellArchitected
329
340
 
330
341
  # Associate a lens to a workload.
331
342
  #
343
+ # Up to 10 lenses can be associated with a workload in a single API
344
+ # operation. A maximum of 20 lenses can be associated with a workload.
345
+ #
346
+ # <note markdown="1"> **Disclaimer**
347
+ #
348
+ # By accessing and/or applying custom lenses created by another Amazon
349
+ # Web Services user or account, you acknowledge that custom lenses
350
+ # created by other users and shared with you are Third Party Content as
351
+ # defined in the Amazon Web Services Customer Agreement.
352
+ #
353
+ # </note>
354
+ #
332
355
  # @option params [required, String] :workload_id
333
- # The ID assigned to the workload. This ID is unique within an AWS
334
- # Region.
356
+ # The ID assigned to the workload. This ID is unique within an Amazon
357
+ # Web Services Region.
335
358
  #
336
359
  # @option params [required, Array<String>] :lens_aliases
337
- # List of lens aliases to associate or disassociate with a workload.
360
+ # List of lens aliases to associate or disassociate with a workload. Up
361
+ # to 10 lenses can be specified.
338
362
  #
339
363
  # Identify a lens using its LensSummary$LensAlias.
340
364
  #
@@ -356,11 +380,144 @@ module Aws::WellArchitected
356
380
  req.send_request(options)
357
381
  end
358
382
 
383
+ # Create a lens share.
384
+ #
385
+ # The owner of a lens can share it with other Amazon Web Services
386
+ # accounts and IAM users in the same Amazon Web Services Region. Shared
387
+ # access to a lens is not removed until the lens invitation is deleted.
388
+ #
389
+ # <note markdown="1"> **Disclaimer**
390
+ #
391
+ # By sharing your custom lenses with other Amazon Web Services accounts,
392
+ # you acknowledge that Amazon Web Services will make your custom lenses
393
+ # available to those other accounts. Those other accounts may continue
394
+ # to access and use your shared custom lenses even if you delete the
395
+ # custom lenses from your own Amazon Web Services account or terminate
396
+ # your Amazon Web Services account.
397
+ #
398
+ # </note>
399
+ #
400
+ # @option params [required, String] :lens_alias
401
+ # The alias of the lens, for example, `serverless`.
402
+ #
403
+ # Each lens is identified by its LensSummary$LensAlias.
404
+ #
405
+ # @option params [required, String] :shared_with
406
+ # The Amazon Web Services account ID or IAM role with which the workload
407
+ # is shared.
408
+ #
409
+ # @option params [required, String] :client_request_token
410
+ # A unique case-sensitive string used to ensure that this request is
411
+ # idempotent (executes only once).
412
+ #
413
+ # You should not reuse the same token for other requests. If you retry a
414
+ # request with the same client request token and the same parameters
415
+ # after it has completed successfully, the result of the original
416
+ # request is returned.
417
+ #
418
+ # This token is listed as required, however, if you do not specify it,
419
+ # the Amazon Web Services SDKs automatically generate one for you. If
420
+ # you are not using the Amazon Web Services SDK or the CLI, you must
421
+ # provide this token or the request will fail.
422
+ #
423
+ # **A suitable default value is auto-generated.** You should normally
424
+ # not need to pass this option.**
425
+ #
426
+ # @return [Types::CreateLensShareOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
427
+ #
428
+ # * {Types::CreateLensShareOutput#share_id #share_id} => String
429
+ #
430
+ # @example Request syntax with placeholder values
431
+ #
432
+ # resp = client.create_lens_share({
433
+ # lens_alias: "LensAlias", # required
434
+ # shared_with: "SharedWith", # required
435
+ # client_request_token: "ClientRequestToken", # required
436
+ # })
437
+ #
438
+ # @example Response structure
439
+ #
440
+ # resp.share_id #=> String
441
+ #
442
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/CreateLensShare AWS API Documentation
443
+ #
444
+ # @overload create_lens_share(params = {})
445
+ # @param [Hash] params ({})
446
+ def create_lens_share(params = {}, options = {})
447
+ req = build_request(:create_lens_share, params)
448
+ req.send_request(options)
449
+ end
450
+
451
+ # Create a new lens version.
452
+ #
453
+ # A lens can have up to 100 versions.
454
+ #
455
+ # After a lens has been imported, create a new lens version to publish
456
+ # it. The owner of a lens can share the lens with other Amazon Web
457
+ # Services accounts and IAM users in the same Amazon Web Services
458
+ # Region. Only the owner of a lens can delete it.
459
+ #
460
+ # @option params [required, String] :lens_alias
461
+ # The alias of the lens, for example, `serverless`.
462
+ #
463
+ # Each lens is identified by its LensSummary$LensAlias.
464
+ #
465
+ # @option params [required, String] :lens_version
466
+ # The version of the lens being created.
467
+ #
468
+ # @option params [Boolean] :is_major_version
469
+ # Set to true if this new major lens version.
470
+ #
471
+ # @option params [required, String] :client_request_token
472
+ # A unique case-sensitive string used to ensure that this request is
473
+ # idempotent (executes only once).
474
+ #
475
+ # You should not reuse the same token for other requests. If you retry a
476
+ # request with the same client request token and the same parameters
477
+ # after it has completed successfully, the result of the original
478
+ # request is returned.
479
+ #
480
+ # This token is listed as required, however, if you do not specify it,
481
+ # the Amazon Web Services SDKs automatically generate one for you. If
482
+ # you are not using the Amazon Web Services SDK or the CLI, you must
483
+ # provide this token or the request will fail.
484
+ #
485
+ # **A suitable default value is auto-generated.** You should normally
486
+ # not need to pass this option.**
487
+ #
488
+ # @return [Types::CreateLensVersionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
489
+ #
490
+ # * {Types::CreateLensVersionOutput#lens_arn #lens_arn} => String
491
+ # * {Types::CreateLensVersionOutput#lens_version #lens_version} => String
492
+ #
493
+ # @example Request syntax with placeholder values
494
+ #
495
+ # resp = client.create_lens_version({
496
+ # lens_alias: "LensAlias", # required
497
+ # lens_version: "LensVersion", # required
498
+ # is_major_version: false,
499
+ # client_request_token: "ClientRequestToken", # required
500
+ # })
501
+ #
502
+ # @example Response structure
503
+ #
504
+ # resp.lens_arn #=> String
505
+ # resp.lens_version #=> String
506
+ #
507
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/CreateLensVersion AWS API Documentation
508
+ #
509
+ # @overload create_lens_version(params = {})
510
+ # @param [Hash] params ({})
511
+ def create_lens_version(params = {}, options = {})
512
+ req = build_request(:create_lens_version, params)
513
+ req.send_request(options)
514
+ end
515
+
359
516
  # Create a milestone for an existing workload.
360
517
  #
361
518
  # @option params [required, String] :workload_id
362
- # The ID assigned to the workload. This ID is unique within an AWS
363
- # Region.
519
+ # The ID assigned to the workload. This ID is unique within an Amazon
520
+ # Web Services Region.
364
521
  #
365
522
  # @option params [required, String] :milestone_name
366
523
  # The name of the milestone in a workload.
@@ -377,9 +534,9 @@ module Aws::WellArchitected
377
534
  # request is returned.
378
535
  #
379
536
  # This token is listed as required, however, if you do not specify it,
380
- # the AWS SDKs automatically generate one for you. If you are not using
381
- # the AWS SDK or the AWS CLI, you must provide this token or the request
382
- # will fail.
537
+ # the Amazon Web Services SDKs automatically generate one for you. If
538
+ # you are not using the Amazon Web Services SDK or the CLI, you must
539
+ # provide this token or the request will fail.
383
540
  #
384
541
  # **A suitable default value is auto-generated.** You should normally
385
542
  # not need to pass this option.**
@@ -413,12 +570,12 @@ module Aws::WellArchitected
413
570
 
414
571
  # Create a new workload.
415
572
  #
416
- # The owner of a workload can share the workload with other AWS accounts
417
- # and IAM users in the same AWS Region. Only the owner of a workload can
418
- # delete it.
573
+ # The owner of a workload can share the workload with other Amazon Web
574
+ # Services accounts and IAM users in the same Amazon Web Services
575
+ # Region. Only the owner of a workload can delete it.
419
576
  #
420
- # For more information, see [Defining a Workload][1] in the *AWS
421
- # Well-Architected Tool User Guide*.
577
+ # For more information, see [Defining a Workload][1] in the
578
+ # *Well-Architected Tool User Guide*.
422
579
  #
423
580
  #
424
581
  #
@@ -427,8 +584,9 @@ module Aws::WellArchitected
427
584
  # @option params [required, String] :workload_name
428
585
  # The name of the workload.
429
586
  #
430
- # The name must be unique within an account within a Region. Spaces and
431
- # capitalization are ignored when checking for uniqueness.
587
+ # The name must be unique within an account within an Amazon Web
588
+ # Services Region. Spaces and capitalization are ignored when checking
589
+ # for uniqueness.
432
590
  #
433
591
  # @option params [required, String] :description
434
592
  # The description for the workload.
@@ -437,14 +595,16 @@ module Aws::WellArchitected
437
595
  # The environment for the workload.
438
596
  #
439
597
  # @option params [Array<String>] :account_ids
440
- # The list of AWS account IDs associated with the workload.
598
+ # The list of Amazon Web Services account IDs associated with the
599
+ # workload.
441
600
  #
442
601
  # @option params [Array<String>] :aws_regions
443
- # The list of AWS Regions associated with the workload, for example,
444
- # `us-east-2`, or `ca-central-1`.
602
+ # The list of Amazon Web Services Regions associated with the workload,
603
+ # for example, `us-east-2`, or `ca-central-1`.
445
604
  #
446
605
  # @option params [Array<String>] :non_aws_regions
447
- # The list of non-AWS Regions associated with the workload.
606
+ # The list of non-Amazon Web Services Regions associated with the
607
+ # workload.
448
608
  #
449
609
  # @option params [Array<String>] :pillar_priorities
450
610
  # The priorities of the pillars, which are used to order items in the
@@ -538,9 +698,9 @@ module Aws::WellArchitected
538
698
  # request is returned.
539
699
  #
540
700
  # This token is listed as required, however, if you do not specify it,
541
- # the AWS SDKs automatically generate one for you. If you are not using
542
- # the AWS SDK or the AWS CLI, you must provide this token or the request
543
- # will fail.
701
+ # the Amazon Web Services SDKs automatically generate one for you. If
702
+ # you are not using the Amazon Web Services SDK or the CLI, you must
703
+ # provide this token or the request will fail.
544
704
  #
545
705
  # **A suitable default value is auto-generated.** You should normally
546
706
  # not need to pass this option.**
@@ -591,23 +751,25 @@ module Aws::WellArchitected
591
751
 
592
752
  # Create a workload share.
593
753
  #
594
- # The owner of a workload can share it with other AWS accounts and IAM
595
- # users in the same AWS Region. Shared access to a workload is not
596
- # removed until the workload invitation is deleted.
754
+ # The owner of a workload can share it with other Amazon Web Services
755
+ # accounts and IAM users in the same Amazon Web Services Region. Shared
756
+ # access to a workload is not removed until the workload invitation is
757
+ # deleted.
597
758
  #
598
- # For more information, see [Sharing a Workload][1] in the *AWS
599
- # Well-Architected Tool User Guide*.
759
+ # For more information, see [Sharing a Workload][1] in the
760
+ # *Well-Architected Tool User Guide*.
600
761
  #
601
762
  #
602
763
  #
603
764
  # [1]: https://docs.aws.amazon.com/wellarchitected/latest/userguide/workloads-sharing.html
604
765
  #
605
766
  # @option params [required, String] :workload_id
606
- # The ID assigned to the workload. This ID is unique within an AWS
607
- # Region.
767
+ # The ID assigned to the workload. This ID is unique within an Amazon
768
+ # Web Services Region.
608
769
  #
609
770
  # @option params [required, String] :shared_with
610
- # The AWS account ID or IAM role with which the workload is shared.
771
+ # The Amazon Web Services account ID or IAM role with which the workload
772
+ # is shared.
611
773
  #
612
774
  # @option params [required, String] :permission_type
613
775
  # Permission granted on a workload share.
@@ -622,9 +784,9 @@ module Aws::WellArchitected
622
784
  # request is returned.
623
785
  #
624
786
  # This token is listed as required, however, if you do not specify it,
625
- # the AWS SDKs automatically generate one for you. If you are not using
626
- # the AWS SDK or the AWS CLI, you must provide this token or the request
627
- # will fail.
787
+ # the Amazon Web Services SDKs automatically generate one for you. If
788
+ # you are not using the Amazon Web Services SDK or the CLI, you must
789
+ # provide this token or the request will fail.
628
790
  #
629
791
  # **A suitable default value is auto-generated.** You should normally
630
792
  # not need to pass this option.**
@@ -657,11 +819,134 @@ module Aws::WellArchitected
657
819
  req.send_request(options)
658
820
  end
659
821
 
822
+ # Delete an existing lens.
823
+ #
824
+ # Only the owner of a lens can delete it. After the lens is deleted,
825
+ # Amazon Web Services accounts and IAM users that you shared the lens
826
+ # with can continue to use it, but they will no longer be able to apply
827
+ # it to new workloads.
828
+ #
829
+ # <note markdown="1"> **Disclaimer**
830
+ #
831
+ # By sharing your custom lenses with other Amazon Web Services accounts,
832
+ # you acknowledge that Amazon Web Services will make your custom lenses
833
+ # available to those other accounts. Those other accounts may continue
834
+ # to access and use your shared custom lenses even if you delete the
835
+ # custom lenses from your own Amazon Web Services account or terminate
836
+ # your Amazon Web Services account.
837
+ #
838
+ # </note>
839
+ #
840
+ # @option params [required, String] :lens_alias
841
+ # The alias of the lens, for example, `serverless`.
842
+ #
843
+ # Each lens is identified by its LensSummary$LensAlias.
844
+ #
845
+ # @option params [required, String] :client_request_token
846
+ # A unique case-sensitive string used to ensure that this request is
847
+ # idempotent (executes only once).
848
+ #
849
+ # You should not reuse the same token for other requests. If you retry a
850
+ # request with the same client request token and the same parameters
851
+ # after it has completed successfully, the result of the original
852
+ # request is returned.
853
+ #
854
+ # This token is listed as required, however, if you do not specify it,
855
+ # the Amazon Web Services SDKs automatically generate one for you. If
856
+ # you are not using the Amazon Web Services SDK or the CLI, you must
857
+ # provide this token or the request will fail.
858
+ #
859
+ # **A suitable default value is auto-generated.** You should normally
860
+ # not need to pass this option.**
861
+ #
862
+ # @option params [required, String] :lens_status
863
+ # The status of the lens to be deleted.
864
+ #
865
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
866
+ #
867
+ # @example Request syntax with placeholder values
868
+ #
869
+ # resp = client.delete_lens({
870
+ # lens_alias: "LensAlias", # required
871
+ # client_request_token: "ClientRequestToken", # required
872
+ # lens_status: "ALL", # required, accepts ALL, DRAFT, PUBLISHED
873
+ # })
874
+ #
875
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/DeleteLens AWS API Documentation
876
+ #
877
+ # @overload delete_lens(params = {})
878
+ # @param [Hash] params ({})
879
+ def delete_lens(params = {}, options = {})
880
+ req = build_request(:delete_lens, params)
881
+ req.send_request(options)
882
+ end
883
+
884
+ # Delete a lens share.
885
+ #
886
+ # After the lens share is deleted, Amazon Web Services accounts and IAM
887
+ # users that you shared the lens with can continue to use it, but they
888
+ # will no longer be able to apply it to new workloads.
889
+ #
890
+ # <note markdown="1"> **Disclaimer**
891
+ #
892
+ # By sharing your custom lenses with other Amazon Web Services accounts,
893
+ # you acknowledge that Amazon Web Services will make your custom lenses
894
+ # available to those other accounts. Those other accounts may continue
895
+ # to access and use your shared custom lenses even if you delete the
896
+ # custom lenses from your own Amazon Web Services account or terminate
897
+ # your Amazon Web Services account.
898
+ #
899
+ # </note>
900
+ #
901
+ # @option params [required, String] :share_id
902
+ # The ID associated with the workload share.
903
+ #
904
+ # @option params [required, String] :lens_alias
905
+ # The alias of the lens, for example, `serverless`.
906
+ #
907
+ # Each lens is identified by its LensSummary$LensAlias.
908
+ #
909
+ # @option params [required, String] :client_request_token
910
+ # A unique case-sensitive string used to ensure that this request is
911
+ # idempotent (executes only once).
912
+ #
913
+ # You should not reuse the same token for other requests. If you retry a
914
+ # request with the same client request token and the same parameters
915
+ # after it has completed successfully, the result of the original
916
+ # request is returned.
917
+ #
918
+ # This token is listed as required, however, if you do not specify it,
919
+ # the Amazon Web Services SDKs automatically generate one for you. If
920
+ # you are not using the Amazon Web Services SDK or the CLI, you must
921
+ # provide this token or the request will fail.
922
+ #
923
+ # **A suitable default value is auto-generated.** You should normally
924
+ # not need to pass this option.**
925
+ #
926
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
927
+ #
928
+ # @example Request syntax with placeholder values
929
+ #
930
+ # resp = client.delete_lens_share({
931
+ # share_id: "ShareId", # required
932
+ # lens_alias: "LensAlias", # required
933
+ # client_request_token: "ClientRequestToken", # required
934
+ # })
935
+ #
936
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/DeleteLensShare AWS API Documentation
937
+ #
938
+ # @overload delete_lens_share(params = {})
939
+ # @param [Hash] params ({})
940
+ def delete_lens_share(params = {}, options = {})
941
+ req = build_request(:delete_lens_share, params)
942
+ req.send_request(options)
943
+ end
944
+
660
945
  # Delete an existing workload.
661
946
  #
662
947
  # @option params [required, String] :workload_id
663
- # The ID assigned to the workload. This ID is unique within an AWS
664
- # Region.
948
+ # The ID assigned to the workload. This ID is unique within an Amazon
949
+ # Web Services Region.
665
950
  #
666
951
  # @option params [required, String] :client_request_token
667
952
  # A unique case-sensitive string used to ensure that this request is
@@ -673,9 +958,9 @@ module Aws::WellArchitected
673
958
  # request is returned.
674
959
  #
675
960
  # This token is listed as required, however, if you do not specify it,
676
- # the AWS SDKs automatically generate one for you. If you are not using
677
- # the AWS SDK or the AWS CLI, you must provide this token or the request
678
- # will fail.
961
+ # the Amazon Web Services SDKs automatically generate one for you. If
962
+ # you are not using the Amazon Web Services SDK or the CLI, you must
963
+ # provide this token or the request will fail.
679
964
  #
680
965
  # **A suitable default value is auto-generated.** You should normally
681
966
  # not need to pass this option.**
@@ -704,8 +989,8 @@ module Aws::WellArchitected
704
989
  # The ID associated with the workload share.
705
990
  #
706
991
  # @option params [required, String] :workload_id
707
- # The ID assigned to the workload. This ID is unique within an AWS
708
- # Region.
992
+ # The ID assigned to the workload. This ID is unique within an Amazon
993
+ # Web Services Region.
709
994
  #
710
995
  # @option params [required, String] :client_request_token
711
996
  # A unique case-sensitive string used to ensure that this request is
@@ -717,9 +1002,9 @@ module Aws::WellArchitected
717
1002
  # request is returned.
718
1003
  #
719
1004
  # This token is listed as required, however, if you do not specify it,
720
- # the AWS SDKs automatically generate one for you. If you are not using
721
- # the AWS SDK or the AWS CLI, you must provide this token or the request
722
- # will fail.
1005
+ # the Amazon Web Services SDKs automatically generate one for you. If
1006
+ # you are not using the Amazon Web Services SDK or the CLI, you must
1007
+ # provide this token or the request will fail.
723
1008
  #
724
1009
  # **A suitable default value is auto-generated.** You should normally
725
1010
  # not need to pass this option.**
@@ -745,17 +1030,21 @@ module Aws::WellArchitected
745
1030
 
746
1031
  # Disassociate a lens from a workload.
747
1032
  #
748
- # <note markdown="1"> The AWS Well-Architected Framework lens (`wellarchitected`) cannot be
749
- # removed from a workload.
1033
+ # Up to 10 lenses can be disassociated from a workload in a single API
1034
+ # operation.
1035
+ #
1036
+ # <note markdown="1"> The Amazon Web Services Well-Architected Framework lens
1037
+ # (`wellarchitected`) cannot be removed from a workload.
750
1038
  #
751
1039
  # </note>
752
1040
  #
753
1041
  # @option params [required, String] :workload_id
754
- # The ID assigned to the workload. This ID is unique within an AWS
755
- # Region.
1042
+ # The ID assigned to the workload. This ID is unique within an Amazon
1043
+ # Web Services Region.
756
1044
  #
757
1045
  # @option params [required, Array<String>] :lens_aliases
758
- # List of lens aliases to associate or disassociate with a workload.
1046
+ # List of lens aliases to associate or disassociate with a workload. Up
1047
+ # to 10 lenses can be specified.
759
1048
  #
760
1049
  # Identify a lens using its LensSummary$LensAlias.
761
1050
  #
@@ -777,11 +1066,65 @@ module Aws::WellArchitected
777
1066
  req.send_request(options)
778
1067
  end
779
1068
 
1069
+ # Export an existing lens.
1070
+ #
1071
+ # Lenses are defined in JSON. For more information, see [JSON format
1072
+ # specification][1] in the *Well-Architected Tool User Guide*. Only the
1073
+ # owner of a lens can export it.
1074
+ #
1075
+ # <note markdown="1"> **Disclaimer**
1076
+ #
1077
+ # Do not include or gather personal identifiable information (PII) of
1078
+ # end users or other identifiable individuals in or via your custom
1079
+ # lenses. If your custom lens or those shared with you and used in your
1080
+ # account do include or collect PII you are responsible for: ensuring
1081
+ # that the included PII is processed in accordance with applicable law,
1082
+ # providing adequate privacy notices, and obtaining necessary consents
1083
+ # for processing such data.
1084
+ #
1085
+ # </note>
1086
+ #
1087
+ #
1088
+ #
1089
+ # [1]: https://docs.aws.amazon.com/wellarchitected/latest/userguide/lenses-format-specification.html
1090
+ #
1091
+ # @option params [required, String] :lens_alias
1092
+ # The alias of the lens, for example, `serverless`.
1093
+ #
1094
+ # Each lens is identified by its LensSummary$LensAlias.
1095
+ #
1096
+ # @option params [String] :lens_version
1097
+ # The lens version to be exported.
1098
+ #
1099
+ # @return [Types::ExportLensOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1100
+ #
1101
+ # * {Types::ExportLensOutput#lens_json #lens_json} => String
1102
+ #
1103
+ # @example Request syntax with placeholder values
1104
+ #
1105
+ # resp = client.export_lens({
1106
+ # lens_alias: "LensAlias", # required
1107
+ # lens_version: "LensVersion",
1108
+ # })
1109
+ #
1110
+ # @example Response structure
1111
+ #
1112
+ # resp.lens_json #=> String
1113
+ #
1114
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ExportLens AWS API Documentation
1115
+ #
1116
+ # @overload export_lens(params = {})
1117
+ # @param [Hash] params ({})
1118
+ def export_lens(params = {}, options = {})
1119
+ req = build_request(:export_lens, params)
1120
+ req.send_request(options)
1121
+ end
1122
+
780
1123
  # Get the answer to a specific question in a workload review.
781
1124
  #
782
1125
  # @option params [required, String] :workload_id
783
- # The ID assigned to the workload. This ID is unique within an AWS
784
- # Region.
1126
+ # The ID assigned to the workload. This ID is unique within an Amazon
1127
+ # Web Services Region.
785
1128
  #
786
1129
  # @option params [required, String] :lens_alias
787
1130
  # The alias of the lens, for example, `serverless`.
@@ -801,6 +1144,7 @@ module Aws::WellArchitected
801
1144
  # * {Types::GetAnswerOutput#workload_id #workload_id} => String
802
1145
  # * {Types::GetAnswerOutput#milestone_number #milestone_number} => Integer
803
1146
  # * {Types::GetAnswerOutput#lens_alias #lens_alias} => String
1147
+ # * {Types::GetAnswerOutput#lens_arn #lens_arn} => String
804
1148
  # * {Types::GetAnswerOutput#answer #answer} => Types::Answer
805
1149
  #
806
1150
  # @example Request syntax with placeholder values
@@ -817,16 +1161,22 @@ module Aws::WellArchitected
817
1161
  # resp.workload_id #=> String
818
1162
  # resp.milestone_number #=> Integer
819
1163
  # resp.lens_alias #=> String
1164
+ # resp.lens_arn #=> String
820
1165
  # resp.answer.question_id #=> String
821
1166
  # resp.answer.pillar_id #=> String
822
1167
  # resp.answer.question_title #=> String
823
1168
  # resp.answer.question_description #=> String
824
1169
  # resp.answer.improvement_plan_url #=> String
825
1170
  # resp.answer.helpful_resource_url #=> String
1171
+ # resp.answer.helpful_resource_display_text #=> String
826
1172
  # resp.answer.choices #=> Array
827
1173
  # resp.answer.choices[0].choice_id #=> String
828
1174
  # resp.answer.choices[0].title #=> String
829
1175
  # resp.answer.choices[0].description #=> String
1176
+ # resp.answer.choices[0].helpful_resource.display_text #=> String
1177
+ # resp.answer.choices[0].helpful_resource.url #=> String
1178
+ # resp.answer.choices[0].improvement_plan.display_text #=> String
1179
+ # resp.answer.choices[0].improvement_plan.url #=> String
830
1180
  # resp.answer.selected_choices #=> Array
831
1181
  # resp.answer.selected_choices[0] #=> String
832
1182
  # resp.answer.choice_answers #=> Array
@@ -848,11 +1198,50 @@ module Aws::WellArchitected
848
1198
  req.send_request(options)
849
1199
  end
850
1200
 
1201
+ # Get an existing lens.
1202
+ #
1203
+ # @option params [required, String] :lens_alias
1204
+ # The alias of the lens, for example, `serverless`.
1205
+ #
1206
+ # Each lens is identified by its LensSummary$LensAlias.
1207
+ #
1208
+ # @option params [String] :lens_version
1209
+ # The lens version to be retrieved.
1210
+ #
1211
+ # @return [Types::GetLensOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1212
+ #
1213
+ # * {Types::GetLensOutput#lens #lens} => Types::Lens
1214
+ #
1215
+ # @example Request syntax with placeholder values
1216
+ #
1217
+ # resp = client.get_lens({
1218
+ # lens_alias: "LensAlias", # required
1219
+ # lens_version: "LensVersion",
1220
+ # })
1221
+ #
1222
+ # @example Response structure
1223
+ #
1224
+ # resp.lens.lens_arn #=> String
1225
+ # resp.lens.lens_version #=> String
1226
+ # resp.lens.name #=> String
1227
+ # resp.lens.description #=> String
1228
+ # resp.lens.owner #=> String
1229
+ # resp.lens.share_invitation_id #=> String
1230
+ #
1231
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetLens AWS API Documentation
1232
+ #
1233
+ # @overload get_lens(params = {})
1234
+ # @param [Hash] params ({})
1235
+ def get_lens(params = {}, options = {})
1236
+ req = build_request(:get_lens, params)
1237
+ req.send_request(options)
1238
+ end
1239
+
851
1240
  # Get lens review.
852
1241
  #
853
1242
  # @option params [required, String] :workload_id
854
- # The ID assigned to the workload. This ID is unique within an AWS
855
- # Region.
1243
+ # The ID assigned to the workload. This ID is unique within an Amazon
1244
+ # Web Services Region.
856
1245
  #
857
1246
  # @option params [required, String] :lens_alias
858
1247
  # The alias of the lens, for example, `serverless`.
@@ -883,9 +1272,10 @@ module Aws::WellArchitected
883
1272
  # resp.workload_id #=> String
884
1273
  # resp.milestone_number #=> Integer
885
1274
  # resp.lens_review.lens_alias #=> String
1275
+ # resp.lens_review.lens_arn #=> String
886
1276
  # resp.lens_review.lens_version #=> String
887
1277
  # resp.lens_review.lens_name #=> String
888
- # resp.lens_review.lens_status #=> String, one of "CURRENT", "NOT_CURRENT", "DEPRECATED"
1278
+ # resp.lens_review.lens_status #=> String, one of "CURRENT", "NOT_CURRENT", "DEPRECATED", "DELETED", "UNSHARED"
889
1279
  # resp.lens_review.pillar_review_summaries #=> Array
890
1280
  # resp.lens_review.pillar_review_summaries[0].pillar_id #=> String
891
1281
  # resp.lens_review.pillar_review_summaries[0].pillar_name #=> String
@@ -910,8 +1300,8 @@ module Aws::WellArchitected
910
1300
  # Get lens review report.
911
1301
  #
912
1302
  # @option params [required, String] :workload_id
913
- # The ID assigned to the workload. This ID is unique within an AWS
914
- # Region.
1303
+ # The ID assigned to the workload. This ID is unique within an Amazon
1304
+ # Web Services Region.
915
1305
  #
916
1306
  # @option params [required, String] :lens_alias
917
1307
  # The alias of the lens, for example, `serverless`.
@@ -942,6 +1332,7 @@ module Aws::WellArchitected
942
1332
  # resp.workload_id #=> String
943
1333
  # resp.milestone_number #=> Integer
944
1334
  # resp.lens_review_report.lens_alias #=> String
1335
+ # resp.lens_review_report.lens_arn #=> String
945
1336
  # resp.lens_review_report.base_64_string #=> String
946
1337
  #
947
1338
  # @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetLensReviewReport AWS API Documentation
@@ -960,13 +1351,18 @@ module Aws::WellArchitected
960
1351
  #
961
1352
  # Each lens is identified by its LensSummary$LensAlias.
962
1353
  #
963
- # @option params [required, String] :base_lens_version
1354
+ # @option params [String] :base_lens_version
964
1355
  # The base version of the lens.
965
1356
  #
1357
+ # @option params [String] :target_lens_version
1358
+ # The lens version to target a difference for.
1359
+ #
966
1360
  # @return [Types::GetLensVersionDifferenceOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
967
1361
  #
968
1362
  # * {Types::GetLensVersionDifferenceOutput#lens_alias #lens_alias} => String
1363
+ # * {Types::GetLensVersionDifferenceOutput#lens_arn #lens_arn} => String
969
1364
  # * {Types::GetLensVersionDifferenceOutput#base_lens_version #base_lens_version} => String
1365
+ # * {Types::GetLensVersionDifferenceOutput#target_lens_version #target_lens_version} => String
970
1366
  # * {Types::GetLensVersionDifferenceOutput#latest_lens_version #latest_lens_version} => String
971
1367
  # * {Types::GetLensVersionDifferenceOutput#version_differences #version_differences} => Types::VersionDifferences
972
1368
  #
@@ -974,16 +1370,20 @@ module Aws::WellArchitected
974
1370
  #
975
1371
  # resp = client.get_lens_version_difference({
976
1372
  # lens_alias: "LensAlias", # required
977
- # base_lens_version: "LensVersion", # required
1373
+ # base_lens_version: "LensVersion",
1374
+ # target_lens_version: "LensVersion",
978
1375
  # })
979
1376
  #
980
1377
  # @example Response structure
981
1378
  #
982
1379
  # resp.lens_alias #=> String
1380
+ # resp.lens_arn #=> String
983
1381
  # resp.base_lens_version #=> String
1382
+ # resp.target_lens_version #=> String
984
1383
  # resp.latest_lens_version #=> String
985
1384
  # resp.version_differences.pillar_differences #=> Array
986
1385
  # resp.version_differences.pillar_differences[0].pillar_id #=> String
1386
+ # resp.version_differences.pillar_differences[0].pillar_name #=> String
987
1387
  # resp.version_differences.pillar_differences[0].difference_status #=> String, one of "UPDATED", "NEW", "DELETED"
988
1388
  # resp.version_differences.pillar_differences[0].question_differences #=> Array
989
1389
  # resp.version_differences.pillar_differences[0].question_differences[0].question_id #=> String
@@ -1002,8 +1402,8 @@ module Aws::WellArchitected
1002
1402
  # Get a milestone for an existing workload.
1003
1403
  #
1004
1404
  # @option params [required, String] :workload_id
1005
- # The ID assigned to the workload. This ID is unique within an AWS
1006
- # Region.
1405
+ # The ID assigned to the workload. This ID is unique within an Amazon
1406
+ # Web Services Region.
1007
1407
  #
1008
1408
  # @option params [required, Integer] :milestone_number
1009
1409
  # The milestone number.
@@ -1071,8 +1471,8 @@ module Aws::WellArchitected
1071
1471
  # Get an existing workload.
1072
1472
  #
1073
1473
  # @option params [required, String] :workload_id
1074
- # The ID assigned to the workload. This ID is unique within an AWS
1075
- # Region.
1474
+ # The ID assigned to the workload. This ID is unique within an Amazon
1475
+ # Web Services Region.
1076
1476
  #
1077
1477
  # @return [Types::GetWorkloadOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1078
1478
  #
@@ -1126,11 +1526,95 @@ module Aws::WellArchitected
1126
1526
  req.send_request(options)
1127
1527
  end
1128
1528
 
1529
+ # Import a new lens.
1530
+ #
1531
+ # The lens cannot be applied to workloads or shared with other Amazon
1532
+ # Web Services accounts until it's published with CreateLensVersion
1533
+ #
1534
+ # Lenses are defined in JSON. For more information, see [JSON format
1535
+ # specification][1] in the *Well-Architected Tool User Guide*.
1536
+ #
1537
+ # A custom lens cannot exceed 500 KB in size.
1538
+ #
1539
+ # <note markdown="1"> **Disclaimer**
1540
+ #
1541
+ # Do not include or gather personal identifiable information (PII) of
1542
+ # end users or other identifiable individuals in or via your custom
1543
+ # lenses. If your custom lens or those shared with you and used in your
1544
+ # account do include or collect PII you are responsible for: ensuring
1545
+ # that the included PII is processed in accordance with applicable law,
1546
+ # providing adequate privacy notices, and obtaining necessary consents
1547
+ # for processing such data.
1548
+ #
1549
+ # </note>
1550
+ #
1551
+ #
1552
+ #
1553
+ # [1]: https://docs.aws.amazon.com/wellarchitected/latest/userguide/lenses-format-specification.html
1554
+ #
1555
+ # @option params [String] :lens_alias
1556
+ # The alias of the lens, for example, `serverless`.
1557
+ #
1558
+ # Each lens is identified by its LensSummary$LensAlias.
1559
+ #
1560
+ # @option params [required, String] :json_string
1561
+ # The JSON representation of a lens.
1562
+ #
1563
+ # @option params [required, String] :client_request_token
1564
+ # A unique case-sensitive string used to ensure that this request is
1565
+ # idempotent (executes only once).
1566
+ #
1567
+ # You should not reuse the same token for other requests. If you retry a
1568
+ # request with the same client request token and the same parameters
1569
+ # after it has completed successfully, the result of the original
1570
+ # request is returned.
1571
+ #
1572
+ # This token is listed as required, however, if you do not specify it,
1573
+ # the Amazon Web Services SDKs automatically generate one for you. If
1574
+ # you are not using the Amazon Web Services SDK or the CLI, you must
1575
+ # provide this token or the request will fail.
1576
+ #
1577
+ # **A suitable default value is auto-generated.** You should normally
1578
+ # not need to pass this option.**
1579
+ #
1580
+ # @option params [Hash<String,String>] :tags
1581
+ # Tags to associate to a lens.
1582
+ #
1583
+ # @return [Types::ImportLensOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1584
+ #
1585
+ # * {Types::ImportLensOutput#lens_arn #lens_arn} => String
1586
+ # * {Types::ImportLensOutput#status #status} => String
1587
+ #
1588
+ # @example Request syntax with placeholder values
1589
+ #
1590
+ # resp = client.import_lens({
1591
+ # lens_alias: "LensAlias",
1592
+ # json_string: "LensJSON", # required
1593
+ # client_request_token: "ClientRequestToken", # required
1594
+ # tags: {
1595
+ # "TagKey" => "TagValue",
1596
+ # },
1597
+ # })
1598
+ #
1599
+ # @example Response structure
1600
+ #
1601
+ # resp.lens_arn #=> String
1602
+ # resp.status #=> String, one of "IN_PROGRESS", "COMPLETE", "ERROR"
1603
+ #
1604
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ImportLens AWS API Documentation
1605
+ #
1606
+ # @overload import_lens(params = {})
1607
+ # @param [Hash] params ({})
1608
+ def import_lens(params = {}, options = {})
1609
+ req = build_request(:import_lens, params)
1610
+ req.send_request(options)
1611
+ end
1612
+
1129
1613
  # List of answers.
1130
1614
  #
1131
1615
  # @option params [required, String] :workload_id
1132
- # The ID assigned to the workload. This ID is unique within an AWS
1133
- # Region.
1616
+ # The ID assigned to the workload. This ID is unique within an Amazon
1617
+ # Web Services Region.
1134
1618
  #
1135
1619
  # @option params [required, String] :lens_alias
1136
1620
  # The alias of the lens, for example, `serverless`.
@@ -1158,6 +1642,7 @@ module Aws::WellArchitected
1158
1642
  # * {Types::ListAnswersOutput#workload_id #workload_id} => String
1159
1643
  # * {Types::ListAnswersOutput#milestone_number #milestone_number} => Integer
1160
1644
  # * {Types::ListAnswersOutput#lens_alias #lens_alias} => String
1645
+ # * {Types::ListAnswersOutput#lens_arn #lens_arn} => String
1161
1646
  # * {Types::ListAnswersOutput#answer_summaries #answer_summaries} => Array&lt;Types::AnswerSummary&gt;
1162
1647
  # * {Types::ListAnswersOutput#next_token #next_token} => String
1163
1648
  #
@@ -1179,6 +1664,7 @@ module Aws::WellArchitected
1179
1664
  # resp.workload_id #=> String
1180
1665
  # resp.milestone_number #=> Integer
1181
1666
  # resp.lens_alias #=> String
1667
+ # resp.lens_arn #=> String
1182
1668
  # resp.answer_summaries #=> Array
1183
1669
  # resp.answer_summaries[0].question_id #=> String
1184
1670
  # resp.answer_summaries[0].pillar_id #=> String
@@ -1187,6 +1673,10 @@ module Aws::WellArchitected
1187
1673
  # resp.answer_summaries[0].choices[0].choice_id #=> String
1188
1674
  # resp.answer_summaries[0].choices[0].title #=> String
1189
1675
  # resp.answer_summaries[0].choices[0].description #=> String
1676
+ # resp.answer_summaries[0].choices[0].helpful_resource.display_text #=> String
1677
+ # resp.answer_summaries[0].choices[0].helpful_resource.url #=> String
1678
+ # resp.answer_summaries[0].choices[0].improvement_plan.display_text #=> String
1679
+ # resp.answer_summaries[0].choices[0].improvement_plan.url #=> String
1190
1680
  # resp.answer_summaries[0].selected_choices #=> Array
1191
1681
  # resp.answer_summaries[0].selected_choices[0] #=> String
1192
1682
  # resp.answer_summaries[0].choice_answer_summaries #=> Array
@@ -1210,8 +1700,8 @@ module Aws::WellArchitected
1210
1700
  # List lens review improvements.
1211
1701
  #
1212
1702
  # @option params [required, String] :workload_id
1213
- # The ID assigned to the workload. This ID is unique within an AWS
1214
- # Region.
1703
+ # The ID assigned to the workload. This ID is unique within an Amazon
1704
+ # Web Services Region.
1215
1705
  #
1216
1706
  # @option params [required, String] :lens_alias
1217
1707
  # The alias of the lens, for example, `serverless`.
@@ -1239,6 +1729,7 @@ module Aws::WellArchitected
1239
1729
  # * {Types::ListLensReviewImprovementsOutput#workload_id #workload_id} => String
1240
1730
  # * {Types::ListLensReviewImprovementsOutput#milestone_number #milestone_number} => Integer
1241
1731
  # * {Types::ListLensReviewImprovementsOutput#lens_alias #lens_alias} => String
1732
+ # * {Types::ListLensReviewImprovementsOutput#lens_arn #lens_arn} => String
1242
1733
  # * {Types::ListLensReviewImprovementsOutput#improvement_summaries #improvement_summaries} => Array&lt;Types::ImprovementSummary&gt;
1243
1734
  # * {Types::ListLensReviewImprovementsOutput#next_token #next_token} => String
1244
1735
  #
@@ -1260,12 +1751,17 @@ module Aws::WellArchitected
1260
1751
  # resp.workload_id #=> String
1261
1752
  # resp.milestone_number #=> Integer
1262
1753
  # resp.lens_alias #=> String
1754
+ # resp.lens_arn #=> String
1263
1755
  # resp.improvement_summaries #=> Array
1264
1756
  # resp.improvement_summaries[0].question_id #=> String
1265
1757
  # resp.improvement_summaries[0].pillar_id #=> String
1266
1758
  # resp.improvement_summaries[0].question_title #=> String
1267
1759
  # resp.improvement_summaries[0].risk #=> String, one of "UNANSWERED", "HIGH", "MEDIUM", "NONE", "NOT_APPLICABLE"
1268
1760
  # resp.improvement_summaries[0].improvement_plan_url #=> String
1761
+ # resp.improvement_summaries[0].improvement_plans #=> Array
1762
+ # resp.improvement_summaries[0].improvement_plans[0].choice_id #=> String
1763
+ # resp.improvement_summaries[0].improvement_plans[0].display_text #=> String
1764
+ # resp.improvement_summaries[0].improvement_plans[0].improvement_plan_url #=> String
1269
1765
  # resp.next_token #=> String
1270
1766
  #
1271
1767
  # @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListLensReviewImprovements AWS API Documentation
@@ -1280,8 +1776,8 @@ module Aws::WellArchitected
1280
1776
  # List lens reviews.
1281
1777
  #
1282
1778
  # @option params [required, String] :workload_id
1283
- # The ID assigned to the workload. This ID is unique within an AWS
1284
- # Region.
1779
+ # The ID assigned to the workload. This ID is unique within an Amazon
1780
+ # Web Services Region.
1285
1781
  #
1286
1782
  # @option params [Integer] :milestone_number
1287
1783
  # The milestone number.
@@ -1318,9 +1814,10 @@ module Aws::WellArchitected
1318
1814
  # resp.milestone_number #=> Integer
1319
1815
  # resp.lens_review_summaries #=> Array
1320
1816
  # resp.lens_review_summaries[0].lens_alias #=> String
1817
+ # resp.lens_review_summaries[0].lens_arn #=> String
1321
1818
  # resp.lens_review_summaries[0].lens_version #=> String
1322
1819
  # resp.lens_review_summaries[0].lens_name #=> String
1323
- # resp.lens_review_summaries[0].lens_status #=> String, one of "CURRENT", "NOT_CURRENT", "DEPRECATED"
1820
+ # resp.lens_review_summaries[0].lens_status #=> String, one of "CURRENT", "NOT_CURRENT", "DEPRECATED", "DELETED", "UNSHARED"
1324
1821
  # resp.lens_review_summaries[0].updated_at #=> Time
1325
1822
  # resp.lens_review_summaries[0].risk_counts #=> Hash
1326
1823
  # resp.lens_review_summaries[0].risk_counts["Risk"] #=> Integer
@@ -1335,6 +1832,56 @@ module Aws::WellArchitected
1335
1832
  req.send_request(options)
1336
1833
  end
1337
1834
 
1835
+ # List the lens shares associated with the lens.
1836
+ #
1837
+ # @option params [required, String] :lens_alias
1838
+ # The alias of the lens, for example, `serverless`.
1839
+ #
1840
+ # Each lens is identified by its LensSummary$LensAlias.
1841
+ #
1842
+ # @option params [String] :shared_with_prefix
1843
+ # The Amazon Web Services account ID or IAM role with which the lens is
1844
+ # shared.
1845
+ #
1846
+ # @option params [String] :next_token
1847
+ # The token to use to retrieve the next set of results.
1848
+ #
1849
+ # @option params [Integer] :max_results
1850
+ # The maximum number of results to return for this request.
1851
+ #
1852
+ # @return [Types::ListLensSharesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1853
+ #
1854
+ # * {Types::ListLensSharesOutput#lens_share_summaries #lens_share_summaries} => Array&lt;Types::LensShareSummary&gt;
1855
+ # * {Types::ListLensSharesOutput#next_token #next_token} => String
1856
+ #
1857
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1858
+ #
1859
+ # @example Request syntax with placeholder values
1860
+ #
1861
+ # resp = client.list_lens_shares({
1862
+ # lens_alias: "LensAlias", # required
1863
+ # shared_with_prefix: "SharedWithPrefix",
1864
+ # next_token: "NextToken",
1865
+ # max_results: 1,
1866
+ # })
1867
+ #
1868
+ # @example Response structure
1869
+ #
1870
+ # resp.lens_share_summaries #=> Array
1871
+ # resp.lens_share_summaries[0].share_id #=> String
1872
+ # resp.lens_share_summaries[0].shared_with #=> String
1873
+ # resp.lens_share_summaries[0].status #=> String, one of "ACCEPTED", "REJECTED", "PENDING", "REVOKED", "EXPIRED"
1874
+ # resp.next_token #=> String
1875
+ #
1876
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListLensShares AWS API Documentation
1877
+ #
1878
+ # @overload list_lens_shares(params = {})
1879
+ # @param [Hash] params ({})
1880
+ def list_lens_shares(params = {}, options = {})
1881
+ req = build_request(:list_lens_shares, params)
1882
+ req.send_request(options)
1883
+ end
1884
+
1338
1885
  # List the available lenses.
1339
1886
  #
1340
1887
  # @option params [String] :next_token
@@ -1343,6 +1890,15 @@ module Aws::WellArchitected
1343
1890
  # @option params [Integer] :max_results
1344
1891
  # The maximum number of results to return for this request.
1345
1892
  #
1893
+ # @option params [String] :lens_type
1894
+ # The type of lenses to be returned.
1895
+ #
1896
+ # @option params [String] :lens_status
1897
+ # The status of lenses to be returned.
1898
+ #
1899
+ # @option params [String] :lens_name
1900
+ # The full name of the lens.
1901
+ #
1346
1902
  # @return [Types::ListLensesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1347
1903
  #
1348
1904
  # * {Types::ListLensesOutput#lens_summaries #lens_summaries} => Array&lt;Types::LensSummary&gt;
@@ -1355,15 +1911,24 @@ module Aws::WellArchitected
1355
1911
  # resp = client.list_lenses({
1356
1912
  # next_token: "NextToken",
1357
1913
  # max_results: 1,
1914
+ # lens_type: "AWS_OFFICIAL", # accepts AWS_OFFICIAL, CUSTOM_SHARED, CUSTOM_SELF
1915
+ # lens_status: "ALL", # accepts ALL, DRAFT, PUBLISHED
1916
+ # lens_name: "LensName",
1358
1917
  # })
1359
1918
  #
1360
1919
  # @example Response structure
1361
1920
  #
1362
1921
  # resp.lens_summaries #=> Array
1922
+ # resp.lens_summaries[0].lens_arn #=> String
1363
1923
  # resp.lens_summaries[0].lens_alias #=> String
1364
- # resp.lens_summaries[0].lens_version #=> String
1365
1924
  # resp.lens_summaries[0].lens_name #=> String
1925
+ # resp.lens_summaries[0].lens_type #=> String, one of "AWS_OFFICIAL", "CUSTOM_SHARED", "CUSTOM_SELF"
1366
1926
  # resp.lens_summaries[0].description #=> String
1927
+ # resp.lens_summaries[0].created_at #=> Time
1928
+ # resp.lens_summaries[0].updated_at #=> Time
1929
+ # resp.lens_summaries[0].lens_version #=> String
1930
+ # resp.lens_summaries[0].owner #=> String
1931
+ # resp.lens_summaries[0].lens_status #=> String, one of "CURRENT", "NOT_CURRENT", "DEPRECATED", "DELETED", "UNSHARED"
1367
1932
  # resp.next_token #=> String
1368
1933
  #
1369
1934
  # @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListLenses AWS API Documentation
@@ -1378,8 +1943,8 @@ module Aws::WellArchitected
1378
1943
  # List all milestones for an existing workload.
1379
1944
  #
1380
1945
  # @option params [required, String] :workload_id
1381
- # The ID assigned to the workload. This ID is unique within an AWS
1382
- # Region.
1946
+ # The ID assigned to the workload. This ID is unique within an Amazon
1947
+ # Web Services Region.
1383
1948
  #
1384
1949
  # @option params [String] :next_token
1385
1950
  # The token to use to retrieve the next set of results.
@@ -1434,8 +1999,8 @@ module Aws::WellArchitected
1434
1999
  # List lens notifications.
1435
2000
  #
1436
2001
  # @option params [String] :workload_id
1437
- # The ID assigned to the workload. This ID is unique within an AWS
1438
- # Region.
2002
+ # The ID assigned to the workload. This ID is unique within an Amazon
2003
+ # Web Services Region.
1439
2004
  #
1440
2005
  # @option params [String] :next_token
1441
2006
  # The token to use to retrieve the next set of results.
@@ -1465,6 +2030,7 @@ module Aws::WellArchitected
1465
2030
  # resp.notification_summaries[0].lens_upgrade_summary.workload_id #=> String
1466
2031
  # resp.notification_summaries[0].lens_upgrade_summary.workload_name #=> String
1467
2032
  # resp.notification_summaries[0].lens_upgrade_summary.lens_alias #=> String
2033
+ # resp.notification_summaries[0].lens_upgrade_summary.lens_arn #=> String
1468
2034
  # resp.notification_summaries[0].lens_upgrade_summary.current_lens_version #=> String
1469
2035
  # resp.notification_summaries[0].lens_upgrade_summary.latest_lens_version #=> String
1470
2036
  # resp.next_token #=> String
@@ -1484,6 +2050,13 @@ module Aws::WellArchitected
1484
2050
  # An optional string added to the beginning of each workload name
1485
2051
  # returned in the results.
1486
2052
  #
2053
+ # @option params [String] :lens_name_prefix
2054
+ # An optional string added to the beginning of each lens name returned
2055
+ # in the results.
2056
+ #
2057
+ # @option params [String] :share_resource_type
2058
+ # The type of share invitations to be returned.
2059
+ #
1487
2060
  # @option params [String] :next_token
1488
2061
  # The token to use to retrieve the next set of results.
1489
2062
  #
@@ -1501,6 +2074,8 @@ module Aws::WellArchitected
1501
2074
  #
1502
2075
  # resp = client.list_share_invitations({
1503
2076
  # workload_name_prefix: "WorkloadNamePrefix",
2077
+ # lens_name_prefix: "LensNamePrefix",
2078
+ # share_resource_type: "WORKLOAD", # accepts WORKLOAD, LENS
1504
2079
  # next_token: "NextToken",
1505
2080
  # max_results: 1,
1506
2081
  # })
@@ -1512,8 +2087,11 @@ module Aws::WellArchitected
1512
2087
  # resp.share_invitation_summaries[0].shared_by #=> String
1513
2088
  # resp.share_invitation_summaries[0].shared_with #=> String
1514
2089
  # resp.share_invitation_summaries[0].permission_type #=> String, one of "READONLY", "CONTRIBUTOR"
2090
+ # resp.share_invitation_summaries[0].share_resource_type #=> String, one of "WORKLOAD", "LENS"
1515
2091
  # resp.share_invitation_summaries[0].workload_name #=> String
1516
2092
  # resp.share_invitation_summaries[0].workload_id #=> String
2093
+ # resp.share_invitation_summaries[0].lens_name #=> String
2094
+ # resp.share_invitation_summaries[0].lens_arn #=> String
1517
2095
  # resp.next_token #=> String
1518
2096
  #
1519
2097
  # @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListShareInvitations AWS API Documentation
@@ -1557,11 +2135,12 @@ module Aws::WellArchitected
1557
2135
  # List the workload shares associated with the workload.
1558
2136
  #
1559
2137
  # @option params [required, String] :workload_id
1560
- # The ID assigned to the workload. This ID is unique within an AWS
1561
- # Region.
2138
+ # The ID assigned to the workload. This ID is unique within an Amazon
2139
+ # Web Services Region.
1562
2140
  #
1563
2141
  # @option params [String] :shared_with_prefix
1564
- # The AWS account ID or IAM role with which the workload is shared.
2142
+ # The Amazon Web Services account ID or IAM role with which the workload
2143
+ # is shared.
1565
2144
  #
1566
2145
  # @option params [String] :next_token
1567
2146
  # The token to use to retrieve the next set of results.
@@ -1719,8 +2298,8 @@ module Aws::WellArchitected
1719
2298
  # Update the answer to a specific question in a workload review.
1720
2299
  #
1721
2300
  # @option params [required, String] :workload_id
1722
- # The ID assigned to the workload. This ID is unique within an AWS
1723
- # Region.
2301
+ # The ID assigned to the workload. This ID is unique within an Amazon
2302
+ # Web Services Region.
1724
2303
  #
1725
2304
  # @option params [required, String] :lens_alias
1726
2305
  # The alias of the lens, for example, `serverless`.
@@ -1752,6 +2331,7 @@ module Aws::WellArchitected
1752
2331
  #
1753
2332
  # * {Types::UpdateAnswerOutput#workload_id #workload_id} => String
1754
2333
  # * {Types::UpdateAnswerOutput#lens_alias #lens_alias} => String
2334
+ # * {Types::UpdateAnswerOutput#lens_arn #lens_arn} => String
1755
2335
  # * {Types::UpdateAnswerOutput#answer #answer} => Types::Answer
1756
2336
  #
1757
2337
  # @example Request syntax with placeholder values
@@ -1777,16 +2357,22 @@ module Aws::WellArchitected
1777
2357
  #
1778
2358
  # resp.workload_id #=> String
1779
2359
  # resp.lens_alias #=> String
2360
+ # resp.lens_arn #=> String
1780
2361
  # resp.answer.question_id #=> String
1781
2362
  # resp.answer.pillar_id #=> String
1782
2363
  # resp.answer.question_title #=> String
1783
2364
  # resp.answer.question_description #=> String
1784
2365
  # resp.answer.improvement_plan_url #=> String
1785
2366
  # resp.answer.helpful_resource_url #=> String
2367
+ # resp.answer.helpful_resource_display_text #=> String
1786
2368
  # resp.answer.choices #=> Array
1787
2369
  # resp.answer.choices[0].choice_id #=> String
1788
2370
  # resp.answer.choices[0].title #=> String
1789
2371
  # resp.answer.choices[0].description #=> String
2372
+ # resp.answer.choices[0].helpful_resource.display_text #=> String
2373
+ # resp.answer.choices[0].helpful_resource.url #=> String
2374
+ # resp.answer.choices[0].improvement_plan.display_text #=> String
2375
+ # resp.answer.choices[0].improvement_plan.url #=> String
1790
2376
  # resp.answer.selected_choices #=> Array
1791
2377
  # resp.answer.selected_choices[0] #=> String
1792
2378
  # resp.answer.choice_answers #=> Array
@@ -1811,8 +2397,8 @@ module Aws::WellArchitected
1811
2397
  # Update lens review.
1812
2398
  #
1813
2399
  # @option params [required, String] :workload_id
1814
- # The ID assigned to the workload. This ID is unique within an AWS
1815
- # Region.
2400
+ # The ID assigned to the workload. This ID is unique within an Amazon
2401
+ # Web Services Region.
1816
2402
  #
1817
2403
  # @option params [required, String] :lens_alias
1818
2404
  # The alias of the lens, for example, `serverless`.
@@ -1845,9 +2431,10 @@ module Aws::WellArchitected
1845
2431
  #
1846
2432
  # resp.workload_id #=> String
1847
2433
  # resp.lens_review.lens_alias #=> String
2434
+ # resp.lens_review.lens_arn #=> String
1848
2435
  # resp.lens_review.lens_version #=> String
1849
2436
  # resp.lens_review.lens_name #=> String
1850
- # resp.lens_review.lens_status #=> String, one of "CURRENT", "NOT_CURRENT", "DEPRECATED"
2437
+ # resp.lens_review.lens_status #=> String, one of "CURRENT", "NOT_CURRENT", "DEPRECATED", "DELETED", "UNSHARED"
1851
2438
  # resp.lens_review.pillar_review_summaries #=> Array
1852
2439
  # resp.lens_review.pillar_review_summaries[0].pillar_id #=> String
1853
2440
  # resp.lens_review.pillar_review_summaries[0].pillar_name #=> String
@@ -1891,7 +2478,10 @@ module Aws::WellArchitected
1891
2478
  # @example Response structure
1892
2479
  #
1893
2480
  # resp.share_invitation.share_invitation_id #=> String
2481
+ # resp.share_invitation.share_resource_type #=> String, one of "WORKLOAD", "LENS"
1894
2482
  # resp.share_invitation.workload_id #=> String
2483
+ # resp.share_invitation.lens_alias #=> String
2484
+ # resp.share_invitation.lens_arn #=> String
1895
2485
  #
1896
2486
  # @see http://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/UpdateShareInvitation AWS API Documentation
1897
2487
  #
@@ -1905,14 +2495,15 @@ module Aws::WellArchitected
1905
2495
  # Update an existing workload.
1906
2496
  #
1907
2497
  # @option params [required, String] :workload_id
1908
- # The ID assigned to the workload. This ID is unique within an AWS
1909
- # Region.
2498
+ # The ID assigned to the workload. This ID is unique within an Amazon
2499
+ # Web Services Region.
1910
2500
  #
1911
2501
  # @option params [String] :workload_name
1912
2502
  # The name of the workload.
1913
2503
  #
1914
- # The name must be unique within an account within a Region. Spaces and
1915
- # capitalization are ignored when checking for uniqueness.
2504
+ # The name must be unique within an account within an Amazon Web
2505
+ # Services Region. Spaces and capitalization are ignored when checking
2506
+ # for uniqueness.
1916
2507
  #
1917
2508
  # @option params [String] :description
1918
2509
  # The description for the workload.
@@ -1921,14 +2512,16 @@ module Aws::WellArchitected
1921
2512
  # The environment for the workload.
1922
2513
  #
1923
2514
  # @option params [Array<String>] :account_ids
1924
- # The list of AWS account IDs associated with the workload.
2515
+ # The list of Amazon Web Services account IDs associated with the
2516
+ # workload.
1925
2517
  #
1926
2518
  # @option params [Array<String>] :aws_regions
1927
- # The list of AWS Regions associated with the workload, for example,
1928
- # `us-east-2`, or `ca-central-1`.
2519
+ # The list of Amazon Web Services Regions associated with the workload,
2520
+ # for example, `us-east-2`, or `ca-central-1`.
1929
2521
  #
1930
2522
  # @option params [Array<String>] :non_aws_regions
1931
- # The list of non-AWS Regions associated with the workload.
2523
+ # The list of non-Amazon Web Services Regions associated with the
2524
+ # workload.
1932
2525
  #
1933
2526
  # @option params [Array<String>] :pillar_priorities
1934
2527
  # The priorities of the pillars, which are used to order items in the
@@ -2091,8 +2684,8 @@ module Aws::WellArchitected
2091
2684
  # The ID associated with the workload share.
2092
2685
  #
2093
2686
  # @option params [required, String] :workload_id
2094
- # The ID assigned to the workload. This ID is unique within an AWS
2095
- # Region.
2687
+ # The ID assigned to the workload. This ID is unique within an Amazon
2688
+ # Web Services Region.
2096
2689
  #
2097
2690
  # @option params [required, String] :permission_type
2098
2691
  # Permission granted on a workload share.
@@ -2133,8 +2726,8 @@ module Aws::WellArchitected
2133
2726
  # Upgrade lens review.
2134
2727
  #
2135
2728
  # @option params [required, String] :workload_id
2136
- # The ID assigned to the workload. This ID is unique within an AWS
2137
- # Region.
2729
+ # The ID assigned to the workload. This ID is unique within an Amazon
2730
+ # Web Services Region.
2138
2731
  #
2139
2732
  # @option params [required, String] :lens_alias
2140
2733
  # The alias of the lens, for example, `serverless`.
@@ -2156,9 +2749,9 @@ module Aws::WellArchitected
2156
2749
  # request is returned.
2157
2750
  #
2158
2751
  # This token is listed as required, however, if you do not specify it,
2159
- # the AWS SDKs automatically generate one for you. If you are not using
2160
- # the AWS SDK or the AWS CLI, you must provide this token or the request
2161
- # will fail.
2752
+ # the Amazon Web Services SDKs automatically generate one for you. If
2753
+ # you are not using the Amazon Web Services SDK or the CLI, you must
2754
+ # provide this token or the request will fail.
2162
2755
  #
2163
2756
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2164
2757
  #
@@ -2193,7 +2786,7 @@ module Aws::WellArchitected
2193
2786
  params: params,
2194
2787
  config: config)
2195
2788
  context[:gem_name] = 'aws-sdk-wellarchitected'
2196
- context[:gem_version] = '1.8.0'
2789
+ context[:gem_version] = '1.12.0'
2197
2790
  Seahorse::Client::Request.new(handlers, context)
2198
2791
  end
2199
2792