Skip to content

Type definitions#

Index > DataSync > Type definitions

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

BlobTypeDef#

# BlobTypeDef Union usage example

from types_boto3_datasync.type_defs import BlobTypeDef


def get_value() -> BlobTypeDef:
    return ...


# BlobTypeDef definition

BlobTypeDef = Union[
    str,
    bytes,
    IO[Any],
    botocore.response.StreamingBody,
]

Ec2ConfigUnionTypeDef#

# Ec2ConfigUnionTypeDef Union usage example

from types_boto3_datasync.type_defs import Ec2ConfigUnionTypeDef


def get_value() -> Ec2ConfigUnionTypeDef:
    return ...


# Ec2ConfigUnionTypeDef definition

Ec2ConfigUnionTypeDef = Union[
    Ec2ConfigTypeDef,  # (1)
    Ec2ConfigOutputTypeDef,  # (2)
]
  1. See Ec2ConfigTypeDef
  2. See Ec2ConfigOutputTypeDef

OnPremConfigUnionTypeDef#

# OnPremConfigUnionTypeDef Union usage example

from types_boto3_datasync.type_defs import OnPremConfigUnionTypeDef


def get_value() -> OnPremConfigUnionTypeDef:
    return ...


# OnPremConfigUnionTypeDef definition

OnPremConfigUnionTypeDef = Union[
    OnPremConfigTypeDef,  # (1)
    OnPremConfigOutputTypeDef,  # (2)
]
  1. See OnPremConfigTypeDef
  2. See OnPremConfigOutputTypeDef

PlatformTypeDef#

# PlatformTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import PlatformTypeDef


def get_value() -> PlatformTypeDef:
    return {
        "Version": ...,
    }


# PlatformTypeDef definition

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

AzureBlobSasConfigurationTypeDef#

# AzureBlobSasConfigurationTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import AzureBlobSasConfigurationTypeDef


def get_value() -> AzureBlobSasConfigurationTypeDef:
    return {
        "Token": ...,
    }


# AzureBlobSasConfigurationTypeDef definition

class AzureBlobSasConfigurationTypeDef(TypedDict):
    Token: str,

CancelTaskExecutionRequestTypeDef#

# CancelTaskExecutionRequestTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import CancelTaskExecutionRequestTypeDef


def get_value() -> CancelTaskExecutionRequestTypeDef:
    return {
        "TaskExecutionArn": ...,
    }


# CancelTaskExecutionRequestTypeDef definition

class CancelTaskExecutionRequestTypeDef(TypedDict):
    TaskExecutionArn: str,

TagListEntryTypeDef#

# TagListEntryTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import TagListEntryTypeDef


def get_value() -> TagListEntryTypeDef:
    return {
        "Key": ...,
    }


# TagListEntryTypeDef definition

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

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import ResponseMetadataTypeDef


def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
    }


# ResponseMetadataTypeDef definition

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

HdfsNameNodeTypeDef#

# HdfsNameNodeTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import HdfsNameNodeTypeDef


def get_value() -> HdfsNameNodeTypeDef:
    return {
        "Hostname": ...,
    }


# HdfsNameNodeTypeDef definition

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

QopConfigurationTypeDef#

# QopConfigurationTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import QopConfigurationTypeDef


def get_value() -> QopConfigurationTypeDef:
    return {
        "RpcProtection": ...,
    }


# QopConfigurationTypeDef definition

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

NfsMountOptionsTypeDef#

# NfsMountOptionsTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import NfsMountOptionsTypeDef


def get_value() -> NfsMountOptionsTypeDef:
    return {
        "Version": ...,
    }


# NfsMountOptionsTypeDef definition

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

S3ConfigTypeDef#

# S3ConfigTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import S3ConfigTypeDef


def get_value() -> S3ConfigTypeDef:
    return {
        "BucketAccessRoleArn": ...,
    }


# S3ConfigTypeDef definition

class S3ConfigTypeDef(TypedDict):
    BucketAccessRoleArn: str,

SmbMountOptionsTypeDef#

# SmbMountOptionsTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import SmbMountOptionsTypeDef


def get_value() -> SmbMountOptionsTypeDef:
    return {
        "Version": ...,
    }


# SmbMountOptionsTypeDef definition

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

FilterRuleTypeDef#

# FilterRuleTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import FilterRuleTypeDef


def get_value() -> FilterRuleTypeDef:
    return {
        "FilterType": ...,
    }


# FilterRuleTypeDef definition

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

OptionsTypeDef#

# OptionsTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import OptionsTypeDef


def get_value() -> OptionsTypeDef:
    return {
        "VerifyMode": ...,
    }


# 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 TypedDict usage example

from types_boto3_datasync.type_defs import TaskScheduleTypeDef


def get_value() -> TaskScheduleTypeDef:
    return {
        "ScheduleExpression": ...,
    }


# TaskScheduleTypeDef definition

class TaskScheduleTypeDef(TypedDict):
    ScheduleExpression: str,
    Status: NotRequired[ScheduleStatusType],  # (1)
  1. See ScheduleStatusType

DeleteAgentRequestTypeDef#

# DeleteAgentRequestTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import DeleteAgentRequestTypeDef


def get_value() -> DeleteAgentRequestTypeDef:
    return {
        "AgentArn": ...,
    }


# DeleteAgentRequestTypeDef definition

class DeleteAgentRequestTypeDef(TypedDict):
    AgentArn: str,

DeleteLocationRequestTypeDef#

# DeleteLocationRequestTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import DeleteLocationRequestTypeDef


def get_value() -> DeleteLocationRequestTypeDef:
    return {
        "LocationArn": ...,
    }


# DeleteLocationRequestTypeDef definition

class DeleteLocationRequestTypeDef(TypedDict):
    LocationArn: str,

DeleteTaskRequestTypeDef#

# DeleteTaskRequestTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import DeleteTaskRequestTypeDef


def get_value() -> DeleteTaskRequestTypeDef:
    return {
        "TaskArn": ...,
    }


# DeleteTaskRequestTypeDef definition

class DeleteTaskRequestTypeDef(TypedDict):
    TaskArn: str,

DescribeAgentRequestTypeDef#

# DescribeAgentRequestTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import DescribeAgentRequestTypeDef


def get_value() -> DescribeAgentRequestTypeDef:
    return {
        "AgentArn": ...,
    }


# DescribeAgentRequestTypeDef definition

class DescribeAgentRequestTypeDef(TypedDict):
    AgentArn: str,

PrivateLinkConfigTypeDef#

# PrivateLinkConfigTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import PrivateLinkConfigTypeDef


def get_value() -> PrivateLinkConfigTypeDef:
    return {
        "VpcEndpointId": ...,
    }


# PrivateLinkConfigTypeDef definition

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

DescribeLocationAzureBlobRequestTypeDef#

# DescribeLocationAzureBlobRequestTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import DescribeLocationAzureBlobRequestTypeDef


def get_value() -> DescribeLocationAzureBlobRequestTypeDef:
    return {
        "LocationArn": ...,
    }


# DescribeLocationAzureBlobRequestTypeDef definition

class DescribeLocationAzureBlobRequestTypeDef(TypedDict):
    LocationArn: str,

DescribeLocationEfsRequestTypeDef#

# DescribeLocationEfsRequestTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import DescribeLocationEfsRequestTypeDef


def get_value() -> DescribeLocationEfsRequestTypeDef:
    return {
        "LocationArn": ...,
    }


# DescribeLocationEfsRequestTypeDef definition

class DescribeLocationEfsRequestTypeDef(TypedDict):
    LocationArn: str,

Ec2ConfigOutputTypeDef#

# Ec2ConfigOutputTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import Ec2ConfigOutputTypeDef


def get_value() -> Ec2ConfigOutputTypeDef:
    return {
        "SubnetArn": ...,
    }


# Ec2ConfigOutputTypeDef definition

class Ec2ConfigOutputTypeDef(TypedDict):
    SubnetArn: str,
    SecurityGroupArns: List[str],

DescribeLocationFsxLustreRequestTypeDef#

# DescribeLocationFsxLustreRequestTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import DescribeLocationFsxLustreRequestTypeDef


def get_value() -> DescribeLocationFsxLustreRequestTypeDef:
    return {
        "LocationArn": ...,
    }


# DescribeLocationFsxLustreRequestTypeDef definition

class DescribeLocationFsxLustreRequestTypeDef(TypedDict):
    LocationArn: str,

DescribeLocationFsxOntapRequestTypeDef#

# DescribeLocationFsxOntapRequestTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import DescribeLocationFsxOntapRequestTypeDef


def get_value() -> DescribeLocationFsxOntapRequestTypeDef:
    return {
        "LocationArn": ...,
    }


# DescribeLocationFsxOntapRequestTypeDef definition

class DescribeLocationFsxOntapRequestTypeDef(TypedDict):
    LocationArn: str,

DescribeLocationFsxOpenZfsRequestTypeDef#

# DescribeLocationFsxOpenZfsRequestTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import DescribeLocationFsxOpenZfsRequestTypeDef


def get_value() -> DescribeLocationFsxOpenZfsRequestTypeDef:
    return {
        "LocationArn": ...,
    }


# DescribeLocationFsxOpenZfsRequestTypeDef definition

class DescribeLocationFsxOpenZfsRequestTypeDef(TypedDict):
    LocationArn: str,

DescribeLocationFsxWindowsRequestTypeDef#

# DescribeLocationFsxWindowsRequestTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import DescribeLocationFsxWindowsRequestTypeDef


def get_value() -> DescribeLocationFsxWindowsRequestTypeDef:
    return {
        "LocationArn": ...,
    }


# DescribeLocationFsxWindowsRequestTypeDef definition

class DescribeLocationFsxWindowsRequestTypeDef(TypedDict):
    LocationArn: str,

DescribeLocationHdfsRequestTypeDef#

# DescribeLocationHdfsRequestTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import DescribeLocationHdfsRequestTypeDef


def get_value() -> DescribeLocationHdfsRequestTypeDef:
    return {
        "LocationArn": ...,
    }


# DescribeLocationHdfsRequestTypeDef definition

class DescribeLocationHdfsRequestTypeDef(TypedDict):
    LocationArn: str,

DescribeLocationNfsRequestTypeDef#

# DescribeLocationNfsRequestTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import DescribeLocationNfsRequestTypeDef


def get_value() -> DescribeLocationNfsRequestTypeDef:
    return {
        "LocationArn": ...,
    }


# DescribeLocationNfsRequestTypeDef definition

class DescribeLocationNfsRequestTypeDef(TypedDict):
    LocationArn: str,

OnPremConfigOutputTypeDef#

# OnPremConfigOutputTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import OnPremConfigOutputTypeDef


def get_value() -> OnPremConfigOutputTypeDef:
    return {
        "AgentArns": ...,
    }


# OnPremConfigOutputTypeDef definition

class OnPremConfigOutputTypeDef(TypedDict):
    AgentArns: List[str],

DescribeLocationObjectStorageRequestTypeDef#

# DescribeLocationObjectStorageRequestTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import DescribeLocationObjectStorageRequestTypeDef


def get_value() -> DescribeLocationObjectStorageRequestTypeDef:
    return {
        "LocationArn": ...,
    }


# DescribeLocationObjectStorageRequestTypeDef definition

class DescribeLocationObjectStorageRequestTypeDef(TypedDict):
    LocationArn: str,

DescribeLocationS3RequestTypeDef#

# DescribeLocationS3RequestTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import DescribeLocationS3RequestTypeDef


def get_value() -> DescribeLocationS3RequestTypeDef:
    return {
        "LocationArn": ...,
    }


# DescribeLocationS3RequestTypeDef definition

class DescribeLocationS3RequestTypeDef(TypedDict):
    LocationArn: str,

DescribeLocationSmbRequestTypeDef#

# DescribeLocationSmbRequestTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import DescribeLocationSmbRequestTypeDef


def get_value() -> DescribeLocationSmbRequestTypeDef:
    return {
        "LocationArn": ...,
    }


# DescribeLocationSmbRequestTypeDef definition

class DescribeLocationSmbRequestTypeDef(TypedDict):
    LocationArn: str,

DescribeTaskExecutionRequestTypeDef#

# DescribeTaskExecutionRequestTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import DescribeTaskExecutionRequestTypeDef


def get_value() -> DescribeTaskExecutionRequestTypeDef:
    return {
        "TaskExecutionArn": ...,
    }


# DescribeTaskExecutionRequestTypeDef definition

class DescribeTaskExecutionRequestTypeDef(TypedDict):
    TaskExecutionArn: str,

ReportResultTypeDef#

# ReportResultTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import ReportResultTypeDef


def get_value() -> ReportResultTypeDef:
    return {
        "Status": ...,
    }


# ReportResultTypeDef definition

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

TaskExecutionFilesFailedDetailTypeDef#

# TaskExecutionFilesFailedDetailTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import TaskExecutionFilesFailedDetailTypeDef


def get_value() -> TaskExecutionFilesFailedDetailTypeDef:
    return {
        "Prepare": ...,
    }


# TaskExecutionFilesFailedDetailTypeDef definition

class TaskExecutionFilesFailedDetailTypeDef(TypedDict):
    Prepare: NotRequired[int],
    Transfer: NotRequired[int],
    Verify: NotRequired[int],
    Delete: NotRequired[int],

TaskExecutionFilesListedDetailTypeDef#

# TaskExecutionFilesListedDetailTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import TaskExecutionFilesListedDetailTypeDef


def get_value() -> TaskExecutionFilesListedDetailTypeDef:
    return {
        "AtSource": ...,
    }


# TaskExecutionFilesListedDetailTypeDef definition

class TaskExecutionFilesListedDetailTypeDef(TypedDict):
    AtSource: NotRequired[int],
    AtDestinationForDelete: NotRequired[int],

TaskExecutionResultDetailTypeDef#

# TaskExecutionResultDetailTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import TaskExecutionResultDetailTypeDef


def get_value() -> TaskExecutionResultDetailTypeDef:
    return {
        "PrepareDuration": ...,
    }


# 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

DescribeTaskRequestTypeDef#

# DescribeTaskRequestTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import DescribeTaskRequestTypeDef


def get_value() -> DescribeTaskRequestTypeDef:
    return {
        "TaskArn": ...,
    }


# DescribeTaskRequestTypeDef definition

class DescribeTaskRequestTypeDef(TypedDict):
    TaskArn: str,

TaskScheduleDetailsTypeDef#

# TaskScheduleDetailsTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import TaskScheduleDetailsTypeDef


def get_value() -> TaskScheduleDetailsTypeDef:
    return {
        "StatusUpdateTime": ...,
    }


# TaskScheduleDetailsTypeDef definition

class TaskScheduleDetailsTypeDef(TypedDict):
    StatusUpdateTime: NotRequired[datetime.datetime],
    DisabledReason: NotRequired[str],
    DisabledBy: NotRequired[ScheduleDisabledByType],  # (1)
  1. See ScheduleDisabledByType

Ec2ConfigTypeDef#

# Ec2ConfigTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import Ec2ConfigTypeDef


def get_value() -> Ec2ConfigTypeDef:
    return {
        "SubnetArn": ...,
    }


# Ec2ConfigTypeDef definition

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

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import PaginatorConfigTypeDef


def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }


# PaginatorConfigTypeDef definition

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

ListAgentsRequestTypeDef#

# ListAgentsRequestTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import ListAgentsRequestTypeDef


def get_value() -> ListAgentsRequestTypeDef:
    return {
        "MaxResults": ...,
    }


# ListAgentsRequestTypeDef definition

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

LocationFilterTypeDef#

# LocationFilterTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import LocationFilterTypeDef


def get_value() -> LocationFilterTypeDef:
    return {
        "Name": ...,
    }


# LocationFilterTypeDef definition

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

LocationListEntryTypeDef#

# LocationListEntryTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import LocationListEntryTypeDef


def get_value() -> LocationListEntryTypeDef:
    return {
        "LocationArn": ...,
    }


# LocationListEntryTypeDef definition

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

ListTagsForResourceRequestTypeDef#

# ListTagsForResourceRequestTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import ListTagsForResourceRequestTypeDef


def get_value() -> ListTagsForResourceRequestTypeDef:
    return {
        "ResourceArn": ...,
    }


# ListTagsForResourceRequestTypeDef definition

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

ListTaskExecutionsRequestTypeDef#

# ListTaskExecutionsRequestTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import ListTaskExecutionsRequestTypeDef


def get_value() -> ListTaskExecutionsRequestTypeDef:
    return {
        "TaskArn": ...,
    }


# ListTaskExecutionsRequestTypeDef definition

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

TaskExecutionListEntryTypeDef#

# TaskExecutionListEntryTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import TaskExecutionListEntryTypeDef


def get_value() -> TaskExecutionListEntryTypeDef:
    return {
        "TaskExecutionArn": ...,
    }


# TaskExecutionListEntryTypeDef definition

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

TaskFilterTypeDef#

# TaskFilterTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import TaskFilterTypeDef


def get_value() -> TaskFilterTypeDef:
    return {
        "Name": ...,
    }


# TaskFilterTypeDef definition

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

TaskListEntryTypeDef#

# TaskListEntryTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import TaskListEntryTypeDef


def get_value() -> TaskListEntryTypeDef:
    return {
        "TaskArn": ...,
    }


# TaskListEntryTypeDef definition

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

OnPremConfigTypeDef#

# OnPremConfigTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import OnPremConfigTypeDef


def get_value() -> OnPremConfigTypeDef:
    return {
        "AgentArns": ...,
    }


# OnPremConfigTypeDef definition

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

ReportDestinationS3TypeDef#

# ReportDestinationS3TypeDef TypedDict usage example

from types_boto3_datasync.type_defs import ReportDestinationS3TypeDef


def get_value() -> ReportDestinationS3TypeDef:
    return {
        "Subdirectory": ...,
    }


# ReportDestinationS3TypeDef definition

class ReportDestinationS3TypeDef(TypedDict):
    S3BucketArn: str,
    BucketAccessRoleArn: str,
    Subdirectory: NotRequired[str],

ReportOverrideTypeDef#

# ReportOverrideTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import ReportOverrideTypeDef


def get_value() -> ReportOverrideTypeDef:
    return {
        "ReportLevel": ...,
    }


# ReportOverrideTypeDef definition

class ReportOverrideTypeDef(TypedDict):
    ReportLevel: NotRequired[ReportLevelType],  # (1)
  1. See ReportLevelType

S3ManifestConfigTypeDef#

# S3ManifestConfigTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import S3ManifestConfigTypeDef


def get_value() -> S3ManifestConfigTypeDef:
    return {
        "ManifestObjectPath": ...,
    }


# S3ManifestConfigTypeDef definition

class S3ManifestConfigTypeDef(TypedDict):
    ManifestObjectPath: str,
    BucketAccessRoleArn: str,
    S3BucketArn: str,
    ManifestObjectVersionId: NotRequired[str],

UntagResourceRequestTypeDef#

# UntagResourceRequestTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import UntagResourceRequestTypeDef


def get_value() -> UntagResourceRequestTypeDef:
    return {
        "ResourceArn": ...,
    }


# UntagResourceRequestTypeDef definition

class UntagResourceRequestTypeDef(TypedDict):
    ResourceArn: str,
    Keys: Sequence[str],

UpdateAgentRequestTypeDef#

# UpdateAgentRequestTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import UpdateAgentRequestTypeDef


def get_value() -> UpdateAgentRequestTypeDef:
    return {
        "AgentArn": ...,
    }


# UpdateAgentRequestTypeDef definition

class UpdateAgentRequestTypeDef(TypedDict):
    AgentArn: str,
    Name: NotRequired[str],

UpdateLocationEfsRequestTypeDef#

# UpdateLocationEfsRequestTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import UpdateLocationEfsRequestTypeDef


def get_value() -> UpdateLocationEfsRequestTypeDef:
    return {
        "LocationArn": ...,
    }


# UpdateLocationEfsRequestTypeDef definition

class UpdateLocationEfsRequestTypeDef(TypedDict):
    LocationArn: str,
    Subdirectory: NotRequired[str],
    AccessPointArn: NotRequired[str],
    FileSystemAccessRoleArn: NotRequired[str],
    InTransitEncryption: NotRequired[EfsInTransitEncryptionType],  # (1)
  1. See EfsInTransitEncryptionType

UpdateLocationFsxLustreRequestTypeDef#

# UpdateLocationFsxLustreRequestTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import UpdateLocationFsxLustreRequestTypeDef


def get_value() -> UpdateLocationFsxLustreRequestTypeDef:
    return {
        "LocationArn": ...,
    }


# UpdateLocationFsxLustreRequestTypeDef definition

class UpdateLocationFsxLustreRequestTypeDef(TypedDict):
    LocationArn: str,
    Subdirectory: NotRequired[str],

UpdateLocationFsxWindowsRequestTypeDef#

# UpdateLocationFsxWindowsRequestTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import UpdateLocationFsxWindowsRequestTypeDef


def get_value() -> UpdateLocationFsxWindowsRequestTypeDef:
    return {
        "LocationArn": ...,
    }


# UpdateLocationFsxWindowsRequestTypeDef definition

class UpdateLocationFsxWindowsRequestTypeDef(TypedDict):
    LocationArn: str,
    Subdirectory: NotRequired[str],
    Domain: NotRequired[str],
    User: NotRequired[str],
    Password: NotRequired[str],

AgentListEntryTypeDef#

# AgentListEntryTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import AgentListEntryTypeDef


def get_value() -> AgentListEntryTypeDef:
    return {
        "AgentArn": ...,
    }


# AgentListEntryTypeDef definition

class AgentListEntryTypeDef(TypedDict):
    AgentArn: NotRequired[str],
    Name: NotRequired[str],
    Status: NotRequired[AgentStatusType],  # (1)
    Platform: NotRequired[PlatformTypeDef],  # (2)
  1. See AgentStatusType
  2. See PlatformTypeDef

UpdateLocationAzureBlobRequestTypeDef#

# UpdateLocationAzureBlobRequestTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import UpdateLocationAzureBlobRequestTypeDef


def get_value() -> UpdateLocationAzureBlobRequestTypeDef:
    return {
        "LocationArn": ...,
    }


# UpdateLocationAzureBlobRequestTypeDef definition

class UpdateLocationAzureBlobRequestTypeDef(TypedDict):
    LocationArn: str,
    Subdirectory: NotRequired[str],
    AuthenticationType: NotRequired[AzureBlobAuthenticationTypeType],  # (1)
    SasConfiguration: NotRequired[AzureBlobSasConfigurationTypeDef],  # (2)
    BlobType: NotRequired[AzureBlobTypeType],  # (3)
    AccessTier: NotRequired[AzureAccessTierType],  # (4)
    AgentArns: NotRequired[Sequence[str]],
  1. See AzureBlobAuthenticationTypeType
  2. See AzureBlobSasConfigurationTypeDef
  3. See AzureBlobTypeType
  4. See AzureAccessTierType

UpdateLocationObjectStorageRequestTypeDef#

# UpdateLocationObjectStorageRequestTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import UpdateLocationObjectStorageRequestTypeDef


def get_value() -> UpdateLocationObjectStorageRequestTypeDef:
    return {
        "LocationArn": ...,
    }


# UpdateLocationObjectStorageRequestTypeDef definition

class UpdateLocationObjectStorageRequestTypeDef(TypedDict):
    LocationArn: str,
    ServerPort: NotRequired[int],
    ServerProtocol: NotRequired[ObjectStorageServerProtocolType],  # (1)
    Subdirectory: NotRequired[str],
    ServerHostname: NotRequired[str],
    AccessKey: NotRequired[str],
    SecretKey: NotRequired[str],
    AgentArns: NotRequired[Sequence[str]],
    ServerCertificate: NotRequired[BlobTypeDef],
  1. See ObjectStorageServerProtocolType

CreateAgentRequestTypeDef#

# CreateAgentRequestTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import CreateAgentRequestTypeDef


def get_value() -> CreateAgentRequestTypeDef:
    return {
        "ActivationKey": ...,
    }


# CreateAgentRequestTypeDef definition

class CreateAgentRequestTypeDef(TypedDict):
    ActivationKey: str,
    AgentName: NotRequired[str],
    Tags: NotRequired[Sequence[TagListEntryTypeDef]],  # (1)
    VpcEndpointId: NotRequired[str],
    SubnetArns: NotRequired[Sequence[str]],
    SecurityGroupArns: NotRequired[Sequence[str]],
  1. See Sequence[TagListEntryTypeDef]

CreateLocationAzureBlobRequestTypeDef#

# CreateLocationAzureBlobRequestTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import CreateLocationAzureBlobRequestTypeDef


def get_value() -> CreateLocationAzureBlobRequestTypeDef:
    return {
        "ContainerUrl": ...,
    }


# CreateLocationAzureBlobRequestTypeDef definition

class CreateLocationAzureBlobRequestTypeDef(TypedDict):
    ContainerUrl: str,
    AuthenticationType: AzureBlobAuthenticationTypeType,  # (1)
    AgentArns: Sequence[str],
    SasConfiguration: NotRequired[AzureBlobSasConfigurationTypeDef],  # (2)
    BlobType: NotRequired[AzureBlobTypeType],  # (3)
    AccessTier: NotRequired[AzureAccessTierType],  # (4)
    Subdirectory: NotRequired[str],
    Tags: NotRequired[Sequence[TagListEntryTypeDef]],  # (5)
  1. See AzureBlobAuthenticationTypeType
  2. See AzureBlobSasConfigurationTypeDef
  3. See AzureBlobTypeType
  4. See AzureAccessTierType
  5. See Sequence[TagListEntryTypeDef]

CreateLocationFsxLustreRequestTypeDef#

# CreateLocationFsxLustreRequestTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import CreateLocationFsxLustreRequestTypeDef


def get_value() -> CreateLocationFsxLustreRequestTypeDef:
    return {
        "FsxFilesystemArn": ...,
    }


# CreateLocationFsxLustreRequestTypeDef definition

class CreateLocationFsxLustreRequestTypeDef(TypedDict):
    FsxFilesystemArn: str,
    SecurityGroupArns: Sequence[str],
    Subdirectory: NotRequired[str],
    Tags: NotRequired[Sequence[TagListEntryTypeDef]],  # (1)
  1. See Sequence[TagListEntryTypeDef]

CreateLocationFsxWindowsRequestTypeDef#

# CreateLocationFsxWindowsRequestTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import CreateLocationFsxWindowsRequestTypeDef


def get_value() -> CreateLocationFsxWindowsRequestTypeDef:
    return {
        "FsxFilesystemArn": ...,
    }


# CreateLocationFsxWindowsRequestTypeDef definition

class CreateLocationFsxWindowsRequestTypeDef(TypedDict):
    FsxFilesystemArn: str,
    SecurityGroupArns: Sequence[str],
    User: str,
    Password: str,
    Subdirectory: NotRequired[str],
    Tags: NotRequired[Sequence[TagListEntryTypeDef]],  # (1)
    Domain: NotRequired[str],
  1. See Sequence[TagListEntryTypeDef]

CreateLocationObjectStorageRequestTypeDef#

# CreateLocationObjectStorageRequestTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import CreateLocationObjectStorageRequestTypeDef


def get_value() -> CreateLocationObjectStorageRequestTypeDef:
    return {
        "ServerHostname": ...,
    }


# CreateLocationObjectStorageRequestTypeDef definition

class CreateLocationObjectStorageRequestTypeDef(TypedDict):
    ServerHostname: str,
    BucketName: str,
    AgentArns: Sequence[str],
    ServerPort: NotRequired[int],
    ServerProtocol: NotRequired[ObjectStorageServerProtocolType],  # (1)
    Subdirectory: NotRequired[str],
    AccessKey: NotRequired[str],
    SecretKey: NotRequired[str],
    Tags: NotRequired[Sequence[TagListEntryTypeDef]],  # (2)
    ServerCertificate: NotRequired[BlobTypeDef],
  1. See ObjectStorageServerProtocolType
  2. See Sequence[TagListEntryTypeDef]

TagResourceRequestTypeDef#

# TagResourceRequestTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import TagResourceRequestTypeDef


def get_value() -> TagResourceRequestTypeDef:
    return {
        "ResourceArn": ...,
    }


# TagResourceRequestTypeDef definition

class TagResourceRequestTypeDef(TypedDict):
    ResourceArn: str,
    Tags: Sequence[TagListEntryTypeDef],  # (1)
  1. See Sequence[TagListEntryTypeDef]

CreateAgentResponseTypeDef#

# CreateAgentResponseTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import CreateAgentResponseTypeDef


def get_value() -> CreateAgentResponseTypeDef:
    return {
        "AgentArn": ...,
    }


# CreateAgentResponseTypeDef definition

class CreateAgentResponseTypeDef(TypedDict):
    AgentArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateLocationAzureBlobResponseTypeDef#

# CreateLocationAzureBlobResponseTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import CreateLocationAzureBlobResponseTypeDef


def get_value() -> CreateLocationAzureBlobResponseTypeDef:
    return {
        "LocationArn": ...,
    }


# CreateLocationAzureBlobResponseTypeDef definition

class CreateLocationAzureBlobResponseTypeDef(TypedDict):
    LocationArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateLocationEfsResponseTypeDef#

# CreateLocationEfsResponseTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import CreateLocationEfsResponseTypeDef


def get_value() -> CreateLocationEfsResponseTypeDef:
    return {
        "LocationArn": ...,
    }


# CreateLocationEfsResponseTypeDef definition

class CreateLocationEfsResponseTypeDef(TypedDict):
    LocationArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateLocationFsxLustreResponseTypeDef#

# CreateLocationFsxLustreResponseTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import CreateLocationFsxLustreResponseTypeDef


def get_value() -> CreateLocationFsxLustreResponseTypeDef:
    return {
        "LocationArn": ...,
    }


# CreateLocationFsxLustreResponseTypeDef definition

class CreateLocationFsxLustreResponseTypeDef(TypedDict):
    LocationArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateLocationFsxOntapResponseTypeDef#

# CreateLocationFsxOntapResponseTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import CreateLocationFsxOntapResponseTypeDef


def get_value() -> CreateLocationFsxOntapResponseTypeDef:
    return {
        "LocationArn": ...,
    }


# CreateLocationFsxOntapResponseTypeDef definition

class CreateLocationFsxOntapResponseTypeDef(TypedDict):
    LocationArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateLocationFsxOpenZfsResponseTypeDef#

# CreateLocationFsxOpenZfsResponseTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import CreateLocationFsxOpenZfsResponseTypeDef


def get_value() -> CreateLocationFsxOpenZfsResponseTypeDef:
    return {
        "LocationArn": ...,
    }


# CreateLocationFsxOpenZfsResponseTypeDef definition

class CreateLocationFsxOpenZfsResponseTypeDef(TypedDict):
    LocationArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateLocationFsxWindowsResponseTypeDef#

# CreateLocationFsxWindowsResponseTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import CreateLocationFsxWindowsResponseTypeDef


def get_value() -> CreateLocationFsxWindowsResponseTypeDef:
    return {
        "LocationArn": ...,
    }


# CreateLocationFsxWindowsResponseTypeDef definition

class CreateLocationFsxWindowsResponseTypeDef(TypedDict):
    LocationArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateLocationHdfsResponseTypeDef#

# CreateLocationHdfsResponseTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import CreateLocationHdfsResponseTypeDef


def get_value() -> CreateLocationHdfsResponseTypeDef:
    return {
        "LocationArn": ...,
    }


# CreateLocationHdfsResponseTypeDef definition

class CreateLocationHdfsResponseTypeDef(TypedDict):
    LocationArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateLocationNfsResponseTypeDef#

# CreateLocationNfsResponseTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import CreateLocationNfsResponseTypeDef


def get_value() -> CreateLocationNfsResponseTypeDef:
    return {
        "LocationArn": ...,
    }


# CreateLocationNfsResponseTypeDef definition

class CreateLocationNfsResponseTypeDef(TypedDict):
    LocationArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateLocationObjectStorageResponseTypeDef#

# CreateLocationObjectStorageResponseTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import CreateLocationObjectStorageResponseTypeDef


def get_value() -> CreateLocationObjectStorageResponseTypeDef:
    return {
        "LocationArn": ...,
    }


# CreateLocationObjectStorageResponseTypeDef definition

class CreateLocationObjectStorageResponseTypeDef(TypedDict):
    LocationArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateLocationS3ResponseTypeDef#

# CreateLocationS3ResponseTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import CreateLocationS3ResponseTypeDef


def get_value() -> CreateLocationS3ResponseTypeDef:
    return {
        "LocationArn": ...,
    }


# CreateLocationS3ResponseTypeDef definition

class CreateLocationS3ResponseTypeDef(TypedDict):
    LocationArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateLocationSmbResponseTypeDef#

# CreateLocationSmbResponseTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import CreateLocationSmbResponseTypeDef


def get_value() -> CreateLocationSmbResponseTypeDef:
    return {
        "LocationArn": ...,
    }


# CreateLocationSmbResponseTypeDef definition

class CreateLocationSmbResponseTypeDef(TypedDict):
    LocationArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateTaskResponseTypeDef#

# CreateTaskResponseTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import CreateTaskResponseTypeDef


def get_value() -> CreateTaskResponseTypeDef:
    return {
        "TaskArn": ...,
    }


# CreateTaskResponseTypeDef definition

class CreateTaskResponseTypeDef(TypedDict):
    TaskArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DescribeLocationAzureBlobResponseTypeDef#

# DescribeLocationAzureBlobResponseTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import DescribeLocationAzureBlobResponseTypeDef


def get_value() -> DescribeLocationAzureBlobResponseTypeDef:
    return {
        "LocationArn": ...,
    }


# DescribeLocationAzureBlobResponseTypeDef definition

class DescribeLocationAzureBlobResponseTypeDef(TypedDict):
    LocationArn: str,
    LocationUri: str,
    AuthenticationType: AzureBlobAuthenticationTypeType,  # (1)
    BlobType: AzureBlobTypeType,  # (2)
    AccessTier: AzureAccessTierType,  # (3)
    AgentArns: List[str],
    CreationTime: datetime.datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See AzureBlobAuthenticationTypeType
  2. See AzureBlobTypeType
  3. See AzureAccessTierType
  4. See ResponseMetadataTypeDef

DescribeLocationFsxLustreResponseTypeDef#

# DescribeLocationFsxLustreResponseTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import DescribeLocationFsxLustreResponseTypeDef


def get_value() -> DescribeLocationFsxLustreResponseTypeDef:
    return {
        "LocationArn": ...,
    }


# DescribeLocationFsxLustreResponseTypeDef definition

class DescribeLocationFsxLustreResponseTypeDef(TypedDict):
    LocationArn: str,
    LocationUri: str,
    SecurityGroupArns: List[str],
    CreationTime: datetime.datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DescribeLocationFsxWindowsResponseTypeDef#

# DescribeLocationFsxWindowsResponseTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import DescribeLocationFsxWindowsResponseTypeDef


def get_value() -> DescribeLocationFsxWindowsResponseTypeDef:
    return {
        "LocationArn": ...,
    }


# DescribeLocationFsxWindowsResponseTypeDef definition

class DescribeLocationFsxWindowsResponseTypeDef(TypedDict):
    LocationArn: str,
    LocationUri: str,
    SecurityGroupArns: List[str],
    CreationTime: datetime.datetime,
    User: str,
    Domain: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DescribeLocationObjectStorageResponseTypeDef#

# DescribeLocationObjectStorageResponseTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import DescribeLocationObjectStorageResponseTypeDef


def get_value() -> DescribeLocationObjectStorageResponseTypeDef:
    return {
        "LocationArn": ...,
    }


# DescribeLocationObjectStorageResponseTypeDef definition

class DescribeLocationObjectStorageResponseTypeDef(TypedDict):
    LocationArn: str,
    LocationUri: str,
    AccessKey: str,
    ServerPort: int,
    ServerProtocol: ObjectStorageServerProtocolType,  # (1)
    AgentArns: List[str],
    CreationTime: datetime.datetime,
    ServerCertificate: bytes,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ObjectStorageServerProtocolType
  2. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import ListTagsForResourceResponseTypeDef


def get_value() -> ListTagsForResourceResponseTypeDef:
    return {
        "Tags": ...,
    }


# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    Tags: List[TagListEntryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See List[TagListEntryTypeDef]
  2. See ResponseMetadataTypeDef

StartTaskExecutionResponseTypeDef#

# StartTaskExecutionResponseTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import StartTaskExecutionResponseTypeDef


def get_value() -> StartTaskExecutionResponseTypeDef:
    return {
        "TaskExecutionArn": ...,
    }


# StartTaskExecutionResponseTypeDef definition

class StartTaskExecutionResponseTypeDef(TypedDict):
    TaskExecutionArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateLocationHdfsRequestTypeDef#

# CreateLocationHdfsRequestTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import CreateLocationHdfsRequestTypeDef


def get_value() -> CreateLocationHdfsRequestTypeDef:
    return {
        "NameNodes": ...,
    }


# CreateLocationHdfsRequestTypeDef definition

class CreateLocationHdfsRequestTypeDef(TypedDict):
    NameNodes: Sequence[HdfsNameNodeTypeDef],  # (1)
    AuthenticationType: HdfsAuthenticationTypeType,  # (2)
    AgentArns: Sequence[str],
    Subdirectory: NotRequired[str],
    BlockSize: NotRequired[int],
    ReplicationFactor: NotRequired[int],
    KmsKeyProviderUri: NotRequired[str],
    QopConfiguration: NotRequired[QopConfigurationTypeDef],  # (3)
    SimpleUser: NotRequired[str],
    KerberosPrincipal: NotRequired[str],
    KerberosKeytab: NotRequired[BlobTypeDef],
    KerberosKrb5Conf: NotRequired[BlobTypeDef],
    Tags: NotRequired[Sequence[TagListEntryTypeDef]],  # (4)
  1. See Sequence[HdfsNameNodeTypeDef]
  2. See HdfsAuthenticationTypeType
  3. See QopConfigurationTypeDef
  4. See Sequence[TagListEntryTypeDef]

DescribeLocationHdfsResponseTypeDef#

# DescribeLocationHdfsResponseTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import DescribeLocationHdfsResponseTypeDef


def get_value() -> DescribeLocationHdfsResponseTypeDef:
    return {
        "LocationArn": ...,
    }


# DescribeLocationHdfsResponseTypeDef definition

class DescribeLocationHdfsResponseTypeDef(TypedDict):
    LocationArn: str,
    LocationUri: str,
    NameNodes: List[HdfsNameNodeTypeDef],  # (1)
    BlockSize: int,
    ReplicationFactor: int,
    KmsKeyProviderUri: str,
    QopConfiguration: QopConfigurationTypeDef,  # (2)
    AuthenticationType: HdfsAuthenticationTypeType,  # (3)
    SimpleUser: str,
    KerberosPrincipal: str,
    AgentArns: List[str],
    CreationTime: datetime.datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See List[HdfsNameNodeTypeDef]
  2. See QopConfigurationTypeDef
  3. See HdfsAuthenticationTypeType
  4. See ResponseMetadataTypeDef

UpdateLocationHdfsRequestTypeDef#

# UpdateLocationHdfsRequestTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import UpdateLocationHdfsRequestTypeDef


def get_value() -> UpdateLocationHdfsRequestTypeDef:
    return {
        "LocationArn": ...,
    }


# UpdateLocationHdfsRequestTypeDef definition

class UpdateLocationHdfsRequestTypeDef(TypedDict):
    LocationArn: str,
    Subdirectory: NotRequired[str],
    NameNodes: NotRequired[Sequence[HdfsNameNodeTypeDef]],  # (1)
    BlockSize: NotRequired[int],
    ReplicationFactor: NotRequired[int],
    KmsKeyProviderUri: NotRequired[str],
    QopConfiguration: NotRequired[QopConfigurationTypeDef],  # (2)
    AuthenticationType: NotRequired[HdfsAuthenticationTypeType],  # (3)
    SimpleUser: NotRequired[str],
    KerberosPrincipal: NotRequired[str],
    KerberosKeytab: NotRequired[BlobTypeDef],
    KerberosKrb5Conf: NotRequired[BlobTypeDef],
    AgentArns: NotRequired[Sequence[str]],
  1. See Sequence[HdfsNameNodeTypeDef]
  2. See QopConfigurationTypeDef
  3. See HdfsAuthenticationTypeType

FsxProtocolNfsTypeDef#

# FsxProtocolNfsTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import FsxProtocolNfsTypeDef


def get_value() -> FsxProtocolNfsTypeDef:
    return {
        "MountOptions": ...,
    }


# FsxProtocolNfsTypeDef definition

class FsxProtocolNfsTypeDef(TypedDict):
    MountOptions: NotRequired[NfsMountOptionsTypeDef],  # (1)
  1. See NfsMountOptionsTypeDef

CreateLocationS3RequestTypeDef#

# CreateLocationS3RequestTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import CreateLocationS3RequestTypeDef


def get_value() -> CreateLocationS3RequestTypeDef:
    return {
        "S3BucketArn": ...,
    }


# CreateLocationS3RequestTypeDef definition

class CreateLocationS3RequestTypeDef(TypedDict):
    S3BucketArn: str,
    S3Config: S3ConfigTypeDef,  # (1)
    Subdirectory: NotRequired[str],
    S3StorageClass: NotRequired[S3StorageClassType],  # (2)
    AgentArns: NotRequired[Sequence[str]],
    Tags: NotRequired[Sequence[TagListEntryTypeDef]],  # (3)
  1. See S3ConfigTypeDef
  2. See S3StorageClassType
  3. See Sequence[TagListEntryTypeDef]

DescribeLocationS3ResponseTypeDef#

# DescribeLocationS3ResponseTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import DescribeLocationS3ResponseTypeDef


def get_value() -> DescribeLocationS3ResponseTypeDef:
    return {
        "LocationArn": ...,
    }


# DescribeLocationS3ResponseTypeDef definition

class DescribeLocationS3ResponseTypeDef(TypedDict):
    LocationArn: str,
    LocationUri: str,
    S3StorageClass: S3StorageClassType,  # (1)
    S3Config: S3ConfigTypeDef,  # (2)
    AgentArns: List[str],
    CreationTime: datetime.datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See S3StorageClassType
  2. See S3ConfigTypeDef
  3. See ResponseMetadataTypeDef

UpdateLocationS3RequestTypeDef#

# UpdateLocationS3RequestTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import UpdateLocationS3RequestTypeDef


def get_value() -> UpdateLocationS3RequestTypeDef:
    return {
        "LocationArn": ...,
    }


# UpdateLocationS3RequestTypeDef definition

class UpdateLocationS3RequestTypeDef(TypedDict):
    LocationArn: str,
    Subdirectory: NotRequired[str],
    S3StorageClass: NotRequired[S3StorageClassType],  # (1)
    S3Config: NotRequired[S3ConfigTypeDef],  # (2)
  1. See S3StorageClassType
  2. See S3ConfigTypeDef

CreateLocationSmbRequestTypeDef#

# CreateLocationSmbRequestTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import CreateLocationSmbRequestTypeDef


def get_value() -> CreateLocationSmbRequestTypeDef:
    return {
        "Subdirectory": ...,
    }


# CreateLocationSmbRequestTypeDef definition

class CreateLocationSmbRequestTypeDef(TypedDict):
    Subdirectory: str,
    ServerHostname: str,
    AgentArns: Sequence[str],
    User: NotRequired[str],
    Domain: NotRequired[str],
    Password: NotRequired[str],
    MountOptions: NotRequired[SmbMountOptionsTypeDef],  # (1)
    Tags: NotRequired[Sequence[TagListEntryTypeDef]],  # (2)
    AuthenticationType: NotRequired[SmbAuthenticationTypeType],  # (3)
    DnsIpAddresses: NotRequired[Sequence[str]],
    KerberosPrincipal: NotRequired[str],
    KerberosKeytab: NotRequired[BlobTypeDef],
    KerberosKrb5Conf: NotRequired[BlobTypeDef],
  1. See SmbMountOptionsTypeDef
  2. See Sequence[TagListEntryTypeDef]
  3. See SmbAuthenticationTypeType

DescribeLocationSmbResponseTypeDef#

# DescribeLocationSmbResponseTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import DescribeLocationSmbResponseTypeDef


def get_value() -> DescribeLocationSmbResponseTypeDef:
    return {
        "LocationArn": ...,
    }


# DescribeLocationSmbResponseTypeDef definition

class DescribeLocationSmbResponseTypeDef(TypedDict):
    LocationArn: str,
    LocationUri: str,
    AgentArns: List[str],
    User: str,
    Domain: str,
    MountOptions: SmbMountOptionsTypeDef,  # (1)
    CreationTime: datetime.datetime,
    DnsIpAddresses: List[str],
    KerberosPrincipal: str,
    AuthenticationType: SmbAuthenticationTypeType,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See SmbMountOptionsTypeDef
  2. See SmbAuthenticationTypeType
  3. See ResponseMetadataTypeDef

FsxProtocolSmbTypeDef#

# FsxProtocolSmbTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import FsxProtocolSmbTypeDef


def get_value() -> FsxProtocolSmbTypeDef:
    return {
        "Domain": ...,
    }


# FsxProtocolSmbTypeDef definition

class FsxProtocolSmbTypeDef(TypedDict):
    Password: str,
    User: str,
    Domain: NotRequired[str],
    MountOptions: NotRequired[SmbMountOptionsTypeDef],  # (1)
  1. See SmbMountOptionsTypeDef

FsxUpdateProtocolSmbTypeDef#

# FsxUpdateProtocolSmbTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import FsxUpdateProtocolSmbTypeDef


def get_value() -> FsxUpdateProtocolSmbTypeDef:
    return {
        "Domain": ...,
    }


# FsxUpdateProtocolSmbTypeDef definition

class FsxUpdateProtocolSmbTypeDef(TypedDict):
    Domain: NotRequired[str],
    MountOptions: NotRequired[SmbMountOptionsTypeDef],  # (1)
    Password: NotRequired[str],
    User: NotRequired[str],
  1. See SmbMountOptionsTypeDef

UpdateLocationSmbRequestTypeDef#

# UpdateLocationSmbRequestTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import UpdateLocationSmbRequestTypeDef


def get_value() -> UpdateLocationSmbRequestTypeDef:
    return {
        "LocationArn": ...,
    }


# UpdateLocationSmbRequestTypeDef definition

class UpdateLocationSmbRequestTypeDef(TypedDict):
    LocationArn: str,
    Subdirectory: NotRequired[str],
    ServerHostname: NotRequired[str],
    User: NotRequired[str],
    Domain: NotRequired[str],
    Password: NotRequired[str],
    AgentArns: NotRequired[Sequence[str]],
    MountOptions: NotRequired[SmbMountOptionsTypeDef],  # (1)
    AuthenticationType: NotRequired[SmbAuthenticationTypeType],  # (2)
    DnsIpAddresses: NotRequired[Sequence[str]],
    KerberosPrincipal: NotRequired[str],
    KerberosKeytab: NotRequired[BlobTypeDef],
    KerberosKrb5Conf: NotRequired[BlobTypeDef],
  1. See SmbMountOptionsTypeDef
  2. See SmbAuthenticationTypeType

UpdateTaskExecutionRequestTypeDef#

# UpdateTaskExecutionRequestTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import UpdateTaskExecutionRequestTypeDef


def get_value() -> UpdateTaskExecutionRequestTypeDef:
    return {
        "TaskExecutionArn": ...,
    }


# UpdateTaskExecutionRequestTypeDef definition

class UpdateTaskExecutionRequestTypeDef(TypedDict):
    TaskExecutionArn: str,
    Options: OptionsTypeDef,  # (1)
  1. See OptionsTypeDef

DescribeAgentResponseTypeDef#

# DescribeAgentResponseTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import DescribeAgentResponseTypeDef


def get_value() -> DescribeAgentResponseTypeDef:
    return {
        "AgentArn": ...,
    }


# DescribeAgentResponseTypeDef definition

class DescribeAgentResponseTypeDef(TypedDict):
    AgentArn: str,
    Name: str,
    Status: AgentStatusType,  # (1)
    LastConnectionTime: datetime.datetime,
    CreationTime: datetime.datetime,
    EndpointType: EndpointTypeType,  # (2)
    PrivateLinkConfig: PrivateLinkConfigTypeDef,  # (3)
    Platform: PlatformTypeDef,  # (4)
    ResponseMetadata: ResponseMetadataTypeDef,  # (5)
  1. See AgentStatusType
  2. See EndpointTypeType
  3. See PrivateLinkConfigTypeDef
  4. See PlatformTypeDef
  5. See ResponseMetadataTypeDef

DescribeLocationEfsResponseTypeDef#

# DescribeLocationEfsResponseTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import DescribeLocationEfsResponseTypeDef


def get_value() -> DescribeLocationEfsResponseTypeDef:
    return {
        "LocationArn": ...,
    }


# DescribeLocationEfsResponseTypeDef definition

class DescribeLocationEfsResponseTypeDef(TypedDict):
    LocationArn: str,
    LocationUri: str,
    Ec2Config: Ec2ConfigOutputTypeDef,  # (1)
    CreationTime: datetime.datetime,
    AccessPointArn: str,
    FileSystemAccessRoleArn: str,
    InTransitEncryption: EfsInTransitEncryptionType,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See Ec2ConfigOutputTypeDef
  2. See EfsInTransitEncryptionType
  3. See ResponseMetadataTypeDef

DescribeLocationNfsResponseTypeDef#

# DescribeLocationNfsResponseTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import DescribeLocationNfsResponseTypeDef


def get_value() -> DescribeLocationNfsResponseTypeDef:
    return {
        "LocationArn": ...,
    }


# DescribeLocationNfsResponseTypeDef definition

class DescribeLocationNfsResponseTypeDef(TypedDict):
    LocationArn: str,
    LocationUri: str,
    OnPremConfig: OnPremConfigOutputTypeDef,  # (1)
    MountOptions: NfsMountOptionsTypeDef,  # (2)
    CreationTime: datetime.datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See OnPremConfigOutputTypeDef
  2. See NfsMountOptionsTypeDef
  3. See ResponseMetadataTypeDef

ListAgentsRequestPaginateTypeDef#

# ListAgentsRequestPaginateTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import ListAgentsRequestPaginateTypeDef


def get_value() -> ListAgentsRequestPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }


# ListAgentsRequestPaginateTypeDef definition

class ListAgentsRequestPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListTagsForResourceRequestPaginateTypeDef#

# ListTagsForResourceRequestPaginateTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import ListTagsForResourceRequestPaginateTypeDef


def get_value() -> ListTagsForResourceRequestPaginateTypeDef:
    return {
        "ResourceArn": ...,
    }


# ListTagsForResourceRequestPaginateTypeDef definition

class ListTagsForResourceRequestPaginateTypeDef(TypedDict):
    ResourceArn: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListTaskExecutionsRequestPaginateTypeDef#

# ListTaskExecutionsRequestPaginateTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import ListTaskExecutionsRequestPaginateTypeDef


def get_value() -> ListTaskExecutionsRequestPaginateTypeDef:
    return {
        "TaskArn": ...,
    }


# ListTaskExecutionsRequestPaginateTypeDef definition

class ListTaskExecutionsRequestPaginateTypeDef(TypedDict):
    TaskArn: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListLocationsRequestPaginateTypeDef#

# ListLocationsRequestPaginateTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import ListLocationsRequestPaginateTypeDef


def get_value() -> ListLocationsRequestPaginateTypeDef:
    return {
        "Filters": ...,
    }


# ListLocationsRequestPaginateTypeDef definition

class ListLocationsRequestPaginateTypeDef(TypedDict):
    Filters: NotRequired[Sequence[LocationFilterTypeDef]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See Sequence[LocationFilterTypeDef]
  2. See PaginatorConfigTypeDef

ListLocationsRequestTypeDef#

# ListLocationsRequestTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import ListLocationsRequestTypeDef


def get_value() -> ListLocationsRequestTypeDef:
    return {
        "MaxResults": ...,
    }


# ListLocationsRequestTypeDef definition

class ListLocationsRequestTypeDef(TypedDict):
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
    Filters: NotRequired[Sequence[LocationFilterTypeDef]],  # (1)
  1. See Sequence[LocationFilterTypeDef]

ListLocationsResponseTypeDef#

# ListLocationsResponseTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import ListLocationsResponseTypeDef


def get_value() -> ListLocationsResponseTypeDef:
    return {
        "Locations": ...,
    }


# ListLocationsResponseTypeDef definition

class ListLocationsResponseTypeDef(TypedDict):
    Locations: List[LocationListEntryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See List[LocationListEntryTypeDef]
  2. See ResponseMetadataTypeDef

ListTaskExecutionsResponseTypeDef#

# ListTaskExecutionsResponseTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import ListTaskExecutionsResponseTypeDef


def get_value() -> ListTaskExecutionsResponseTypeDef:
    return {
        "TaskExecutions": ...,
    }


# ListTaskExecutionsResponseTypeDef definition

class ListTaskExecutionsResponseTypeDef(TypedDict):
    TaskExecutions: List[TaskExecutionListEntryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See List[TaskExecutionListEntryTypeDef]
  2. See ResponseMetadataTypeDef

ListTasksRequestPaginateTypeDef#

# ListTasksRequestPaginateTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import ListTasksRequestPaginateTypeDef


def get_value() -> ListTasksRequestPaginateTypeDef:
    return {
        "Filters": ...,
    }


# ListTasksRequestPaginateTypeDef definition

class ListTasksRequestPaginateTypeDef(TypedDict):
    Filters: NotRequired[Sequence[TaskFilterTypeDef]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See Sequence[TaskFilterTypeDef]
  2. See PaginatorConfigTypeDef

ListTasksRequestTypeDef#

# ListTasksRequestTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import ListTasksRequestTypeDef


def get_value() -> ListTasksRequestTypeDef:
    return {
        "MaxResults": ...,
    }


# ListTasksRequestTypeDef definition

class ListTasksRequestTypeDef(TypedDict):
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
    Filters: NotRequired[Sequence[TaskFilterTypeDef]],  # (1)
  1. See Sequence[TaskFilterTypeDef]

ListTasksResponseTypeDef#

# ListTasksResponseTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import ListTasksResponseTypeDef


def get_value() -> ListTasksResponseTypeDef:
    return {
        "Tasks": ...,
    }


# ListTasksResponseTypeDef definition

class ListTasksResponseTypeDef(TypedDict):
    Tasks: List[TaskListEntryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See List[TaskListEntryTypeDef]
  2. See ResponseMetadataTypeDef

ReportDestinationTypeDef#

# ReportDestinationTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import ReportDestinationTypeDef


def get_value() -> ReportDestinationTypeDef:
    return {
        "S3": ...,
    }


# ReportDestinationTypeDef definition

class ReportDestinationTypeDef(TypedDict):
    S3: NotRequired[ReportDestinationS3TypeDef],  # (1)
  1. See ReportDestinationS3TypeDef

ReportOverridesTypeDef#

# ReportOverridesTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import ReportOverridesTypeDef


def get_value() -> ReportOverridesTypeDef:
    return {
        "Transferred": ...,
    }


# ReportOverridesTypeDef definition

class ReportOverridesTypeDef(TypedDict):
    Transferred: NotRequired[ReportOverrideTypeDef],  # (1)
    Verified: NotRequired[ReportOverrideTypeDef],  # (1)
    Deleted: NotRequired[ReportOverrideTypeDef],  # (1)
    Skipped: NotRequired[ReportOverrideTypeDef],  # (1)
  1. See ReportOverrideTypeDef
  2. See ReportOverrideTypeDef
  3. See ReportOverrideTypeDef
  4. See ReportOverrideTypeDef

SourceManifestConfigTypeDef#

# SourceManifestConfigTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import SourceManifestConfigTypeDef


def get_value() -> SourceManifestConfigTypeDef:
    return {
        "S3": ...,
    }


# SourceManifestConfigTypeDef definition

class SourceManifestConfigTypeDef(TypedDict):
    S3: S3ManifestConfigTypeDef,  # (1)
  1. See S3ManifestConfigTypeDef

ListAgentsResponseTypeDef#

# ListAgentsResponseTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import ListAgentsResponseTypeDef


def get_value() -> ListAgentsResponseTypeDef:
    return {
        "Agents": ...,
    }


# ListAgentsResponseTypeDef definition

class ListAgentsResponseTypeDef(TypedDict):
    Agents: List[AgentListEntryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See List[AgentListEntryTypeDef]
  2. See ResponseMetadataTypeDef

FsxProtocolTypeDef#

# FsxProtocolTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import FsxProtocolTypeDef


def get_value() -> FsxProtocolTypeDef:
    return {
        "NFS": ...,
    }


# FsxProtocolTypeDef definition

class FsxProtocolTypeDef(TypedDict):
    NFS: NotRequired[FsxProtocolNfsTypeDef],  # (1)
    SMB: NotRequired[FsxProtocolSmbTypeDef],  # (2)
  1. See FsxProtocolNfsTypeDef
  2. See FsxProtocolSmbTypeDef

FsxUpdateProtocolTypeDef#

# FsxUpdateProtocolTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import FsxUpdateProtocolTypeDef


def get_value() -> FsxUpdateProtocolTypeDef:
    return {
        "NFS": ...,
    }


# FsxUpdateProtocolTypeDef definition

class FsxUpdateProtocolTypeDef(TypedDict):
    NFS: NotRequired[FsxProtocolNfsTypeDef],  # (1)
    SMB: NotRequired[FsxUpdateProtocolSmbTypeDef],  # (2)
  1. See FsxProtocolNfsTypeDef
  2. See FsxUpdateProtocolSmbTypeDef

CreateLocationEfsRequestTypeDef#

# CreateLocationEfsRequestTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import CreateLocationEfsRequestTypeDef


def get_value() -> CreateLocationEfsRequestTypeDef:
    return {
        "EfsFilesystemArn": ...,
    }


# CreateLocationEfsRequestTypeDef definition

class CreateLocationEfsRequestTypeDef(TypedDict):
    EfsFilesystemArn: str,
    Ec2Config: Ec2ConfigUnionTypeDef,  # (1)
    Subdirectory: NotRequired[str],
    Tags: NotRequired[Sequence[TagListEntryTypeDef]],  # (2)
    AccessPointArn: NotRequired[str],
    FileSystemAccessRoleArn: NotRequired[str],
    InTransitEncryption: NotRequired[EfsInTransitEncryptionType],  # (3)
  1. See Ec2ConfigUnionTypeDef
  2. See Sequence[TagListEntryTypeDef]
  3. See EfsInTransitEncryptionType

CreateLocationNfsRequestTypeDef#

# CreateLocationNfsRequestTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import CreateLocationNfsRequestTypeDef


def get_value() -> CreateLocationNfsRequestTypeDef:
    return {
        "Subdirectory": ...,
    }


# CreateLocationNfsRequestTypeDef definition

class CreateLocationNfsRequestTypeDef(TypedDict):
    Subdirectory: str,
    ServerHostname: str,
    OnPremConfig: OnPremConfigUnionTypeDef,  # (1)
    MountOptions: NotRequired[NfsMountOptionsTypeDef],  # (2)
    Tags: NotRequired[Sequence[TagListEntryTypeDef]],  # (3)
  1. See OnPremConfigUnionTypeDef
  2. See NfsMountOptionsTypeDef
  3. See Sequence[TagListEntryTypeDef]

UpdateLocationNfsRequestTypeDef#

# UpdateLocationNfsRequestTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import UpdateLocationNfsRequestTypeDef


def get_value() -> UpdateLocationNfsRequestTypeDef:
    return {
        "LocationArn": ...,
    }


# UpdateLocationNfsRequestTypeDef definition

class UpdateLocationNfsRequestTypeDef(TypedDict):
    LocationArn: str,
    Subdirectory: NotRequired[str],
    ServerHostname: NotRequired[str],
    OnPremConfig: NotRequired[OnPremConfigUnionTypeDef],  # (1)
    MountOptions: NotRequired[NfsMountOptionsTypeDef],  # (2)
  1. See OnPremConfigUnionTypeDef
  2. See NfsMountOptionsTypeDef

TaskReportConfigTypeDef#

# TaskReportConfigTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import TaskReportConfigTypeDef


def get_value() -> TaskReportConfigTypeDef:
    return {
        "Destination": ...,
    }


# TaskReportConfigTypeDef definition

class TaskReportConfigTypeDef(TypedDict):
    Destination: NotRequired[ReportDestinationTypeDef],  # (1)
    OutputType: NotRequired[ReportOutputTypeType],  # (2)
    ReportLevel: NotRequired[ReportLevelType],  # (3)
    ObjectVersionIds: NotRequired[ObjectVersionIdsType],  # (4)
    Overrides: NotRequired[ReportOverridesTypeDef],  # (5)
  1. See ReportDestinationTypeDef
  2. See ReportOutputTypeType
  3. See ReportLevelType
  4. See ObjectVersionIdsType
  5. See ReportOverridesTypeDef

ManifestConfigTypeDef#

# ManifestConfigTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import ManifestConfigTypeDef


def get_value() -> ManifestConfigTypeDef:
    return {
        "Action": ...,
    }


# ManifestConfigTypeDef definition

class ManifestConfigTypeDef(TypedDict):
    Action: NotRequired[ManifestActionType],  # (1)
    Format: NotRequired[ManifestFormatType],  # (2)
    Source: NotRequired[SourceManifestConfigTypeDef],  # (3)
  1. See ManifestActionType
  2. See ManifestFormatType
  3. See SourceManifestConfigTypeDef

CreateLocationFsxOntapRequestTypeDef#

# CreateLocationFsxOntapRequestTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import CreateLocationFsxOntapRequestTypeDef


def get_value() -> CreateLocationFsxOntapRequestTypeDef:
    return {
        "Protocol": ...,
    }


# CreateLocationFsxOntapRequestTypeDef definition

class CreateLocationFsxOntapRequestTypeDef(TypedDict):
    Protocol: FsxProtocolTypeDef,  # (1)
    SecurityGroupArns: Sequence[str],
    StorageVirtualMachineArn: str,
    Subdirectory: NotRequired[str],
    Tags: NotRequired[Sequence[TagListEntryTypeDef]],  # (2)
  1. See FsxProtocolTypeDef
  2. See Sequence[TagListEntryTypeDef]

CreateLocationFsxOpenZfsRequestTypeDef#

# CreateLocationFsxOpenZfsRequestTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import CreateLocationFsxOpenZfsRequestTypeDef


def get_value() -> CreateLocationFsxOpenZfsRequestTypeDef:
    return {
        "FsxFilesystemArn": ...,
    }


# CreateLocationFsxOpenZfsRequestTypeDef definition

class CreateLocationFsxOpenZfsRequestTypeDef(TypedDict):
    FsxFilesystemArn: str,
    Protocol: FsxProtocolTypeDef,  # (1)
    SecurityGroupArns: Sequence[str],
    Subdirectory: NotRequired[str],
    Tags: NotRequired[Sequence[TagListEntryTypeDef]],  # (2)
  1. See FsxProtocolTypeDef
  2. See Sequence[TagListEntryTypeDef]

DescribeLocationFsxOntapResponseTypeDef#

# DescribeLocationFsxOntapResponseTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import DescribeLocationFsxOntapResponseTypeDef


def get_value() -> DescribeLocationFsxOntapResponseTypeDef:
    return {
        "CreationTime": ...,
    }


# DescribeLocationFsxOntapResponseTypeDef definition

class DescribeLocationFsxOntapResponseTypeDef(TypedDict):
    CreationTime: datetime.datetime,
    LocationArn: str,
    LocationUri: str,
    Protocol: FsxProtocolTypeDef,  # (1)
    SecurityGroupArns: List[str],
    StorageVirtualMachineArn: str,
    FsxFilesystemArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See FsxProtocolTypeDef
  2. See ResponseMetadataTypeDef

DescribeLocationFsxOpenZfsResponseTypeDef#

# DescribeLocationFsxOpenZfsResponseTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import DescribeLocationFsxOpenZfsResponseTypeDef


def get_value() -> DescribeLocationFsxOpenZfsResponseTypeDef:
    return {
        "LocationArn": ...,
    }


# DescribeLocationFsxOpenZfsResponseTypeDef definition

class DescribeLocationFsxOpenZfsResponseTypeDef(TypedDict):
    LocationArn: str,
    LocationUri: str,
    SecurityGroupArns: List[str],
    Protocol: FsxProtocolTypeDef,  # (1)
    CreationTime: datetime.datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See FsxProtocolTypeDef
  2. See ResponseMetadataTypeDef

UpdateLocationFsxOpenZfsRequestTypeDef#

# UpdateLocationFsxOpenZfsRequestTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import UpdateLocationFsxOpenZfsRequestTypeDef


def get_value() -> UpdateLocationFsxOpenZfsRequestTypeDef:
    return {
        "LocationArn": ...,
    }


# UpdateLocationFsxOpenZfsRequestTypeDef definition

class UpdateLocationFsxOpenZfsRequestTypeDef(TypedDict):
    LocationArn: str,
    Protocol: NotRequired[FsxProtocolTypeDef],  # (1)
    Subdirectory: NotRequired[str],
  1. See FsxProtocolTypeDef

UpdateLocationFsxOntapRequestTypeDef#

# UpdateLocationFsxOntapRequestTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import UpdateLocationFsxOntapRequestTypeDef


def get_value() -> UpdateLocationFsxOntapRequestTypeDef:
    return {
        "LocationArn": ...,
    }


# UpdateLocationFsxOntapRequestTypeDef definition

class UpdateLocationFsxOntapRequestTypeDef(TypedDict):
    LocationArn: str,
    Protocol: NotRequired[FsxUpdateProtocolTypeDef],  # (1)
    Subdirectory: NotRequired[str],
  1. See FsxUpdateProtocolTypeDef

CreateTaskRequestTypeDef#

# CreateTaskRequestTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import CreateTaskRequestTypeDef


def get_value() -> CreateTaskRequestTypeDef:
    return {
        "SourceLocationArn": ...,
    }


# CreateTaskRequestTypeDef definition

class CreateTaskRequestTypeDef(TypedDict):
    SourceLocationArn: str,
    DestinationLocationArn: str,
    CloudWatchLogGroupArn: NotRequired[str],
    Name: NotRequired[str],
    Options: NotRequired[OptionsTypeDef],  # (1)
    Excludes: NotRequired[Sequence[FilterRuleTypeDef]],  # (2)
    Schedule: NotRequired[TaskScheduleTypeDef],  # (3)
    Tags: NotRequired[Sequence[TagListEntryTypeDef]],  # (4)
    Includes: NotRequired[Sequence[FilterRuleTypeDef]],  # (2)
    ManifestConfig: NotRequired[ManifestConfigTypeDef],  # (6)
    TaskReportConfig: NotRequired[TaskReportConfigTypeDef],  # (7)
    TaskMode: NotRequired[TaskModeType],  # (8)
  1. See OptionsTypeDef
  2. See Sequence[FilterRuleTypeDef]
  3. See TaskScheduleTypeDef
  4. See Sequence[TagListEntryTypeDef]
  5. See Sequence[FilterRuleTypeDef]
  6. See ManifestConfigTypeDef
  7. See TaskReportConfigTypeDef
  8. See TaskModeType

DescribeTaskExecutionResponseTypeDef#

# DescribeTaskExecutionResponseTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import DescribeTaskExecutionResponseTypeDef


def get_value() -> DescribeTaskExecutionResponseTypeDef:
    return {
        "TaskExecutionArn": ...,
    }


# DescribeTaskExecutionResponseTypeDef definition

class DescribeTaskExecutionResponseTypeDef(TypedDict):
    TaskExecutionArn: str,
    Status: TaskExecutionStatusType,  # (1)
    Options: OptionsTypeDef,  # (2)
    Excludes: List[FilterRuleTypeDef],  # (3)
    Includes: List[FilterRuleTypeDef],  # (3)
    ManifestConfig: ManifestConfigTypeDef,  # (5)
    StartTime: datetime.datetime,
    EstimatedFilesToTransfer: int,
    EstimatedBytesToTransfer: int,
    FilesTransferred: int,
    BytesWritten: int,
    BytesTransferred: int,
    BytesCompressed: int,
    Result: TaskExecutionResultDetailTypeDef,  # (6)
    TaskReportConfig: TaskReportConfigTypeDef,  # (7)
    FilesDeleted: int,
    FilesSkipped: int,
    FilesVerified: int,
    ReportResult: ReportResultTypeDef,  # (8)
    EstimatedFilesToDelete: int,
    TaskMode: TaskModeType,  # (9)
    FilesPrepared: int,
    FilesListed: TaskExecutionFilesListedDetailTypeDef,  # (10)
    FilesFailed: TaskExecutionFilesFailedDetailTypeDef,  # (11)
    ResponseMetadata: ResponseMetadataTypeDef,  # (12)
  1. See TaskExecutionStatusType
  2. See OptionsTypeDef
  3. See List[FilterRuleTypeDef]
  4. See List[FilterRuleTypeDef]
  5. See ManifestConfigTypeDef
  6. See TaskExecutionResultDetailTypeDef
  7. See TaskReportConfigTypeDef
  8. See ReportResultTypeDef
  9. See TaskModeType
  10. See TaskExecutionFilesListedDetailTypeDef
  11. See TaskExecutionFilesFailedDetailTypeDef
  12. See ResponseMetadataTypeDef

DescribeTaskResponseTypeDef#

# DescribeTaskResponseTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import DescribeTaskResponseTypeDef


def get_value() -> DescribeTaskResponseTypeDef:
    return {
        "TaskArn": ...,
    }


# DescribeTaskResponseTypeDef definition

class DescribeTaskResponseTypeDef(TypedDict):
    TaskArn: str,
    Status: TaskStatusType,  # (1)
    Name: str,
    CurrentTaskExecutionArn: str,
    SourceLocationArn: str,
    DestinationLocationArn: str,
    CloudWatchLogGroupArn: str,
    SourceNetworkInterfaceArns: List[str],
    DestinationNetworkInterfaceArns: List[str],
    Options: OptionsTypeDef,  # (2)
    Excludes: List[FilterRuleTypeDef],  # (3)
    Schedule: TaskScheduleTypeDef,  # (4)
    ErrorCode: str,
    ErrorDetail: str,
    CreationTime: datetime.datetime,
    Includes: List[FilterRuleTypeDef],  # (3)
    ManifestConfig: ManifestConfigTypeDef,  # (6)
    TaskReportConfig: TaskReportConfigTypeDef,  # (7)
    ScheduleDetails: TaskScheduleDetailsTypeDef,  # (8)
    TaskMode: TaskModeType,  # (9)
    ResponseMetadata: ResponseMetadataTypeDef,  # (10)
  1. See TaskStatusType
  2. See OptionsTypeDef
  3. See List[FilterRuleTypeDef]
  4. See TaskScheduleTypeDef
  5. See List[FilterRuleTypeDef]
  6. See ManifestConfigTypeDef
  7. See TaskReportConfigTypeDef
  8. See TaskScheduleDetailsTypeDef
  9. See TaskModeType
  10. See ResponseMetadataTypeDef

StartTaskExecutionRequestTypeDef#

# StartTaskExecutionRequestTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import StartTaskExecutionRequestTypeDef


def get_value() -> StartTaskExecutionRequestTypeDef:
    return {
        "TaskArn": ...,
    }


# StartTaskExecutionRequestTypeDef definition

class StartTaskExecutionRequestTypeDef(TypedDict):
    TaskArn: str,
    OverrideOptions: NotRequired[OptionsTypeDef],  # (1)
    Includes: NotRequired[Sequence[FilterRuleTypeDef]],  # (2)
    Excludes: NotRequired[Sequence[FilterRuleTypeDef]],  # (2)
    ManifestConfig: NotRequired[ManifestConfigTypeDef],  # (4)
    TaskReportConfig: NotRequired[TaskReportConfigTypeDef],  # (5)
    Tags: NotRequired[Sequence[TagListEntryTypeDef]],  # (6)
  1. See OptionsTypeDef
  2. See Sequence[FilterRuleTypeDef]
  3. See Sequence[FilterRuleTypeDef]
  4. See ManifestConfigTypeDef
  5. See TaskReportConfigTypeDef
  6. See Sequence[TagListEntryTypeDef]

UpdateTaskRequestTypeDef#

# UpdateTaskRequestTypeDef TypedDict usage example

from types_boto3_datasync.type_defs import UpdateTaskRequestTypeDef


def get_value() -> UpdateTaskRequestTypeDef:
    return {
        "TaskArn": ...,
    }


# UpdateTaskRequestTypeDef definition

class UpdateTaskRequestTypeDef(TypedDict):
    TaskArn: str,
    Options: NotRequired[OptionsTypeDef],  # (1)
    Excludes: NotRequired[Sequence[FilterRuleTypeDef]],  # (2)
    Schedule: NotRequired[TaskScheduleTypeDef],  # (3)
    Name: NotRequired[str],
    CloudWatchLogGroupArn: NotRequired[str],
    Includes: NotRequired[Sequence[FilterRuleTypeDef]],  # (2)
    ManifestConfig: NotRequired[ManifestConfigTypeDef],  # (5)
    TaskReportConfig: NotRequired[TaskReportConfigTypeDef],  # (6)
  1. See OptionsTypeDef
  2. See Sequence[FilterRuleTypeDef]
  3. See TaskScheduleTypeDef
  4. See Sequence[FilterRuleTypeDef]
  5. See ManifestConfigTypeDef
  6. See TaskReportConfigTypeDef