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#

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

can_paginate#

Check if an operation can be paginated.

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

close#

Closes underlying endpoint connections.

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

# close method definition

def close(
    self,
) -> None:
    ...

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 See also: AWS API Documentation.

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 See also: AWS API Documentation.

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