Skip to content

DataSyncClient#

Index > DataSync > DataSyncClient

Auto-generated documentation for DataSync type annotations stubs module mypy-boto3-datasync.

DataSyncClient#

Type annotations and code completion for boto3.client("datasync"). boto3 documentation

# DataSyncClient usage example

from boto3.session import Session
from mypy_boto3_datasync.client import DataSyncClient

def get_datasync_client() -> DataSyncClient:
    return Session().client("datasync")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("datasync").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("datasync")

try:
    do_something(client)
except (
    client.exceptions.ClientError,
    client.exceptions.InternalException,
    client.exceptions.InvalidRequestException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_datasync.client import Exceptions

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

Methods#

add_storage_system#

Creates an Amazon Web Services resource for an on-premises storage system that you want DataSync Discovery to collect information about.

Type annotations and code completion for boto3.client("datasync").add_storage_system method. boto3 documentation

# add_storage_system method definition

def add_storage_system(
    self,
    *,
    ServerConfiguration: DiscoveryServerConfigurationTypeDef,  # (1)
    SystemType: DiscoverySystemTypeType,  # (2)
    AgentArns: Sequence[str],
    ClientToken: str,
    Credentials: CredentialsTypeDef,  # (3)
    CloudWatchLogGroupArn: str = ...,
    Tags: Sequence[TagListEntryTypeDef] = ...,  # (4)
    Name: str = ...,
) -> AddStorageSystemResponseTypeDef:  # (5)
    ...
  1. See DiscoveryServerConfigurationTypeDef
  2. See DiscoverySystemTypeType
  3. See CredentialsTypeDef
  4. See TagListEntryTypeDef
  5. See AddStorageSystemResponseTypeDef 
# add_storage_system method usage example with argument unpacking

kwargs: AddStorageSystemRequestRequestTypeDef = {  # (1)
    "ServerConfiguration": ...,
    "SystemType": ...,
    "AgentArns": ...,
    "ClientToken": ...,
    "Credentials": ...,
}

parent.add_storage_system(**kwargs)
  1. See AddStorageSystemRequestRequestTypeDef

can_paginate#

Check if an operation can be paginated.

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

# can_paginate method definition

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

cancel_task_execution#

Stops an DataSync task execution that's in progress.

Type annotations and code completion for boto3.client("datasync").cancel_task_execution method. boto3 documentation

# cancel_task_execution method definition

def cancel_task_execution(
    self,
    *,
    TaskExecutionArn: str,
) -> Dict[str, Any]:
    ...
# cancel_task_execution method usage example with argument unpacking

kwargs: CancelTaskExecutionRequestRequestTypeDef = {  # (1)
    "TaskExecutionArn": ...,
}

parent.cancel_task_execution(**kwargs)
  1. See CancelTaskExecutionRequestRequestTypeDef

close#

Closes underlying endpoint connections.

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

# close method definition

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

create_agent#

Activates an DataSync agent that you've deployed in your storage environment.

Type annotations and code completion for boto3.client("datasync").create_agent method. boto3 documentation

# create_agent method definition

def create_agent(
    self,
    *,
    ActivationKey: str,
    AgentName: str = ...,
    Tags: Sequence[TagListEntryTypeDef] = ...,  # (1)
    VpcEndpointId: str = ...,
    SubnetArns: Sequence[str] = ...,
    SecurityGroupArns: Sequence[str] = ...,
) -> CreateAgentResponseTypeDef:  # (2)
    ...
  1. See TagListEntryTypeDef
  2. See CreateAgentResponseTypeDef 
# create_agent method usage example with argument unpacking

kwargs: CreateAgentRequestRequestTypeDef = {  # (1)
    "ActivationKey": ...,
}

parent.create_agent(**kwargs)
  1. See CreateAgentRequestRequestTypeDef

create_location_azure_blob#

Creates an endpoint for a Microsoft Azure Blob Storage container that DataSync can use as a transfer source or destination.

Type annotations and code completion for boto3.client("datasync").create_location_azure_blob method. boto3 documentation

# create_location_azure_blob method definition

def create_location_azure_blob(
    self,
    *,
    ContainerUrl: str,
    AuthenticationType: AzureBlobAuthenticationTypeType,  # (1)
    AgentArns: Sequence[str],
    SasConfiguration: AzureBlobSasConfigurationTypeDef = ...,  # (2)
    BlobType: AzureBlobTypeType = ...,  # (3)
    AccessTier: AzureAccessTierType = ...,  # (4)
    Subdirectory: str = ...,
    Tags: Sequence[TagListEntryTypeDef] = ...,  # (5)
) -> CreateLocationAzureBlobResponseTypeDef:  # (6)
    ...
  1. See AzureBlobAuthenticationTypeType
  2. See AzureBlobSasConfigurationTypeDef
  3. See AzureBlobTypeType
  4. See AzureAccessTierType
  5. See TagListEntryTypeDef
  6. See CreateLocationAzureBlobResponseTypeDef 
# create_location_azure_blob method usage example with argument unpacking

kwargs: CreateLocationAzureBlobRequestRequestTypeDef = {  # (1)
    "ContainerUrl": ...,
    "AuthenticationType": ...,
    "AgentArns": ...,
}

parent.create_location_azure_blob(**kwargs)
  1. See CreateLocationAzureBlobRequestRequestTypeDef

create_location_efs#

Creates an endpoint for an Amazon EFS file system that DataSync can access for a transfer.

Type annotations and code completion for boto3.client("datasync").create_location_efs method. boto3 documentation

# create_location_efs method definition

def create_location_efs(
    self,
    *,
    EfsFilesystemArn: str,
    Ec2Config: Ec2ConfigTypeDef,  # (1)
    Subdirectory: str = ...,
    Tags: Sequence[TagListEntryTypeDef] = ...,  # (2)
    AccessPointArn: str = ...,
    FileSystemAccessRoleArn: str = ...,
    InTransitEncryption: EfsInTransitEncryptionType = ...,  # (3)
) -> CreateLocationEfsResponseTypeDef:  # (4)
    ...
  1. See Ec2ConfigTypeDef
  2. See TagListEntryTypeDef
  3. See EfsInTransitEncryptionType
  4. See CreateLocationEfsResponseTypeDef 
# create_location_efs method usage example with argument unpacking

kwargs: CreateLocationEfsRequestRequestTypeDef = {  # (1)
    "EfsFilesystemArn": ...,
    "Ec2Config": ...,
}

parent.create_location_efs(**kwargs)
  1. See CreateLocationEfsRequestRequestTypeDef

create_location_fsx_lustre#

Creates an endpoint for an Amazon FSx for Lustre file system.

Type annotations and code completion for boto3.client("datasync").create_location_fsx_lustre method. boto3 documentation

# create_location_fsx_lustre method definition

def create_location_fsx_lustre(
    self,
    *,
    FsxFilesystemArn: str,
    SecurityGroupArns: Sequence[str],
    Subdirectory: str = ...,
    Tags: Sequence[TagListEntryTypeDef] = ...,  # (1)
) -> CreateLocationFsxLustreResponseTypeDef:  # (2)
    ...
  1. See TagListEntryTypeDef
  2. See CreateLocationFsxLustreResponseTypeDef 
# create_location_fsx_lustre method usage example with argument unpacking

kwargs: CreateLocationFsxLustreRequestRequestTypeDef = {  # (1)
    "FsxFilesystemArn": ...,
    "SecurityGroupArns": ...,
}

parent.create_location_fsx_lustre(**kwargs)
  1. See CreateLocationFsxLustreRequestRequestTypeDef

create_location_fsx_ontap#

Creates an endpoint for an Amazon FSx for NetApp ONTAP file system that DataSync can access for a transfer.

Type annotations and code completion for boto3.client("datasync").create_location_fsx_ontap method. boto3 documentation

# create_location_fsx_ontap method definition

def create_location_fsx_ontap(
    self,
    *,
    Protocol: FsxProtocolTypeDef,  # (1)
    SecurityGroupArns: Sequence[str],
    StorageVirtualMachineArn: str,
    Subdirectory: str = ...,
    Tags: Sequence[TagListEntryTypeDef] = ...,  # (2)
) -> CreateLocationFsxOntapResponseTypeDef:  # (3)
    ...
  1. See FsxProtocolTypeDef
  2. See TagListEntryTypeDef
  3. See CreateLocationFsxOntapResponseTypeDef 
# create_location_fsx_ontap method usage example with argument unpacking

kwargs: CreateLocationFsxOntapRequestRequestTypeDef = {  # (1)
    "Protocol": ...,
    "SecurityGroupArns": ...,
    "StorageVirtualMachineArn": ...,
}

parent.create_location_fsx_ontap(**kwargs)
  1. See CreateLocationFsxOntapRequestRequestTypeDef

create_location_fsx_open_zfs#

Creates an endpoint for an Amazon FSx for OpenZFS file system that DataSync can access for a transfer.

Type annotations and code completion for boto3.client("datasync").create_location_fsx_open_zfs method. boto3 documentation

# create_location_fsx_open_zfs method definition

def create_location_fsx_open_zfs(
    self,
    *,
    FsxFilesystemArn: str,
    Protocol: FsxProtocolTypeDef,  # (1)
    SecurityGroupArns: Sequence[str],
    Subdirectory: str = ...,
    Tags: Sequence[TagListEntryTypeDef] = ...,  # (2)
) -> CreateLocationFsxOpenZfsResponseTypeDef:  # (3)
    ...
  1. See FsxProtocolTypeDef
  2. See TagListEntryTypeDef
  3. See CreateLocationFsxOpenZfsResponseTypeDef 
# create_location_fsx_open_zfs method usage example with argument unpacking

kwargs: CreateLocationFsxOpenZfsRequestRequestTypeDef = {  # (1)
    "FsxFilesystemArn": ...,
    "Protocol": ...,
    "SecurityGroupArns": ...,
}

parent.create_location_fsx_open_zfs(**kwargs)
  1. See CreateLocationFsxOpenZfsRequestRequestTypeDef

create_location_fsx_windows#

Creates an endpoint for an Amazon FSx for Windows File Server file system.

Type annotations and code completion for boto3.client("datasync").create_location_fsx_windows method. boto3 documentation

# create_location_fsx_windows method definition

def create_location_fsx_windows(
    self,
    *,
    FsxFilesystemArn: str,
    SecurityGroupArns: Sequence[str],
    User: str,
    Password: str,
    Subdirectory: str = ...,
    Tags: Sequence[TagListEntryTypeDef] = ...,  # (1)
    Domain: str = ...,
) -> CreateLocationFsxWindowsResponseTypeDef:  # (2)
    ...
  1. See TagListEntryTypeDef
  2. See CreateLocationFsxWindowsResponseTypeDef 
# create_location_fsx_windows method usage example with argument unpacking

kwargs: CreateLocationFsxWindowsRequestRequestTypeDef = {  # (1)
    "FsxFilesystemArn": ...,
    "SecurityGroupArns": ...,
    "User": ...,
    "Password": ...,
}

parent.create_location_fsx_windows(**kwargs)
  1. See CreateLocationFsxWindowsRequestRequestTypeDef

create_location_hdfs#

Creates an endpoint for a Hadoop Distributed File System (HDFS).

Type annotations and code completion for boto3.client("datasync").create_location_hdfs method. boto3 documentation

# create_location_hdfs method definition

def create_location_hdfs(
    self,
    *,
    NameNodes: Sequence[HdfsNameNodeTypeDef],  # (1)
    AuthenticationType: HdfsAuthenticationTypeType,  # (2)
    AgentArns: Sequence[str],
    Subdirectory: str = ...,
    BlockSize: int = ...,
    ReplicationFactor: int = ...,
    KmsKeyProviderUri: str = ...,
    QopConfiguration: QopConfigurationTypeDef = ...,  # (3)
    SimpleUser: str = ...,
    KerberosPrincipal: str = ...,
    KerberosKeytab: Union[str, bytes, IO[Any], StreamingBody] = ...,
    KerberosKrb5Conf: Union[str, bytes, IO[Any], StreamingBody] = ...,
    Tags: Sequence[TagListEntryTypeDef] = ...,  # (4)
) -> CreateLocationHdfsResponseTypeDef:  # (5)
    ...
  1. See HdfsNameNodeTypeDef
  2. See HdfsAuthenticationTypeType
  3. See QopConfigurationTypeDef
  4. See TagListEntryTypeDef
  5. See CreateLocationHdfsResponseTypeDef 
# create_location_hdfs method usage example with argument unpacking

kwargs: CreateLocationHdfsRequestRequestTypeDef = {  # (1)
    "NameNodes": ...,
    "AuthenticationType": ...,
    "AgentArns": ...,
}

parent.create_location_hdfs(**kwargs)
  1. See CreateLocationHdfsRequestRequestTypeDef

create_location_nfs#

Creates an endpoint for a Network File System (NFS) file server that DataSync can use for a data transfer.

Type annotations and code completion for boto3.client("datasync").create_location_nfs method. boto3 documentation

# create_location_nfs method definition

def create_location_nfs(
    self,
    *,
    Subdirectory: str,
    ServerHostname: str,
    OnPremConfig: OnPremConfigTypeDef,  # (1)
    MountOptions: NfsMountOptionsTypeDef = ...,  # (2)
    Tags: Sequence[TagListEntryTypeDef] = ...,  # (3)
) -> CreateLocationNfsResponseTypeDef:  # (4)
    ...
  1. See OnPremConfigTypeDef
  2. See NfsMountOptionsTypeDef
  3. See TagListEntryTypeDef
  4. See CreateLocationNfsResponseTypeDef 
# create_location_nfs method usage example with argument unpacking

kwargs: CreateLocationNfsRequestRequestTypeDef = {  # (1)
    "Subdirectory": ...,
    "ServerHostname": ...,
    "OnPremConfig": ...,
}

parent.create_location_nfs(**kwargs)
  1. See CreateLocationNfsRequestRequestTypeDef

create_location_object_storage#

Creates an endpoint for an object storage system that DataSync can access for a transfer.

Type annotations and code completion for boto3.client("datasync").create_location_object_storage method. boto3 documentation

# create_location_object_storage method definition

def create_location_object_storage(
    self,
    *,
    ServerHostname: str,
    BucketName: str,
    AgentArns: Sequence[str],
    ServerPort: int = ...,
    ServerProtocol: ObjectStorageServerProtocolType = ...,  # (1)
    Subdirectory: str = ...,
    AccessKey: str = ...,
    SecretKey: str = ...,
    Tags: Sequence[TagListEntryTypeDef] = ...,  # (2)
    ServerCertificate: Union[str, bytes, IO[Any], StreamingBody] = ...,
) -> CreateLocationObjectStorageResponseTypeDef:  # (3)
    ...
  1. See ObjectStorageServerProtocolType
  2. See TagListEntryTypeDef
  3. See CreateLocationObjectStorageResponseTypeDef 
# create_location_object_storage method usage example with argument unpacking

kwargs: CreateLocationObjectStorageRequestRequestTypeDef = {  # (1)
    "ServerHostname": ...,
    "BucketName": ...,
    "AgentArns": ...,
}

parent.create_location_object_storage(**kwargs)
  1. See CreateLocationObjectStorageRequestRequestTypeDef

create_location_s3#

A location is an endpoint for an Amazon S3 bucket.

Type annotations and code completion for boto3.client("datasync").create_location_s3 method. boto3 documentation

# create_location_s3 method definition

def create_location_s3(
    self,
    *,
    S3BucketArn: str,
    S3Config: S3ConfigTypeDef,  # (1)
    Subdirectory: str = ...,
    S3StorageClass: S3StorageClassType = ...,  # (2)
    AgentArns: Sequence[str] = ...,
    Tags: Sequence[TagListEntryTypeDef] = ...,  # (3)
) -> CreateLocationS3ResponseTypeDef:  # (4)
    ...
  1. See S3ConfigTypeDef
  2. See S3StorageClassType
  3. See TagListEntryTypeDef
  4. See CreateLocationS3ResponseTypeDef 
# create_location_s3 method usage example with argument unpacking

kwargs: CreateLocationS3RequestRequestTypeDef = {  # (1)
    "S3BucketArn": ...,
    "S3Config": ...,
}

parent.create_location_s3(**kwargs)
  1. See CreateLocationS3RequestRequestTypeDef

create_location_smb#

Creates an endpoint for a Server Message Block (SMB) file server that DataSync can use for a data transfer.

Type annotations and code completion for boto3.client("datasync").create_location_smb method. boto3 documentation

# create_location_smb method definition

def create_location_smb(
    self,
    *,
    Subdirectory: str,
    ServerHostname: str,
    User: str,
    Password: str,
    AgentArns: Sequence[str],
    Domain: str = ...,
    MountOptions: SmbMountOptionsTypeDef = ...,  # (1)
    Tags: Sequence[TagListEntryTypeDef] = ...,  # (2)
) -> CreateLocationSmbResponseTypeDef:  # (3)
    ...
  1. See SmbMountOptionsTypeDef
  2. See TagListEntryTypeDef
  3. See CreateLocationSmbResponseTypeDef 
# create_location_smb method usage example with argument unpacking

kwargs: CreateLocationSmbRequestRequestTypeDef = {  # (1)
    "Subdirectory": ...,
    "ServerHostname": ...,
    "User": ...,
    "Password": ...,
    "AgentArns": ...,
}

parent.create_location_smb(**kwargs)
  1. See CreateLocationSmbRequestRequestTypeDef

create_task#

Configures a transfer task, which defines where and how DataSync moves your data.

Type annotations and code completion for boto3.client("datasync").create_task method. boto3 documentation

# create_task method definition

def create_task(
    self,
    *,
    SourceLocationArn: str,
    DestinationLocationArn: str,
    CloudWatchLogGroupArn: str = ...,
    Name: str = ...,
    Options: OptionsTypeDef = ...,  # (1)
    Excludes: Sequence[FilterRuleTypeDef] = ...,  # (2)
    Schedule: TaskScheduleTypeDef = ...,  # (3)
    Tags: Sequence[TagListEntryTypeDef] = ...,  # (4)
    Includes: Sequence[FilterRuleTypeDef] = ...,  # (2)
    TaskReportConfig: TaskReportConfigTypeDef = ...,  # (6)
) -> CreateTaskResponseTypeDef:  # (7)
    ...
  1. See OptionsTypeDef
  2. See FilterRuleTypeDef
  3. See TaskScheduleTypeDef
  4. See TagListEntryTypeDef
  5. See FilterRuleTypeDef
  6. See TaskReportConfigTypeDef
  7. See CreateTaskResponseTypeDef 
# create_task method usage example with argument unpacking

kwargs: CreateTaskRequestRequestTypeDef = {  # (1)
    "SourceLocationArn": ...,
    "DestinationLocationArn": ...,
}

parent.create_task(**kwargs)
  1. See CreateTaskRequestRequestTypeDef

delete_agent#

Deletes an agent.

Type annotations and code completion for boto3.client("datasync").delete_agent method. boto3 documentation

# delete_agent method definition

def delete_agent(
    self,
    *,
    AgentArn: str,
) -> Dict[str, Any]:
    ...
# delete_agent method usage example with argument unpacking

kwargs: DeleteAgentRequestRequestTypeDef = {  # (1)
    "AgentArn": ...,
}

parent.delete_agent(**kwargs)
  1. See DeleteAgentRequestRequestTypeDef

delete_location#

Deletes the configuration of a location used by DataSync.

Type annotations and code completion for boto3.client("datasync").delete_location method. boto3 documentation

# delete_location method definition

def delete_location(
    self,
    *,
    LocationArn: str,
) -> Dict[str, Any]:
    ...
# delete_location method usage example with argument unpacking

kwargs: DeleteLocationRequestRequestTypeDef = {  # (1)
    "LocationArn": ...,
}

parent.delete_location(**kwargs)
  1. See DeleteLocationRequestRequestTypeDef

delete_task#

Deletes an DataSync transfer task.

Type annotations and code completion for boto3.client("datasync").delete_task method. boto3 documentation

# delete_task method definition

def delete_task(
    self,
    *,
    TaskArn: str,
) -> Dict[str, Any]:
    ...
# delete_task method usage example with argument unpacking

kwargs: DeleteTaskRequestRequestTypeDef = {  # (1)
    "TaskArn": ...,
}

parent.delete_task(**kwargs)
  1. See DeleteTaskRequestRequestTypeDef

describe_agent#

Returns metadata about an DataSync agent, such as its name, endpoint type, and status.

Type annotations and code completion for boto3.client("datasync").describe_agent method. boto3 documentation

# describe_agent method definition

def describe_agent(
    self,
    *,
    AgentArn: str,
) -> DescribeAgentResponseTypeDef:  # (1)
    ...
  1. See DescribeAgentResponseTypeDef 
# describe_agent method usage example with argument unpacking

kwargs: DescribeAgentRequestRequestTypeDef = {  # (1)
    "AgentArn": ...,
}

parent.describe_agent(**kwargs)
  1. See DescribeAgentRequestRequestTypeDef

describe_discovery_job#

Returns information about a DataSync discovery job.

Type annotations and code completion for boto3.client("datasync").describe_discovery_job method. boto3 documentation

# describe_discovery_job method definition

def describe_discovery_job(
    self,
    *,
    DiscoveryJobArn: str,
) -> DescribeDiscoveryJobResponseTypeDef:  # (1)
    ...
  1. See DescribeDiscoveryJobResponseTypeDef 
# describe_discovery_job method usage example with argument unpacking

kwargs: DescribeDiscoveryJobRequestRequestTypeDef = {  # (1)
    "DiscoveryJobArn": ...,
}

parent.describe_discovery_job(**kwargs)
  1. See DescribeDiscoveryJobRequestRequestTypeDef

describe_location_azure_blob#

Provides details about how an DataSync transfer location for Microsoft Azure Blob Storage is configured.

Type annotations and code completion for boto3.client("datasync").describe_location_azure_blob method. boto3 documentation

# describe_location_azure_blob method definition

def describe_location_azure_blob(
    self,
    *,
    LocationArn: str,
) -> DescribeLocationAzureBlobResponseTypeDef:  # (1)
    ...
  1. See DescribeLocationAzureBlobResponseTypeDef 
# describe_location_azure_blob method usage example with argument unpacking

kwargs: DescribeLocationAzureBlobRequestRequestTypeDef = {  # (1)
    "LocationArn": ...,
}

parent.describe_location_azure_blob(**kwargs)
  1. See DescribeLocationAzureBlobRequestRequestTypeDef

describe_location_efs#

Returns metadata about your DataSync location for an Amazon EFS file system.

Type annotations and code completion for boto3.client("datasync").describe_location_efs method. boto3 documentation

# describe_location_efs method definition

def describe_location_efs(
    self,
    *,
    LocationArn: str,
) -> DescribeLocationEfsResponseTypeDef:  # (1)
    ...
  1. See DescribeLocationEfsResponseTypeDef 
# describe_location_efs method usage example with argument unpacking

kwargs: DescribeLocationEfsRequestRequestTypeDef = {  # (1)
    "LocationArn": ...,
}

parent.describe_location_efs(**kwargs)
  1. See DescribeLocationEfsRequestRequestTypeDef

describe_location_fsx_lustre#

Provides details about how an DataSync location for an Amazon FSx for Lustre file system is configured.

Type annotations and code completion for boto3.client("datasync").describe_location_fsx_lustre method. boto3 documentation

# describe_location_fsx_lustre method definition

def describe_location_fsx_lustre(
    self,
    *,
    LocationArn: str,
) -> DescribeLocationFsxLustreResponseTypeDef:  # (1)
    ...
  1. See DescribeLocationFsxLustreResponseTypeDef 
# describe_location_fsx_lustre method usage example with argument unpacking

kwargs: DescribeLocationFsxLustreRequestRequestTypeDef = {  # (1)
    "LocationArn": ...,
}

parent.describe_location_fsx_lustre(**kwargs)
  1. See DescribeLocationFsxLustreRequestRequestTypeDef

describe_location_fsx_ontap#

Provides details about how an DataSync location for an Amazon FSx for NetApp ONTAP file system is configured.

Type annotations and code completion for boto3.client("datasync").describe_location_fsx_ontap method.