aws-sdk-controltower 1.17.0 → 1.19.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-controltower/client.rb +452 -65
- data/lib/aws-sdk-controltower/client_api.rb +294 -0
- data/lib/aws-sdk-controltower/endpoints.rb +126 -0
- data/lib/aws-sdk-controltower/plugins/endpoints.rb +18 -0
- data/lib/aws-sdk-controltower/types.rb +530 -23
- data/lib/aws-sdk-controltower.rb +1 -1
- data/sig/client.rbs +119 -0
- data/sig/types.rbs +158 -0
- metadata +4 -4
@@ -22,6 +22,7 @@ require 'aws-sdk-core/plugins/endpoint_pattern.rb'
|
|
22
22
|
require 'aws-sdk-core/plugins/response_paging.rb'
|
23
23
|
require 'aws-sdk-core/plugins/stub_responses.rb'
|
24
24
|
require 'aws-sdk-core/plugins/idempotency_token.rb'
|
25
|
+
require 'aws-sdk-core/plugins/invocation_id.rb'
|
25
26
|
require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
26
27
|
require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
27
28
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
@@ -72,6 +73,7 @@ module Aws::ControlTower
|
|
72
73
|
add_plugin(Aws::Plugins::ResponsePaging)
|
73
74
|
add_plugin(Aws::Plugins::StubResponses)
|
74
75
|
add_plugin(Aws::Plugins::IdempotencyToken)
|
76
|
+
add_plugin(Aws::Plugins::InvocationId)
|
75
77
|
add_plugin(Aws::Plugins::JsonvalueConverter)
|
76
78
|
add_plugin(Aws::Plugins::ClientMetricsPlugin)
|
77
79
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
@@ -196,10 +198,17 @@ module Aws::ControlTower
|
|
196
198
|
# When set to 'true' the request body will not be compressed
|
197
199
|
# for supported operations.
|
198
200
|
#
|
199
|
-
# @option options [String] :endpoint
|
200
|
-
#
|
201
|
-
#
|
202
|
-
#
|
201
|
+
# @option options [String, URI::HTTPS, URI::HTTP] :endpoint
|
202
|
+
# Normally you should not configure the `:endpoint` option
|
203
|
+
# directly. This is normally constructed from the `:region`
|
204
|
+
# option. Configuring `:endpoint` is normally reserved for
|
205
|
+
# connecting to test or custom endpoints. The endpoint should
|
206
|
+
# be a URI formatted like:
|
207
|
+
#
|
208
|
+
# 'http://example.com'
|
209
|
+
# 'https://example.com'
|
210
|
+
# 'http://example.com:123'
|
211
|
+
#
|
203
212
|
#
|
204
213
|
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
205
214
|
# Used for the maximum size limit of the LRU cache storing endpoints data
|
@@ -337,50 +346,65 @@ module Aws::ControlTower
|
|
337
346
|
# @option options [Aws::ControlTower::EndpointProvider] :endpoint_provider
|
338
347
|
# The endpoint provider used to resolve endpoints. Any object that responds to `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::ControlTower::EndpointParameters`
|
339
348
|
#
|
340
|
-
# @option options [
|
341
|
-
#
|
342
|
-
#
|
343
|
-
#
|
344
|
-
#
|
345
|
-
#
|
346
|
-
#
|
347
|
-
#
|
348
|
-
#
|
349
|
-
#
|
350
|
-
#
|
351
|
-
# @option options [Float] :
|
352
|
-
#
|
353
|
-
#
|
354
|
-
#
|
355
|
-
#
|
356
|
-
#
|
357
|
-
#
|
358
|
-
#
|
359
|
-
#
|
360
|
-
#
|
361
|
-
#
|
362
|
-
#
|
363
|
-
#
|
364
|
-
#
|
365
|
-
#
|
366
|
-
#
|
367
|
-
#
|
349
|
+
# @option options [Float] :http_continue_timeout (1)
|
350
|
+
# The number of seconds to wait for a 100-continue response before sending the
|
351
|
+
# request body. This option has no effect unless the request has "Expect"
|
352
|
+
# header set to "100-continue". Defaults to `nil` which disables this
|
353
|
+
# behaviour. This value can safely be set per request on the session.
|
354
|
+
#
|
355
|
+
# @option options [Float] :http_idle_timeout (5)
|
356
|
+
# The number of seconds a connection is allowed to sit idle before it
|
357
|
+
# is considered stale. Stale connections are closed and removed from the
|
358
|
+
# pool before making a request.
|
359
|
+
#
|
360
|
+
# @option options [Float] :http_open_timeout (15)
|
361
|
+
# The default number of seconds to wait for response data.
|
362
|
+
# This value can safely be set per-request on the session.
|
363
|
+
#
|
364
|
+
# @option options [URI::HTTP,String] :http_proxy
|
365
|
+
# A proxy to send requests through. Formatted like 'http://proxy.com:123'.
|
366
|
+
#
|
367
|
+
# @option options [Float] :http_read_timeout (60)
|
368
|
+
# The default number of seconds to wait for response data.
|
369
|
+
# This value can safely be set per-request on the session.
|
370
|
+
#
|
371
|
+
# @option options [Boolean] :http_wire_trace (false)
|
372
|
+
# When `true`, HTTP debug output will be sent to the `:logger`.
|
373
|
+
#
|
374
|
+
# @option options [Proc] :on_chunk_received
|
375
|
+
# When a Proc object is provided, it will be used as callback when each chunk
|
376
|
+
# of the response body is received. It provides three arguments: the chunk,
|
377
|
+
# the number of bytes received, and the total number of
|
378
|
+
# bytes in the response (or nil if the server did not send a `content-length`).
|
379
|
+
#
|
380
|
+
# @option options [Proc] :on_chunk_sent
|
381
|
+
# When a Proc object is provided, it will be used as callback when each chunk
|
382
|
+
# of the request body is sent. It provides three arguments: the chunk,
|
383
|
+
# the number of bytes read from the body, and the total number of
|
384
|
+
# bytes in the body.
|
385
|
+
#
|
386
|
+
# @option options [Boolean] :raise_response_errors (true)
|
387
|
+
# When `true`, response errors are raised.
|
388
|
+
#
|
389
|
+
# @option options [String] :ssl_ca_bundle
|
390
|
+
# Full path to the SSL certificate authority bundle file that should be used when
|
391
|
+
# verifying peer certificates. If you do not pass `:ssl_ca_bundle` or
|
392
|
+
# `:ssl_ca_directory` the the system default will be used if available.
|
393
|
+
#
|
394
|
+
# @option options [String] :ssl_ca_directory
|
395
|
+
# Full path of the directory that contains the unbundled SSL certificate
|
396
|
+
# authority files for verifying peer certificates. If you do
|
397
|
+
# not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the system
|
398
|
+
# default will be used if available.
|
368
399
|
#
|
369
|
-
# @option options [
|
370
|
-
#
|
371
|
-
# connection.
|
400
|
+
# @option options [String] :ssl_ca_store
|
401
|
+
# Sets the X509::Store to verify peer certificate.
|
372
402
|
#
|
373
|
-
# @option options [
|
374
|
-
#
|
375
|
-
# verifying peer certificates. If you do not pass
|
376
|
-
# `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
|
377
|
-
# will be used if available.
|
403
|
+
# @option options [Float] :ssl_timeout
|
404
|
+
# Sets the SSL timeout in seconds
|
378
405
|
#
|
379
|
-
# @option options [
|
380
|
-
#
|
381
|
-
# authority files for verifying peer certificates. If you do
|
382
|
-
# not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
|
383
|
-
# system default will be used if available.
|
406
|
+
# @option options [Boolean] :ssl_verify_peer (true)
|
407
|
+
# When `true`, SSL peer certificates are verified when establishing a connection.
|
384
408
|
#
|
385
409
|
def initialize(*args)
|
386
410
|
super
|
@@ -393,9 +417,8 @@ module Aws::ControlTower
|
|
393
417
|
# parameters specified in the manifest JSON file.
|
394
418
|
#
|
395
419
|
# @option params [required, Hash,Array,String,Numeric,Boolean] :manifest
|
396
|
-
# The manifest
|
397
|
-
# Services resources. For examples, review [
|
398
|
-
# zone][1].
|
420
|
+
# The manifest.yaml file is a text file that describes your Amazon Web
|
421
|
+
# Services resources. For examples, review [The manifest file][1].
|
399
422
|
#
|
400
423
|
# Document type used to carry open content
|
401
424
|
# (Hash,Array,String,Numeric,Boolean). A document type value is
|
@@ -404,7 +427,7 @@ module Aws::ControlTower
|
|
404
427
|
#
|
405
428
|
#
|
406
429
|
#
|
407
|
-
# [1]: https://docs.aws.amazon.com/controltower/latest/userguide/
|
430
|
+
# [1]: https://docs.aws.amazon.com/controltower/latest/userguide/the-manifest-file
|
408
431
|
#
|
409
432
|
# @option params [Hash<String,String>] :tags
|
410
433
|
# Tags to be applied to the landing zone.
|
@@ -472,11 +495,43 @@ module Aws::ControlTower
|
|
472
495
|
req.send_request(options)
|
473
496
|
end
|
474
497
|
|
498
|
+
# Disable an `EnabledBaseline` resource on the specified Target. This
|
499
|
+
# API starts an asynchronous operation to remove all resources deployed
|
500
|
+
# as part of the baseline enablement. The resource will vary depending
|
501
|
+
# on the enabled baseline.
|
502
|
+
#
|
503
|
+
# @option params [required, String] :enabled_baseline_identifier
|
504
|
+
# Identifier of the `EnabledBaseline` resource to be deactivated, in ARN
|
505
|
+
# format.
|
506
|
+
#
|
507
|
+
# @return [Types::DisableBaselineOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
508
|
+
#
|
509
|
+
# * {Types::DisableBaselineOutput#operation_identifier #operation_identifier} => String
|
510
|
+
#
|
511
|
+
# @example Request syntax with placeholder values
|
512
|
+
#
|
513
|
+
# resp = client.disable_baseline({
|
514
|
+
# enabled_baseline_identifier: "Arn", # required
|
515
|
+
# })
|
516
|
+
#
|
517
|
+
# @example Response structure
|
518
|
+
#
|
519
|
+
# resp.operation_identifier #=> String
|
520
|
+
#
|
521
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/DisableBaseline AWS API Documentation
|
522
|
+
#
|
523
|
+
# @overload disable_baseline(params = {})
|
524
|
+
# @param [Hash] params ({})
|
525
|
+
def disable_baseline(params = {}, options = {})
|
526
|
+
req = build_request(:disable_baseline, params)
|
527
|
+
req.send_request(options)
|
528
|
+
end
|
529
|
+
|
475
530
|
# This API call turns off a control. It starts an asynchronous operation
|
476
|
-
# that deletes
|
477
|
-
#
|
478
|
-
#
|
479
|
-
#
|
531
|
+
# that deletes AWS resources on the specified organizational unit and
|
532
|
+
# the accounts it contains. The resources will vary according to the
|
533
|
+
# control that you specify. For usage examples, see [ *the Amazon Web
|
534
|
+
# Services Control Tower User Guide* ][1].
|
480
535
|
#
|
481
536
|
#
|
482
537
|
#
|
@@ -484,9 +539,9 @@ module Aws::ControlTower
|
|
484
539
|
#
|
485
540
|
# @option params [required, String] :control_identifier
|
486
541
|
# The ARN of the control. Only **Strongly recommended** and **Elective**
|
487
|
-
# controls are permitted, with the exception of the **
|
488
|
-
#
|
489
|
-
#
|
542
|
+
# controls are permitted, with the exception of the **Region deny**
|
543
|
+
# control. For information on how to find the `controlIdentifier`, see
|
544
|
+
# [the overview page][1].
|
490
545
|
#
|
491
546
|
#
|
492
547
|
#
|
@@ -524,6 +579,64 @@ module Aws::ControlTower
|
|
524
579
|
req.send_request(options)
|
525
580
|
end
|
526
581
|
|
582
|
+
# Enable (apply) a `Baseline` to a Target. This API starts an
|
583
|
+
# asynchronous operation to deploy resources specified by the `Baseline`
|
584
|
+
# to the specified Target.
|
585
|
+
#
|
586
|
+
# @option params [required, String] :baseline_identifier
|
587
|
+
# The ARN of the baseline to be enabled.
|
588
|
+
#
|
589
|
+
# @option params [required, String] :baseline_version
|
590
|
+
# The specific version to be enabled of the specified baseline.
|
591
|
+
#
|
592
|
+
# @option params [Array<Types::EnabledBaselineParameter>] :parameters
|
593
|
+
# A list of `key-value` objects that specify enablement parameters,
|
594
|
+
# where `key` is a string and `value` is a document of any type.
|
595
|
+
#
|
596
|
+
# @option params [Hash<String,String>] :tags
|
597
|
+
# Tags associated with input to `EnableBaseline`.
|
598
|
+
#
|
599
|
+
# @option params [required, String] :target_identifier
|
600
|
+
# The ARN of the target on which the baseline will be enabled. Only OUs
|
601
|
+
# are supported as targets.
|
602
|
+
#
|
603
|
+
# @return [Types::EnableBaselineOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
604
|
+
#
|
605
|
+
# * {Types::EnableBaselineOutput#arn #arn} => String
|
606
|
+
# * {Types::EnableBaselineOutput#operation_identifier #operation_identifier} => String
|
607
|
+
#
|
608
|
+
# @example Request syntax with placeholder values
|
609
|
+
#
|
610
|
+
# resp = client.enable_baseline({
|
611
|
+
# baseline_identifier: "Arn", # required
|
612
|
+
# baseline_version: "BaselineVersion", # required
|
613
|
+
# parameters: [
|
614
|
+
# {
|
615
|
+
# key: "String", # required
|
616
|
+
# value: { # required
|
617
|
+
# },
|
618
|
+
# },
|
619
|
+
# ],
|
620
|
+
# tags: {
|
621
|
+
# "TagKey" => "TagValue",
|
622
|
+
# },
|
623
|
+
# target_identifier: "Arn", # required
|
624
|
+
# })
|
625
|
+
#
|
626
|
+
# @example Response structure
|
627
|
+
#
|
628
|
+
# resp.arn #=> String
|
629
|
+
# resp.operation_identifier #=> String
|
630
|
+
#
|
631
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/EnableBaseline AWS API Documentation
|
632
|
+
#
|
633
|
+
# @overload enable_baseline(params = {})
|
634
|
+
# @param [Hash] params ({})
|
635
|
+
def enable_baseline(params = {}, options = {})
|
636
|
+
req = build_request(:enable_baseline, params)
|
637
|
+
req.send_request(options)
|
638
|
+
end
|
639
|
+
|
527
640
|
# This API call activates a control. It starts an asynchronous operation
|
528
641
|
# that creates Amazon Web Services resources on the specified
|
529
642
|
# organizational unit and the accounts it contains. The resources
|
@@ -537,16 +650,17 @@ module Aws::ControlTower
|
|
537
650
|
#
|
538
651
|
# @option params [required, String] :control_identifier
|
539
652
|
# The ARN of the control. Only **Strongly recommended** and **Elective**
|
540
|
-
# controls are permitted, with the exception of the **
|
541
|
-
#
|
542
|
-
#
|
653
|
+
# controls are permitted, with the exception of the **Region deny**
|
654
|
+
# control. For information on how to find the `controlIdentifier`, see
|
655
|
+
# [the overview page][1].
|
543
656
|
#
|
544
657
|
#
|
545
658
|
#
|
546
659
|
# [1]: https://docs.aws.amazon.com/controltower/latest/APIReference/Welcome.html
|
547
660
|
#
|
548
661
|
# @option params [Array<Types::EnabledControlParameter>] :parameters
|
549
|
-
#
|
662
|
+
# A list of input parameter values, which are specified to configure the
|
663
|
+
# control when you enable it.
|
550
664
|
#
|
551
665
|
# @option params [Hash<String,String>] :tags
|
552
666
|
# Tags to be applied to the `EnabledControl` resource.
|
@@ -595,6 +709,76 @@ module Aws::ControlTower
|
|
595
709
|
req.send_request(options)
|
596
710
|
end
|
597
711
|
|
712
|
+
# Retrieve details about an existing `Baseline` resource by specifying
|
713
|
+
# its identifier.
|
714
|
+
#
|
715
|
+
# @option params [required, String] :baseline_identifier
|
716
|
+
# The ARN of the `Baseline` resource to be retrieved.
|
717
|
+
#
|
718
|
+
# @return [Types::GetBaselineOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
719
|
+
#
|
720
|
+
# * {Types::GetBaselineOutput#arn #arn} => String
|
721
|
+
# * {Types::GetBaselineOutput#description #description} => String
|
722
|
+
# * {Types::GetBaselineOutput#name #name} => String
|
723
|
+
#
|
724
|
+
# @example Request syntax with placeholder values
|
725
|
+
#
|
726
|
+
# resp = client.get_baseline({
|
727
|
+
# baseline_identifier: "BaselineArn", # required
|
728
|
+
# })
|
729
|
+
#
|
730
|
+
# @example Response structure
|
731
|
+
#
|
732
|
+
# resp.arn #=> String
|
733
|
+
# resp.description #=> String
|
734
|
+
# resp.name #=> String
|
735
|
+
#
|
736
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/GetBaseline AWS API Documentation
|
737
|
+
#
|
738
|
+
# @overload get_baseline(params = {})
|
739
|
+
# @param [Hash] params ({})
|
740
|
+
def get_baseline(params = {}, options = {})
|
741
|
+
req = build_request(:get_baseline, params)
|
742
|
+
req.send_request(options)
|
743
|
+
end
|
744
|
+
|
745
|
+
# Returns the details of an asynchronous baseline operation, as
|
746
|
+
# initiated by any of these APIs: `EnableBaseline`, `DisableBaseline`,
|
747
|
+
# `UpdateEnabledBaseline`, `ResetEnabledBaseline`. A status message is
|
748
|
+
# displayed in case of operation failure.
|
749
|
+
#
|
750
|
+
# @option params [required, String] :operation_identifier
|
751
|
+
# The operation ID returned from mutating asynchronous APIs (Enable,
|
752
|
+
# Disable, Update, Reset).
|
753
|
+
#
|
754
|
+
# @return [Types::GetBaselineOperationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
755
|
+
#
|
756
|
+
# * {Types::GetBaselineOperationOutput#baseline_operation #baseline_operation} => Types::BaselineOperation
|
757
|
+
#
|
758
|
+
# @example Request syntax with placeholder values
|
759
|
+
#
|
760
|
+
# resp = client.get_baseline_operation({
|
761
|
+
# operation_identifier: "OperationIdentifier", # required
|
762
|
+
# })
|
763
|
+
#
|
764
|
+
# @example Response structure
|
765
|
+
#
|
766
|
+
# resp.baseline_operation.end_time #=> Time
|
767
|
+
# resp.baseline_operation.operation_identifier #=> String
|
768
|
+
# resp.baseline_operation.operation_type #=> String, one of "ENABLE_BASELINE", "DISABLE_BASELINE", "UPDATE_ENABLED_BASELINE", "RESET_ENABLED_BASELINE"
|
769
|
+
# resp.baseline_operation.start_time #=> Time
|
770
|
+
# resp.baseline_operation.status #=> String, one of "SUCCEEDED", "FAILED", "IN_PROGRESS"
|
771
|
+
# resp.baseline_operation.status_message #=> String
|
772
|
+
#
|
773
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/GetBaselineOperation AWS API Documentation
|
774
|
+
#
|
775
|
+
# @overload get_baseline_operation(params = {})
|
776
|
+
# @param [Hash] params ({})
|
777
|
+
def get_baseline_operation(params = {}, options = {})
|
778
|
+
req = build_request(:get_baseline_operation, params)
|
779
|
+
req.send_request(options)
|
780
|
+
end
|
781
|
+
|
598
782
|
# Returns the status of a particular `EnableControl` or `DisableControl`
|
599
783
|
# operation. Displays a message in case of error. Details for an
|
600
784
|
# operation are available for 90 days. For usage examples, see [ *the
|
@@ -635,6 +819,43 @@ module Aws::ControlTower
|
|
635
819
|
req.send_request(options)
|
636
820
|
end
|
637
821
|
|
822
|
+
# Retrieve details of an `EnabledBaseline` resource by specifying its
|
823
|
+
# identifier.
|
824
|
+
#
|
825
|
+
# @option params [required, String] :enabled_baseline_identifier
|
826
|
+
# Identifier of the `EnabledBaseline` resource to be retrieved, in ARN
|
827
|
+
# format.
|
828
|
+
#
|
829
|
+
# @return [Types::GetEnabledBaselineOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
830
|
+
#
|
831
|
+
# * {Types::GetEnabledBaselineOutput#enabled_baseline_details #enabled_baseline_details} => Types::EnabledBaselineDetails
|
832
|
+
#
|
833
|
+
# @example Request syntax with placeholder values
|
834
|
+
#
|
835
|
+
# resp = client.get_enabled_baseline({
|
836
|
+
# enabled_baseline_identifier: "Arn", # required
|
837
|
+
# })
|
838
|
+
#
|
839
|
+
# @example Response structure
|
840
|
+
#
|
841
|
+
# resp.enabled_baseline_details.arn #=> String
|
842
|
+
# resp.enabled_baseline_details.baseline_identifier #=> String
|
843
|
+
# resp.enabled_baseline_details.baseline_version #=> String
|
844
|
+
# resp.enabled_baseline_details.parameters #=> Array
|
845
|
+
# resp.enabled_baseline_details.parameters[0].key #=> String
|
846
|
+
# resp.enabled_baseline_details.status_summary.last_operation_identifier #=> String
|
847
|
+
# resp.enabled_baseline_details.status_summary.status #=> String, one of "SUCCEEDED", "FAILED", "UNDER_CHANGE"
|
848
|
+
# resp.enabled_baseline_details.target_identifier #=> String
|
849
|
+
#
|
850
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/GetEnabledBaseline AWS API Documentation
|
851
|
+
#
|
852
|
+
# @overload get_enabled_baseline(params = {})
|
853
|
+
# @param [Hash] params ({})
|
854
|
+
def get_enabled_baseline(params = {}, options = {})
|
855
|
+
req = build_request(:get_enabled_baseline, params)
|
856
|
+
req.send_request(options)
|
857
|
+
end
|
858
|
+
|
638
859
|
# Retrieves details about an enabled control. For usage examples, see [
|
639
860
|
# *the Amazon Web Services Control Tower User Guide* ][1].
|
640
861
|
#
|
@@ -743,6 +964,98 @@ module Aws::ControlTower
|
|
743
964
|
req.send_request(options)
|
744
965
|
end
|
745
966
|
|
967
|
+
# Returns a summary list of all available baselines.
|
968
|
+
#
|
969
|
+
# @option params [Integer] :max_results
|
970
|
+
# The maximum number of results to be shown.
|
971
|
+
#
|
972
|
+
# @option params [String] :next_token
|
973
|
+
# A pagination token.
|
974
|
+
#
|
975
|
+
# @return [Types::ListBaselinesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
976
|
+
#
|
977
|
+
# * {Types::ListBaselinesOutput#baselines #baselines} => Array<Types::BaselineSummary>
|
978
|
+
# * {Types::ListBaselinesOutput#next_token #next_token} => String
|
979
|
+
#
|
980
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
981
|
+
#
|
982
|
+
# @example Request syntax with placeholder values
|
983
|
+
#
|
984
|
+
# resp = client.list_baselines({
|
985
|
+
# max_results: 1,
|
986
|
+
# next_token: "String",
|
987
|
+
# })
|
988
|
+
#
|
989
|
+
# @example Response structure
|
990
|
+
#
|
991
|
+
# resp.baselines #=> Array
|
992
|
+
# resp.baselines[0].arn #=> String
|
993
|
+
# resp.baselines[0].description #=> String
|
994
|
+
# resp.baselines[0].name #=> String
|
995
|
+
# resp.next_token #=> String
|
996
|
+
#
|
997
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/ListBaselines AWS API Documentation
|
998
|
+
#
|
999
|
+
# @overload list_baselines(params = {})
|
1000
|
+
# @param [Hash] params ({})
|
1001
|
+
def list_baselines(params = {}, options = {})
|
1002
|
+
req = build_request(:list_baselines, params)
|
1003
|
+
req.send_request(options)
|
1004
|
+
end
|
1005
|
+
|
1006
|
+
# Returns a list of summaries describing `EnabledBaseline` resources.
|
1007
|
+
# You can filter the list by the corresponding `Baseline` or `Target` of
|
1008
|
+
# the `EnabledBaseline` resources.
|
1009
|
+
#
|
1010
|
+
# @option params [Types::EnabledBaselineFilter] :filter
|
1011
|
+
# A filter applied on the `ListEnabledBaseline` operation. Allowed
|
1012
|
+
# filters are `baselineIdentifiers` and `targetIdentifiers`. The filter
|
1013
|
+
# can be applied for either, or both.
|
1014
|
+
#
|
1015
|
+
# @option params [Integer] :max_results
|
1016
|
+
# The maximum number of results to be shown.
|
1017
|
+
#
|
1018
|
+
# @option params [String] :next_token
|
1019
|
+
# A pagination token.
|
1020
|
+
#
|
1021
|
+
# @return [Types::ListEnabledBaselinesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1022
|
+
#
|
1023
|
+
# * {Types::ListEnabledBaselinesOutput#enabled_baselines #enabled_baselines} => Array<Types::EnabledBaselineSummary>
|
1024
|
+
# * {Types::ListEnabledBaselinesOutput#next_token #next_token} => String
|
1025
|
+
#
|
1026
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1027
|
+
#
|
1028
|
+
# @example Request syntax with placeholder values
|
1029
|
+
#
|
1030
|
+
# resp = client.list_enabled_baselines({
|
1031
|
+
# filter: {
|
1032
|
+
# baseline_identifiers: ["Arn"],
|
1033
|
+
# target_identifiers: ["Arn"],
|
1034
|
+
# },
|
1035
|
+
# max_results: 1,
|
1036
|
+
# next_token: "ListEnabledBaselinesNextToken",
|
1037
|
+
# })
|
1038
|
+
#
|
1039
|
+
# @example Response structure
|
1040
|
+
#
|
1041
|
+
# resp.enabled_baselines #=> Array
|
1042
|
+
# resp.enabled_baselines[0].arn #=> String
|
1043
|
+
# resp.enabled_baselines[0].baseline_identifier #=> String
|
1044
|
+
# resp.enabled_baselines[0].baseline_version #=> String
|
1045
|
+
# resp.enabled_baselines[0].status_summary.last_operation_identifier #=> String
|
1046
|
+
# resp.enabled_baselines[0].status_summary.status #=> String, one of "SUCCEEDED", "FAILED", "UNDER_CHANGE"
|
1047
|
+
# resp.enabled_baselines[0].target_identifier #=> String
|
1048
|
+
# resp.next_token #=> String
|
1049
|
+
#
|
1050
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/ListEnabledBaselines AWS API Documentation
|
1051
|
+
#
|
1052
|
+
# @overload list_enabled_baselines(params = {})
|
1053
|
+
# @param [Hash] params ({})
|
1054
|
+
def list_enabled_baselines(params = {}, options = {})
|
1055
|
+
req = build_request(:list_enabled_baselines, params)
|
1056
|
+
req.send_request(options)
|
1057
|
+
end
|
1058
|
+
|
746
1059
|
# Lists the controls enabled by Amazon Web Services Control Tower on the
|
747
1060
|
# specified organizational unit and the accounts it contains. For usage
|
748
1061
|
# examples, see [ *the Amazon Web Services Control Tower User Guide*
|
@@ -879,6 +1192,37 @@ module Aws::ControlTower
|
|
879
1192
|
req.send_request(options)
|
880
1193
|
end
|
881
1194
|
|
1195
|
+
# Re-enables an `EnabledBaseline` resource. For example, this API can
|
1196
|
+
# re-apply the existing `Baseline` after a new member account is moved
|
1197
|
+
# to the target OU.
|
1198
|
+
#
|
1199
|
+
# @option params [required, String] :enabled_baseline_identifier
|
1200
|
+
# Specifies the ID of the `EnabledBaseline` resource to be re-enabled,
|
1201
|
+
# in ARN format.
|
1202
|
+
#
|
1203
|
+
# @return [Types::ResetEnabledBaselineOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1204
|
+
#
|
1205
|
+
# * {Types::ResetEnabledBaselineOutput#operation_identifier #operation_identifier} => String
|
1206
|
+
#
|
1207
|
+
# @example Request syntax with placeholder values
|
1208
|
+
#
|
1209
|
+
# resp = client.reset_enabled_baseline({
|
1210
|
+
# enabled_baseline_identifier: "Arn", # required
|
1211
|
+
# })
|
1212
|
+
#
|
1213
|
+
# @example Response structure
|
1214
|
+
#
|
1215
|
+
# resp.operation_identifier #=> String
|
1216
|
+
#
|
1217
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/ResetEnabledBaseline AWS API Documentation
|
1218
|
+
#
|
1219
|
+
# @overload reset_enabled_baseline(params = {})
|
1220
|
+
# @param [Hash] params ({})
|
1221
|
+
def reset_enabled_baseline(params = {}, options = {})
|
1222
|
+
req = build_request(:reset_enabled_baseline, params)
|
1223
|
+
req.send_request(options)
|
1224
|
+
end
|
1225
|
+
|
882
1226
|
# This API call resets a landing zone. It starts an asynchronous
|
883
1227
|
# operation that resets the landing zone to the parameters specified in
|
884
1228
|
# its original configuration.
|
@@ -973,6 +1317,50 @@ module Aws::ControlTower
|
|
973
1317
|
req.send_request(options)
|
974
1318
|
end
|
975
1319
|
|
1320
|
+
# Updates an `EnabledBaseline` resource's applied parameters or
|
1321
|
+
# version.
|
1322
|
+
#
|
1323
|
+
# @option params [required, String] :baseline_version
|
1324
|
+
# Specifies the new `Baseline` version, to which the `EnabledBaseline`
|
1325
|
+
# should be updated.
|
1326
|
+
#
|
1327
|
+
# @option params [required, String] :enabled_baseline_identifier
|
1328
|
+
# Specifies the `EnabledBaseline` resource to be updated.
|
1329
|
+
#
|
1330
|
+
# @option params [Array<Types::EnabledBaselineParameter>] :parameters
|
1331
|
+
# Parameters to apply when making an update.
|
1332
|
+
#
|
1333
|
+
# @return [Types::UpdateEnabledBaselineOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1334
|
+
#
|
1335
|
+
# * {Types::UpdateEnabledBaselineOutput#operation_identifier #operation_identifier} => String
|
1336
|
+
#
|
1337
|
+
# @example Request syntax with placeholder values
|
1338
|
+
#
|
1339
|
+
# resp = client.update_enabled_baseline({
|
1340
|
+
# baseline_version: "BaselineVersion", # required
|
1341
|
+
# enabled_baseline_identifier: "Arn", # required
|
1342
|
+
# parameters: [
|
1343
|
+
# {
|
1344
|
+
# key: "String", # required
|
1345
|
+
# value: { # required
|
1346
|
+
# },
|
1347
|
+
# },
|
1348
|
+
# ],
|
1349
|
+
# })
|
1350
|
+
#
|
1351
|
+
# @example Response structure
|
1352
|
+
#
|
1353
|
+
# resp.operation_identifier #=> String
|
1354
|
+
#
|
1355
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/UpdateEnabledBaseline AWS API Documentation
|
1356
|
+
#
|
1357
|
+
# @overload update_enabled_baseline(params = {})
|
1358
|
+
# @param [Hash] params ({})
|
1359
|
+
def update_enabled_baseline(params = {}, options = {})
|
1360
|
+
req = build_request(:update_enabled_baseline, params)
|
1361
|
+
req.send_request(options)
|
1362
|
+
end
|
1363
|
+
|
976
1364
|
# Updates the configuration of an already enabled control.
|
977
1365
|
#
|
978
1366
|
# If the enabled control shows an `EnablementStatus` of SUCCEEDED,
|
@@ -1040,9 +1428,8 @@ module Aws::ControlTower
|
|
1040
1428
|
# The unique identifier of the landing zone.
|
1041
1429
|
#
|
1042
1430
|
# @option params [required, Hash,Array,String,Numeric,Boolean] :manifest
|
1043
|
-
# The manifest
|
1044
|
-
# Services resources. For examples, review [
|
1045
|
-
# zone][1].
|
1431
|
+
# The `manifest.yaml` file is a text file that describes your Amazon Web
|
1432
|
+
# Services resources. For examples, review [The manifest file][1].
|
1046
1433
|
#
|
1047
1434
|
# Document type used to carry open content
|
1048
1435
|
# (Hash,Array,String,Numeric,Boolean). A document type value is
|
@@ -1051,7 +1438,7 @@ module Aws::ControlTower
|
|
1051
1438
|
#
|
1052
1439
|
#
|
1053
1440
|
#
|
1054
|
-
# [1]: https://docs.aws.amazon.com/controltower/latest/userguide/
|
1441
|
+
# [1]: https://docs.aws.amazon.com/controltower/latest/userguide/the-manifest-file
|
1055
1442
|
#
|
1056
1443
|
# @option params [required, String] :version
|
1057
1444
|
# The landing zone version, for example, 3.2.
|
@@ -1095,7 +1482,7 @@ module Aws::ControlTower
|
|
1095
1482
|
params: params,
|
1096
1483
|
config: config)
|
1097
1484
|
context[:gem_name] = 'aws-sdk-controltower'
|
1098
|
-
context[:gem_version] = '1.
|
1485
|
+
context[:gem_version] = '1.19.0'
|
1099
1486
|
Seahorse::Client::Request.new(handlers, context)
|
1100
1487
|
end
|
1101
1488
|
|