com.amazonaws.services.drs.AWSdrs Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-drs Show documentation
Show all versions of aws-java-sdk-drs Show documentation
The AWS Java SDK for Elastic Disaster Recovery module holds the client classes that are used for communicating with Elastic Disaster Recovery Service
/*
* Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.drs;
import javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.drs.model.*;
/**
* Interface for accessing drs.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.drs.AbstractAWSdrs} instead.
*
*
*
* AWS Elastic Disaster Recovery Service.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AWSdrs {
/**
* The region metadata service name for computing region endpoints. You can use this value to retrieve metadata
* (such as supported regions) of the service.
*
* @see RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "drs";
/**
*
* Associate a Source Network to an existing CloudFormation Stack and modify launch templates to use this network.
* Can be used for reverting to previously deployed CloudFormation stacks.
*
*
* @param associateSourceNetworkStackRequest
* @return Result of the AssociateSourceNetworkStack operation returned by the service.
* @throws ResourceNotFoundException
* The resource for this operation was not found.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception or failure.
* @throws ConflictException
* The request could not be completed due to a conflict with the current state of the target resource.
* @throws ServiceQuotaExceededException
* The request could not be completed because its exceeded the service quota.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ValidationException
* The input fails to satisfy the constraints specified by the AWS service.
* @throws UninitializedAccountException
* The account performing the request has not been initialized.
* @sample AWSdrs.AssociateSourceNetworkStack
* @see AWS API Documentation
*/
AssociateSourceNetworkStackResult associateSourceNetworkStack(AssociateSourceNetworkStackRequest associateSourceNetworkStackRequest);
/**
*
* Create an extended source server in the target Account based on the source server in staging account.
*
*
* @param createExtendedSourceServerRequest
* @return Result of the CreateExtendedSourceServer operation returned by the service.
* @throws ResourceNotFoundException
* The resource for this operation was not found.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception or failure.
* @throws ServiceQuotaExceededException
* The request could not be completed because its exceeded the service quota.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ValidationException
* The input fails to satisfy the constraints specified by the AWS service.
* @throws UninitializedAccountException
* The account performing the request has not been initialized.
* @sample AWSdrs.CreateExtendedSourceServer
* @see AWS
* API Documentation
*/
CreateExtendedSourceServerResult createExtendedSourceServer(CreateExtendedSourceServerRequest createExtendedSourceServerRequest);
/**
*
* Creates a new Launch Configuration Template.
*
*
* @param createLaunchConfigurationTemplateRequest
* @return Result of the CreateLaunchConfigurationTemplate operation returned by the service.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception or failure.
* @throws ServiceQuotaExceededException
* The request could not be completed because its exceeded the service quota.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ValidationException
* The input fails to satisfy the constraints specified by the AWS service.
* @throws UninitializedAccountException
* The account performing the request has not been initialized.
* @sample AWSdrs.CreateLaunchConfigurationTemplate
* @see AWS API Documentation
*/
CreateLaunchConfigurationTemplateResult createLaunchConfigurationTemplate(CreateLaunchConfigurationTemplateRequest createLaunchConfigurationTemplateRequest);
/**
*
* Creates a new ReplicationConfigurationTemplate.
*
*
* @param createReplicationConfigurationTemplateRequest
* @return Result of the CreateReplicationConfigurationTemplate operation returned by the service.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception or failure.
* @throws ServiceQuotaExceededException
* The request could not be completed because its exceeded the service quota.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ValidationException
* The input fails to satisfy the constraints specified by the AWS service.
* @throws UninitializedAccountException
* The account performing the request has not been initialized.
* @sample AWSdrs.CreateReplicationConfigurationTemplate
* @see AWS API Documentation
*/
CreateReplicationConfigurationTemplateResult createReplicationConfigurationTemplate(
CreateReplicationConfigurationTemplateRequest createReplicationConfigurationTemplateRequest);
/**
*
* Create a new Source Network resource for a provided VPC ID.
*
*
* @param createSourceNetworkRequest
* @return Result of the CreateSourceNetwork operation returned by the service.
* @throws ResourceNotFoundException
* The resource for this operation was not found.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception or failure.
* @throws ConflictException
* The request could not be completed due to a conflict with the current state of the target resource.
* @throws ServiceQuotaExceededException
* The request could not be completed because its exceeded the service quota.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ValidationException
* The input fails to satisfy the constraints specified by the AWS service.
* @throws UninitializedAccountException
* The account performing the request has not been initialized.
* @sample AWSdrs.CreateSourceNetwork
* @see AWS API
* Documentation
*/
CreateSourceNetworkResult createSourceNetwork(CreateSourceNetworkRequest createSourceNetworkRequest);
/**
*
* Deletes a single Job by ID.
*
*
* @param deleteJobRequest
* @return Result of the DeleteJob operation returned by the service.
* @throws ResourceNotFoundException
* The resource for this operation was not found.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception or failure.
* @throws ConflictException
* The request could not be completed due to a conflict with the current state of the target resource.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws UninitializedAccountException
* The account performing the request has not been initialized.
* @sample AWSdrs.DeleteJob
* @see AWS API
* Documentation
*/
DeleteJobResult deleteJob(DeleteJobRequest deleteJobRequest);
/**
*
* Deletes a resource launch action.
*
*
* @param deleteLaunchActionRequest
* @return Result of the DeleteLaunchAction operation returned by the service.
* @throws ResourceNotFoundException
* The resource for this operation was not found.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception or failure.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ValidationException
* The input fails to satisfy the constraints specified by the AWS service.
* @throws UninitializedAccountException
* The account performing the request has not been initialized.
* @sample AWSdrs.DeleteLaunchAction
* @see AWS API
* Documentation
*/
DeleteLaunchActionResult deleteLaunchAction(DeleteLaunchActionRequest deleteLaunchActionRequest);
/**
*
* Deletes a single Launch Configuration Template by ID.
*
*
* @param deleteLaunchConfigurationTemplateRequest
* @return Result of the DeleteLaunchConfigurationTemplate operation returned by the service.
* @throws ResourceNotFoundException
* The resource for this operation was not found.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception or failure.
* @throws ConflictException
* The request could not be completed due to a conflict with the current state of the target resource.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws UninitializedAccountException
* The account performing the request has not been initialized.
* @sample AWSdrs.DeleteLaunchConfigurationTemplate
* @see AWS API Documentation
*/
DeleteLaunchConfigurationTemplateResult deleteLaunchConfigurationTemplate(DeleteLaunchConfigurationTemplateRequest deleteLaunchConfigurationTemplateRequest);
/**
*
* Deletes a single Recovery Instance by ID. This deletes the Recovery Instance resource from Elastic Disaster
* Recovery. The Recovery Instance must be disconnected first in order to delete it.
*
*
* @param deleteRecoveryInstanceRequest
* @return Result of the DeleteRecoveryInstance operation returned by the service.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception or failure.
* @throws ConflictException
* The request could not be completed due to a conflict with the current state of the target resource.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws UninitializedAccountException
* The account performing the request has not been initialized.
* @sample AWSdrs.DeleteRecoveryInstance
* @see AWS API
* Documentation
*/
DeleteRecoveryInstanceResult deleteRecoveryInstance(DeleteRecoveryInstanceRequest deleteRecoveryInstanceRequest);
/**
*
* Deletes a single Replication Configuration Template by ID
*
*
* @param deleteReplicationConfigurationTemplateRequest
* @return Result of the DeleteReplicationConfigurationTemplate operation returned by the service.
* @throws ResourceNotFoundException
* The resource for this operation was not found.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception or failure.
* @throws ConflictException
* The request could not be completed due to a conflict with the current state of the target resource.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws UninitializedAccountException
* The account performing the request has not been initialized.
* @sample AWSdrs.DeleteReplicationConfigurationTemplate
* @see AWS API Documentation
*/
DeleteReplicationConfigurationTemplateResult deleteReplicationConfigurationTemplate(
DeleteReplicationConfigurationTemplateRequest deleteReplicationConfigurationTemplateRequest);
/**
*
* Delete Source Network resource.
*
*
* @param deleteSourceNetworkRequest
* @return Result of the DeleteSourceNetwork operation returned by the service.
* @throws ResourceNotFoundException
* The resource for this operation was not found.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception or failure.
* @throws ConflictException
* The request could not be completed due to a conflict with the current state of the target resource.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws UninitializedAccountException
* The account performing the request has not been initialized.
* @sample AWSdrs.DeleteSourceNetwork
* @see AWS API
* Documentation
*/
DeleteSourceNetworkResult deleteSourceNetwork(DeleteSourceNetworkRequest deleteSourceNetworkRequest);
/**
*
* Deletes a single Source Server by ID. The Source Server must be disconnected first.
*
*
* @param deleteSourceServerRequest
* @return Result of the DeleteSourceServer operation returned by the service.
* @throws ResourceNotFoundException
* The resource for this operation was not found.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception or failure.
* @throws ConflictException
* The request could not be completed due to a conflict with the current state of the target resource.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws UninitializedAccountException
* The account performing the request has not been initialized.
* @sample AWSdrs.DeleteSourceServer
* @see AWS API
* Documentation
*/
DeleteSourceServerResult deleteSourceServer(DeleteSourceServerRequest deleteSourceServerRequest);
/**
*
* Retrieves a detailed Job log with pagination.
*
*
* @param describeJobLogItemsRequest
* @return Result of the DescribeJobLogItems operation returned by the service.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception or failure.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ValidationException
* The input fails to satisfy the constraints specified by the AWS service.
* @throws UninitializedAccountException
* The account performing the request has not been initialized.
* @sample AWSdrs.DescribeJobLogItems
* @see AWS API
* Documentation
*/
DescribeJobLogItemsResult describeJobLogItems(DescribeJobLogItemsRequest describeJobLogItemsRequest);
/**
*
* Returns a list of Jobs. Use the JobsID and fromDate and toDate filters to limit which jobs are returned. The
* response is sorted by creationDataTime - latest date first. Jobs are created by the StartRecovery,
* TerminateRecoveryInstances and StartFailbackLaunch APIs. Jobs are also created by DiagnosticLaunch and
* TerminateDiagnosticInstances, which are APIs available only to *Support* and only used in response to relevant
* support tickets.
*
*
* @param describeJobsRequest
* @return Result of the DescribeJobs operation returned by the service.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception or failure.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ValidationException
* The input fails to satisfy the constraints specified by the AWS service.
* @throws UninitializedAccountException
* The account performing the request has not been initialized.
* @sample AWSdrs.DescribeJobs
* @see AWS API
* Documentation
*/
DescribeJobsResult describeJobs(DescribeJobsRequest describeJobsRequest);
/**
*
* Lists all Launch Configuration Templates, filtered by Launch Configuration Template IDs
*
*
* @param describeLaunchConfigurationTemplatesRequest
* @return Result of the DescribeLaunchConfigurationTemplates operation returned by the service.
* @throws ResourceNotFoundException
* The resource for this operation was not found.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception or failure.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ValidationException
* The input fails to satisfy the constraints specified by the AWS service.
* @throws UninitializedAccountException
* The account performing the request has not been initialized.
* @sample AWSdrs.DescribeLaunchConfigurationTemplates
* @see AWS API Documentation
*/
DescribeLaunchConfigurationTemplatesResult describeLaunchConfigurationTemplates(
DescribeLaunchConfigurationTemplatesRequest describeLaunchConfigurationTemplatesRequest);
/**
*
* Lists all Recovery Instances or multiple Recovery Instances by ID.
*
*
* @param describeRecoveryInstancesRequest
* @return Result of the DescribeRecoveryInstances operation returned by the service.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception or failure.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws UninitializedAccountException
* The account performing the request has not been initialized.
* @sample AWSdrs.DescribeRecoveryInstances
* @see AWS
* API Documentation
*/
DescribeRecoveryInstancesResult describeRecoveryInstances(DescribeRecoveryInstancesRequest describeRecoveryInstancesRequest);
/**
*
* Lists all Recovery Snapshots for a single Source Server.
*
*
* @param describeRecoverySnapshotsRequest
* @return Result of the DescribeRecoverySnapshots operation returned by the service.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception or failure.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ValidationException
* The input fails to satisfy the constraints specified by the AWS service.
* @throws UninitializedAccountException
* The account performing the request has not been initialized.
* @sample AWSdrs.DescribeRecoverySnapshots
* @see AWS
* API Documentation
*/
DescribeRecoverySnapshotsResult describeRecoverySnapshots(DescribeRecoverySnapshotsRequest describeRecoverySnapshotsRequest);
/**
*
* Lists all ReplicationConfigurationTemplates, filtered by Source Server IDs.
*
*
* @param describeReplicationConfigurationTemplatesRequest
* @return Result of the DescribeReplicationConfigurationTemplates operation returned by the service.
* @throws ResourceNotFoundException
* The resource for this operation was not found.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception or failure.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ValidationException
* The input fails to satisfy the constraints specified by the AWS service.
* @throws UninitializedAccountException
* The account performing the request has not been initialized.
* @sample AWSdrs.DescribeReplicationConfigurationTemplates
* @see AWS API Documentation
*/
DescribeReplicationConfigurationTemplatesResult describeReplicationConfigurationTemplates(
DescribeReplicationConfigurationTemplatesRequest describeReplicationConfigurationTemplatesRequest);
/**
*
* Lists all Source Networks or multiple Source Networks filtered by ID.
*
*
* @param describeSourceNetworksRequest
* @return Result of the DescribeSourceNetworks operation returned by the service.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception or failure.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ValidationException
* The input fails to satisfy the constraints specified by the AWS service.
* @throws UninitializedAccountException
* The account performing the request has not been initialized.
* @sample AWSdrs.DescribeSourceNetworks
* @see AWS API
* Documentation
*/
DescribeSourceNetworksResult describeSourceNetworks(DescribeSourceNetworksRequest describeSourceNetworksRequest);
/**
*
* Lists all Source Servers or multiple Source Servers filtered by ID.
*
*
* @param describeSourceServersRequest
* @return Result of the DescribeSourceServers operation returned by the service.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception or failure.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ValidationException
* The input fails to satisfy the constraints specified by the AWS service.
* @throws UninitializedAccountException
* The account performing the request has not been initialized.
* @sample AWSdrs.DescribeSourceServers
* @see AWS API
* Documentation
*/
DescribeSourceServersResult describeSourceServers(DescribeSourceServersRequest describeSourceServersRequest);
/**
*
* Disconnect a Recovery Instance from Elastic Disaster Recovery. Data replication is stopped immediately. All AWS
* resources created by Elastic Disaster Recovery for enabling the replication of the Recovery Instance will be
* terminated / deleted within 90 minutes. If the agent on the Recovery Instance has not been prevented from
* communicating with the Elastic Disaster Recovery service, then it will receive a command to uninstall itself
* (within approximately 10 minutes). The following properties of the Recovery Instance will be changed immediately:
* dataReplicationInfo.dataReplicationState will be set to DISCONNECTED; The totalStorageBytes property for each of
* dataReplicationInfo.replicatedDisks will be set to zero; dataReplicationInfo.lagDuration and
* dataReplicationInfo.lagDuration will be nullified.
*
*
* @param disconnectRecoveryInstanceRequest
* @return Result of the DisconnectRecoveryInstance operation returned by the service.
* @throws ResourceNotFoundException
* The resource for this operation was not found.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception or failure.
* @throws ConflictException
* The request could not be completed due to a conflict with the current state of the target resource.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws UninitializedAccountException
* The account performing the request has not been initialized.
* @sample AWSdrs.DisconnectRecoveryInstance
* @see AWS
* API Documentation
*/
DisconnectRecoveryInstanceResult disconnectRecoveryInstance(DisconnectRecoveryInstanceRequest disconnectRecoveryInstanceRequest);
/**
*
* Disconnects a specific Source Server from Elastic Disaster Recovery. Data replication is stopped immediately. All
* AWS resources created by Elastic Disaster Recovery for enabling the replication of the Source Server will be
* terminated / deleted within 90 minutes. You cannot disconnect a Source Server if it has a Recovery Instance. If
* the agent on the Source Server has not been prevented from communicating with the Elastic Disaster Recovery
* service, then it will receive a command to uninstall itself (within approximately 10 minutes). The following
* properties of the SourceServer will be changed immediately: dataReplicationInfo.dataReplicationState will be set
* to DISCONNECTED; The totalStorageBytes property for each of dataReplicationInfo.replicatedDisks will be set to
* zero; dataReplicationInfo.lagDuration and dataReplicationInfo.lagDuration will be nullified.
*
*
* @param disconnectSourceServerRequest
* @return Result of the DisconnectSourceServer operation returned by the service.
* @throws ResourceNotFoundException
* The resource for this operation was not found.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception or failure.
* @throws ConflictException
* The request could not be completed due to a conflict with the current state of the target resource.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws UninitializedAccountException
* The account performing the request has not been initialized.
* @sample AWSdrs.DisconnectSourceServer
* @see AWS API
* Documentation
*/
DisconnectSourceServerResult disconnectSourceServer(DisconnectSourceServerRequest disconnectSourceServerRequest);
/**
*
* Export the Source Network CloudFormation template to an S3 bucket.
*
*
* @param exportSourceNetworkCfnTemplateRequest
* @return Result of the ExportSourceNetworkCfnTemplate operation returned by the service.
* @throws ResourceNotFoundException
* The resource for this operation was not found.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception or failure.
* @throws ConflictException
* The request could not be completed due to a conflict with the current state of the target resource.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ValidationException
* The input fails to satisfy the constraints specified by the AWS service.
* @throws UninitializedAccountException
* The account performing the request has not been initialized.
* @sample AWSdrs.ExportSourceNetworkCfnTemplate
* @see AWS API Documentation
*/
ExportSourceNetworkCfnTemplateResult exportSourceNetworkCfnTemplate(ExportSourceNetworkCfnTemplateRequest exportSourceNetworkCfnTemplateRequest);
/**
*
* Lists all Failback ReplicationConfigurations, filtered by Recovery Instance ID.
*
*
* @param getFailbackReplicationConfigurationRequest
* @return Result of the GetFailbackReplicationConfiguration operation returned by the service.
* @throws ResourceNotFoundException
* The resource for this operation was not found.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception or failure.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws UninitializedAccountException
* The account performing the request has not been initialized.
* @sample AWSdrs.GetFailbackReplicationConfiguration
* @see AWS API Documentation
*/
GetFailbackReplicationConfigurationResult getFailbackReplicationConfiguration(
GetFailbackReplicationConfigurationRequest getFailbackReplicationConfigurationRequest);
/**
*
* Gets a LaunchConfiguration, filtered by Source Server IDs.
*
*
* @param getLaunchConfigurationRequest
* @return Result of the GetLaunchConfiguration operation returned by the service.
* @throws ResourceNotFoundException
* The resource for this operation was not found.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception or failure.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws UninitializedAccountException
* The account performing the request has not been initialized.
* @sample AWSdrs.GetLaunchConfiguration
* @see AWS API
* Documentation
*/
GetLaunchConfigurationResult getLaunchConfiguration(GetLaunchConfigurationRequest getLaunchConfigurationRequest);
/**
*
* Gets a ReplicationConfiguration, filtered by Source Server ID.
*
*
* @param getReplicationConfigurationRequest
* @return Result of the GetReplicationConfiguration operation returned by the service.
* @throws ResourceNotFoundException
* The resource for this operation was not found.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception or failure.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws UninitializedAccountException
* The account performing the request has not been initialized.
* @sample AWSdrs.GetReplicationConfiguration
* @see AWS API Documentation
*/
GetReplicationConfigurationResult getReplicationConfiguration(GetReplicationConfigurationRequest getReplicationConfigurationRequest);
/**
*
* Initialize Elastic Disaster Recovery.
*
*
* @param initializeServiceRequest
* @return Result of the InitializeService operation returned by the service.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception or failure.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ValidationException
* The input fails to satisfy the constraints specified by the AWS service.
* @sample AWSdrs.InitializeService
* @see AWS API
* Documentation
*/
InitializeServiceResult initializeService(InitializeServiceRequest initializeServiceRequest);
/**
*
* Returns a list of source servers on a staging account that are extensible, which means that: a. The source server
* is not already extended into this Account. b. The source server on the Account we’re reading from is not an
* extension of another source server.
*
*
* @param listExtensibleSourceServersRequest
* @return Result of the ListExtensibleSourceServers operation returned by the service.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception or failure.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ValidationException
* The input fails to satisfy the constraints specified by the AWS service.
* @throws UninitializedAccountException
* The account performing the request has not been initialized.
* @sample AWSdrs.ListExtensibleSourceServers
* @see AWS API Documentation
*/
ListExtensibleSourceServersResult listExtensibleSourceServers(ListExtensibleSourceServersRequest listExtensibleSourceServersRequest);
/**
*
* Lists resource launch actions.
*
*
* @param listLaunchActionsRequest
* @return Result of the ListLaunchActions operation returned by the service.
* @throws ResourceNotFoundException
* The resource for this operation was not found.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception or failure.
* @throws ServiceQuotaExceededException
* The request could not be completed because its exceeded the service quota.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws UninitializedAccountException
* The account performing the request has not been initialized.
* @sample AWSdrs.ListLaunchActions
* @see AWS API
* Documentation
*/
ListLaunchActionsResult listLaunchActions(ListLaunchActionsRequest listLaunchActionsRequest);
/**
*
* Returns an array of staging accounts for existing extended source servers.
*
*
* @param listStagingAccountsRequest
* @return Result of the ListStagingAccounts operation returned by the service.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception or failure.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ValidationException
* The input fails to satisfy the constraints specified by the AWS service.
* @throws UninitializedAccountException
* The account performing the request has not been initialized.
* @sample AWSdrs.ListStagingAccounts
* @see AWS API
* Documentation
*/
ListStagingAccountsResult listStagingAccounts(ListStagingAccountsRequest listStagingAccountsRequest);
/**
*
* List all tags for your Elastic Disaster Recovery resources.
*
*
* @param listTagsForResourceRequest
* @return Result of the ListTagsForResource operation returned by the service.
* @throws ResourceNotFoundException
* The resource for this operation was not found.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception or failure.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ValidationException
* The input fails to satisfy the constraints specified by the AWS service.
* @sample AWSdrs.ListTagsForResource
* @see AWS API
* Documentation
*/
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* Puts a resource launch action.
*
*
* @param putLaunchActionRequest
* @return Result of the PutLaunchAction operation returned by the service.
* @throws ResourceNotFoundException
* The resource for this operation was not found.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception or failure.
* @throws ConflictException
* The request could not be completed due to a conflict with the current state of the target resource.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ValidationException
* The input fails to satisfy the constraints specified by the AWS service.
* @throws UninitializedAccountException
* The account performing the request has not been initialized.
* @sample AWSdrs.PutLaunchAction
* @see AWS API
* Documentation
*/
PutLaunchActionResult putLaunchAction(PutLaunchActionRequest putLaunchActionRequest);
/**
*
* WARNING: RetryDataReplication is deprecated. Causes the data replication initiation sequence to begin immediately
* upon next Handshake for the specified Source Server ID, regardless of when the previous initiation started. This
* command will work only if the Source Server is stalled or is in a DISCONNECTED or STOPPED state.
*
*
* @param retryDataReplicationRequest
* @return Result of the RetryDataReplication operation returned by the service.
* @throws ResourceNotFoundException
* The resource for this operation was not found.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception or failure.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ValidationException
* The input fails to satisfy the constraints specified by the AWS service.
* @throws UninitializedAccountException
* The account performing the request has not been initialized.
* @sample AWSdrs.RetryDataReplication
* @see AWS API
* Documentation
*/
@Deprecated
RetryDataReplicationResult retryDataReplication(RetryDataReplicationRequest retryDataReplicationRequest);
/**
*
* Start replication to origin / target region - applies only to protected instances that originated in EC2. For
* recovery instances on target region - starts replication back to origin region. For failback instances on origin
* region - starts replication to target region to re-protect them.
*
*
* @param reverseReplicationRequest
* @return Result of the ReverseReplication operation returned by the service.
* @throws ResourceNotFoundException
* The resource for this operation was not found.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception or failure.
* @throws ConflictException
* The request could not be completed due to a conflict with the current state of the target resource.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ValidationException
* The input fails to satisfy the constraints specified by the AWS service.
* @throws UninitializedAccountException
* The account performing the request has not been initialized.
* @sample AWSdrs.ReverseReplication
* @see AWS API
* Documentation
*/
ReverseReplicationResult reverseReplication(ReverseReplicationRequest reverseReplicationRequest);
/**
*
* Initiates a Job for launching the machine that is being failed back to from the specified Recovery Instance. This
* will run conversion on the failback client and will reboot your machine, thus completing the failback process.
*
*
* @param startFailbackLaunchRequest
* @return Result of the StartFailbackLaunch operation returned by the service.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception or failure.
* @throws ConflictException
* The request could not be completed due to a conflict with the current state of the target resource.
* @throws ServiceQuotaExceededException
* The request could not be completed because its exceeded the service quota.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ValidationException
* The input fails to satisfy the constraints specified by the AWS service.
* @throws UninitializedAccountException
* The account performing the request has not been initialized.
* @sample AWSdrs.StartFailbackLaunch
* @see AWS API
* Documentation
*/
StartFailbackLaunchResult startFailbackLaunch(StartFailbackLaunchRequest startFailbackLaunchRequest);
/**
*
* Launches Recovery Instances for the specified Source Servers. For each Source Server you may choose a point in
* time snapshot to launch from, or use an on demand snapshot.
*
*
* @param startRecoveryRequest
* @return Result of the StartRecovery operation returned by the service.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception or failure.
* @throws ConflictException
* The request could not be completed due to a conflict with the current state of the target resource.
* @throws ServiceQuotaExceededException
* The request could not be completed because its exceeded the service quota.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws UninitializedAccountException
* The account performing the request has not been initialized.
* @sample AWSdrs.StartRecovery
* @see AWS API
* Documentation
*/
StartRecoveryResult startRecovery(StartRecoveryRequest startRecoveryRequest);
/**
*
* Starts replication for a stopped Source Server. This action would make the Source Server protected again and
* restart billing for it.
*
*
* @param startReplicationRequest
* @return Result of the StartReplication operation returned by the service.
* @throws ResourceNotFoundException
* The resource for this operation was not found.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception or failure.
* @throws ConflictException
* The request could not be completed due to a conflict with the current state of the target resource.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws UninitializedAccountException
* The account performing the request has not been initialized.
* @sample AWSdrs.StartReplication
* @see AWS API
* Documentation
*/
StartReplicationResult startReplication(StartReplicationRequest startReplicationRequest);
/**
*
* Deploy VPC for the specified Source Network and modify launch templates to use this network. The VPC will be
* deployed using a dedicated CloudFormation stack.
*
*
* @param startSourceNetworkRecoveryRequest
* @return Result of the StartSourceNetworkRecovery operation returned by the service.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception or failure.
* @throws ConflictException
* The request could not be completed due to a conflict with the current state of the target resource.
* @throws ServiceQuotaExceededException
* The request could not be completed because its exceeded the service quota.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ValidationException
* The input fails to satisfy the constraints specified by the AWS service.
* @throws UninitializedAccountException
* The account performing the request has not been initialized.
* @sample AWSdrs.StartSourceNetworkRecovery
* @see AWS
* API Documentation
*/
StartSourceNetworkRecoveryResult startSourceNetworkRecovery(StartSourceNetworkRecoveryRequest startSourceNetworkRecoveryRequest);
/**
*
* Starts replication for a Source Network. This action would make the Source Network protected.
*
*
* @param startSourceNetworkReplicationRequest
* @return Result of the StartSourceNetworkReplication operation returned by the service.
* @throws ResourceNotFoundException
* The resource for this operation was not found.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception or failure.
* @throws ConflictException
* The request could not be completed due to a conflict with the current state of the target resource.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws UninitializedAccountException
* The account performing the request has not been initialized.
* @sample AWSdrs.StartSourceNetworkReplication
* @see AWS API Documentation
*/
StartSourceNetworkReplicationResult startSourceNetworkReplication(StartSourceNetworkReplicationRequest startSourceNetworkReplicationRequest);
/**
*
* Stops the failback process for a specified Recovery Instance. This changes the Failback State of the Recovery
* Instance back to FAILBACK_NOT_STARTED.
*
*
* @param stopFailbackRequest
* @return Result of the StopFailback operation returned by the service.
* @throws ResourceNotFoundException
* The resource for this operation was not found.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception or failure.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws UninitializedAccountException
* The account performing the request has not been initialized.
* @sample AWSdrs.StopFailback
* @see AWS API
* Documentation
*/
StopFailbackResult stopFailback(StopFailbackRequest stopFailbackRequest);
/**
*
* Stops replication for a Source Server. This action would make the Source Server unprotected, delete its existing
* snapshots and stop billing for it.
*
*
* @param stopReplicationRequest
* @return Result of the StopReplication operation returned by the service.
* @throws ResourceNotFoundException
* The resource for this operation was not found.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception or failure.
* @throws ConflictException
* The request could not be completed due to a conflict with the current state of the target resource.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws UninitializedAccountException
* The account performing the request has not been initialized.
* @sample AWSdrs.StopReplication
* @see AWS API
* Documentation
*/
StopReplicationResult stopReplication(StopReplicationRequest stopReplicationRequest);
/**
*
* Stops replication for a Source Network. This action would make the Source Network unprotected.
*
*
* @param stopSourceNetworkReplicationRequest
* @return Result of the StopSourceNetworkReplication operation returned by the service.
* @throws ResourceNotFoundException
* The resource for this operation was not found.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception or failure.
* @throws ConflictException
* The request could not be completed due to a conflict with the current state of the target resource.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ValidationException
* The input fails to satisfy the constraints specified by the AWS service.
* @throws UninitializedAccountException
* The account performing the request has not been initialized.
* @sample AWSdrs.StopSourceNetworkReplication
* @see AWS API Documentation
*/
StopSourceNetworkReplicationResult stopSourceNetworkReplication(StopSourceNetworkReplicationRequest stopSourceNetworkReplicationRequest);
/**
*
* Adds or overwrites only the specified tags for the specified Elastic Disaster Recovery resource or resources.
* When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a
* maximum of 50 tags. Each tag consists of a key and optional value.
*
*
* @param tagResourceRequest
* @return Result of the TagResource operation returned by the service.
* @throws ResourceNotFoundException
* The resource for this operation was not found.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception or failure.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ValidationException
* The input fails to satisfy the constraints specified by the AWS service.
* @sample AWSdrs.TagResource
* @see AWS API
* Documentation
*/
TagResourceResult tagResource(TagResourceRequest tagResourceRequest);
/**
*
* Initiates a Job for terminating the EC2 resources associated with the specified Recovery Instances, and then will
* delete the Recovery Instances from the Elastic Disaster Recovery service.
*
*
* @param terminateRecoveryInstancesRequest
* @return Result of the TerminateRecoveryInstances operation returned by the service.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception or failure.
* @throws ConflictException
* The request could not be completed due to a conflict with the current state of the target resource.
* @throws ServiceQuotaExceededException
* The request could not be completed because its exceeded the service quota.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws UninitializedAccountException
* The account performing the request has not been initialized.
* @sample AWSdrs.TerminateRecoveryInstances
* @see AWS
* API Documentation
*/
TerminateRecoveryInstancesResult terminateRecoveryInstances(TerminateRecoveryInstancesRequest terminateRecoveryInstancesRequest);
/**
*
* Deletes the specified set of tags from the specified set of Elastic Disaster Recovery resources.
*
*
* @param untagResourceRequest
* @return Result of the UntagResource operation returned by the service.
* @throws ResourceNotFoundException
* The resource for this operation was not found.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception or failure.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ValidationException
* The input fails to satisfy the constraints specified by the AWS service.
* @sample AWSdrs.UntagResource
* @see AWS API
* Documentation
*/
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest);
/**
*
* Allows you to update the failback replication configuration of a Recovery Instance by ID.
*
*
* @param updateFailbackReplicationConfigurationRequest
* @return Result of the UpdateFailbackReplicationConfiguration operation returned by the service.
* @throws ResourceNotFoundException
* The resource for this operation was not found.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception or failure.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws UninitializedAccountException
* The account performing the request has not been initialized.
* @sample AWSdrs.UpdateFailbackReplicationConfiguration
* @see AWS API Documentation
*/
UpdateFailbackReplicationConfigurationResult updateFailbackReplicationConfiguration(
UpdateFailbackReplicationConfigurationRequest updateFailbackReplicationConfigurationRequest);
/**
*
* Updates a LaunchConfiguration by Source Server ID.
*
*
* @param updateLaunchConfigurationRequest
* @return Result of the UpdateLaunchConfiguration operation returned by the service.
* @throws ResourceNotFoundException
* The resource for this operation was not found.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception or failure.
* @throws ConflictException
* The request could not be completed due to a conflict with the current state of the target resource.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ValidationException
* The input fails to satisfy the constraints specified by the AWS service.
* @throws UninitializedAccountException
* The account performing the request has not been initialized.
* @sample AWSdrs.UpdateLaunchConfiguration
* @see AWS
* API Documentation
*/
UpdateLaunchConfigurationResult updateLaunchConfiguration(UpdateLaunchConfigurationRequest updateLaunchConfigurationRequest);
/**
*
* Updates an existing Launch Configuration Template by ID.
*
*
* @param updateLaunchConfigurationTemplateRequest
* @return Result of the UpdateLaunchConfigurationTemplate operation returned by the service.
* @throws ResourceNotFoundException
* The resource for this operation was not found.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception or failure.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ValidationException
* The input fails to satisfy the constraints specified by the AWS service.
* @throws UninitializedAccountException
* The account performing the request has not been initialized.
* @sample AWSdrs.UpdateLaunchConfigurationTemplate
* @see AWS API Documentation
*/
UpdateLaunchConfigurationTemplateResult updateLaunchConfigurationTemplate(UpdateLaunchConfigurationTemplateRequest updateLaunchConfigurationTemplateRequest);
/**
*
* Allows you to update a ReplicationConfiguration by Source Server ID.
*
*
* @param updateReplicationConfigurationRequest
* @return Result of the UpdateReplicationConfiguration operation returned by the service.
* @throws ResourceNotFoundException
* The resource for this operation was not found.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception or failure.
* @throws ConflictException
* The request could not be completed due to a conflict with the current state of the target resource.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ValidationException
* The input fails to satisfy the constraints specified by the AWS service.
* @throws UninitializedAccountException
* The account performing the request has not been initialized.
* @sample AWSdrs.UpdateReplicationConfiguration
* @see AWS API Documentation
*/
UpdateReplicationConfigurationResult updateReplicationConfiguration(UpdateReplicationConfigurationRequest updateReplicationConfigurationRequest);
/**
*
* Updates a ReplicationConfigurationTemplate by ID.
*
*
* @param updateReplicationConfigurationTemplateRequest
* @return Result of the UpdateReplicationConfigurationTemplate operation returned by the service.
* @throws ResourceNotFoundException
* The resource for this operation was not found.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception or failure.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ValidationException
* The input fails to satisfy the constraints specified by the AWS service.
* @throws UninitializedAccountException
* The account performing the request has not been initialized.
* @sample AWSdrs.UpdateReplicationConfigurationTemplate
* @see AWS API Documentation
*/
UpdateReplicationConfigurationTemplateResult updateReplicationConfigurationTemplate(
UpdateReplicationConfigurationTemplateRequest updateReplicationConfigurationTemplateRequest);
/**
* Shuts down this client object, releasing any resources that might be held open. This is an optional method, and
* callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client
* has been shutdown, it should not be used to make any more requests.
*/
void shutdown();
/**
* Returns additional metadata for a previously executed successful request, typically used for debugging issues
* where a service isn't acting as expected. This data isn't considered part of the result data returned by an
* operation, so it's available through this separate, diagnostic interface.
*
* 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 a request.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}