aws-sdk-controltower 1.11.0 → 1.13.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 4a3aa67695d6e0f0ee8cc3f70eae34f700ed760a9569b962da3b197781d6fe6f
4
- data.tar.gz: 587639ea3f15464a4517f32278cc27d610952452c254cc4e7f2f5b0125f77f35
3
+ metadata.gz: '01068a7d69e7cfce4651d37296c14de38dc9bbb891cfe5c1c35f4d2aa32f1fff'
4
+ data.tar.gz: e4df49d011371aabf701df509be82704c56c698257af82a7ef24664e11b4ce50
5
5
  SHA512:
6
- metadata.gz: 9c34002ebcfa9aa3f8904ee6bb976c3a53e54d1c084c55ac212a2abf0e5dfdbd518d1c0335ff62552d8e85bf901a011b4d091ffbccabbe3e3cca69446de639fe
7
- data.tar.gz: 913cc819e0f644b7af70dab0b334fe5c8f5f85a0ea7d71c0dae94ee1b80190cca972a37a8daa30a6bbf74a843617f6520fc4b850ce5b6c2f56a63d292298c139
6
+ metadata.gz: 499bf6a89d21c53a832d3d69d3e21048520c79e05f00d5d1097dcf35477ab1b394bff23dfc294565364c8bb7a4dfadeb16bd6a4bdd0cb3b6a60f57435b26b7d3
7
+ data.tar.gz: ef6b264490f8ca513de8630629860f32ad25340d90519440d84f71cbee2954274fc332cf4e2b59b176c22abc6680a718006e52b2cfccbe16551b5dfd76c1a7c1
data/CHANGELOG.md CHANGED
@@ -1,6 +1,16 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.13.0 (2023-11-27)
5
+ ------------------
6
+
7
+ * Feature - Add APIs to create and manage a landing zone.
8
+
9
+ 1.12.0 (2023-11-22)
10
+ ------------------
11
+
12
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
13
+
4
14
  1.11.0 (2023-11-10)
5
15
  ------------------
6
16
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.11.0
1
+ 1.13.0
@@ -388,11 +388,94 @@ module Aws::ControlTower
388
388
 
389
389
  # @!group API Operations
390
390
 
391
+ # Creates a new landing zone. This starts an asynchronous operation that
392
+ # creates and configures a landing zone based on the parameters
393
+ # specified in the manifest JSON file.
394
+ #
395
+ # @option params [required, Hash,Array,String,Numeric,Boolean] :manifest
396
+ # The manifest.yaml file is a text file that describes your Amazon Web
397
+ # Services resources. For examples, review [The manifest file][1].
398
+ #
399
+ # Document type used to carry open content
400
+ # (Hash,Array,String,Numeric,Boolean). A document type value is
401
+ # serialized using the same format as its surroundings and requires no
402
+ # additional encoding or escaping.
403
+ #
404
+ #
405
+ #
406
+ # [1]: https://docs.aws.amazon.com/controltower/latest/userguide/the-manifest-file
407
+ #
408
+ # @option params [Hash<String,String>] :tags
409
+ # Tags to be applied to the landing zone.
410
+ #
411
+ # @option params [required, String] :version
412
+ # The landing zone version.
413
+ #
414
+ # @return [Types::CreateLandingZoneOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
415
+ #
416
+ # * {Types::CreateLandingZoneOutput#arn #arn} => String
417
+ # * {Types::CreateLandingZoneOutput#operation_identifier #operation_identifier} => String
418
+ #
419
+ # @example Request syntax with placeholder values
420
+ #
421
+ # resp = client.create_landing_zone({
422
+ # manifest: { # required
423
+ # },
424
+ # tags: {
425
+ # "TagKey" => "TagValue",
426
+ # },
427
+ # version: "LandingZoneVersion", # required
428
+ # })
429
+ #
430
+ # @example Response structure
431
+ #
432
+ # resp.arn #=> String
433
+ # resp.operation_identifier #=> String
434
+ #
435
+ # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/CreateLandingZone AWS API Documentation
436
+ #
437
+ # @overload create_landing_zone(params = {})
438
+ # @param [Hash] params ({})
439
+ def create_landing_zone(params = {}, options = {})
440
+ req = build_request(:create_landing_zone, params)
441
+ req.send_request(options)
442
+ end
443
+
444
+ # This decommissions a landing zone. This starts an asynchronous
445
+ # operation that deletes Amazon Web Services Control Tower resources
446
+ # deployed in Amazon Web Services Control Tower managed accounts.
447
+ #
448
+ # @option params [required, String] :landing_zone_identifier
449
+ # The unique identifier of the landing zone.
450
+ #
451
+ # @return [Types::DeleteLandingZoneOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
452
+ #
453
+ # * {Types::DeleteLandingZoneOutput#operation_identifier #operation_identifier} => String
454
+ #
455
+ # @example Request syntax with placeholder values
456
+ #
457
+ # resp = client.delete_landing_zone({
458
+ # landing_zone_identifier: "String", # required
459
+ # })
460
+ #
461
+ # @example Response structure
462
+ #
463
+ # resp.operation_identifier #=> String
464
+ #
465
+ # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/DeleteLandingZone AWS API Documentation
466
+ #
467
+ # @overload delete_landing_zone(params = {})
468
+ # @param [Hash] params ({})
469
+ def delete_landing_zone(params = {}, options = {})
470
+ req = build_request(:delete_landing_zone, params)
471
+ req.send_request(options)
472
+ end
473
+
391
474
  # This API call turns off a control. It starts an asynchronous operation
392
- # that deletes AWS resources on the specified organizational unit and
393
- # the accounts it contains. The resources will vary according to the
394
- # control that you specify. For usage examples, see [ *the AWS Control
395
- # Tower User Guide* ][1].
475
+ # that deletes Amazon Web Services resources on the specified
476
+ # organizational unit and the accounts it contains. The resources will
477
+ # vary according to the control that you specify. For usage examples,
478
+ # see [ *the Amazon Web Services Control Tower User Guide* ][1].
396
479
  #
397
480
  #
398
481
  #
@@ -441,10 +524,11 @@ module Aws::ControlTower
441
524
  end
442
525
 
443
526
  # This API call activates a control. It starts an asynchronous operation
444
- # that creates AWS resources on the specified organizational unit and
445
- # the accounts it contains. The resources created will vary according to
446
- # the control that you specify. For usage examples, see [ *the AWS
447
- # Control Tower User Guide* ][1].
527
+ # that creates Amazon Web Services resources on the specified
528
+ # organizational unit and the accounts it contains. The resources
529
+ # created will vary according to the control that you specify. For usage
530
+ # examples, see [ *the Amazon Web Services Control Tower User Guide*
531
+ # ][1].
448
532
  #
449
533
  #
450
534
  #
@@ -503,7 +587,7 @@ module Aws::ControlTower
503
587
  # Returns the status of a particular `EnableControl` or `DisableControl`
504
588
  # operation. Displays a message in case of error. Details for an
505
589
  # operation are available for 90 days. For usage examples, see [ *the
506
- # AWS Control Tower User Guide* ][1].
590
+ # Amazon Web Services Control Tower User Guide* ][1].
507
591
  #
508
592
  #
509
593
  #
@@ -541,7 +625,7 @@ module Aws::ControlTower
541
625
  end
542
626
 
543
627
  # Retrieves details about an enabled control. For usage examples, see [
544
- # *the AWS Control Tower User Guide* ][1].
628
+ # *the Amazon Web Services Control Tower User Guide* ][1].
545
629
  #
546
630
  #
547
631
  #
@@ -580,9 +664,76 @@ module Aws::ControlTower
580
664
  req.send_request(options)
581
665
  end
582
666
 
583
- # Lists the controls enabled by AWS Control Tower on the specified
584
- # organizational unit and the accounts it contains. For usage examples,
585
- # see [ *the AWS Control Tower User Guide* ][1].
667
+ # Returns details about the landing zone. Displays a message in case of
668
+ # error.
669
+ #
670
+ # @option params [required, String] :landing_zone_identifier
671
+ # The unique identifier of the landing zone.
672
+ #
673
+ # @return [Types::GetLandingZoneOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
674
+ #
675
+ # * {Types::GetLandingZoneOutput#landing_zone #landing_zone} => Types::LandingZoneDetail
676
+ #
677
+ # @example Request syntax with placeholder values
678
+ #
679
+ # resp = client.get_landing_zone({
680
+ # landing_zone_identifier: "String", # required
681
+ # })
682
+ #
683
+ # @example Response structure
684
+ #
685
+ # resp.landing_zone.arn #=> String
686
+ # resp.landing_zone.drift_status.status #=> String, one of "DRIFTED", "IN_SYNC"
687
+ # resp.landing_zone.latest_available_version #=> String
688
+ # resp.landing_zone.status #=> String, one of "ACTIVE", "PROCESSING", "FAILED"
689
+ # resp.landing_zone.version #=> String
690
+ #
691
+ # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/GetLandingZone AWS API Documentation
692
+ #
693
+ # @overload get_landing_zone(params = {})
694
+ # @param [Hash] params ({})
695
+ def get_landing_zone(params = {}, options = {})
696
+ req = build_request(:get_landing_zone, params)
697
+ req.send_request(options)
698
+ end
699
+
700
+ # Returns the status of the specified landing zone operation. Details
701
+ # for an operation are available for X days.
702
+ #
703
+ # @option params [required, String] :operation_identifier
704
+ # A unique identifier assigned to a landing zone operation.
705
+ #
706
+ # @return [Types::GetLandingZoneOperationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
707
+ #
708
+ # * {Types::GetLandingZoneOperationOutput#operation_details #operation_details} => Types::LandingZoneOperationDetail
709
+ #
710
+ # @example Request syntax with placeholder values
711
+ #
712
+ # resp = client.get_landing_zone_operation({
713
+ # operation_identifier: "OperationIdentifier", # required
714
+ # })
715
+ #
716
+ # @example Response structure
717
+ #
718
+ # resp.operation_details.end_time #=> Time
719
+ # resp.operation_details.operation_type #=> String, one of "DELETE", "CREATE", "UPDATE", "RESET"
720
+ # resp.operation_details.start_time #=> Time
721
+ # resp.operation_details.status #=> String, one of "SUCCEEDED", "FAILED", "IN_PROGRESS"
722
+ # resp.operation_details.status_message #=> String
723
+ #
724
+ # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/GetLandingZoneOperation AWS API Documentation
725
+ #
726
+ # @overload get_landing_zone_operation(params = {})
727
+ # @param [Hash] params ({})
728
+ def get_landing_zone_operation(params = {}, options = {})
729
+ req = build_request(:get_landing_zone_operation, params)
730
+ req.send_request(options)
731
+ end
732
+
733
+ # Lists the controls enabled by Amazon Web Services Control Tower on the
734
+ # specified organizational unit and the accounts it contains. For usage
735
+ # examples, see [ *the Amazon Web Services Control Tower User Guide*
736
+ # ][1].
586
737
  #
587
738
  #
588
739
  #
@@ -638,8 +789,51 @@ module Aws::ControlTower
638
789
  req.send_request(options)
639
790
  end
640
791
 
792
+ # Returns the landing zone ARN for the landing zone deployed in your
793
+ # managed account. This API also creates an ARN for existing accounts
794
+ # that do not yet have a landing zone ARN.
795
+ #
796
+ # The return limit is one landing zone ARN.
797
+ #
798
+ # @option params [Integer] :max_results
799
+ # The maximum number of returned landing zone ARNs.
800
+ #
801
+ # @option params [String] :next_token
802
+ # The token to continue the list from a previous API call with the same
803
+ # parameters.
804
+ #
805
+ # @return [Types::ListLandingZonesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
806
+ #
807
+ # * {Types::ListLandingZonesOutput#landing_zones #landing_zones} => Array&lt;Types::LandingZoneSummary&gt;
808
+ # * {Types::ListLandingZonesOutput#next_token #next_token} => String
809
+ #
810
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
811
+ #
812
+ # @example Request syntax with placeholder values
813
+ #
814
+ # resp = client.list_landing_zones({
815
+ # max_results: 1,
816
+ # next_token: "String",
817
+ # })
818
+ #
819
+ # @example Response structure
820
+ #
821
+ # resp.landing_zones #=> Array
822
+ # resp.landing_zones[0].arn #=> String
823
+ # resp.next_token #=> String
824
+ #
825
+ # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/ListLandingZones AWS API Documentation
826
+ #
827
+ # @overload list_landing_zones(params = {})
828
+ # @param [Hash] params ({})
829
+ def list_landing_zones(params = {}, options = {})
830
+ req = build_request(:list_landing_zones, params)
831
+ req.send_request(options)
832
+ end
833
+
641
834
  # Returns a list of tags associated with the resource. For usage
642
- # examples, see [ *the AWS Control Tower User Guide* ][1].
835
+ # examples, see [ *the Amazon Web Services Control Tower User Guide*
836
+ # ][1].
643
837
  #
644
838
  #
645
839
  #
@@ -672,8 +866,38 @@ module Aws::ControlTower
672
866
  req.send_request(options)
673
867
  end
674
868
 
675
- # Applies tags to a resource. For usage examples, see [ *the AWS Control
676
- # Tower User Guide* ][1].
869
+ # This API call resets a landing zone. It starts an asynchronous
870
+ # operation that resets the landing zone to the parameters specified in
871
+ # its original configuration.
872
+ #
873
+ # @option params [required, String] :landing_zone_identifier
874
+ # The unique identifier of the landing zone.
875
+ #
876
+ # @return [Types::ResetLandingZoneOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
877
+ #
878
+ # * {Types::ResetLandingZoneOutput#operation_identifier #operation_identifier} => String
879
+ #
880
+ # @example Request syntax with placeholder values
881
+ #
882
+ # resp = client.reset_landing_zone({
883
+ # landing_zone_identifier: "String", # required
884
+ # })
885
+ #
886
+ # @example Response structure
887
+ #
888
+ # resp.operation_identifier #=> String
889
+ #
890
+ # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/ResetLandingZone AWS API Documentation
891
+ #
892
+ # @overload reset_landing_zone(params = {})
893
+ # @param [Hash] params ({})
894
+ def reset_landing_zone(params = {}, options = {})
895
+ req = build_request(:reset_landing_zone, params)
896
+ req.send_request(options)
897
+ end
898
+
899
+ # Applies tags to a resource. For usage examples, see [ *the Amazon Web
900
+ # Services Control Tower User Guide* ][1].
677
901
  #
678
902
  #
679
903
  #
@@ -705,8 +929,8 @@ module Aws::ControlTower
705
929
  req.send_request(options)
706
930
  end
707
931
 
708
- # Removes tags from a resource. For usage examples, see [ *the AWS
709
- # Control Tower User Guide* ][1].
932
+ # Removes tags from a resource. For usage examples, see [ *the Amazon
933
+ # Web Services Control Tower User Guide* ][1].
710
934
  #
711
935
  #
712
936
  #
@@ -736,6 +960,56 @@ module Aws::ControlTower
736
960
  req.send_request(options)
737
961
  end
738
962
 
963
+ # This API call updates the landing zone. It starts an asynchronous
964
+ # operation that updates the landing zone based on the new landing zone
965
+ # version or the updated parameters specified in the updated manifest
966
+ # file.
967
+ #
968
+ # @option params [required, String] :landing_zone_identifier
969
+ # The unique identifier of the landing zone.
970
+ #
971
+ # @option params [required, Hash,Array,String,Numeric,Boolean] :manifest
972
+ # The manifest.yaml file is a text file that describes your Amazon Web
973
+ # Services resources. For examples, review [The manifest file][1]
974
+ #
975
+ # Document type used to carry open content
976
+ # (Hash,Array,String,Numeric,Boolean). A document type value is
977
+ # serialized using the same format as its surroundings and requires no
978
+ # additional encoding or escaping.
979
+ #
980
+ #
981
+ #
982
+ # [1]: https://docs.aws.amazon.com/controltower/latest/userguide/the-manifest-file
983
+ #
984
+ # @option params [required, String] :version
985
+ # The landing zone version.
986
+ #
987
+ # @return [Types::UpdateLandingZoneOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
988
+ #
989
+ # * {Types::UpdateLandingZoneOutput#operation_identifier #operation_identifier} => String
990
+ #
991
+ # @example Request syntax with placeholder values
992
+ #
993
+ # resp = client.update_landing_zone({
994
+ # landing_zone_identifier: "String", # required
995
+ # manifest: { # required
996
+ # },
997
+ # version: "LandingZoneVersion", # required
998
+ # })
999
+ #
1000
+ # @example Response structure
1001
+ #
1002
+ # resp.operation_identifier #=> String
1003
+ #
1004
+ # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/UpdateLandingZone AWS API Documentation
1005
+ #
1006
+ # @overload update_landing_zone(params = {})
1007
+ # @param [Hash] params ({})
1008
+ def update_landing_zone(params = {}, options = {})
1009
+ req = build_request(:update_landing_zone, params)
1010
+ req.send_request(options)
1011
+ end
1012
+
739
1013
  # @!endgroup
740
1014
 
741
1015
  # @param params ({})
@@ -749,7 +1023,7 @@ module Aws::ControlTower
749
1023
  params: params,
750
1024
  config: config)
751
1025
  context[:gem_name] = 'aws-sdk-controltower'
752
- context[:gem_version] = '1.11.0'
1026
+ context[:gem_version] = '1.13.0'
753
1027
  Seahorse::Client::Request.new(handlers, context)
754
1028
  end
755
1029