Skip to content

DrsClient#

Index > Drs > 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

# DrsClient usage example

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.

# Exceptions.exceptions usage example

client = boto3.client("drs")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.UninitializedAccountException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_drs.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods#

can_paginate#

Type annotations and code completion for boto3.client("drs").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url#

Type annotations and code completion for boto3.client("drs").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

associate_source_network_stack#

Associate a Source Network to an existing CloudFormation Stack and modify launch templates to use this network.

Type annotations and code completion for boto3.client("drs").associate_source_network_stack method. boto3 documentation

# associate_source_network_stack method definition

def associate_source_network_stack(
    self,
    *,
    cfnStackName: str,
    sourceNetworkID: str,
) -> AssociateSourceNetworkStackResponseTypeDef:  # (1)
    ...
  1. See AssociateSourceNetworkStackResponseTypeDef 
# associate_source_network_stack method usage example with argument unpacking

kwargs: AssociateSourceNetworkStackRequestRequestTypeDef = {  # (1)
    "cfnStackName": ...,
    "sourceNetworkID": ...,
}

parent.associate_source_network_stack(**kwargs)
  1. See AssociateSourceNetworkStackRequestRequestTypeDef

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

# create_extended_source_server method definition

def create_extended_source_server(
    self,
    *,
    sourceServerArn: str,
    tags: Mapping[str, str] = ...,
) -> CreateExtendedSourceServerResponseTypeDef:  # (1)
    ...
  1. See CreateExtendedSourceServerResponseTypeDef 
# create_extended_source_server method usage example with argument unpacking

kwargs: CreateExtendedSourceServerRequestRequestTypeDef = {  # (1)
    "sourceServerArn": ...,
}

parent.create_extended_source_server(**kwargs)
  1. See CreateExtendedSourceServerRequestRequestTypeDef

create_launch_configuration_template#

Creates a new Launch Configuration Template.

Type annotations and code completion for boto3.client("drs").create_launch_configuration_template method. boto3 documentation

# create_launch_configuration_template method definition

def create_launch_configuration_template(
    self,
    *,
    copyPrivateIp: bool = ...,
    copyTags: bool = ...,
    exportBucketArn: str = ...,
    launchDisposition: LaunchDispositionType = ...,  # (1)
    launchIntoSourceInstance: bool = ...,
    licensing: LicensingTypeDef = ...,  # (2)
    postLaunchEnabled: bool = ...,
    tags: Mapping[str, str] = ...,
    targetInstanceTypeRightSizingMethod: TargetInstanceTypeRightSizingMethodType = ...,  # (3)
) -> CreateLaunchConfigurationTemplateResponseTypeDef:  # (4)
    ...
  1. See LaunchDispositionType
  2. See LicensingTypeDef
  3. See TargetInstanceTypeRightSizingMethodType
  4. See CreateLaunchConfigurationTemplateResponseTypeDef 
# create_launch_configuration_template method usage example with argument unpacking

kwargs: CreateLaunchConfigurationTemplateRequestRequestTypeDef = {  # (1)
    "copyPrivateIp": ...,
}

parent.create_launch_configuration_template(**kwargs)
  1. See CreateLaunchConfigurationTemplateRequestRequestTypeDef

create_replication_configuration_template#

Creates a new ReplicationConfigurationTemplate.

Type annotations and code completion for boto3.client("drs").create_replication_configuration_template method. boto3 documentation

# create_replication_configuration_template method definition

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,
    autoReplicateNewDisks: bool = ...,
    ebsEncryptionKeyArn: str = ...,
    tags: Mapping[str, str] = ...,
) -> ReplicationConfigurationTemplateResponseTypeDef:  # (5)
    ...
  1. See ReplicationConfigurationDataPlaneRoutingType
  2. See ReplicationConfigurationDefaultLargeStagingDiskTypeType
  3. See ReplicationConfigurationEbsEncryptionType
  4. See PITPolicyRuleTypeDef
  5. See ReplicationConfigurationTemplateResponseTypeDef 
# create_replication_configuration_template method usage example with argument unpacking

kwargs: CreateReplicationConfigurationTemplateRequestRequestTypeDef = {  # (1)
    "associateDefaultSecurityGroup": ...,
    "bandwidthThrottling": ...,
    "createPublicIP": ...,
    "dataPlaneRouting": ...,
    "defaultLargeStagingDiskType": ...,
    "ebsEncryption": ...,
    "pitPolicy": ...,
    "replicationServerInstanceType": ...,
    "replicationServersSecurityGroupsIDs": ...,
    "stagingAreaSubnetId": ...,
    "stagingAreaTags": ...,
    "useDedicatedReplicationServer": ...,
}

parent.create_replication_configuration_template(**kwargs)
  1. See CreateReplicationConfigurationTemplateRequestRequestTypeDef

create_source_network#

Create a new Source Network resource for a provided VPC ID.

Type annotations and code completion for boto3.client("drs").create_source_network method. boto3 documentation

# create_source_network method definition

def create_source_network(
    self,
    *,
    originAccountID: str,
    originRegion: str,
    vpcID: str,
    tags: Mapping[str, str] = ...,
) -> CreateSourceNetworkResponseTypeDef:  # (1)
    ...
  1. See CreateSourceNetworkResponseTypeDef 
# create_source_network method usage example with argument unpacking

kwargs: CreateSourceNetworkRequestRequestTypeDef = {  # (1)
    "originAccountID": ...,
    "originRegion": ...,
    "vpcID": ...,
}

parent.create_source_network(**kwargs)
  1. See CreateSourceNetworkRequestRequestTypeDef

delete_job#

Deletes a single Job by ID.

Type annotations and code completion for boto3.client("drs").delete_job method. boto3 documentation

# delete_job method definition

def delete_job(
    self,
    *,
    jobID: str,
) -> dict[str, Any]:
    ...
# delete_job method usage example with argument unpacking

kwargs: DeleteJobRequestRequestTypeDef = {  # (1)
    "jobID": ...,
}

parent.delete_job(**kwargs)
  1. See DeleteJobRequestRequestTypeDef

delete_launch_action#

Deletes a resource launch action.

Type annotations and code completion for boto3.client("drs").delete_launch_action method. boto3 documentation

# delete_launch_action method definition

def delete_launch_action(
    self,
    *,
    actionId: str,
    resourceId: str,
) -> dict[str, Any]:
    ...
# delete_launch_action method usage example with argument unpacking

kwargs: DeleteLaunchActionRequestRequestTypeDef = {  # (1)
    "actionId": ...,
    "resourceId": ...,
}

parent.delete_launch_action(**kwargs)
  1. See DeleteLaunchActionRequestRequestTypeDef

delete_launch_configuration_template#

Deletes a single Launch Configuration Template by ID.

Type annotations and code completion for boto3.client("drs").delete_launch_configuration_template method. boto3 documentation

# delete_launch_configuration_template method definition

def delete_launch_configuration_template(
    self,
    *,
    launchConfigurationTemplateID: str,
) -> dict[str, Any]:
    ...
# delete_launch_configuration_template method usage example with argument unpacking

kwargs: DeleteLaunchConfigurationTemplateRequestRequestTypeDef = {  # (1)
    "launchConfigurationTemplateID": ...,
}

parent.delete_launch_configuration_template(**kwargs)
  1. See DeleteLaunchConfigurationTemplateRequestRequestTypeDef

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

# delete_recovery_instance method definition

def delete_recovery_instance(
    self,
    *,
    recoveryInstanceID: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# delete_recovery_instance method usage example with argument unpacking

kwargs: DeleteRecoveryInstanceRequestRequestTypeDef = {  # (1)
    "recoveryInstanceID": ...,
}

parent.delete_recovery_instance(**kwargs)
  1. See DeleteRecoveryInstanceRequestRequestTypeDef

delete_replication_configuration_template#

Deletes a single Replication Configuration Template by ID.

Type annotations and code completion for boto3.client("drs").delete_replication_configuration_template method. boto3 documentation

# delete_replication_configuration_template method definition

def delete_replication_configuration_template(
    self,
    *,
    replicationConfigurationTemplateID: str,
) -> dict[str, Any]:
    ...
# delete_replication_configuration_template method usage example with argument unpacking

kwargs: DeleteReplicationConfigurationTemplateRequestRequestTypeDef = {  # (1)
    "replicationConfigurationTemplateID": ...,
}

parent.delete_replication_configuration_template(**kwargs)
  1. See DeleteReplicationConfigurationTemplateRequestRequestTypeDef

delete_source_network#

Delete Source Network resource.

Type annotations and code completion for boto3.client("drs").delete_source_network method. boto3 documentation

# delete_source_network method definition

def delete_source_network(
    self,
    *,
    sourceNetworkID: str,
) -> dict[str, Any]:
    ...
# delete_source_network method usage example with argument unpacking

kwargs: DeleteSourceNetworkRequestRequestTypeDef = {  # (1)
    "sourceNetworkID": ...,
}

parent.delete_source_network(**kwargs)
  1. See DeleteSourceNetworkRequestRequestTypeDef

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

# delete_source_server method definition

def delete_source_server(
    self,
    *,
    sourceServerID: str,
) -> dict[str, Any]:
    ...
# delete_source_server method usage example with argument unpacking

kwargs: DeleteSourceServerRequestRequestTypeDef = {  # (1)
    "sourceServerID": ...,
}

parent.delete_source_server(**kwargs)
  1. See DeleteSourceServerRequestRequestTypeDef

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

# describe_job_log_items method definition

def describe_job_log_items(
    self,
    *,
    jobID: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> DescribeJobLogItemsResponseTypeDef:  # (1)
    ...
  1. See DescribeJobLogItemsResponseTypeDef 
# describe_job_log_items method usage example with argument unpacking

kwargs: DescribeJobLogItemsRequestRequestTypeDef = {  # (1)
    "jobID": ...,
}

parent.describe_job_log_items(**kwargs)
  1. See DescribeJobLogItemsRequestRequestTypeDef

describe_jobs#

Returns a list of Jobs.

Type annotations and code completion for boto3.client("drs").describe_jobs method. boto3 documentation

# describe_jobs method definition

def describe_jobs(
    self,
    *,
    filters: DescribeJobsRequestFiltersTypeDef = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> DescribeJobsResponseTypeDef:  # (2)
    ...
  1. See DescribeJobsRequestFiltersTypeDef
  2. See DescribeJobsResponseTypeDef 
# describe_jobs method usage example with argument unpacking

kwargs: DescribeJobsRequestRequestTypeDef = {  # (1)
    "filters": ...,
}

parent.describe_jobs(**kwargs)
  1. See DescribeJobsRequestRequestTypeDef

describe_launch_configuration_templates#

Lists all Launch Configuration Templates, filtered by Launch Configuration Template IDs.

Type annotations and code completion for boto3.client("drs").describe_launch_configuration_templates method. boto3 documentation

# describe_launch_configuration_templates method definition

def describe_launch_configuration_templates(
    self,
    *,
    launchConfigurationTemplateIDs: Sequence[str] = ...,
    maxResults: int = ...,
    nextToken: str = ...,
) -> DescribeLaunchConfigurationTemplatesResponseTypeDef:  # (1)
    ...
  1. See DescribeLaunchConfigurationTemplatesResponseTypeDef 
# describe_launch_configuration_templates method usage example with argument unpacking

kwargs: DescribeLaunchConfigurationTemplatesRequestRequestTypeDef = {  # (1)
    "launchConfigurationTemplateIDs": ...,
}

parent.describe_launch_configuration_templates(**kwargs)
  1. See DescribeLaunchConfigurationTemplatesRequestRequestTypeDef

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

# describe_recovery_instances method definition

def describe_recovery_instances(
    self,
    *,
    filters: DescribeRecoveryInstancesRequestFiltersTypeDef = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> DescribeRecoveryInstancesResponseTypeDef:  # (2)
    ...
  1. See DescribeRecoveryInstancesRequestFiltersTypeDef
  2. See DescribeRecoveryInstancesResponseTypeDef 
# describe_recovery_instances method usage example with argument unpacking

kwargs: DescribeRecoveryInstancesRequestRequestTypeDef = {  # (1)
    "filters": ...,
}

parent.describe_recovery_instances(**kwargs)
  1. See DescribeRecoveryInstancesRequestRequestTypeDef

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

# describe_recovery_snapshots method definition

def describe_recovery_snapshots(
    self,
    *,
    sourceServerID: str,
    filters: DescribeRecoverySnapshotsRequestFiltersTypeDef = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
    order: RecoverySnapshotsOrderType = ...,  # (2)
) -> DescribeRecoverySnapshotsResponseTypeDef:  # (3)
    ...
  1. See DescribeRecoverySnapshotsRequestFiltersTypeDef
  2. See RecoverySnapshotsOrderType
  3. See DescribeRecoverySnapshotsResponseTypeDef 
# describe_recovery_snapshots method usage example with argument unpacking

kwargs: DescribeRecoverySnapshotsRequestRequestTypeDef = {  # (1)
    "sourceServerID": ...,
}

parent.describe_recovery_snapshots(**kwargs)
  1. See DescribeRecoverySnapshotsRequestRequestTypeDef

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

# describe_replication_configuration_templates method definition

def describe_replication_configuration_templates(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
    replicationConfigurationTemplateIDs: Sequence[str] = ...,
) -> DescribeReplicationConfigurationTemplatesResponseTypeDef:  # (1)
    ...
  1. See DescribeReplicationConfigurationTemplatesResponseTypeDef 
# describe_replication_configuration_templates method usage example with argument unpacking

kwargs: DescribeReplicationConfigurationTemplatesRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.describe_replication_configuration_templates(**kwargs)
  1. See DescribeReplicationConfigurationTemplatesRequestRequestTypeDef

describe_source_networks#

Lists all Source Networks or multiple Source Networks filtered by ID.

Type annotations and code completion for boto3.client("drs").describe_source_networks method. boto3 documentation

# describe_source_networks method definition

def describe_source_networks(
    self,
    *,
    filters: DescribeSourceNetworksRequestFiltersTypeDef = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> DescribeSourceNetworksResponseTypeDef:  # (2)
    ...
  1. See DescribeSourceNetworksRequestFiltersTypeDef
  2. See DescribeSourceNetworksResponseTypeDef 
# describe_source_networks method usage example with argument unpacking

kwargs: DescribeSourceNetworksRequestRequestTypeDef = {  # (1)
    "filters": ...,
}

parent.describe_source_networks(**kwargs)
  1. See DescribeSourceNetworksRequestRequestTypeDef

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

# describe_source_servers method definition

def describe_source_servers(
    self,
    *,
    filters: DescribeSourceServersRequestFiltersTypeDef = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> DescribeSourceServersResponseTypeDef:  # (2)
    ...
  1. See DescribeSourceServersRequestFiltersTypeDef
  2. See DescribeSourceServersResponseTypeDef 
# describe_source_servers method usage example with argument unpacking

kwargs: DescribeSourceServersRequestRequestTypeDef = {  # (1)
    "filters": ...,
}

parent.describe_source_servers(**kwargs)
  1. See DescribeSourceServersRequestRequestTypeDef

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

# disconnect_recovery_instance method definition

def disconnect_recovery_instance(
    self,
    *,
    recoveryInstanceID: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# disconnect_recovery_instance method usage example with argument unpacking

kwargs: DisconnectRecoveryInstanceRequestRequestTypeDef = {  # (1)
    "recoveryInstanceID": ...,
}

parent.disconnect_recovery_instance(**kwargs)
  1. See DisconnectRecoveryInstanceRequestRequestTypeDef

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

# disconnect_source_server method definition

def disconnect_source_server(
    self,
    *,
    sourceServerID: str,
) -> SourceServerResponseTypeDef:  # (1)
    ...
  1. See SourceServerResponseTypeDef 
# disconnect_source_server method usage example with argument unpacking

kwargs: DisconnectSourceServerRequestRequestTypeDef = {  # (1)
    "sourceServerID": ...,
}

parent.disconnect_source_server(**kwargs)
  1. See DisconnectSourceServerRequestRequestTypeDef

export_source_network_cfn_template#

Export the Source Network CloudFormation template to an S3 bucket.

Type annotations and code completion for boto3.client("drs").export_source_network_cfn_template method. boto3 documentation

# export_source_network_cfn_template method definition

def export_source_network_cfn_template(
    self,
    *,
    sourceNetworkID: str,
) -> ExportSourceNetworkCfnTemplateResponseTypeDef:  # (1)
    ...
  1. See ExportSourceNetworkCfnTemplateResponseTypeDef 
# export_source_network_cfn_template method usage example with argument unpacking

kwargs: ExportSourceNetworkCfnTemplateRequestRequestTypeDef = {  # (1)
    "sourceNetworkID": ...,
}

parent.export_source_network_cfn_template(**kwargs)
  1. See ExportSourceNetworkCfnTemplateRequestRequestTypeDef

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

# get_failback_replication_configuration method definition

def get_failback_replication_configuration(
    self,
    *,
    recoveryInstanceID: str,
) -> GetFailbackReplicationConfigurationResponseTypeDef:  # (1)
    ...
  1. See GetFailbackReplicationConfigurationResponseTypeDef 
# get_failback_replication_configuration method usage example with argument unpacking

kwargs: GetFailbackReplicationConfigurationRequestRequestTypeDef = {  # (1)
    "recoveryInstanceID": ...,
}

parent.get_failback_replication_configuration(**kwargs)
  1. See GetFailbackReplicationConfigurationRequestRequestTypeDef

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

# get_launch_configuration method definition

def get_launch_configuration(
    self,
    *,
    sourceServerID: str,
) -> LaunchConfigurationTypeDef:  # (1)
    ...
  1. See LaunchConfigurationTypeDef 
# get_launch_configuration method usage example with argument unpacking

kwargs: GetLaunchConfigurationRequestRequestTypeDef = {  # (1)
    "sourceServerID": ...,
}

parent.get_launch_configuration(**kwargs)
  1. See GetLaunchConfigurationRequestRequestTypeDef

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

# get_replication_configuration method definition

def get_replication_configuration(
    self,
    *,
    sourceServerID: str,
) -> ReplicationConfigurationTypeDef:  # (1)
    ...
  1. See ReplicationConfigurationTypeDef 
# get_replication_configuration method usage example with argument unpacking

kwargs: GetReplicationConfigurationRequestRequestTypeDef = {  # (1)
    "sourceServerID": ...,
}

parent.get_replication_configuration(**kwargs)
  1. See GetReplicationConfigurationRequestRequestTypeDef

initialize_service#

Initialize Elastic Disaster Recovery.

Type annotations and code completion for boto3.client("drs").initialize_service method. boto3 documentation

# initialize_service method definition

def initialize_service(
    self,
) -> dict[str, Any]:
    ...

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

# list_extensible_source_servers method definition

def list_extensible_source_servers(
    self,
    *,
    stagingAccountID: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListExtensibleSourceServersResponseTypeDef:  # (1)
    ...
  1. See ListExtensibleSourceServersResponseTypeDef 
# list_extensible_source_servers method usage example with argument unpacking

kwargs: ListExtensibleSourceServersRequestRequestTypeDef = {  # (1)
    "stagingAccountID": ...,
}

parent.list_extensible_source_servers(**kwargs)
  1. See ListExtensibleSourceServersRequestRequestTypeDef

list_launch_actions#

Lists resource launch actions.

Type annotations and code completion for boto3.client("drs").list_launch_actions method. boto3 documentation

# list_launch_actions method definition

def list_launch_actions(
    self,
    *,
    resourceId: str,
    filters: LaunchActionsRequestFiltersTypeDef = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListLaunchActionsResponseTypeDef:  # (2)
    ...
  1. See LaunchActionsRequestFiltersTypeDef
  2. See ListLaunchActionsResponseTypeDef 
# list_launch_actions method usage example with argument unpacking

kwargs: ListLaunchActionsRequestRequestTypeDef = {  # (1)
    "resourceId": ...,
}

parent.list_launch_actions(**kwargs)
  1. See ListLaunchActionsRequestRequestTypeDef

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

# list_staging_accounts method definition

def list_staging_accounts(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListStagingAccountsResponseTypeDef:  # (1)
    ...
  1. See ListStagingAccountsResponseTypeDef 
# list_staging_accounts method usage example with argument unpacking

kwargs: ListStagingAccountsRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_staging_accounts(**kwargs)
  1. See ListStagingAccountsRequestRequestTypeDef

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

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef 
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestRequestTypeDef

put_launch_action#

Puts a resource launch action.

Type annotations and code completion for boto3.client("drs").put_launch_action method. boto3 documentation

# put_launch_action method definition

def put_launch_action(
    self,
    *,
    actionCode: str,
    actionId: str,
    actionVersion: str,
    active: bool,
    category: LaunchActionCategoryType,  # (1)
    description: str,
    name: str,
    optional: bool,
    order: int,
    resourceId: str,
    parameters: Mapping[str, LaunchActionParameterTypeDef] = ...,  # (2)
) -> PutLaunchActionResponseTypeDef:  # (3)
    ...
  1. See LaunchActionCategoryType
  2. See LaunchActionParameterTypeDef
  3. See PutLaunchActionResponseTypeDef 
# put_launch_action method usage example with argument unpacking

kwargs: PutLaunchActionRequestRequestTypeDef = {  # (1)
    "actionCode": ...,
    "actionId": ...,
    "actionVersion": ...,
    "active": ...,
    "category": ...,
    "description": ...,
    "name": ...,
    "optional": ...,
    "order": ...,
    "resourceId": ...,
}

parent.put_launch_action(**kwargs)
  1. See PutLaunchActionRequestRequestTypeDef

retry_data_replication#

WARNING: RetryDataReplication is deprecated.

Type annotations and code completion for boto3.client("drs").retry_data_replication method. boto3 documentation

# retry_data_replication method definition

def retry_data_replication(
    self,
    *,
    sourceServerID: str,
) -> SourceServerResponseTypeDef:  # (1)
    ...
  1. See SourceServerResponseTypeDef 
# retry_data_replication method usage example with argument unpacking

kwargs: RetryDataReplicationRequestRequestTypeDef = {  # (1)
    "sourceServerID": ...,
}

parent.retry_data_replication(**kwargs)
  1. See RetryDataReplicationRequestRequestTypeDef

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

# reverse_replication method definition

def reverse_replication(
    self,
    *,
    recoveryInstanceID: str,
) -> ReverseReplicationResponseTypeDef:  # (1)
    ...
  1. See ReverseReplicationResponseTypeDef 
# reverse_replication method usage example with argument unpacking

kwargs: ReverseReplicationRequestRequestTypeDef = {  # (1)
    "recoveryInstanceID": ...,
}

parent.reverse_replication(**kwargs)
  1. See ReverseReplicationRequestRequestTypeDef

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

# start_failback_launch method definition

def start_failback_launch(
    self,
    *,
    recoveryInstanceIDs: Sequence[str],
    tags: Mapping[str, str] = ...,
) -> StartFailbackLaunchResponseTypeDef:  # (1)
    ...
  1. See StartFailbackLaunchResponseTypeDef 
# start_failback_launch method usage example with argument unpacking

kwargs: StartFailbackLaunchRequestRequestTypeDef = {  # (1)
    "recoveryInstanceIDs": ...,
}

parent.start_failback_launch(**kwargs)
  1. See StartFailbackLaunchRequestRequestTypeDef

start_recovery#

Launches Recovery Instances for the specified Source Servers.

Type annotations and code completion for boto3.client("drs").start_recovery method. boto3 documentation

# start_recovery method definition

def start_recovery(
    self,
    *,
    sourceServers: Sequence[StartRecoveryRequestSourceServerTypeDef],  # (1)
    isDrill: bool = ...,
    tags: Mapping[str, str] = ...,
) -> StartRecoveryResponseTypeDef:  # (2)
    ...
  1. See StartRecoveryRequestSourceServerTypeDef
  2. See StartRecoveryResponseTypeDef 
# start_recovery method usage example with argument unpacking

kwargs: StartRecoveryRequestRequestTypeDef = {  # (1)
    "sourceServers": ...,
}

parent.start_recovery(**kwargs)
  1. See StartRecoveryRequestRequestTypeDef

start_replication#

Starts replication for a stopped Source Server.

Type annotations and code completion for boto3.client("drs").start_replication method. boto3 documentation

# start_replication method definition

def start_replication(
    self,
    *,
    sourceServerID: str,
) -> StartReplicationResponseTypeDef:  # (1)
    ...
  1. See StartReplicationResponseTypeDef 
# start_replication method usage example with argument unpacking

kwargs: StartReplicationRequestRequestTypeDef = {  # (1)
    "sourceServerID": ...,
}

parent.start_replication(**kwargs)
  1. See StartReplicationRequestRequestTypeDef

start_source_network_recovery#

Deploy VPC for the specified Source Network and modify launch templates to use this network.

Type annotations and code completion for boto3.client("drs").start_source_network_recovery method. boto3 documentation

# start_source_network_recovery method definition

def start_source_network_recovery(
    self,
    *,
    sourceNetworks: Sequence[StartSourceNetworkRecoveryRequestNetworkEntryTypeDef],  # (1)
    deployAsNew: bool = ...,
    tags: Mapping[str, str] = ...,
) -> StartSourceNetworkRecoveryResponseTypeDef:  # (2)
    ...
  1. See StartSourceNetworkRecoveryRequestNetworkEntryTypeDef
  2. See StartSourceNetworkRecoveryResponseTypeDef 
# start_source_network_recovery method usage example with argument unpacking

kwargs: StartSourceNetworkRecoveryRequestRequestTypeDef = {  # (1)
    "sourceNetworks": ...,
}

parent.start_source_network_recovery(**kwargs)
  1. See StartSourceNetworkRecoveryRequestRequestTypeDef

start_source_network_replication#

Starts replication for a Source Network.

Type annotations and code completion for boto3.client("drs").start_source_network_replication method. boto3 documentation

# start_source_network_replication method definition

def start_source_network_replication(
    self,
    *,
    sourceNetworkID: str,
) -> StartSourceNetworkReplicationResponseTypeDef:  # (1)
    ...
  1. See StartSourceNetworkReplicationResponseTypeDef 
# start_source_network_replication method usage example with argument unpacking

kwargs: StartSourceNetworkReplicationRequestRequestTypeDef = {  # (1)
    "sourceNetworkID": ...,
}

parent.start_source_network_replication(**kwargs)
  1. See StartSourceNetworkReplicationRequestRequestTypeDef

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

# stop_failback method definition

def stop_failback(
    self,
    *,
    recoveryInstanceID: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# stop_failback method usage example with argument unpacking

kwargs: StopFailbackRequestRequestTypeDef = {  # (1)
    "recoveryInstanceID": ...,
}

parent.stop_failback(**kwargs)
  1. See StopFailbackRequestRequestTypeDef

stop_replication#

Stops replication for a Source Server.

Type annotations and code completion for boto3.client("drs").stop_replication method. boto3 documentation

# stop_replication method definition

def stop_replication(
    self,
    *,
    sourceServerID: str,
) -> StopReplicationResponseTypeDef:  # (1)
    ...
  1. See StopReplicationResponseTypeDef 
# stop_replication method usage example with argument unpacking

kwargs: StopReplicationRequestRequestTypeDef = {  # (1)
    "sourceServerID": ...,
}

parent.stop_replication(**kwargs)
  1. See StopReplicationRequestRequestTypeDef

stop_source_network_replication#

Stops replication for a Source Network.

Type annotations and code completion for boto3.client("drs").stop_source_network_replication method. boto3 documentation

# stop_source_network_replication method definition

def stop_source_network_replication(
    self,
    *,
    sourceNetworkID: str,
) -> StopSourceNetworkReplicationResponseTypeDef:  # (1)
    ...
  1. See StopSourceNetworkReplicationResponseTypeDef 
# stop_source_network_replication method usage example with argument unpacking

kwargs: StopSourceNetworkReplicationRequestRequestTypeDef = {  # (1)
    "sourceNetworkID": ...,
}

parent.stop_source_network_replication(**kwargs)
  1. See StopSourceNetworkReplicationRequestRequestTypeDef

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

# tag_resource method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestRequestTypeDef

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

# terminate_recovery_instances method definition

def terminate_recovery_instances(
    self,
    *,
    recoveryInstanceIDs: Sequence[str],
) -> TerminateRecoveryInstancesResponseTypeDef:  # (1)
    ...
  1. See TerminateRecoveryInstancesResponseTypeDef 
# terminate_recovery_instances method usage example with argument unpacking

kwargs: TerminateRecoveryInstancesRequestRequestTypeDef = {  # (1)
    "recoveryInstanceIDs": ...,
}

parent.terminate_recovery_instances(**kwargs)
  1. See TerminateRecoveryInstancesRequestRequestTypeDef

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

# untag_resource method definition

def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestRequestTypeDef

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

# update_failback_replication_configuration method definition

def update_failback_replication_configuration(
    self,
    *,
    recoveryInstanceID: str,
    bandwidthThrottling: int = ...,
    name: str = ...,
    usePrivateIP: bool = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# update_failback_replication_configuration method usage example with argument unpacking

kwargs: UpdateFailbackReplicationConfigurationRequestRequestTypeDef = {  # (1)
    "recoveryInstanceID": ...,
}

parent.update_failback_replication_configuration(**kwargs)
  1. See UpdateFailbackReplicationConfigurationRequestRequestTypeDef

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

# update_launch_configuration method definition

def update_launch_configuration(
    self,
    *,
    sourceServerID: str,
    copyPrivateIp: bool = ...,
    copyTags: bool = ...,
    launchDisposition: LaunchDispositionType = ...,  # (1)
    launchIntoInstanceProperties: LaunchIntoInstancePropertiesTypeDef = ...,  # (2)
    licensing: LicensingTypeDef = ...,  # (3)
    name: str = ...,
    postLaunchEnabled: bool = ...,
    targetInstanceTypeRightSizingMethod: TargetInstanceTypeRightSizingMethodType = ...,  # (4)
) -> LaunchConfigurationTypeDef:  # (5)
    ...
  1. See LaunchDispositionType
  2. See LaunchIntoInstancePropertiesTypeDef
  3. See LicensingTypeDef
  4. See TargetInstanceTypeRightSizingMethodType
  5. See LaunchConfigurationTypeDef 
# update_launch_configuration method usage example with argument unpacking

kwargs: UpdateLaunchConfigurationRequestRequestTypeDef = {  # (1)
    "sourceServerID": ...,
}

parent.update_launch_configuration(**kwargs)
  1. See UpdateLaunchConfigurationRequestRequestTypeDef

update_launch_configuration_template#

Updates an existing Launch Configuration Template by ID.

Type annotations and code completion for boto3.client("drs").update_launch_configuration_template method. boto3 documentation

# update_launch_configuration_template method definition

def update_launch_configuration_template(
    self,
    *,
    launchConfigurationTemplateID: str,
    copyPrivateIp: bool = ...,
    copyTags: bool = ...,
    exportBucketArn: str = ...,
    launchDisposition: LaunchDispositionType = ...,  # (1)
    launchIntoSourceInstance: bool = ...,
    licensing: LicensingTypeDef = ...,  # (2)
    postLaunchEnabled: bool = ...,
    targetInstanceTypeRightSizingMethod: TargetInstanceTypeRightSizingMethodType = ...,  # (3)
) -> UpdateLaunchConfigurationTemplateResponseTypeDef:  # (4)
    ...
  1. See LaunchDispositionType
  2. See LicensingTypeDef
  3. See TargetInstanceTypeRightSizingMethodType
  4. See UpdateLaunchConfigurationTemplateResponseTypeDef 
# update_launch_configuration_template method usage example with argument unpacking

kwargs: UpdateLaunchConfigurationTemplateRequestRequestTypeDef = {  # (1)
    "launchConfigurationTemplateID": ...,
}

parent.update_launch_configuration_template(**kwargs)
  1. See UpdateLaunchConfigurationTemplateRequestRequestTypeDef

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

# update_replication_configuration method definition

def update_replication_configuration(
    self,
    *,
    sourceServerID: str,
    associateDefaultSecurityGroup: bool = ...,
    autoReplicateNewDisks: 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)
    ...
  1. See ReplicationConfigurationDataPlaneRoutingType
  2. See ReplicationConfigurationDefaultLargeStagingDiskTypeType
  3. See ReplicationConfigurationEbsEncryptionType
  4. See PITPolicyRuleTypeDef
  5. See ReplicationConfigurationReplicatedDiskTypeDef
  6. See ReplicationConfigurationTypeDef 
# update_replication_configuration method usage example with argument unpacking

kwargs: UpdateReplicationConfigurationRequestRequestTypeDef = {  # (1)
    "sourceServerID": ...,
}

parent.update_replication_configuration(**kwargs)
  1. See UpdateReplicationConfigurationRequestRequestTypeDef

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

# update_replication_configuration_template method definition

def update_replication_configuration_template(
    self,
    *,
    replicationConfigurationTemplateID: str,
    arn: str = ...,
    associateDefaultSecurityGroup: bool = ...,
    autoReplicateNewDisks: 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 = ...,
) -> ReplicationConfigurationTemplateResponseTypeDef:  # (5)
    ...
  1. See ReplicationConfigurationDataPlaneRoutingType
  2. See ReplicationConfigurationDefaultLargeStagingDiskTypeType
  3. See ReplicationConfigurationEbsEncryptionType
  4. See PITPolicyRuleTypeDef
  5. See ReplicationConfigurationTemplateResponseTypeDef 
# update_replication_configuration_template method usage example with argument unpacking

kwargs: UpdateReplicationConfigurationTemplateRequestRequestTypeDef = {  # (1)
    "replicationConfigurationTemplateID": ...,
}

parent.update_replication_configuration_template(**kwargs)
  1. See UpdateReplicationConfigurationTemplateRequestRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("drs").get_paginator method with overloads.