Skip to content

DataSync module#

Index > DataSync

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

How to install#

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 boto3-stubs for DataSync service.

# install with boto3 type annotations
python -m pip install 'boto3-stubs[datasync]'


# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[datasync]'


# standalone installation
python -m pip install mypy-boto3-datasync

How to uninstall#

python -m pip uninstall -y mypy-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 mypy_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("...").

# DescribeStorageSystemResourceMetricsPaginator usage example

from boto3.session import Session

from mypy_boto3_datasync.paginator import DescribeStorageSystemResourceMetricsPaginator

def get_describe_storage_system_resource_metrics_paginator() -> DescribeStorageSystemResourceMetricsPaginator:
    return Session().client("datasync").get_paginator("describe_storage_system_resource_metrics"))

Literals#

Type annotations for literals used in methods and schemas.

# AgentStatusType usage example

from mypy_boto3_datasync.literals import AgentStatusType

def get_value() -> AgentStatusType:
    return "OFFLINE"

Typed dictionaries#

Type annotations for typed dictionaries used in methods and schema.

# CredentialsTypeDef usage example

from mypy_boto3_datasync.type_defs import CredentialsTypeDef

def get_value() -> CredentialsTypeDef:
    return {
        "Username": ...,
        "Password": ...,
    }