DataSync module#
Index > DataSync
Auto-generated documentation for DataSync type annotations stubs module types-boto3-datasync.
How to install#
Generate locally (recommended)#
You can generate type annotations for boto3
package locally with mypy-boto3-builder
.
Use uv for build isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'boto3==1.38.26' mypy-boto3-builder
- Select
boto3
AWS SDK. - Add
DataSync
service. - Use provided commands to install generated packages.
VSCode extension#
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Modify
and select boto3 common
and DataSync
.
From PyPI with pip#
Install types-boto3
for DataSync
service.
# install with boto3 type annotations
python -m pip install 'types-boto3[datasync]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-boto3-lite[datasync]'
# standalone installation
python -m pip install types-boto3-datasync
How to uninstall#
python -m pip uninstall -y types-boto3-datasync
Usage#
Code samples can be found in Examples.
DataSyncClient#
Type annotations and code completion for boto3.client("datasync")
as DataSyncClient
boto3 documentation
# DataSyncClient usage example
from boto3.session import Session
from types_boto3_datasync.client import DataSyncClient
def get_client() -> DataSyncClient:
return Session().client("datasync")
Paginators#
Type annotations and code completion for paginators
from boto3.client("datasync").get_paginator("...")
.
# ListAgentsPaginator usage example
from boto3.session import Session
from types_boto3_datasync.paginator import ListAgentsPaginator
def get_list_agents_paginator() -> ListAgentsPaginator:
return Session().client("datasync").get_paginator("list_agents"))
- ListAgentsPaginator
- ListLocationsPaginator
- ListTagsForResourcePaginator
- ListTaskExecutionsPaginator
- ListTasksPaginator
Literals#
Type annotations for literals used in methods and schema.
# AgentStatusType usage example
from types_boto3_datasync.literals import AgentStatusType
def get_value() -> AgentStatusType:
return "OFFLINE"
- AgentStatusType
- AtimeType
- AzureAccessTierType
- AzureBlobAuthenticationTypeType
- AzureBlobTypeType
- EfsInTransitEncryptionType
- EndpointTypeType
- FilterTypeType
- GidType
- HdfsAuthenticationTypeType
- HdfsDataTransferProtectionType
- HdfsRpcProtectionType
- ListAgentsPaginatorName
- ListLocationsPaginatorName
- ListTagsForResourcePaginatorName
- ListTaskExecutionsPaginatorName
- ListTasksPaginatorName
- LocationFilterNameType
- LogLevelType
- ManifestActionType
- ManifestFormatType
- MtimeType
- NfsVersionType
- ObjectStorageServerProtocolType
- ObjectTagsType
- ObjectVersionIdsType
- OperatorType
- OverwriteModeType
- PhaseStatusType
- PosixPermissionsType
- PreserveDeletedFilesType
- PreserveDevicesType
- ReportLevelType
- ReportOutputTypeType
- S3StorageClassType
- ScheduleDisabledByType
- ScheduleStatusType
- SmbAuthenticationTypeType
- SmbSecurityDescriptorCopyFlagsType
- SmbVersionType
- TaskExecutionStatusType
- TaskFilterNameType
- TaskModeType
- TaskQueueingType
- TaskStatusType
- TransferModeType
- UidType
- VerifyModeType
- DataSyncServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.
- PlatformTypeDef
- AzureBlobSasConfigurationTypeDef
- BlobTypeDef
- CancelTaskExecutionRequestTypeDef
- CmkSecretConfigTypeDef
- TagListEntryTypeDef
- ResponseMetadataTypeDef
- CustomSecretConfigTypeDef
- HdfsNameNodeTypeDef
- QopConfigurationTypeDef
- NfsMountOptionsTypeDef
- S3ConfigTypeDef
- SmbMountOptionsTypeDef
- FilterRuleTypeDef
- OptionsTypeDef
- TaskScheduleTypeDef
- DeleteAgentRequestTypeDef
- DeleteLocationRequestTypeDef
- DeleteTaskRequestTypeDef
- DescribeAgentRequestTypeDef
- PrivateLinkConfigTypeDef
- DescribeLocationAzureBlobRequestTypeDef
- ManagedSecretConfigTypeDef
- DescribeLocationEfsRequestTypeDef
- Ec2ConfigOutputTypeDef
- DescribeLocationFsxLustreRequestTypeDef
- DescribeLocationFsxOntapRequestTypeDef
- DescribeLocationFsxOpenZfsRequestTypeDef
- DescribeLocationFsxWindowsRequestTypeDef
- DescribeLocationHdfsRequestTypeDef
- DescribeLocationNfsRequestTypeDef
- OnPremConfigOutputTypeDef
- DescribeLocationObjectStorageRequestTypeDef
- DescribeLocationS3RequestTypeDef
- DescribeLocationSmbRequestTypeDef
- DescribeTaskExecutionRequestTypeDef
- ReportResultTypeDef
- TaskExecutionFilesFailedDetailTypeDef
- TaskExecutionFilesListedDetailTypeDef
- TaskExecutionResultDetailTypeDef
- DescribeTaskRequestTypeDef
- TaskScheduleDetailsTypeDef
- Ec2ConfigTypeDef
- PaginatorConfigTypeDef
- ListAgentsRequestTypeDef
- LocationFilterTypeDef
- LocationListEntryTypeDef
- ListTagsForResourceRequestTypeDef
- ListTaskExecutionsRequestTypeDef
- TaskExecutionListEntryTypeDef
- TaskFilterTypeDef
- TaskListEntryTypeDef
- OnPremConfigTypeDef
- ReportDestinationS3TypeDef
- ReportOverrideTypeDef
- S3ManifestConfigTypeDef
- UntagResourceRequestTypeDef
- UpdateAgentRequestTypeDef
- UpdateLocationEfsRequestTypeDef
- UpdateLocationFsxLustreRequestTypeDef
- UpdateLocationFsxWindowsRequestTypeDef
- AgentListEntryTypeDef
- CreateAgentRequestTypeDef
- CreateLocationFsxLustreRequestTypeDef
- CreateLocationFsxWindowsRequestTypeDef
- TagResourceRequestTypeDef
- CreateAgentResponseTypeDef
- CreateLocationAzureBlobResponseTypeDef
- CreateLocationEfsResponseTypeDef
- CreateLocationFsxLustreResponseTypeDef
- CreateLocationFsxOntapResponseTypeDef
- CreateLocationFsxOpenZfsResponseTypeDef
- CreateLocationFsxWindowsResponseTypeDef
- CreateLocationHdfsResponseTypeDef
- CreateLocationNfsResponseTypeDef
- CreateLocationObjectStorageResponseTypeDef
- CreateLocationS3ResponseTypeDef
- CreateLocationSmbResponseTypeDef
- CreateTaskResponseTypeDef
- DescribeLocationFsxLustreResponseTypeDef
- DescribeLocationFsxWindowsResponseTypeDef
- ListTagsForResourceResponseTypeDef
- StartTaskExecutionResponseTypeDef
- CreateLocationAzureBlobRequestTypeDef
- CreateLocationObjectStorageRequestTypeDef
- UpdateLocationAzureBlobRequestTypeDef
- UpdateLocationObjectStorageRequestTypeDef
- CreateLocationHdfsRequestTypeDef
- DescribeLocationHdfsResponseTypeDef
- UpdateLocationHdfsRequestTypeDef
- FsxProtocolNfsTypeDef
- CreateLocationS3RequestTypeDef
- DescribeLocationS3ResponseTypeDef
- UpdateLocationS3RequestTypeDef
- CreateLocationSmbRequestTypeDef
- DescribeLocationSmbResponseTypeDef
- FsxProtocolSmbTypeDef
- FsxUpdateProtocolSmbTypeDef
- UpdateLocationSmbRequestTypeDef
- UpdateTaskExecutionRequestTypeDef
- DescribeAgentResponseTypeDef
- DescribeLocationAzureBlobResponseTypeDef
- DescribeLocationObjectStorageResponseTypeDef
- DescribeLocationEfsResponseTypeDef
- DescribeLocationNfsResponseTypeDef
- Ec2ConfigUnionTypeDef
- ListAgentsRequestPaginateTypeDef
- ListTagsForResourceRequestPaginateTypeDef
- ListTaskExecutionsRequestPaginateTypeDef
- ListLocationsRequestPaginateTypeDef
- ListLocationsRequestTypeDef
- ListLocationsResponseTypeDef
- ListTaskExecutionsResponseTypeDef
- ListTasksRequestPaginateTypeDef
- ListTasksRequestTypeDef
- ListTasksResponseTypeDef
- OnPremConfigUnionTypeDef
- ReportDestinationTypeDef
- ReportOverridesTypeDef
- SourceManifestConfigTypeDef
- ListAgentsResponseTypeDef
- FsxProtocolTypeDef
- FsxUpdateProtocolTypeDef
- CreateLocationEfsRequestTypeDef
- CreateLocationNfsRequestTypeDef
- UpdateLocationNfsRequestTypeDef
- TaskReportConfigTypeDef
- ManifestConfigTypeDef
- CreateLocationFsxOntapRequestTypeDef
- CreateLocationFsxOpenZfsRequestTypeDef
- DescribeLocationFsxOntapResponseTypeDef
- DescribeLocationFsxOpenZfsResponseTypeDef
- UpdateLocationFsxOpenZfsRequestTypeDef
- UpdateLocationFsxOntapRequestTypeDef
- CreateTaskRequestTypeDef
- DescribeTaskExecutionResponseTypeDef
- DescribeTaskResponseTypeDef
- StartTaskExecutionRequestTypeDef
- UpdateTaskRequestTypeDef