Skip to content

Examples#

Index > DataSync > Examples

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

Client#

Implicit type annotations#

Can be used with boto3-stubs[datasync] package installed.

Write your DataSync code as usual, type checking and code completion should work out of the box.

# DataSyncClient usage example

from boto3.session import Session


session = Session()

client = session.client("datasync")  # (1)
result = client.add_storage_system()  # (2)
  1. client: DataSyncClient
  2. result: AddStorageSystemResponseTypeDef
# DescribeStorageSystemResourceMetricsPaginator usage example

from boto3.session import Session


session = Session()
client = session.client("datasync")  # (1)

paginator = client.get_paginator("describe_storage_system_resource_metrics")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: DataSyncClient
  2. paginator: DescribeStorageSystemResourceMetricsPaginator
  3. item: DescribeStorageSystemResourceMetricsResponseTypeDef

Explicit type annotations#

With boto3-stubs-lite[datasync] or a standalone mypy_boto3_datasync package, you have to explicitly specify client: DataSyncClient type annotation.

All other type annotations are optional, as types should be discovered automatically. However, these type annotations can be helpful in your functions and methods.

# DataSyncClient usage example with type annotations

from boto3.session import Session

from mypy_boto3_datasync.client import DataSyncClient
from mypy_boto3_datasync.type_defs import AddStorageSystemResponseTypeDef
from mypy_boto3_datasync.type_defs import AddStorageSystemRequestRequestTypeDef


session = Session()

client: DataSyncClient = session.client("datasync")

kwargs: AddStorageSystemRequestRequestTypeDef = {...}
result: AddStorageSystemResponseTypeDef = client.add_storage_system(**kwargs)
# DescribeStorageSystemResourceMetricsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_datasync.client import DataSyncClient
from mypy_boto3_datasync.paginator import DescribeStorageSystemResourceMetricsPaginator
from mypy_boto3_datasync.type_defs import DescribeStorageSystemResourceMetricsResponseTypeDef


session = Session()
client: DataSyncClient = session.client("datasync")

paginator: DescribeStorageSystemResourceMetricsPaginator = client.get_paginator("describe_storage_system_resource_metrics")
for item in paginator.paginate(...):
    item: DescribeStorageSystemResourceMetricsResponseTypeDef
    print(item)