drsClient
Auto-generated documentation for drs type annotations stubs module mypy-boto3-drs.
drsClient
Type annotations and code completion for boto3.client("drs")
.
boto3 documentation
from boto3.session import Session
from mypy_boto3_drs.client import drsClient
def get_drs_client() -> drsClient:
return Session().client("drs")
Exceptions
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("drs").exceptions
structure.
client = boto3.client("drs")
try:
do_something(client)
except (
client.AccessDeniedException,
client.ClientError,
client.ConflictException,
client.InternalServerException,
client.ResourceNotFoundException,
client.ServiceQuotaExceededException,
client.ThrottlingException,
client.UninitializedAccountException,
client.ValidationException,
) as e:
print(e)
from mypy_boto3_drs.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
...
Methods
can_paginate
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("drs").can_paginate
method.
boto3 documentation
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("drs").close
method.
boto3 documentation
create_extended_source_server
Create an extended source server in the target Account based on the source server in staging account.
Type annotations and code completion for boto3.client("drs").create_extended_source_server
method.
boto3 documentation
def create_extended_source_server(
self,
*,
sourceServerArn: str,
tags: Mapping[str, str] = ...,
) -> CreateExtendedSourceServerResponseTypeDef: # (1)
...
kwargs: CreateExtendedSourceServerRequestRequestTypeDef = { # (1)
"sourceServerArn": ...,
}
parent.create_extended_source_server(**kwargs)
create_replication_configuration_template
Creates a new ReplicationConfigurationTemplate.
Type annotations and code completion for boto3.client("drs").create_replication_configuration_template
method.
boto3 documentation
def create_replication_configuration_template(
self,
*,
associateDefaultSecurityGroup: bool,
bandwidthThrottling: int,
createPublicIP: bool,
dataPlaneRouting: ReplicationConfigurationDataPlaneRoutingType, # (1)
defaultLargeStagingDiskType: ReplicationConfigurationDefaultLargeStagingDiskTypeType, # (2)
ebsEncryption: ReplicationConfigurationEbsEncryptionType, # (3)
pitPolicy: Sequence[PITPolicyRuleTypeDef], # (4)
replicationServerInstanceType: str,
replicationServersSecurityGroupsIDs: Sequence[str],
stagingAreaSubnetId: str,
stagingAreaTags: Mapping[str, str],
useDedicatedReplicationServer: bool,
ebsEncryptionKeyArn: str = ...,
tags: Mapping[str, str] = ...,
) -> ReplicationConfigurationTemplateResponseMetadataTypeDef: # (5)
...
- See ReplicationConfigurationDataPlaneRoutingType
- See ReplicationConfigurationDefaultLargeStagingDiskTypeType
- See ReplicationConfigurationEbsEncryptionType
- See PITPolicyRuleTypeDef
- See ReplicationConfigurationTemplateResponseMetadataTypeDef
kwargs: CreateReplicationConfigurationTemplateRequestRequestTypeDef = { # (1)
"associateDefaultSecurityGroup": ...,
"bandwidthThrottling": ...,
"createPublicIP": ...,
"dataPlaneRouting": ...,
"defaultLargeStagingDiskType": ...,
"ebsEncryption": ...,
"pitPolicy": ...,
"replicationServerInstanceType": ...,
"replicationServersSecurityGroupsIDs": ...,
"stagingAreaSubnetId": ...,
"stagingAreaTags": ...,
"useDedicatedReplicationServer": ...,
}
parent.create_replication_configuration_template(**kwargs)
delete_job
Deletes a single Job by ID.
Type annotations and code completion for boto3.client("drs").delete_job
method.
boto3 documentation
kwargs: DeleteJobRequestRequestTypeDef = { # (1)
"jobID": ...,
}
parent.delete_job(**kwargs)
delete_recovery_instance
Deletes a single Recovery Instance by ID.
Type annotations and code completion for boto3.client("drs").delete_recovery_instance
method.
boto3 documentation
def delete_recovery_instance(
self,
*,
recoveryInstanceID: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteRecoveryInstanceRequestRequestTypeDef = { # (1)
"recoveryInstanceID": ...,
}
parent.delete_recovery_instance(**kwargs)
delete_replication_configuration_template
Deletes a single Replication Configuration Template by ID See also: AWS API Documentation.
Type annotations and code completion for boto3.client("drs").delete_replication_configuration_template
method.
boto3 documentation
def delete_replication_configuration_template(
self,
*,
replicationConfigurationTemplateID: str,
) -> Dict[str, Any]:
...
kwargs: DeleteReplicationConfigurationTemplateRequestRequestTypeDef = { # (1)
"replicationConfigurationTemplateID": ...,
}
parent.delete_replication_configuration_template(**kwargs)
delete_source_server
Deletes a single Source Server by ID.
Type annotations and code completion for boto3.client("drs").delete_source_server
method.
boto3 documentation
kwargs: DeleteSourceServerRequestRequestTypeDef = { # (1)
"sourceServerID": ...,
}
parent.delete_source_server(**kwargs)
describe_job_log_items
Retrieves a detailed Job log with pagination.
Type annotations and code completion for boto3.client("drs").describe_job_log_items
method.
boto3 documentation
def describe_job_log_items(
self,
*,
jobID: str,
maxResults: int = ...,
nextToken: str = ...,
) -> DescribeJobLogItemsResponseTypeDef: # (1)
...
kwargs: DescribeJobLogItemsRequestRequestTypeDef = { # (1)
"jobID": ...,
}
parent.describe_job_log_items(**kwargs)
describe_jobs
Returns a list of Jobs.
Type annotations and code completion for boto3.client("drs").describe_jobs
method.
boto3 documentation
def describe_jobs(
self,
*,
filters: DescribeJobsRequestFiltersTypeDef = ..., # (1)
maxResults: int = ...,
nextToken: str = ...,
) -> DescribeJobsResponseTypeDef: # (2)
...
kwargs: DescribeJobsRequestRequestTypeDef = { # (1)
"filters": ...,
}
parent.describe_jobs(**kwargs)
describe_recovery_instances
Lists all Recovery Instances or multiple Recovery Instances by ID.
Type annotations and code completion for boto3.client("drs").describe_recovery_instances
method.
boto3 documentation
def describe_recovery_instances(
self,
*,
filters: DescribeRecoveryInstancesRequestFiltersTypeDef = ..., # (1)
maxResults: int = ...,
nextToken: str = ...,
) -> DescribeRecoveryInstancesResponseTypeDef: # (2)
...
kwargs: DescribeRecoveryInstancesRequestRequestTypeDef = { # (1)
"filters": ...,
}
parent.describe_recovery_instances(**kwargs)
describe_recovery_snapshots
Lists all Recovery Snapshots for a single Source Server.
Type annotations and code completion for boto3.client("drs").describe_recovery_snapshots
method.
boto3 documentation
def describe_recovery_snapshots(
self,
*,
sourceServerID: str,
filters: DescribeRecoverySnapshotsRequestFiltersTypeDef = ..., # (1)
maxResults: int = ...,
nextToken: str = ...,
order: RecoverySnapshotsOrderType = ..., # (2)
) -> DescribeRecoverySnapshotsResponseTypeDef: # (3)
...
- See DescribeRecoverySnapshotsRequestFiltersTypeDef
- See RecoverySnapshotsOrderType
- See DescribeRecoverySnapshotsResponseTypeDef
kwargs: DescribeRecoverySnapshotsRequestRequestTypeDef = { # (1)
"sourceServerID": ...,
}
parent.describe_recovery_snapshots(**kwargs)
describe_replication_configuration_templates
Lists all ReplicationConfigurationTemplates, filtered by Source Server IDs.
Type annotations and code completion for boto3.client("drs").describe_replication_configuration_templates
method.
boto3 documentation
def describe_replication_configuration_templates(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
replicationConfigurationTemplateIDs: Sequence[str] = ...,
) -> DescribeReplicationConfigurationTemplatesResponseTypeDef: # (1)
...
kwargs: DescribeReplicationConfigurationTemplatesRequestRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.describe_replication_configuration_templates(**kwargs)
describe_source_servers
Lists all Source Servers or multiple Source Servers filtered by ID.
Type annotations and code completion for boto3.client("drs").describe_source_servers
method.
boto3 documentation
def describe_source_servers(
self,
*,
filters: DescribeSourceServersRequestFiltersTypeDef = ..., # (1)
maxResults: int = ...,
nextToken: str = ...,
) -> DescribeSourceServersResponseTypeDef: # (2)
...
kwargs: DescribeSourceServersRequestRequestTypeDef = { # (1)
"filters": ...,
}
parent.describe_source_servers(**kwargs)
disconnect_recovery_instance
Disconnect a Recovery Instance from Elastic Disaster Recovery.
Type annotations and code completion for boto3.client("drs").disconnect_recovery_instance
method.
boto3 documentation
def disconnect_recovery_instance(
self,
*,
recoveryInstanceID: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DisconnectRecoveryInstanceRequestRequestTypeDef = { # (1)
"recoveryInstanceID": ...,
}
parent.disconnect_recovery_instance(**kwargs)
disconnect_source_server
Disconnects a specific Source Server from Elastic Disaster Recovery.
Type annotations and code completion for boto3.client("drs").disconnect_source_server
method.
boto3 documentation
def disconnect_source_server(
self,
*,
sourceServerID: str,
) -> SourceServerResponseMetadataTypeDef: # (1)
...
kwargs: DisconnectSourceServerRequestRequestTypeDef = { # (1)
"sourceServerID": ...,
}
parent.disconnect_source_server(**kwargs)
generate_presigned_url
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("drs").generate_presigned_url
method.
boto3 documentation
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
get_failback_replication_configuration
Lists all Failback ReplicationConfigurations, filtered by Recovery Instance ID.
Type annotations and code completion for boto3.client("drs").get_failback_replication_configuration
method.
boto3 documentation
def get_failback_replication_configuration(
self,
*,
recoveryInstanceID: str,
) -> GetFailbackReplicationConfigurationResponseTypeDef: # (1)
...
kwargs: GetFailbackReplicationConfigurationRequestRequestTypeDef = { # (1)
"recoveryInstanceID": ...,
}
parent.get_failback_replication_configuration(**kwargs)
get_launch_configuration
Gets a LaunchConfiguration, filtered by Source Server IDs.
Type annotations and code completion for boto3.client("drs").get_launch_configuration
method.
boto3 documentation
def get_launch_configuration(
self,
*,
sourceServerID: str,
) -> LaunchConfigurationTypeDef: # (1)
...
kwargs: GetLaunchConfigurationRequestRequestTypeDef = { # (1)
"sourceServerID": ...,
}
parent.get_launch_configuration(**kwargs)
get_replication_configuration
Gets a ReplicationConfiguration, filtered by Source Server ID.
Type annotations and code completion for boto3.client("drs").get_replication_configuration
method.
boto3 documentation
def get_replication_configuration(
self,
*,
sourceServerID: str,
) -> ReplicationConfigurationTypeDef: # (1)
...
kwargs: GetReplicationConfigurationRequestRequestTypeDef = { # (1)
"sourceServerID": ...,
}
parent.get_replication_configuration(**kwargs)
initialize_service
Initialize Elastic Disaster Recovery.
Type annotations and code completion for boto3.client("drs").initialize_service
method.
boto3 documentation
list_extensible_source_servers
Returns a list of source servers on a staging account that are extensible, which means that: a.
Type annotations and code completion for boto3.client("drs").list_extensible_source_servers
method.
boto3 documentation
def list_extensible_source_servers(
self,
*,
stagingAccountID: str,
maxResults: int = ...,
nextToken: str = ...,
) -> ListExtensibleSourceServersResponseTypeDef: # (1)
...
kwargs: ListExtensibleSourceServersRequestRequestTypeDef = { # (1)
"stagingAccountID": ...,
}
parent.list_extensible_source_servers(**kwargs)
list_staging_accounts
Returns an array of staging accounts for existing extended source servers.
Type annotations and code completion for boto3.client("drs").list_staging_accounts
method.
boto3 documentation
def list_staging_accounts(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
) -> ListStagingAccountsResponseTypeDef: # (1)
...
kwargs: ListStagingAccountsRequestRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_staging_accounts(**kwargs)
list_tags_for_resource
List all tags for your Elastic Disaster Recovery resources.
Type annotations and code completion for boto3.client("drs").list_tags_for_resource
method.
boto3 documentation
def list_tags_for_resource(
self,
*,
resourceArn: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
retry_data_replication
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.
Type annotations and code completion for boto3.client("drs").retry_data_replication
method.
boto3 documentation
def retry_data_replication(
self,
*,
sourceServerID: str,
) -> SourceServerResponseMetadataTypeDef: # (1)
...
kwargs: RetryDataReplicationRequestRequestTypeDef = { # (1)
"sourceServerID": ...,
}
parent.retry_data_replication(**kwargs)
reverse_replication
Start replication to origin / target region - applies only to protected instances that originated in EC2.
Type annotations and code completion for boto3.client("drs").reverse_replication
method.
boto3 documentation
def reverse_replication(
self,
*,
recoveryInstanceID: str,
) -> ReverseReplicationResponseTypeDef: # (1)
...
kwargs: ReverseReplicationRequestRequestTypeDef = { # (1)
"recoveryInstanceID": ...,
}
parent.reverse_replication(**kwargs)
start_failback_launch
Initiates a Job for launching the machine that is being failed back to from the specified Recovery Instance.
Type annotations and code completion for boto3.client("drs").start_failback_launch
method.
boto3 documentation
def start_failback_launch(
self,
*,
recoveryInstanceIDs: Sequence[str],
tags: Mapping[str, str] = ...,
) -> StartFailbackLaunchResponseTypeDef: # (1)
...
kwargs: StartFailbackLaunchRequestRequestTypeDef = { # (1)
"recoveryInstanceIDs": ...,
}
parent.start_failback_launch(**kwargs)
start_recovery
Launches Recovery Instances for the specified Source Servers.
Type annotations and code completion for boto3.client("drs").start_recovery
method.
boto3 documentation
def start_recovery(
self,
*,
sourceServers: Sequence[StartRecoveryRequestSourceServerTypeDef], # (1)
isDrill: bool = ...,
tags: Mapping[str, str] = ...,
) -> StartRecoveryResponseTypeDef: # (2)
...
kwargs: StartRecoveryRequestRequestTypeDef = { # (1)
"sourceServers": ...,
}
parent.start_recovery(**kwargs)
start_replication
Starts replication for a stopped Source Server.
Type annotations and code completion for boto3.client("drs").start_replication
method.
boto3 documentation
def start_replication(
self,
*,
sourceServerID: str,
) -> StartReplicationResponseTypeDef: # (1)
...
kwargs: StartReplicationRequestRequestTypeDef = { # (1)
"sourceServerID": ...,
}
parent.start_replication(**kwargs)
stop_failback
Stops the failback process for a specified Recovery Instance.
Type annotations and code completion for boto3.client("drs").stop_failback
method.
boto3 documentation
def stop_failback(
self,
*,
recoveryInstanceID: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: StopFailbackRequestRequestTypeDef = { # (1)
"recoveryInstanceID": ...,
}
parent.stop_failback(**kwargs)
stop_replication
Stops replication for a Source Server.
Type annotations and code completion for boto3.client("drs").stop_replication
method.
boto3 documentation
def stop_replication(
self,
*,
sourceServerID: str,
) -> StopReplicationResponseTypeDef: # (1)
...
kwargs: StopReplicationRequestRequestTypeDef = { # (1)
"sourceServerID": ...,
}
parent.stop_replication(**kwargs)
tag_resource
Adds or overwrites only the specified tags for the specified Elastic Disaster Recovery resource or resources.
Type annotations and code completion for boto3.client("drs").tag_resource
method.
boto3 documentation
def tag_resource(
self,
*,
resourceArn: str,
tags: Mapping[str, str],
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"tags": ...,
}
parent.tag_resource(**kwargs)
terminate_recovery_instances
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.
Type annotations and code completion for boto3.client("drs").terminate_recovery_instances
method.
boto3 documentation
def terminate_recovery_instances(
self,
*,
recoveryInstanceIDs: Sequence[str],
) -> TerminateRecoveryInstancesResponseTypeDef: # (1)
...
kwargs: TerminateRecoveryInstancesRequestRequestTypeDef = { # (1)
"recoveryInstanceIDs": ...,
}
parent.terminate_recovery_instances(**kwargs)
untag_resource
Deletes the specified set of tags from the specified set of Elastic Disaster Recovery resources.
Type annotations and code completion for boto3.client("drs").untag_resource
method.
boto3 documentation
def untag_resource(
self,
*,
resourceArn: str,
tagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"tagKeys": ...,
}
parent.untag_resource(**kwargs)
update_failback_replication_configuration
Allows you to update the failback replication configuration of a Recovery Instance by ID.
Type annotations and code completion for boto3.client("drs").update_failback_replication_configuration
method.
boto3 documentation
def update_failback_replication_configuration(
self,
*,
recoveryInstanceID: str,
bandwidthThrottling: int = ...,
name: str = ...,
usePrivateIP: bool = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: UpdateFailbackReplicationConfigurationRequestRequestTypeDef = { # (1)
"recoveryInstanceID": ...,
}
parent.update_failback_replication_configuration(**kwargs)
update_launch_configuration
Updates a LaunchConfiguration by Source Server ID.
Type annotations and code completion for boto3.client("drs").update_launch_configuration
method.
boto3 documentation
def update_launch_configuration(
self,
*,
sourceServerID: str,
copyPrivateIp: bool = ...,
copyTags: bool = ...,
launchDisposition: LaunchDispositionType = ..., # (1)
licensing: LicensingTypeDef = ..., # (2)
name: str = ...,
targetInstanceTypeRightSizingMethod: TargetInstanceTypeRightSizingMethodType = ..., # (3)
) -> LaunchConfigurationTypeDef: # (4)
...
- See LaunchDispositionType
- See LicensingTypeDef
- See TargetInstanceTypeRightSizingMethodType
- See LaunchConfigurationTypeDef
kwargs: UpdateLaunchConfigurationRequestRequestTypeDef = { # (1)
"sourceServerID": ...,
}
parent.update_launch_configuration(**kwargs)
update_replication_configuration
Allows you to update a ReplicationConfiguration by Source Server ID.
Type annotations and code completion for boto3.client("drs").update_replication_configuration
method.
boto3 documentation
def update_replication_configuration(
self,
*,
sourceServerID: str,
associateDefaultSecurityGroup: bool = ...,
bandwidthThrottling: int = ...,
createPublicIP: bool = ...,
dataPlaneRouting: ReplicationConfigurationDataPlaneRoutingType = ..., # (1)
defaultLargeStagingDiskType: ReplicationConfigurationDefaultLargeStagingDiskTypeType = ..., # (2)
ebsEncryption: ReplicationConfigurationEbsEncryptionType = ..., # (3)
ebsEncryptionKeyArn: str = ...,
name: str = ...,
pitPolicy: Sequence[PITPolicyRuleTypeDef] = ..., # (4)
replicatedDisks: Sequence[ReplicationConfigurationReplicatedDiskTypeDef] = ..., # (5)
replicationServerInstanceType: str = ...,
replicationServersSecurityGroupsIDs: Sequence[str] = ...,
stagingAreaSubnetId: str = ...,
stagingAreaTags: Mapping[str, str] = ...,
useDedicatedReplicationServer: bool = ...,
) -> ReplicationConfigurationTypeDef: # (6)
...
- See ReplicationConfigurationDataPlaneRoutingType
- See ReplicationConfigurationDefaultLargeStagingDiskTypeType
- See ReplicationConfigurationEbsEncryptionType
- See PITPolicyRuleTypeDef
- See ReplicationConfigurationReplicatedDiskTypeDef
- See ReplicationConfigurationTypeDef
kwargs: UpdateReplicationConfigurationRequestRequestTypeDef = { # (1)
"sourceServerID": ...,
}
parent.update_replication_configuration(**kwargs)
update_replication_configuration_template
Updates a ReplicationConfigurationTemplate by ID.
Type annotations and code completion for boto3.client("drs").update_replication_configuration_template
method.
boto3 documentation
def update_replication_configuration_template(
self,
*,
replicationConfigurationTemplateID: str,
arn: str = ...,
associateDefaultSecurityGroup: bool = ...,
bandwidthThrottling: int = ...,
createPublicIP: bool = ...,
dataPlaneRouting: ReplicationConfigurationDataPlaneRoutingType = ..., # (1)
defaultLargeStagingDiskType: ReplicationConfigurationDefaultLargeStagingDiskTypeType = ..., # (2)
ebsEncryption: ReplicationConfigurationEbsEncryptionType = ..., # (3)
ebsEncryptionKeyArn: str = ...,
pitPolicy: Sequence[PITPolicyRuleTypeDef] = ..., # (4)
replicationServerInstanceType: str = ...,
replicationServersSecurityGroupsIDs: Sequence[str] = ...,
stagingAreaSubnetId: str = ...,
stagingAreaTags: Mapping[str, str] = ...,
useDedicatedReplicationServer: bool = ...,
) -> ReplicationConfigurationTemplateResponseMetadataTypeDef: # (5)
...
- See ReplicationConfigurationDataPlaneRoutingType
- See ReplicationConfigurationDefaultLargeStagingDiskTypeType
- See ReplicationConfigurationEbsEncryptionType
- See PITPolicyRuleTypeDef
- See ReplicationConfigurationTemplateResponseMetadataTypeDef
kwargs: UpdateReplicationConfigurationTemplateRequestRequestTypeDef = { # (1)
"replicationConfigurationTemplateID": ...,
}
parent.update_replication_configuration_template(**kwargs)
get_paginator
Type annotations and code completion for boto3.client("drs").get_paginator
method with overloads.
client.get_paginator("describe_job_log_items")
-> DescribeJobLogItemsPaginatorclient.get_paginator("describe_jobs")
-> DescribeJobsPaginatorclient.get_paginator("describe_recovery_instances")
-> DescribeRecoveryInstancesPaginatorclient.get_paginator("describe_recovery_snapshots")
-> DescribeRecoverySnapshotsPaginatorclient.get_paginator("describe_replication_configuration_templates")
-> DescribeReplicationConfigurationTemplatesPaginatorclient.get_paginator("describe_source_servers")
-> DescribeSourceServersPaginatorclient.get_paginator("list_extensible_source_servers")
-> ListExtensibleSourceServersPaginatorclient.get_paginator("list_staging_accounts")
-> ListStagingAccountsPaginator