Interface ArcZonalShiftClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface ArcZonalShiftClient extends AwsClient
Service client for accessing AWS ARC - Zonal Shift. This can be created using the staticbuilder()method.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 Summary
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
All Methods Static Methods Instance Methods Default Methods Modifier and Type Method Description static ArcZonalShiftClientBuilderbuilder()Create a builder that can be used to configure and create aArcZonalShiftClient.default CancelZonalShiftResponsecancelZonalShift(Consumer<CancelZonalShiftRequest.Builder> cancelZonalShiftRequest)Cancel a zonal shift in Amazon Route 53 Application Recovery Controller.default CancelZonalShiftResponsecancelZonalShift(CancelZonalShiftRequest cancelZonalShiftRequest)Cancel a zonal shift in Amazon Route 53 Application Recovery Controller.static ArcZonalShiftClientcreate()Create aArcZonalShiftClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CreatePracticeRunConfigurationResponsecreatePracticeRunConfiguration(Consumer<CreatePracticeRunConfigurationRequest.Builder> createPracticeRunConfigurationRequest)A practice run configuration for zonal autoshift is required when you enable zonal autoshift.default CreatePracticeRunConfigurationResponsecreatePracticeRunConfiguration(CreatePracticeRunConfigurationRequest createPracticeRunConfigurationRequest)A practice run configuration for zonal autoshift is required when you enable zonal autoshift.default DeletePracticeRunConfigurationResponsedeletePracticeRunConfiguration(Consumer<DeletePracticeRunConfigurationRequest.Builder> deletePracticeRunConfigurationRequest)Deletes the practice run configuration for a resource.default DeletePracticeRunConfigurationResponsedeletePracticeRunConfiguration(DeletePracticeRunConfigurationRequest deletePracticeRunConfigurationRequest)Deletes the practice run configuration for a resource.default GetAutoshiftObserverNotificationStatusResponsegetAutoshiftObserverNotificationStatus(Consumer<GetAutoshiftObserverNotificationStatusRequest.Builder> getAutoshiftObserverNotificationStatusRequest)Returns the status of autoshift observer notification.default GetAutoshiftObserverNotificationStatusResponsegetAutoshiftObserverNotificationStatus(GetAutoshiftObserverNotificationStatusRequest getAutoshiftObserverNotificationStatusRequest)Returns the status of autoshift observer notification.default GetManagedResourceResponsegetManagedResource(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.default GetManagedResourceResponsegetManagedResource(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.default ListAutoshiftsResponselistAutoshifts(Consumer<ListAutoshiftsRequest.Builder> listAutoshiftsRequest)Returns a list of autoshifts for an Amazon Web Services Region.default ListAutoshiftsResponselistAutoshifts(ListAutoshiftsRequest listAutoshiftsRequest)Returns a list of autoshifts for an Amazon Web Services Region.default ListAutoshiftsIterablelistAutoshiftsPaginator(Consumer<ListAutoshiftsRequest.Builder> listAutoshiftsRequest)This is a variant oflistAutoshifts(software.amazon.awssdk.services.arczonalshift.model.ListAutoshiftsRequest)operation.default ListAutoshiftsIterablelistAutoshiftsPaginator(ListAutoshiftsRequest listAutoshiftsRequest)This is a variant oflistAutoshifts(software.amazon.awssdk.services.arczonalshift.model.ListAutoshiftsRequest)operation.default ListManagedResourcesResponselistManagedResources(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.default ListManagedResourcesResponselistManagedResources(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.default ListManagedResourcesIterablelistManagedResourcesPaginator(Consumer<ListManagedResourcesRequest.Builder> listManagedResourcesRequest)This is a variant oflistManagedResources(software.amazon.awssdk.services.arczonalshift.model.ListManagedResourcesRequest)operation.default ListManagedResourcesIterablelistManagedResourcesPaginator(ListManagedResourcesRequest listManagedResourcesRequest)This is a variant oflistManagedResources(software.amazon.awssdk.services.arczonalshift.model.ListManagedResourcesRequest)operation.default ListZonalShiftsResponselistZonalShifts(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.default ListZonalShiftsResponselistZonalShifts(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.default ListZonalShiftsIterablelistZonalShiftsPaginator(Consumer<ListZonalShiftsRequest.Builder> listZonalShiftsRequest)This is a variant oflistZonalShifts(software.amazon.awssdk.services.arczonalshift.model.ListZonalShiftsRequest)operation.default ListZonalShiftsIterablelistZonalShiftsPaginator(ListZonalShiftsRequest listZonalShiftsRequest)This is a variant oflistZonalShifts(software.amazon.awssdk.services.arczonalshift.model.ListZonalShiftsRequest)operation.default ArcZonalShiftServiceClientConfigurationserviceClientConfiguration()static ServiceMetadataserviceMetadata()default StartZonalShiftResponsestartZonalShift(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.default StartZonalShiftResponsestartZonalShift(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.default UpdateAutoshiftObserverNotificationStatusResponseupdateAutoshiftObserverNotificationStatus(Consumer<UpdateAutoshiftObserverNotificationStatusRequest.Builder> updateAutoshiftObserverNotificationStatusRequest)Update the status of autoshift observer notification.default UpdateAutoshiftObserverNotificationStatusResponseupdateAutoshiftObserverNotificationStatus(UpdateAutoshiftObserverNotificationStatusRequest updateAutoshiftObserverNotificationStatusRequest)Update the status of autoshift observer notification.default UpdatePracticeRunConfigurationResponseupdatePracticeRunConfiguration(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.default UpdatePracticeRunConfigurationResponseupdatePracticeRunConfiguration(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.default UpdateZonalAutoshiftConfigurationResponseupdateZonalAutoshiftConfiguration(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.default UpdateZonalAutoshiftConfigurationResponseupdateZonalAutoshiftConfiguration(UpdateZonalAutoshiftConfigurationRequest updateZonalAutoshiftConfigurationRequest)The zonal autoshift configuration for a resource includes the practice run configuration and the status for running autoshifts, zonal autoshift status.default UpdateZonalShiftResponseupdateZonalShift(Consumer<UpdateZonalShiftRequest.Builder> updateZonalShiftRequest)Update an active zonal shift in Amazon Route 53 Application Recovery Controller in your Amazon Web Services account.default UpdateZonalShiftResponseupdateZonalShift(UpdateZonalShiftRequest updateZonalShiftRequest)Update an active zonal shift in Amazon Route 53 Application Recovery Controller in your Amazon Web Services account.-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
cancelZonalShift
default CancelZonalShiftResponse cancelZonalShift(CancelZonalShiftRequest cancelZonalShiftRequest) throws InternalServerException, ConflictException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ArcZonalShiftException
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:
- Result of the CancelZonalShift operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
cancelZonalShift
default CancelZonalShiftResponse cancelZonalShift(Consumer<CancelZonalShiftRequest.Builder> cancelZonalShiftRequest) throws InternalServerException, ConflictException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ArcZonalShiftException
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.Builderavoiding the need to create one manually viaCancelZonalShiftRequest.builder()- Parameters:
cancelZonalShiftRequest- AConsumerthat will call methods onCancelZonalShiftRequest.Builderto create a request.- Returns:
- Result of the CancelZonalShift operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createPracticeRunConfiguration
default CreatePracticeRunConfigurationResponse createPracticeRunConfiguration(CreatePracticeRunConfigurationRequest createPracticeRunConfigurationRequest) throws InternalServerException, ConflictException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ArcZonalShiftException
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:
- Result of the CreatePracticeRunConfiguration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createPracticeRunConfiguration
default CreatePracticeRunConfigurationResponse createPracticeRunConfiguration(Consumer<CreatePracticeRunConfigurationRequest.Builder> createPracticeRunConfigurationRequest) throws InternalServerException, ConflictException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ArcZonalShiftException
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.Builderavoiding the need to create one manually viaCreatePracticeRunConfigurationRequest.builder()- Parameters:
createPracticeRunConfigurationRequest- AConsumerthat will call methods onCreatePracticeRunConfigurationRequest.Builderto create a request.- Returns:
- Result of the CreatePracticeRunConfiguration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deletePracticeRunConfiguration
default DeletePracticeRunConfigurationResponse deletePracticeRunConfiguration(DeletePracticeRunConfigurationRequest deletePracticeRunConfigurationRequest) throws InternalServerException, ConflictException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ArcZonalShiftException
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:
- Result of the DeletePracticeRunConfiguration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deletePracticeRunConfiguration
default DeletePracticeRunConfigurationResponse deletePracticeRunConfiguration(Consumer<DeletePracticeRunConfigurationRequest.Builder> deletePracticeRunConfigurationRequest) throws InternalServerException, ConflictException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ArcZonalShiftException
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.Builderavoiding the need to create one manually viaDeletePracticeRunConfigurationRequest.builder()- Parameters:
deletePracticeRunConfigurationRequest- AConsumerthat will call methods onDeletePracticeRunConfigurationRequest.Builderto create a request.- Returns:
- Result of the DeletePracticeRunConfiguration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getAutoshiftObserverNotificationStatus
default GetAutoshiftObserverNotificationStatusResponse getAutoshiftObserverNotificationStatus(GetAutoshiftObserverNotificationStatusRequest getAutoshiftObserverNotificationStatusRequest) throws InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ArcZonalShiftException
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 patternAutoshift In Progress. When the status isDISABLED, 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:
- Result of the GetAutoshiftObserverNotificationStatus operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getAutoshiftObserverNotificationStatus
default GetAutoshiftObserverNotificationStatusResponse getAutoshiftObserverNotificationStatus(Consumer<GetAutoshiftObserverNotificationStatusRequest.Builder> getAutoshiftObserverNotificationStatusRequest) throws InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, ArcZonalShiftException
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 patternAutoshift In Progress. When the status isDISABLED, 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.Builderavoiding the need to create one manually viaGetAutoshiftObserverNotificationStatusRequest.builder()- Parameters:
getAutoshiftObserverNotificationStatusRequest- AConsumerthat will call methods onGetAutoshiftObserverNotificationStatusRequest.Builderto create a request.- Returns:
- Result of the GetAutoshiftObserverNotificationStatus operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getManagedResource
default GetManagedResourceResponse getManagedResource(GetManagedResourceRequest getManagedResourceRequest) throws InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ArcZonalShiftException
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:
- Result of the GetManagedResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getManagedResource
default GetManagedResourceResponse getManagedResource(Consumer<GetManagedResourceRequest.Builder> getManagedResourceRequest) throws InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ArcZonalShiftException
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.Builderavoiding the need to create one manually viaGetManagedResourceRequest.builder()- Parameters:
getManagedResourceRequest- AConsumerthat will call methods onGetManagedResourceRequest.Builderto create a request.- Returns:
- Result of the GetManagedResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listAutoshifts
default ListAutoshiftsResponse listAutoshifts(ListAutoshiftsRequest listAutoshiftsRequest) throws InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ArcZonalShiftException
Returns a list of autoshifts for an Amazon Web Services Region. By default, the call returns only
ACTIVEautoshifts. Optionally, you can specify thestatusparameter to returnCOMPLETEDautoshifts.- Parameters:
listAutoshiftsRequest-- Returns:
- Result of the ListAutoshifts operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listAutoshifts
default ListAutoshiftsResponse listAutoshifts(Consumer<ListAutoshiftsRequest.Builder> listAutoshiftsRequest) throws InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ArcZonalShiftException
Returns a list of autoshifts for an Amazon Web Services Region. By default, the call returns only
ACTIVEautoshifts. Optionally, you can specify thestatusparameter to returnCOMPLETEDautoshifts.
This is a convenience which creates an instance of the
ListAutoshiftsRequest.Builderavoiding the need to create one manually viaListAutoshiftsRequest.builder()- Parameters:
listAutoshiftsRequest- AConsumerthat will call methods onListAutoshiftsRequest.Builderto create a request.- Returns:
- Result of the ListAutoshifts operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listAutoshiftsPaginator
default ListAutoshiftsIterable listAutoshiftsPaginator(ListAutoshiftsRequest listAutoshiftsRequest) throws InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ArcZonalShiftException
This is a variant of
listAutoshifts(software.amazon.awssdk.services.arczonalshift.model.ListAutoshiftsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.arczonalshift.paginators.ListAutoshiftsIterable responses = client.listAutoshiftsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.arczonalshift.paginators.ListAutoshiftsIterable responses = client .listAutoshiftsPaginator(request); for (software.amazon.awssdk.services.arczonalshift.model.ListAutoshiftsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.arczonalshift.paginators.ListAutoshiftsIterable responses = client.listAutoshiftsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAutoshifts(software.amazon.awssdk.services.arczonalshift.model.ListAutoshiftsRequest)operation.- Parameters:
listAutoshiftsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listAutoshiftsPaginator
default ListAutoshiftsIterable listAutoshiftsPaginator(Consumer<ListAutoshiftsRequest.Builder> listAutoshiftsRequest) throws InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ArcZonalShiftException
This is a variant of
listAutoshifts(software.amazon.awssdk.services.arczonalshift.model.ListAutoshiftsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.arczonalshift.paginators.ListAutoshiftsIterable responses = client.listAutoshiftsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.arczonalshift.paginators.ListAutoshiftsIterable responses = client .listAutoshiftsPaginator(request); for (software.amazon.awssdk.services.arczonalshift.model.ListAutoshiftsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.arczonalshift.paginators.ListAutoshiftsIterable responses = client.listAutoshiftsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAutoshifts(software.amazon.awssdk.services.arczonalshift.model.ListAutoshiftsRequest)operation.
This is a convenience which creates an instance of the
ListAutoshiftsRequest.Builderavoiding the need to create one manually viaListAutoshiftsRequest.builder()- Parameters:
listAutoshiftsRequest- AConsumerthat will call methods onListAutoshiftsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listManagedResources
default ListManagedResourcesResponse listManagedResources(ListManagedResourcesRequest listManagedResourcesRequest) throws InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ArcZonalShiftException
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:
- Result of the ListManagedResources operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listManagedResources
default ListManagedResourcesResponse listManagedResources(Consumer<ListManagedResourcesRequest.Builder> listManagedResourcesRequest) throws InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ArcZonalShiftException
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.Builderavoiding the need to create one manually viaListManagedResourcesRequest.builder()- Parameters:
listManagedResourcesRequest- AConsumerthat will call methods onListManagedResourcesRequest.Builderto create a request.- Returns:
- Result of the ListManagedResources operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listManagedResourcesPaginator
default ListManagedResourcesIterable listManagedResourcesPaginator(ListManagedResourcesRequest listManagedResourcesRequest) throws InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ArcZonalShiftException
This is a variant of
listManagedResources(software.amazon.awssdk.services.arczonalshift.model.ListManagedResourcesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.arczonalshift.paginators.ListManagedResourcesIterable responses = client.listManagedResourcesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.arczonalshift.paginators.ListManagedResourcesIterable responses = client .listManagedResourcesPaginator(request); for (software.amazon.awssdk.services.arczonalshift.model.ListManagedResourcesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.arczonalshift.paginators.ListManagedResourcesIterable responses = client.listManagedResourcesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listManagedResources(software.amazon.awssdk.services.arczonalshift.model.ListManagedResourcesRequest)operation.- Parameters:
listManagedResourcesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listManagedResourcesPaginator
default ListManagedResourcesIterable listManagedResourcesPaginator(Consumer<ListManagedResourcesRequest.Builder> listManagedResourcesRequest) throws InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ArcZonalShiftException
This is a variant of
listManagedResources(software.amazon.awssdk.services.arczonalshift.model.ListManagedResourcesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.arczonalshift.paginators.ListManagedResourcesIterable responses = client.listManagedResourcesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.arczonalshift.paginators.ListManagedResourcesIterable responses = client .listManagedResourcesPaginator(request); for (software.amazon.awssdk.services.arczonalshift.model.ListManagedResourcesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.arczonalshift.paginators.ListManagedResourcesIterable responses = client.listManagedResourcesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listManagedResources(software.amazon.awssdk.services.arczonalshift.model.ListManagedResourcesRequest)operation.
This is a convenience which creates an instance of the
ListManagedResourcesRequest.Builderavoiding the need to create one manually viaListManagedResourcesRequest.builder()- Parameters:
listManagedResourcesRequest- AConsumerthat will call methods onListManagedResourcesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listZonalShifts
default ListZonalShiftsResponse listZonalShifts(ListZonalShiftsRequest listZonalShiftsRequest) throws InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ArcZonalShiftException
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.
ListZonalShiftsreturns customer-initiated zonal shifts, as well as practice run zonal shifts that Route 53 ARC started on your behalf for zonal autoshift.The
ListZonalShiftsoperation does not list autoshifts. For more information about listing autoshifts, see ">ListAutoshifts.- Parameters:
listZonalShiftsRequest-- Returns:
- Result of the ListZonalShifts operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listZonalShifts
default ListZonalShiftsResponse listZonalShifts(Consumer<ListZonalShiftsRequest.Builder> listZonalShiftsRequest) throws InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ArcZonalShiftException
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.
ListZonalShiftsreturns customer-initiated zonal shifts, as well as practice run zonal shifts that Route 53 ARC started on your behalf for zonal autoshift.The
ListZonalShiftsoperation does not list autoshifts. For more information about listing autoshifts, see ">ListAutoshifts.
This is a convenience which creates an instance of the
ListZonalShiftsRequest.Builderavoiding the need to create one manually viaListZonalShiftsRequest.builder()- Parameters:
listZonalShiftsRequest- AConsumerthat will call methods onListZonalShiftsRequest.Builderto create a request.- Returns:
- Result of the ListZonalShifts operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listZonalShiftsPaginator
default ListZonalShiftsIterable listZonalShiftsPaginator(ListZonalShiftsRequest listZonalShiftsRequest) throws InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ArcZonalShiftException
This is a variant of
listZonalShifts(software.amazon.awssdk.services.arczonalshift.model.ListZonalShiftsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.arczonalshift.paginators.ListZonalShiftsIterable responses = client.listZonalShiftsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.arczonalshift.paginators.ListZonalShiftsIterable responses = client .listZonalShiftsPaginator(request); for (software.amazon.awssdk.services.arczonalshift.model.ListZonalShiftsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.arczonalshift.paginators.ListZonalShiftsIterable responses = client.listZonalShiftsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listZonalShifts(software.amazon.awssdk.services.arczonalshift.model.ListZonalShiftsRequest)operation.- Parameters:
listZonalShiftsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listZonalShiftsPaginator
default ListZonalShiftsIterable listZonalShiftsPaginator(Consumer<ListZonalShiftsRequest.Builder> listZonalShiftsRequest) throws InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ArcZonalShiftException
This is a variant of
listZonalShifts(software.amazon.awssdk.services.arczonalshift.model.ListZonalShiftsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.arczonalshift.paginators.ListZonalShiftsIterable responses = client.listZonalShiftsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.arczonalshift.paginators.ListZonalShiftsIterable responses = client .listZonalShiftsPaginator(request); for (software.amazon.awssdk.services.arczonalshift.model.ListZonalShiftsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.arczonalshift.paginators.ListZonalShiftsIterable responses = client.listZonalShiftsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listZonalShifts(software.amazon.awssdk.services.arczonalshift.model.ListZonalShiftsRequest)operation.
This is a convenience which creates an instance of the
ListZonalShiftsRequest.Builderavoiding the need to create one manually viaListZonalShiftsRequest.builder()- Parameters:
listZonalShiftsRequest- AConsumerthat will call methods onListZonalShiftsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
startZonalShift
default StartZonalShiftResponse startZonalShift(StartZonalShiftRequest startZonalShiftRequest) throws InternalServerException, ConflictException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ArcZonalShiftException
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:
- Result of the StartZonalShift operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
startZonalShift
default StartZonalShiftResponse startZonalShift(Consumer<StartZonalShiftRequest.Builder> startZonalShiftRequest) throws InternalServerException, ConflictException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ArcZonalShiftException
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.Builderavoiding the need to create one manually viaStartZonalShiftRequest.builder()- Parameters:
startZonalShiftRequest- AConsumerthat will call methods onStartZonalShiftRequest.Builderto create a request.- Returns:
- Result of the StartZonalShift operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateAutoshiftObserverNotificationStatus
default UpdateAutoshiftObserverNotificationStatusResponse updateAutoshiftObserverNotificationStatus(UpdateAutoshiftObserverNotificationStatusRequest updateAutoshiftObserverNotificationStatusRequest) throws InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ArcZonalShiftException
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 patternAutoshift In Progress. When the status isDISABLED, 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:
- Result of the UpdateAutoshiftObserverNotificationStatus operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateAutoshiftObserverNotificationStatus
default UpdateAutoshiftObserverNotificationStatusResponse updateAutoshiftObserverNotificationStatus(Consumer<UpdateAutoshiftObserverNotificationStatusRequest.Builder> updateAutoshiftObserverNotificationStatusRequest) throws InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ArcZonalShiftException
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 patternAutoshift In Progress. When the status isDISABLED, 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.Builderavoiding the need to create one manually viaUpdateAutoshiftObserverNotificationStatusRequest.builder()- Parameters:
updateAutoshiftObserverNotificationStatusRequest- AConsumerthat will call methods onUpdateAutoshiftObserverNotificationStatusRequest.Builderto create a request.- Returns:
- Result of the UpdateAutoshiftObserverNotificationStatus operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updatePracticeRunConfiguration
default UpdatePracticeRunConfigurationResponse updatePracticeRunConfiguration(UpdatePracticeRunConfigurationRequest updatePracticeRunConfigurationRequest) throws InternalServerException, ConflictException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ArcZonalShiftException
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:
- Result of the UpdatePracticeRunConfiguration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updatePracticeRunConfiguration
default UpdatePracticeRunConfigurationResponse updatePracticeRunConfiguration(Consumer<UpdatePracticeRunConfigurationRequest.Builder> updatePracticeRunConfigurationRequest) throws InternalServerException, ConflictException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ArcZonalShiftException
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.Builderavoiding the need to create one manually viaUpdatePracticeRunConfigurationRequest.builder()- Parameters:
updatePracticeRunConfigurationRequest- AConsumerthat will call methods onUpdatePracticeRunConfigurationRequest.Builderto create a request.- Returns:
- Result of the UpdatePracticeRunConfiguration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateZonalAutoshiftConfiguration
default UpdateZonalAutoshiftConfigurationResponse updateZonalAutoshiftConfiguration(UpdateZonalAutoshiftConfigurationRequest updateZonalAutoshiftConfigurationRequest) throws InternalServerException, ConflictException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ArcZonalShiftException
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:
- Result of the UpdateZonalAutoshiftConfiguration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateZonalAutoshiftConfiguration
default UpdateZonalAutoshiftConfigurationResponse updateZonalAutoshiftConfiguration(Consumer<UpdateZonalAutoshiftConfigurationRequest.Builder> updateZonalAutoshiftConfigurationRequest) throws InternalServerException, ConflictException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ArcZonalShiftException
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.Builderavoiding the need to create one manually viaUpdateZonalAutoshiftConfigurationRequest.builder()- Parameters:
updateZonalAutoshiftConfigurationRequest- AConsumerthat will call methods onUpdateZonalAutoshiftConfigurationRequest.Builderto create a request.- Returns:
- Result of the UpdateZonalAutoshiftConfiguration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateZonalShift
default UpdateZonalShiftResponse updateZonalShift(UpdateZonalShiftRequest updateZonalShiftRequest) throws InternalServerException, ConflictException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ArcZonalShiftException
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:
- Result of the UpdateZonalShift operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateZonalShift
default UpdateZonalShiftResponse updateZonalShift(Consumer<UpdateZonalShiftRequest.Builder> updateZonalShiftRequest) throws InternalServerException, ConflictException, ResourceNotFoundException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, ArcZonalShiftException
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.Builderavoiding the need to create one manually viaUpdateZonalShiftRequest.builder()- Parameters:
updateZonalShiftRequest- AConsumerthat will call methods onUpdateZonalShiftRequest.Builderto create a request.- Returns:
- Result of the UpdateZonalShift operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
create
static ArcZonalShiftClient create()
Create aArcZonalShiftClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static ArcZonalShiftClientBuilder builder()
Create a builder that can be used to configure and create aArcZonalShiftClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default ArcZonalShiftServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-