DataSyncClient
Auto-generated documentation for DataSync type annotations stubs module types-aiobotocore-datasync.
DataSyncClient
Type annotations and code completion for session.client("datasync")
boto3 documentation
from aioboto3.session import Session
from types_aiobotocore_datasync.client import DataSyncClient
session = Session()
async with session.client("datasync") as client:
client: DataSyncClient
Exceptions
aioboto3
client exceptions are generated in runtime.
This class provides code completion for session.client("datasync").exceptions
structure.
async with session.client("datasync") as client:
try:
do_something(client)
except (
client.ClientError,
client.InternalException,
client.InvalidRequestException,
) as e:
print(e)
from types_aiobotocore_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 session.client("datasync").can_paginate
method.
boto3 documentation
cancel_task_execution
Cancels execution of a task.
Type annotations and code completion for session.client("datasync").cancel_task_execution
method.
boto3 documentation
await def cancel_task_execution(
self,
*,
TaskExecutionArn: str,
) -> Dict[str, Any]:
...
kwargs: CancelTaskExecutionRequestRequestTypeDef = { # (1)
"TaskExecutionArn": ...,
}
parent.cancel_task_execution(**kwargs)
close
Closes underlying endpoint connections.
Type annotations and code completion for session.client("datasync").close
method.
boto3 documentation
create_agent
Activates an DataSync agent that you have deployed on your host.
Type annotations and code completion for session.client("datasync").create_agent
method.
boto3 documentation
await def create_agent(
self,
*,
ActivationKey: str,
AgentName: str = ...,
Tags: Sequence[TagListEntryTypeDef] = ..., # (1)
VpcEndpointId: str = ...,
SubnetArns: Sequence[str] = ...,
SecurityGroupArns: Sequence[str] = ...,
) -> CreateAgentResponseTypeDef: # (2)
...
kwargs: CreateAgentRequestRequestTypeDef = { # (1)
"ActivationKey": ...,
}
parent.create_agent(**kwargs)
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 session.client("datasync").create_location_efs
method.
boto3 documentation
await 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)
...
- See Ec2ConfigTypeDef
- See TagListEntryTypeDef
- See EfsInTransitEncryptionType
- See CreateLocationEfsResponseTypeDef
kwargs: CreateLocationEfsRequestRequestTypeDef = { # (1)
"EfsFilesystemArn": ...,
"Ec2Config": ...,
}
parent.create_location_efs(**kwargs)
create_location_fsx_lustre
Creates an endpoint for an Amazon FSx for Lustre file system.
Type annotations and code completion for session.client("datasync").create_location_fsx_lustre
method.
boto3 documentation
await def create_location_fsx_lustre(
self,
*,
FsxFilesystemArn: str,
SecurityGroupArns: Sequence[str],
Subdirectory: str = ...,
Tags: Sequence[TagListEntryTypeDef] = ..., # (1)
) -> CreateLocationFsxLustreResponseTypeDef: # (2)
...
kwargs: CreateLocationFsxLustreRequestRequestTypeDef = { # (1)
"FsxFilesystemArn": ...,
"SecurityGroupArns": ...,
}
parent.create_location_fsx_lustre(**kwargs)
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 session.client("datasync").create_location_fsx_ontap
method.
boto3 documentation
await def create_location_fsx_ontap(
self,
*,
Protocol: FsxProtocolTypeDef, # (1)
SecurityGroupArns: Sequence[str],
StorageVirtualMachineArn: str,
Subdirectory: str = ...,
Tags: Sequence[TagListEntryTypeDef] = ..., # (2)
) -> CreateLocationFsxOntapResponseTypeDef: # (3)
...
kwargs: CreateLocationFsxOntapRequestRequestTypeDef = { # (1)
"Protocol": ...,
"SecurityGroupArns": ...,
"StorageVirtualMachineArn": ...,
}
parent.create_location_fsx_ontap(**kwargs)
create_location_fsx_open_zfs
Creates an endpoint for an Amazon FSx for OpenZFS file system.
Type annotations and code completion for session.client("datasync").create_location_fsx_open_zfs
method.
boto3 documentation
await def create_location_fsx_open_zfs(
self,
*,
FsxFilesystemArn: str,
Protocol: FsxProtocolTypeDef, # (1)
SecurityGroupArns: Sequence[str],
Subdirectory: str = ...,
Tags: Sequence[TagListEntryTypeDef] = ..., # (2)
) -> CreateLocationFsxOpenZfsResponseTypeDef: # (3)
...
kwargs: CreateLocationFsxOpenZfsRequestRequestTypeDef = { # (1)
"FsxFilesystemArn": ...,
"Protocol": ...,
"SecurityGroupArns": ...,
}
parent.create_location_fsx_open_zfs(**kwargs)
create_location_fsx_windows
Creates an endpoint for an Amazon FSx for Windows File Server file system.
Type annotations and code completion for session.client("datasync").create_location_fsx_windows
method.
boto3 documentation
await 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)
...
kwargs: CreateLocationFsxWindowsRequestRequestTypeDef = { # (1)
"FsxFilesystemArn": ...,
"SecurityGroupArns": ...,
"User": ...,
"Password": ...,
}
parent.create_location_fsx_windows(**kwargs)
create_location_hdfs
Creates an endpoint for a Hadoop Distributed File System (HDFS).
Type annotations and code completion for session.client("datasync").create_location_hdfs
method.
boto3 documentation
await 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)
...
- See HdfsNameNodeTypeDef
- See HdfsAuthenticationTypeType
- See QopConfigurationTypeDef
- See TagListEntryTypeDef
- See CreateLocationHdfsResponseTypeDef
kwargs: CreateLocationHdfsRequestRequestTypeDef = { # (1)
"NameNodes": ...,
"AuthenticationType": ...,
"AgentArns": ...,
}
parent.create_location_hdfs(**kwargs)
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 session.client("datasync").create_location_nfs
method.
boto3 documentation
await def create_location_nfs(
self,
*,
Subdirectory: str,
ServerHostname: str,
OnPremConfig: OnPremConfigTypeDef, # (1)
MountOptions: NfsMountOptionsTypeDef = ..., # (2)
Tags: Sequence[TagListEntryTypeDef] = ..., # (3)
) -> CreateLocationNfsResponseTypeDef: # (4)
...
- See OnPremConfigTypeDef
- See NfsMountOptionsTypeDef
- See TagListEntryTypeDef
- See CreateLocationNfsResponseTypeDef
kwargs: CreateLocationNfsRequestRequestTypeDef = { # (1)
"Subdirectory": ...,
"ServerHostname": ...,
"OnPremConfig": ...,
}
parent.create_location_nfs(**kwargs)
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 session.client("datasync").create_location_object_storage
method.
boto3 documentation
await 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)
...
- See ObjectStorageServerProtocolType
- See TagListEntryTypeDef
- See CreateLocationObjectStorageResponseTypeDef
kwargs: CreateLocationObjectStorageRequestRequestTypeDef = { # (1)
"ServerHostname": ...,
"BucketName": ...,
"AgentArns": ...,
}
parent.create_location_object_storage(**kwargs)
create_location_s3
Creates an endpoint for an Amazon S3 bucket.
Type annotations and code completion for session.client("datasync").create_location_s3
method.
boto3 documentation
await def create_location_s3(
self,
*,
S3BucketArn: str,
S3Config: S3ConfigTypeDef, # (1)
Subdirectory: str = ...,
S3StorageClass: S3StorageClassType = ..., # (2)
AgentArns: Sequence[str] = ...,
Tags: Sequence[TagListEntryTypeDef] = ..., # (3)
) -> CreateLocationS3ResponseTypeDef: # (4)
...
- See S3ConfigTypeDef
- See S3StorageClassType
- See TagListEntryTypeDef
- See CreateLocationS3ResponseTypeDef
kwargs: CreateLocationS3RequestRequestTypeDef = { # (1)
"S3BucketArn": ...,
"S3Config": ...,
}
parent.create_location_s3(**kwargs)
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 session.client("datasync").create_location_smb
method.
boto3 documentation
await 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)
...
kwargs: CreateLocationSmbRequestRequestTypeDef = { # (1)
"Subdirectory": ...,
"ServerHostname": ...,
"User": ...,
"Password": ...,
"AgentArns": ...,
}
parent.create_location_smb(**kwargs)
create_task
Configures a task, which defines where and how DataSync transfers your data.
Type annotations and code completion for session.client("datasync").create_task
method.
boto3 documentation
await 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)
...
- See OptionsTypeDef
- See FilterRuleTypeDef
- See TaskScheduleTypeDef
- See TagListEntryTypeDef
- See FilterRuleTypeDef
- See CreateTaskResponseTypeDef
kwargs: CreateTaskRequestRequestTypeDef = { # (1)
"SourceLocationArn": ...,
"DestinationLocationArn": ...,
}
parent.create_task(**kwargs)
delete_agent
Deletes an agent.
Type annotations and code completion for session.client("datasync").delete_agent
method.
boto3 documentation
kwargs: DeleteAgentRequestRequestTypeDef = { # (1)
"AgentArn": ...,
}
parent.delete_agent(**kwargs)
delete_location
Deletes the configuration of a location used by DataSync.
Type annotations and code completion for session.client("datasync").delete_location
method.
boto3 documentation
kwargs: DeleteLocationRequestRequestTypeDef = { # (1)
"LocationArn": ...,
}
parent.delete_location(**kwargs)
delete_task
Deletes a task.
Type annotations and code completion for session.client("datasync").delete_task
method.
boto3 documentation
kwargs: DeleteTaskRequestRequestTypeDef = { # (1)
"TaskArn": ...,
}
parent.delete_task(**kwargs)
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 session.client("datasync").describe_agent
method.
boto3 documentation
await def describe_agent(
self,
*,
AgentArn: str,
) -> DescribeAgentResponseTypeDef: # (1)
...
kwargs: DescribeAgentRequestRequestTypeDef = { # (1)
"AgentArn": ...,
}
parent.describe_agent(**kwargs)
describe_location_efs
Returns metadata about your DataSync location for an Amazon EFS file system.
Type annotations and code completion for session.client("datasync").describe_location_efs
method.
boto3 documentation
await def describe_location_efs(
self,
*,
LocationArn: str,
) -> DescribeLocationEfsResponseTypeDef: # (1)
...
kwargs: DescribeLocationEfsRequestRequestTypeDef = { # (1)
"LocationArn": ...,
}
parent.describe_location_efs(**kwargs)
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 session.client("datasync").describe_location_fsx_lustre
method.
boto3 documentation
await def describe_location_fsx_lustre(
self,
*,
LocationArn: str,
) -> DescribeLocationFsxLustreResponseTypeDef: # (1)
...
kwargs: DescribeLocationFsxLustreRequestRequestTypeDef = { # (1)
"LocationArn": ...,
}
parent.describe_location_fsx_lustre(**kwargs)
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 session.client("datasync").describe_location_fsx_ontap
method.
boto3 documentation
await def describe_location_fsx_ontap(
self,
*,
LocationArn: str,
) -> DescribeLocationFsxOntapResponseTypeDef: # (1)
...
kwargs: DescribeLocationFsxOntapRequestRequestTypeDef = { # (1)
"LocationArn": ...,
}
parent.describe_location_fsx_ontap(**kwargs)
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 session.client("datasync").describe_location_fsx_open_zfs
method.
boto3 documentation
await def describe_location_fsx_open_zfs(
self,
*,
LocationArn: str,
) -> DescribeLocationFsxOpenZfsResponseTypeDef: # (1)
...
kwargs: DescribeLocationFsxOpenZfsRequestRequestTypeDef = { # (1)
"LocationArn": ...,
}
parent.describe_location_fsx_open_zfs(**kwargs)
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 session.client("datasync").describe_location_fsx_windows
method.
boto3 documentation
await def describe_location_fsx_windows(
self,
*,
LocationArn: str,
) -> DescribeLocationFsxWindowsResponseTypeDef: # (1)
...
kwargs: DescribeLocationFsxWindowsRequestRequestTypeDef = { # (1)
"LocationArn": ...,
}
parent.describe_location_fsx_windows(**kwargs)
describe_location_hdfs
Returns metadata, such as the authentication information about the Hadoop Distributed File System (HDFS) location.
Type annotations and code completion for session.client("datasync").describe_location_hdfs
method.
boto3 documentation
await def describe_location_hdfs(
self,
*,
LocationArn: str,
) -> DescribeLocationHdfsResponseTypeDef: # (1)
...
kwargs: DescribeLocationHdfsRequestRequestTypeDef = { # (1)
"LocationArn": ...,
}
parent.describe_location_hdfs(**kwargs)
describe_location_nfs
Returns metadata, such as the path information, about an NFS location.
Type annotations and code completion for session.client("datasync").describe_location_nfs
method.
boto3 documentation
await def describe_location_nfs(
self,
*,
LocationArn: str,
) -> DescribeLocationNfsResponseTypeDef: # (1)
...
kwargs: DescribeLocationNfsRequestRequestTypeDef = { # (1)
"LocationArn": ...,
}
parent.describe_location_nfs(**kwargs)
describe_location_object_storage
Returns metadata about your DataSync location for an object storage system.
Type annotations and code completion for session.client("datasync").describe_location_object_storage
method.
boto3 documentation
await def describe_location_object_storage(
self,
*,
LocationArn: str,
) -> DescribeLocationObjectStorageResponseTypeDef: # (1)
...
kwargs: DescribeLocationObjectStorageRequestRequestTypeDef = { # (1)
"LocationArn": ...,
}
parent.describe_location_object_storage(**kwargs)
describe_location_s3
Returns metadata, such as bucket name, about an Amazon S3 bucket location.
Type annotations and code completion for session.client("datasync").describe_location_s3
method.
boto3 documentation
await def describe_location_s3(
self,
*,
LocationArn: str,
) -> DescribeLocationS3ResponseTypeDef: # (1)
...
kwargs: DescribeLocationS3RequestRequestTypeDef = { # (1)
"LocationArn": ...,
}
parent.describe_location_s3(**kwargs)
describe_location_smb
Returns metadata, such as the path and user information about an SMB location.
Type annotations and code completion for session.client("datasync").describe_location_smb
method.
boto3 documentation
await def describe_location_smb(
self,
*,
LocationArn: str,
) -> DescribeLocationSmbResponseTypeDef: # (1)
...
kwargs: DescribeLocationSmbRequestRequestTypeDef = { # (1)
"LocationArn": ...,
}
parent.describe_location_smb(**kwargs)
describe_task
Returns metadata about a task.
Type annotations and code completion for session.client("datasync").describe_task
method.
boto3 documentation
await def describe_task(
self,
*,
TaskArn: str,
) -> DescribeTaskResponseTypeDef: # (1)
...
kwargs: DescribeTaskRequestRequestTypeDef = { # (1)
"TaskArn": ...,
}
parent.describe_task(**kwargs)
describe_task_execution
Returns detailed metadata about a task that is being executed.
Type annotations and code completion for session.client("datasync").describe_task_execution
method.
boto3 documentation
await def describe_task_execution(
self,
*,
TaskExecutionArn: str,
) -> DescribeTaskExecutionResponseTypeDef: # (1)
...
kwargs: DescribeTaskExecutionRequestRequestTypeDef = { # (1)
"TaskExecutionArn": ...,
}
parent.describe_task_execution(**kwargs)
generate_presigned_url
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for session.client("datasync").generate_presigned_url
method.
boto3 documentation
await 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 session.client("datasync").list_agents
method.
boto3 documentation
await def list_agents(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListAgentsResponseTypeDef: # (1)
...
kwargs: ListAgentsRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_agents(**kwargs)
list_locations
Returns a list of source and destination locations.
Type annotations and code completion for session.client("datasync").list_locations
method.
boto3 documentation
await def list_locations(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
Filters: Sequence[LocationFilterTypeDef] = ..., # (1)
) -> ListLocationsResponseTypeDef: # (2)
...
kwargs: ListLocationsRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_locations(**kwargs)
list_tags_for_resource
Returns all the tags associated with a specified resource.
Type annotations and code completion for session.client("datasync").list_tags_for_resource
method.
boto3 documentation
await def list_tags_for_resource(
self,
*,
ResourceArn: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
list_task_executions
Returns a list of executed tasks.
Type annotations and code completion for session.client("datasync").list_task_executions
method.
boto3 documentation
await def list_task_executions(
self,
*,
TaskArn: str = ...,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListTaskExecutionsResponseTypeDef: # (1)
...
kwargs: ListTaskExecutionsRequestRequestTypeDef = { # (1)
"TaskArn": ...,
}
parent.list_task_executions(**kwargs)
list_tasks
Returns a list of the DataSync tasks you created.
Type annotations and code completion for session.client("datasync").list_tasks
method.
boto3 documentation
await def list_tasks(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
Filters: Sequence[TaskFilterTypeDef] = ..., # (1)
) -> ListTasksResponseTypeDef: # (2)
...
kwargs: ListTasksRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_tasks(**kwargs)
start_task_execution
Starts a specific invocation of a task.
Type annotations and code completion for session.client("datasync").start_task_execution
method.
boto3 documentation
await def start_task_execution(
self,
*,
TaskArn: str,
OverrideOptions: OptionsTypeDef = ..., # (1)
Includes: Sequence[FilterRuleTypeDef] = ..., # (2)
Excludes: Sequence[FilterRuleTypeDef] = ..., # (2)
) -> StartTaskExecutionResponseTypeDef: # (4)
...
- See OptionsTypeDef
- See FilterRuleTypeDef
- See FilterRuleTypeDef
- See StartTaskExecutionResponseTypeDef
kwargs: StartTaskExecutionRequestRequestTypeDef = { # (1)
"TaskArn": ...,
}
parent.start_task_execution(**kwargs)
tag_resource
Applies a key-value pair to an Amazon Web Services resource.
Type annotations and code completion for session.client("datasync").tag_resource
method.
boto3 documentation
await def tag_resource(
self,
*,
ResourceArn: str,
Tags: Sequence[TagListEntryTypeDef], # (1)
) -> Dict[str, Any]:
...
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"Tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource
Removes a tag from an Amazon Web Services resource.
Type annotations and code completion for session.client("datasync").untag_resource
method.
boto3 documentation
await def untag_resource(
self,
*,
ResourceArn: str,
Keys: Sequence[str],
) -> Dict[str, Any]:
...
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"Keys": ...,
}
parent.untag_resource(**kwargs)
update_agent
Updates the name of an agent.
Type annotations and code completion for session.client("datasync").update_agent
method.
boto3 documentation
await def update_agent(
self,
*,
AgentArn: str,
Name: str = ...,
) -> Dict[str, Any]:
...
kwargs: UpdateAgentRequestRequestTypeDef = { # (1)
"AgentArn": ...,
}
parent.update_agent(**kwargs)
update_location_hdfs
Updates some parameters of a previously created location for a Hadoop Distributed File System cluster.
Type annotations and code completion for session.client("datasync").update_location_hdfs
method.
boto3 documentation
await 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]:
...
kwargs: UpdateLocationHdfsRequestRequestTypeDef = { # (1)
"LocationArn": ...,
}
parent.update_location_hdfs(**kwargs)
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 session.client("datasync").update_location_nfs
method.
boto3 documentation
await def update_location_nfs(
self,
*,
LocationArn: str,
Subdirectory: str = ...,
OnPremConfig: OnPremConfigTypeDef = ..., # (1)
MountOptions: NfsMountOptionsTypeDef = ..., # (2)
) -> Dict[str, Any]:
...
kwargs: UpdateLocationNfsRequestRequestTypeDef = { # (1)
"LocationArn": ...,
}
parent.update_location_nfs(**kwargs)
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 session.client("datasync").update_location_object_storage
method.
boto3 documentation
await 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]:
...
kwargs: UpdateLocationObjectStorageRequestRequestTypeDef = { # (1)
"LocationArn": ...,
}
parent.update_location_object_storage(**kwargs)
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 session.client("datasync").update_location_smb
method.
boto3 documentation
await def update_location_smb(
self,
*,
LocationArn: str,
Subdirectory: str = ...,
User: str = ...,
Domain: str = ...,
Password: str = ...,
AgentArns: Sequence[str] = ...,
MountOptions: SmbMountOptionsTypeDef = ..., # (1)
) -> Dict[str, Any]:
...
kwargs: UpdateLocationSmbRequestRequestTypeDef = { # (1)
"LocationArn": ...,
}
parent.update_location_smb(**kwargs)
update_task
Updates the metadata associated with a task.
Type annotations and code completion for session.client("datasync").update_task
method.
boto3 documentation
await 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]:
...
- See OptionsTypeDef
- See FilterRuleTypeDef
- See TaskScheduleTypeDef
- See FilterRuleTypeDef
kwargs: UpdateTaskRequestRequestTypeDef = { # (1)
"TaskArn": ...,
}
parent.update_task(**kwargs)
update_task_execution
Updates execution of a task.
Type annotations and code completion for session.client("datasync").update_task_execution
method.
boto3 documentation
await def update_task_execution(
self,
*,
TaskExecutionArn: str,
Options: OptionsTypeDef, # (1)
) -> Dict[str, Any]:
...
- See OptionsTypeDef
kwargs: UpdateTaskExecutionRequestRequestTypeDef = { # (1)
"TaskExecutionArn": ...,
"Options": ...,
}
parent.update_task_execution(**kwargs)
__aenter__
Type annotations and code completion for session.client("datasync").__aenter__
method.
boto3 documentation
__aexit__
Type annotations and code completion for session.client("datasync").__aexit__
method.
boto3 documentation
get_paginator
Type annotations and code completion for session.client("datasync").get_paginator
method with overloads.
client.get_paginator("list_agents")
-> ListAgentsPaginatorclient.get_paginator("list_locations")
-> ListLocationsPaginatorclient.get_paginator("list_tags_for_resource")
-> ListTagsForResourcePaginatorclient.get_paginator("list_task_executions")
-> ListTaskExecutionsPaginatorclient.get_paginator("list_tasks")
-> ListTasksPaginator