software.amazon.awssdk.services.arczonalshift

Interface ArcZonalShiftClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

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

Service client for accessing AWS ARC - Zonal Shift. This can be created using the static builder() method.

This is the API Reference Guide for the zonal shift feature of Amazon Route 53 Application Recovery Controller. This guide is for developers who need detailed information about zonal shift API actions, data types, and errors.

Zonal shift is in preview release for Amazon Route 53 Application Recovery Controller and is subject to change.

Zonal shift in Route 53 ARC enables you to move traffic for a load balancer resource away from an Availability Zone. Starting a zonal shift helps your application recover immediately, for example, from a developer's bad code deployment or from an AWS infrastructure failure in a single Availability Zone, reducing the impact and time lost from an issue in one zone.

Supported AWS resources are automatically registered with Route 53 ARC. Resources that are registered for zonal shifts in Route 53 ARC are managed resources in Route 53 ARC. You can start a zonal shift for any managed resource in your account in a Region. 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.

Zonal shifts are temporary. You must specify an expiration when you start a zonal shift, of up to three days initially. If you want to still keep traffic away from an Availability Zone, you can update the zonal shift and set a new expiration. You can also cancel a zonal shift, before it expires, for example, if you're ready to restore traffic to the Availability Zone.

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVICE_METADATA_ID Value for looking up the service's metadata from the ServiceMetadataProvider.
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method and Description
static ArcZonalShiftClientBuilder	builder() Create a builder that can be used to configure and create a ArcZonalShiftClient.
default CancelZonalShiftResponse	cancelZonalShift(CancelZonalShiftRequest cancelZonalShiftRequest) Cancel a zonal shift in Amazon Route 53 Application Recovery Controller that you've started for a resource in your AWS account in an AWS Region.
default CancelZonalShiftResponse	cancelZonalShift(Consumer<CancelZonalShiftRequest.Builder> cancelZonalShiftRequest) Cancel a zonal shift in Amazon Route 53 Application Recovery Controller that you've started for a resource in your AWS account in an AWS Region.
static ArcZonalShiftClient	create() Create a ArcZonalShiftClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default 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 AWS Region.
default 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 AWS Region.
default ListManagedResourcesResponse	listManagedResources(Consumer<ListManagedResourcesRequest.Builder> listManagedResourcesRequest) Lists all the resources in your AWS account in this AWS Region that are managed for zonal shifts in Amazon Route 53 Application Recovery Controller, and information about them.
default ListManagedResourcesResponse	listManagedResources(ListManagedResourcesRequest listManagedResourcesRequest) Lists all the resources in your AWS account in this AWS Region that are managed for zonal shifts in Amazon Route 53 Application Recovery Controller, and information about them.
default ListManagedResourcesIterable	listManagedResourcesPaginator(Consumer<ListManagedResourcesRequest.Builder> listManagedResourcesRequest) Lists all the resources in your AWS account in this AWS Region that are managed for zonal shifts in Amazon Route 53 Application Recovery Controller, and information about them.
default ListManagedResourcesIterable	listManagedResourcesPaginator(ListManagedResourcesRequest listManagedResourcesRequest) Lists all the resources in your AWS account in this AWS Region that are managed for zonal shifts in Amazon Route 53 Application Recovery Controller, and information about them.
default ListZonalShiftsResponse	listZonalShifts(Consumer<ListZonalShiftsRequest.Builder> listZonalShiftsRequest) Lists all the active zonal shifts in Amazon Route 53 Application Recovery Controller in your AWS account in this AWS Region.
default ListZonalShiftsResponse	listZonalShifts(ListZonalShiftsRequest listZonalShiftsRequest) Lists all the active zonal shifts in Amazon Route 53 Application Recovery Controller in your AWS account in this AWS Region.
default ListZonalShiftsIterable	listZonalShiftsPaginator(Consumer<ListZonalShiftsRequest.Builder> listZonalShiftsRequest) Lists all the active zonal shifts in Amazon Route 53 Application Recovery Controller in your AWS account in this AWS Region.
default ListZonalShiftsIterable	listZonalShiftsPaginator(ListZonalShiftsRequest listZonalShiftsRequest) Lists all the active zonal shifts in Amazon Route 53 Application Recovery Controller in your AWS account in this AWS Region.
default ArcZonalShiftServiceClientConfiguration	serviceClientConfiguration()
static ServiceMetadata	serviceMetadata()
default StartZonalShiftResponse	startZonalShift(Consumer<StartZonalShiftRequest.Builder> startZonalShiftRequest) You start a zonal shift to temporarily move load balancer traffic away from an Availability Zone in a AWS Region, to help your application recover immediately, for example, from a developer's bad code deployment or from an AWS infrastructure failure in a single Availability Zone.
default StartZonalShiftResponse	startZonalShift(StartZonalShiftRequest startZonalShiftRequest) You start a zonal shift to temporarily move load balancer traffic away from an Availability Zone in a AWS Region, to help your application recover immediately, for example, from a developer's bad code deployment or from an AWS infrastructure failure in a single Availability Zone.
default UpdateZonalShiftResponse	updateZonalShift(Consumer<UpdateZonalShiftRequest.Builder> updateZonalShiftRequest) Update an active zonal shift in Amazon Route 53 Application Recovery Controller in your AWS account.
default UpdateZonalShiftResponse	updateZonalShift(UpdateZonalShiftRequest updateZonalShiftRequest) Update an active zonal shift in Amazon Route 53 Application Recovery Controller in your AWS account.

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

serviceName

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

close

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 the ServiceMetadataProvider.

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 that you've started for a resource in your AWS account in an AWS Region.

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 AWS 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 that you've started for a resource in your AWS account in an AWS Region.

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:

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 AWS 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(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 AWS Region. Resources that are registered for zonal shifts are managed resources in Route 53 ARC.

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.

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 AWS 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 AWS Region. Resources that are registered for zonal shifts are managed resources in Route 53 ARC.

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.

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:

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 AWS 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 AWS account in this AWS Region that are managed for zonal shifts in Amazon Route 53 Application Recovery Controller, and information about them. The information includes their Amazon Resource Names (ARNs), the Availability Zones the resources are 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 AWS 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 AWS account in this AWS Region that are managed for zonal shifts in Amazon Route 53 Application Recovery Controller, and information about them. The information includes their Amazon Resource Names (ARNs), the Availability Zones the resources are 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:

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 AWS 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

Lists all the resources in your AWS account in this AWS Region that are managed for zonal shifts in Amazon Route 53 Application Recovery Controller, and information about them. The information includes their Amazon Resource Names (ARNs), the Availability Zones the resources are deployed in, and the resource name.

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

 
 software.amazon.awssdk.services.arczonalshift.paginators.ListManagedResourcesIterable responses = client.listManagedResourcesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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 AWS 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

Lists all the resources in your AWS account in this AWS Region that are managed for zonal shifts in Amazon Route 53 Application Recovery Controller, and information about them. The information includes their Amazon Resource Names (ARNs), the Availability Zones the resources are deployed in, and the resource name.

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

 
 software.amazon.awssdk.services.arczonalshift.paginators.ListManagedResourcesIterable responses = client.listManagedResourcesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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.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 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 AWS 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 the active zonal shifts in Amazon Route 53 Application Recovery Controller in your AWS account in this AWS Region.

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 AWS 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 the active zonal shifts in Amazon Route 53 Application Recovery Controller in your AWS account in this AWS Region.

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:

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 AWS 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

Lists all the active zonal shifts in Amazon Route 53 Application Recovery Controller in your AWS account in this AWS Region.

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

 
 software.amazon.awssdk.services.arczonalshift.paginators.ListZonalShiftsIterable responses = client.listZonalShiftsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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 AWS 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

Lists all the active zonal shifts in Amazon Route 53 Application Recovery Controller in your AWS account in this AWS Region.

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

 
 software.amazon.awssdk.services.arczonalshift.paginators.ListZonalShiftsIterable responses = client.listZonalShiftsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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.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 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 AWS 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 a AWS Region, to help your application recover immediately, for example, from a developer's bad code deployment or from an AWS infrastructure failure in a single Availability Zone. You can start a zonal shift in Route 53 ARC only for managed resources in your account in an AWS Region. Resources are automatically registered with Route 53 ARC by AWS 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 AWS 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 a AWS Region, to help your application recover immediately, for example, from a developer's bad code deployment or from an AWS infrastructure failure in a single Availability Zone. You can start a zonal shift in Route 53 ARC only for managed resources in your account in an AWS Region. Resources are automatically registered with Route 53 ARC by AWS 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:

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 AWS 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 AWS 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 AWS 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 AWS 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:

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 AWS 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 a ArcZonalShiftClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static ArcZonalShiftClientBuilder builder()

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

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default ArcZonalShiftServiceClientConfiguration serviceClientConfiguration()

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient