Struct Client 

pub struct Client { /* private fields */ }

Client for ARC - Region switch

Client for invoking operations on ARC - Region switch. Each operation on ARC - Region switch 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_arcregionswitch::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_arcregionswitch::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 ApprovePlanExecutionStep operation has a Client::approve_plan_execution_step, 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.approve_plan_execution_step()
    .plan_arn("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.

Waiters

This client provides wait_until methods behind the Waiters trait. To use them, simply import the trait, and then call one of the wait_until methods. This will return a waiter fluent builder that takes various parameters, which are documented on the builder type. Once parameters have been provided, the wait method can be called to initiate waiting.

For example, if there was a wait_until_thing method, it could look like:

let result = client.wait_until_thing()
    .thing_id("someId")
    .wait(Duration::from_secs(120))
    .await;

Implementations

impl Client

pub fn approve_plan_execution_step( &self, ) -> ApprovePlanExecutionStepFluentBuilder

Constructs a fluent builder for the ApprovePlanExecutionStep operation.

• The fluent builder is configurable:
  • plan_arn(impl Into<String>) / set_plan_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the plan.

    
    
  • execution_id(impl Into<String>) / set_execution_id(Option<String>):
    required: true
    

    The execution identifier of a plan execution.

    
    
  • step_name(impl Into<String>) / set_step_name(Option<String>):
    required: true
    

    The name of a step in a plan execution.

    
    
  • approval(Approval) / set_approval(Option<Approval>):
    required: true
    

    The status of approval for a plan execution step.

    
    
  • comment(impl Into<String>) / set_comment(Option<String>):
    required: false
    

    A comment that you can enter about a plan execution.

    
    
• On success, responds with ApprovePlanExecutionStepOutput
• On failure, responds with SdkError<ApprovePlanExecutionStepError>

impl Client

pub fn cancel_plan_execution(&self) -> CancelPlanExecutionFluentBuilder

Constructs a fluent builder for the CancelPlanExecution operation.

• The fluent builder is configurable:
  • plan_arn(impl Into<String>) / set_plan_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the plan.

    
    
  • execution_id(impl Into<String>) / set_execution_id(Option<String>):
    required: true
    

    The execution identifier of a plan execution.

    
    
  • comment(impl Into<String>) / set_comment(Option<String>):
    required: false
    

    A comment that you can enter about canceling a plan execution step.

    
    
• On success, responds with CancelPlanExecutionOutput
• On failure, responds with SdkError<CancelPlanExecutionError>

impl Client

pub fn create_plan(&self) -> CreatePlanFluentBuilder

Constructs a fluent builder for the CreatePlan operation.

• The fluent builder is configurable:
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of a Region switch plan.

    
    
  • workflows(Workflow) / set_workflows(Option<Vec::<Workflow>>):
    required: true
    

    An array of workflows included in a Region switch plan.

    
    
  • execution_role(impl Into<String>) / set_execution_role(Option<String>):
    required: true
    

    An execution role is a way to categorize a Region switch plan.

    
    
  • recovery_time_objective_minutes(i32) / set_recovery_time_objective_minutes(Option<i32>):
    required: false
    

    Optionally, you can specify an recovery time objective for a Region switch plan, in minutes.

    
    
  • associated_alarms(impl Into<String>, AssociatedAlarm) / set_associated_alarms(Option<HashMap::<String, AssociatedAlarm>>):
    required: false
    

    The alarms associated with a Region switch plan.

    
    
  • triggers(Trigger) / set_triggers(Option<Vec::<Trigger>>):
    required: false
    

    The triggers associated with a Region switch plan.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of a Region switch plan.

    
    
  • regions(impl Into<String>) / set_regions(Option<Vec::<String>>):
    required: true
    

    An array that specifies the Amazon Web Services Regions for a Region switch plan. Specify two Regions.

    
    
  • recovery_approach(RecoveryApproach) / set_recovery_approach(Option<RecoveryApproach>):
    required: true
    

    The recovery approach for a Region switch plan, which can be active/active (activeActive) or active/passive (activePassive).

    
    
  • primary_region(impl Into<String>) / set_primary_region(Option<String>):
    required: false
    

    The primary Amazon Web Services Region for the application. This is the Region where the application normally runs before any Region switch occurs.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags to apply to the Region switch plan.

    
    
• On success, responds with CreatePlanOutput with field(s):
  • plan(Option<Plan>):

    The details of the created Region switch plan.

• On failure, responds with SdkError<CreatePlanError>

impl Client

pub fn delete_plan(&self) -> DeletePlanFluentBuilder

Constructs a fluent builder for the DeletePlan operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the plan.

    
    
• On success, responds with DeletePlanOutput
• On failure, responds with SdkError<DeletePlanError>

impl Client

pub fn get_plan(&self) -> GetPlanFluentBuilder

Constructs a fluent builder for the GetPlan operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the plan.

    
    
• On success, responds with GetPlanOutput with field(s):
  • plan(Option<Plan>):

    The detailed information about the requested Region switch plan.

• On failure, responds with SdkError<GetPlanError>

impl Client

pub fn get_plan_evaluation_status(&self) -> GetPlanEvaluationStatusFluentBuilder

Constructs a fluent builder for the GetPlanEvaluationStatus operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • plan_arn(impl Into<String>) / set_plan_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the Region switch plan to retrieve evaluation status for.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The number of objects that you want to return with this call.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Specifies that you want to receive the next page of results. Valid only if you received a nextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call’s nextToken response to request the next page of results.

    
    
• On success, responds with GetPlanEvaluationStatusOutput with field(s):
  • plan_arn(String):

    The Amazon Resource Name (ARN) of the plan.

  • last_evaluation_time(Option<DateTime>):

    The time of the last time that Region switch ran an evaluation of the plan.

  • last_evaluated_version(Option<String>):

    The version of the last evaluation of the plan.

  • region(Option<String>):

    The Amazon Web Services Region for the plan.

  • evaluation_state(Option<EvaluationStatus>):

    The evaluation state for the plan.

  • warnings(Option<Vec::<ResourceWarning>>):

    The current evaluation warnings for the plan.

  • next_token(Option<String>):

    Specifies that you want to receive the next page of results. Valid only if you received a nextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call’s nextToken response to request the next page of results.

• On failure, responds with SdkError<GetPlanEvaluationStatusError>

impl Client

pub fn get_plan_execution(&self) -> GetPlanExecutionFluentBuilder

Constructs a fluent builder for the GetPlanExecution operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • plan_arn(impl Into<String>) / set_plan_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the plan with the execution to retrieve.

    
    
  • execution_id(impl Into<String>) / set_execution_id(Option<String>):
    required: true
    

    The execution identifier of a plan execution.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The number of objects that you want to return with this call.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Specifies that you want to receive the next page of results. Valid only if you received a nextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call’s nextToken response to request the next page of results.

    
    
• On success, responds with GetPlanExecutionOutput with field(s):
  • plan_arn(String):

    The Amazon Resource Name (ARN) of the plan.

  • execution_id(String):

    The execution identifier of a plan execution.

  • version(Option<String>):

    The version for the plan.

  • updated_at(Option<DateTime>):

    The timestamp when the plan execution was last updated.

  • comment(Option<String>):

    A comment included on the plan execution.

  • start_time(DateTime):

    The time (UTC) when the plan execution started.

  • end_time(Option<DateTime>):

    The time (UTC) when the plan execution ended.

  • mode(ExecutionMode):

    The plan execution mode. Valid values are Practice, for testing without making actual changes, or Recovery, for actual traffic shifting and application recovery.

  • execution_state(ExecutionState):

    The plan execution state. Provides the state of a plan execution, for example, In Progress or Paused by Operator.

  • execution_action(ExecutionAction):

    The plan execution action. Valid values are Activate, to activate an Amazon Web Services Region, or Deactivate, to deactivate a Region.

  • execution_region(String):

    The Amazon Web Services Region for a plan execution.

  • step_states(Option<Vec::<StepState>>):

    The states of the steps in the plan execution.

  • plan(Option<Plan>):

    The details of the Region switch plan.

  • actual_recovery_time(Option<String>):

    The actual recovery time that Region switch calculates for a plan execution. Actual recovery time includes the time for the plan to run added to the time elapsed until the application health alarms that you’ve specified are healthy again.

  • next_token(Option<String>):

    Specifies that you want to receive the next page of results. Valid only if you received a nextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call’s nextToken response to request the next page of results.

• On failure, responds with SdkError<GetPlanExecutionError>

impl Client

pub fn get_plan_in_region(&self) -> GetPlanInRegionFluentBuilder

Constructs a fluent builder for the GetPlanInRegion operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the plan in Region.

    
    
• On success, responds with GetPlanInRegionOutput with field(s):
  • plan(Option<Plan>):

    The details of the Region switch plan.

• On failure, responds with SdkError<GetPlanInRegionError>

impl Client

pub fn list_plan_execution_events(&self) -> ListPlanExecutionEventsFluentBuilder

Constructs a fluent builder for the ListPlanExecutionEvents operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • plan_arn(impl Into<String>) / set_plan_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the plan.

    
    
  • execution_id(impl Into<String>) / set_execution_id(Option<String>):
    required: true
    

    The execution identifier of a plan execution.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The number of objects that you want to return with this call.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Specifies that you want to receive the next page of results. Valid only if you received a nextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call’s nextToken response to request the next page of results.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The name of the plan execution event.

    
    
• On success, responds with ListPlanExecutionEventsOutput with field(s):
  • items(Option<Vec::<ExecutionEvent>>):

    The items in the plan execution event.

  • next_token(Option<String>):

    Specifies that you want to receive the next page of results. Valid only if you received a nextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call’s nextToken response to request the next page of results.

• On failure, responds with SdkError<ListPlanExecutionEventsError>

impl Client

pub fn list_plan_executions(&self) -> ListPlanExecutionsFluentBuilder

Constructs a fluent builder for the ListPlanExecutions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • plan_arn(impl Into<String>) / set_plan_arn(Option<String>):
    required: true
    

    The ARN for the plan.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The number of objects that you want to return with this call.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Specifies that you want to receive the next page of results. Valid only if you received a nextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call’s nextToken response to request the next page of results.

    
    
  • state(ExecutionState) / set_state(Option<ExecutionState>):
    required: false
    

    The state of the plan execution. For example, the plan execution might be In Progress.

    
    
• On success, responds with ListPlanExecutionsOutput with field(s):
  • items(Option<Vec::<AbbreviatedExecution>>):

    The items in the plan execution to return.

  • next_token(Option<String>):

    Specifies that you want to receive the next page of results. Valid only if you received a nextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call’s nextToken response to request the next page of results.

• On failure, responds with SdkError<ListPlanExecutionsError>

impl Client

pub fn list_plans(&self) -> ListPlansFluentBuilder

Constructs a fluent builder for the ListPlans operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The number of objects that you want to return with this call.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Specifies that you want to receive the next page of results. Valid only if you received a nextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call’s nextToken response to request the next page of results.

    
    
• On success, responds with ListPlansOutput with field(s):
  • plans(Option<Vec::<AbbreviatedPlan>>):

    The plans that were requested.

  • next_token(Option<String>):

    Specifies that you want to receive the next page of results. Valid only if you received a nextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call’s nextToken response to request the next page of results.

• On failure, responds with SdkError<ListPlansError>

impl Client

pub fn list_plans_in_region(&self) -> ListPlansInRegionFluentBuilder

Constructs a fluent builder for the ListPlansInRegion operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The number of objects that you want to return with this call.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Specifies that you want to receive the next page of results. Valid only if you received a nextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call’s nextToken response to request the next page of results.

    
    
• On success, responds with ListPlansInRegionOutput with field(s):
  • plans(Option<Vec::<AbbreviatedPlan>>):

    The plans that were requested.

  • next_token(Option<String>):

    Specifies that you want to receive the next page of results. Valid only if you received a nextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call’s nextToken response to request the next page of results.

• On failure, responds with SdkError<ListPlansInRegionError>

impl Client

pub fn list_route53_health_checks(&self) -> ListRoute53HealthChecksFluentBuilder

Constructs a fluent builder for the ListRoute53HealthChecks operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the Amazon Route 53 health check request.

    
    
  • hosted_zone_id(impl Into<String>) / set_hosted_zone_id(Option<String>):
    required: false
    

    The hosted zone ID for the health checks.

    
    
  • record_name(impl Into<String>) / set_record_name(Option<String>):
    required: false
    

    The record name for the health checks.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The number of objects that you want to return with this call.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Specifies that you want to receive the next page of results. Valid only if you received a nextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call’s nextToken response to request the next page of results.

    
    
• On success, responds with ListRoute53HealthChecksOutput with field(s):
  • health_checks(Option<Vec::<Route53HealthCheck>>):

    List of the health checks requested.

  • next_token(Option<String>):

    Specifies that you want to receive the next page of results. Valid only if you received a nextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call’s nextToken response to request the next page of results.

• On failure, responds with SdkError<ListRoute53HealthChecksError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource.

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • resource_tags(Option<HashMap::<String, String>>):

    The tags for a resource.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn start_plan_execution(&self) -> StartPlanExecutionFluentBuilder

Constructs a fluent builder for the StartPlanExecution operation.

• The fluent builder is configurable:
  • plan_arn(impl Into<String>) / set_plan_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the plan to execute.

    
    
  • target_region(impl Into<String>) / set_target_region(Option<String>):
    required: true
    

    The Amazon Web Services Region to target with this execution. This is the Region that traffic will be shifted to or from, depending on the action.

    
    
  • action(ExecutionAction) / set_action(Option<ExecutionAction>):
    required: true
    

    The action to perform. Valid values are ACTIVATE (to shift traffic to the target Region) or DEACTIVATE (to shift traffic away from the target Region).

    
    
  • mode(ExecutionMode) / set_mode(Option<ExecutionMode>):
    required: false
    

    The plan execution mode. Valid values are Practice, for testing without making actual changes, or Recovery, for actual traffic shifting and application recovery.

    
    
  • comment(impl Into<String>) / set_comment(Option<String>):
    required: false
    

    An optional comment explaining why the plan execution is being started.

    
    
  • latest_version(impl Into<String>) / set_latest_version(Option<String>):
    required: false
    

    A boolean value indicating whether to use the latest version of the plan. If set to false, you must specify a specific version.

    
    
• On success, responds with StartPlanExecutionOutput with field(s):
  • execution_id(Option<String>):

    The execution identifier of a plan execution.

  • plan(Option<String>):

    The details of the Region switch plan.

  • plan_version(Option<String>):

    The version of the plan, a unique number generated by Region switch.

  • activate_region(Option<String>):

    The Amazon Web Services Region to activate.

  • deactivate_region(Option<String>):

    The Amazon Web Services Region to deactivate.

• On failure, responds with SdkError<StartPlanExecutionError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) for a tag that you add to a resource.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: true
    

    Tags that you add to a resource. You can add a maximum of 50 tags in Region switch.

    
    
• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) for a tag you remove a resource from.

    
    
  • resource_tag_keys(impl Into<String>) / set_resource_tag_keys(Option<Vec::<String>>):
    required: true
    

    Tag keys that you remove from a resource.

    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_plan(&self) -> UpdatePlanFluentBuilder

Constructs a fluent builder for the UpdatePlan operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the plan.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The updated description for the Region switch plan.

    
    
  • workflows(Workflow) / set_workflows(Option<Vec::<Workflow>>):
    required: true
    

    The updated workflows for the Region switch plan.

    
    
  • execution_role(impl Into<String>) / set_execution_role(Option<String>):
    required: true
    

    The updated IAM role ARN that grants Region switch the permissions needed to execute the plan steps.

    
    
  • recovery_time_objective_minutes(i32) / set_recovery_time_objective_minutes(Option<i32>):
    required: false
    

    The updated target recovery time objective (RTO) in minutes for the plan.

    
    
  • associated_alarms(impl Into<String>, AssociatedAlarm) / set_associated_alarms(Option<HashMap::<String, AssociatedAlarm>>):
    required: false
    

    The updated CloudWatch alarms associated with the plan.

    
    
  • triggers(Trigger) / set_triggers(Option<Vec::<Trigger>>):
    required: false
    

    The updated conditions that can automatically trigger the execution of the plan.

    
    
• On success, responds with UpdatePlanOutput with field(s):
  • plan(Option<Plan>):

    The details of the updated Region switch plan.

• On failure, responds with SdkError<UpdatePlanError>

impl Client

pub fn update_plan_execution(&self) -> UpdatePlanExecutionFluentBuilder

Constructs a fluent builder for the UpdatePlanExecution operation.

• The fluent builder is configurable:
  • plan_arn(impl Into<String>) / set_plan_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the plan with the execution to update.

    
    
  • execution_id(impl Into<String>) / set_execution_id(Option<String>):
    required: true
    

    The execution identifier of a plan execution.

    
    
  • action(UpdatePlanExecutionAction) / set_action(Option<UpdatePlanExecutionAction>):
    required: true
    

    The action specified for a plan execution, for example, Switch to Graceful or Pause.

    
    
  • comment(impl Into<String>) / set_comment(Option<String>):
    required: false
    

    An optional comment about the plan execution.

    
    
• On success, responds with UpdatePlanExecutionOutput
• On failure, responds with SdkError<UpdatePlanExecutionError>

impl Client

pub fn update_plan_execution_step(&self) -> UpdatePlanExecutionStepFluentBuilder

Constructs a fluent builder for the UpdatePlanExecutionStep operation.

• The fluent builder is configurable:
  • plan_arn(impl Into<String>) / set_plan_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the plan containing the execution step to update.

    
    
  • execution_id(impl Into<String>) / set_execution_id(Option<String>):
    required: true
    

    The unique identifier of the plan execution containing the step to update.

    
    
  • comment(impl Into<String>) / set_comment(Option<String>):
    required: true
    

    An optional comment about the plan execution.

    
    
  • step_name(impl Into<String>) / set_step_name(Option<String>):
    required: true
    

    The name of the execution step to update.

    
    
  • action_to_take(UpdatePlanExecutionStepAction) / set_action_to_take(Option<UpdatePlanExecutionStepAction>):
    required: true
    

    The updated action to take for the step. This can be used to skip or retry a step.

    
    
• On success, responds with UpdatePlanExecutionStepOutput
• On failure, responds with SdkError<UpdatePlanExecutionStepError>

impl Client

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 and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

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 the sleep_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 the http_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, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Waiters for Client

fn wait_until_plan_evaluation_status_passed( &self, ) -> PlanEvaluationStatusPassedFluentBuilder

Wait for plan_evaluation_status_passed

fn wait_until_plan_execution_completed( &self, ) -> PlanExecutionCompletedFluentBuilder

Wait for plan_execution_completed