Interface ArcRegionSwitchAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface ArcRegionSwitchAsyncClient extends AwsClient
Service client for accessing ARC - Region switch asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call.

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 Details

  • Method Details

    • approvePlanExecutionStep

      default CompletableFuture<ApprovePlanExecutionStepResponse> approvePlanExecutionStep(ApprovePlanExecutionStepRequest approvePlanExecutionStepRequest)

      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:
      A Java Future containing the result of the ApprovePlanExecutionStep operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The specified resource was not found.

        HTTP Status Code: 404

      • AccessDeniedException You do not have sufficient access to perform this action.

        HTTP Status Code: 403

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ArcRegionSwitchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • approvePlanExecutionStep

      default CompletableFuture<ApprovePlanExecutionStepResponse> approvePlanExecutionStep(Consumer<ApprovePlanExecutionStepRequest.Builder> approvePlanExecutionStepRequest)

      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:
      A Java Future containing the result of the ApprovePlanExecutionStep operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The specified resource was not found.

        HTTP Status Code: 404

      • AccessDeniedException You do not have sufficient access to perform this action.

        HTTP Status Code: 403

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ArcRegionSwitchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • cancelPlanExecution

      default CompletableFuture<CancelPlanExecutionResponse> cancelPlanExecution(CancelPlanExecutionRequest cancelPlanExecutionRequest)

      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:
      A Java Future containing the result of the CancelPlanExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The specified resource was not found.

        HTTP Status Code: 404

      • AccessDeniedException You do not have sufficient access to perform this action.

        HTTP Status Code: 403

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ArcRegionSwitchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • cancelPlanExecution

      default CompletableFuture<CancelPlanExecutionResponse> cancelPlanExecution(Consumer<CancelPlanExecutionRequest.Builder> cancelPlanExecutionRequest)

      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:
      A Java Future containing the result of the CancelPlanExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The specified resource was not found.

        HTTP Status Code: 404

      • AccessDeniedException You do not have sufficient access to perform this action.

        HTTP Status Code: 403

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ArcRegionSwitchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createPlan

      default CompletableFuture<CreatePlanResponse> createPlan(CreatePlanRequest createPlanRequest)

      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:
      A Java Future containing the result of the CreatePlan operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ArcRegionSwitchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createPlan

      default CompletableFuture<CreatePlanResponse> createPlan(Consumer<CreatePlanRequest.Builder> createPlanRequest)

      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:
      A Java Future containing the result of the CreatePlan operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ArcRegionSwitchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deletePlan

      default CompletableFuture<DeletePlanResponse> deletePlan(DeletePlanRequest deletePlanRequest)

      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:
      A Java Future containing the result of the DeletePlan operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The specified resource was not found.

        HTTP Status Code: 404

      • IllegalStateException The operation failed because the current state of the resource doesn't allow the operation to proceed.

        HTTP Status Code: 400

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ArcRegionSwitchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deletePlan

      default CompletableFuture<DeletePlanResponse> deletePlan(Consumer<DeletePlanRequest.Builder> deletePlanRequest)

      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:
      A Java Future containing the result of the DeletePlan operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The specified resource was not found.

        HTTP Status Code: 404

      • IllegalStateException The operation failed because the current state of the resource doesn't allow the operation to proceed.

        HTTP Status Code: 400

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ArcRegionSwitchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getPlan

      default CompletableFuture<GetPlanResponse> getPlan(GetPlanRequest getPlanRequest)

      Retrieves detailed information about a Region switch plan. You must specify the ARN of the plan.

      Parameters:
      getPlanRequest -
      Returns:
      A Java Future containing the result of the GetPlan operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The specified resource was not found.

        HTTP Status Code: 404

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ArcRegionSwitchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getPlan

      default CompletableFuture<GetPlanResponse> getPlan(Consumer<GetPlanRequest.Builder> getPlanRequest)

      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:
      A Java Future containing the result of the GetPlan operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The specified resource was not found.

        HTTP Status Code: 404

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ArcRegionSwitchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getPlanEvaluationStatus

      default CompletableFuture<GetPlanEvaluationStatusResponse> getPlanEvaluationStatus(GetPlanEvaluationStatusRequest getPlanEvaluationStatusRequest)

      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:
      A Java Future containing the result of the GetPlanEvaluationStatus operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The specified resource was not found.

        HTTP Status Code: 404

      • AccessDeniedException You do not have sufficient access to perform this action.

        HTTP Status Code: 403

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ArcRegionSwitchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getPlanEvaluationStatus

      default CompletableFuture<GetPlanEvaluationStatusResponse> getPlanEvaluationStatus(Consumer<GetPlanEvaluationStatusRequest.Builder> getPlanEvaluationStatusRequest)

      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:
      A Java Future containing the result of the GetPlanEvaluationStatus operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The specified resource was not found.

        HTTP Status Code: 404

      • AccessDeniedException You do not have sufficient access to perform this action.

        HTTP Status Code: 403

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ArcRegionSwitchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getPlanEvaluationStatusPaginator

      default GetPlanEvaluationStatusPublisher getPlanEvaluationStatusPaginator(GetPlanEvaluationStatusRequest getPlanEvaluationStatusRequest)

      This is a variant of getPlanEvaluationStatus(software.amazon.awssdk.services.arcregionswitch.model.GetPlanEvaluationStatusRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.arcregionswitch.paginators.GetPlanEvaluationStatusPublisher publisher = client.getPlanEvaluationStatusPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.arcregionswitch.paginators.GetPlanEvaluationStatusPublisher publisher = client.getPlanEvaluationStatusPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.arcregionswitch.model.GetPlanEvaluationStatusResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.arcregionswitch.model.GetPlanEvaluationStatusResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The specified resource was not found.

        HTTP Status Code: 404

      • AccessDeniedException You do not have sufficient access to perform this action.

        HTTP Status Code: 403

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ArcRegionSwitchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getPlanEvaluationStatusPaginator

      default GetPlanEvaluationStatusPublisher getPlanEvaluationStatusPaginator(Consumer<GetPlanEvaluationStatusRequest.Builder> getPlanEvaluationStatusRequest)

      This is a variant of getPlanEvaluationStatus(software.amazon.awssdk.services.arcregionswitch.model.GetPlanEvaluationStatusRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.arcregionswitch.paginators.GetPlanEvaluationStatusPublisher publisher = client.getPlanEvaluationStatusPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.arcregionswitch.paginators.GetPlanEvaluationStatusPublisher publisher = client.getPlanEvaluationStatusPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.arcregionswitch.model.GetPlanEvaluationStatusResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.arcregionswitch.model.GetPlanEvaluationStatusResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The specified resource was not found.

        HTTP Status Code: 404

      • AccessDeniedException You do not have sufficient access to perform this action.

        HTTP Status Code: 403

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ArcRegionSwitchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getPlanExecution

      default CompletableFuture<GetPlanExecutionResponse> getPlanExecution(GetPlanExecutionRequest getPlanExecutionRequest)

      Retrieves detailed information about a specific plan execution. You must specify the plan ARN and execution ID.

      Parameters:
      getPlanExecutionRequest -
      Returns:
      A Java Future containing the result of the GetPlanExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The specified resource was not found.

        HTTP Status Code: 404

      • AccessDeniedException You do not have sufficient access to perform this action.

        HTTP Status Code: 403

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ArcRegionSwitchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getPlanExecution

      default CompletableFuture<GetPlanExecutionResponse> getPlanExecution(Consumer<GetPlanExecutionRequest.Builder> getPlanExecutionRequest)

      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:
      A Java Future containing the result of the GetPlanExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The specified resource was not found.

        HTTP Status Code: 404

      • AccessDeniedException You do not have sufficient access to perform this action.

        HTTP Status Code: 403

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ArcRegionSwitchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getPlanExecutionPaginator

      default GetPlanExecutionPublisher getPlanExecutionPaginator(GetPlanExecutionRequest getPlanExecutionRequest)

      This is a variant of getPlanExecution(software.amazon.awssdk.services.arcregionswitch.model.GetPlanExecutionRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.arcregionswitch.paginators.GetPlanExecutionPublisher publisher = client.getPlanExecutionPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.arcregionswitch.paginators.GetPlanExecutionPublisher publisher = client.getPlanExecutionPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.arcregionswitch.model.GetPlanExecutionResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.arcregionswitch.model.GetPlanExecutionResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The specified resource was not found.

        HTTP Status Code: 404

      • AccessDeniedException You do not have sufficient access to perform this action.

        HTTP Status Code: 403

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ArcRegionSwitchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getPlanExecutionPaginator

      default GetPlanExecutionPublisher getPlanExecutionPaginator(Consumer<GetPlanExecutionRequest.Builder> getPlanExecutionRequest)

      This is a variant of getPlanExecution(software.amazon.awssdk.services.arcregionswitch.model.GetPlanExecutionRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.arcregionswitch.paginators.GetPlanExecutionPublisher publisher = client.getPlanExecutionPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.arcregionswitch.paginators.GetPlanExecutionPublisher publisher = client.getPlanExecutionPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.arcregionswitch.model.GetPlanExecutionResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.arcregionswitch.model.GetPlanExecutionResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The specified resource was not found.

        HTTP Status Code: 404

      • AccessDeniedException You do not have sufficient access to perform this action.

        HTTP Status Code: 403

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ArcRegionSwitchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getPlanInRegion

      default CompletableFuture<GetPlanInRegionResponse> getPlanInRegion(GetPlanInRegionRequest getPlanInRegionRequest)

      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:
      A Java Future containing the result of the GetPlanInRegion operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The specified resource was not found.

        HTTP Status Code: 404

      • AccessDeniedException You do not have sufficient access to perform this action.

        HTTP Status Code: 403

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ArcRegionSwitchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getPlanInRegion

      default CompletableFuture<GetPlanInRegionResponse> getPlanInRegion(Consumer<GetPlanInRegionRequest.Builder> getPlanInRegionRequest)

      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:
      A Java Future containing the result of the GetPlanInRegion operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The specified resource was not found.

        HTTP Status Code: 404

      • AccessDeniedException You do not have sufficient access to perform this action.

        HTTP Status Code: 403

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ArcRegionSwitchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPlanExecutionEvents

      default CompletableFuture<ListPlanExecutionEventsResponse> listPlanExecutionEvents(ListPlanExecutionEventsRequest listPlanExecutionEventsRequest)

      Lists the events that occurred during a plan execution. These events provide a detailed timeline of the execution process.

      Parameters:
      listPlanExecutionEventsRequest -
      Returns:
      A Java Future containing the result of the ListPlanExecutionEvents operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The specified resource was not found.

        HTTP Status Code: 404

      • AccessDeniedException You do not have sufficient access to perform this action.

        HTTP Status Code: 403

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ArcRegionSwitchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPlanExecutionEvents

      default CompletableFuture<ListPlanExecutionEventsResponse> listPlanExecutionEvents(Consumer<ListPlanExecutionEventsRequest.Builder> listPlanExecutionEventsRequest)

      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:
      A Java Future containing the result of the ListPlanExecutionEvents operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The specified resource was not found.

        HTTP Status Code: 404

      • AccessDeniedException You do not have sufficient access to perform this action.

        HTTP Status Code: 403

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ArcRegionSwitchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPlanExecutionEventsPaginator

      default ListPlanExecutionEventsPublisher listPlanExecutionEventsPaginator(ListPlanExecutionEventsRequest listPlanExecutionEventsRequest)

      This is a variant of listPlanExecutionEvents(software.amazon.awssdk.services.arcregionswitch.model.ListPlanExecutionEventsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.arcregionswitch.paginators.ListPlanExecutionEventsPublisher publisher = client.listPlanExecutionEventsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.arcregionswitch.paginators.ListPlanExecutionEventsPublisher publisher = client.listPlanExecutionEventsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.arcregionswitch.model.ListPlanExecutionEventsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.arcregionswitch.model.ListPlanExecutionEventsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The specified resource was not found.

        HTTP Status Code: 404

      • AccessDeniedException You do not have sufficient access to perform this action.

        HTTP Status Code: 403

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ArcRegionSwitchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPlanExecutionEventsPaginator

      default ListPlanExecutionEventsPublisher listPlanExecutionEventsPaginator(Consumer<ListPlanExecutionEventsRequest.Builder> listPlanExecutionEventsRequest)

      This is a variant of listPlanExecutionEvents(software.amazon.awssdk.services.arcregionswitch.model.ListPlanExecutionEventsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.arcregionswitch.paginators.ListPlanExecutionEventsPublisher publisher = client.listPlanExecutionEventsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.arcregionswitch.paginators.ListPlanExecutionEventsPublisher publisher = client.listPlanExecutionEventsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.arcregionswitch.model.ListPlanExecutionEventsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.arcregionswitch.model.ListPlanExecutionEventsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The specified resource was not found.

        HTTP Status Code: 404

      • AccessDeniedException You do not have sufficient access to perform this action.

        HTTP Status Code: 403

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ArcRegionSwitchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPlanExecutions

      default CompletableFuture<ListPlanExecutionsResponse> listPlanExecutions(ListPlanExecutionsRequest listPlanExecutionsRequest)

      Lists the executions of a Region switch plan. This operation returns information about both current and historical executions.

      Parameters:
      listPlanExecutionsRequest -
      Returns:
      A Java Future containing the result of the ListPlanExecutions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The specified resource was not found.

        HTTP Status Code: 404

      • AccessDeniedException You do not have sufficient access to perform this action.

        HTTP Status Code: 403

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ArcRegionSwitchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPlanExecutions

      default CompletableFuture<ListPlanExecutionsResponse> listPlanExecutions(Consumer<ListPlanExecutionsRequest.Builder> listPlanExecutionsRequest)

      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:
      A Java Future containing the result of the ListPlanExecutions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The specified resource was not found.

        HTTP Status Code: 404

      • AccessDeniedException You do not have sufficient access to perform this action.

        HTTP Status Code: 403

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ArcRegionSwitchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPlanExecutionsPaginator

      default ListPlanExecutionsPublisher listPlanExecutionsPaginator(ListPlanExecutionsRequest listPlanExecutionsRequest)

      This is a variant of listPlanExecutions(software.amazon.awssdk.services.arcregionswitch.model.ListPlanExecutionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.arcregionswitch.paginators.ListPlanExecutionsPublisher publisher = client.listPlanExecutionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.arcregionswitch.paginators.ListPlanExecutionsPublisher publisher = client.listPlanExecutionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.arcregionswitch.model.ListPlanExecutionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.arcregionswitch.model.ListPlanExecutionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The specified resource was not found.

        HTTP Status Code: 404

      • AccessDeniedException You do not have sufficient access to perform this action.

        HTTP Status Code: 403

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ArcRegionSwitchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPlanExecutionsPaginator

      default ListPlanExecutionsPublisher listPlanExecutionsPaginator(Consumer<ListPlanExecutionsRequest.Builder> listPlanExecutionsRequest)

      This is a variant of listPlanExecutions(software.amazon.awssdk.services.arcregionswitch.model.ListPlanExecutionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.arcregionswitch.paginators.ListPlanExecutionsPublisher publisher = client.listPlanExecutionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.arcregionswitch.paginators.ListPlanExecutionsPublisher publisher = client.listPlanExecutionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.arcregionswitch.model.ListPlanExecutionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.arcregionswitch.model.ListPlanExecutionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The specified resource was not found.

        HTTP Status Code: 404

      • AccessDeniedException You do not have sufficient access to perform this action.

        HTTP Status Code: 403

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ArcRegionSwitchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPlans

      default CompletableFuture<ListPlansResponse> listPlans(ListPlansRequest listPlansRequest)

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

      Parameters:
      listPlansRequest -
      Returns:
      A Java Future containing the result of the ListPlans operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ArcRegionSwitchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPlans

      default CompletableFuture<ListPlansResponse> listPlans(Consumer<ListPlansRequest.Builder> listPlansRequest)

      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:
      A Java Future containing the result of the ListPlans operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ArcRegionSwitchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPlansInRegion

      default CompletableFuture<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.

      Parameters:
      listPlansInRegionRequest -
      Returns:
      A Java Future containing the result of the ListPlansInRegion operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You do not have sufficient access to perform this action.

        HTTP Status Code: 403

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ArcRegionSwitchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPlansInRegion

      default CompletableFuture<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.


      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 Java Future containing the result of the ListPlansInRegion operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You do not have sufficient access to perform this action.

        HTTP Status Code: 403

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ArcRegionSwitchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPlansInRegionPaginator

      default ListPlansInRegionPublisher listPlansInRegionPaginator(ListPlansInRegionRequest listPlansInRegionRequest)

      This is a variant of listPlansInRegion(software.amazon.awssdk.services.arcregionswitch.model.ListPlansInRegionRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.arcregionswitch.paginators.ListPlansInRegionPublisher publisher = client.listPlansInRegionPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.arcregionswitch.paginators.ListPlansInRegionPublisher publisher = client.listPlansInRegionPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.arcregionswitch.model.ListPlansInRegionResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.arcregionswitch.model.ListPlansInRegionResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You do not have sufficient access to perform this action.

        HTTP Status Code: 403

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ArcRegionSwitchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPlansInRegionPaginator

      default ListPlansInRegionPublisher listPlansInRegionPaginator(Consumer<ListPlansInRegionRequest.Builder> listPlansInRegionRequest)

      This is a variant of listPlansInRegion(software.amazon.awssdk.services.arcregionswitch.model.ListPlansInRegionRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.arcregionswitch.paginators.ListPlansInRegionPublisher publisher = client.listPlansInRegionPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.arcregionswitch.paginators.ListPlansInRegionPublisher publisher = client.listPlansInRegionPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.arcregionswitch.model.ListPlansInRegionResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.arcregionswitch.model.ListPlansInRegionResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You do not have sufficient access to perform this action.

        HTTP Status Code: 403

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ArcRegionSwitchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPlansPaginator

      default ListPlansPublisher listPlansPaginator(ListPlansRequest listPlansRequest)

      This is a variant of listPlans(software.amazon.awssdk.services.arcregionswitch.model.ListPlansRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.arcregionswitch.paginators.ListPlansPublisher publisher = client.listPlansPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.arcregionswitch.paginators.ListPlansPublisher publisher = client.listPlansPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.arcregionswitch.model.ListPlansResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.arcregionswitch.model.ListPlansResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ArcRegionSwitchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPlansPaginator

      default ListPlansPublisher listPlansPaginator(Consumer<ListPlansRequest.Builder> listPlansRequest)

      This is a variant of listPlans(software.amazon.awssdk.services.arcregionswitch.model.ListPlansRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.arcregionswitch.paginators.ListPlansPublisher publisher = client.listPlansPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.arcregionswitch.paginators.ListPlansPublisher publisher = client.listPlansPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.arcregionswitch.model.ListPlansResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.arcregionswitch.model.ListPlansResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ArcRegionSwitchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRoute53HealthChecks

      default CompletableFuture<ListRoute53HealthChecksResponse> listRoute53HealthChecks(ListRoute53HealthChecksRequest listRoute53HealthChecksRequest)

      List the Amazon Route 53 health checks.

      Parameters:
      listRoute53HealthChecksRequest -
      Returns:
      A Java Future containing the result of the ListRoute53HealthChecks operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The specified resource was not found.

        HTTP Status Code: 404

      • AccessDeniedException You do not have sufficient access to perform this action.

        HTTP Status Code: 403

      • InternalServerException The request processing has failed because of an unknown error, exception, or failure.

        HTTP Status Code: 500

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ArcRegionSwitchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRoute53HealthChecks

      default CompletableFuture<ListRoute53HealthChecksResponse> listRoute53HealthChecks(Consumer<ListRoute53HealthChecksRequest.Builder> listRoute53HealthChecksRequest)

      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:
      A Java Future containing the result of the ListRoute53HealthChecks operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The specified resource was not found.

        HTTP Status Code: 404

      • AccessDeniedException You do not have sufficient access to perform this action.

        HTTP Status Code: 403

      • InternalServerException The request processing has failed because of an unknown error, exception, or failure.

        HTTP Status Code: 500

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ArcRegionSwitchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRoute53HealthChecksPaginator

      default ListRoute53HealthChecksPublisher listRoute53HealthChecksPaginator(ListRoute53HealthChecksRequest listRoute53HealthChecksRequest)

      This is a variant of listRoute53HealthChecks(software.amazon.awssdk.services.arcregionswitch.model.ListRoute53HealthChecksRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.arcregionswitch.paginators.ListRoute53HealthChecksPublisher publisher = client.listRoute53HealthChecksPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.arcregionswitch.paginators.ListRoute53HealthChecksPublisher publisher = client.listRoute53HealthChecksPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.arcregionswitch.model.ListRoute53HealthChecksResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.arcregionswitch.model.ListRoute53HealthChecksResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The specified resource was not found.

        HTTP Status Code: 404

      • AccessDeniedException You do not have sufficient access to perform this action.

        HTTP Status Code: 403

      • InternalServerException The request processing has failed because of an unknown error, exception, or failure.

        HTTP Status Code: 500

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ArcRegionSwitchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRoute53HealthChecksPaginator

      default ListRoute53HealthChecksPublisher listRoute53HealthChecksPaginator(Consumer<ListRoute53HealthChecksRequest.Builder> listRoute53HealthChecksRequest)

      This is a variant of listRoute53HealthChecks(software.amazon.awssdk.services.arcregionswitch.model.ListRoute53HealthChecksRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.arcregionswitch.paginators.ListRoute53HealthChecksPublisher publisher = client.listRoute53HealthChecksPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.arcregionswitch.paginators.ListRoute53HealthChecksPublisher publisher = client.listRoute53HealthChecksPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.arcregionswitch.model.ListRoute53HealthChecksResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.arcregionswitch.model.ListRoute53HealthChecksResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The specified resource was not found.

        HTTP Status Code: 404

      • AccessDeniedException You do not have sufficient access to perform this action.

        HTTP Status Code: 403

      • InternalServerException The request processing has failed because of an unknown error, exception, or failure.

        HTTP Status Code: 500

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ArcRegionSwitchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

      Lists the tags attached to a Region switch resource.

      Parameters:
      listTagsForResourceRequest -
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The specified resource was not found.

        HTTP Status Code: 404

      • InternalServerException The request processing has failed because of an unknown error, exception, or failure.

        HTTP Status Code: 500

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ArcRegionSwitchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)

      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:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The specified resource was not found.

        HTTP Status Code: 404

      • InternalServerException The request processing has failed because of an unknown error, exception, or failure.

        HTTP Status Code: 500

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ArcRegionSwitchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startPlanExecution

      default CompletableFuture<StartPlanExecutionResponse> startPlanExecution(StartPlanExecutionRequest startPlanExecutionRequest)

      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:
      A Java Future containing the result of the StartPlanExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The specified resource was not found.

        HTTP Status Code: 404

      • IllegalStateException The operation failed because the current state of the resource doesn't allow the operation to proceed.

        HTTP Status Code: 400

      • AccessDeniedException You do not have sufficient access to perform this action.

        HTTP Status Code: 403

      • IllegalArgumentException The request processing has an invalid argument.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ArcRegionSwitchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startPlanExecution

      default CompletableFuture<StartPlanExecutionResponse> startPlanExecution(Consumer<StartPlanExecutionRequest.Builder> startPlanExecutionRequest)

      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:
      A Java Future containing the result of the StartPlanExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The specified resource was not found.

        HTTP Status Code: 404

      • IllegalStateException The operation failed because the current state of the resource doesn't allow the operation to proceed.

        HTTP Status Code: 400

      • AccessDeniedException You do not have sufficient access to perform this action.

        HTTP Status Code: 403

      • IllegalArgumentException The request processing has an invalid argument.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ArcRegionSwitchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)

      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:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The specified resource was not found.

        HTTP Status Code: 404

      • InternalServerException The request processing has failed because of an unknown error, exception, or failure.

        HTTP Status Code: 500

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ArcRegionSwitchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)

      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:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The specified resource was not found.

        HTTP Status Code: 404

      • InternalServerException The request processing has failed because of an unknown error, exception, or failure.

        HTTP Status Code: 500

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ArcRegionSwitchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)

      Removes tags from a Region switch resource.

      Parameters:
      untagResourceRequest -
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The specified resource was not found.

        HTTP Status Code: 404

      • InternalServerException The request processing has failed because of an unknown error, exception, or failure.

        HTTP Status Code: 500

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ArcRegionSwitchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)

      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:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The specified resource was not found.

        HTTP Status Code: 404

      • InternalServerException The request processing has failed because of an unknown error, exception, or failure.

        HTTP Status Code: 500

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ArcRegionSwitchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updatePlan

      default CompletableFuture<UpdatePlanResponse> updatePlan(UpdatePlanRequest updatePlanRequest)

      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:
      A Java Future containing the result of the UpdatePlan operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The specified resource was not found.

        HTTP Status Code: 404

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ArcRegionSwitchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updatePlan

      default CompletableFuture<UpdatePlanResponse> updatePlan(Consumer<UpdatePlanRequest.Builder> updatePlanRequest)

      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:
      A Java Future containing the result of the UpdatePlan operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The specified resource was not found.

        HTTP Status Code: 404

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ArcRegionSwitchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updatePlanExecution

      default CompletableFuture<UpdatePlanExecutionResponse> updatePlanExecution(UpdatePlanExecutionRequest updatePlanExecutionRequest)

      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:
      A Java Future containing the result of the UpdatePlanExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The specified resource was not found.

        HTTP Status Code: 404

      • IllegalStateException The operation failed because the current state of the resource doesn't allow the operation to proceed.

        HTTP Status Code: 400

      • AccessDeniedException You do not have sufficient access to perform this action.

        HTTP Status Code: 403

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ArcRegionSwitchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updatePlanExecution

      default CompletableFuture<UpdatePlanExecutionResponse> updatePlanExecution(Consumer<UpdatePlanExecutionRequest.Builder> updatePlanExecutionRequest)

      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:
      A Java Future containing the result of the UpdatePlanExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The specified resource was not found.

        HTTP Status Code: 404

      • IllegalStateException The operation failed because the current state of the resource doesn't allow the operation to proceed.

        HTTP Status Code: 400

      • AccessDeniedException You do not have sufficient access to perform this action.

        HTTP Status Code: 403

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ArcRegionSwitchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updatePlanExecutionStep

      default CompletableFuture<UpdatePlanExecutionStepResponse> updatePlanExecutionStep(UpdatePlanExecutionStepRequest updatePlanExecutionStepRequest)

      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:
      A Java Future containing the result of the UpdatePlanExecutionStep operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The specified resource was not found.

        HTTP Status Code: 404

      • AccessDeniedException You do not have sufficient access to perform this action.

        HTTP Status Code: 403

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ArcRegionSwitchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updatePlanExecutionStep

      default CompletableFuture<UpdatePlanExecutionStepResponse> updatePlanExecutionStep(Consumer<UpdatePlanExecutionStepRequest.Builder> updatePlanExecutionStepRequest)

      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:
      A Java Future containing the result of the UpdatePlanExecutionStep operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The specified resource was not found.

        HTTP Status Code: 404

      • AccessDeniedException You do not have sufficient access to perform this action.

        HTTP Status Code: 403

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ArcRegionSwitchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • waiter

      default ArcRegionSwitchAsyncWaiter waiter()
      Create an instance of ArcRegionSwitchAsyncWaiter 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 ArcRegionSwitchAsyncWaiter

    • 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

    • create

      static ArcRegionSwitchAsyncClient create()
      Create a ArcRegionSwitchAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static ArcRegionSwitchAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a ArcRegionSwitchAsyncClient.