All Superinterfaces:: AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface ArcRegionSwitchClient extends AwsClient

Service client for accessing ARC - Region switch. This can be created using the static builder() method.

Amazon Application Recovery Controller (ARC) Region switch helps you to quickly and reliably shift traffic away from an impaired Amazon Web Services Region to a healthy Region. With Region switch, you can create plans that define the steps to shift traffic for your application from one Amazon Web Services Region to another. You can test your plans in practice mode before using them in a real recovery scenario.

Region switch provides a structured approach to multi-Region failover, helping you to meet your recovery time objectives (RTOs) and maintain business continuity during regional disruptions.

Field Summary

Fields

Modifier and Type

Field

Description

static final String

SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

static final String

SERVICE_NAME
Method Summary

Modifier and Type

Method

Description

default ApprovePlanExecutionStepResponse

approvePlanExecutionStep(Consumer<ApprovePlanExecutionStepRequest.Builder> approvePlanExecutionStepRequest)

Approves a step in a plan execution that requires manual approval.

default ApprovePlanExecutionStepResponse

approvePlanExecutionStep(ApprovePlanExecutionStepRequest approvePlanExecutionStepRequest)

Approves a step in a plan execution that requires manual approval.

static ArcRegionSwitchClientBuilder

builder()

Create a builder that can be used to configure and create a ArcRegionSwitchClient.

default CancelPlanExecutionResponse

cancelPlanExecution(Consumer<CancelPlanExecutionRequest.Builder> cancelPlanExecutionRequest)

Cancels an in-progress plan execution.

default CancelPlanExecutionResponse

cancelPlanExecution(CancelPlanExecutionRequest cancelPlanExecutionRequest)

Cancels an in-progress plan execution.

static ArcRegionSwitchClient

create()

Create a ArcRegionSwitchClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

default CreatePlanResponse

createPlan(Consumer<CreatePlanRequest.Builder> createPlanRequest)

Creates a new Region switch plan.

default CreatePlanResponse

createPlan(CreatePlanRequest createPlanRequest)

Creates a new Region switch plan.

default DeletePlanResponse

deletePlan(Consumer<DeletePlanRequest.Builder> deletePlanRequest)

Deletes a Region switch plan.

default DeletePlanResponse

deletePlan(DeletePlanRequest deletePlanRequest)

Deletes a Region switch plan.

default GetPlanResponse

getPlan(Consumer<GetPlanRequest.Builder> getPlanRequest)

Retrieves detailed information about a Region switch plan.

default GetPlanResponse

getPlan(GetPlanRequest getPlanRequest)

Retrieves detailed information about a Region switch plan.

default GetPlanEvaluationStatusResponse

getPlanEvaluationStatus(Consumer<GetPlanEvaluationStatusRequest.Builder> getPlanEvaluationStatusRequest)

Retrieves the evaluation status of a Region switch plan.

default GetPlanEvaluationStatusResponse

getPlanEvaluationStatus(GetPlanEvaluationStatusRequest getPlanEvaluationStatusRequest)

Retrieves the evaluation status of a Region switch plan.

default GetPlanEvaluationStatusIterable

getPlanEvaluationStatusPaginator(Consumer<GetPlanEvaluationStatusRequest.Builder> getPlanEvaluationStatusRequest)

This is a variant of getPlanEvaluationStatus(software.amazon.awssdk.services.arcregionswitch.model.GetPlanEvaluationStatusRequest) operation.

default GetPlanEvaluationStatusIterable

getPlanEvaluationStatusPaginator(GetPlanEvaluationStatusRequest getPlanEvaluationStatusRequest)

This is a variant of getPlanEvaluationStatus(software.amazon.awssdk.services.arcregionswitch.model.GetPlanEvaluationStatusRequest) operation.

default GetPlanExecutionResponse

getPlanExecution(Consumer<GetPlanExecutionRequest.Builder> getPlanExecutionRequest)

Retrieves detailed information about a specific plan execution.

default GetPlanExecutionResponse

getPlanExecution(GetPlanExecutionRequest getPlanExecutionRequest)

Retrieves detailed information about a specific plan execution.

default GetPlanExecutionIterable

getPlanExecutionPaginator(Consumer<GetPlanExecutionRequest.Builder> getPlanExecutionRequest)

This is a variant of getPlanExecution(software.amazon.awssdk.services.arcregionswitch.model.GetPlanExecutionRequest) operation.

default GetPlanExecutionIterable

getPlanExecutionPaginator(GetPlanExecutionRequest getPlanExecutionRequest)

This is a variant of getPlanExecution(software.amazon.awssdk.services.arcregionswitch.model.GetPlanExecutionRequest) operation.

default GetPlanInRegionResponse

getPlanInRegion(Consumer<GetPlanInRegionRequest.Builder> getPlanInRegionRequest)

Retrieves information about a Region switch plan in a specific Amazon Web Services Region.

default GetPlanInRegionResponse

getPlanInRegion(GetPlanInRegionRequest getPlanInRegionRequest)

Retrieves information about a Region switch plan in a specific Amazon Web Services Region.

default ListPlanExecutionEventsResponse

listPlanExecutionEvents(Consumer<ListPlanExecutionEventsRequest.Builder> listPlanExecutionEventsRequest)

Lists the events that occurred during a plan execution.

default ListPlanExecutionEventsResponse

listPlanExecutionEvents(ListPlanExecutionEventsRequest listPlanExecutionEventsRequest)

Lists the events that occurred during a plan execution.

default ListPlanExecutionEventsIterable

listPlanExecutionEventsPaginator(Consumer<ListPlanExecutionEventsRequest.Builder> listPlanExecutionEventsRequest)

This is a variant of listPlanExecutionEvents(software.amazon.awssdk.services.arcregionswitch.model.ListPlanExecutionEventsRequest) operation.

default ListPlanExecutionEventsIterable

listPlanExecutionEventsPaginator(ListPlanExecutionEventsRequest listPlanExecutionEventsRequest)

This is a variant of listPlanExecutionEvents(software.amazon.awssdk.services.arcregionswitch.model.ListPlanExecutionEventsRequest) operation.

default ListPlanExecutionsResponse

listPlanExecutions(Consumer<ListPlanExecutionsRequest.Builder> listPlanExecutionsRequest)

Lists the executions of a Region switch plan.

default ListPlanExecutionsResponse

listPlanExecutions(ListPlanExecutionsRequest listPlanExecutionsRequest)

Lists the executions of a Region switch plan.

default ListPlanExecutionsIterable

listPlanExecutionsPaginator(Consumer<ListPlanExecutionsRequest.Builder> listPlanExecutionsRequest)

This is a variant of listPlanExecutions(software.amazon.awssdk.services.arcregionswitch.model.ListPlanExecutionsRequest) operation.

default ListPlanExecutionsIterable

listPlanExecutionsPaginator(ListPlanExecutionsRequest listPlanExecutionsRequest)

This is a variant of listPlanExecutions(software.amazon.awssdk.services.arcregionswitch.model.ListPlanExecutionsRequest) operation.

default ListPlansResponse

listPlans(Consumer<ListPlansRequest.Builder> listPlansRequest)

Lists all Region switch plans in your Amazon Web Services account.

default ListPlansResponse

listPlans(ListPlansRequest listPlansRequest)

Lists all Region switch plans in your Amazon Web Services account.

default ListPlansInRegionResponse

listPlansInRegion(Consumer<ListPlansInRegionRequest.Builder> listPlansInRegionRequest)

Lists all Region switch plans in your Amazon Web Services account that are available in the current Amazon Web Services Region.

default ListPlansInRegionResponse

listPlansInRegion(ListPlansInRegionRequest listPlansInRegionRequest)

Lists all Region switch plans in your Amazon Web Services account that are available in the current Amazon Web Services Region.

default ListPlansInRegionIterable

listPlansInRegionPaginator(Consumer<ListPlansInRegionRequest.Builder> listPlansInRegionRequest)

This is a variant of listPlansInRegion(software.amazon.awssdk.services.arcregionswitch.model.ListPlansInRegionRequest) operation.

default ListPlansInRegionIterable

listPlansInRegionPaginator(ListPlansInRegionRequest listPlansInRegionRequest)

This is a variant of listPlansInRegion(software.amazon.awssdk.services.arcregionswitch.model.ListPlansInRegionRequest) operation.

default ListPlansIterable

listPlansPaginator(Consumer<ListPlansRequest.Builder> listPlansRequest)

This is a variant of listPlans(software.amazon.awssdk.services.arcregionswitch.model.ListPlansRequest) operation.

default ListPlansIterable

listPlansPaginator(ListPlansRequest listPlansRequest)

This is a variant of listPlans(software.amazon.awssdk.services.arcregionswitch.model.ListPlansRequest) operation.

default ListRoute53HealthChecksResponse

listRoute53HealthChecks(Consumer<ListRoute53HealthChecksRequest.Builder> listRoute53HealthChecksRequest)

List the Amazon Route 53 health checks.

default ListRoute53HealthChecksResponse

listRoute53HealthChecks(ListRoute53HealthChecksRequest listRoute53HealthChecksRequest)

List the Amazon Route 53 health checks.

default ListRoute53HealthChecksIterable

listRoute53HealthChecksPaginator(Consumer<ListRoute53HealthChecksRequest.Builder> listRoute53HealthChecksRequest)

This is a variant of listRoute53HealthChecks(software.amazon.awssdk.services.arcregionswitch.model.ListRoute53HealthChecksRequest) operation.

default ListRoute53HealthChecksIterable

listRoute53HealthChecksPaginator(ListRoute53HealthChecksRequest listRoute53HealthChecksRequest)

This is a variant of listRoute53HealthChecks(software.amazon.awssdk.services.arcregionswitch.model.ListRoute53HealthChecksRequest) operation.

default ListTagsForResourceResponse

listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)

Lists the tags attached to a Region switch resource.

default ListTagsForResourceResponse

listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Lists the tags attached to a Region switch resource.

default ArcRegionSwitchServiceClientConfiguration

serviceClientConfiguration()

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

static ServiceMetadata

serviceMetadata()

default StartPlanExecutionResponse

startPlanExecution(Consumer<StartPlanExecutionRequest.Builder> startPlanExecutionRequest)

Starts the execution of a Region switch plan.

default StartPlanExecutionResponse

startPlanExecution(StartPlanExecutionRequest startPlanExecutionRequest)

Starts the execution of a Region switch plan.

default TagResourceResponse

tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)

Adds or updates tags for a Region switch resource.

default TagResourceResponse

tagResource(TagResourceRequest tagResourceRequest)

Adds or updates tags for a Region switch resource.

default UntagResourceResponse

untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)

Removes tags from a Region switch resource.

default UntagResourceResponse

untagResource(UntagResourceRequest untagResourceRequest)

Removes tags from a Region switch resource.

default UpdatePlanResponse

updatePlan(Consumer<UpdatePlanRequest.Builder> updatePlanRequest)

Updates an existing Region switch plan.

default UpdatePlanResponse

updatePlan(UpdatePlanRequest updatePlanRequest)

Updates an existing Region switch plan.

default UpdatePlanExecutionResponse

updatePlanExecution(Consumer<UpdatePlanExecutionRequest.Builder> updatePlanExecutionRequest)

Updates an in-progress plan execution.

default UpdatePlanExecutionResponse

updatePlanExecution(UpdatePlanExecutionRequest updatePlanExecutionRequest)

Updates an in-progress plan execution.

default UpdatePlanExecutionStepResponse

updatePlanExecutionStep(Consumer<UpdatePlanExecutionStepRequest.Builder> updatePlanExecutionStepRequest)

Updates a specific step in an in-progress plan execution.

default UpdatePlanExecutionStepResponse

updatePlanExecutionStep(UpdatePlanExecutionStepRequest updatePlanExecutionStepRequest)

Updates a specific step in an in-progress plan execution.

default ArcRegionSwitchWaiter

waiter()

Create an instance of ArcRegionSwitchWaiter using this client.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close

Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName

Field Details
- SERVICE_NAME
  static final String SERVICE_NAME
  
  See Also:
  
  Constant Field Values
- SERVICE_METADATA_ID
  static final String SERVICE_METADATA_ID
  
  Value for looking up the service's metadata from the ServiceMetadataProvider.
  
  See Also:
  
  Constant Field Values
Method Details
- approvePlanExecutionStep
  default ApprovePlanExecutionStepResponse approvePlanExecutionStep(ApprovePlanExecutionStepRequest approvePlanExecutionStepRequest) throws ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, ArcRegionSwitchException
  
  Approves a step in a plan execution that requires manual approval. When you create a plan, you can include approval steps that require manual intervention before the execution can proceed. This operation allows you to provide that approval.
  
  You must specify the plan ARN, execution ID, step name, and approval status. You can also provide an optional comment explaining the approval decision.
  
  Parameters:
  
  approvePlanExecutionStepRequest -
  
  Returns:
  
  Result of the ApprovePlanExecutionStep operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- approvePlanExecutionStep
  default ApprovePlanExecutionStepResponse approvePlanExecutionStep(Consumer<ApprovePlanExecutionStepRequest.Builder> approvePlanExecutionStepRequest) throws ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, ArcRegionSwitchException
  
  Approves a step in a plan execution that requires manual approval. When you create a plan, you can include approval steps that require manual intervention before the execution can proceed. This operation allows you to provide that approval.
  
  You must specify the plan ARN, execution ID, step name, and approval status. You can also provide an optional comment explaining the approval decision.
  
  This is a convenience which creates an instance of the ApprovePlanExecutionStepRequest.Builder avoiding the need to create one manually via ApprovePlanExecutionStepRequest.builder()
  
  Parameters:
  
  approvePlanExecutionStepRequest - A Consumer that will call methods on ApprovePlanExecutionStepRequest.Builder to create a request.
  
  Returns:
  
  Result of the ApprovePlanExecutionStep operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- cancelPlanExecution
  default CancelPlanExecutionResponse cancelPlanExecution(CancelPlanExecutionRequest cancelPlanExecutionRequest) throws ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, ArcRegionSwitchException
  
  Cancels an in-progress plan execution. This operation stops the execution of the plan and prevents any further steps from being processed.
  
  You must specify the plan ARN and execution ID. You can also provide an optional comment explaining why the execution was canceled.
  
  Parameters:
  
  cancelPlanExecutionRequest -
  
  Returns:
  
  Result of the CancelPlanExecution operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- cancelPlanExecution
  default CancelPlanExecutionResponse cancelPlanExecution(Consumer<CancelPlanExecutionRequest.Builder> cancelPlanExecutionRequest) throws ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, ArcRegionSwitchException
  
  Cancels an in-progress plan execution. This operation stops the execution of the plan and prevents any further steps from being processed.
  
  You must specify the plan ARN and execution ID. You can also provide an optional comment explaining why the execution was canceled.
  
  This is a convenience which creates an instance of the CancelPlanExecutionRequest.Builder avoiding the need to create one manually via CancelPlanExecutionRequest.builder()
  
  Parameters:
  
  cancelPlanExecutionRequest - A Consumer that will call methods on CancelPlanExecutionRequest.Builder to create a request.
  
  Returns:
  
  Result of the CancelPlanExecution operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- createPlan
  default CreatePlanResponse createPlan(CreatePlanRequest createPlanRequest) throws AwsServiceException, SdkClientException, ArcRegionSwitchException
  
  Creates a new Region switch plan. A plan defines the steps required to shift traffic from one Amazon Web Services Region to another.
  
  You must specify a name for the plan, the primary Region, and at least one additional Region. You can also provide a description, execution role, recovery time objective, associated alarms, triggers, and workflows that define the steps to execute during a Region switch.
  
  Parameters:
  
  createPlanRequest -
  
  Returns:
  
  Result of the CreatePlan operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- createPlan
  default CreatePlanResponse createPlan(Consumer<CreatePlanRequest.Builder> createPlanRequest) throws AwsServiceException, SdkClientException, ArcRegionSwitchException
  
  Creates a new Region switch plan. A plan defines the steps required to shift traffic from one Amazon Web Services Region to another.
  
  You must specify a name for the plan, the primary Region, and at least one additional Region. You can also provide a description, execution role, recovery time objective, associated alarms, triggers, and workflows that define the steps to execute during a Region switch.
  
  This is a convenience which creates an instance of the CreatePlanRequest.Builder avoiding the need to create one manually via CreatePlanRequest.builder()
  
  Parameters:
  
  createPlanRequest - A Consumer that will call methods on CreatePlanRequest.Builder to create a request.
  
  Returns:
  
  Result of the CreatePlan operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- deletePlan
  default DeletePlanResponse deletePlan(DeletePlanRequest deletePlanRequest) throws ResourceNotFoundException, IllegalStateException, AwsServiceException, SdkClientException, ArcRegionSwitchException
  
  Deletes a Region switch plan. You must specify the ARN of the plan to delete.
  
  You cannot delete a plan that has an active execution in progress.
  
  Parameters:
  
  deletePlanRequest -
  
  Returns:
  
  Result of the DeletePlan operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- deletePlan
  default DeletePlanResponse deletePlan(Consumer<DeletePlanRequest.Builder> deletePlanRequest) throws ResourceNotFoundException, IllegalStateException, AwsServiceException, SdkClientException, ArcRegionSwitchException
  
  Deletes a Region switch plan. You must specify the ARN of the plan to delete.
  
  You cannot delete a plan that has an active execution in progress.
  
  This is a convenience which creates an instance of the DeletePlanRequest.Builder avoiding the need to create one manually via DeletePlanRequest.builder()
  
  Parameters:
  
  deletePlanRequest - A Consumer that will call methods on DeletePlanRequest.Builder to create a request.
  
  Returns:
  
  Result of the DeletePlan operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- getPlan
  default GetPlanResponse getPlan(GetPlanRequest getPlanRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, ArcRegionSwitchException
  
  Retrieves detailed information about a Region switch plan. You must specify the ARN of the plan.
  
  Parameters:
  
  getPlanRequest -
  
  Returns:
  
  Result of the GetPlan operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- getPlan
  default GetPlanResponse getPlan(Consumer<GetPlanRequest.Builder> getPlanRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, ArcRegionSwitchException
  
  Retrieves detailed information about a Region switch plan. You must specify the ARN of the plan.
  
  This is a convenience which creates an instance of the GetPlanRequest.Builder avoiding the need to create one manually via GetPlanRequest.builder()
  
  Parameters:
  
  getPlanRequest - A Consumer that will call methods on GetPlanRequest.Builder to create a request.
  
  Returns:
  
  Result of the GetPlan operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- getPlanEvaluationStatus
  default GetPlanEvaluationStatusResponse getPlanEvaluationStatus(GetPlanEvaluationStatusRequest getPlanEvaluationStatusRequest) throws ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, ArcRegionSwitchException
  
  Retrieves the evaluation status of a Region switch plan. The evaluation status provides information about the last time the plan was evaluated and any warnings or issues detected.
  
  Parameters:
  
  getPlanEvaluationStatusRequest -
  
  Returns:
  
  Result of the GetPlanEvaluationStatus operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- getPlanEvaluationStatus
  default GetPlanEvaluationStatusResponse getPlanEvaluationStatus(Consumer<GetPlanEvaluationStatusRequest.Builder> getPlanEvaluationStatusRequest) throws ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, ArcRegionSwitchException
  
  Retrieves the evaluation status of a Region switch plan. The evaluation status provides information about the last time the plan was evaluated and any warnings or issues detected.
  
  This is a convenience which creates an instance of the GetPlanEvaluationStatusRequest.Builder avoiding the need to create one manually via GetPlanEvaluationStatusRequest.builder()
  
  Parameters:
  
  getPlanEvaluationStatusRequest - A Consumer that will call methods on GetPlanEvaluationStatusRequest.Builder to create a request.
  
  Returns:
  
  Result of the GetPlanEvaluationStatus operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- getPlanEvaluationStatusPaginator
  default GetPlanEvaluationStatusIterable getPlanEvaluationStatusPaginator(GetPlanEvaluationStatusRequest getPlanEvaluationStatusRequest) throws ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, ArcRegionSwitchException
  
  This is a variant of getPlanEvaluationStatus(software.amazon.awssdk.services.arcregionswitch.model.GetPlanEvaluationStatusRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.
  
  When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
  
  The following are few ways to iterate through the response pages:
  1) Using a Stream
  software.amazon.awssdk.services.arcregionswitch.paginators.GetPlanEvaluationStatusIterable responses = client.getPlanEvaluationStatusPaginator(request); responses.stream().forEach(....);
  2) Using For loop
  { @code software.amazon.awssdk.services.arcregionswitch.paginators.GetPlanEvaluationStatusIterable responses = client .getPlanEvaluationStatusPaginator(request); for (software.amazon.awssdk.services.arcregionswitch.model.GetPlanEvaluationStatusResponse response : responses) { // do something; } }
  3) Use iterator directly
  software.amazon.awssdk.services.arcregionswitch.paginators.GetPlanEvaluationStatusIterable responses = client.getPlanEvaluationStatusPaginator(request); responses.iterator().forEachRemaining(....);
  
  Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
  
  Note: If you prefer to have control on service calls, use the getPlanEvaluationStatus(software.amazon.awssdk.services.arcregionswitch.model.GetPlanEvaluationStatusRequest) operation.
  
  Parameters:
  
  getPlanEvaluationStatusRequest -
  
  Returns:
  
  A custom iterable that can be used to iterate through all the response pages.
  
  See Also:
  
  AWS API Documentation
- getPlanEvaluationStatusPaginator
  default GetPlanEvaluationStatusIterable getPlanEvaluationStatusPaginator(Consumer<GetPlanEvaluationStatusRequest.Builder> getPlanEvaluationStatusRequest) throws ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, ArcRegionSwitchException
  
  This is a variant of getPlanEvaluationStatus(software.amazon.awssdk.services.arcregionswitch.model.GetPlanEvaluationStatusRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.
  
  When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
  
  The following are few ways to iterate through the response pages:
  1) Using a Stream
  software.amazon.awssdk.services.arcregionswitch.paginators.GetPlanEvaluationStatusIterable responses = client.getPlanEvaluationStatusPaginator(request); responses.stream().forEach(....);
  2) Using For loop
  { @code software.amazon.awssdk.services.arcregionswitch.paginators.GetPlanEvaluationStatusIterable responses = client .getPlanEvaluationStatusPaginator(request); for (software.amazon.awssdk.services.arcregionswitch.model.GetPlanEvaluationStatusResponse response : responses) { // do something; } }
  3) Use iterator directly
  software.amazon.awssdk.services.arcregionswitch.paginators.GetPlanEvaluationStatusIterable responses = client.getPlanEvaluationStatusPaginator(request); responses.iterator().forEachRemaining(....);
  
  Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
  
  Note: If you prefer to have control on service calls, use the getPlanEvaluationStatus(software.amazon.awssdk.services.arcregionswitch.model.GetPlanEvaluationStatusRequest) operation.
  
  This is a convenience which creates an instance of the GetPlanEvaluationStatusRequest.Builder avoiding the need to create one manually via GetPlanEvaluationStatusRequest.builder()
  
  Parameters:
  
  getPlanEvaluationStatusRequest - A Consumer that will call methods on GetPlanEvaluationStatusRequest.Builder to create a request.
  
  Returns:
  
  A custom iterable that can be used to iterate through all the response pages.
  
  See Also:
  
  AWS API Documentation
- getPlanExecution
  default GetPlanExecutionResponse getPlanExecution(GetPlanExecutionRequest getPlanExecutionRequest) throws ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, ArcRegionSwitchException
  
  Retrieves detailed information about a specific plan execution. You must specify the plan ARN and execution ID.
  
  Parameters:
  
  getPlanExecutionRequest -
  
  Returns:
  
  Result of the GetPlanExecution operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- getPlanExecution
  default GetPlanExecutionResponse getPlanExecution(Consumer<GetPlanExecutionRequest.Builder> getPlanExecutionRequest) throws ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, ArcRegionSwitchException
  
  Retrieves detailed information about a specific plan execution. You must specify the plan ARN and execution ID.
  
  This is a convenience which creates an instance of the GetPlanExecutionRequest.Builder avoiding the need to create one manually via GetPlanExecutionRequest.builder()
  
  Parameters:
  
  getPlanExecutionRequest - A Consumer that will call methods on GetPlanExecutionRequest.Builder to create a request.
  
  Returns:
  
  Result of the GetPlanExecution operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- getPlanExecutionPaginator
  default GetPlanExecutionIterable getPlanExecutionPaginator(GetPlanExecutionRequest getPlanExecutionRequest) throws ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, ArcRegionSwitchException
  
  This is a variant of getPlanExecution(software.amazon.awssdk.services.arcregionswitch.model.GetPlanExecutionRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.
  
  When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
  
  The following are few ways to iterate through the response pages:
  1) Using a Stream
  software.amazon.awssdk.services.arcregionswitch.paginators.GetPlanExecutionIterable responses = client.getPlanExecutionPaginator(request); responses.stream().forEach(....);
  2) Using For loop
  { @code software.amazon.awssdk.services.arcregionswitch.paginators.GetPlanExecutionIterable responses = client .getPlanExecutionPaginator(request); for (software.amazon.awssdk.services.arcregionswitch.model.GetPlanExecutionResponse response : responses) { // do something; } }
  3) Use iterator directly
  software.amazon.awssdk.services.arcregionswitch.paginators.GetPlanExecutionIterable responses = client.getPlanExecutionPaginator(request); responses.iterator().forEachRemaining(....);
  
  Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
  
  Note: If you prefer to have control on service calls, use the getPlanExecution(software.amazon.awssdk.services.arcregionswitch.model.GetPlanExecutionRequest) operation.
  
  Parameters:
  
  getPlanExecutionRequest -
  
  Returns:
  
  A custom iterable that can be used to iterate through all the response pages.
  
  See Also:
  
  AWS API Documentation
- getPlanExecutionPaginator
  default GetPlanExecutionIterable getPlanExecutionPaginator(Consumer<GetPlanExecutionRequest.Builder> getPlanExecutionRequest) throws ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, ArcRegionSwitchException
  
  This is a variant of getPlanExecution(software.amazon.awssdk.services.arcregionswitch.model.GetPlanExecutionRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.
  
  When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
  
  The following are few ways to iterate through the response pages:
  1) Using a Stream
  software.amazon.awssdk.services.arcregionswitch.paginators.GetPlanExecutionIterable responses = client.getPlanExecutionPaginator(request); responses.stream().forEach(....);
  2) Using For loop
  { @code software.amazon.awssdk.services.arcregionswitch.paginators.GetPlanExecutionIterable responses = client .getPlanExecutionPaginator(request); for (software.amazon.awssdk.services.arcregionswitch.model.GetPlanExecutionResponse response : responses) { // do something; } }
  3) Use iterator directly
  software.amazon.awssdk.services.arcregionswitch.paginators.GetPlanExecutionIterable responses = client.getPlanExecutionPaginator(request); responses.iterator().forEachRemaining(....);
  
  Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
  
  Note: If you prefer to have control on service calls, use the getPlanExecution(software.amazon.awssdk.services.arcregionswitch.model.GetPlanExecutionRequest) operation.
  
  This is a convenience which creates an instance of the GetPlanExecutionRequest.Builder avoiding the need to create one manually via GetPlanExecutionRequest.builder()
  
  Parameters:
  
  getPlanExecutionRequest - A Consumer that will call methods on GetPlanExecutionRequest.Builder to create a request.
  
  Returns:
  
  A custom iterable that can be used to iterate through all the response pages.
  
  See Also:
  
  AWS API Documentation
- getPlanInRegion
  default GetPlanInRegionResponse getPlanInRegion(GetPlanInRegionRequest getPlanInRegionRequest) throws ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, ArcRegionSwitchException
  
  Retrieves information about a Region switch plan in a specific Amazon Web Services Region. This operation is useful for getting Region-specific information about a plan.
  
  Parameters:
  
  getPlanInRegionRequest -
  
  Returns:
  
  Result of the GetPlanInRegion operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- getPlanInRegion
  default GetPlanInRegionResponse getPlanInRegion(Consumer<GetPlanInRegionRequest.Builder> getPlanInRegionRequest) throws ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, ArcRegionSwitchException
  
  Retrieves information about a Region switch plan in a specific Amazon Web Services Region. This operation is useful for getting Region-specific information about a plan.
  
  This is a convenience which creates an instance of the GetPlanInRegionRequest.Builder avoiding the need to create one manually via GetPlanInRegionRequest.builder()
  
  Parameters:
  
  getPlanInRegionRequest - A Consumer that will call methods on GetPlanInRegionRequest.Builder to create a request.
  
  Returns:
  
  Result of the GetPlanInRegion operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- listPlanExecutionEvents
  default ListPlanExecutionEventsResponse listPlanExecutionEvents(ListPlanExecutionEventsRequest listPlanExecutionEventsRequest) throws ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, ArcRegionSwitchException
  
  Lists the events that occurred during a plan execution. These events provide a detailed timeline of the execution process.
  
  Parameters:
  
  listPlanExecutionEventsRequest -
  
  Returns:
  
  Result of the ListPlanExecutionEvents operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- listPlanExecutionEvents
  default ListPlanExecutionEventsResponse listPlanExecutionEvents(Consumer<ListPlanExecutionEventsRequest.Builder> listPlanExecutionEventsRequest) throws ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, ArcRegionSwitchException
  
  Lists the events that occurred during a plan execution. These events provide a detailed timeline of the execution process.
  
  This is a convenience which creates an instance of the ListPlanExecutionEventsRequest.Builder avoiding the need to create one manually via ListPlanExecutionEventsRequest.builder()
  
  Parameters:
  
  listPlanExecutionEventsRequest - A Consumer that will call methods on ListPlanExecutionEventsRequest.Builder to create a request.
  
  Returns:
  
  Result of the ListPlanExecutionEvents operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- listPlanExecutionEventsPaginator
  default ListPlanExecutionEventsIterable listPlanExecutionEventsPaginator(ListPlanExecutionEventsRequest listPlanExecutionEventsRequest) throws ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, ArcRegionSwitchException
  
  This is a variant of listPlanExecutionEvents(software.amazon.awssdk.services.arcregionswitch.model.ListPlanExecutionEventsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.
  
  When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
  
  The following are few ways to iterate through the response pages:
  1) Using a Stream
  software.amazon.awssdk.services.arcregionswitch.paginators.ListPlanExecutionEventsIterable responses = client.listPlanExecutionEventsPaginator(request); responses.stream().forEach(....);
  2) Using For loop
  { @code software.amazon.awssdk.services.arcregionswitch.paginators.ListPlanExecutionEventsIterable responses = client .listPlanExecutionEventsPaginator(request); for (software.amazon.awssdk.services.arcregionswitch.model.ListPlanExecutionEventsResponse response : responses) { // do something; } }
  3) Use iterator directly
  software.amazon.awssdk.services.arcregionswitch.paginators.ListPlanExecutionEventsIterable responses = client.listPlanExecutionEventsPaginator(request); responses.iterator().forEachRemaining(....);
  
  Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
  
  Note: If you prefer to have control on service calls, use the listPlanExecutionEvents(software.amazon.awssdk.services.arcregionswitch.model.ListPlanExecutionEventsRequest) operation.
  
  Parameters:
  
  listPlanExecutionEventsRequest -
  
  Returns:
  
  A custom iterable that can be used to iterate through all the response pages.
  
  See Also:
  
  AWS API Documentation
- listPlanExecutionEventsPaginator
  default ListPlanExecutionEventsIterable listPlanExecutionEventsPaginator(Consumer<ListPlanExecutionEventsRequest.Builder> listPlanExecutionEventsRequest) throws ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, ArcRegionSwitchException
  
  This is a variant of listPlanExecutionEvents(software.amazon.awssdk.services.arcregionswitch.model.ListPlanExecutionEventsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.
  
  When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
  
  The following are few ways to iterate through the response pages:
  1) Using a Stream
  software.amazon.awssdk.services.arcregionswitch.paginators.ListPlanExecutionEventsIterable responses = client.listPlanExecutionEventsPaginator(request); responses.stream().forEach(....);
  2) Using For loop
  { @code software.amazon.awssdk.services.arcregionswitch.paginators.ListPlanExecutionEventsIterable responses = client .listPlanExecutionEventsPaginator(request); for (software.amazon.awssdk.services.arcregionswitch.model.ListPlanExecutionEventsResponse response : responses) { // do something; } }
  3) Use iterator directly
  software.amazon.awssdk.services.arcregionswitch.paginators.ListPlanExecutionEventsIterable responses = client.listPlanExecutionEventsPaginator(request); responses.iterator().forEachRemaining(....);
  
  Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
  
  Note: If you prefer to have control on service calls, use the listPlanExecutionEvents(software.amazon.awssdk.services.arcregionswitch.model.ListPlanExecutionEventsRequest) operation.
  
  This is a convenience which creates an instance of the ListPlanExecutionEventsRequest.Builder avoiding the need to create one manually via ListPlanExecutionEventsRequest.builder()
  
  Parameters:
  
  listPlanExecutionEventsRequest - A Consumer that will call methods on ListPlanExecutionEventsRequest.Builder to create a request.
  
  Returns:
  
  A custom iterable that can be used to iterate through all the response pages.
  
  See Also:
  
  AWS API Documentation
- listPlanExecutions
  default ListPlanExecutionsResponse listPlanExecutions(ListPlanExecutionsRequest listPlanExecutionsRequest) throws ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, ArcRegionSwitchException
  
  Lists the executions of a Region switch plan. This operation returns information about both current and historical executions.
  
  Parameters:
  
  listPlanExecutionsRequest -
  
  Returns:
  
  Result of the ListPlanExecutions operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- listPlanExecutions
  default ListPlanExecutionsResponse listPlanExecutions(Consumer<ListPlanExecutionsRequest.Builder> listPlanExecutionsRequest) throws ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, ArcRegionSwitchException
  
  Lists the executions of a Region switch plan. This operation returns information about both current and historical executions.
  
  This is a convenience which creates an instance of the ListPlanExecutionsRequest.Builder avoiding the need to create one manually via ListPlanExecutionsRequest.builder()
  
  Parameters:
  
  listPlanExecutionsRequest - A Consumer that will call methods on ListPlanExecutionsRequest.Builder to create a request.
  
  Returns:
  
  Result of the ListPlanExecutions operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- listPlanExecutionsPaginator
  default ListPlanExecutionsIterable listPlanExecutionsPaginator(ListPlanExecutionsRequest listPlanExecutionsRequest) throws ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, ArcRegionSwitchException
  
  This is a variant of listPlanExecutions(software.amazon.awssdk.services.arcregionswitch.model.ListPlanExecutionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.
  
  When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
  
  The following are few ways to iterate through the response pages:
  1) Using a Stream
  software.amazon.awssdk.services.arcregionswitch.paginators.ListPlanExecutionsIterable responses = client.listPlanExecutionsPaginator(request); responses.stream().forEach(....);
  2) Using For loop
  { @code software.amazon.awssdk.services.arcregionswitch.paginators.ListPlanExecutionsIterable responses = client .listPlanExecutionsPaginator(request); for (software.amazon.awssdk.services.arcregionswitch.model.ListPlanExecutionsResponse response : responses) { // do something; } }
  3) Use iterator directly
  software.amazon.awssdk.services.arcregionswitch.paginators.ListPlanExecutionsIterable responses = client.listPlanExecutionsPaginator(request); responses.iterator().forEachRemaining(....);
  
  Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
  
  Note: If you prefer to have control on service calls, use the listPlanExecutions(software.amazon.awssdk.services.arcregionswitch.model.ListPlanExecutionsRequest) operation.
  
  Parameters:
  
  listPlanExecutionsRequest -
  
  Returns:
  
  A custom iterable that can be used to iterate through all the response pages.
  
  See Also:
  
  AWS API Documentation
- listPlanExecutionsPaginator
  default ListPlanExecutionsIterable listPlanExecutionsPaginator(Consumer<ListPlanExecutionsRequest.Builder> listPlanExecutionsRequest) throws ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, ArcRegionSwitchException
  
  This is a variant of listPlanExecutions(software.amazon.awssdk.services.arcregionswitch.model.ListPlanExecutionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.
  
  When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
  
  The following are few ways to iterate through the response pages:
  1) Using a Stream
  software.amazon.awssdk.services.arcregionswitch.paginators.ListPlanExecutionsIterable responses = client.listPlanExecutionsPaginator(request); responses.stream().forEach(....);
  2) Using For loop
  { @code software.amazon.awssdk.services.arcregionswitch.paginators.ListPlanExecutionsIterable responses = client .listPlanExecutionsPaginator(request); for (software.amazon.awssdk.services.arcregionswitch.model.ListPlanExecutionsResponse response : responses) { // do something; } }
  3) Use iterator directly
  software.amazon.awssdk.services.arcregionswitch.paginators.ListPlanExecutionsIterable responses = client.listPlanExecutionsPaginator(request); responses.iterator().forEachRemaining(....);
  
  Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
  
  Note: If you prefer to have control on service calls, use the listPlanExecutions(software.amazon.awssdk.services.arcregionswitch.model.ListPlanExecutionsRequest) operation.
  
  This is a convenience which creates an instance of the ListPlanExecutionsRequest.Builder avoiding the need to create one manually via ListPlanExecutionsRequest.builder()
  
  Parameters:
  
  listPlanExecutionsRequest - A Consumer that will call methods on ListPlanExecutionsRequest.Builder to create a request.
  
  Returns:
  
  A custom iterable that can be used to iterate through all the response pages.
  
  See Also:
  
  AWS API Documentation
- listPlans
  default ListPlansResponse listPlans(ListPlansRequest listPlansRequest) throws AwsServiceException, SdkClientException, ArcRegionSwitchException
  
  Lists all Region switch plans in your Amazon Web Services account.
  
  Parameters:
  
  listPlansRequest -
  
  Returns:
  
  Result of the ListPlans operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- listPlans
  default ListPlansResponse listPlans(Consumer<ListPlansRequest.Builder> listPlansRequest) throws AwsServiceException, SdkClientException, ArcRegionSwitchException
  
  Lists all Region switch plans in your Amazon Web Services account.
  
  This is a convenience which creates an instance of the ListPlansRequest.Builder avoiding the need to create one manually via ListPlansRequest.builder()
  
  Parameters:
  
  listPlansRequest - A Consumer that will call methods on ListPlansRequest.Builder to create a request.
  
  Returns:
  
  Result of the ListPlans operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- listPlansPaginator
  default ListPlansIterable listPlansPaginator(ListPlansRequest listPlansRequest) throws AwsServiceException, SdkClientException, ArcRegionSwitchException
  
  This is a variant of listPlans(software.amazon.awssdk.services.arcregionswitch.model.ListPlansRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.
  
  When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
  
  The following are few ways to iterate through the response pages:
  1) Using a Stream
  software.amazon.awssdk.services.arcregionswitch.paginators.ListPlansIterable responses = client.listPlansPaginator(request); responses.stream().forEach(....);
  2) Using For loop
  { @code software.amazon.awssdk.services.arcregionswitch.paginators.ListPlansIterable responses = client.listPlansPaginator(request); for (software.amazon.awssdk.services.arcregionswitch.model.ListPlansResponse response : responses) { // do something; } }
  3) Use iterator directly
  software.amazon.awssdk.services.arcregionswitch.paginators.ListPlansIterable responses = client.listPlansPaginator(request); responses.iterator().forEachRemaining(....);
  
  Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
  
  Note: If you prefer to have control on service calls, use the listPlans(software.amazon.awssdk.services.arcregionswitch.model.ListPlansRequest) operation.
  
  Parameters:
  
  listPlansRequest -
  
  Returns:
  
  A custom iterable that can be used to iterate through all the response pages.
  
  See Also:
  
  AWS API Documentation
- listPlansPaginator
  default ListPlansIterable listPlansPaginator(Consumer<ListPlansRequest.Builder> listPlansRequest) throws AwsServiceException, SdkClientException, ArcRegionSwitchException
  
  This is a variant of listPlans(software.amazon.awssdk.services.arcregionswitch.model.ListPlansRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.
  
  When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
  
  The following are few ways to iterate through the response pages:
  1) Using a Stream
  software.amazon.awssdk.services.arcregionswitch.paginators.ListPlansIterable responses = client.listPlansPaginator(request); responses.stream().forEach(....);
  2) Using For loop
  { @code software.amazon.awssdk.services.arcregionswitch.paginators.ListPlansIterable responses = client.listPlansPaginator(request); for (software.amazon.awssdk.services.arcregionswitch.model.ListPlansResponse response : responses) { // do something; } }
  3) Use iterator directly
  software.amazon.awssdk.services.arcregionswitch.paginators.ListPlansIterable responses = client.listPlansPaginator(request); responses.iterator().forEachRemaining(....);
  
  Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
  
  Note: If you prefer to have control on service calls, use the listPlans(software.amazon.awssdk.services.arcregionswitch.model.ListPlansRequest) operation.
  
  This is a convenience which creates an instance of the ListPlansRequest.Builder avoiding the need to create one manually via ListPlansRequest.builder()
  
  Parameters:
  
  listPlansRequest - A Consumer that will call methods on ListPlansRequest.Builder to create a request.
  
  Returns:
  
  A custom iterable that can be used to iterate through all the response pages.
  
  See Also:
  
  AWS API Documentation
- listPlansInRegion
  default ListPlansInRegionResponse listPlansInRegion(ListPlansInRegionRequest listPlansInRegionRequest) throws AccessDeniedException, AwsServiceException, SdkClientException, ArcRegionSwitchException
  
  Lists all Region switch plans in your Amazon Web Services account that are available in the current Amazon Web Services Region.
  
  Parameters:
  
  listPlansInRegionRequest -
  
  Returns:
  
  Result of the ListPlansInRegion operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- listPlansInRegion
  default ListPlansInRegionResponse listPlansInRegion(Consumer<ListPlansInRegionRequest.Builder> listPlansInRegionRequest) throws AccessDeniedException, AwsServiceException, SdkClientException, ArcRegionSwitchException
  
  Lists all Region switch plans in your Amazon Web Services account that are available in the current Amazon Web Services Region.
  
  This is a convenience which creates an instance of the ListPlansInRegionRequest.Builder avoiding the need to create one manually via ListPlansInRegionRequest.builder()
  
  Parameters:
  
  listPlansInRegionRequest - A Consumer that will call methods on ListPlansInRegionRequest.Builder to create a request.
  
  Returns:
  
  Result of the ListPlansInRegion operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- listPlansInRegionPaginator
  default ListPlansInRegionIterable listPlansInRegionPaginator(ListPlansInRegionRequest listPlansInRegionRequest) throws AccessDeniedException, AwsServiceException, SdkClientException, ArcRegionSwitchException
  
  This is a variant of listPlansInRegion(software.amazon.awssdk.services.arcregionswitch.model.ListPlansInRegionRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.
  
  When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
  
  The following are few ways to iterate through the response pages:
  1) Using a Stream
  software.amazon.awssdk.services.arcregionswitch.paginators.ListPlansInRegionIterable responses = client.listPlansInRegionPaginator(request); responses.stream().forEach(....);
  2) Using For loop
  { @code software.amazon.awssdk.services.arcregionswitch.paginators.ListPlansInRegionIterable responses = client .listPlansInRegionPaginator(request); for (software.amazon.awssdk.services.arcregionswitch.model.ListPlansInRegionResponse response : responses) { // do something; } }
  3) Use iterator directly
  software.amazon.awssdk.services.arcregionswitch.paginators.ListPlansInRegionIterable responses = client.listPlansInRegionPaginator(request); responses.iterator().forEachRemaining(....);
  
  Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
  
  Note: If you prefer to have control on service calls, use the listPlansInRegion(software.amazon.awssdk.services.arcregionswitch.model.ListPlansInRegionRequest) operation.
  
  Parameters:
  
  listPlansInRegionRequest -
  
  Returns:
  
  A custom iterable that can be used to iterate through all the response pages.
  
  See Also:
  
  AWS API Documentation
- listPlansInRegionPaginator
  default ListPlansInRegionIterable listPlansInRegionPaginator(Consumer<ListPlansInRegionRequest.Builder> listPlansInRegionRequest) throws AccessDeniedException, AwsServiceException, SdkClientException, ArcRegionSwitchException
  
  This is a variant of listPlansInRegion(software.amazon.awssdk.services.arcregionswitch.model.ListPlansInRegionRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.
  
  When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
  
  The following are few ways to iterate through the response pages:
  1) Using a Stream
  software.amazon.awssdk.services.arcregionswitch.paginators.ListPlansInRegionIterable responses = client.listPlansInRegionPaginator(request); responses.stream().forEach(....);
  2) Using For loop
  { @code software.amazon.awssdk.services.arcregionswitch.paginators.ListPlansInRegionIterable responses = client .listPlansInRegionPaginator(request); for (software.amazon.awssdk.services.arcregionswitch.model.ListPlansInRegionResponse response : responses) { // do something; } }
  3) Use iterator directly
  software.amazon.awssdk.services.arcregionswitch.paginators.ListPlansInRegionIterable responses = client.listPlansInRegionPaginator(request); responses.iterator().forEachRemaining(....);
  
  Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
  
  Note: If you prefer to have control on service calls, use the listPlansInRegion(software.amazon.awssdk.services.arcregionswitch.model.ListPlansInRegionRequest) operation.
  
  This is a convenience which creates an instance of the ListPlansInRegionRequest.Builder avoiding the need to create one manually via ListPlansInRegionRequest.builder()
  
  Parameters:
  
  listPlansInRegionRequest - A Consumer that will call methods on ListPlansInRegionRequest.Builder to create a request.
  
  Returns:
  
  A custom iterable that can be used to iterate through all the response pages.
  
  See Also:
  
  AWS API Documentation
- listRoute53HealthChecks
  default ListRoute53HealthChecksResponse listRoute53HealthChecks(ListRoute53HealthChecksRequest listRoute53HealthChecksRequest) throws ResourceNotFoundException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, ArcRegionSwitchException
  
  List the Amazon Route 53 health checks.
  
  Parameters:
  
  listRoute53HealthChecksRequest -
  
  Returns:
  
  Result of the ListRoute53HealthChecks operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- listRoute53HealthChecks
  default ListRoute53HealthChecksResponse listRoute53HealthChecks(Consumer<ListRoute53HealthChecksRequest.Builder> listRoute53HealthChecksRequest) throws ResourceNotFoundException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, ArcRegionSwitchException
  
  List the Amazon Route 53 health checks.
  
  This is a convenience which creates an instance of the ListRoute53HealthChecksRequest.Builder avoiding the need to create one manually via ListRoute53HealthChecksRequest.builder()
  
  Parameters:
  
  listRoute53HealthChecksRequest - A Consumer that will call methods on ListRoute53HealthChecksRequest.Builder to create a request.
  
  Returns:
  
  Result of the ListRoute53HealthChecks operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- listRoute53HealthChecksPaginator
  default ListRoute53HealthChecksIterable listRoute53HealthChecksPaginator(ListRoute53HealthChecksRequest listRoute53HealthChecksRequest) throws ResourceNotFoundException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, ArcRegionSwitchException
  
  This is a variant of listRoute53HealthChecks(software.amazon.awssdk.services.arcregionswitch.model.ListRoute53HealthChecksRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.
  
  When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
  
  The following are few ways to iterate through the response pages:
  1) Using a Stream
  software.amazon.awssdk.services.arcregionswitch.paginators.ListRoute53HealthChecksIterable responses = client.listRoute53HealthChecksPaginator(request); responses.stream().forEach(....);
  2) Using For loop
  { @code software.amazon.awssdk.services.arcregionswitch.paginators.ListRoute53HealthChecksIterable responses = client .listRoute53HealthChecksPaginator(request); for (software.amazon.awssdk.services.arcregionswitch.model.ListRoute53HealthChecksResponse response : responses) { // do something; } }
  3) Use iterator directly
  software.amazon.awssdk.services.arcregionswitch.paginators.ListRoute53HealthChecksIterable responses = client.listRoute53HealthChecksPaginator(request); responses.iterator().forEachRemaining(....);
  
  Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
  
  Note: If you prefer to have control on service calls, use the listRoute53HealthChecks(software.amazon.awssdk.services.arcregionswitch.model.ListRoute53HealthChecksRequest) operation.
  
  Parameters:
  
  listRoute53HealthChecksRequest -
  
  Returns:
  
  A custom iterable that can be used to iterate through all the response pages.
  
  See Also:
  
  AWS API Documentation
- listRoute53HealthChecksPaginator
  default ListRoute53HealthChecksIterable listRoute53HealthChecksPaginator(Consumer<ListRoute53HealthChecksRequest.Builder> listRoute53HealthChecksRequest) throws ResourceNotFoundException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, ArcRegionSwitchException
  
  This is a variant of listRoute53HealthChecks(software.amazon.awssdk.services.arcregionswitch.model.ListRoute53HealthChecksRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.
  
  When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
  
  The following are few ways to iterate through the response pages:
  1) Using a Stream
  software.amazon.awssdk.services.arcregionswitch.paginators.ListRoute53HealthChecksIterable responses = client.listRoute53HealthChecksPaginator(request); responses.stream().forEach(....);
  2) Using For loop
  { @code software.amazon.awssdk.services.arcregionswitch.paginators.ListRoute53HealthChecksIterable responses = client .listRoute53HealthChecksPaginator(request); for (software.amazon.awssdk.services.arcregionswitch.model.ListRoute53HealthChecksResponse response : responses) { // do something; } }
  3) Use iterator directly
  software.amazon.awssdk.services.arcregionswitch.paginators.ListRoute53HealthChecksIterable responses = client.listRoute53HealthChecksPaginator(request); responses.iterator().forEachRemaining(....);
  
  Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
  
  Note: If you prefer to have control on service calls, use the listRoute53HealthChecks(software.amazon.awssdk.services.arcregionswitch.model.ListRoute53HealthChecksRequest) operation.
  
  This is a convenience which creates an instance of the ListRoute53HealthChecksRequest.Builder avoiding the need to create one manually via ListRoute53HealthChecksRequest.builder()
  
  Parameters:
  
  listRoute53HealthChecksRequest - A Consumer that will call methods on ListRoute53HealthChecksRequest.Builder to create a request.
  
  Returns:
  
  A custom iterable that can be used to iterate through all the response pages.
  
  See Also:
  
  AWS API Documentation
- listTagsForResource
  default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ArcRegionSwitchException
  
  Lists the tags attached to a Region switch resource.
  
  Parameters:
  
  listTagsForResourceRequest -
  
  Returns:
  
  Result of the ListTagsForResource operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- listTagsForResource
  default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ArcRegionSwitchException
  
  Lists the tags attached to a Region switch resource.
  
  This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()
  
  Parameters:
  
  listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.
  
  Returns:
  
  Result of the ListTagsForResource operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- startPlanExecution
  default StartPlanExecutionResponse startPlanExecution(StartPlanExecutionRequest startPlanExecutionRequest) throws ResourceNotFoundException, IllegalStateException, AccessDeniedException, IllegalArgumentException, AwsServiceException, SdkClientException, ArcRegionSwitchException
  
  Starts the execution of a Region switch plan. You can execute a plan in either PRACTICE or RECOVERY mode.
  
  In PRACTICE mode, the execution simulates the steps without making actual changes to your application's traffic routing. In RECOVERY mode, the execution performs actual changes to shift traffic between Regions.
  
  Parameters:
  
  startPlanExecutionRequest -
  
  Returns:
  
  Result of the StartPlanExecution operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- startPlanExecution
  default StartPlanExecutionResponse startPlanExecution(Consumer<StartPlanExecutionRequest.Builder> startPlanExecutionRequest) throws ResourceNotFoundException, IllegalStateException, AccessDeniedException, IllegalArgumentException, AwsServiceException, SdkClientException, ArcRegionSwitchException
  
  Starts the execution of a Region switch plan. You can execute a plan in either PRACTICE or RECOVERY mode.
  
  In PRACTICE mode, the execution simulates the steps without making actual changes to your application's traffic routing. In RECOVERY mode, the execution performs actual changes to shift traffic between Regions.
  
  This is a convenience which creates an instance of the StartPlanExecutionRequest.Builder avoiding the need to create one manually via StartPlanExecutionRequest.builder()
  
  Parameters:
  
  startPlanExecutionRequest - A Consumer that will call methods on StartPlanExecutionRequest.Builder to create a request.
  
  Returns:
  
  Result of the StartPlanExecution operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- tagResource
  default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ArcRegionSwitchException
  
  Adds or updates tags for a Region switch resource. You can assign metadata to your resources in the form of tags, which are key-value pairs.
  
  Parameters:
  
  tagResourceRequest -
  
  Returns:
  
  Result of the TagResource operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- tagResource
  default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ArcRegionSwitchException
  
  Adds or updates tags for a Region switch resource. You can assign metadata to your resources in the form of tags, which are key-value pairs.
  
  This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()
  
  Parameters:
  
  tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.
  
  Returns:
  
  Result of the TagResource operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- untagResource
  default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ArcRegionSwitchException
  
  Removes tags from a Region switch resource.
  
  Parameters:
  
  untagResourceRequest -
  
  Returns:
  
  Result of the UntagResource operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- untagResource
  default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ArcRegionSwitchException
  
  Removes tags from a Region switch resource.
  
  This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()
  
  Parameters:
  
  untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.
  
  Returns:
  
  Result of the UntagResource operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- updatePlan
  default UpdatePlanResponse updatePlan(UpdatePlanRequest updatePlanRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, ArcRegionSwitchException
  
  Updates an existing Region switch plan. You can modify the plan's description, workflows, execution role, recovery time objective, associated alarms, and triggers.
  
  Parameters:
  
  updatePlanRequest -
  
  Returns:
  
  Result of the UpdatePlan operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- updatePlan
  default UpdatePlanResponse updatePlan(Consumer<UpdatePlanRequest.Builder> updatePlanRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, ArcRegionSwitchException
  
  Updates an existing Region switch plan. You can modify the plan's description, workflows, execution role, recovery time objective, associated alarms, and triggers.
  
  This is a convenience which creates an instance of the UpdatePlanRequest.Builder avoiding the need to create one manually via UpdatePlanRequest.builder()
  
  Parameters:
  
  updatePlanRequest - A Consumer that will call methods on UpdatePlanRequest.Builder to create a request.
  
  Returns:
  
  Result of the UpdatePlan operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- updatePlanExecution
  default UpdatePlanExecutionResponse updatePlanExecution(UpdatePlanExecutionRequest updatePlanExecutionRequest) throws ResourceNotFoundException, IllegalStateException, AccessDeniedException, AwsServiceException, SdkClientException, ArcRegionSwitchException
  
  Updates an in-progress plan execution. This operation allows you to modify certain aspects of the execution, such as adding a comment or changing the action.
  
  Parameters:
  
  updatePlanExecutionRequest -
  
  Returns:
  
  Result of the UpdatePlanExecution operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- updatePlanExecution
  default UpdatePlanExecutionResponse updatePlanExecution(Consumer<UpdatePlanExecutionRequest.Builder> updatePlanExecutionRequest) throws ResourceNotFoundException, IllegalStateException, AccessDeniedException, AwsServiceException, SdkClientException, ArcRegionSwitchException
  
  Updates an in-progress plan execution. This operation allows you to modify certain aspects of the execution, such as adding a comment or changing the action.
  
  This is a convenience which creates an instance of the UpdatePlanExecutionRequest.Builder avoiding the need to create one manually via UpdatePlanExecutionRequest.builder()
  
  Parameters:
  
  updatePlanExecutionRequest - A Consumer that will call methods on UpdatePlanExecutionRequest.Builder to create a request.
  
  Returns:
  
  Result of the UpdatePlanExecution operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- updatePlanExecutionStep
  default UpdatePlanExecutionStepResponse updatePlanExecutionStep(UpdatePlanExecutionStepRequest updatePlanExecutionStepRequest) throws ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, ArcRegionSwitchException
  
  Updates a specific step in an in-progress plan execution. This operation allows you to modify the step's comment or action.
  
  Parameters:
  
  updatePlanExecutionStepRequest -
  
  Returns:
  
  Result of the UpdatePlanExecutionStep operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- updatePlanExecutionStep
  default UpdatePlanExecutionStepResponse updatePlanExecutionStep(Consumer<UpdatePlanExecutionStepRequest.Builder> updatePlanExecutionStepRequest) throws ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, ArcRegionSwitchException
  
  Updates a specific step in an in-progress plan execution. This operation allows you to modify the step's comment or action.
  
  This is a convenience which creates an instance of the UpdatePlanExecutionStepRequest.Builder avoiding the need to create one manually via UpdatePlanExecutionStepRequest.builder()
  
  Parameters:
  
  updatePlanExecutionStepRequest - A Consumer that will call methods on UpdatePlanExecutionStepRequest.Builder to create a request.
  
  Returns:
  
  Result of the UpdatePlanExecutionStep operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- waiter
  
  default ArcRegionSwitchWaiter waiter()
  
  Create an instance of ArcRegionSwitchWaiter using this client.
  Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
  
  Returns:
  
  an instance of ArcRegionSwitchWaiter
- create
  
  static ArcRegionSwitchClient create()
  
  Create a ArcRegionSwitchClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
- builder
  
  static ArcRegionSwitchClientBuilder builder()
  
  Create a builder that can be used to configure and create a ArcRegionSwitchClient.
- serviceMetadata
  
  static ServiceMetadata serviceMetadata()
- serviceClientConfiguration
  
  default ArcRegionSwitchServiceClientConfiguration serviceClientConfiguration()
  
  Description copied from interface: SdkClient
  
  The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
  
  Specified by:
  
  serviceClientConfiguration in interface AwsClient
  
  Specified by:
  
  serviceClientConfiguration in interface SdkClient
  
  Returns:
  
  SdkServiceClientConfiguration

Interface ArcRegionSwitchClient

Field Summary

Method Summary

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

Methods inherited from interface software.amazon.awssdk.core.SdkClient

Field Details

SERVICE_NAME

SERVICE_METADATA_ID

Method Details

approvePlanExecutionStep

approvePlanExecutionStep

cancelPlanExecution

cancelPlanExecution

createPlan

createPlan

deletePlan

deletePlan

getPlan

getPlan

getPlanEvaluationStatus

getPlanEvaluationStatus

getPlanEvaluationStatusPaginator

getPlanEvaluationStatusPaginator

getPlanExecution

getPlanExecution

getPlanExecutionPaginator

getPlanExecutionPaginator

getPlanInRegion

getPlanInRegion

listPlanExecutionEvents

listPlanExecutionEvents

listPlanExecutionEventsPaginator

listPlanExecutionEventsPaginator

listPlanExecutions

listPlanExecutions

listPlanExecutionsPaginator

listPlanExecutionsPaginator

listPlans

listPlans

listPlansPaginator

listPlansPaginator

listPlansInRegion

listPlansInRegion

listPlansInRegionPaginator

listPlansInRegionPaginator

listRoute53HealthChecks

listRoute53HealthChecks

listRoute53HealthChecksPaginator

listRoute53HealthChecksPaginator

listTagsForResource

listTagsForResource

startPlanExecution

startPlanExecution

tagResource

tagResource

untagResource

untagResource

updatePlan

updatePlan

updatePlanExecution

updatePlanExecution

updatePlanExecutionStep

updatePlanExecutionStep

waiter

create

builder

serviceMetadata

serviceClientConfiguration