*
* 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. *
*/ @ThreadSafe @Generated("com.amazonaws:aws-java-sdk-code-generator") public class AWSARCZonalShiftClient extends AmazonWebServiceClient implements AWSARCZonalShift { /** Provider for AWS credentials. */ private final AWSCredentialsProvider awsCredentialsProvider; private static final Log log = LogFactory.getLog(AWSARCZonalShift.class); /** Default signing name for the service. */ private static final String DEFAULT_SIGNING_NAME = "arc-zonal-shift"; /** Client configuration factory providing ClientConfigurations tailored to this client */ protected static final ClientConfigurationFactory configFactory = new ClientConfigurationFactory(); private final AdvancedConfig advancedConfig; private static final com.amazonaws.protocol.json.SdkJsonProtocolFactory protocolFactory = new com.amazonaws.protocol.json.SdkJsonProtocolFactory( new JsonClientMetadata() .withProtocolVersion("1.1") .withSupportsCbor(false) .withSupportsIon(false) .withContentTypeOverride("application/json") .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("AccessDeniedException").withExceptionUnmarshaller( com.amazonaws.services.arczonalshift.model.transform.AccessDeniedExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("ValidationException").withExceptionUnmarshaller( com.amazonaws.services.arczonalshift.model.transform.ValidationExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("ConflictException").withExceptionUnmarshaller( com.amazonaws.services.arczonalshift.model.transform.ConflictExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("ResourceNotFoundException").withExceptionUnmarshaller( com.amazonaws.services.arczonalshift.model.transform.ResourceNotFoundExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("InternalServerException").withExceptionUnmarshaller( com.amazonaws.services.arczonalshift.model.transform.InternalServerExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("ThrottlingException").withExceptionUnmarshaller( com.amazonaws.services.arczonalshift.model.transform.ThrottlingExceptionUnmarshaller.getInstance())) .withBaseServiceExceptionClass(com.amazonaws.services.arczonalshift.model.AWSARCZonalShiftException.class)); public static AWSARCZonalShiftClientBuilder builder() { return AWSARCZonalShiftClientBuilder.standard(); } /** * Constructs a new client to invoke service methods on AWS ARC - Zonal Shift using the specified parameters. * ** All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @param clientParams * Object providing client parameters. */ AWSARCZonalShiftClient(AwsSyncClientParams clientParams) { this(clientParams, false); } /** * Constructs a new client to invoke service methods on AWS ARC - Zonal Shift using the specified parameters. * *
* All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @param clientParams * Object providing client parameters. */ AWSARCZonalShiftClient(AwsSyncClientParams clientParams, boolean endpointDiscoveryEnabled) { super(clientParams); this.awsCredentialsProvider = clientParams.getCredentialsProvider(); this.advancedConfig = clientParams.getAdvancedConfig(); init(); } private void init() { setServiceNameIntern(DEFAULT_SIGNING_NAME); setEndpointPrefix(ENDPOINT_PREFIX); // calling this.setEndPoint(...) will also modify the signer accordingly setEndpoint("arc-zonal-shift.us-east-1.amazonaws.com"); HandlerChainFactory chainFactory = new HandlerChainFactory(); requestHandler2s.addAll(chainFactory.newRequestHandlerChain("/com/amazonaws/services/arczonalshift/request.handlers")); requestHandler2s.addAll(chainFactory.newRequestHandler2Chain("/com/amazonaws/services/arczonalshift/request.handler2s")); requestHandler2s.addAll(chainFactory.getGlobalHandlers()); } /** *
* 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. *
* * @param cancelZonalShiftRequest * @return Result of the CancelZonalShift operation returned by the service. * @throws InternalServerException * There was an internal server error. * @throws ConflictException * The request could not be processed because of conflict in the current state of the resource. * @throws ResourceNotFoundException * The input requested a resource that was not found. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The input fails to satisfy the constraints specified by an AWS service. * @throws AccessDeniedException * You do not have sufficient access to perform this action. * @sample AWSARCZonalShift.CancelZonalShift * @see AWS API Documentation */ @Override public CancelZonalShiftResult cancelZonalShift(CancelZonalShiftRequest request) { request = beforeClientExecution(request); return executeCancelZonalShift(request); } @SdkInternalApi final CancelZonalShiftResult executeCancelZonalShift(CancelZonalShiftRequest cancelZonalShiftRequest) { ExecutionContext executionContext = createExecutionContext(cancelZonalShiftRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* 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. *
* * @param getManagedResourceRequest * @return Result of the GetManagedResource operation returned by the service. * @throws InternalServerException * There was an internal server error. * @throws ResourceNotFoundException * The input requested a resource that was not found. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The input fails to satisfy the constraints specified by an AWS service. * @throws AccessDeniedException * You do not have sufficient access to perform this action. * @sample AWSARCZonalShift.GetManagedResource * @see AWS API Documentation */ @Override public GetManagedResourceResult getManagedResource(GetManagedResourceRequest request) { request = beforeClientExecution(request); return executeGetManagedResource(request); } @SdkInternalApi final GetManagedResourceResult executeGetManagedResource(GetManagedResourceRequest getManagedResourceRequest) { ExecutionContext executionContext = createExecutionContext(getManagedResourceRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* 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. *
* * @param listManagedResourcesRequest * @return Result of the ListManagedResources operation returned by the service. * @throws InternalServerException * There was an internal server error. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The input fails to satisfy the constraints specified by an AWS service. * @throws AccessDeniedException * You do not have sufficient access to perform this action. * @sample AWSARCZonalShift.ListManagedResources * @see AWS API Documentation */ @Override public ListManagedResourcesResult listManagedResources(ListManagedResourcesRequest request) { request = beforeClientExecution(request); return executeListManagedResources(request); } @SdkInternalApi final ListManagedResourcesResult executeListManagedResources(ListManagedResourcesRequest listManagedResourcesRequest) { ExecutionContext executionContext = createExecutionContext(listManagedResourcesRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Lists all the active zonal shifts in Amazon Route 53 Application Recovery Controller in your AWS account in this * AWS Region. *
* * @param listZonalShiftsRequest * @return Result of the ListZonalShifts operation returned by the service. * @throws InternalServerException * There was an internal server error. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The input fails to satisfy the constraints specified by an AWS service. * @throws AccessDeniedException * You do not have sufficient access to perform this action. * @sample AWSARCZonalShift.ListZonalShifts * @see AWS API Documentation */ @Override public ListZonalShiftsResult listZonalShifts(ListZonalShiftsRequest request) { request = beforeClientExecution(request); return executeListZonalShifts(request); } @SdkInternalApi final ListZonalShiftsResult executeListZonalShifts(ListZonalShiftsRequest listZonalShiftsRequest) { ExecutionContext executionContext = createExecutionContext(listZonalShiftsRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* 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. *
* * @param startZonalShiftRequest * @return Result of the StartZonalShift operation returned by the service. * @throws InternalServerException * There was an internal server error. * @throws ConflictException * The request could not be processed because of conflict in the current state of the resource. * @throws ResourceNotFoundException * The input requested a resource that was not found. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The input fails to satisfy the constraints specified by an AWS service. * @throws AccessDeniedException * You do not have sufficient access to perform this action. * @sample AWSARCZonalShift.StartZonalShift * @see AWS API Documentation */ @Override public StartZonalShiftResult startZonalShift(StartZonalShiftRequest request) { request = beforeClientExecution(request); return executeStartZonalShift(request); } @SdkInternalApi final StartZonalShiftResult executeStartZonalShift(StartZonalShiftRequest startZonalShiftRequest) { ExecutionContext executionContext = createExecutionContext(startZonalShiftRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* 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. *
* * @param updateZonalShiftRequest * @return Result of the UpdateZonalShift operation returned by the service. * @throws InternalServerException * There was an internal server error. * @throws ConflictException * The request could not be processed because of conflict in the current state of the resource. * @throws ResourceNotFoundException * The input requested a resource that was not found. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The input fails to satisfy the constraints specified by an AWS service. * @throws AccessDeniedException * You do not have sufficient access to perform this action. * @sample AWSARCZonalShift.UpdateZonalShift * @see AWS API Documentation */ @Override public UpdateZonalShiftResult updateZonalShift(UpdateZonalShiftRequest request) { request = beforeClientExecution(request); return executeUpdateZonalShift(request); } @SdkInternalApi final UpdateZonalShiftResult executeUpdateZonalShift(UpdateZonalShiftRequest updateZonalShiftRequest) { ExecutionContext executionContext = createExecutionContext(updateZonalShiftRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request
* Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic
* information for an executed request, you should use this method to retrieve it as soon as possible after
* executing the request.
*
* @param request
* The originally executed request
*
* @return The response metadata for the specified request, or null if none is available.
*/
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request) {
return client.getResponseMetadataForRequest(request);
}
/**
* Normal invoke with authentication. Credentials are required and may be overriden at the request level.
**/
private