aws-sdk-controltower 1.12.0 → 1.13.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -10,7 +10,7 @@
10
10
  module Aws::ControlTower
11
11
  module Types
12
12
 
13
- # User does not have sufficient access to perform this action.
13
+ # You do not have sufficient access to perform this action.
14
14
  #
15
15
  # @!attribute [rw] message
16
16
  # @return [String]
@@ -71,6 +71,78 @@ module Aws::ControlTower
71
71
  include Aws::Structure
72
72
  end
73
73
 
74
+ # @!attribute [rw] manifest
75
+ # The manifest.yaml file is a text file that describes your Amazon Web
76
+ # Services resources. For examples, review [The manifest file][1].
77
+ #
78
+ #
79
+ #
80
+ # [1]: https://docs.aws.amazon.com/controltower/latest/userguide/the-manifest-file
81
+ # @return [Hash,Array,String,Numeric,Boolean]
82
+ #
83
+ # @!attribute [rw] tags
84
+ # Tags to be applied to the landing zone.
85
+ # @return [Hash<String,String>]
86
+ #
87
+ # @!attribute [rw] version
88
+ # The landing zone version.
89
+ # @return [String]
90
+ #
91
+ # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/CreateLandingZoneInput AWS API Documentation
92
+ #
93
+ class CreateLandingZoneInput < Struct.new(
94
+ :manifest,
95
+ :tags,
96
+ :version)
97
+ SENSITIVE = []
98
+ include Aws::Structure
99
+ end
100
+
101
+ # @!attribute [rw] arn
102
+ # The ARN of the landing zone.
103
+ # @return [String]
104
+ #
105
+ # @!attribute [rw] operation_identifier
106
+ # A unique identifier assigned to a `CreateLandingZone` operation. You
107
+ # can use this identifier as an input of `GetLandingZoneOperation` to
108
+ # check the operation's status.
109
+ # @return [String]
110
+ #
111
+ # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/CreateLandingZoneOutput AWS API Documentation
112
+ #
113
+ class CreateLandingZoneOutput < Struct.new(
114
+ :arn,
115
+ :operation_identifier)
116
+ SENSITIVE = []
117
+ include Aws::Structure
118
+ end
119
+
120
+ # @!attribute [rw] landing_zone_identifier
121
+ # The unique identifier of the landing zone.
122
+ # @return [String]
123
+ #
124
+ # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/DeleteLandingZoneInput AWS API Documentation
125
+ #
126
+ class DeleteLandingZoneInput < Struct.new(
127
+ :landing_zone_identifier)
128
+ SENSITIVE = []
129
+ include Aws::Structure
130
+ end
131
+
132
+ # @!attribute [rw] operation_identifier
133
+ # A unique identifier assigned to a `DeleteLandingZone` operation. You
134
+ # can use this identifier as an input of `GetLandingZoneOperation` to
135
+ # check the operation's status.
136
+ # @return [String]
137
+ #
138
+ # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/DeleteLandingZoneOutput AWS API Documentation
139
+ #
140
+ class DeleteLandingZoneOutput < Struct.new(
141
+ :operation_identifier)
142
+ SENSITIVE = []
143
+ include Aws::Structure
144
+ end
145
+
74
146
  # @!attribute [rw] control_identifier
75
147
  # The ARN of the control. Only **Strongly recommended** and
76
148
  # **Elective** controls are permitted, with the exception of the
@@ -115,10 +187,11 @@ module Aws::ControlTower
115
187
 
116
188
  # The drift summary of the enabled control.
117
189
  #
118
- # AWS Control Tower expects the enabled control configuration to include
119
- # all supported and governed Regions. If the enabled control differs
120
- # from the expected configuration, it is defined to be in a state of
121
- # drift. You can repair this drift by resetting the enabled control.
190
+ # Amazon Web Services Control Tower expects the enabled control
191
+ # configuration to include all supported and governed Regions. If the
192
+ # enabled control differs from the expected configuration, it is defined
193
+ # to be in a state of drift. You can repair this drift by resetting the
194
+ # enabled control.
122
195
  #
123
196
  # @!attribute [rw] drift_status
124
197
  # The drift status of the enabled control.
@@ -126,16 +199,19 @@ module Aws::ControlTower
126
199
  # Valid values:
127
200
  #
128
201
  # * `DRIFTED`: The `enabledControl` deployed in this configuration
129
- # doesn’t match the configuration that AWS Control Tower expected.
202
+ # doesn’t match the configuration that Amazon Web Services Control
203
+ # Tower expected.
130
204
  #
131
205
  # * `IN_SYNC`: The `enabledControl` deployed in this configuration
132
- # matches the configuration that AWS Control Tower expected.
206
+ # matches the configuration that Amazon Web Services Control Tower
207
+ # expected.
133
208
  #
134
- # * `NOT_CHECKING`: AWS Control Tower does not check drift for this
135
- # enabled control. Drift is not supported for the control type.
209
+ # * `NOT_CHECKING`: Amazon Web Services Control Tower does not check
210
+ # drift for this enabled control. Drift is not supported for the
211
+ # control type.
136
212
  #
137
- # * `UNKNOWN`: AWS Control Tower is not able to check the drift status
138
- # for the enabled control.
213
+ # * `UNKNOWN`: Amazon Web Services Control Tower is not able to check
214
+ # the drift status for the enabled control.
139
215
  # @return [String]
140
216
  #
141
217
  # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/DriftStatusSummary AWS API Documentation
@@ -231,7 +307,7 @@ module Aws::ControlTower
231
307
  # @return [String]
232
308
  #
233
309
  # @!attribute [rw] target_regions
234
- # Target AWS Regions for the enabled control.
310
+ # Target Amazon Web Services Regions for the enabled control.
235
311
  # @return [Array<Types::Region>]
236
312
  #
237
313
  # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/EnabledControlDetails AWS API Documentation
@@ -358,6 +434,54 @@ module Aws::ControlTower
358
434
  include Aws::Structure
359
435
  end
360
436
 
437
+ # @!attribute [rw] landing_zone_identifier
438
+ # The unique identifier of the landing zone.
439
+ # @return [String]
440
+ #
441
+ # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/GetLandingZoneInput AWS API Documentation
442
+ #
443
+ class GetLandingZoneInput < Struct.new(
444
+ :landing_zone_identifier)
445
+ SENSITIVE = []
446
+ include Aws::Structure
447
+ end
448
+
449
+ # @!attribute [rw] operation_identifier
450
+ # A unique identifier assigned to a landing zone operation.
451
+ # @return [String]
452
+ #
453
+ # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/GetLandingZoneOperationInput AWS API Documentation
454
+ #
455
+ class GetLandingZoneOperationInput < Struct.new(
456
+ :operation_identifier)
457
+ SENSITIVE = []
458
+ include Aws::Structure
459
+ end
460
+
461
+ # @!attribute [rw] operation_details
462
+ # The landing zone operation details.
463
+ # @return [Types::LandingZoneOperationDetail]
464
+ #
465
+ # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/GetLandingZoneOperationOutput AWS API Documentation
466
+ #
467
+ class GetLandingZoneOperationOutput < Struct.new(
468
+ :operation_details)
469
+ SENSITIVE = []
470
+ include Aws::Structure
471
+ end
472
+
473
+ # @!attribute [rw] landing_zone
474
+ # Information about the landing zone.
475
+ # @return [Types::LandingZoneDetail]
476
+ #
477
+ # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/GetLandingZoneOutput AWS API Documentation
478
+ #
479
+ class GetLandingZoneOutput < Struct.new(
480
+ :landing_zone)
481
+ SENSITIVE = []
482
+ include Aws::Structure
483
+ end
484
+
361
485
  # Unexpected error during processing of request.
362
486
  #
363
487
  # @!attribute [rw] message
@@ -371,6 +495,148 @@ module Aws::ControlTower
371
495
  include Aws::Structure
372
496
  end
373
497
 
498
+ # Information about the landing zone.
499
+ #
500
+ # @!attribute [rw] arn
501
+ # The ARN of the landing zone.
502
+ # @return [String]
503
+ #
504
+ # @!attribute [rw] drift_status
505
+ # The drift status of the landing zone.
506
+ # @return [Types::LandingZoneDriftStatusSummary]
507
+ #
508
+ # @!attribute [rw] latest_available_version
509
+ # The latest available version of the landing zone.
510
+ # @return [String]
511
+ #
512
+ # @!attribute [rw] manifest
513
+ # The landing zone manifest.yaml text file that specifies the landing
514
+ # zone configurations.
515
+ # @return [Hash,Array,String,Numeric,Boolean]
516
+ #
517
+ # @!attribute [rw] status
518
+ # The landing zone deployment status.
519
+ #
520
+ # Valid values:
521
+ #
522
+ # * `ACTIVE`: The landing zone is actively deployed.
523
+ #
524
+ # * `PROCESSING`: The landing zone is processing deployment.
525
+ #
526
+ # * `FAILED`: The landing zone failed deployment.
527
+ # @return [String]
528
+ #
529
+ # @!attribute [rw] version
530
+ # The landing zone's current deployed version.
531
+ # @return [String]
532
+ #
533
+ # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/LandingZoneDetail AWS API Documentation
534
+ #
535
+ class LandingZoneDetail < Struct.new(
536
+ :arn,
537
+ :drift_status,
538
+ :latest_available_version,
539
+ :manifest,
540
+ :status,
541
+ :version)
542
+ SENSITIVE = []
543
+ include Aws::Structure
544
+ end
545
+
546
+ # The drift status summary of the landing zone.
547
+ #
548
+ # If the landing zone differs from the expected configuration, it is
549
+ # defined to be in a state of drift. You can repair this drift by
550
+ # resetting the landing zone.
551
+ #
552
+ # @!attribute [rw] status
553
+ # The drift status of the landing zone.
554
+ #
555
+ # Valid values:
556
+ #
557
+ # * `DRIFTED`: The landing zone deployed in this configuration does
558
+ # not match the configuration that Amazon Web Services Control Tower
559
+ # expected.
560
+ #
561
+ # * `IN_SYNC`: The landing zone deployed in this configuration matches
562
+ # the configuration that Amazon Web Services Control Tower expected.
563
+ # @return [String]
564
+ #
565
+ # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/LandingZoneDriftStatusSummary AWS API Documentation
566
+ #
567
+ class LandingZoneDriftStatusSummary < Struct.new(
568
+ :status)
569
+ SENSITIVE = []
570
+ include Aws::Structure
571
+ end
572
+
573
+ # Information about a landing zone operation.
574
+ #
575
+ # @!attribute [rw] end_time
576
+ # The landing zone operation end time.
577
+ # @return [Time]
578
+ #
579
+ # @!attribute [rw] operation_type
580
+ # The landing zone operation type.
581
+ #
582
+ # Valid values:
583
+ #
584
+ # * `DELETE`: The `DeleteLandingZone` operation.
585
+ #
586
+ # * `CREATE`: The `CreateLandingZone` operation.
587
+ #
588
+ # * `UPDATE`: The `UpdateLandingZone` operation.
589
+ #
590
+ # * `RESET`: The `ResetLandingZone` operation.
591
+ # @return [String]
592
+ #
593
+ # @!attribute [rw] start_time
594
+ # The landing zone operation start time.
595
+ # @return [Time]
596
+ #
597
+ # @!attribute [rw] status
598
+ # The landing zone operation status.
599
+ #
600
+ # Valid values:
601
+ #
602
+ # * `SUCCEEDED`: The landing zone operation succeeded.
603
+ #
604
+ # * `IN_PROGRESS`: The landing zone operation is in progress.
605
+ #
606
+ # * `FAILED`: The landing zone operation failed.
607
+ # @return [String]
608
+ #
609
+ # @!attribute [rw] status_message
610
+ # If the operation result is FAILED, this string contains a message
611
+ # explaining why the operation failed.
612
+ # @return [String]
613
+ #
614
+ # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/LandingZoneOperationDetail AWS API Documentation
615
+ #
616
+ class LandingZoneOperationDetail < Struct.new(
617
+ :end_time,
618
+ :operation_type,
619
+ :start_time,
620
+ :status,
621
+ :status_message)
622
+ SENSITIVE = []
623
+ include Aws::Structure
624
+ end
625
+
626
+ # Returns a summary of information about a landing zone.
627
+ #
628
+ # @!attribute [rw] arn
629
+ # The ARN of the landing zone.
630
+ # @return [String]
631
+ #
632
+ # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/LandingZoneSummary AWS API Documentation
633
+ #
634
+ class LandingZoneSummary < Struct.new(
635
+ :arn)
636
+ SENSITIVE = []
637
+ include Aws::Structure
638
+ end
639
+
374
640
  # @!attribute [rw] max_results
375
641
  # How many results to return per API call.
376
642
  # @return [Integer]
@@ -400,8 +666,8 @@ module Aws::ControlTower
400
666
  end
401
667
 
402
668
  # @!attribute [rw] enabled_controls
403
- # Lists the controls enabled by AWS Control Tower on the specified
404
- # organizational unit and the accounts it contains.
669
+ # Lists the controls enabled by Amazon Web Services Control Tower on
670
+ # the specified organizational unit and the accounts it contains.
405
671
  # @return [Array<Types::EnabledControlSummary>]
406
672
  #
407
673
  # @!attribute [rw] next_token
@@ -418,6 +684,42 @@ module Aws::ControlTower
418
684
  include Aws::Structure
419
685
  end
420
686
 
687
+ # @!attribute [rw] max_results
688
+ # The maximum number of returned landing zone ARNs.
689
+ # @return [Integer]
690
+ #
691
+ # @!attribute [rw] next_token
692
+ # The token to continue the list from a previous API call with the
693
+ # same parameters.
694
+ # @return [String]
695
+ #
696
+ # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/ListLandingZonesInput AWS API Documentation
697
+ #
698
+ class ListLandingZonesInput < Struct.new(
699
+ :max_results,
700
+ :next_token)
701
+ SENSITIVE = []
702
+ include Aws::Structure
703
+ end
704
+
705
+ # @!attribute [rw] landing_zones
706
+ # The ARN of the landing zone.
707
+ # @return [Array<Types::LandingZoneSummary>]
708
+ #
709
+ # @!attribute [rw] next_token
710
+ # Retrieves the next page of results. If the string is empty, the
711
+ # current response is the end of the results.
712
+ # @return [String]
713
+ #
714
+ # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/ListLandingZonesOutput AWS API Documentation
715
+ #
716
+ class ListLandingZonesOutput < Struct.new(
717
+ :landing_zones,
718
+ :next_token)
719
+ SENSITIVE = []
720
+ include Aws::Structure
721
+ end
722
+
421
723
  # @!attribute [rw] resource_arn
422
724
  # The ARN of the resource.
423
725
  # @return [String]
@@ -442,8 +744,8 @@ module Aws::ControlTower
442
744
  include Aws::Structure
443
745
  end
444
746
 
445
- # An AWS Region in which AWS Control Tower expects to find the control
446
- # deployed.
747
+ # An Amazon Web Services Region in which Amazon Web Services Control
748
+ # Tower expects to find the control deployed.
447
749
  #
448
750
  # The expected Regions are based on the Regions that are governed by the
449
751
  # landing zone. In certain cases, a control is not actually enabled in
@@ -455,7 +757,7 @@ module Aws::ControlTower
455
757
  # [1]: https://docs.aws.amazon.com/controltower/latest/userguide/region-how.html#mixed-governance
456
758
  #
457
759
  # @!attribute [rw] name
458
- # The AWS Region name.
760
+ # The Amazon Web Services Region name.
459
761
  # @return [String]
460
762
  #
461
763
  # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/Region AWS API Documentation
@@ -466,6 +768,32 @@ module Aws::ControlTower
466
768
  include Aws::Structure
467
769
  end
468
770
 
771
+ # @!attribute [rw] landing_zone_identifier
772
+ # The unique identifier of the landing zone.
773
+ # @return [String]
774
+ #
775
+ # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/ResetLandingZoneInput AWS API Documentation
776
+ #
777
+ class ResetLandingZoneInput < Struct.new(
778
+ :landing_zone_identifier)
779
+ SENSITIVE = []
780
+ include Aws::Structure
781
+ end
782
+
783
+ # @!attribute [rw] operation_identifier
784
+ # A unique identifier assigned to a `ResetLandingZone` operation. You
785
+ # can use this identifier as an input of `GetLandingZoneOperation` to
786
+ # check the operation's status.
787
+ # @return [String]
788
+ #
789
+ # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/ResetLandingZoneOutput AWS API Documentation
790
+ #
791
+ class ResetLandingZoneOutput < Struct.new(
792
+ :operation_identifier)
793
+ SENSITIVE = []
794
+ include Aws::Structure
795
+ end
796
+
469
797
  # Request references a resource which does not exist.
470
798
  #
471
799
  # @!attribute [rw] message
@@ -563,8 +891,49 @@ module Aws::ControlTower
563
891
  #
564
892
  class UntagResourceOutput < Aws::EmptyStructure; end
565
893
 
566
- # The input fails to satisfy the constraints specified by an AWS
567
- # service.
894
+ # @!attribute [rw] landing_zone_identifier
895
+ # The unique identifier of the landing zone.
896
+ # @return [String]
897
+ #
898
+ # @!attribute [rw] manifest
899
+ # The manifest.yaml file is a text file that describes your Amazon Web
900
+ # Services resources. For examples, review [The manifest file][1]
901
+ #
902
+ #
903
+ #
904
+ # [1]: https://docs.aws.amazon.com/controltower/latest/userguide/the-manifest-file
905
+ # @return [Hash,Array,String,Numeric,Boolean]
906
+ #
907
+ # @!attribute [rw] version
908
+ # The landing zone version.
909
+ # @return [String]
910
+ #
911
+ # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/UpdateLandingZoneInput AWS API Documentation
912
+ #
913
+ class UpdateLandingZoneInput < Struct.new(
914
+ :landing_zone_identifier,
915
+ :manifest,
916
+ :version)
917
+ SENSITIVE = []
918
+ include Aws::Structure
919
+ end
920
+
921
+ # @!attribute [rw] operation_identifier
922
+ # A unique identifier assigned to a `UpdateLandingZone` operation. You
923
+ # can use this identifier as an input of `GetLandingZoneOperation` to
924
+ # check the operation's status.
925
+ # @return [String]
926
+ #
927
+ # @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/UpdateLandingZoneOutput AWS API Documentation
928
+ #
929
+ class UpdateLandingZoneOutput < Struct.new(
930
+ :operation_identifier)
931
+ SENSITIVE = []
932
+ include Aws::Structure
933
+ end
934
+
935
+ # The input fails to satisfy the constraints specified by an Amazon Web
936
+ # Services service.
568
937
  #
569
938
  # @!attribute [rw] message
570
939
  # @return [String]
@@ -32,7 +32,7 @@ require_relative 'aws-sdk-controltower/customizations'
32
32
  # structure.
33
33
  #
34
34
  # control_tower = Aws::ControlTower::Client.new
35
- # resp = control_tower.disable_control(params)
35
+ # resp = control_tower.create_landing_zone(params)
36
36
  #
37
37
  # See {Client} for more information.
38
38
  #
@@ -52,6 +52,6 @@ require_relative 'aws-sdk-controltower/customizations'
52
52
  # @!group service
53
53
  module Aws::ControlTower
54
54
 
55
- GEM_VERSION = '1.12.0'
55
+ GEM_VERSION = '1.13.0'
56
56
 
57
57
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-controltower
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.12.0
4
+ version: 1.13.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-11-22 00:00:00.000000000 Z
11
+ date: 2023-11-27 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core