pub struct Client { /* private fields */ }
Expand description
Client for AWS Control Tower
Client for invoking operations on AWS Control Tower. Each operation on AWS Control Tower is a method on this
this struct. .send()
MUST be invoked on the generated operations to dispatch the request to the service.
§Constructing a Client
A Config
is required to construct a client. For most use cases, the aws-config
crate should be used to automatically resolve this config using
aws_config::load_from_env()
, since this will resolve an SdkConfig
which can be shared
across multiple different AWS SDK clients. This config resolution process can be customized
by calling aws_config::from_env()
instead, which returns a ConfigLoader
that uses
the builder pattern to customize the default config.
In the simplest case, creating a client looks as follows:
let config = aws_config::load_from_env().await;
let client = aws_sdk_controltower::Client::new(&config);
Occasionally, SDKs may have additional service-specific values that can be set on the Config
that
is absent from SdkConfig
, or slightly different settings for a specific client may be desired.
The Builder
struct implements From<&SdkConfig>
, so setting these specific settings can be
done as follows:
let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_controltower::config::Builder::from(&sdk_config)
.some_service_specific_setting("value")
.build();
See the aws-config
docs and Config
for more information on customizing configuration.
Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.
§Using the Client
A client has a function for every operation that can be performed by the service.
For example, the DisableControl
operation has
a Client::disable_control
, function which returns a builder for that operation.
The fluent builder ultimately has a send()
function that returns an async future that
returns a result, as illustrated below:
let result = client.disable_control()
.control_identifier("example")
.send()
.await;
The underlying HTTP requests that get made by this can be modified with the customize_operation
function on the fluent builder. See the customize
module for more
information.
Implementations§
Source§impl Client
impl Client
Sourcepub fn create_landing_zone(&self) -> CreateLandingZoneFluentBuilder
pub fn create_landing_zone(&self) -> CreateLandingZoneFluentBuilder
Constructs a fluent builder for the CreateLandingZone
operation.
- The fluent builder is configurable:
version(impl Into<String>)
/set_version(Option<String>)
:
required: trueThe landing zone version, for example, 3.0.
manifest(Document)
/set_manifest(Option<Document>)
:
required: trueThe manifest JSON file is a text file that describes your Amazon Web Services resources. For examples, review Launch your landing zone.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseTags to be applied to the landing zone.
- On success, responds with
CreateLandingZoneOutput
with field(s):arn(String)
:The ARN of the landing zone resource.
operation_identifier(String)
:A unique identifier assigned to a
CreateLandingZone
operation. You can use this identifier as an input ofGetLandingZoneOperation
to check the operation’s status.
- On failure, responds with
SdkError<CreateLandingZoneError>
Source§impl Client
impl Client
Sourcepub fn delete_landing_zone(&self) -> DeleteLandingZoneFluentBuilder
pub fn delete_landing_zone(&self) -> DeleteLandingZoneFluentBuilder
Constructs a fluent builder for the DeleteLandingZone
operation.
- The fluent builder is configurable:
landing_zone_identifier(impl Into<String>)
/set_landing_zone_identifier(Option<String>)
:
required: trueThe unique identifier of the landing zone.
- On success, responds with
DeleteLandingZoneOutput
with field(s):operation_identifier(String)
:>A unique identifier assigned to a
DeleteLandingZone
operation. You can use this identifier as an input parameter ofGetLandingZoneOperation
to check the operation’s status.
- On failure, responds with
SdkError<DeleteLandingZoneError>
Source§impl Client
impl Client
Sourcepub fn disable_baseline(&self) -> DisableBaselineFluentBuilder
pub fn disable_baseline(&self) -> DisableBaselineFluentBuilder
Constructs a fluent builder for the DisableBaseline
operation.
- The fluent builder is configurable:
enabled_baseline_identifier(impl Into<String>)
/set_enabled_baseline_identifier(Option<String>)
:
required: trueIdentifier of the
EnabledBaseline
resource to be deactivated, in ARN format.
- On success, responds with
DisableBaselineOutput
with field(s):operation_identifier(String)
:The ID (in UUID format) of the asynchronous
DisableBaseline
operation. ThisoperationIdentifier
is used to track status through calls to theGetBaselineOperation
API.
- On failure, responds with
SdkError<DisableBaselineError>
Source§impl Client
impl Client
Sourcepub fn disable_control(&self) -> DisableControlFluentBuilder
pub fn disable_control(&self) -> DisableControlFluentBuilder
Constructs a fluent builder for the DisableControl
operation.
- The fluent builder is configurable:
control_identifier(impl Into<String>)
/set_control_identifier(Option<String>)
:
required: trueThe ARN of the control. Only Strongly recommended and Elective controls are permitted, with the exception of the Region deny control. For information on how to find the
controlIdentifier
, see the overview page.target_identifier(impl Into<String>)
/set_target_identifier(Option<String>)
:
required: trueThe ARN of the organizational unit. For information on how to find the
targetIdentifier
, see the overview page.
- On success, responds with
DisableControlOutput
with field(s):operation_identifier(String)
:The ID of the asynchronous operation, which is used to track status. The operation is available for 90 days.
- On failure, responds with
SdkError<DisableControlError>
Source§impl Client
impl Client
Sourcepub fn enable_baseline(&self) -> EnableBaselineFluentBuilder
pub fn enable_baseline(&self) -> EnableBaselineFluentBuilder
Constructs a fluent builder for the EnableBaseline
operation.
- The fluent builder is configurable:
baseline_version(impl Into<String>)
/set_baseline_version(Option<String>)
:
required: trueThe specific version to be enabled of the specified baseline.
parameters(EnabledBaselineParameter)
/set_parameters(Option<Vec::<EnabledBaselineParameter>>)
:
required: falseA list of
key-value
objects that specify enablement parameters, wherekey
is a string andvalue
is a document of any type.baseline_identifier(impl Into<String>)
/set_baseline_identifier(Option<String>)
:
required: trueThe ARN of the baseline to be enabled.
target_identifier(impl Into<String>)
/set_target_identifier(Option<String>)
:
required: trueThe ARN of the target on which the baseline will be enabled. Only OUs are supported as targets.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseTags associated with input to
EnableBaseline
.
- On success, responds with
EnableBaselineOutput
with field(s):operation_identifier(String)
:The ID (in UUID format) of the asynchronous
EnableBaseline
operation. ThisoperationIdentifier
is used to track status through calls to theGetBaselineOperation
API.arn(String)
:The ARN of the
EnabledBaseline
resource.
- On failure, responds with
SdkError<EnableBaselineError>
Source§impl Client
impl Client
Sourcepub fn enable_control(&self) -> EnableControlFluentBuilder
pub fn enable_control(&self) -> EnableControlFluentBuilder
Constructs a fluent builder for the EnableControl
operation.
- The fluent builder is configurable:
control_identifier(impl Into<String>)
/set_control_identifier(Option<String>)
:
required: trueThe ARN of the control. Only Strongly recommended and Elective controls are permitted, with the exception of the Region deny control. For information on how to find the
controlIdentifier
, see the overview page.target_identifier(impl Into<String>)
/set_target_identifier(Option<String>)
:
required: trueThe ARN of the organizational unit. For information on how to find the
targetIdentifier
, see the overview page.tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseTags to be applied to the
EnabledControl
resource.parameters(EnabledControlParameter)
/set_parameters(Option<Vec::<EnabledControlParameter>>)
:
required: falseA list of input parameter values, which are specified to configure the control when you enable it.
- On success, responds with
EnableControlOutput
with field(s):operation_identifier(String)
:The ID of the asynchronous operation, which is used to track status. The operation is available for 90 days.
arn(Option<String>)
:The ARN of the
EnabledControl
resource.
- On failure, responds with
SdkError<EnableControlError>
Source§impl Client
impl Client
Sourcepub fn get_baseline(&self) -> GetBaselineFluentBuilder
pub fn get_baseline(&self) -> GetBaselineFluentBuilder
Constructs a fluent builder for the GetBaseline
operation.
- The fluent builder is configurable:
baseline_identifier(impl Into<String>)
/set_baseline_identifier(Option<String>)
:
required: trueThe ARN of the
Baseline
resource to be retrieved.
- On success, responds with
GetBaselineOutput
with field(s):arn(String)
:The baseline ARN.
name(String)
:A user-friendly name for the baseline.
description(Option<String>)
:A description of the baseline.
- On failure, responds with
SdkError<GetBaselineError>
Source§impl Client
impl Client
Sourcepub fn get_baseline_operation(&self) -> GetBaselineOperationFluentBuilder
pub fn get_baseline_operation(&self) -> GetBaselineOperationFluentBuilder
Constructs a fluent builder for the GetBaselineOperation
operation.
- The fluent builder is configurable:
operation_identifier(impl Into<String>)
/set_operation_identifier(Option<String>)
:
required: trueThe operation ID returned from mutating asynchronous APIs (Enable, Disable, Update, Reset).
- On success, responds with
GetBaselineOperationOutput
with field(s):baseline_operation(Option<BaselineOperation>)
:A
baselineOperation
object that shows information about the specified operation ID.
- On failure, responds with
SdkError<GetBaselineOperationError>
Source§impl Client
impl Client
Sourcepub fn get_control_operation(&self) -> GetControlOperationFluentBuilder
pub fn get_control_operation(&self) -> GetControlOperationFluentBuilder
Constructs a fluent builder for the GetControlOperation
operation.
- The fluent builder is configurable:
operation_identifier(impl Into<String>)
/set_operation_identifier(Option<String>)
:
required: trueThe ID of the asynchronous operation, which is used to track status. The operation is available for 90 days.
- On success, responds with
GetControlOperationOutput
with field(s):control_operation(Option<ControlOperation>)
:An operation performed by the control.
- On failure, responds with
SdkError<GetControlOperationError>
Source§impl Client
impl Client
Sourcepub fn get_enabled_baseline(&self) -> GetEnabledBaselineFluentBuilder
pub fn get_enabled_baseline(&self) -> GetEnabledBaselineFluentBuilder
Constructs a fluent builder for the GetEnabledBaseline
operation.
- The fluent builder is configurable:
enabled_baseline_identifier(impl Into<String>)
/set_enabled_baseline_identifier(Option<String>)
:
required: trueIdentifier of the
EnabledBaseline
resource to be retrieved, in ARN format.
- On success, responds with
GetEnabledBaselineOutput
with field(s):enabled_baseline_details(Option<EnabledBaselineDetails>)
:Details of the
EnabledBaseline
resource.
- On failure, responds with
SdkError<GetEnabledBaselineError>
Source§impl Client
impl Client
Sourcepub fn get_enabled_control(&self) -> GetEnabledControlFluentBuilder
pub fn get_enabled_control(&self) -> GetEnabledControlFluentBuilder
Constructs a fluent builder for the GetEnabledControl
operation.
- The fluent builder is configurable:
enabled_control_identifier(impl Into<String>)
/set_enabled_control_identifier(Option<String>)
:
required: trueThe
controlIdentifier
of the enabled control.
- On success, responds with
GetEnabledControlOutput
with field(s):enabled_control_details(Option<EnabledControlDetails>)
:Information about the enabled control.
- On failure, responds with
SdkError<GetEnabledControlError>
Source§impl Client
impl Client
Sourcepub fn get_landing_zone(&self) -> GetLandingZoneFluentBuilder
pub fn get_landing_zone(&self) -> GetLandingZoneFluentBuilder
Constructs a fluent builder for the GetLandingZone
operation.
- The fluent builder is configurable:
landing_zone_identifier(impl Into<String>)
/set_landing_zone_identifier(Option<String>)
:
required: trueThe unique identifier of the landing zone.
- On success, responds with
GetLandingZoneOutput
with field(s):landing_zone(Option<LandingZoneDetail>)
:Information about the landing zone.
- On failure, responds with
SdkError<GetLandingZoneError>
Source§impl Client
impl Client
Sourcepub fn get_landing_zone_operation(&self) -> GetLandingZoneOperationFluentBuilder
pub fn get_landing_zone_operation(&self) -> GetLandingZoneOperationFluentBuilder
Constructs a fluent builder for the GetLandingZoneOperation
operation.
- The fluent builder is configurable:
operation_identifier(impl Into<String>)
/set_operation_identifier(Option<String>)
:
required: trueA unique identifier assigned to a landing zone operation.
- On success, responds with
GetLandingZoneOperationOutput
with field(s):operation_details(Option<LandingZoneOperationDetail>)
:Details about a landing zone operation.
- On failure, responds with
SdkError<GetLandingZoneOperationError>
Source§impl Client
impl Client
Sourcepub fn list_baselines(&self) -> ListBaselinesFluentBuilder
pub fn list_baselines(&self) -> ListBaselinesFluentBuilder
Constructs a fluent builder for the ListBaselines
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA pagination token.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to be shown.
- On success, responds with
ListBaselinesOutput
with field(s):baselines(Vec::<BaselineSummary>)
:A list of
Baseline
object details.next_token(Option<String>)
:A pagination token.
- On failure, responds with
SdkError<ListBaselinesError>
Source§impl Client
impl Client
Sourcepub fn list_control_operations(&self) -> ListControlOperationsFluentBuilder
pub fn list_control_operations(&self) -> ListControlOperationsFluentBuilder
Constructs a fluent builder for the ListControlOperations
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filter(ControlOperationFilter)
/set_filter(Option<ControlOperationFilter>)
:
required: falseAn input filter for the
ListControlOperations
API that lets you select the types of control operations to view.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA pagination token.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to be shown.
- On success, responds with
ListControlOperationsOutput
with field(s):control_operations(Vec::<ControlOperationSummary>)
:Returns a list of output from control operations.
next_token(Option<String>)
:A pagination token.
- On failure, responds with
SdkError<ListControlOperationsError>
Source§impl Client
impl Client
Sourcepub fn list_enabled_baselines(&self) -> ListEnabledBaselinesFluentBuilder
pub fn list_enabled_baselines(&self) -> ListEnabledBaselinesFluentBuilder
Constructs a fluent builder for the ListEnabledBaselines
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filter(EnabledBaselineFilter)
/set_filter(Option<EnabledBaselineFilter>)
:
required: falseA filter applied on the
ListEnabledBaseline
operation. Allowed filters arebaselineIdentifiers
andtargetIdentifiers
. The filter can be applied for either, or both.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA pagination token.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to be shown.
include_children(bool)
/set_include_children(Option<bool>)
:
required: falseA value that can be set to include the child enabled baselines in responses. The default value is false.
- On success, responds with
ListEnabledBaselinesOutput
with field(s):enabled_baselines(Vec::<EnabledBaselineSummary>)
:Retuens a list of summaries of
EnabledBaseline
resources.next_token(Option<String>)
:A pagination token.
- On failure, responds with
SdkError<ListEnabledBaselinesError>
Source§impl Client
impl Client
Sourcepub fn list_enabled_controls(&self) -> ListEnabledControlsFluentBuilder
pub fn list_enabled_controls(&self) -> ListEnabledControlsFluentBuilder
Constructs a fluent builder for the ListEnabledControls
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
target_identifier(impl Into<String>)
/set_target_identifier(Option<String>)
:
required: falseThe ARN of the organizational unit. For information on how to find the
targetIdentifier
, see the overview page.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe token to continue the list from a previous API call with the same parameters.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseHow many results to return per API call.
filter(EnabledControlFilter)
/set_filter(Option<EnabledControlFilter>)
:
required: falseAn input filter for the
ListEnabledControls
API that lets you select the types of control operations to view.
- On success, responds with
ListEnabledControlsOutput
with field(s):enabled_controls(Vec::<EnabledControlSummary>)
:Lists the controls enabled by Amazon Web Services Control Tower on the specified organizational unit and the accounts it contains.
next_token(Option<String>)
:Retrieves the next page of results. If the string is empty, the response is the end of the results.
- On failure, responds with
SdkError<ListEnabledControlsError>
Source§impl Client
impl Client
Sourcepub fn list_landing_zone_operations(
&self,
) -> ListLandingZoneOperationsFluentBuilder
pub fn list_landing_zone_operations( &self, ) -> ListLandingZoneOperationsFluentBuilder
Constructs a fluent builder for the ListLandingZoneOperations
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filter(LandingZoneOperationFilter)
/set_filter(Option<LandingZoneOperationFilter>)
:
required: falseAn input filter for the
ListLandingZoneOperations
API that lets you select the types of landing zone operations to view.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe token to continue the list from a previous API call with the same parameters.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseHow many results to return per API call.
- On success, responds with
ListLandingZoneOperationsOutput
with field(s):landing_zone_operations(Vec::<LandingZoneOperationSummary>)
:Lists landing zone operations.
next_token(Option<String>)
:Retrieves the next page of results. If the string is empty, the response is the end of the results.
- On failure, responds with
SdkError<ListLandingZoneOperationsError>
Source§impl Client
impl Client
Sourcepub fn list_landing_zones(&self) -> ListLandingZonesFluentBuilder
pub fn list_landing_zones(&self) -> ListLandingZonesFluentBuilder
Constructs a fluent builder for the ListLandingZones
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe token to continue the list from a previous API call with the same parameters.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of returned landing zone ARNs, which is one.
- On success, responds with
ListLandingZonesOutput
with field(s):landing_zones(Vec::<LandingZoneSummary>)
:The ARN of the landing zone.
next_token(Option<String>)
:Retrieves the next page of results. If the string is empty, the response is the end of the results.
- On failure, responds with
SdkError<ListLandingZonesError>
Source§impl Client
impl Client
Constructs a fluent builder for the ListTagsForResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe ARN of the resource.
- On success, responds with
ListTagsForResourceOutput
with field(s):tags(HashMap::<String, String>)
:A list of tags, as
key:value
strings.
- On failure, responds with
SdkError<ListTagsForResourceError>
Source§impl Client
impl Client
Sourcepub fn reset_enabled_baseline(&self) -> ResetEnabledBaselineFluentBuilder
pub fn reset_enabled_baseline(&self) -> ResetEnabledBaselineFluentBuilder
Constructs a fluent builder for the ResetEnabledBaseline
operation.
- The fluent builder is configurable:
enabled_baseline_identifier(impl Into<String>)
/set_enabled_baseline_identifier(Option<String>)
:
required: trueSpecifies the ID of the
EnabledBaseline
resource to be re-enabled, in ARN format.
- On success, responds with
ResetEnabledBaselineOutput
with field(s):operation_identifier(String)
:The ID (in UUID format) of the asynchronous
ResetEnabledBaseline
operation. ThisoperationIdentifier
is used to track status through calls to theGetBaselineOperation
API.
- On failure, responds with
SdkError<ResetEnabledBaselineError>
Source§impl Client
impl Client
Sourcepub fn reset_enabled_control(&self) -> ResetEnabledControlFluentBuilder
pub fn reset_enabled_control(&self) -> ResetEnabledControlFluentBuilder
Constructs a fluent builder for the ResetEnabledControl
operation.
- The fluent builder is configurable:
enabled_control_identifier(impl Into<String>)
/set_enabled_control_identifier(Option<String>)
:
required: trueThe ARN of the enabled control to be reset.
- On success, responds with
ResetEnabledControlOutput
with field(s):operation_identifier(String)
:The operation identifier for this
ResetEnabledControl
operation.
- On failure, responds with
SdkError<ResetEnabledControlError>
Source§impl Client
impl Client
Sourcepub fn reset_landing_zone(&self) -> ResetLandingZoneFluentBuilder
pub fn reset_landing_zone(&self) -> ResetLandingZoneFluentBuilder
Constructs a fluent builder for the ResetLandingZone
operation.
- The fluent builder is configurable:
landing_zone_identifier(impl Into<String>)
/set_landing_zone_identifier(Option<String>)
:
required: trueThe unique identifier of the landing zone.
- On success, responds with
ResetLandingZoneOutput
with field(s):operation_identifier(String)
:A unique identifier assigned to a
ResetLandingZone
operation. You can use this identifier as an input parameter ofGetLandingZoneOperation
to check the operation’s status.
- On failure, responds with
SdkError<ResetLandingZoneError>
Source§impl Client
impl Client
Sourcepub fn tag_resource(&self) -> TagResourceFluentBuilder
pub fn tag_resource(&self) -> TagResourceFluentBuilder
Constructs a fluent builder for the TagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe ARN of the resource to be tagged.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: trueTags to be applied to the resource.
- On success, responds with
TagResourceOutput
- On failure, responds with
SdkError<TagResourceError>
Source§impl Client
impl Client
Sourcepub fn untag_resource(&self) -> UntagResourceFluentBuilder
pub fn untag_resource(&self) -> UntagResourceFluentBuilder
Constructs a fluent builder for the UntagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe ARN of the resource.
tag_keys(impl Into<String>)
/set_tag_keys(Option<Vec::<String>>)
:
required: trueTag keys to be removed from the resource.
- On success, responds with
UntagResourceOutput
- On failure, responds with
SdkError<UntagResourceError>
Source§impl Client
impl Client
Sourcepub fn update_enabled_baseline(&self) -> UpdateEnabledBaselineFluentBuilder
pub fn update_enabled_baseline(&self) -> UpdateEnabledBaselineFluentBuilder
Constructs a fluent builder for the UpdateEnabledBaseline
operation.
- The fluent builder is configurable:
baseline_version(impl Into<String>)
/set_baseline_version(Option<String>)
:
required: trueSpecifies the new
Baseline
version, to which theEnabledBaseline
should be updated.parameters(EnabledBaselineParameter)
/set_parameters(Option<Vec::<EnabledBaselineParameter>>)
:
required: falseParameters to apply when making an update.
enabled_baseline_identifier(impl Into<String>)
/set_enabled_baseline_identifier(Option<String>)
:
required: trueSpecifies the
EnabledBaseline
resource to be updated.
- On success, responds with
UpdateEnabledBaselineOutput
with field(s):operation_identifier(String)
:The ID (in UUID format) of the asynchronous
UpdateEnabledBaseline
operation. ThisoperationIdentifier
is used to track status through calls to theGetBaselineOperation
API.
- On failure, responds with
SdkError<UpdateEnabledBaselineError>
Source§impl Client
impl Client
Sourcepub fn update_enabled_control(&self) -> UpdateEnabledControlFluentBuilder
pub fn update_enabled_control(&self) -> UpdateEnabledControlFluentBuilder
Constructs a fluent builder for the UpdateEnabledControl
operation.
- The fluent builder is configurable:
parameters(EnabledControlParameter)
/set_parameters(Option<Vec::<EnabledControlParameter>>)
:
required: trueA key/value pair, where
Key
is of typeString
andValue
is of typeDocument
.enabled_control_identifier(impl Into<String>)
/set_enabled_control_identifier(Option<String>)
:
required: trueThe ARN of the enabled control that will be updated.
- On success, responds with
UpdateEnabledControlOutput
with field(s):operation_identifier(String)
:The operation identifier for this
UpdateEnabledControl
operation.
- On failure, responds with
SdkError<UpdateEnabledControlError>
Source§impl Client
impl Client
Sourcepub fn update_landing_zone(&self) -> UpdateLandingZoneFluentBuilder
pub fn update_landing_zone(&self) -> UpdateLandingZoneFluentBuilder
Constructs a fluent builder for the UpdateLandingZone
operation.
- The fluent builder is configurable:
version(impl Into<String>)
/set_version(Option<String>)
:
required: trueThe landing zone version, for example, 3.2.
manifest(Document)
/set_manifest(Option<Document>)
:
required: trueThe manifest file (JSON) is a text file that describes your Amazon Web Services resources. For an example, review Launch your landing zone. The example manifest file contains each of the available parameters. The schema for the landing zone’s JSON manifest file is not published, by design.
landing_zone_identifier(impl Into<String>)
/set_landing_zone_identifier(Option<String>)
:
required: trueThe unique identifier of the landing zone.
- On success, responds with
UpdateLandingZoneOutput
with field(s):operation_identifier(String)
:A unique identifier assigned to a
UpdateLandingZone
operation. You can use this identifier as an input ofGetLandingZoneOperation
to check the operation’s status.
- On failure, responds with
SdkError<UpdateLandingZoneError>
Source§impl Client
impl Client
Sourcepub fn from_conf(conf: Config) -> Self
pub fn from_conf(conf: Config) -> Self
Creates a new client from the service Config
.
§Panics
This method will panic in the following cases:
- Retries or timeouts are enabled without a
sleep_impl
configured. - Identity caching is enabled without a
sleep_impl
andtime_source
configured. - No
behavior_version
is provided.
The panic message for each of these will have instructions on how to resolve them.
Source§impl Client
impl Client
Sourcepub fn new(sdk_config: &SdkConfig) -> Self
pub fn new(sdk_config: &SdkConfig) -> Self
Creates a new client from an SDK Config.
§Panics
- This method will panic if the
sdk_config
is missing an async sleep implementation. If you experience this panic, set thesleep_impl
on the Config passed into this function to fix it. - This method will panic if the
sdk_config
is missing an HTTP connector. If you experience this panic, set thehttp_connector
on the Config passed into this function to fix it. - This method will panic if no
BehaviorVersion
is provided. If you experience this panic, setbehavior_version
on the Config or enable thebehavior-version-latest
Cargo feature.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for Client
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.bright_black());
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.bright_green());
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.bright_yellow());
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.bright_magenta());
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.bright_white());
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.on_bright_black());
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.on_bright_green());
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.on_bright_yellow());
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlue
.
§Example
println!("{}", value.on_bright_blue());
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.on_bright_magenta());
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightCyan
.
§Example
println!("{}", value.on_bright_cyan());
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.on_bright_white());
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::Underline
.
§Example
println!("{}", value.underline());
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::RapidBlink
.
§Example
println!("{}", value.rapid_blink());
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);