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

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.

Usage example

client = boto3.client("datasync")

try:
    do_something(client)
except (
    client.ClientError,
    client.InternalException,
    client.InvalidRequestException,
) as e:
    print(e)

Type checking example

from mypy_boto3_datasync.client import Exceptions

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

Methods

can_paginate

Check if an operation can be paginated.

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

Method definition

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

cancel_task_execution

Cancels execution of a task.

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

Method definition

def cancel_task_execution(
    self,
    *,
    TaskExecutionArn: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

Method definition

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

create_agent

Activates an DataSync agent that you have deployed on your host.

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

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

Usage example with kwargs

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

parent.create_agent(**kwargs)

1. See CreateAgentRequestRequestTypeDef

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

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

Usage example with kwargs

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

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

Usage example with kwargs

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

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

Usage example with kwargs

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.

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

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

Usage example with kwargs

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

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

Usage example with kwargs

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

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

Usage example with kwargs

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

parent.create_location_hdfs(**kwargs)

1. See CreateLocationHdfsRequestRequestTypeDef

create_location_nfs

Defines a file system on a Network File System (NFS) server that can be read from or written to.

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

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

Usage example with kwargs

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

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)
) -> CreateLocationObjectStorageResponseTypeDef:  # (3)
    ...

1. See ObjectStorageServerProtocolType
2. See TagListEntryTypeDef
3. See CreateLocationObjectStorageResponseTypeDef

Usage example with kwargs

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

parent.create_location_object_storage(**kwargs)

1. See CreateLocationObjectStorageRequestRequestTypeDef

create_location_s3

Creates an endpoint for an Amazon S3 bucket.

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

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

Usage example with kwargs

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

parent.create_location_s3(**kwargs)

1. See CreateLocationS3RequestRequestTypeDef

create_location_smb

Defines a file system on a Server Message Block (SMB) server that can be read from or written to.

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

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

Usage example with kwargs

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

parent.create_location_smb(**kwargs)

1. See CreateLocationSmbRequestRequestTypeDef

create_task

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

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

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)
) -> CreateTaskResponseTypeDef:  # (6)
    ...

1. See OptionsTypeDef
2. See FilterRuleTypeDef
3. See TaskScheduleTypeDef
4. See TagListEntryTypeDef
5. See FilterRuleTypeDef
6. See CreateTaskResponseTypeDef

Usage example with kwargs

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

Method definition

def delete_agent(
    self,
    *,
    AgentArn: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

Method definition

def delete_location(
    self,
    *,
    LocationArn: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

parent.delete_location(**kwargs)

1. See DeleteLocationRequestRequestTypeDef

delete_task

Deletes a task.

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

Method definition

def delete_task(
    self,
    *,
    TaskArn: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

parent.delete_task(**kwargs)

1. See DeleteTaskRequestRequestTypeDef

describe_agent

Returns metadata such as the name, the network interfaces, and the status (that is, whether the agent is running or not) for an agent.

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

Method definition

def describe_agent(
    self,
    *,
    AgentArn: str,
) -> DescribeAgentResponseTypeDef:  # (1)
    ...

1. See DescribeAgentResponseTypeDef

Usage example with kwargs

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

parent.describe_agent(**kwargs)

1. See DescribeAgentRequestRequestTypeDef

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

Method definition

def describe_location_efs(
    self,
    *,
    LocationArn: str,
) -> DescribeLocationEfsResponseTypeDef:  # (1)
    ...

1. See DescribeLocationEfsResponseTypeDef

Usage example with kwargs

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

parent.describe_location_efs(**kwargs)

1. See DescribeLocationEfsRequestRequestTypeDef

describe_location_fsx_lustre

Returns metadata about an Amazon FSx for Lustre location, such as information about its path.

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

Method definition

def describe_location_fsx_lustre(
    self,
    *,
    LocationArn: str,
) -> DescribeLocationFsxLustreResponseTypeDef:  # (1)
    ...

1. See DescribeLocationFsxLustreResponseTypeDef

Usage example with kwargs

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. boto3 documentation

Method definition

def describe_location_fsx_ontap(
    self,
    *,
    LocationArn: str,
) -> DescribeLocationFsxOntapResponseTypeDef:  # (1)
    ...

1. See DescribeLocationFsxOntapResponseTypeDef

Usage example with kwargs

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

parent.describe_location_fsx_ontap(**kwargs)

1. See DescribeLocationFsxOntapRequestRequestTypeDef

describe_location_fsx_open_zfs

Returns metadata about an Amazon FSx for OpenZFS location, such as information about its path.

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

Method definition

def describe_location_fsx_open_zfs(
    self,
    *,
    LocationArn: str,
) -> DescribeLocationFsxOpenZfsResponseTypeDef:  # (1)
    ...

1. See DescribeLocationFsxOpenZfsResponseTypeDef

Usage example with kwargs

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

parent.describe_location_fsx_open_zfs(**kwargs)

1. See DescribeLocationFsxOpenZfsRequestRequestTypeDef

describe_location_fsx_windows

Returns metadata about an Amazon FSx for Windows File Server location, such as information about its path.

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

Method definition

def describe_location_fsx_windows(
    self,
    *,
    LocationArn: str,
) -> DescribeLocationFsxWindowsResponseTypeDef:  # (1)
    ...

1. See DescribeLocationFsxWindowsResponseTypeDef

Usage example with kwargs

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

parent.describe_location_fsx_windows(**kwargs)

1. See DescribeLocationFsxWindowsRequestRequestTypeDef

describe_location_hdfs

Returns metadata, such as the authentication information about the Hadoop Distributed File System (HDFS) location.

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

Method definition

def describe_location_hdfs(
    self,
    *,
    LocationArn: str,
) -> DescribeLocationHdfsResponseTypeDef:  # (1)
    ...

1. See DescribeLocationHdfsResponseTypeDef

Usage example with kwargs

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

parent.describe_location_hdfs(**kwargs)

1. See DescribeLocationHdfsRequestRequestTypeDef

describe_location_nfs

Returns metadata, such as the path information, about an NFS location.

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

Method definition

def describe_location_nfs(
    self,
    *,
    LocationArn: str,
) -> DescribeLocationNfsResponseTypeDef:  # (1)
    ...

1. See DescribeLocationNfsResponseTypeDef

Usage example with kwargs

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

parent.describe_location_nfs(**kwargs)

1. See DescribeLocationNfsRequestRequestTypeDef

describe_location_object_storage

Returns metadata about your DataSync location for an object storage system.

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

Method definition

def describe_location_object_storage(
    self,
    *,
    LocationArn: str,
) -> DescribeLocationObjectStorageResponseTypeDef:  # (1)
    ...

1. See DescribeLocationObjectStorageResponseTypeDef

Usage example with kwargs

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

parent.describe_location_object_storage(**kwargs)

1. See DescribeLocationObjectStorageRequestRequestTypeDef

describe_location_s3

Returns metadata, such as bucket name, about an Amazon S3 bucket location.

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

Method definition

def describe_location_s3(
    self,
    *,
    LocationArn: str,
) -> DescribeLocationS3ResponseTypeDef:  # (1)
    ...

1. See DescribeLocationS3ResponseTypeDef

Usage example with kwargs

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

parent.describe_location_s3(**kwargs)

1. See DescribeLocationS3RequestRequestTypeDef

describe_location_smb

Returns metadata, such as the path and user information about an SMB location.

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

Method definition

def describe_location_smb(
    self,
    *,
    LocationArn: str,
) -> DescribeLocationSmbResponseTypeDef:  # (1)
    ...

1. See DescribeLocationSmbResponseTypeDef

Usage example with kwargs

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

parent.describe_location_smb(**kwargs)

1. See DescribeLocationSmbRequestRequestTypeDef

describe_task

Returns metadata about a task.

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

Method definition

def describe_task(
    self,
    *,
    TaskArn: str,
) -> DescribeTaskResponseTypeDef:  # (1)
    ...

1. See DescribeTaskResponseTypeDef

Usage example with kwargs

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

parent.describe_task(**kwargs)

1. See DescribeTaskRequestRequestTypeDef

describe_task_execution

Returns detailed metadata about a task that is being executed.

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

Method definition

def describe_task_execution(
    self,
    *,
    TaskExecutionArn: str,
) -> DescribeTaskExecutionResponseTypeDef:  # (1)
    ...

1. See DescribeTaskExecutionResponseTypeDef

Usage example with kwargs

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

parent.describe_task_execution(**kwargs)

1. See DescribeTaskExecutionRequestRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

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

Method definition

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

list_agents

Returns a list of agents owned by an Amazon Web Services account in the Amazon Web Services Region specified in the request.

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

Method definition

def list_agents(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListAgentsResponseTypeDef:  # (1)
    ...

1. See ListAgentsResponseTypeDef

Usage example with kwargs

kwargs: ListAgentsRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_agents(**kwargs)

1. See ListAgentsRequestRequestTypeDef

list_locations

Returns a list of source and destination locations.

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

Method definition

def list_locations(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
    Filters: Sequence[LocationFilterTypeDef] = ...,  # (1)
) -> ListLocationsResponseTypeDef:  # (2)
    ...

1. See LocationFilterTypeDef
2. See ListLocationsResponseTypeDef

Usage example with kwargs

kwargs: ListLocationsRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_locations(**kwargs)

1. See ListLocationsRequestRequestTypeDef

list_tags_for_resource

Returns all the tags associated with a specified resource.

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

Method definition

def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

Usage example with kwargs

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

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestRequestTypeDef

list_task_executions

Returns a list of executed tasks.

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

Method definition

def list_task_executions(
    self,
    *,
    TaskArn: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListTaskExecutionsResponseTypeDef:  # (1)
    ...

1. See ListTaskExecutionsResponseTypeDef

Usage example with kwargs

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

parent.list_task_executions(**kwargs)

1. See ListTaskExecutionsRequestRequestTypeDef

list_tasks

Returns a list of the DataSync tasks you created.

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

Method definition

def list_tasks(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
    Filters: Sequence[TaskFilterTypeDef] = ...,  # (1)
) -> ListTasksResponseTypeDef:  # (2)
    ...

1. See TaskFilterTypeDef
2. See ListTasksResponseTypeDef

Usage example with kwargs

kwargs: ListTasksRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_tasks(**kwargs)

1. See ListTasksRequestRequestTypeDef

start_task_execution

Starts a specific invocation of a task.

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

Method definition

def start_task_execution(
    self,
    *,
    TaskArn: str,
    OverrideOptions: OptionsTypeDef = ...,  # (1)
    Includes: Sequence[FilterRuleTypeDef] = ...,  # (2)
    Excludes: Sequence[FilterRuleTypeDef] = ...,  # (2)
) -> StartTaskExecutionResponseTypeDef:  # (4)
    ...

1. See OptionsTypeDef
2. See FilterRuleTypeDef
3. See FilterRuleTypeDef
4. See StartTaskExecutionResponseTypeDef

Usage example with kwargs

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

parent.start_task_execution(**kwargs)

1. See StartTaskExecutionRequestRequestTypeDef

tag_resource

Applies a key-value pair to an Amazon Web Services resource.

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

Method definition

def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Sequence[TagListEntryTypeDef],  # (1)
) -> Dict[str, Any]:
    ...

1. See TagListEntryTypeDef

Usage example with kwargs

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestRequestTypeDef

untag_resource

Removes a tag from an Amazon Web Services resource.

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

Method definition

def untag_resource(
    self,
    *,
    ResourceArn: str,
    Keys: Sequence[str],
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Keys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestRequestTypeDef

update_agent

Updates the name of an agent.

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

Method definition

def update_agent(
    self,
    *,
    AgentArn: str,
    Name: str = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

parent.update_agent(**kwargs)

1. See UpdateAgentRequestRequestTypeDef

update_location_hdfs

Updates some parameters of a previously created location for a Hadoop Distributed File System cluster.

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

Method definition

def update_location_hdfs(
    self,
    *,
    LocationArn: str,
    Subdirectory: str = ...,
    NameNodes: Sequence[HdfsNameNodeTypeDef] = ...,  # (1)
    BlockSize: int = ...,
    ReplicationFactor: int = ...,
    KmsKeyProviderUri: str = ...,
    QopConfiguration: QopConfigurationTypeDef = ...,  # (2)
    AuthenticationType: HdfsAuthenticationTypeType = ...,  # (3)
    SimpleUser: str = ...,
    KerberosPrincipal: str = ...,
    KerberosKeytab: Union[str, bytes, IO[Any], StreamingBody] = ...,
    KerberosKrb5Conf: Union[str, bytes, IO[Any], StreamingBody] = ...,
    AgentArns: Sequence[str] = ...,
) -> Dict[str, Any]:
    ...

1. See HdfsNameNodeTypeDef
2. See QopConfigurationTypeDef
3. See HdfsAuthenticationTypeType

Usage example with kwargs

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

parent.update_location_hdfs(**kwargs)

1. See UpdateLocationHdfsRequestRequestTypeDef

update_location_nfs

Updates some of the parameters of a previously created location for Network File System (NFS) access.

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

Method definition

def update_location_nfs(
    self,
    *,
    LocationArn: str,
    Subdirectory: str = ...,
    OnPremConfig: OnPremConfigTypeDef = ...,  # (1)
    MountOptions: NfsMountOptionsTypeDef = ...,  # (2)
) -> Dict[str, Any]:
    ...

1. See OnPremConfigTypeDef
2. See NfsMountOptionsTypeDef

Usage example with kwargs

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

parent.update_location_nfs(**kwargs)

1. See UpdateLocationNfsRequestRequestTypeDef

update_location_object_storage

Updates some of the parameters of a previously created location for self-managed object storage server access.

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

Method definition

def update_location_object_storage(
    self,
    *,
    LocationArn: str,
    ServerPort: int = ...,
    ServerProtocol: ObjectStorageServerProtocolType = ...,  # (1)
    Subdirectory: str = ...,
    AccessKey: str = ...,
    SecretKey: str = ...,
    AgentArns: Sequence[str] = ...,
) -> Dict[str, Any]:
    ...

1. See ObjectStorageServerProtocolType

Usage example with kwargs

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

parent.update_location_object_storage(**kwargs)

1. See UpdateLocationObjectStorageRequestRequestTypeDef

update_location_smb

Updates some of the parameters of a previously created location for Server Message Block (SMB) file system access.

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

Method definition

def update_location_smb(
    self,
    *,
    LocationArn: str,
    Subdirectory: str = ...,
    User: str = ...,
    Domain: str = ...,
    Password: str = ...,
    AgentArns: Sequence[str] = ...,
    MountOptions: SmbMountOptionsTypeDef = ...,  # (1)
) -> Dict[str, Any]:
    ...

1. See SmbMountOptionsTypeDef

Usage example with kwargs

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

parent.update_location_smb(**kwargs)

1. See UpdateLocationSmbRequestRequestTypeDef

update_task

Updates the metadata associated with a task.

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

Method definition

def update_task(
    self,
    *,
    TaskArn: str,
    Options: OptionsTypeDef = ...,  # (1)
    Excludes: Sequence[FilterRuleTypeDef] = ...,  # (2)
    Schedule: TaskScheduleTypeDef = ...,  # (3)
    Name: str = ...,
    CloudWatchLogGroupArn: str = ...,
    Includes: Sequence[FilterRuleTypeDef] = ...,  # (2)
) -> Dict[str, Any]:
    ...

1. See OptionsTypeDef
2. See FilterRuleTypeDef
3. See TaskScheduleTypeDef
4. See FilterRuleTypeDef

Usage example with kwargs

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

parent.update_task(**kwargs)

1. See UpdateTaskRequestRequestTypeDef

update_task_execution

Updates execution of a task.

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

Method definition

def update_task_execution(
    self,
    *,
    TaskExecutionArn: str,
    Options: OptionsTypeDef,  # (1)
) -> Dict[str, Any]:
    ...

1. See OptionsTypeDef

Usage example with kwargs

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

parent.update_task_execution(**kwargs)

1. See UpdateTaskExecutionRequestRequestTypeDef

get_paginator

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

• client.get_paginator("list_agents") -> ListAgentsPaginator
• client.get_paginator("list_locations") -> ListLocationsPaginator
• client.get_paginator("list_tags_for_resource") -> ListTagsForResourcePaginator
• client.get_paginator("list_task_executions") -> ListTaskExecutionsPaginator
• client.get_paginator("list_tasks") -> ListTasksPaginator