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#

can_paginate#

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

generate_presigned_url#

Type annotations and code completion for boto3.client("datasync").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:
    ...

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 Sequence[TagListEntryTypeDef]
  5. See AddStorageSystemResponseTypeDef
# add_storage_system method usage example with argument unpacking

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

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

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: CancelTaskExecutionRequestTypeDef = {  # (1)
    "TaskExecutionArn": ...,
}

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

create_agent#

Activates an DataSync agent that you deploy 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 Sequence[TagListEntryTypeDef]
  2. See CreateAgentResponseTypeDef
# create_agent method usage example with argument unpacking

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

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

create_location_azure_blob#

Creates a transfer location for a Microsoft Azure Blob Storage container.

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 Sequence[TagListEntryTypeDef]
  6. See CreateLocationAzureBlobResponseTypeDef
# create_location_azure_blob method usage example with argument unpacking

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

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

create_location_efs#

Creates a transfer location for an Amazon EFS file system.

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: Ec2ConfigUnionTypeDef,  # (1)
    Subdirectory: str = ...,
    Tags: Sequence[TagListEntryTypeDef] = ...,  # (2)
    AccessPointArn: str = ...,
    FileSystemAccessRoleArn: str = ...,
    InTransitEncryption: EfsInTransitEncryptionType = ...,  # (3)
) -> CreateLocationEfsResponseTypeDef:  # (4)
    ...
  1. See Ec2ConfigUnionTypeDef
  2. See Sequence[TagListEntryTypeDef]
  3. See EfsInTransitEncryptionType
  4. See CreateLocationEfsResponseTypeDef
# create_location_efs method usage example with argument unpacking

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

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

create_location_fsx_lustre#

Creates a transfer location 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 Sequence[TagListEntryTypeDef]
  2. See CreateLocationFsxLustreResponseTypeDef
# create_location_fsx_lustre method usage example with argument unpacking

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

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

create_location_fsx_ontap#

Creates a transfer location for an Amazon FSx for NetApp ONTAP file system.

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 Sequence[TagListEntryTypeDef]
  3. See CreateLocationFsxOntapResponseTypeDef
# create_location_fsx_ontap method usage example with argument unpacking

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

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

create_location_fsx_open_zfs#

Creates a transfer location 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

# 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 Sequence[TagListEntryTypeDef]
  3. See CreateLocationFsxOpenZfsResponseTypeDef
# create_location_fsx_open_zfs method usage example with argument unpacking

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

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

create_location_fsx_windows#

Creates a transfer location 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 Sequence[TagListEntryTypeDef]
  2. See CreateLocationFsxWindowsResponseTypeDef
# create_location_fsx_windows method usage example with argument unpacking

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

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

create_location_hdfs#

Creates a transfer location 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: BlobTypeDef = ...,
    KerberosKrb5Conf: BlobTypeDef = ...,
    Tags: Sequence[TagListEntryTypeDef] = ...,  # (4)
) -> CreateLocationHdfsResponseTypeDef:  # (5)
    ...
  1. See Sequence[HdfsNameNodeTypeDef]
  2. See HdfsAuthenticationTypeType
  3. See QopConfigurationTypeDef
  4. See Sequence[TagListEntryTypeDef]
  5. See CreateLocationHdfsResponseTypeDef
# create_location_hdfs method usage example with argument unpacking

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

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

create_location_nfs#

Creates a transfer location for a Network File System (NFS) file server.

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: OnPremConfigUnionTypeDef,  # (1)
    MountOptions: NfsMountOptionsTypeDef = ...,  # (2)
    Tags: Sequence[TagListEntryTypeDef] = ...,  # (3)
) -> CreateLocationNfsResponseTypeDef:  # (4)
    ...
  1. See OnPremConfigUnionTypeDef
  2. See NfsMountOptionsTypeDef
  3. See Sequence[TagListEntryTypeDef]
  4. See CreateLocationNfsResponseTypeDef
# create_location_nfs method usage example with argument unpacking

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

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

create_location_object_storage#

Creates a transfer location for an object storage system.

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: BlobTypeDef = ...,
) -> CreateLocationObjectStorageResponseTypeDef:  # (3)
    ...
  1. See ObjectStorageServerProtocolType
  2. See Sequence[TagListEntryTypeDef]
  3. See CreateLocationObjectStorageResponseTypeDef
# create_location_object_storage method usage example with argument unpacking

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

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

create_location_s3#

Creates a transfer location 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 Sequence[TagListEntryTypeDef]
  4. See CreateLocationS3ResponseTypeDef
# create_location_s3 method usage example with argument unpacking

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

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

create_location_smb#

Creates a transfer location for a Server Message Block (SMB) file server.

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,
    AgentArns: Sequence[str],
    User: str = ...,
    Domain: str = ...,
    Password: str = ...,
    MountOptions: SmbMountOptionsTypeDef = ...,  # (1)
    Tags: Sequence[TagListEntryTypeDef] = ...,  # (2)
    AuthenticationType: SmbAuthenticationTypeType = ...,  # (3)
    DnsIpAddresses: Sequence[str] = ...,
    KerberosPrincipal: str = ...,
    KerberosKeytab: BlobTypeDef = ...,
    KerberosKrb5Conf: BlobTypeDef = ...,
) -> CreateLocationSmbResponseTypeDef:  # (4)
    ...
  1. See SmbMountOptionsTypeDef
  2. See Sequence[TagListEntryTypeDef]
  3. See SmbAuthenticationTypeType
  4. See CreateLocationSmbResponseTypeDef
# create_location_smb method usage example with argument unpacking

kwargs: CreateLocationSmbRequestTypeDef = {  # (1)
    "Subdirectory": ...,
    "ServerHostname": ...,
    "AgentArns": ...,
}

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

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

# 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)
    ManifestConfig: ManifestConfigTypeDef = ...,  # (6)
    TaskReportConfig: TaskReportConfigTypeDef = ...,  # (7)
    TaskMode: TaskModeType = ...,  # (8)
) -> CreateTaskResponseTypeDef:  # (9)
    ...
  1. See OptionsTypeDef
  2. See Sequence[FilterRuleTypeDef]
  3. See TaskScheduleTypeDef
  4. See Sequence[TagListEntryTypeDef]
  5. See Sequence[FilterRuleTypeDef]
  6. See ManifestConfigTypeDef
  7. See TaskReportConfigTypeDef
  8. See TaskModeType
  9. See CreateTaskResponseTypeDef
# create_task method usage example with argument unpacking

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

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

delete_agent#

Removes an DataSync agent resource from your Amazon Web Services account.

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: DeleteAgentRequestTypeDef = {  # (1)
    "AgentArn": ...,
}

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

delete_location#

Deletes a transfer location resource from 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: DeleteLocationRequestTypeDef = {  # (1)
    "LocationArn": ...,
}

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

delete_task#

Deletes a transfer task resource from DataSync.

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: DeleteTaskRequestTypeDef = {  # (1)
    "TaskArn": ...,
}

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

describe_agent#

Returns information about an DataSync agent, such as its name, service 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: DescribeAgentRequestTypeDef = {  # (1)
    "AgentArn": ...,
}

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

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: DescribeDiscoveryJobRequestTypeDef = {  # (1)
    "DiscoveryJobArn": ...,
}

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

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: DescribeLocationAzureBlobRequestTypeDef = {  # (1)
    "LocationArn": ...,
}

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

describe_location_efs#

Provides details about how an DataSync transfer location for an Amazon EFS file system is configured.

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: DescribeLocationEfsRequestTypeDef = {  # (1)
    "LocationArn": ...,
}

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

describe_location_fsx_lustre#

Provides details about how an DataSync transfer 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: DescribeLocationFsxLustreRequestTypeDef = {  # (1)
    "LocationArn": ...,
}

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

describe_location_fsx_ontap#

Provides details about how an DataSync transfer 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

# describe_location_fsx_ontap method definition

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

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

parent.describe_location_fsx_ontap(**kwargs)
  1. See DescribeLocationFsxOntapRequestTypeDef

describe_location_fsx_open_zfs#

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

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

# describe_location_fsx_open_zfs method definition

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

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

parent.describe_location_fsx_open_zfs(**kwargs)
  1. See DescribeLocationFsxOpenZfsRequestTypeDef

describe_location_fsx_windows#

Provides details about how an DataSync transfer location for an Amazon FSx for Windows File Server file system is configured.

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

# describe_location_fsx_windows method definition

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

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

parent.describe_location_fsx_windows(**kwargs)
  1. See DescribeLocationFsxWindowsRequestTypeDef

describe_location_hdfs#

Provides details about how an DataSync transfer location for a Hadoop Distributed File System (HDFS) is configured.

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

# describe_location_hdfs method definition

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

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

parent.describe_location_hdfs(**kwargs)
  1. See DescribeLocationHdfsRequestTypeDef

describe_location_nfs#

Provides details about how an DataSync transfer location for a Network File System (NFS) file server is configured.

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

# describe_location_nfs method definition

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

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

parent.describe_location_nfs(**kwargs)
  1. See DescribeLocationNfsRequestTypeDef

describe_location_object_storage#

Provides details about how an DataSync transfer location for an object storage system is configured.

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

# describe_location_object_storage method definition

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

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

parent.describe_location_object_storage(**kwargs)
  1. See DescribeLocationObjectStorageRequestTypeDef

describe_location_s3#

Provides details about how an DataSync transfer location for an S3 bucket is configured.

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

# describe_location_s3 method definition

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

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

parent.describe_location_s3(**kwargs)
  1. See DescribeLocationS3RequestTypeDef

describe_location_smb#

Provides details about how an DataSync transfer location for a Server Message Block (SMB) file server is configured.

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

# describe_location_smb method definition

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

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

parent.describe_location_smb(**kwargs)
  1. See DescribeLocationSmbRequestTypeDef

describe_storage_system#

Returns information about an on-premises storage system that you're using with DataSync Discovery.

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

# describe_storage_system method definition

def describe_storage_system(
    self,
    *,
    StorageSystemArn: str,
) -> DescribeStorageSystemResponseTypeDef:  # (1)
    ...
  1. See DescribeStorageSystemResponseTypeDef
# describe_storage_system method usage example with argument unpacking

kwargs: DescribeStorageSystemRequestTypeDef = {  # (1)
    "StorageSystemArn": ...,
}

parent.describe_storage_system(**kwargs)
  1. See DescribeStorageSystemRequestTypeDef

describe_storage_system_resource_metrics#

Returns information, including performance data and capacity usage, which DataSync Discovery collects about a specific resource in your-premises storage system.

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

# describe_storage_system_resource_metrics method definition

def describe_storage_system_resource_metrics(
    self,
    *,
    DiscoveryJobArn: str,
    ResourceType: DiscoveryResourceTypeType,  # (1)
    ResourceId: str,
    StartTime: TimestampTypeDef = ...,
    EndTime: TimestampTypeDef = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeStorageSystemResourceMetricsResponseTypeDef:  # (2)
    ...
  1. See DiscoveryResourceTypeType
  2. See DescribeStorageSystemResourceMetricsResponseTypeDef
# describe_storage_system_resource_metrics method usage example with argument unpacking

kwargs: DescribeStorageSystemResourceMetricsRequestTypeDef = {  # (1)
    "DiscoveryJobArn": ...,
    "ResourceType": ...,
    "ResourceId": ...,
}

parent.describe_storage_system_resource_metrics(**kwargs)
  1. See DescribeStorageSystemResourceMetricsRequestTypeDef

describe_storage_system_resources#

Returns information that DataSync Discovery collects about resources in your on-premises storage system.

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

# describe_storage_system_resources method definition

def describe_storage_system_resources(
    self,
    *,
    DiscoveryJobArn: str,
    ResourceType: DiscoveryResourceTypeType,  # (1)
    ResourceIds: Sequence[str] = ...,
    Filter: Mapping[DiscoveryResourceFilterType, Sequence[str]] = ...,  # (2)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeStorageSystemResourcesResponseTypeDef:  # (3)
    ...
  1. See DiscoveryResourceTypeType
  2. See Mapping[Literal['SVM'], Sequence[str]]
  3. See DescribeStorageSystemResourcesResponseTypeDef
# describe_storage_system_resources method usage example with argument unpacking

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

parent.describe_storage_system_resources(**kwargs)
  1. See DescribeStorageSystemResourcesRequestTypeDef

describe_task#

Provides information about a task, which defines where and how DataSync transfers your data.

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

# describe_task method definition

def describe_task(
    self,
    *,
    TaskArn: str,
) -> DescribeTaskResponseTypeDef:  # (1)
    ...
  1. See DescribeTaskResponseTypeDef
# describe_task method usage example with argument unpacking

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

parent.describe_task(**kwargs)
  1. See DescribeTaskRequestTypeDef

describe_task_execution#

Provides information about an execution of your DataSync task.

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

# describe_task_execution method definition

def describe_task_execution(
    self,
    *,
    TaskExecutionArn: str,
) -> DescribeTaskExecutionResponseTypeDef:  # (1)
    ...
  1. See DescribeTaskExecutionResponseTypeDef
# describe_task_execution method usage example with argument unpacking

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

parent.describe_task_execution(**kwargs)
  1. See DescribeTaskExecutionRequestTypeDef

generate_recommendations#

Creates recommendations about where to migrate your data to in Amazon Web Services.

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

# generate_recommendations method definition

def generate_recommendations(
    self,
    *,
    DiscoveryJobArn: str,
    ResourceIds: Sequence[str],
    ResourceType: DiscoveryResourceTypeType,  # (1)
) -> Dict[str, Any]:
    ...
  1. See DiscoveryResourceTypeType
# generate_recommendations method usage example with argument unpacking

kwargs: GenerateRecommendationsRequestTypeDef = {  # (1)
    "DiscoveryJobArn": ...,
    "ResourceIds": ...,
    "ResourceType": ...,
}

parent.generate_recommendations(**kwargs)
  1. See GenerateRecommendationsRequestTypeDef

list_agents#

Returns a list of DataSync agents that belong to 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

# list_agents method definition

def list_agents(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListAgentsResponseTypeDef:  # (1)
    ...
  1. See ListAgentsResponseTypeDef
# list_agents method usage example with argument unpacking

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

parent.list_agents(**kwargs)
  1. See ListAgentsRequestTypeDef

list_discovery_jobs#

Provides a list of the existing discovery jobs in the Amazon Web Services Region and Amazon Web Services account where you're using DataSync Discovery.

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

# list_discovery_jobs method definition

def list_discovery_jobs(
    self,
    *,
    StorageSystemArn: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListDiscoveryJobsResponseTypeDef:  # (1)
    ...
  1. See ListDiscoveryJobsResponseTypeDef
# list_discovery_jobs method usage example with argument unpacking

kwargs: ListDiscoveryJobsRequestTypeDef = {  # (1)
    "StorageSystemArn": ...,
}

parent.list_discovery_jobs(**kwargs)
  1. See ListDiscoveryJobsRequestTypeDef

list_locations#

Returns a list of source and destination locations.

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

# list_locations method definition

def list_locations(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
    Filters: Sequence[LocationFilterTypeDef] = ...,  # (1)
) -> ListLocationsResponseTypeDef:  # (2)
    ...
  1. See Sequence[LocationFilterTypeDef]
  2. See ListLocationsResponseTypeDef
# list_locations method usage example with argument unpacking

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

parent.list_locations(**kwargs)
  1. See ListLocationsRequestTypeDef

list_storage_systems#

Lists the on-premises storage systems that you're using with DataSync Discovery.

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

# list_storage_systems method definition

def list_storage_systems(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListStorageSystemsResponseTypeDef:  # (1)
    ...
  1. See ListStorageSystemsResponseTypeDef
# list_storage_systems method usage example with argument unpacking

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

parent.list_storage_systems(**kwargs)
  1. See ListStorageSystemsRequestTypeDef

list_tags_for_resource#

Returns all the tags associated with an Amazon Web Services resource.

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

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef
# list_tags_for_resource method usage example with argument unpacking

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

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

list_task_executions#

Returns a list of executions for an DataSync transfer task.

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

# list_task_executions method definition

def list_task_executions(
    self,
    *,
    TaskArn: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListTaskExecutionsResponseTypeDef:  # (1)
    ...
  1. See ListTaskExecutionsResponseTypeDef
# list_task_executions method usage example with argument unpacking

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

parent.list_task_executions(**kwargs)
  1. See ListTaskExecutionsRequestTypeDef

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

# list_tasks method definition

def list_tasks(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
    Filters: Sequence[TaskFilterTypeDef] = ...,  # (1)
) -> ListTasksResponseTypeDef:  # (2)
    ...
  1. See Sequence[TaskFilterTypeDef]
  2. See ListTasksResponseTypeDef
# list_tasks method usage example with argument unpacking

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

parent.list_tasks(**kwargs)
  1. See ListTasksRequestTypeDef

remove_storage_system#

Permanently removes a storage system resource from DataSync Discovery, including the associated discovery jobs, collected data, and recommendations.

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

# remove_storage_system method definition

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

kwargs: RemoveStorageSystemRequestTypeDef = {  # (1)
    "StorageSystemArn": ...,
}

parent.remove_storage_system(**kwargs)
  1. See RemoveStorageSystemRequestTypeDef

start_discovery_job#

Runs a DataSync discovery job on your on-premises storage system.

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

# start_discovery_job method definition

def start_discovery_job(
    self,
    *,
    StorageSystemArn: str,
    CollectionDurationMinutes: int,
    ClientToken: str,
    Tags: Sequence[TagListEntryTypeDef] = ...,  # (1)
) -> StartDiscoveryJobResponseTypeDef:  # (2)
    ...
  1. See Sequence[TagListEntryTypeDef]
  2. See StartDiscoveryJobResponseTypeDef
# start_discovery_job method usage example with argument unpacking

kwargs: StartDiscoveryJobRequestTypeDef = {  # (1)
    "StorageSystemArn": ...,
    "CollectionDurationMinutes": ...,
    "ClientToken": ...,
}

parent.start_discovery_job(**kwargs)
  1. See StartDiscoveryJobRequestTypeDef

start_task_execution#

Starts an DataSync transfer task.

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

# start_task_execution method definition

def start_task_execution(
    self,
    *,
    TaskArn: str,
    OverrideOptions: OptionsTypeDef = ...,  # (1)
    Includes: Sequence[FilterRuleTypeDef] = ...,  # (2)
    Excludes: Sequence[FilterRuleTypeDef] = ...,  # (2)
    ManifestConfig: ManifestConfigTypeDef = ...,  # (4)
    TaskReportConfig: TaskReportConfigTypeDef = ...,  # (5)
    Tags: Sequence[TagListEntryTypeDef] = ...,  # (6)
) -> StartTaskExecutionResponseTypeDef:  # (7)
    ...
  1. See OptionsTypeDef
  2. See Sequence[FilterRuleTypeDef]
  3. See Sequence[FilterRuleTypeDef]
  4. See ManifestConfigTypeDef
  5. See TaskReportConfigTypeDef
  6. See Sequence[TagListEntryTypeDef]
  7. See StartTaskExecutionResponseTypeDef
# start_task_execution method usage example with argument unpacking

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

parent.start_task_execution(**kwargs)
  1. See StartTaskExecutionRequestTypeDef

stop_discovery_job#

Stops a running DataSync discovery job.

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

# stop_discovery_job method definition

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

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

parent.stop_discovery_job(**kwargs)
  1. See StopDiscoveryJobRequestTypeDef

tag_resource#

Applies a tag to an Amazon Web Services resource.

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

# tag_resource method definition

def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Sequence[TagListEntryTypeDef],  # (1)
) -> Dict[str, Any]:
    ...
  1. See Sequence[TagListEntryTypeDef]
# tag_resource method usage example with argument unpacking

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

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

untag_resource#

Removes tags from an Amazon Web Services resource.

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

# untag_resource method definition

def untag_resource(
    self,
    *,
    ResourceArn: str,
    Keys: Sequence[str],
) -> Dict[str, Any]:
    ...
# untag_resource method usage example with argument unpacking

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

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

update_agent#

Updates the name of an DataSync agent.

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

# update_agent method definition

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

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

parent.update_agent(**kwargs)
  1. See UpdateAgentRequestTypeDef

update_discovery_job#

Edits a DataSync discovery job configuration.

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

# update_discovery_job method definition

def update_discovery_job(
    self,
    *,
    DiscoveryJobArn: str,
    CollectionDurationMinutes: int,
) -> Dict[str, Any]:
    ...
# update_discovery_job method usage example with argument unpacking

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

parent.update_discovery_job(**kwargs)
  1. See UpdateDiscoveryJobRequestTypeDef

update_location_azure_blob#

Modifies the following configurations of the Microsoft Azure Blob Storage transfer location that you're using with DataSync.

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

# update_location_azure_blob method definition

def update_location_azure_blob(
    self,
    *,
    LocationArn: str,
    Subdirectory: str = ...,
    AuthenticationType: AzureBlobAuthenticationTypeType = ...,  # (1)
    SasConfiguration: AzureBlobSasConfigurationTypeDef = ...,  # (2)
    BlobType: AzureBlobTypeType = ...,  # (3)
    AccessTier: AzureAccessTierType = ...,  # (4)
    AgentArns: Sequence[str] = ...,
) -> Dict[str, Any]:
    ...
  1. See AzureBlobAuthenticationTypeType
  2. See AzureBlobSasConfigurationTypeDef
  3. See AzureBlobTypeType
  4. See AzureAccessTierType
# update_location_azure_blob method usage example with argument unpacking

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

parent.update_location_azure_blob(**kwargs)
  1. See UpdateLocationAzureBlobRequestTypeDef

update_location_efs#

Modifies the following configuration parameters of the Amazon EFS transfer location that you're using with DataSync.

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

# update_location_efs method definition

def update_location_efs(
    self,
    *,
    LocationArn: str,
    Subdirectory: str = ...,
    AccessPointArn: str = ...,
    FileSystemAccessRoleArn: str = ...,
    InTransitEncryption: EfsInTransitEncryptionType = ...,  # (1)
) -> Dict[str, Any]:
    ...
  1. See EfsInTransitEncryptionType
# update_location_efs method usage example with argument unpacking

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

parent.update_location_efs(**kwargs)
  1. See UpdateLocationEfsRequestTypeDef

update_location_fsx_lustre#

Modifies the following configuration parameters of the Amazon FSx for Lustre transfer location that you're using with DataSync.

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

# update_location_fsx_lustre method definition

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

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

parent.update_location_fsx_lustre(**kwargs)
  1. See UpdateLocationFsxLustreRequestTypeDef

update_location_fsx_ontap#

Modifies the following configuration parameters of the Amazon FSx for NetApp ONTAP transfer location that you're using with DataSync.

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

# update_location_fsx_ontap method definition

def update_location_fsx_ontap(
    self,
    *,
    LocationArn: str,
    Protocol: FsxUpdateProtocolTypeDef = ...,  # (1)
    Subdirectory: str = ...,
) -> Dict[str, Any]:
    ...
  1. See FsxUpdateProtocolTypeDef
# update_location_fsx_ontap method usage example with argument unpacking

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

parent.update_location_fsx_ontap(**kwargs)
  1. See UpdateLocationFsxOntapRequestTypeDef

update_location_fsx_open_zfs#

Modifies the following configuration parameters of the Amazon FSx for OpenZFS transfer location that you're using with DataSync.

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

# update_location_fsx_open_zfs method definition

def update_location_fsx_open_zfs(
    self,
    *,
    LocationArn: str,
    Protocol: FsxProtocolTypeDef = ...,  # (1)
    Subdirectory: str = ...,
) -> Dict[str, Any]:
    ...
  1. See FsxProtocolTypeDef
# update_location_fsx_open_zfs method usage example with argument unpacking

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

parent.update_location_fsx_open_zfs(**kwargs)
  1. See UpdateLocationFsxOpenZfsRequestTypeDef

update_location_fsx_windows#

Modifies the following configuration parameters of the Amazon FSx for Windows File Server transfer location that you're using with DataSync.

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

# update_location_fsx_windows method definition

def update_location_fsx_windows(
    self,
    *,
    LocationArn: str,
    Subdirectory: str = ...,
    Domain: str = ...,
    User: str = ...,
    Password: str = ...,
) -> Dict[str, Any]:
    ...
# update_location_fsx_windows method usage example with argument unpacking

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

parent.update_location_fsx_windows(**kwargs)
  1. See UpdateLocationFsxWindowsRequestTypeDef

update_location_hdfs#

Modifies the following configuration parameters of the Hadoop Distributed File System (HDFS) transfer location that you're using with DataSync.

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

# update_location_hdfs 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: BlobTypeDef = ...,
    KerberosKrb5Conf: BlobTypeDef = ...,
    AgentArns: Sequence[str] = ...,
) -> Dict[str, Any]:
    ...
  1. See Sequence[HdfsNameNodeTypeDef]
  2. See QopConfigurationTypeDef
  3. See HdfsAuthenticationTypeType
# update_location_hdfs method usage example with argument unpacking

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

parent.update_location_hdfs(**kwargs)
  1. See UpdateLocationHdfsRequestTypeDef

update_location_nfs#

Modifies the following configuration parameters of the Network File System (NFS) transfer location that you're using with DataSync.

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

# update_location_nfs method definition

def update_location_nfs(
    self,
    *,
    LocationArn: str,
    Subdirectory: str = ...,
    ServerHostname: str = ...,
    OnPremConfig: OnPremConfigUnionTypeDef = ...,  # (1)
    MountOptions: NfsMountOptionsTypeDef = ...,  # (2)
) -> Dict[str, Any]:
    ...
  1. See OnPremConfigUnionTypeDef
  2. See NfsMountOptionsTypeDef
# update_location_nfs method usage example with argument unpacking

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

parent.update_location_nfs(**kwargs)
  1. See UpdateLocationNfsRequestTypeDef

update_location_object_storage#

Modifies the following configuration parameters of the object storage transfer location that you're using with DataSync.

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

# update_location_object_storage method definition

def update_location_object_storage(
    self,
    *,
    LocationArn: str,
    ServerPort: int = ...,
    ServerProtocol: ObjectStorageServerProtocolType = ...,  # (1)
    Subdirectory: str = ...,
    ServerHostname: str = ...,
    AccessKey: str = ...,
    SecretKey: str = ...,
    AgentArns: Sequence[str] = ...,
    ServerCertificate: BlobTypeDef = ...,
) -> Dict[str, Any]:
    ...
  1. See ObjectStorageServerProtocolType
# update_location_object_storage method usage example with argument unpacking

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

parent.update_location_object_storage(**kwargs)
  1. See UpdateLocationObjectStorageRequestTypeDef

update_location_s3#

Modifies the following configuration parameters of the Amazon S3 transfer location that you're using with DataSync.

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

# update_location_s3 method definition

def update_location_s3(
    self,
    *,
    LocationArn: str,
    Subdirectory: str = ...,
    S3StorageClass: S3StorageClassType = ...,  # (1)
    S3Config: S3ConfigTypeDef = ...,  # (2)
) -> Dict[str, Any]:
    ...
  1. See S3StorageClassType
  2. See S3ConfigTypeDef
# update_location_s3 method usage example with argument unpacking

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

parent.update_location_s3(**kwargs)
  1. See UpdateLocationS3RequestTypeDef

update_location_smb#

Modifies the following configuration parameters of the Server Message Block (SMB) transfer location that you're using with DataSync.

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

# update_location_smb method definition

def update_location_smb(
    self,
    *,
    LocationArn: str,
    Subdirectory: str = ...,
    ServerHostname: str = ...,
    User: str = ...,
    Domain: str = ...,
    Password: str = ...,
    AgentArns: Sequence[str] = ...,
    MountOptions: SmbMountOptionsTypeDef = ...,  # (1)
    AuthenticationType: SmbAuthenticationTypeType = ...,  # (2)
    DnsIpAddresses: Sequence[str] = ...,
    KerberosPrincipal: str = ...,
    KerberosKeytab: BlobTypeDef = ...,
    KerberosKrb5Conf: BlobTypeDef = ...,
) -> Dict[str, Any]:
    ...
  1. See SmbMountOptionsTypeDef
  2. See SmbAuthenticationTypeType
# update_location_smb method usage example with argument unpacking

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

parent.update_location_smb(**kwargs)
  1. See UpdateLocationSmbRequestTypeDef

update_storage_system#

Modifies some configurations of an on-premises storage system resource that you're using with DataSync Discovery.

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

# update_storage_system method definition

def update_storage_system(
    self,
    *,
    StorageSystemArn: str,
    ServerConfiguration: DiscoveryServerConfigurationTypeDef = ...,  # (1)
    AgentArns: Sequence[str] = ...,
    Name: str = ...,
    CloudWatchLogGroupArn: str = ...,
    Credentials: CredentialsTypeDef = ...,  # (2)
) -> Dict[str, Any]:
    ...
  1. See DiscoveryServerConfigurationTypeDef
  2. See CredentialsTypeDef
# update_storage_system method usage example with argument unpacking

kwargs: UpdateStorageSystemRequestTypeDef = {  # (1)
    "StorageSystemArn": ...,
}

parent.update_storage_system(**kwargs)
  1. See UpdateStorageSystemRequestTypeDef

update_task#

Updates the configuration of a task, which defines where and how DataSync transfers your data.

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

# update_task 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)
    ManifestConfig: ManifestConfigTypeDef = ...,  # (5)
    TaskReportConfig: TaskReportConfigTypeDef = ...,  # (6)
) -> Dict[str, Any]:
    ...
  1. See OptionsTypeDef
  2. See Sequence[FilterRuleTypeDef]
  3. See TaskScheduleTypeDef
  4. See Sequence[FilterRuleTypeDef]
  5. See ManifestConfigTypeDef
  6. See TaskReportConfigTypeDef
# update_task method usage example with argument unpacking

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

parent.update_task(**kwargs)
  1. See UpdateTaskRequestTypeDef

update_task_execution#

Updates the configuration of a running DataSync task execution.

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

# update_task_execution method definition

def update_task_execution(
    self,
    *,
    TaskExecutionArn: str,
    Options: OptionsTypeDef,  # (1)
) -> Dict[str, Any]:
    ...
  1. See OptionsTypeDef
# update_task_execution method usage example with argument unpacking

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

parent.update_task_execution(**kwargs)
  1. See UpdateTaskExecutionRequestTypeDef

get_paginator#

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