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,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

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#

# ReportDestinationS3TypeDef definition

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

ReportOverrideTypeDef#

# ReportOverrideTypeDef definition

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

S3ManifestConfigTypeDef#

# S3ManifestConfigTypeDef definition

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

StopDiscoveryJobRequestRequestTypeDef#

# StopDiscoveryJobRequestRequestTypeDef definition

class StopDiscoveryJobRequestRequestTypeDef(TypedDict):
    DiscoveryJobArn: str,

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

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

UpdateAgentRequestRequestTypeDef#

# UpdateAgentRequestRequestTypeDef definition

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

UpdateDiscoveryJobRequestRequestTypeDef#

# UpdateDiscoveryJobRequestRequestTypeDef definition

class UpdateDiscoveryJobRequestRequestTypeDef(TypedDict):
    DiscoveryJobArn: str,
    CollectionDurationMinutes: int,

UpdateStorageSystemRequestRequestTypeDef#

# UpdateStorageSystemRequestRequestTypeDef definition

class UpdateStorageSystemRequestRequestTypeDef(TypedDict):
    StorageSystemArn: str,
    ServerConfiguration: NotRequired[DiscoveryServerConfigurationTypeDef],  # (1)
    AgentArns: NotRequired[Sequence[str]],
    Name: NotRequired[str],
    CloudWatchLogGroupArn: NotRequired[str],
    Credentials: NotRequired[CredentialsTypeDef],  # (2)
  1. See DiscoveryServerConfigurationTypeDef
  2. See CredentialsTypeDef

AddStorageSystemRequestRequestTypeDef#

# AddStorageSystemRequestRequestTypeDef definition

class AddStorageSystemRequestRequestTypeDef(TypedDict):
    ServerConfiguration: DiscoveryServerConfigurationTypeDef,  # (1)
    SystemType: DiscoverySystemTypeType,  # (2)
    AgentArns: Sequence[str],
    ClientToken: str,
    Credentials: CredentialsTypeDef,  # (3)
    CloudWatchLogGroupArn: NotRequired[str],
    Tags: NotRequired[Sequence[TagListEntryTypeDef]],  # (4)
    Name: NotRequired[str],
  1. See DiscoveryServerConfigurationTypeDef
  2. See DiscoverySystemTypeType
  3. See CredentialsTypeDef
  4. See TagListEntryTypeDef

CreateAgentRequestRequestTypeDef#

# CreateAgentRequestRequestTypeDef definition

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

CreateLocationFsxLustreRequestRequestTypeDef#

# CreateLocationFsxLustreRequestRequestTypeDef definition

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

CreateLocationFsxWindowsRequestRequestTypeDef#

# CreateLocationFsxWindowsRequestRequestTypeDef definition

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

StartDiscoveryJobRequestRequestTypeDef#

# StartDiscoveryJobRequestRequestTypeDef definition

class StartDiscoveryJobRequestRequestTypeDef(TypedDict):
    StorageSystemArn: str,
    CollectionDurationMinutes: int,
    ClientToken: str,
    Tags: NotRequired[Sequence[TagListEntryTypeDef]],  # (1)
  1. See TagListEntryTypeDef

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

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

AddStorageSystemResponseTypeDef#

# AddStorageSystemResponseTypeDef definition

class AddStorageSystemResponseTypeDef(TypedDict):
    StorageSystemArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateAgentResponseTypeDef#

# CreateAgentResponseTypeDef definition

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

CreateLocationAzureBlobResponseTypeDef#

# CreateLocationAzureBlobResponseTypeDef definition

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

CreateLocationEfsResponseTypeDef#

# CreateLocationEfsResponseTypeDef definition

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

CreateLocationFsxLustreResponseTypeDef#

# CreateLocationFsxLustreResponseTypeDef definition

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

CreateLocationFsxOntapResponseTypeDef#

# CreateLocationFsxOntapResponseTypeDef definition

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

CreateLocationFsxOpenZfsResponseTypeDef#

# CreateLocationFsxOpenZfsResponseTypeDef definition

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

CreateLocationFsxWindowsResponseTypeDef#

# CreateLocationFsxWindowsResponseTypeDef definition

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

CreateLocationHdfsResponseTypeDef#

# CreateLocationHdfsResponseTypeDef definition

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

CreateLocationNfsResponseTypeDef#

# CreateLocationNfsResponseTypeDef definition

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

CreateLocationObjectStorageResponseTypeDef#

# CreateLocationObjectStorageResponseTypeDef definition

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

CreateLocationS3ResponseTypeDef#

# CreateLocationS3ResponseTypeDef definition

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

CreateLocationSmbResponseTypeDef#

# CreateLocationSmbResponseTypeDef definition

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

CreateTaskResponseTypeDef#

# CreateTaskResponseTypeDef definition

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

DescribeDiscoveryJobResponseTypeDef#

# DescribeDiscoveryJobResponseTypeDef definition

class DescribeDiscoveryJobResponseTypeDef(TypedDict):
    StorageSystemArn: str,
    DiscoveryJobArn: str,
    CollectionDurationMinutes: int,
    Status: DiscoveryJobStatusType,  # (1)
    JobStartTime: datetime,
    JobEndTime: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DiscoveryJobStatusType
  2. See ResponseMetadataTypeDef

DescribeLocationAzureBlobResponseTypeDef#

# DescribeLocationAzureBlobResponseTypeDef definition

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

DescribeLocationFsxLustreResponseTypeDef#

# DescribeLocationFsxLustreResponseTypeDef definition

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

DescribeLocationFsxWindowsResponseTypeDef#

# DescribeLocationFsxWindowsResponseTypeDef definition

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

DescribeLocationObjectStorageResponseTypeDef#

# DescribeLocationObjectStorageResponseTypeDef definition

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

DescribeStorageSystemResponseTypeDef#

# DescribeStorageSystemResponseTypeDef definition

class DescribeStorageSystemResponseTypeDef(TypedDict):
    StorageSystemArn: str,
    ServerConfiguration: DiscoveryServerConfigurationTypeDef,  # (1)
    SystemType: DiscoverySystemTypeType,  # (2)
    AgentArns: List[str],
    Name: str,
    ErrorMessage: str,
    ConnectivityStatus: StorageSystemConnectivityStatusType,  # (3)
    CloudWatchLogGroupArn: str,
    CreationTime: datetime,
    SecretsManagerArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See DiscoveryServerConfigurationTypeDef
  2. See DiscoverySystemTypeType
  3. See StorageSystemConnectivityStatusType
  4. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

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

StartDiscoveryJobResponseTypeDef#

# StartDiscoveryJobResponseTypeDef definition

class StartDiscoveryJobResponseTypeDef(TypedDict):
    DiscoveryJobArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StartTaskExecutionResponseTypeDef#

# StartTaskExecutionResponseTypeDef definition

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

AgentListEntryTypeDef#

# 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

CreateLocationAzureBlobRequestRequestTypeDef#

# CreateLocationAzureBlobRequestRequestTypeDef definition

class CreateLocationAzureBlobRequestRequestTypeDef(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 TagListEntryTypeDef

UpdateLocationAzureBlobRequestRequestTypeDef#

# UpdateLocationAzureBlobRequestRequestTypeDef definition

class UpdateLocationAzureBlobRequestRequestTypeDef(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

CreateLocationObjectStorageRequestRequestTypeDef#

# CreateLocationObjectStorageRequestRequestTypeDef definition

class CreateLocationObjectStorageRequestRequestTypeDef(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[Union[str, bytes, IO[Any], StreamingBody]],
  1. See ObjectStorageServerProtocolType
  2. See TagListEntryTypeDef

UpdateLocationObjectStorageRequestRequestTypeDef#

# UpdateLocationObjectStorageRequestRequestTypeDef definition

class UpdateLocationObjectStorageRequestRequestTypeDef(TypedDict):
    LocationArn: str,
    ServerPort: NotRequired[int],
    ServerProtocol: NotRequired[ObjectStorageServerProtocolType],  # (1)
    Subdirectory: NotRequired[str],
    AccessKey: NotRequired[str],
    SecretKey: NotRequired[str],
    AgentArns: NotRequired[Sequence[str]],
    ServerCertificate: NotRequired[Union[str, bytes, IO[Any], StreamingBody]],
  1. See ObjectStorageServerProtocolType

CreateLocationEfsRequestRequestTypeDef#

# CreateLocationEfsRequestRequestTypeDef definition

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

DescribeLocationEfsResponseTypeDef#

# DescribeLocationEfsResponseTypeDef definition

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

CreateLocationHdfsRequestRequestTypeDef#

# CreateLocationHdfsRequestRequestTypeDef definition

class CreateLocationHdfsRequestRequestTypeDef(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[Union[str, bytes, IO[Any], StreamingBody]],
    KerberosKrb5Conf: NotRequired[Union[str, bytes, IO[Any], StreamingBody]],
    Tags: NotRequired[Sequence[TagListEntryTypeDef]],  # (4)
  1. See HdfsNameNodeTypeDef
  2. See HdfsAuthenticationTypeType
  3. See QopConfigurationTypeDef
  4. See TagListEntryTypeDef

DescribeLocationHdfsResponseTypeDef#

# 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,
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See HdfsNameNodeTypeDef
  2. See QopConfigurationTypeDef
  3. See HdfsAuthenticationTypeType
  4. See ResponseMetadataTypeDef

UpdateLocationHdfsRequestRequestTypeDef#

# UpdateLocationHdfsRequestRequestTypeDef definition

class UpdateLocationHdfsRequestRequestTypeDef(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[Union[str, bytes, IO[Any], StreamingBody]],
    KerberosKrb5Conf: NotRequired[Union[str, bytes, IO[Any], StreamingBody]],
    AgentArns: NotRequired[Sequence[str]],
  1. See HdfsNameNodeTypeDef
  2. See QopConfigurationTypeDef
  3. See HdfsAuthenticationTypeType

FsxProtocolNfsTypeDef#

# FsxProtocolNfsTypeDef definition

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

CreateLocationNfsRequestRequestTypeDef#

# CreateLocationNfsRequestRequestTypeDef definition

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

DescribeLocationNfsResponseTypeDef#

# DescribeLocationNfsResponseTypeDef definition

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

UpdateLocationNfsRequestRequestTypeDef#

# UpdateLocationNfsRequestRequestTypeDef definition

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

CreateLocationS3RequestRequestTypeDef#

# CreateLocationS3RequestRequestTypeDef definition

class CreateLocationS3RequestRequestTypeDef(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 TagListEntryTypeDef

DescribeLocationS3ResponseTypeDef#

# DescribeLocationS3ResponseTypeDef definition

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

CreateLocationSmbRequestRequestTypeDef#

# CreateLocationSmbRequestRequestTypeDef definition

class CreateLocationSmbRequestRequestTypeDef(TypedDict):
    Subdirectory: str,
    ServerHostname: str,
    User: str,
    Password: str,
    AgentArns: Sequence[str],
    Domain: NotRequired[str],
    MountOptions: NotRequired[SmbMountOptionsTypeDef],  # (1)
    Tags: NotRequired[Sequence[TagListEntryTypeDef]],  # (2)
  1. See SmbMountOptionsTypeDef
  2. See TagListEntryTypeDef

DescribeLocationSmbResponseTypeDef#

# DescribeLocationSmbResponseTypeDef definition

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

FsxProtocolSmbTypeDef#

# FsxProtocolSmbTypeDef definition

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

UpdateLocationSmbRequestRequestTypeDef#

# UpdateLocationSmbRequestRequestTypeDef definition

class UpdateLocationSmbRequestRequestTypeDef(TypedDict):
    LocationArn: str,
    Subdirectory: NotRequired[str],
    User: NotRequired[str],
    Domain: NotRequired[str],
    Password: NotRequired[str],
    AgentArns: NotRequired[Sequence[str]],
    MountOptions: NotRequired[SmbMountOptionsTypeDef],  # (1)
  1. See SmbMountOptionsTypeDef

UpdateTaskExecutionRequestRequestTypeDef#

# UpdateTaskExecutionRequestRequestTypeDef definition

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

DescribeAgentResponseTypeDef#

# DescribeAgentResponseTypeDef definition

class DescribeAgentResponseTypeDef(TypedDict):
    AgentArn: str,
    Name: str,
    Status: AgentStatusType,  # (1)
    LastConnectionTime: datetime,
    CreationTime: 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

ListAgentsRequestListAgentsPaginateTypeDef#

# ListAgentsRequestListAgentsPaginateTypeDef definition

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

ListDiscoveryJobsRequestListDiscoveryJobsPaginateTypeDef#

# ListDiscoveryJobsRequestListDiscoveryJobsPaginateTypeDef definition

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

ListStorageSystemsRequestListStorageSystemsPaginateTypeDef#

# ListStorageSystemsRequestListStorageSystemsPaginateTypeDef definition

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

ListTagsForResourceRequestListTagsForResourcePaginateTypeDef#

# ListTagsForResourceRequestListTagsForResourcePaginateTypeDef definition

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

ListTaskExecutionsRequestListTaskExecutionsPaginateTypeDef#

# ListTaskExecutionsRequestListTaskExecutionsPaginateTypeDef definition

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

DescribeStorageSystemResourceMetricsRequestDescribeStorageSystemResourceMetricsPaginateTypeDef#

# DescribeStorageSystemResourceMetricsRequestDescribeStorageSystemResourceMetricsPaginateTypeDef definition

class DescribeStorageSystemResourceMetricsRequestDescribeStorageSystemResourceMetricsPaginateTypeDef(TypedDict):
    DiscoveryJobArn: str,
    ResourceType: DiscoveryResourceTypeType,  # (1)
    ResourceId: str,
    StartTime: NotRequired[Union[datetime, str]],
    EndTime: NotRequired[Union[datetime, str]],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See DiscoveryResourceTypeType
  2. See PaginatorConfigTypeDef

DescribeStorageSystemResourceMetricsRequestRequestTypeDef#

# DescribeStorageSystemResourceMetricsRequestRequestTypeDef definition

class DescribeStorageSystemResourceMetricsRequestRequestTypeDef(TypedDict):
    DiscoveryJobArn: str,
    ResourceType: DiscoveryResourceTypeType,  # (1)
    ResourceId: str,
    StartTime: NotRequired[Union[datetime, str]],
    EndTime: NotRequired[Union[datetime, str]],
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
  1. See DiscoveryResourceTypeType

ListDiscoveryJobsResponseTypeDef#

# ListDiscoveryJobsResponseTypeDef definition

class ListDiscoveryJobsResponseTypeDef(TypedDict):
    DiscoveryJobs: List[DiscoveryJobListEntryTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DiscoveryJobListEntryTypeDef
  2. See ResponseMetadataTypeDef

ListLocationsRequestListLocationsPaginateTypeDef#

# ListLocationsRequestListLocationsPaginateTypeDef definition

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

ListLocationsRequestRequestTypeDef#

# ListLocationsRequestRequestTypeDef definition

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

ListLocationsResponseTypeDef#

# ListLocationsResponseTypeDef definition

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

ListStorageSystemsResponseTypeDef#

# ListStorageSystemsResponseTypeDef definition

class ListStorageSystemsResponseTypeDef(TypedDict):
    StorageSystems: List[StorageSystemListEntryTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See StorageSystemListEntryTypeDef
  2. See ResponseMetadataTypeDef

ListTaskExecutionsResponseTypeDef#

# ListTaskExecutionsResponseTypeDef definition

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

ListTasksRequestListTasksPaginateTypeDef#

# ListTasksRequestListTasksPaginateTypeDef definition

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

ListTasksRequestRequestTypeDef#

# ListTasksRequestRequestTypeDef definition

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

ListTasksResponseTypeDef#

# ListTasksResponseTypeDef definition

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

NetAppONTAPClusterTypeDef#

# NetAppONTAPClusterTypeDef definition

class NetAppONTAPClusterTypeDef(TypedDict):
    CifsShareCount: NotRequired[int],
    NfsExportedVolumes: NotRequired[int],
    ResourceId: NotRequired[str],
    ClusterName: NotRequired[str],
    MaxP95Performance: NotRequired[MaxP95PerformanceTypeDef],  # (1)
    ClusterBlockStorageSize: NotRequired[int],
    ClusterBlockStorageUsed: NotRequired[int],
    ClusterBlockStorageLogicalUsed: NotRequired[int],
    Recommendations: NotRequired[List[RecommendationTypeDef]],  # (2)
    RecommendationStatus: NotRequired[RecommendationStatusType],  # (3)
    LunCount: NotRequired[int],
    ClusterCloudStorageUsed: NotRequired[int],
  1. See MaxP95PerformanceTypeDef
  2. See RecommendationTypeDef
  3. See RecommendationStatusType

NetAppONTAPSVMTypeDef#

# NetAppONTAPSVMTypeDef definition

class NetAppONTAPSVMTypeDef(TypedDict):
    ClusterUuid: NotRequired[str],
    ResourceId: NotRequired[str],
    SvmName: NotRequired[str],
    CifsShareCount: NotRequired[int],
    EnabledProtocols: NotRequired[List[str]],
    TotalCapacityUsed: NotRequired[int],
    TotalCapacityProvisioned: NotRequired[int],
    TotalLogicalCapacityUsed: NotRequired[int],
    MaxP95Performance: NotRequired[MaxP95PerformanceTypeDef],  # (1)
    Recommendations: NotRequired[List[RecommendationTypeDef]],  # (2)
    NfsExportedVolumes: NotRequired[int],
    RecommendationStatus: NotRequired[RecommendationStatusType],  # (3)
    TotalSnapshotCapacityUsed: NotRequired[int],
    LunCount: NotRequired[int],
  1. See MaxP95PerformanceTypeDef
  2. See RecommendationTypeDef
  3. See RecommendationStatusType

NetAppONTAPVolumeTypeDef#

# NetAppONTAPVolumeTypeDef definition

class NetAppONTAPVolumeTypeDef(TypedDict):
    VolumeName: NotRequired[str],
    ResourceId: NotRequired[str],
    CifsShareCount: NotRequired[int],
    SecurityStyle: NotRequired[str],
    SvmUuid: NotRequired[str],
    SvmName: NotRequired[str],
    CapacityUsed: NotRequired[int],
    CapacityProvisioned: NotRequired[int],
    LogicalCapacityUsed: NotRequired[int],
    NfsExported: NotRequired[bool],
    SnapshotCapacityUsed: NotRequired[int],
    MaxP95Performance: NotRequired[MaxP95PerformanceTypeDef],  # (1)
    Recommendations: NotRequired[List[RecommendationTypeDef]],  # (2)
    RecommendationStatus: NotRequired[RecommendationStatusType],  # (3)
    LunCount: NotRequired[int],
  1. See MaxP95PerformanceTypeDef
  2. See RecommendationTypeDef
  3. See RecommendationStatusType

P95MetricsTypeDef#

# P95MetricsTypeDef definition

class P95MetricsTypeDef(TypedDict):
    IOPS: NotRequired[IOPSTypeDef],  # (1)
    Throughput: NotRequired[ThroughputTypeDef],  # (2)
    Latency: NotRequired[LatencyTypeDef],  # (3)
  1. See IOPSTypeDef
  2. See ThroughputTypeDef
  3. See LatencyTypeDef

ReportDestinationTypeDef#

# ReportDestinationTypeDef definition

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

ReportOverridesTypeDef#

# 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 definition

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

ListAgentsResponseTypeDef#

# ListAgentsResponseTypeDef definition

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

FsxProtocolTypeDef#

# FsxProtocolTypeDef definition

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

ResourceDetailsTypeDef#

# ResourceDetailsTypeDef definition

class ResourceDetailsTypeDef(TypedDict):
    NetAppONTAPSVMs: NotRequired[List[NetAppONTAPSVMTypeDef]],  # (1)
    NetAppONTAPVolumes: NotRequired[List[NetAppONTAPVolumeTypeDef]],  # (2)
    NetAppONTAPClusters: NotRequired[List[NetAppONTAPClusterTypeDef]],  # (3)
  1. See NetAppONTAPSVMTypeDef
  2. See NetAppONTAPVolumeTypeDef
  3. See NetAppONTAPClusterTypeDef

ResourceMetricsTypeDef#

# ResourceMetricsTypeDef definition

class ResourceMetricsTypeDef(TypedDict):
    Timestamp: NotRequired[datetime],
    P95Metrics: NotRequired[P95MetricsTypeDef],  # (1)
    Capacity: NotRequired[CapacityTypeDef],  # (2)
    ResourceId: NotRequired[str],
    ResourceType: NotRequired[DiscoveryResourceTypeType],  # (3)
  1. See P95MetricsTypeDef
  2. See CapacityTypeDef
  3. See DiscoveryResourceTypeType

TaskReportConfigTypeDef#

# 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 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

CreateLocationFsxOntapRequestRequestTypeDef#

# CreateLocationFsxOntapRequestRequestTypeDef definition

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

CreateLocationFsxOpenZfsRequestRequestTypeDef#

# CreateLocationFsxOpenZfsRequestRequestTypeDef definition

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

DescribeLocationFsxOntapResponseTypeDef#

# DescribeLocationFsxOntapResponseTypeDef definition

class DescribeLocationFsxOntapResponseTypeDef(TypedDict):
    CreationTime: 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 definition

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

DescribeStorageSystemResourcesResponseTypeDef#

# DescribeStorageSystemResourcesResponseTypeDef definition

class DescribeStorageSystemResourcesResponseTypeDef(TypedDict):
    ResourceDetails: ResourceDetailsTypeDef,  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ResourceDetailsTypeDef
  2. See ResponseMetadataTypeDef

DescribeStorageSystemResourceMetricsResponseTypeDef#

# DescribeStorageSystemResourceMetricsResponseTypeDef definition

class DescribeStorageSystemResourceMetricsResponseTypeDef(TypedDict):
    Metrics: List[ResourceMetricsTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ResourceMetricsTypeDef
  2. See ResponseMetadataTypeDef

CreateTaskRequestRequestTypeDef#

# CreateTaskRequestRequestTypeDef definition

class CreateTaskRequestRequestTypeDef(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)
  1. See OptionsTypeDef
  2. See FilterRuleTypeDef
  3. See TaskScheduleTypeDef
  4. See TagListEntryTypeDef
  5. See FilterRuleTypeDef
  6. See ManifestConfigTypeDef
  7. See TaskReportConfigTypeDef

DescribeTaskExecutionResponseTypeDef#

# 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,
    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,
    ResponseMetadata: ResponseMetadataTypeDef,  # (9)
  1. See TaskExecutionStatusType
  2. See OptionsTypeDef
  3. See FilterRuleTypeDef
  4. See FilterRuleTypeDef
  5. See ManifestConfigTypeDef
  6. See TaskExecutionResultDetailTypeDef
  7. See TaskReportConfigTypeDef
  8. See ReportResultTypeDef
  9. See ResponseMetadataTypeDef

DescribeTaskResponseTypeDef#

# 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,
    Includes: List[FilterRuleTypeDef],  # (3)
    ManifestConfig: ManifestConfigTypeDef,  # (6)
    TaskReportConfig: TaskReportConfigTypeDef,  # (7)
    ResponseMetadata: ResponseMetadataTypeDef,  # (8)
  1. See TaskStatusType
  2. See OptionsTypeDef
  3. See FilterRuleTypeDef
  4. See TaskScheduleTypeDef
  5. See FilterRuleTypeDef
  6. See ManifestConfigTypeDef
  7. See TaskReportConfigTypeDef
  8. See ResponseMetadataTypeDef

StartTaskExecutionRequestRequestTypeDef#

# StartTaskExecutionRequestRequestTypeDef definition

class StartTaskExecutionRequestRequestTypeDef(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 FilterRuleTypeDef
  3. See FilterRuleTypeDef
  4. See ManifestConfigTypeDef
  5. See TaskReportConfigTypeDef
  6. See TagListEntryTypeDef

UpdateTaskRequestRequestTypeDef#

# UpdateTaskRequestRequestTypeDef definition

class UpdateTaskRequestRequestTypeDef(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 FilterRuleTypeDef
  3. See TaskScheduleTypeDef
  4. See FilterRuleTypeDef
  5. See ManifestConfigTypeDef
  6. See TaskReportConfigTypeDef