Skip to content

Type definitions#

Index > DataSync > Type definitions

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

BlobTypeDef#

# BlobTypeDef definition

BlobTypeDef = Union[
    str,
    bytes,
    IO[Any],
    StreamingBody,
]

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

CredentialsTypeDef#

# CredentialsTypeDef definition

class CredentialsTypeDef(TypedDict):
    Username: str,
    Password: str,

DiscoveryServerConfigurationTypeDef#

# DiscoveryServerConfigurationTypeDef definition

class DiscoveryServerConfigurationTypeDef(TypedDict):
    ServerHostname: str,
    ServerPort: NotRequired[int],

TagListEntryTypeDef#

# TagListEntryTypeDef definition

class TagListEntryTypeDef(TypedDict):
    Key: str,
    Value: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

PlatformTypeDef#

# PlatformTypeDef definition

class PlatformTypeDef(TypedDict):
    Version: NotRequired[str],

AzureBlobSasConfigurationTypeDef#

# AzureBlobSasConfigurationTypeDef definition

class AzureBlobSasConfigurationTypeDef(TypedDict):
    Token: str,

CancelTaskExecutionRequestRequestTypeDef#

# CancelTaskExecutionRequestRequestTypeDef definition

class CancelTaskExecutionRequestRequestTypeDef(TypedDict):
    TaskExecutionArn: str,

CapacityTypeDef#

# CapacityTypeDef definition

class CapacityTypeDef(TypedDict):
    Used: NotRequired[int],
    Provisioned: NotRequired[int],
    LogicalUsed: NotRequired[int],
    ClusterCloudStorageUsed: NotRequired[int],

Ec2ConfigTypeDef#

# Ec2ConfigTypeDef definition

class Ec2ConfigTypeDef(TypedDict):
    SubnetArn: str,
    SecurityGroupArns: Sequence[str],

HdfsNameNodeTypeDef#

# HdfsNameNodeTypeDef definition

class HdfsNameNodeTypeDef(TypedDict):
    Hostname: str,
    Port: int,

QopConfigurationTypeDef#

# QopConfigurationTypeDef definition

class QopConfigurationTypeDef(TypedDict):
    RpcProtection: NotRequired[HdfsRpcProtectionType],  # (1)
    DataTransferProtection: NotRequired[HdfsDataTransferProtectionType],  # (2)
  1. See HdfsRpcProtectionType
  2. See HdfsDataTransferProtectionType

NfsMountOptionsTypeDef#

# NfsMountOptionsTypeDef definition

class NfsMountOptionsTypeDef(TypedDict):
    Version: NotRequired[NfsVersionType],  # (1)
  1. See NfsVersionType

OnPremConfigTypeDef#

# OnPremConfigTypeDef definition

class OnPremConfigTypeDef(TypedDict):
    AgentArns: Sequence[str],

S3ConfigTypeDef#

# S3ConfigTypeDef definition

class S3ConfigTypeDef(TypedDict):
    BucketAccessRoleArn: str,

SmbMountOptionsTypeDef#

# SmbMountOptionsTypeDef definition

class SmbMountOptionsTypeDef(TypedDict):
    Version: NotRequired[SmbVersionType],  # (1)
  1. See SmbVersionType

FilterRuleTypeDef#

# FilterRuleTypeDef definition

class FilterRuleTypeDef(TypedDict):
    FilterType: NotRequired[FilterTypeType],  # (1)
    Value: NotRequired[str],
  1. See FilterTypeType

OptionsTypeDef#

# OptionsTypeDef definition

class OptionsTypeDef(TypedDict):
    VerifyMode: NotRequired[VerifyModeType],  # (1)
    OverwriteMode: NotRequired[OverwriteModeType],  # (2)
    Atime: NotRequired[AtimeType],  # (3)
    Mtime: NotRequired[MtimeType],  # (4)
    Uid: NotRequired[UidType],  # (5)
    Gid: NotRequired[GidType],  # (6)
    PreserveDeletedFiles: NotRequired[PreserveDeletedFilesType],  # (7)
    PreserveDevices: NotRequired[PreserveDevicesType],  # (8)
    PosixPermissions: NotRequired[PosixPermissionsType],  # (9)
    BytesPerSecond: NotRequired[int],
    TaskQueueing: NotRequired[TaskQueueingType],  # (10)
    LogLevel: NotRequired[LogLevelType],  # (11)
    TransferMode: NotRequired[TransferModeType],  # (12)
    SecurityDescriptorCopyFlags: NotRequired[SmbSecurityDescriptorCopyFlagsType],  # (13)
    ObjectTags: NotRequired[ObjectTagsType],  # (14)
  1. See VerifyModeType
  2. See OverwriteModeType
  3. See AtimeType
  4. See MtimeType
  5. See UidType
  6. See GidType
  7. See PreserveDeletedFilesType
  8. See PreserveDevicesType
  9. See PosixPermissionsType
  10. See TaskQueueingType
  11. See LogLevelType
  12. See TransferModeType
  13. See SmbSecurityDescriptorCopyFlagsType
  14. See ObjectTagsType

TaskScheduleTypeDef#

# TaskScheduleTypeDef definition

class TaskScheduleTypeDef(TypedDict):
    ScheduleExpression: str,

DeleteAgentRequestRequestTypeDef#

# DeleteAgentRequestRequestTypeDef definition

class DeleteAgentRequestRequestTypeDef(TypedDict):
    AgentArn: str,

DeleteLocationRequestRequestTypeDef#

# DeleteLocationRequestRequestTypeDef definition

class DeleteLocationRequestRequestTypeDef(TypedDict):
    LocationArn: str,

DeleteTaskRequestRequestTypeDef#

# DeleteTaskRequestRequestTypeDef definition

class DeleteTaskRequestRequestTypeDef(TypedDict):
    TaskArn: str,

DescribeAgentRequestRequestTypeDef#

# DescribeAgentRequestRequestTypeDef definition

class DescribeAgentRequestRequestTypeDef(TypedDict):
    AgentArn: str,

PrivateLinkConfigTypeDef#

# PrivateLinkConfigTypeDef definition

class PrivateLinkConfigTypeDef(TypedDict):
    VpcEndpointId: NotRequired[str],
    PrivateLinkEndpoint: NotRequired[str],
    SubnetArns: NotRequired[List[str]],
    SecurityGroupArns: NotRequired[List[str]],

DescribeDiscoveryJobRequestRequestTypeDef#

# DescribeDiscoveryJobRequestRequestTypeDef definition

class DescribeDiscoveryJobRequestRequestTypeDef(TypedDict):
    DiscoveryJobArn: str,

DescribeLocationAzureBlobRequestRequestTypeDef#

# DescribeLocationAzureBlobRequestRequestTypeDef definition

class DescribeLocationAzureBlobRequestRequestTypeDef(TypedDict):
    LocationArn: str,

DescribeLocationEfsRequestRequestTypeDef#

# DescribeLocationEfsRequestRequestTypeDef definition

class DescribeLocationEfsRequestRequestTypeDef(TypedDict):
    LocationArn: str,

DescribeLocationFsxLustreRequestRequestTypeDef#

# DescribeLocationFsxLustreRequestRequestTypeDef definition

class DescribeLocationFsxLustreRequestRequestTypeDef(TypedDict):
    LocationArn: str,

DescribeLocationFsxOntapRequestRequestTypeDef#

# DescribeLocationFsxOntapRequestRequestTypeDef definition

class DescribeLocationFsxOntapRequestRequestTypeDef(TypedDict):
    LocationArn: str,

DescribeLocationFsxOpenZfsRequestRequestTypeDef#

# DescribeLocationFsxOpenZfsRequestRequestTypeDef definition

class DescribeLocationFsxOpenZfsRequestRequestTypeDef(TypedDict):
    LocationArn: str,

DescribeLocationFsxWindowsRequestRequestTypeDef#

# DescribeLocationFsxWindowsRequestRequestTypeDef definition

class DescribeLocationFsxWindowsRequestRequestTypeDef(TypedDict):
    LocationArn: str,

DescribeLocationHdfsRequestRequestTypeDef#

# DescribeLocationHdfsRequestRequestTypeDef definition

class DescribeLocationHdfsRequestRequestTypeDef(TypedDict):
    LocationArn: str,

DescribeLocationNfsRequestRequestTypeDef#

# DescribeLocationNfsRequestRequestTypeDef definition

class DescribeLocationNfsRequestRequestTypeDef(TypedDict):
    LocationArn: str,

DescribeLocationObjectStorageRequestRequestTypeDef#

# DescribeLocationObjectStorageRequestRequestTypeDef definition

class DescribeLocationObjectStorageRequestRequestTypeDef(TypedDict):
    LocationArn: str,

DescribeLocationS3RequestRequestTypeDef#

# DescribeLocationS3RequestRequestTypeDef definition

class DescribeLocationS3RequestRequestTypeDef(TypedDict):
    LocationArn: str,

DescribeLocationSmbRequestRequestTypeDef#

# DescribeLocationSmbRequestRequestTypeDef definition

class DescribeLocationSmbRequestRequestTypeDef(TypedDict):
    LocationArn: str,

DescribeStorageSystemRequestRequestTypeDef#

# DescribeStorageSystemRequestRequestTypeDef definition

class DescribeStorageSystemRequestRequestTypeDef(TypedDict):
    StorageSystemArn: str,

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

DescribeStorageSystemResourcesRequestRequestTypeDef#

# DescribeStorageSystemResourcesRequestRequestTypeDef definition

class DescribeStorageSystemResourcesRequestRequestTypeDef(TypedDict):
    DiscoveryJobArn: str,
    ResourceType: DiscoveryResourceTypeType,  # (1)
    ResourceIds: NotRequired[Sequence[str]],
    Filter: NotRequired[Mapping[DiscoveryResourceFilterType, Sequence[str]]],  # (2)
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
  1. See DiscoveryResourceTypeType
  2. See DiscoveryResourceFilterType

DescribeTaskExecutionRequestRequestTypeDef#

# DescribeTaskExecutionRequestRequestTypeDef definition

class DescribeTaskExecutionRequestRequestTypeDef(TypedDict):
    TaskExecutionArn: str,

ReportResultTypeDef#

# ReportResultTypeDef definition

class ReportResultTypeDef(TypedDict):
    Status: NotRequired[PhaseStatusType],  # (1)
    ErrorCode: NotRequired[str],
    ErrorDetail: NotRequired[str],
  1. See PhaseStatusType

TaskExecutionResultDetailTypeDef#

# TaskExecutionResultDetailTypeDef definition

class TaskExecutionResultDetailTypeDef(TypedDict):
    PrepareDuration: NotRequired[int],
    PrepareStatus: NotRequired[PhaseStatusType],  # (1)
    TotalDuration: NotRequired[int],
    TransferDuration: NotRequired[int],
    TransferStatus: NotRequired[PhaseStatusType],  # (1)
    VerifyDuration: NotRequired[int],
    VerifyStatus: NotRequired[PhaseStatusType],  # (1)
    ErrorCode: NotRequired[str],
    ErrorDetail: NotRequired[str],
  1. See PhaseStatusType
  2. See PhaseStatusType
  3. See PhaseStatusType

DescribeTaskRequestRequestTypeDef#

# DescribeTaskRequestRequestTypeDef definition

class DescribeTaskRequestRequestTypeDef(TypedDict):
    TaskArn: str,

DiscoveryJobListEntryTypeDef#

# DiscoveryJobListEntryTypeDef definition

class DiscoveryJobListEntryTypeDef(TypedDict):
    DiscoveryJobArn: NotRequired[str],
    Status: NotRequired[DiscoveryJobStatusType],  # (1)
  1. See DiscoveryJobStatusType

GenerateRecommendationsRequestRequestTypeDef#

# GenerateRecommendationsRequestRequestTypeDef definition

class GenerateRecommendationsRequestRequestTypeDef(TypedDict):
    DiscoveryJobArn: str,
    ResourceIds: Sequence[str],
    ResourceType: DiscoveryResourceTypeType,  # (1)
  1. See DiscoveryResourceTypeType

IOPSTypeDef#

# IOPSTypeDef definition

class IOPSTypeDef(TypedDict):
    Read: NotRequired[float],
    Write: NotRequired[float],
    Other: NotRequired[float],
    Total: NotRequired[float],

LatencyTypeDef#

# LatencyTypeDef definition

class LatencyTypeDef(TypedDict):
    Read: NotRequired[float],
    Write: NotRequired[float],
    Other: NotRequired[float],

ListAgentsRequestRequestTypeDef#

# ListAgentsRequestRequestTypeDef definition

class ListAgentsRequestRequestTypeDef(TypedDict):
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListDiscoveryJobsRequestRequestTypeDef#

# ListDiscoveryJobsRequestRequestTypeDef definition

class ListDiscoveryJobsRequestRequestTypeDef(TypedDict):
    StorageSystemArn: NotRequired[str],
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

LocationFilterTypeDef#

# LocationFilterTypeDef definition

class LocationFilterTypeDef(TypedDict):
    Name: LocationFilterNameType,  # (1)
    Values: Sequence[str],
    Operator: OperatorType,  # (2)
  1. See LocationFilterNameType
  2. See OperatorType

LocationListEntryTypeDef#

# LocationListEntryTypeDef definition

class LocationListEntryTypeDef(TypedDict):
    LocationArn: NotRequired[str],
    LocationUri: NotRequired[str],

ListStorageSystemsRequestRequestTypeDef#

# ListStorageSystemsRequestRequestTypeDef definition

class ListStorageSystemsRequestRequestTypeDef(TypedDict):
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

StorageSystemListEntryTypeDef#

# StorageSystemListEntryTypeDef definition

class StorageSystemListEntryTypeDef(TypedDict):
    StorageSystemArn: NotRequired[str],
    Name: NotRequired[str],

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListTaskExecutionsRequestRequestTypeDef#

# ListTaskExecutionsRequestRequestTypeDef definition

class ListTaskExecutionsRequestRequestTypeDef(TypedDict):
    TaskArn: NotRequired[str],
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

TaskExecutionListEntryTypeDef#

# TaskExecutionListEntryTypeDef definition

class TaskExecutionListEntryTypeDef(TypedDict):
    TaskExecutionArn: NotRequired[str],
    Status: NotRequired[TaskExecutionStatusType],  # (1)
  1. See TaskExecutionStatusType

TaskFilterTypeDef#

# TaskFilterTypeDef definition

class TaskFilterTypeDef(TypedDict):
    Name: TaskFilterNameType,  # (1)
    Values: Sequence[str],
    Operator: OperatorType,  # (2)
  1. See TaskFilterNameType
  2. See OperatorType

TaskListEntryTypeDef#

# TaskListEntryTypeDef definition

class TaskListEntryTypeDef(TypedDict):
    TaskArn: NotRequired[str],
    Status: NotRequired[TaskStatusType],  # (1)
    Name: NotRequired[str],
  1. See TaskStatusType

MaxP95PerformanceTypeDef#

# MaxP95PerformanceTypeDef definition

class MaxP95PerformanceTypeDef(TypedDict):
    IopsRead: NotRequired[float],
    IopsWrite: NotRequired[float],
    IopsOther: NotRequired[float],
    IopsTotal: NotRequired[float],
    ThroughputRead: NotRequired[float],
    ThroughputWrite: NotRequired[float],
    ThroughputOther: NotRequired[float],
    ThroughputTotal: NotRequired[float],
    LatencyRead: NotRequired[float],
    LatencyWrite: NotRequired[float],
    LatencyOther: NotRequired[float],

RecommendationTypeDef#

# RecommendationTypeDef definition

class RecommendationTypeDef(TypedDict):
    StorageType: NotRequired[str],
    StorageConfiguration: NotRequired[Dict[str, str]],
    EstimatedMonthlyStorageCost: NotRequired[str],

ThroughputTypeDef#

# ThroughputTypeDef definition

class ThroughputTypeDef(TypedDict):
    Read: NotRequired[float],
    Write: NotRequired[float],
    Other: NotRequired[float],
    Total: NotRequired[float],

RemoveStorageSystemRequestRequestTypeDef#

# RemoveStorageSystemRequestRequestTypeDef definition

class RemoveStorageSystemRequestRequestTypeDef(TypedDict):
    StorageSystemArn: str,

ReportDestinationS3TypeDef#