Interface ArcZonalShiftAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface ArcZonalShiftAsyncClient extends AwsClient
Service client for accessing AWS ARC - Zonal Shift 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.

Welcome to the API Reference Guide for zonal shift and zonal autoshift in Amazon Route 53 Application Recovery Controller (Route 53 ARC).

You can start a zonal shift to move traffic for a load balancer resource away from an Availability Zone to help your application recover quickly from an impairment in an Availability Zone. For example, you can recover your application from a developer's bad code deployment or from an Amazon Web Services infrastructure failure in a single Availability Zone.

You can also configure zonal autoshift for supported load balancer resources. Zonal autoshift is a capability in Route 53 ARC where you authorize Amazon Web Services to shift away application resource traffic from an Availability Zone during events, on your behalf, to help reduce your time to recovery. Amazon Web Services starts an autoshift when internal telemetry indicates that there is an Availability Zone impairment that could potentially impact customers.

To help make sure that zonal autoshift is safe for your application, you must also configure practice runs when you enable zonal autoshift for a resource. Practice runs start weekly zonal shifts for a resource, to shift traffic for the resource away from an Availability Zone. Practice runs help you to make sure, on a regular basis, that you have enough capacity in all the Availability Zones in an Amazon Web Services Region for your application to continue to operate normally when traffic for a resource is shifted away from one Availability Zone.

Before you configure practice runs or enable zonal autoshift, we strongly recommend that you prescale your application resource capacity in all Availability Zones in the Region where your application resources are deployed. You should not rely on scaling on demand when an autoshift or practice run starts. Zonal autoshift, including practice runs, works independently, and does not wait for auto scaling actions to complete. Relying on auto scaling, instead of pre-scaling, can result in loss of availability.

If you use auto scaling to handle regular cycles of traffic, we strongly recommend that you configure the minimum capacity of your auto scaling to continue operating normally with the loss of an Availability Zone.

Be aware that Route 53 ARC does not inspect the health of individual resources. Amazon Web Services only starts an autoshift when Amazon Web Services telemetry detects that there is an Availability Zone impairment that could potentially impact customers. In some cases, resources might be shifted away that are not experiencing impact.

For more information about using zonal shift and zonal autoshift, see the Amazon Route 53 Application Recovery Controller Developer Guide.

  • Field Details

  • Method Details

    • cancelZonalShift

      default CompletableFuture<CancelZonalShiftResponse> cancelZonalShift(CancelZonalShiftRequest cancelZonalShiftRequest)

      Cancel a zonal shift in Amazon Route 53 Application Recovery Controller. To cancel the zonal shift, specify the zonal shift ID.

      A zonal shift can be one that you've started for a resource in your Amazon Web Services account in an Amazon Web Services Region, or it can be a zonal shift started by a practice run with zonal autoshift.

      Parameters:
      cancelZonalShiftRequest -
      Returns:
      A Java Future containing the result of the CancelZonalShift 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.
      • InternalServerException There was an internal server error.
      • ConflictException The request could not be processed because of conflict in the current state of the resource.
      • ResourceNotFoundException The input requested a resource that was not found.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • 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.
      • ArcZonalShiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • cancelZonalShift

      default CompletableFuture<CancelZonalShiftResponse> cancelZonalShift(Consumer<CancelZonalShiftRequest.Builder> cancelZonalShiftRequest)

      Cancel a zonal shift in Amazon Route 53 Application Recovery Controller. To cancel the zonal shift, specify the zonal shift ID.

      A zonal shift can be one that you've started for a resource in your Amazon Web Services account in an Amazon Web Services Region, or it can be a zonal shift started by a practice run with zonal autoshift.


      This is a convenience which creates an instance of the CancelZonalShiftRequest.Builder avoiding the need to create one manually via CancelZonalShiftRequest.builder()

      Parameters:
      cancelZonalShiftRequest - A Consumer that will call methods on CancelZonalShiftRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CancelZonalShift 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.
      • InternalServerException There was an internal server error.
      • ConflictException The request could not be processed because of conflict in the current state of the resource.
      • ResourceNotFoundException The input requested a resource that was not found.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • 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.
      • ArcZonalShiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createPracticeRunConfiguration

      default CompletableFuture<CreatePracticeRunConfigurationResponse> createPracticeRunConfiguration(CreatePracticeRunConfigurationRequest createPracticeRunConfigurationRequest)

      A practice run configuration for zonal autoshift is required when you enable zonal autoshift. A practice run configuration includes specifications for blocked dates and blocked time windows, and for Amazon CloudWatch alarms that you create to use with practice runs. The alarms that you specify are an outcome alarm, to monitor application health during practice runs and, optionally, a blocking alarm, to block practice runs from starting.

      When a resource has a practice run configuration, Route 53 ARC starts zonal shifts for the resource weekly, to shift traffic for practice runs. Practice runs help you to ensure that shifting away traffic from an Availability Zone during an autoshift is safe for your application.

      For more information, see Considerations when you configure zonal autoshift in the Amazon Route 53 Application Recovery Controller Developer Guide.

      Parameters:
      createPracticeRunConfigurationRequest -
      Returns:
      A Java Future containing the result of the CreatePracticeRunConfiguration 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.
      • InternalServerException There was an internal server error.
      • ConflictException The request could not be processed because of conflict in the current state of the resource.
      • ResourceNotFoundException The input requested a resource that was not found.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • 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.
      • ArcZonalShiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createPracticeRunConfiguration

      default CompletableFuture<CreatePracticeRunConfigurationResponse> createPracticeRunConfiguration(Consumer<CreatePracticeRunConfigurationRequest.Builder> createPracticeRunConfigurationRequest)

      A practice run configuration for zonal autoshift is required when you enable zonal autoshift. A practice run configuration includes specifications for blocked dates and blocked time windows, and for Amazon CloudWatch alarms that you create to use with practice runs. The alarms that you specify are an outcome alarm, to monitor application health during practice runs and, optionally, a blocking alarm, to block practice runs from starting.

      When a resource has a practice run configuration, Route 53 ARC starts zonal shifts for the resource weekly, to shift traffic for practice runs. Practice runs help you to ensure that shifting away traffic from an Availability Zone during an autoshift is safe for your application.

      For more information, see Considerations when you configure zonal autoshift in the Amazon Route 53 Application Recovery Controller Developer Guide.


      This is a convenience which creates an instance of the CreatePracticeRunConfigurationRequest.Builder avoiding the need to create one manually via CreatePracticeRunConfigurationRequest.builder()

      Parameters:
      createPracticeRunConfigurationRequest - A Consumer that will call methods on CreatePracticeRunConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreatePracticeRunConfiguration 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.
      • InternalServerException There was an internal server error.
      • ConflictException The request could not be processed because of conflict in the current state of the resource.
      • ResourceNotFoundException The input requested a resource that was not found.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • 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.
      • ArcZonalShiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deletePracticeRunConfiguration

      default CompletableFuture<DeletePracticeRunConfigurationResponse> deletePracticeRunConfiguration(DeletePracticeRunConfigurationRequest deletePracticeRunConfigurationRequest)

      Deletes the practice run configuration for a resource. Before you can delete a practice run configuration for a resource., you must disable zonal autoshift for the resource. Practice runs must be configured for zonal autoshift to be enabled.

      Parameters:
      deletePracticeRunConfigurationRequest -
      Returns:
      A Java Future containing the result of the DeletePracticeRunConfiguration 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.
      • InternalServerException There was an internal server error.
      • ConflictException The request could not be processed because of conflict in the current state of the resource.
      • ResourceNotFoundException The input requested a resource that was not found.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • 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.
      • ArcZonalShiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deletePracticeRunConfiguration

      default CompletableFuture<DeletePracticeRunConfigurationResponse> deletePracticeRunConfiguration(Consumer<DeletePracticeRunConfigurationRequest.Builder> deletePracticeRunConfigurationRequest)

      Deletes the practice run configuration for a resource. Before you can delete a practice run configuration for a resource., you must disable zonal autoshift for the resource. Practice runs must be configured for zonal autoshift to be enabled.


      This is a convenience which creates an instance of the DeletePracticeRunConfigurationRequest.Builder avoiding the need to create one manually via DeletePracticeRunConfigurationRequest.builder()

      Parameters:
      deletePracticeRunConfigurationRequest - A Consumer that will call methods on DeletePracticeRunConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeletePracticeRunConfiguration 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.
      • InternalServerException There was an internal server error.
      • ConflictException The request could not be processed because of conflict in the current state of the resource.
      • ResourceNotFoundException The input requested a resource that was not found.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • 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.
      • ArcZonalShiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAutoshiftObserverNotificationStatus

      default CompletableFuture<GetAutoshiftObserverNotificationStatusResponse> getAutoshiftObserverNotificationStatus(GetAutoshiftObserverNotificationStatusRequest getAutoshiftObserverNotificationStatusRequest)

      Returns the status of autoshift observer notification. Autoshift observer notification enables you to be notified, through Amazon EventBridge, when there is an autoshift event for zonal autoshift.

      If the status is ENABLED, Route 53 ARC includes all autoshift events when you use the EventBridge pattern Autoshift In Progress. When the status is DISABLED, Route 53 ARC includes only autoshift events for autoshifts when one or more of your resources is included in the autoshift.

      For more information, see Notifications for practice runs and autoshifts in the Amazon Route 53 Application Recovery Controller Developer Guide.

      Parameters:
      getAutoshiftObserverNotificationStatusRequest -
      Returns:
      A Java Future containing the result of the GetAutoshiftObserverNotificationStatus 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.
      • InternalServerException There was an internal server error.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • 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.
      • ArcZonalShiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAutoshiftObserverNotificationStatus

      default CompletableFuture<GetAutoshiftObserverNotificationStatusResponse> getAutoshiftObserverNotificationStatus(Consumer<GetAutoshiftObserverNotificationStatusRequest.Builder> getAutoshiftObserverNotificationStatusRequest)

      Returns the status of autoshift observer notification. Autoshift observer notification enables you to be notified, through Amazon EventBridge, when there is an autoshift event for zonal autoshift.

      If the status is ENABLED, Route 53 ARC includes all autoshift events when you use the EventBridge pattern Autoshift In Progress. When the status is DISABLED, Route 53 ARC includes only autoshift events for autoshifts when one or more of your resources is included in the autoshift.

      For more information, see Notifications for practice runs and autoshifts in the Amazon Route 53 Application Recovery Controller Developer Guide.


      This is a convenience which creates an instance of the GetAutoshiftObserverNotificationStatusRequest.Builder avoiding the need to create one manually via GetAutoshiftObserverNotificationStatusRequest.builder()

      Parameters:
      getAutoshiftObserverNotificationStatusRequest - A Consumer that will call methods on GetAutoshiftObserverNotificationStatusRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetAutoshiftObserverNotificationStatus 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.
      • InternalServerException There was an internal server error.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • 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.
      • ArcZonalShiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getManagedResource

      default CompletableFuture<GetManagedResourceResponse> getManagedResource(GetManagedResourceRequest getManagedResourceRequest)

      Get information about a resource that's been registered for zonal shifts with Amazon Route 53 Application Recovery Controller in this Amazon Web Services Region. Resources that are registered for zonal shifts are managed resources in Route 53 ARC. You can start zonal shifts and configure zonal autoshift for managed resources.

      At this time, you can only start a zonal shift or configure zonal autoshift for Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.

      Parameters:
      getManagedResourceRequest -
      Returns:
      A Java Future containing the result of the GetManagedResource 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.
      • InternalServerException There was an internal server error.
      • ResourceNotFoundException The input requested a resource that was not found.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • 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.
      • ArcZonalShiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getManagedResource

      default CompletableFuture<GetManagedResourceResponse> getManagedResource(Consumer<GetManagedResourceRequest.Builder> getManagedResourceRequest)

      Get information about a resource that's been registered for zonal shifts with Amazon Route 53 Application Recovery Controller in this Amazon Web Services Region. Resources that are registered for zonal shifts are managed resources in Route 53 ARC. You can start zonal shifts and configure zonal autoshift for managed resources.

      At this time, you can only start a zonal shift or configure zonal autoshift for Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.


      This is a convenience which creates an instance of the GetManagedResourceRequest.Builder avoiding the need to create one manually via GetManagedResourceRequest.builder()

      Parameters:
      getManagedResourceRequest - A Consumer that will call methods on GetManagedResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetManagedResource 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.
      • InternalServerException There was an internal server error.
      • ResourceNotFoundException The input requested a resource that was not found.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • 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.
      • ArcZonalShiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAutoshifts

      default CompletableFuture<ListAutoshiftsResponse> listAutoshifts(ListAutoshiftsRequest listAutoshiftsRequest)

      Returns a list of autoshifts for an Amazon Web Services Region. By default, the call returns only ACTIVE autoshifts. Optionally, you can specify the status parameter to return COMPLETED autoshifts.

      Parameters:
      listAutoshiftsRequest -
      Returns:
      A Java Future containing the result of the ListAutoshifts 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.
      • InternalServerException There was an internal server error.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • 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.
      • ArcZonalShiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAutoshifts

      default CompletableFuture<ListAutoshiftsResponse> listAutoshifts(Consumer<ListAutoshiftsRequest.Builder> listAutoshiftsRequest)

      Returns a list of autoshifts for an Amazon Web Services Region. By default, the call returns only ACTIVE autoshifts. Optionally, you can specify the status parameter to return COMPLETED autoshifts.


      This is a convenience which creates an instance of the ListAutoshiftsRequest.Builder avoiding the need to create one manually via ListAutoshiftsRequest.builder()

      Parameters:
      listAutoshiftsRequest - A Consumer that will call methods on ListAutoshiftsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListAutoshifts 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.
      • InternalServerException There was an internal server error.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • 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.
      • ArcZonalShiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAutoshiftsPaginator

      default ListAutoshiftsPublisher listAutoshiftsPaginator(ListAutoshiftsRequest listAutoshiftsRequest)

      This is a variant of listAutoshifts(software.amazon.awssdk.services.arczonalshift.model.ListAutoshiftsRequest) 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.arczonalshift.paginators.ListAutoshiftsPublisher publisher = client.listAutoshiftsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.arczonalshift.paginators.ListAutoshiftsPublisher publisher = client.listAutoshiftsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.arczonalshift.model.ListAutoshiftsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.arczonalshift.model.ListAutoshiftsResponse 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 listAutoshifts(software.amazon.awssdk.services.arczonalshift.model.ListAutoshiftsRequest) operation.

      Parameters:
      listAutoshiftsRequest -
      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.
      • InternalServerException There was an internal server error.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • 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.
      • ArcZonalShiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAutoshiftsPaginator

      default ListAutoshiftsPublisher listAutoshiftsPaginator(Consumer<ListAutoshiftsRequest.Builder> listAutoshiftsRequest)

      This is a variant of listAutoshifts(software.amazon.awssdk.services.arczonalshift.model.ListAutoshiftsRequest) 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.arczonalshift.paginators.ListAutoshiftsPublisher publisher = client.listAutoshiftsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.arczonalshift.paginators.ListAutoshiftsPublisher publisher = client.listAutoshiftsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.arczonalshift.model.ListAutoshiftsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.arczonalshift.model.ListAutoshiftsResponse 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 listAutoshifts(software.amazon.awssdk.services.arczonalshift.model.ListAutoshiftsRequest) operation.


      This is a convenience which creates an instance of the ListAutoshiftsRequest.Builder avoiding the need to create one manually via ListAutoshiftsRequest.builder()

      Parameters:
      listAutoshiftsRequest - A Consumer that will call methods on ListAutoshiftsRequest.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.
      • InternalServerException There was an internal server error.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • 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.
      • ArcZonalShiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listManagedResources

      default CompletableFuture<ListManagedResourcesResponse> listManagedResources(ListManagedResourcesRequest listManagedResourcesRequest)

      Lists all the resources in your Amazon Web Services account in this Amazon Web Services Region that are managed for zonal shifts in Amazon Route 53 Application Recovery Controller, and information about them. The information includes the zonal autoshift status for the resource, as well as the Amazon Resource Name (ARN), the Availability Zones that each resource is deployed in, and the resource name.

      Parameters:
      listManagedResourcesRequest -
      Returns:
      A Java Future containing the result of the ListManagedResources 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.
      • InternalServerException There was an internal server error.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • 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.
      • ArcZonalShiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listManagedResources

      default CompletableFuture<ListManagedResourcesResponse> listManagedResources(Consumer<ListManagedResourcesRequest.Builder> listManagedResourcesRequest)

      Lists all the resources in your Amazon Web Services account in this Amazon Web Services Region that are managed for zonal shifts in Amazon Route 53 Application Recovery Controller, and information about them. The information includes the zonal autoshift status for the resource, as well as the Amazon Resource Name (ARN), the Availability Zones that each resource is deployed in, and the resource name.


      This is a convenience which creates an instance of the ListManagedResourcesRequest.Builder avoiding the need to create one manually via ListManagedResourcesRequest.builder()

      Parameters:
      listManagedResourcesRequest - A Consumer that will call methods on ListManagedResourcesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListManagedResources 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.
      • InternalServerException There was an internal server error.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • 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.
      • ArcZonalShiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listManagedResourcesPaginator

      default ListManagedResourcesPublisher listManagedResourcesPaginator(ListManagedResourcesRequest listManagedResourcesRequest)

      This is a variant of listManagedResources(software.amazon.awssdk.services.arczonalshift.model.ListManagedResourcesRequest) 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.arczonalshift.paginators.ListManagedResourcesPublisher publisher = client.listManagedResourcesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.arczonalshift.paginators.ListManagedResourcesPublisher publisher = client.listManagedResourcesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.arczonalshift.model.ListManagedResourcesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.arczonalshift.model.ListManagedResourcesResponse 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 listManagedResources(software.amazon.awssdk.services.arczonalshift.model.ListManagedResourcesRequest) operation.

      Parameters:
      listManagedResourcesRequest -
      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.
      • InternalServerException There was an internal server error.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • 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.
      • ArcZonalShiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listManagedResourcesPaginator

      default ListManagedResourcesPublisher listManagedResourcesPaginator(Consumer<ListManagedResourcesRequest.Builder> listManagedResourcesRequest)

      This is a variant of listManagedResources(software.amazon.awssdk.services.arczonalshift.model.ListManagedResourcesRequest) 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.arczonalshift.paginators.ListManagedResourcesPublisher publisher = client.listManagedResourcesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.arczonalshift.paginators.ListManagedResourcesPublisher publisher = client.listManagedResourcesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.arczonalshift.model.ListManagedResourcesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.arczonalshift.model.ListManagedResourcesResponse 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 listManagedResources(software.amazon.awssdk.services.arczonalshift.model.ListManagedResourcesRequest) operation.


      This is a convenience which creates an instance of the ListManagedResourcesRequest.Builder avoiding the need to create one manually via ListManagedResourcesRequest.builder()

      Parameters:
      listManagedResourcesRequest - A Consumer that will call methods on ListManagedResourcesRequest.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.
      • InternalServerException There was an internal server error.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • 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.
      • ArcZonalShiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listZonalShifts

      default CompletableFuture<ListZonalShiftsResponse> listZonalShifts(ListZonalShiftsRequest listZonalShiftsRequest)

      Lists all active and completed zonal shifts in Amazon Route 53 Application Recovery Controller in your Amazon Web Services account in this Amazon Web Services Region. ListZonalShifts returns customer-initiated zonal shifts, as well as practice run zonal shifts that Route 53 ARC started on your behalf for zonal autoshift.

      The ListZonalShifts operation does not list autoshifts. For more information about listing autoshifts, see ">ListAutoshifts.

      Parameters:
      listZonalShiftsRequest -
      Returns:
      A Java Future containing the result of the ListZonalShifts 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.
      • InternalServerException There was an internal server error.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • 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.
      • ArcZonalShiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listZonalShifts

      default CompletableFuture<ListZonalShiftsResponse> listZonalShifts(Consumer<ListZonalShiftsRequest.Builder> listZonalShiftsRequest)

      Lists all active and completed zonal shifts in Amazon Route 53 Application Recovery Controller in your Amazon Web Services account in this Amazon Web Services Region. ListZonalShifts returns customer-initiated zonal shifts, as well as practice run zonal shifts that Route 53 ARC started on your behalf for zonal autoshift.

      The ListZonalShifts operation does not list autoshifts. For more information about listing autoshifts, see ">ListAutoshifts.


      This is a convenience which creates an instance of the ListZonalShiftsRequest.Builder avoiding the need to create one manually via ListZonalShiftsRequest.builder()

      Parameters:
      listZonalShiftsRequest - A Consumer that will call methods on ListZonalShiftsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListZonalShifts 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.
      • InternalServerException There was an internal server error.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • 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.
      • ArcZonalShiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listZonalShiftsPaginator

      default ListZonalShiftsPublisher listZonalShiftsPaginator(ListZonalShiftsRequest listZonalShiftsRequest)

      This is a variant of listZonalShifts(software.amazon.awssdk.services.arczonalshift.model.ListZonalShiftsRequest) 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.arczonalshift.paginators.ListZonalShiftsPublisher publisher = client.listZonalShiftsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.arczonalshift.paginators.ListZonalShiftsPublisher publisher = client.listZonalShiftsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.arczonalshift.model.ListZonalShiftsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.arczonalshift.model.ListZonalShiftsResponse 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 listZonalShifts(software.amazon.awssdk.services.arczonalshift.model.ListZonalShiftsRequest) operation.

      Parameters:
      listZonalShiftsRequest -
      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.
      • InternalServerException There was an internal server error.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • 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.
      • ArcZonalShiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listZonalShiftsPaginator

      default ListZonalShiftsPublisher listZonalShiftsPaginator(Consumer<ListZonalShiftsRequest.Builder> listZonalShiftsRequest)

      This is a variant of listZonalShifts(software.amazon.awssdk.services.arczonalshift.model.ListZonalShiftsRequest) 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.arczonalshift.paginators.ListZonalShiftsPublisher publisher = client.listZonalShiftsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.arczonalshift.paginators.ListZonalShiftsPublisher publisher = client.listZonalShiftsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.arczonalshift.model.ListZonalShiftsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.arczonalshift.model.ListZonalShiftsResponse 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 listZonalShifts(software.amazon.awssdk.services.arczonalshift.model.ListZonalShiftsRequest) operation.


      This is a convenience which creates an instance of the ListZonalShiftsRequest.Builder avoiding the need to create one manually via ListZonalShiftsRequest.builder()

      Parameters:
      listZonalShiftsRequest - A Consumer that will call methods on ListZonalShiftsRequest.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.
      • InternalServerException There was an internal server error.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • 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.
      • ArcZonalShiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startZonalShift

      default CompletableFuture<StartZonalShiftResponse> startZonalShift(StartZonalShiftRequest startZonalShiftRequest)

      You start a zonal shift to temporarily move load balancer traffic away from an Availability Zone in an Amazon Web Services Region, to help your application recover immediately, for example, from a developer's bad code deployment or from an Amazon Web Services infrastructure failure in a single Availability Zone. You can start a zonal shift in Route 53 ARC only for managed resources in your Amazon Web Services account in an Amazon Web Services Region. Resources are automatically registered with Route 53 ARC by Amazon Web Services services.

      At this time, you can only start a zonal shift for Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.

      When you start a zonal shift, traffic for the resource is no longer routed to the Availability Zone. The zonal shift is created immediately in Route 53 ARC. However, it can take a short time, typically up to a few minutes, for existing, in-progress connections in the Availability Zone to complete.

      For more information, see Zonal shift in the Amazon Route 53 Application Recovery Controller Developer Guide.

      Parameters:
      startZonalShiftRequest -
      Returns:
      A Java Future containing the result of the StartZonalShift 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.
      • InternalServerException There was an internal server error.
      • ConflictException The request could not be processed because of conflict in the current state of the resource.
      • ResourceNotFoundException The input requested a resource that was not found.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • 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.
      • ArcZonalShiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startZonalShift

      default CompletableFuture<StartZonalShiftResponse> startZonalShift(Consumer<StartZonalShiftRequest.Builder> startZonalShiftRequest)

      You start a zonal shift to temporarily move load balancer traffic away from an Availability Zone in an Amazon Web Services Region, to help your application recover immediately, for example, from a developer's bad code deployment or from an Amazon Web Services infrastructure failure in a single Availability Zone. You can start a zonal shift in Route 53 ARC only for managed resources in your Amazon Web Services account in an Amazon Web Services Region. Resources are automatically registered with Route 53 ARC by Amazon Web Services services.

      At this time, you can only start a zonal shift for Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.

      When you start a zonal shift, traffic for the resource is no longer routed to the Availability Zone. The zonal shift is created immediately in Route 53 ARC. However, it can take a short time, typically up to a few minutes, for existing, in-progress connections in the Availability Zone to complete.

      For more information, see Zonal shift in the Amazon Route 53 Application Recovery Controller Developer Guide.


      This is a convenience which creates an instance of the StartZonalShiftRequest.Builder avoiding the need to create one manually via StartZonalShiftRequest.builder()

      Parameters:
      startZonalShiftRequest - A Consumer that will call methods on StartZonalShiftRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartZonalShift 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.
      • InternalServerException There was an internal server error.
      • ConflictException The request could not be processed because of conflict in the current state of the resource.
      • ResourceNotFoundException The input requested a resource that was not found.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • 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.
      • ArcZonalShiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateAutoshiftObserverNotificationStatus

      default CompletableFuture<UpdateAutoshiftObserverNotificationStatusResponse> updateAutoshiftObserverNotificationStatus(UpdateAutoshiftObserverNotificationStatusRequest updateAutoshiftObserverNotificationStatusRequest)

      Update the status of autoshift observer notification. Autoshift observer notification enables you to be notified, through Amazon EventBridge, when there is an autoshift event for zonal autoshift.

      If the status is ENABLED, Route 53 ARC includes all autoshift events when you use the EventBridge pattern Autoshift In Progress. When the status is DISABLED, Route 53 ARC includes only autoshift events for autoshifts when one or more of your resources is included in the autoshift.

      For more information, see Notifications for practice runs and autoshifts in the Amazon Route 53 Application Recovery Controller Developer Guide.

      Parameters:
      updateAutoshiftObserverNotificationStatusRequest -
      Returns:
      A Java Future containing the result of the UpdateAutoshiftObserverNotificationStatus 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.
      • InternalServerException There was an internal server error.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • 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.
      • ArcZonalShiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateAutoshiftObserverNotificationStatus

      default CompletableFuture<UpdateAutoshiftObserverNotificationStatusResponse> updateAutoshiftObserverNotificationStatus(Consumer<UpdateAutoshiftObserverNotificationStatusRequest.Builder> updateAutoshiftObserverNotificationStatusRequest)

      Update the status of autoshift observer notification. Autoshift observer notification enables you to be notified, through Amazon EventBridge, when there is an autoshift event for zonal autoshift.

      If the status is ENABLED, Route 53 ARC includes all autoshift events when you use the EventBridge pattern Autoshift In Progress. When the status is DISABLED, Route 53 ARC includes only autoshift events for autoshifts when one or more of your resources is included in the autoshift.

      For more information, see Notifications for practice runs and autoshifts in the Amazon Route 53 Application Recovery Controller Developer Guide.


      This is a convenience which creates an instance of the UpdateAutoshiftObserverNotificationStatusRequest.Builder avoiding the need to create one manually via UpdateAutoshiftObserverNotificationStatusRequest.builder()

      Parameters:
      updateAutoshiftObserverNotificationStatusRequest - A Consumer that will call methods on UpdateAutoshiftObserverNotificationStatusRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateAutoshiftObserverNotificationStatus 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.
      • InternalServerException There was an internal server error.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • 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.
      • ArcZonalShiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updatePracticeRunConfiguration

      default CompletableFuture<UpdatePracticeRunConfigurationResponse> updatePracticeRunConfiguration(UpdatePracticeRunConfigurationRequest updatePracticeRunConfigurationRequest)

      Update a practice run configuration to change one or more of the following: add, change, or remove the blocking alarm; change the outcome alarm; or add, change, or remove blocking dates or time windows.

      Parameters:
      updatePracticeRunConfigurationRequest -
      Returns:
      A Java Future containing the result of the UpdatePracticeRunConfiguration 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.
      • InternalServerException There was an internal server error.
      • ConflictException The request could not be processed because of conflict in the current state of the resource.
      • ResourceNotFoundException The input requested a resource that was not found.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • 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.
      • ArcZonalShiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updatePracticeRunConfiguration

      default CompletableFuture<UpdatePracticeRunConfigurationResponse> updatePracticeRunConfiguration(Consumer<UpdatePracticeRunConfigurationRequest.Builder> updatePracticeRunConfigurationRequest)

      Update a practice run configuration to change one or more of the following: add, change, or remove the blocking alarm; change the outcome alarm; or add, change, or remove blocking dates or time windows.


      This is a convenience which creates an instance of the UpdatePracticeRunConfigurationRequest.Builder avoiding the need to create one manually via UpdatePracticeRunConfigurationRequest.builder()

      Parameters:
      updatePracticeRunConfigurationRequest - A Consumer that will call methods on UpdatePracticeRunConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdatePracticeRunConfiguration 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.
      • InternalServerException There was an internal server error.
      • ConflictException The request could not be processed because of conflict in the current state of the resource.
      • ResourceNotFoundException The input requested a resource that was not found.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • 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.
      • ArcZonalShiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateZonalAutoshiftConfiguration

      default CompletableFuture<UpdateZonalAutoshiftConfigurationResponse> updateZonalAutoshiftConfiguration(UpdateZonalAutoshiftConfigurationRequest updateZonalAutoshiftConfigurationRequest)

      The zonal autoshift configuration for a resource includes the practice run configuration and the status for running autoshifts, zonal autoshift status. When a resource has a practice run configuation, Route 53 ARC starts weekly zonal shifts for the resource, to shift traffic away from an Availability Zone. Weekly practice runs help you to make sure that your application can continue to operate normally with the loss of one Availability Zone.

      You can update the zonal autoshift autoshift status to enable or disable zonal autoshift. When zonal autoshift is ENABLED, you authorize Amazon Web Services to shift away resource traffic for an application from an Availability Zone during events, on your behalf, to help reduce time to recovery. Traffic is also shifted away for the required weekly practice runs.

      Parameters:
      updateZonalAutoshiftConfigurationRequest -
      Returns:
      A Java Future containing the result of the UpdateZonalAutoshiftConfiguration 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.
      • InternalServerException There was an internal server error.
      • ConflictException The request could not be processed because of conflict in the current state of the resource.
      • ResourceNotFoundException The input requested a resource that was not found.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • 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.
      • ArcZonalShiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateZonalAutoshiftConfiguration

      default CompletableFuture<UpdateZonalAutoshiftConfigurationResponse> updateZonalAutoshiftConfiguration(Consumer<UpdateZonalAutoshiftConfigurationRequest.Builder> updateZonalAutoshiftConfigurationRequest)

      The zonal autoshift configuration for a resource includes the practice run configuration and the status for running autoshifts, zonal autoshift status. When a resource has a practice run configuation, Route 53 ARC starts weekly zonal shifts for the resource, to shift traffic away from an Availability Zone. Weekly practice runs help you to make sure that your application can continue to operate normally with the loss of one Availability Zone.

      You can update the zonal autoshift autoshift status to enable or disable zonal autoshift. When zonal autoshift is ENABLED, you authorize Amazon Web Services to shift away resource traffic for an application from an Availability Zone during events, on your behalf, to help reduce time to recovery. Traffic is also shifted away for the required weekly practice runs.


      This is a convenience which creates an instance of the UpdateZonalAutoshiftConfigurationRequest.Builder avoiding the need to create one manually via UpdateZonalAutoshiftConfigurationRequest.builder()

      Parameters:
      updateZonalAutoshiftConfigurationRequest - A Consumer that will call methods on UpdateZonalAutoshiftConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateZonalAutoshiftConfiguration 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.
      • InternalServerException There was an internal server error.
      • ConflictException The request could not be processed because of conflict in the current state of the resource.
      • ResourceNotFoundException The input requested a resource that was not found.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • 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.
      • ArcZonalShiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateZonalShift

      default CompletableFuture<UpdateZonalShiftResponse> updateZonalShift(UpdateZonalShiftRequest updateZonalShiftRequest)

      Update an active zonal shift in Amazon Route 53 Application Recovery Controller in your Amazon Web Services account. You can update a zonal shift to set a new expiration, or edit or replace the comment for the zonal shift.

      Parameters:
      updateZonalShiftRequest -
      Returns:
      A Java Future containing the result of the UpdateZonalShift 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.
      • InternalServerException There was an internal server error.
      • ConflictException The request could not be processed because of conflict in the current state of the resource.
      • ResourceNotFoundException The input requested a resource that was not found.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • 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.
      • ArcZonalShiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateZonalShift

      default CompletableFuture<UpdateZonalShiftResponse> updateZonalShift(Consumer<UpdateZonalShiftRequest.Builder> updateZonalShiftRequest)

      Update an active zonal shift in Amazon Route 53 Application Recovery Controller in your Amazon Web Services account. You can update a zonal shift to set a new expiration, or edit or replace the comment for the zonal shift.


      This is a convenience which creates an instance of the UpdateZonalShiftRequest.Builder avoiding the need to create one manually via UpdateZonalShiftRequest.builder()

      Parameters:
      updateZonalShiftRequest - A Consumer that will call methods on UpdateZonalShiftRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateZonalShift 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.
      • InternalServerException There was an internal server error.
      • ConflictException The request could not be processed because of conflict in the current state of the resource.
      • ResourceNotFoundException The input requested a resource that was not found.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • 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.
      • ArcZonalShiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

      default ArcZonalShiftServiceClientConfiguration 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 ArcZonalShiftAsyncClient create()
      Create a ArcZonalShiftAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static ArcZonalShiftAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a ArcZonalShiftAsyncClient.