Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
- Service Configuration
- Errors
- Waiters
- Operations
- CancelTaskExecution
- CreateAgent
- CreateLocationEfs
- CreateLocationFsxLustre
- CreateLocationFsxOntap
- CreateLocationFsxOpenZfs
- CreateLocationFsxWindows
- CreateLocationHdfs
- CreateLocationNfs
- CreateLocationObjectStorage
- CreateLocationS3
- CreateLocationSmb
- CreateTask
- DeleteAgent
- DeleteLocation
- DeleteTask
- DescribeAgent
- DescribeLocationEfs
- DescribeLocationFsxLustre
- DescribeLocationFsxOntap
- DescribeLocationFsxOpenZfs
- DescribeLocationFsxWindows
- DescribeLocationHdfs
- DescribeLocationNfs
- DescribeLocationObjectStorage
- DescribeLocationS3
- DescribeLocationSmb
- DescribeTask
- DescribeTaskExecution
- ListAgents (Paginated)
- ListLocations (Paginated)
- ListTagsForResource (Paginated)
- ListTaskExecutions (Paginated)
- ListTasks (Paginated)
- StartTaskExecution
- TagResource
- UntagResource
- UpdateAgent
- UpdateLocationHdfs
- UpdateLocationNfs
- UpdateLocationObjectStorage
- UpdateLocationSmb
- UpdateTask
- UpdateTaskExecution
- Types
- AgentStatus
- Atime
- EfsInTransitEncryption
- EndpointType
- FilterType
- Gid
- HdfsAuthenticationType
- HdfsDataTransferProtection
- HdfsRpcProtection
- LocationFilterName
- LogLevel
- Mtime
- NfsVersion
- ObjectStorageServerProtocol
- ObjectTags
- Operator
- OverwriteMode
- PhaseStatus
- PosixPermissions
- PreserveDeletedFiles
- PreserveDevices
- S3StorageClass
- SmbSecurityDescriptorCopyFlags
- SmbVersion
- TaskExecutionStatus
- TaskFilterName
- TaskQueueing
- TaskStatus
- TransferMode
- Uid
- VerifyMode
- AgentListEntry
- Ec2Config
- FilterRule
- FsxProtocol
- FsxProtocolNfs
- FsxProtocolSmb
- HdfsNameNode
- LocationFilter
- LocationListEntry
- NfsMountOptions
- OnPremConfig
- Options
- PrivateLinkConfig
- QopConfiguration
- S3Config
- SmbMountOptions
- TagListEntry
- TaskExecutionListEntry
- TaskExecutionResultDetail
- TaskFilter
- TaskListEntry
- TaskSchedule
Derived from API version 2018-11-09
of the AWS service descriptions, licensed under Apache 2.0.
DataSync
DataSync is a managed data transfer service that makes it simpler for you to automate moving data between on-premises storage and Amazon Web Services storage services. You also can use DataSync to transfer data between other cloud providers and Amazon Web Services storage services.
This API interface reference includes documentation for using DataSync programmatically. For complete information, see the <https:docs.aws.amazon.comdatasynclatestuserguidewhat-is-datasync.html DataSync User Guide> .
Synopsis
- defaultService :: Service
- _InternalException :: AsError a => Fold a ServiceError
- _InvalidRequestException :: AsError a => Fold a ServiceError
- data CancelTaskExecution = CancelTaskExecution' Text
- newCancelTaskExecution :: Text -> CancelTaskExecution
- data CancelTaskExecutionResponse = CancelTaskExecutionResponse' Int
- newCancelTaskExecutionResponse :: Int -> CancelTaskExecutionResponse
- data CreateAgent = CreateAgent' (Maybe Text) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe [TagListEntry]) (Maybe Text) Text
- newCreateAgent :: Text -> CreateAgent
- data CreateAgentResponse = CreateAgentResponse' (Maybe Text) Int
- newCreateAgentResponse :: Int -> CreateAgentResponse
- data CreateLocationEfs = CreateLocationEfs' (Maybe Text) (Maybe Text) (Maybe EfsInTransitEncryption) (Maybe Text) (Maybe [TagListEntry]) Text Ec2Config
- newCreateLocationEfs :: Text -> Ec2Config -> CreateLocationEfs
- data CreateLocationEfsResponse = CreateLocationEfsResponse' (Maybe Text) Int
- newCreateLocationEfsResponse :: Int -> CreateLocationEfsResponse
- data CreateLocationFsxLustre = CreateLocationFsxLustre' (Maybe Text) (Maybe [TagListEntry]) Text (NonEmpty Text)
- newCreateLocationFsxLustre :: Text -> NonEmpty Text -> CreateLocationFsxLustre
- data CreateLocationFsxLustreResponse = CreateLocationFsxLustreResponse' (Maybe Text) Int
- newCreateLocationFsxLustreResponse :: Int -> CreateLocationFsxLustreResponse
- data CreateLocationFsxOntap = CreateLocationFsxOntap' (Maybe Text) (Maybe [TagListEntry]) FsxProtocol (NonEmpty Text) Text
- newCreateLocationFsxOntap :: FsxProtocol -> NonEmpty Text -> Text -> CreateLocationFsxOntap
- data CreateLocationFsxOntapResponse = CreateLocationFsxOntapResponse' (Maybe Text) Int
- newCreateLocationFsxOntapResponse :: Int -> CreateLocationFsxOntapResponse
- data CreateLocationFsxOpenZfs = CreateLocationFsxOpenZfs' (Maybe Text) (Maybe [TagListEntry]) Text FsxProtocol (NonEmpty Text)
- newCreateLocationFsxOpenZfs :: Text -> FsxProtocol -> NonEmpty Text -> CreateLocationFsxOpenZfs
- data CreateLocationFsxOpenZfsResponse = CreateLocationFsxOpenZfsResponse' (Maybe Text) Int
- newCreateLocationFsxOpenZfsResponse :: Int -> CreateLocationFsxOpenZfsResponse
- data CreateLocationFsxWindows = CreateLocationFsxWindows' (Maybe Text) (Maybe Text) (Maybe [TagListEntry]) Text (NonEmpty Text) Text (Sensitive Text)
- newCreateLocationFsxWindows :: Text -> NonEmpty Text -> Text -> Text -> CreateLocationFsxWindows
- data CreateLocationFsxWindowsResponse = CreateLocationFsxWindowsResponse' (Maybe Text) Int
- newCreateLocationFsxWindowsResponse :: Int -> CreateLocationFsxWindowsResponse
- data CreateLocationHdfs = CreateLocationHdfs' (Maybe Natural) (Maybe Base64) (Maybe Base64) (Maybe Text) (Maybe Text) (Maybe QopConfiguration) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe [TagListEntry]) (NonEmpty HdfsNameNode) HdfsAuthenticationType (NonEmpty Text)
- newCreateLocationHdfs :: NonEmpty HdfsNameNode -> HdfsAuthenticationType -> NonEmpty Text -> CreateLocationHdfs
- data CreateLocationHdfsResponse = CreateLocationHdfsResponse' (Maybe Text) Int
- newCreateLocationHdfsResponse :: Int -> CreateLocationHdfsResponse
- data CreateLocationNfs = CreateLocationNfs' (Maybe NfsMountOptions) (Maybe [TagListEntry]) Text Text OnPremConfig
- newCreateLocationNfs :: Text -> Text -> OnPremConfig -> CreateLocationNfs
- data CreateLocationNfsResponse = CreateLocationNfsResponse' (Maybe Text) Int
- newCreateLocationNfsResponse :: Int -> CreateLocationNfsResponse
- data CreateLocationObjectStorage = CreateLocationObjectStorage' (Maybe Text) (Maybe (Sensitive Text)) (Maybe Base64) (Maybe Natural) (Maybe ObjectStorageServerProtocol) (Maybe Text) (Maybe [TagListEntry]) Text Text (NonEmpty Text)
- newCreateLocationObjectStorage :: Text -> Text -> NonEmpty Text -> CreateLocationObjectStorage
- data CreateLocationObjectStorageResponse = CreateLocationObjectStorageResponse' (Maybe Text) Int
- newCreateLocationObjectStorageResponse :: Int -> CreateLocationObjectStorageResponse
- data CreateLocationS3 = CreateLocationS3' (Maybe (NonEmpty Text)) (Maybe S3StorageClass) (Maybe Text) (Maybe [TagListEntry]) Text S3Config
- newCreateLocationS3 :: Text -> S3Config -> CreateLocationS3
- data CreateLocationS3Response = CreateLocationS3Response' (Maybe Text) Int
- newCreateLocationS3Response :: Int -> CreateLocationS3Response
- data CreateLocationSmb = CreateLocationSmb' (Maybe Text) (Maybe SmbMountOptions) (Maybe [TagListEntry]) Text Text Text (Sensitive Text) (NonEmpty Text)
- newCreateLocationSmb :: Text -> Text -> Text -> Text -> NonEmpty Text -> CreateLocationSmb
- data CreateLocationSmbResponse = CreateLocationSmbResponse' (Maybe Text) Int
- newCreateLocationSmbResponse :: Int -> CreateLocationSmbResponse
- data CreateTask = CreateTask' (Maybe Text) (Maybe [FilterRule]) (Maybe [FilterRule]) (Maybe Text) (Maybe Options) (Maybe TaskSchedule) (Maybe [TagListEntry]) Text Text
- newCreateTask :: Text -> Text -> CreateTask
- data CreateTaskResponse = CreateTaskResponse' (Maybe Text) Int
- newCreateTaskResponse :: Int -> CreateTaskResponse
- data DeleteAgent = DeleteAgent' Text
- newDeleteAgent :: Text -> DeleteAgent
- data DeleteAgentResponse = DeleteAgentResponse' Int
- newDeleteAgentResponse :: Int -> DeleteAgentResponse
- data DeleteLocation = DeleteLocation' Text
- newDeleteLocation :: Text -> DeleteLocation
- data DeleteLocationResponse = DeleteLocationResponse' Int
- newDeleteLocationResponse :: Int -> DeleteLocationResponse
- data DeleteTask = DeleteTask' Text
- newDeleteTask :: Text -> DeleteTask
- data DeleteTaskResponse = DeleteTaskResponse' Int
- newDeleteTaskResponse :: Int -> DeleteTaskResponse
- data DescribeAgent = DescribeAgent' Text
- newDescribeAgent :: Text -> DescribeAgent
- data DescribeAgentResponse = DescribeAgentResponse' (Maybe Text) (Maybe POSIX) (Maybe EndpointType) (Maybe POSIX) (Maybe Text) (Maybe PrivateLinkConfig) (Maybe AgentStatus) Int
- newDescribeAgentResponse :: Int -> DescribeAgentResponse
- data DescribeLocationEfs = DescribeLocationEfs' Text
- newDescribeLocationEfs :: Text -> DescribeLocationEfs
- data DescribeLocationEfsResponse = DescribeLocationEfsResponse' (Maybe Text) (Maybe POSIX) (Maybe Ec2Config) (Maybe Text) (Maybe EfsInTransitEncryption) (Maybe Text) (Maybe Text) Int
- newDescribeLocationEfsResponse :: Int -> DescribeLocationEfsResponse
- data DescribeLocationFsxLustre = DescribeLocationFsxLustre' Text
- newDescribeLocationFsxLustre :: Text -> DescribeLocationFsxLustre
- data DescribeLocationFsxLustreResponse = DescribeLocationFsxLustreResponse' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe (NonEmpty Text)) Int
- newDescribeLocationFsxLustreResponse :: Int -> DescribeLocationFsxLustreResponse
- data DescribeLocationFsxOntap = DescribeLocationFsxOntap' Text
- newDescribeLocationFsxOntap :: Text -> DescribeLocationFsxOntap
- data DescribeLocationFsxOntapResponse = DescribeLocationFsxOntapResponse' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe FsxProtocol) (Maybe (NonEmpty Text)) (Maybe Text) Int
- newDescribeLocationFsxOntapResponse :: Int -> DescribeLocationFsxOntapResponse
- data DescribeLocationFsxOpenZfs = DescribeLocationFsxOpenZfs' Text
- newDescribeLocationFsxOpenZfs :: Text -> DescribeLocationFsxOpenZfs
- data DescribeLocationFsxOpenZfsResponse = DescribeLocationFsxOpenZfsResponse' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe FsxProtocol) (Maybe (NonEmpty Text)) Int
- newDescribeLocationFsxOpenZfsResponse :: Int -> DescribeLocationFsxOpenZfsResponse
- data DescribeLocationFsxWindows = DescribeLocationFsxWindows' Text
- newDescribeLocationFsxWindows :: Text -> DescribeLocationFsxWindows
- data DescribeLocationFsxWindowsResponse = DescribeLocationFsxWindowsResponse' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (NonEmpty Text)) (Maybe Text) Int
- newDescribeLocationFsxWindowsResponse :: Int -> DescribeLocationFsxWindowsResponse
- data DescribeLocationHdfs = DescribeLocationHdfs' Text
- newDescribeLocationHdfs :: Text -> DescribeLocationHdfs
- data DescribeLocationHdfsResponse = DescribeLocationHdfsResponse' (Maybe (NonEmpty Text)) (Maybe HdfsAuthenticationType) (Maybe Natural) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (NonEmpty HdfsNameNode)) (Maybe QopConfiguration) (Maybe Natural) (Maybe Text) Int
- newDescribeLocationHdfsResponse :: Int -> DescribeLocationHdfsResponse
- data DescribeLocationNfs = DescribeLocationNfs' Text
- newDescribeLocationNfs :: Text -> DescribeLocationNfs
- data DescribeLocationNfsResponse = DescribeLocationNfsResponse' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe NfsMountOptions) (Maybe OnPremConfig) Int
- newDescribeLocationNfsResponse :: Int -> DescribeLocationNfsResponse
- data DescribeLocationObjectStorage = DescribeLocationObjectStorage' Text
- newDescribeLocationObjectStorage :: Text -> DescribeLocationObjectStorage
- data DescribeLocationObjectStorageResponse = DescribeLocationObjectStorageResponse' (Maybe Text) (Maybe (NonEmpty Text)) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Base64) (Maybe Natural) (Maybe ObjectStorageServerProtocol) Int
- newDescribeLocationObjectStorageResponse :: Int -> DescribeLocationObjectStorageResponse
- data DescribeLocationS3 = DescribeLocationS3' Text
- newDescribeLocationS3 :: Text -> DescribeLocationS3
- data DescribeLocationS3Response = DescribeLocationS3Response' (Maybe (NonEmpty Text)) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe S3Config) (Maybe S3StorageClass) Int
- newDescribeLocationS3Response :: Int -> DescribeLocationS3Response
- data DescribeLocationSmb = DescribeLocationSmb' Text
- newDescribeLocationSmb :: Text -> DescribeLocationSmb
- data DescribeLocationSmbResponse = DescribeLocationSmbResponse' (Maybe (NonEmpty Text)) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe SmbMountOptions) (Maybe Text) Int
- newDescribeLocationSmbResponse :: Int -> DescribeLocationSmbResponse
- data DescribeTask = DescribeTask' Text
- newDescribeTask :: Text -> DescribeTask
- data DescribeTaskResponse = DescribeTaskResponse' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe [FilterRule]) (Maybe [FilterRule]) (Maybe Text) (Maybe Options) (Maybe TaskSchedule) (Maybe Text) (Maybe [Text]) (Maybe TaskStatus) (Maybe Text) Int
- newDescribeTaskResponse :: Int -> DescribeTaskResponse
- data DescribeTaskExecution = DescribeTaskExecution' Text
- newDescribeTaskExecution :: Text -> DescribeTaskExecution
- data DescribeTaskExecutionResponse = DescribeTaskExecutionResponse' (Maybe Integer) (Maybe Integer) (Maybe Integer) (Maybe Integer) (Maybe Integer) (Maybe [FilterRule]) (Maybe Integer) (Maybe [FilterRule]) (Maybe Options) (Maybe TaskExecutionResultDetail) (Maybe POSIX) (Maybe TaskExecutionStatus) (Maybe Text) Int
- newDescribeTaskExecutionResponse :: Int -> DescribeTaskExecutionResponse
- data ListAgents = ListAgents' (Maybe Natural) (Maybe Text)
- newListAgents :: ListAgents
- data ListAgentsResponse = ListAgentsResponse' (Maybe [AgentListEntry]) (Maybe Text) Int
- newListAgentsResponse :: Int -> ListAgentsResponse
- data ListLocations = ListLocations' (Maybe [LocationFilter]) (Maybe Natural) (Maybe Text)
- newListLocations :: ListLocations
- data ListLocationsResponse = ListLocationsResponse' (Maybe [LocationListEntry]) (Maybe Text) Int
- newListLocationsResponse :: Int -> ListLocationsResponse
- data ListTagsForResource = ListTagsForResource' (Maybe Natural) (Maybe Text) Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe Text) (Maybe [TagListEntry]) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data ListTaskExecutions = ListTaskExecutions' (Maybe Natural) (Maybe Text) (Maybe Text)
- newListTaskExecutions :: ListTaskExecutions
- data ListTaskExecutionsResponse = ListTaskExecutionsResponse' (Maybe Text) (Maybe [TaskExecutionListEntry]) Int
- newListTaskExecutionsResponse :: Int -> ListTaskExecutionsResponse
- data ListTasks = ListTasks' (Maybe [TaskFilter]) (Maybe Natural) (Maybe Text)
- newListTasks :: ListTasks
- data ListTasksResponse = ListTasksResponse' (Maybe Text) (Maybe [TaskListEntry]) Int
- newListTasksResponse :: Int -> ListTasksResponse
- data StartTaskExecution = StartTaskExecution' (Maybe [FilterRule]) (Maybe [FilterRule]) (Maybe Options) (Maybe [TagListEntry]) Text
- newStartTaskExecution :: Text -> StartTaskExecution
- data StartTaskExecutionResponse = StartTaskExecutionResponse' (Maybe Text) Int
- newStartTaskExecutionResponse :: Int -> StartTaskExecutionResponse
- data TagResource = TagResource' Text [TagListEntry]
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data UntagResource = UntagResource' Text (NonEmpty Text)
- newUntagResource :: Text -> NonEmpty Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data UpdateAgent = UpdateAgent' (Maybe Text) Text
- newUpdateAgent :: Text -> UpdateAgent
- data UpdateAgentResponse = UpdateAgentResponse' Int
- newUpdateAgentResponse :: Int -> UpdateAgentResponse
- data UpdateLocationHdfs = UpdateLocationHdfs' (Maybe (NonEmpty Text)) (Maybe HdfsAuthenticationType) (Maybe Natural) (Maybe Base64) (Maybe Base64) (Maybe Text) (Maybe Text) (Maybe (NonEmpty HdfsNameNode)) (Maybe QopConfiguration) (Maybe Natural) (Maybe Text) (Maybe Text) Text
- newUpdateLocationHdfs :: Text -> UpdateLocationHdfs
- data UpdateLocationHdfsResponse = UpdateLocationHdfsResponse' Int
- newUpdateLocationHdfsResponse :: Int -> UpdateLocationHdfsResponse
- data UpdateLocationNfs = UpdateLocationNfs' (Maybe NfsMountOptions) (Maybe OnPremConfig) (Maybe Text) Text
- newUpdateLocationNfs :: Text -> UpdateLocationNfs
- data UpdateLocationNfsResponse = UpdateLocationNfsResponse' Int
- newUpdateLocationNfsResponse :: Int -> UpdateLocationNfsResponse
- data UpdateLocationObjectStorage = UpdateLocationObjectStorage' (Maybe Text) (Maybe (NonEmpty Text)) (Maybe (Sensitive Text)) (Maybe Base64) (Maybe Natural) (Maybe ObjectStorageServerProtocol) (Maybe Text) Text
- newUpdateLocationObjectStorage :: Text -> UpdateLocationObjectStorage
- data UpdateLocationObjectStorageResponse = UpdateLocationObjectStorageResponse' Int
- newUpdateLocationObjectStorageResponse :: Int -> UpdateLocationObjectStorageResponse
- data UpdateLocationSmb = UpdateLocationSmb' (Maybe (NonEmpty Text)) (Maybe Text) (Maybe SmbMountOptions) (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text) Text
- newUpdateLocationSmb :: Text -> UpdateLocationSmb
- data UpdateLocationSmbResponse = UpdateLocationSmbResponse' Int
- newUpdateLocationSmbResponse :: Int -> UpdateLocationSmbResponse
- data UpdateTask = UpdateTask' (Maybe Text) (Maybe [FilterRule]) (Maybe [FilterRule]) (Maybe Text) (Maybe Options) (Maybe TaskSchedule) Text
- newUpdateTask :: Text -> UpdateTask
- data UpdateTaskResponse = UpdateTaskResponse' Int
- newUpdateTaskResponse :: Int -> UpdateTaskResponse
- data UpdateTaskExecution = UpdateTaskExecution' Text Options
- newUpdateTaskExecution :: Text -> Options -> UpdateTaskExecution
- data UpdateTaskExecutionResponse = UpdateTaskExecutionResponse' Int
- newUpdateTaskExecutionResponse :: Int -> UpdateTaskExecutionResponse
- newtype AgentStatus where
- AgentStatus' { }
- pattern AgentStatus_OFFLINE :: AgentStatus
- pattern AgentStatus_ONLINE :: AgentStatus
- newtype Atime where
- Atime' { }
- pattern Atime_BEST_EFFORT :: Atime
- pattern Atime_NONE :: Atime
- newtype EfsInTransitEncryption where
- newtype EndpointType where
- EndpointType' { }
- pattern EndpointType_FIPS :: EndpointType
- pattern EndpointType_PRIVATE_LINK :: EndpointType
- pattern EndpointType_PUBLIC :: EndpointType
- newtype FilterType where
- FilterType' { }
- pattern FilterType_SIMPLE_PATTERN :: FilterType
- newtype Gid where
- newtype HdfsAuthenticationType where
- newtype HdfsDataTransferProtection where
- HdfsDataTransferProtection' { }
- pattern HdfsDataTransferProtection_AUTHENTICATION :: HdfsDataTransferProtection
- pattern HdfsDataTransferProtection_DISABLED :: HdfsDataTransferProtection
- pattern HdfsDataTransferProtection_INTEGRITY :: HdfsDataTransferProtection
- pattern HdfsDataTransferProtection_PRIVACY :: HdfsDataTransferProtection
- newtype HdfsRpcProtection where
- HdfsRpcProtection' { }
- pattern HdfsRpcProtection_AUTHENTICATION :: HdfsRpcProtection
- pattern HdfsRpcProtection_DISABLED :: HdfsRpcProtection
- pattern HdfsRpcProtection_INTEGRITY :: HdfsRpcProtection
- pattern HdfsRpcProtection_PRIVACY :: HdfsRpcProtection
- newtype LocationFilterName where
- newtype LogLevel where
- LogLevel' {
- fromLogLevel :: Text
- pattern LogLevel_BASIC :: LogLevel
- pattern LogLevel_OFF :: LogLevel
- pattern LogLevel_TRANSFER :: LogLevel
- LogLevel' {
- newtype Mtime where
- Mtime' { }
- pattern Mtime_NONE :: Mtime
- pattern Mtime_PRESERVE :: Mtime
- newtype NfsVersion where
- NfsVersion' { }
- pattern NfsVersion_AUTOMATIC :: NfsVersion
- pattern NfsVersion_NFS3 :: NfsVersion
- pattern NfsVersion_NFS4_0 :: NfsVersion
- pattern NfsVersion_NFS4_1 :: NfsVersion
- newtype ObjectStorageServerProtocol where
- newtype ObjectTags where
- ObjectTags' { }
- pattern ObjectTags_NONE :: ObjectTags
- pattern ObjectTags_PRESERVE :: ObjectTags
- newtype Operator where
- Operator' {
- fromOperator :: Text
- pattern Operator_BeginsWith :: Operator
- pattern Operator_Contains :: Operator
- pattern Operator_Equals :: Operator
- pattern Operator_GreaterThan :: Operator
- pattern Operator_GreaterThanOrEqual :: Operator
- pattern Operator_In :: Operator
- pattern Operator_LessThan :: Operator
- pattern Operator_LessThanOrEqual :: Operator
- pattern Operator_NotContains :: Operator
- pattern Operator_NotEquals :: Operator
- Operator' {
- newtype OverwriteMode where
- OverwriteMode' { }
- pattern OverwriteMode_ALWAYS :: OverwriteMode
- pattern OverwriteMode_NEVER :: OverwriteMode
- newtype PhaseStatus where
- PhaseStatus' { }
- pattern PhaseStatus_ERROR :: PhaseStatus
- pattern PhaseStatus_PENDING :: PhaseStatus
- pattern PhaseStatus_SUCCESS :: PhaseStatus
- newtype PosixPermissions where
- PosixPermissions' { }
- pattern PosixPermissions_NONE :: PosixPermissions
- pattern PosixPermissions_PRESERVE :: PosixPermissions
- newtype PreserveDeletedFiles where
- newtype PreserveDevices where
- PreserveDevices' { }
- pattern PreserveDevices_NONE :: PreserveDevices
- pattern PreserveDevices_PRESERVE :: PreserveDevices
- newtype S3StorageClass where
- S3StorageClass' { }
- pattern S3StorageClass_DEEP_ARCHIVE :: S3StorageClass
- pattern S3StorageClass_GLACIER :: S3StorageClass
- pattern S3StorageClass_GLACIER_INSTANT_RETRIEVAL :: S3StorageClass
- pattern S3StorageClass_INTELLIGENT_TIERING :: S3StorageClass
- pattern S3StorageClass_ONEZONE_IA :: S3StorageClass
- pattern S3StorageClass_OUTPOSTS :: S3StorageClass
- pattern S3StorageClass_STANDARD :: S3StorageClass
- pattern S3StorageClass_STANDARD_IA :: S3StorageClass
- newtype SmbSecurityDescriptorCopyFlags where
- newtype SmbVersion where
- SmbVersion' { }
- pattern SmbVersion_AUTOMATIC :: SmbVersion
- pattern SmbVersion_SMB2 :: SmbVersion
- pattern SmbVersion_SMB3 :: SmbVersion
- newtype TaskExecutionStatus where
- TaskExecutionStatus' { }
- pattern TaskExecutionStatus_ERROR :: TaskExecutionStatus
- pattern TaskExecutionStatus_LAUNCHING :: TaskExecutionStatus
- pattern TaskExecutionStatus_PREPARING :: TaskExecutionStatus
- pattern TaskExecutionStatus_QUEUED :: TaskExecutionStatus
- pattern TaskExecutionStatus_SUCCESS :: TaskExecutionStatus
- pattern TaskExecutionStatus_TRANSFERRING :: TaskExecutionStatus
- pattern TaskExecutionStatus_VERIFYING :: TaskExecutionStatus
- newtype TaskFilterName where
- TaskFilterName' { }
- pattern TaskFilterName_CreationTime :: TaskFilterName
- pattern TaskFilterName_LocationId :: TaskFilterName
- newtype TaskQueueing where
- TaskQueueing' { }
- pattern TaskQueueing_DISABLED :: TaskQueueing
- pattern TaskQueueing_ENABLED :: TaskQueueing
- newtype TaskStatus where
- TaskStatus' { }
- pattern TaskStatus_AVAILABLE :: TaskStatus
- pattern TaskStatus_CREATING :: TaskStatus
- pattern TaskStatus_QUEUED :: TaskStatus
- pattern TaskStatus_RUNNING :: TaskStatus
- pattern TaskStatus_UNAVAILABLE :: TaskStatus
- newtype TransferMode where
- TransferMode' { }
- pattern TransferMode_ALL :: TransferMode
- pattern TransferMode_CHANGED :: TransferMode
- newtype Uid where
- newtype VerifyMode where
- VerifyMode' { }
- pattern VerifyMode_NONE :: VerifyMode
- pattern VerifyMode_ONLY_FILES_TRANSFERRED :: VerifyMode
- pattern VerifyMode_POINT_IN_TIME_CONSISTENT :: VerifyMode
- data AgentListEntry = AgentListEntry' (Maybe Text) (Maybe Text) (Maybe AgentStatus)
- newAgentListEntry :: AgentListEntry
- data Ec2Config = Ec2Config' Text (NonEmpty Text)
- newEc2Config :: Text -> NonEmpty Text -> Ec2Config
- data FilterRule = FilterRule' (Maybe FilterType) (Maybe Text)
- newFilterRule :: FilterRule
- data FsxProtocol = FsxProtocol' (Maybe FsxProtocolNfs) (Maybe FsxProtocolSmb)
- newFsxProtocol :: FsxProtocol
- data FsxProtocolNfs = FsxProtocolNfs' (Maybe NfsMountOptions)
- newFsxProtocolNfs :: FsxProtocolNfs
- data FsxProtocolSmb = FsxProtocolSmb' (Maybe Text) (Maybe SmbMountOptions) (Sensitive Text) Text
- newFsxProtocolSmb :: Text -> Text -> FsxProtocolSmb
- data HdfsNameNode = HdfsNameNode' Text Natural
- newHdfsNameNode :: Text -> Natural -> HdfsNameNode
- data LocationFilter = LocationFilter' LocationFilterName [Text] Operator
- newLocationFilter :: LocationFilterName -> Operator -> LocationFilter
- data LocationListEntry = LocationListEntry' (Maybe Text) (Maybe Text)
- newLocationListEntry :: LocationListEntry
- data NfsMountOptions = NfsMountOptions' (Maybe NfsVersion)
- newNfsMountOptions :: NfsMountOptions
- data OnPremConfig = OnPremConfig' (NonEmpty Text)
- newOnPremConfig :: NonEmpty Text -> OnPremConfig
- data Options = Options' (Maybe Atime) (Maybe Integer) (Maybe Gid) (Maybe LogLevel) (Maybe Mtime) (Maybe ObjectTags) (Maybe OverwriteMode) (Maybe PosixPermissions) (Maybe PreserveDeletedFiles) (Maybe PreserveDevices) (Maybe SmbSecurityDescriptorCopyFlags) (Maybe TaskQueueing) (Maybe TransferMode) (Maybe Uid) (Maybe VerifyMode)
- newOptions :: Options
- data PrivateLinkConfig = PrivateLinkConfig' (Maybe Text) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe Text)
- newPrivateLinkConfig :: PrivateLinkConfig
- data QopConfiguration = QopConfiguration' (Maybe HdfsDataTransferProtection) (Maybe HdfsRpcProtection)
- newQopConfiguration :: QopConfiguration
- data S3Config = S3Config' Text
- newS3Config :: Text -> S3Config
- data SmbMountOptions = SmbMountOptions' (Maybe SmbVersion)
- newSmbMountOptions :: SmbMountOptions
- data TagListEntry = TagListEntry' (Maybe Text) Text
- newTagListEntry :: Text -> TagListEntry
- data TaskExecutionListEntry = TaskExecutionListEntry' (Maybe TaskExecutionStatus) (Maybe Text)
- newTaskExecutionListEntry :: TaskExecutionListEntry
- data TaskExecutionResultDetail = TaskExecutionResultDetail' (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe PhaseStatus) (Maybe Natural) (Maybe Natural) (Maybe PhaseStatus) (Maybe Natural) (Maybe PhaseStatus)
- newTaskExecutionResultDetail :: TaskExecutionResultDetail
- data TaskFilter = TaskFilter' TaskFilterName [Text] Operator
- newTaskFilter :: TaskFilterName -> Operator -> TaskFilter
- data TaskListEntry = TaskListEntry' (Maybe Text) (Maybe TaskStatus) (Maybe Text)
- newTaskListEntry :: TaskListEntry
- data TaskSchedule = TaskSchedule' Text
- newTaskSchedule :: Text -> TaskSchedule
Service Configuration
defaultService :: Service Source #
API version 2018-11-09
of the Amazon DataSync SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by DataSync
.
InternalException
_InternalException :: AsError a => Fold a ServiceError Source #
This exception is thrown when an error occurs in the DataSync service.
InvalidRequestException
_InvalidRequestException :: AsError a => Fold a ServiceError Source #
This exception is thrown when the client submits a malformed request.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
CancelTaskExecution
data CancelTaskExecution Source #
CancelTaskExecutionRequest
See: newCancelTaskExecution
smart constructor.
Instances
newCancelTaskExecution Source #
Create a value of CancelTaskExecution
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CancelTaskExecution
, cancelTaskExecution_taskExecutionArn
- The Amazon Resource Name (ARN) of the task execution to stop.
data CancelTaskExecutionResponse Source #
See: newCancelTaskExecutionResponse
smart constructor.
Instances
newCancelTaskExecutionResponse Source #
Create a value of CancelTaskExecutionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CancelTaskExecutionResponse'
, cancelTaskExecutionResponse_httpStatus
- The response's http status code.
CreateAgent
data CreateAgent Source #
CreateAgentRequest
See: newCreateAgent
smart constructor.
CreateAgent' (Maybe Text) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe [TagListEntry]) (Maybe Text) Text |
Instances
Create a value of CreateAgent
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:agentName:CreateAgent'
, createAgent_agentName
- The name you configured for your agent. This value is a text reference
that is used to identify the agent in the console.
CreateAgent
, createAgent_securityGroupArns
- The ARNs of the security groups used to protect your data transfer task
subnets. See
SecurityGroupArns.
CreateAgent
, createAgent_subnetArns
- The Amazon Resource Names (ARNs) of the subnets in which DataSync will
create elastic network interfaces for each data transfer task. The agent
that runs a task must be private. When you start a task that is
associated with an agent created in a VPC, or one that has access to an
IP address in a VPC, then the task is also private. In this case,
DataSync creates four network interfaces for each task in your subnet.
For a data transfer to work, the agent must be able to route to all
these four network interfaces.
$sel:tags:CreateAgent'
, createAgent_tags
- The key-value pair that represents the tag that you want to associate
with the agent. The value can be an empty string. This value helps you
manage, filter, and search for your agents.
Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @.
CreateAgent
, createAgent_vpcEndpointId
- The ID of the VPC (virtual private cloud) endpoint that the agent has
access to. This is the client-side VPC endpoint, also called a
PrivateLink. If you don't have a PrivateLink VPC endpoint, see
Creating a VPC Endpoint Service Configuration
in the Amazon VPC User Guide.
VPC endpoint ID looks like this: vpce-01234d5aff67890e1
.
$sel:activationKey:CreateAgent'
, createAgent_activationKey
- Your agent activation key. You can get the activation key either by
sending an HTTP GET request with redirects that enable you to get the
agent IP address (port 80). Alternatively, you can get it from the
DataSync console.
The redirect URL returned in the response provides you the activation
key for your agent in the query string parameter activationKey
. It
might also include other activation-related parameters; however, these
are merely defaults. The arguments you pass to this API call determine
the actual configuration of your agent.
For more information, see Activating an Agent in the /DataSync User Guide./
data CreateAgentResponse Source #
CreateAgentResponse
See: newCreateAgentResponse
smart constructor.
Instances
newCreateAgentResponse Source #
Create a value of CreateAgentResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateAgentResponse
, createAgentResponse_agentArn
- The Amazon Resource Name (ARN) of the agent. Use the ListAgents
operation to return a list of agents for your account and Amazon Web
Services Region.
$sel:httpStatus:CreateAgentResponse'
, createAgentResponse_httpStatus
- The response's http status code.
CreateLocationEfs
data CreateLocationEfs Source #
CreateLocationEfsRequest
See: newCreateLocationEfs
smart constructor.
CreateLocationEfs' (Maybe Text) (Maybe Text) (Maybe EfsInTransitEncryption) (Maybe Text) (Maybe [TagListEntry]) Text Ec2Config |
Instances
:: Text | |
-> Ec2Config | |
-> CreateLocationEfs |
Create a value of CreateLocationEfs
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accessPointArn:CreateLocationEfs'
, createLocationEfs_accessPointArn
- Specifies the Amazon Resource Name (ARN) of the access point that
DataSync uses to access the Amazon EFS file system.
$sel:fileSystemAccessRoleArn:CreateLocationEfs'
, createLocationEfs_fileSystemAccessRoleArn
- Specifies an Identity and Access Management (IAM) role that DataSync
assumes when mounting the Amazon EFS file system.
$sel:inTransitEncryption:CreateLocationEfs'
, createLocationEfs_inTransitEncryption
- Specifies whether you want DataSync to use Transport Layer Security
(TLS) 1.2 encryption when it copies data to or from the Amazon EFS file
system.
If you specify an access point using AccessPointArn
or an IAM role
using FileSystemAccessRoleArn
, you must set this parameter to
TLS1_2
.
$sel:subdirectory:CreateLocationEfs'
, createLocationEfs_subdirectory
- Specifies a mount path for your Amazon EFS file system. This is where
DataSync reads or writes data (depending on if this is a source or
destination location). By default, DataSync uses the root directory, but
you can also include subdirectories.
You must specify a value with forward slashes (for example,
/path/to/folder
).
$sel:tags:CreateLocationEfs'
, createLocationEfs_tags
- Specifies the key-value pair that represents a tag that you want to add
to the resource. The value can be an empty string. This value helps you
manage, filter, and search for your resources. We recommend that you
create a name tag for your location.
$sel:efsFilesystemArn:CreateLocationEfs'
, createLocationEfs_efsFilesystemArn
- Specifies the ARN for the Amazon EFS file system.
$sel:ec2Config:CreateLocationEfs'
, createLocationEfs_ec2Config
- Specifies the subnet and security groups DataSync uses to access your
Amazon EFS file system.
data CreateLocationEfsResponse Source #
CreateLocationEfs
See: newCreateLocationEfsResponse
smart constructor.
Instances
newCreateLocationEfsResponse Source #
Create a value of CreateLocationEfsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateLocationEfsResponse
, createLocationEfsResponse_locationArn
- The Amazon Resource Name (ARN) of the Amazon EFS file system location
that you create.
$sel:httpStatus:CreateLocationEfsResponse'
, createLocationEfsResponse_httpStatus
- The response's http status code.
CreateLocationFsxLustre
data CreateLocationFsxLustre Source #
See: newCreateLocationFsxLustre
smart constructor.
Instances
newCreateLocationFsxLustre Source #
:: Text | |
-> NonEmpty Text | |
-> CreateLocationFsxLustre |
Create a value of CreateLocationFsxLustre
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:subdirectory:CreateLocationFsxLustre'
, createLocationFsxLustre_subdirectory
- A subdirectory in the location's path. This subdirectory in the FSx for
Lustre file system is used to read data from the FSx for Lustre source
location or write data to the FSx for Lustre destination.
$sel:tags:CreateLocationFsxLustre'
, createLocationFsxLustre_tags
- The key-value pair that represents a tag that you want to add to the
resource. The value can be an empty string. This value helps you manage,
filter, and search for your resources. We recommend that you create a
name tag for your location.
$sel:fsxFilesystemArn:CreateLocationFsxLustre'
, createLocationFsxLustre_fsxFilesystemArn
- The Amazon Resource Name (ARN) for the FSx for Lustre file system.
CreateLocationFsxLustre
, createLocationFsxLustre_securityGroupArns
- The Amazon Resource Names (ARNs) of the security groups that are used to
configure the FSx for Lustre file system.
data CreateLocationFsxLustreResponse Source #
See: newCreateLocationFsxLustreResponse
smart constructor.
Instances
Generic CreateLocationFsxLustreResponse Source # | |
Read CreateLocationFsxLustreResponse Source # | |
Show CreateLocationFsxLustreResponse Source # | |
Defined in Amazonka.DataSync.CreateLocationFsxLustre | |
NFData CreateLocationFsxLustreResponse Source # | |
Defined in Amazonka.DataSync.CreateLocationFsxLustre rnf :: CreateLocationFsxLustreResponse -> () # | |
Eq CreateLocationFsxLustreResponse Source # | |
type Rep CreateLocationFsxLustreResponse Source # | |
Defined in Amazonka.DataSync.CreateLocationFsxLustre type Rep CreateLocationFsxLustreResponse = D1 ('MetaData "CreateLocationFsxLustreResponse" "Amazonka.DataSync.CreateLocationFsxLustre" "amazonka-datasync-2.0-LCcm4ddRe2z4CES4wun76Z" 'False) (C1 ('MetaCons "CreateLocationFsxLustreResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "locationArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newCreateLocationFsxLustreResponse Source #
Create a value of CreateLocationFsxLustreResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateLocationFsxLustreResponse
, createLocationFsxLustreResponse_locationArn
- The Amazon Resource Name (ARN) of the FSx for Lustre file system
location that's created.
$sel:httpStatus:CreateLocationFsxLustreResponse'
, createLocationFsxLustreResponse_httpStatus
- The response's http status code.
CreateLocationFsxOntap
data CreateLocationFsxOntap Source #
See: newCreateLocationFsxOntap
smart constructor.
Instances
newCreateLocationFsxOntap Source #
:: FsxProtocol | |
-> NonEmpty Text | |
-> Text | |
-> CreateLocationFsxOntap |
Create a value of CreateLocationFsxOntap
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:subdirectory:CreateLocationFsxOntap'
, createLocationFsxOntap_subdirectory
- Specifies the junction path (also known as a mount point) in the SVM
volume where you're copying data to or from (for example, /vol1
).
Don't specify a junction path in the SVM's root volume. For more information, see Managing FSx for ONTAP storage virtual machines in the Amazon FSx for NetApp ONTAP User Guide.
$sel:tags:CreateLocationFsxOntap'
, createLocationFsxOntap_tags
- Specifies labels that help you categorize, filter, and search for your
Amazon Web Services resources. We recommend creating at least a name tag
for your location.
$sel:protocol:CreateLocationFsxOntap'
, createLocationFsxOntap_protocol
- Undocumented member.
CreateLocationFsxOntap
, createLocationFsxOntap_securityGroupArns
- Specifies the Amazon EC2 security groups that provide access to your
file system's preferred subnet.
The security groups must allow outbound traffic on the following ports (depending on the protocol you use):
- Network File System (NFS): TCP ports 111, 635, and 2049
- Server Message Block (SMB): TCP port 445
Your file system's security groups must also allow inbound traffic on the same ports.
$sel:storageVirtualMachineArn:CreateLocationFsxOntap'
, createLocationFsxOntap_storageVirtualMachineArn
- Specifies the ARN of the storage virtual machine (SVM) on your file
system where you're copying data to or from.
data CreateLocationFsxOntapResponse Source #
See: newCreateLocationFsxOntapResponse
smart constructor.
Instances
Generic CreateLocationFsxOntapResponse Source # | |
Read CreateLocationFsxOntapResponse Source # | |
Show CreateLocationFsxOntapResponse Source # | |
Defined in Amazonka.DataSync.CreateLocationFsxOntap | |
NFData CreateLocationFsxOntapResponse Source # | |
Defined in Amazonka.DataSync.CreateLocationFsxOntap rnf :: CreateLocationFsxOntapResponse -> () # | |
Eq CreateLocationFsxOntapResponse Source # | |
type Rep CreateLocationFsxOntapResponse Source # | |
Defined in Amazonka.DataSync.CreateLocationFsxOntap type Rep CreateLocationFsxOntapResponse = D1 ('MetaData "CreateLocationFsxOntapResponse" "Amazonka.DataSync.CreateLocationFsxOntap" "amazonka-datasync-2.0-LCcm4ddRe2z4CES4wun76Z" 'False) (C1 ('MetaCons "CreateLocationFsxOntapResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "locationArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newCreateLocationFsxOntapResponse Source #
Create a value of CreateLocationFsxOntapResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateLocationFsxOntapResponse
, createLocationFsxOntapResponse_locationArn
- Specifies the ARN of the FSx for ONTAP file system location that you
create.
$sel:httpStatus:CreateLocationFsxOntapResponse'
, createLocationFsxOntapResponse_httpStatus
- The response's http status code.
CreateLocationFsxOpenZfs
data CreateLocationFsxOpenZfs Source #
See: newCreateLocationFsxOpenZfs
smart constructor.
Instances
newCreateLocationFsxOpenZfs Source #
:: Text | |
-> FsxProtocol | |
-> NonEmpty Text | |
-> CreateLocationFsxOpenZfs |
Create a value of CreateLocationFsxOpenZfs
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:subdirectory:CreateLocationFsxOpenZfs'
, createLocationFsxOpenZfs_subdirectory
- A subdirectory in the location's path that must begin with /fsx
.
DataSync uses this subdirectory to read or write data (depending on
whether the file system is a source or destination location).
$sel:tags:CreateLocationFsxOpenZfs'
, createLocationFsxOpenZfs_tags
- The key-value pair that represents a tag that you want to add to the
resource. The value can be an empty string. This value helps you manage,
filter, and search for your resources. We recommend that you create a
name tag for your location.
$sel:fsxFilesystemArn:CreateLocationFsxOpenZfs'
, createLocationFsxOpenZfs_fsxFilesystemArn
- The Amazon Resource Name (ARN) of the FSx for OpenZFS file system.
$sel:protocol:CreateLocationFsxOpenZfs'
, createLocationFsxOpenZfs_protocol
- The type of protocol that DataSync uses to access your file system.
CreateLocationFsxOpenZfs
, createLocationFsxOpenZfs_securityGroupArns
- The ARNs of the security groups that are used to configure the FSx for
OpenZFS file system.
data CreateLocationFsxOpenZfsResponse Source #
See: newCreateLocationFsxOpenZfsResponse
smart constructor.
Instances
Generic CreateLocationFsxOpenZfsResponse Source # | |
Read CreateLocationFsxOpenZfsResponse Source # | |
Show CreateLocationFsxOpenZfsResponse Source # | |
NFData CreateLocationFsxOpenZfsResponse Source # | |
Defined in Amazonka.DataSync.CreateLocationFsxOpenZfs rnf :: CreateLocationFsxOpenZfsResponse -> () # | |
Eq CreateLocationFsxOpenZfsResponse Source # | |
type Rep CreateLocationFsxOpenZfsResponse Source # | |
Defined in Amazonka.DataSync.CreateLocationFsxOpenZfs type Rep CreateLocationFsxOpenZfsResponse = D1 ('MetaData "CreateLocationFsxOpenZfsResponse" "Amazonka.DataSync.CreateLocationFsxOpenZfs" "amazonka-datasync-2.0-LCcm4ddRe2z4CES4wun76Z" 'False) (C1 ('MetaCons "CreateLocationFsxOpenZfsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "locationArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newCreateLocationFsxOpenZfsResponse Source #
Create a value of CreateLocationFsxOpenZfsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateLocationFsxOpenZfsResponse
, createLocationFsxOpenZfsResponse_locationArn
- The ARN of the FSx for OpenZFS file system location that you created.
$sel:httpStatus:CreateLocationFsxOpenZfsResponse'
, createLocationFsxOpenZfsResponse_httpStatus
- The response's http status code.
CreateLocationFsxWindows
data CreateLocationFsxWindows Source #
See: newCreateLocationFsxWindows
smart constructor.
CreateLocationFsxWindows' (Maybe Text) (Maybe Text) (Maybe [TagListEntry]) Text (NonEmpty Text) Text (Sensitive Text) |
Instances
newCreateLocationFsxWindows Source #
Create a value of CreateLocationFsxWindows
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateLocationFsxWindows
, createLocationFsxWindows_domain
- Specifies the name of the Windows domain that the FSx for Windows File
Server belongs to.
$sel:subdirectory:CreateLocationFsxWindows'
, createLocationFsxWindows_subdirectory
- Specifies a mount path for your file system using forward slashes. This
is where DataSync reads or writes data (depending on if this is a source
or destination location).
$sel:tags:CreateLocationFsxWindows'
, createLocationFsxWindows_tags
- Specifies labels that help you categorize, filter, and search for your
Amazon Web Services resources. We recommend creating at least a name tag
for your location.
$sel:fsxFilesystemArn:CreateLocationFsxWindows'
, createLocationFsxWindows_fsxFilesystemArn
- Specifies the Amazon Resource Name (ARN) for the FSx for Windows File
Server file system.
CreateLocationFsxWindows
, createLocationFsxWindows_securityGroupArns
- Specifies the ARNs of the security groups that provide access to your
file system's preferred subnet.
If you choose a security group that doesn't allow connections from within itself, do one of the following:
- Configure the security group to allow it to communicate within itself.
- Choose a different security group that can communicate with the mount target's security group.
CreateLocationFsxWindows
, createLocationFsxWindows_user
- Specifies the user who has the permissions to access files and folders
in the file system.
For information about choosing a user name that ensures sufficient permissions to files, folders, and metadata, see user.
CreateLocationFsxWindows
, createLocationFsxWindows_password
- Specifies the password of the user who has the permissions to access
files and folders in the file system.
data CreateLocationFsxWindowsResponse Source #
See: newCreateLocationFsxWindowsResponse
smart constructor.
Instances
Generic CreateLocationFsxWindowsResponse Source # | |
Read CreateLocationFsxWindowsResponse Source # | |
Show CreateLocationFsxWindowsResponse Source # | |
NFData CreateLocationFsxWindowsResponse Source # | |
Defined in Amazonka.DataSync.CreateLocationFsxWindows rnf :: CreateLocationFsxWindowsResponse -> () # | |
Eq CreateLocationFsxWindowsResponse Source # | |
type Rep CreateLocationFsxWindowsResponse Source # | |
Defined in Amazonka.DataSync.CreateLocationFsxWindows type Rep CreateLocationFsxWindowsResponse = D1 ('MetaData "CreateLocationFsxWindowsResponse" "Amazonka.DataSync.CreateLocationFsxWindows" "amazonka-datasync-2.0-LCcm4ddRe2z4CES4wun76Z" 'False) (C1 ('MetaCons "CreateLocationFsxWindowsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "locationArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newCreateLocationFsxWindowsResponse Source #
Create a value of CreateLocationFsxWindowsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateLocationFsxWindowsResponse
, createLocationFsxWindowsResponse_locationArn
- The ARN of the FSx for Windows File Server file system location you
created.
$sel:httpStatus:CreateLocationFsxWindowsResponse'
, createLocationFsxWindowsResponse_httpStatus
- The response's http status code.
CreateLocationHdfs
data CreateLocationHdfs Source #
See: newCreateLocationHdfs
smart constructor.
CreateLocationHdfs' (Maybe Natural) (Maybe Base64) (Maybe Base64) (Maybe Text) (Maybe Text) (Maybe QopConfiguration) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe [TagListEntry]) (NonEmpty HdfsNameNode) HdfsAuthenticationType (NonEmpty Text) |
Instances
newCreateLocationHdfs Source #
Create a value of CreateLocationHdfs
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:blockSize:CreateLocationHdfs'
, createLocationHdfs_blockSize
- The size of data blocks to write into the HDFS cluster. The block size
must be a multiple of 512 bytes. The default block size is 128 mebibytes
(MiB).
$sel:kerberosKeytab:CreateLocationHdfs'
, createLocationHdfs_kerberosKeytab
- The Kerberos key table (keytab) that contains mappings between the
defined Kerberos principal and the encrypted keys. You can load the
keytab from a file by providing the file's address. If you're using
the CLI, it performs base64 encoding for you. Otherwise, provide the
base64-encoded text.
If KERBEROS
is specified for AuthenticationType
, this parameter is
required.--
-- Note: This Lens
automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens
accepts and returns only raw unencoded data.
$sel:kerberosKrb5Conf:CreateLocationHdfs'
, createLocationHdfs_kerberosKrb5Conf
- The krb5.conf
file that contains the Kerberos configuration
information. You can load the krb5.conf
file by providing the file's
address. If you're using the CLI, it performs the base64 encoding for
you. Otherwise, provide the base64-encoded text.
If KERBEROS
is specified for AuthenticationType
, this parameter is
required.--
-- Note: This Lens
automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens
accepts and returns only raw unencoded data.
$sel:kerberosPrincipal:CreateLocationHdfs'
, createLocationHdfs_kerberosPrincipal
- The Kerberos principal with access to the files and folders on the HDFS
cluster.
If KERBEROS
is specified for AuthenticationType
, this parameter is
required.
$sel:kmsKeyProviderUri:CreateLocationHdfs'
, createLocationHdfs_kmsKeyProviderUri
- The URI of the HDFS cluster's Key Management Server (KMS).
$sel:qopConfiguration:CreateLocationHdfs'
, createLocationHdfs_qopConfiguration
- The Quality of Protection (QOP) configuration specifies the Remote
Procedure Call (RPC) and data transfer protection settings configured on
the Hadoop Distributed File System (HDFS) cluster. If QopConfiguration
isn't specified, RpcProtection
and DataTransferProtection
default
to PRIVACY
. If you set RpcProtection
or DataTransferProtection
,
the other parameter assumes the same value.
$sel:replicationFactor:CreateLocationHdfs'
, createLocationHdfs_replicationFactor
- The number of DataNodes to replicate the data to when writing to the
HDFS cluster. By default, data is replicated to three DataNodes.
$sel:simpleUser:CreateLocationHdfs'
, createLocationHdfs_simpleUser
- The user name used to identify the client on the host operating system.
If SIMPLE
is specified for AuthenticationType
, this parameter is
required.
$sel:subdirectory:CreateLocationHdfs'
, createLocationHdfs_subdirectory
- A subdirectory in the HDFS cluster. This subdirectory is used to read
data from or write data to the HDFS cluster. If the subdirectory isn't
specified, it will default to /
.
$sel:tags:CreateLocationHdfs'
, createLocationHdfs_tags
- The key-value pair that represents the tag that you want to add to the
location. The value can be an empty string. We recommend using tags to
name your resources.
$sel:nameNodes:CreateLocationHdfs'
, createLocationHdfs_nameNodes
- The NameNode that manages the HDFS namespace. The NameNode performs
operations such as opening, closing, and renaming files and directories.
The NameNode contains the information to map blocks of data to the
DataNodes. You can use only one NameNode.
$sel:authenticationType:CreateLocationHdfs'
, createLocationHdfs_authenticationType
- The type of authentication used to determine the identity of the user.
CreateLocationHdfs
, createLocationHdfs_agentArns
- The Amazon Resource Names (ARNs) of the agents that are used to connect
to the HDFS cluster.
data CreateLocationHdfsResponse Source #
See: newCreateLocationHdfsResponse
smart constructor.
Instances
newCreateLocationHdfsResponse Source #
Create a value of CreateLocationHdfsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateLocationHdfsResponse
, createLocationHdfsResponse_locationArn
- The ARN of the source HDFS cluster location that's created.
$sel:httpStatus:CreateLocationHdfsResponse'
, createLocationHdfsResponse_httpStatus
- The response's http status code.
CreateLocationNfs
data CreateLocationNfs Source #
CreateLocationNfsRequest
See: newCreateLocationNfs
smart constructor.
Instances
:: Text | |
-> Text | |
-> OnPremConfig | |
-> CreateLocationNfs |
Create a value of CreateLocationNfs
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateLocationNfs
, createLocationNfs_mountOptions
- The NFS mount options that DataSync can use to mount your NFS share.
$sel:tags:CreateLocationNfs'
, createLocationNfs_tags
- The key-value pair that represents the tag that you want to add to the
location. The value can be an empty string. We recommend using tags to
name your resources.
$sel:subdirectory:CreateLocationNfs'
, createLocationNfs_subdirectory
- The subdirectory in the NFS file system that is used to read data from
the NFS source location or write data to the NFS destination. The NFS
path should be a path that's exported by the NFS server, or a
subdirectory of that path. The path should be such that it can be
mounted by other NFS clients in your network.
To see all the paths exported by your NFS server, run
"showmount -e nfs-server-name
" from an NFS client that has access to
your server. You can specify any directory that appears in the results,
and any subdirectory of that directory. Ensure that the NFS export is
accessible without Kerberos authentication.
To transfer all the data in the folder you specified, DataSync needs to
have permissions to read all the data. To ensure this, either configure
the NFS export with no_root_squash,
or ensure that the permissions for
all of the files that you want DataSync allow read access for all users.
Doing either enables the agent to read the files. For the agent to
access directories, you must additionally enable all execute access.
If you are copying data to or from your Snowcone device, see NFS Server on Snowcone for more information.
For information about NFS export configuration, see 18.7. The /etc/exports Configuration File in the Red Hat Enterprise Linux documentation.
$sel:serverHostname:CreateLocationNfs'
, createLocationNfs_serverHostname
- The name of the NFS server. This value is the IP address or Domain Name
Service (DNS) name of the NFS server. An agent that is installed
on-premises uses this hostname to mount the NFS server in a network.
If you are copying data to or from your Snowcone device, see NFS Server on Snowcone for more information.
This name must either be DNS-compliant or must be an IP version 4 (IPv4) address.
$sel:onPremConfig:CreateLocationNfs'
, createLocationNfs_onPremConfig
- Contains a list of Amazon Resource Names (ARNs) of agents that are used
to connect to an NFS server.
If you are copying data to or from your Snowcone device, see NFS Server on Snowcone for more information.
data CreateLocationNfsResponse Source #
CreateLocationNfsResponse
See: newCreateLocationNfsResponse
smart constructor.
Instances
newCreateLocationNfsResponse Source #
Create a value of CreateLocationNfsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateLocationNfsResponse
, createLocationNfsResponse_locationArn
- The Amazon Resource Name (ARN) of the source NFS file system location
that is created.
$sel:httpStatus:CreateLocationNfsResponse'
, createLocationNfsResponse_httpStatus
- The response's http status code.
CreateLocationObjectStorage
data CreateLocationObjectStorage Source #
CreateLocationObjectStorageRequest
See: newCreateLocationObjectStorage
smart constructor.
CreateLocationObjectStorage' (Maybe Text) (Maybe (Sensitive Text)) (Maybe Base64) (Maybe Natural) (Maybe ObjectStorageServerProtocol) (Maybe Text) (Maybe [TagListEntry]) Text Text (NonEmpty Text) |
Instances
newCreateLocationObjectStorage Source #
:: Text | |
-> Text | |
-> NonEmpty Text | |
-> CreateLocationObjectStorage |
Create a value of CreateLocationObjectStorage
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accessKey:CreateLocationObjectStorage'
, createLocationObjectStorage_accessKey
- Specifies the access key (for example, a user name) if credentials are
required to authenticate with the object storage server.
$sel:secretKey:CreateLocationObjectStorage'
, createLocationObjectStorage_secretKey
- Specifies the secret key (for example, a password) if credentials are
required to authenticate with the object storage server.
$sel:serverCertificate:CreateLocationObjectStorage'
, createLocationObjectStorage_serverCertificate
- Specifies a certificate to authenticate with an object storage system
that uses a private or self-signed certificate authority (CA). You must
specify a Base64-encoded .pem
file (for example,
file:///home/user/.ssh/storage_sys_certificate.pem
). The
certificate can be up to 32768 bytes (before Base64 encoding).
To use this parameter, configure ServerProtocol
to HTTPS
.--
-- Note: This Lens
automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens
accepts and returns only raw unencoded data.
$sel:serverPort:CreateLocationObjectStorage'
, createLocationObjectStorage_serverPort
- Specifies the port that your object storage server accepts inbound
network traffic on (for example, port 443).
$sel:serverProtocol:CreateLocationObjectStorage'
, createLocationObjectStorage_serverProtocol
- Specifies the protocol that your object storage server uses to
communicate.
$sel:subdirectory:CreateLocationObjectStorage'
, createLocationObjectStorage_subdirectory
- Specifies the object prefix for your object storage server. If this is a
source location, DataSync only copies objects with this prefix. If this
is a destination location, DataSync writes all objects with this prefix.
$sel:tags:CreateLocationObjectStorage'
, createLocationObjectStorage_tags
- Specifies the key-value pair that represents a tag that you want to add
to the resource. Tags can help you manage, filter, and search for your
resources. We recommend creating a name tag for your location.
$sel:serverHostname:CreateLocationObjectStorage'
, createLocationObjectStorage_serverHostname
- Specifies the domain name or IP address of the object storage server. A
DataSync agent uses this hostname to mount the object storage server in
a network.
$sel:bucketName:CreateLocationObjectStorage'
, createLocationObjectStorage_bucketName
- Specifies the name of the object storage bucket involved in the
transfer.
CreateLocationObjectStorage
, createLocationObjectStorage_agentArns
- Specifies the Amazon Resource Names (ARNs) of the DataSync agents that
can securely connect with your location.
data CreateLocationObjectStorageResponse Source #
CreateLocationObjectStorageResponse
See: newCreateLocationObjectStorageResponse
smart constructor.
Instances
Generic CreateLocationObjectStorageResponse Source # | |
Read CreateLocationObjectStorageResponse Source # | |
Show CreateLocationObjectStorageResponse Source # | |
NFData CreateLocationObjectStorageResponse Source # | |
Defined in Amazonka.DataSync.CreateLocationObjectStorage rnf :: CreateLocationObjectStorageResponse -> () # | |
Eq CreateLocationObjectStorageResponse Source # | |
type Rep CreateLocationObjectStorageResponse Source # | |
Defined in Amazonka.DataSync.CreateLocationObjectStorage type Rep CreateLocationObjectStorageResponse = D1 ('MetaData "CreateLocationObjectStorageResponse" "Amazonka.DataSync.CreateLocationObjectStorage" "amazonka-datasync-2.0-LCcm4ddRe2z4CES4wun76Z" 'False) (C1 ('MetaCons "CreateLocationObjectStorageResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "locationArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newCreateLocationObjectStorageResponse Source #
Create a value of CreateLocationObjectStorageResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateLocationObjectStorageResponse
, createLocationObjectStorageResponse_locationArn
- Specifies the ARN of the object storage system location that you create.
$sel:httpStatus:CreateLocationObjectStorageResponse'
, createLocationObjectStorageResponse_httpStatus
- The response's http status code.
CreateLocationS3
data CreateLocationS3 Source #
CreateLocationS3Request
See: newCreateLocationS3
smart constructor.
CreateLocationS3' (Maybe (NonEmpty Text)) (Maybe S3StorageClass) (Maybe Text) (Maybe [TagListEntry]) Text S3Config |
Instances
:: Text | |
-> S3Config | |
-> CreateLocationS3 |
Create a value of CreateLocationS3
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateLocationS3
, createLocationS3_agentArns
- If you're using DataSync on an Amazon Web Services Outpost, specify the
Amazon Resource Names (ARNs) of the DataSync agents deployed on your
Outpost. For more information about launching a DataSync agent on an
Amazon Web Services Outpost, see
Deploy your DataSync agent on Outposts.
$sel:s3StorageClass:CreateLocationS3'
, createLocationS3_s3StorageClass
- The Amazon S3 storage class that you want to store your files in when
this location is used as a task destination. For buckets in Amazon Web
Services Regions, the storage class defaults to Standard. For buckets on
Outposts, the storage class defaults to Amazon Web Services S3 Outposts.
For more information about S3 storage classes, see Amazon S3 Storage Classes. Some storage classes have behaviors that can affect your S3 storage cost. For detailed information, see Considerations when working with S3 storage classes in DataSync.
$sel:subdirectory:CreateLocationS3'
, createLocationS3_subdirectory
- A subdirectory in the Amazon S3 bucket. This subdirectory in Amazon S3
is used to read data from the S3 source location or write data to the S3
destination.
$sel:tags:CreateLocationS3'
, createLocationS3_tags
- The key-value pair that represents the tag that you want to add to the
location. The value can be an empty string. We recommend using tags to
name your resources.
$sel:s3BucketArn:CreateLocationS3'
, createLocationS3_s3BucketArn
- The ARN of the Amazon S3 bucket. If the bucket is on an Amazon Web
Services Outpost, this must be an access point ARN.
$sel:s3Config:CreateLocationS3'
, createLocationS3_s3Config
- Undocumented member.
data CreateLocationS3Response Source #
CreateLocationS3Response
See: newCreateLocationS3Response
smart constructor.
Instances
newCreateLocationS3Response Source #
Create a value of CreateLocationS3Response
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateLocationS3Response
, createLocationS3Response_locationArn
- The Amazon Resource Name (ARN) of the source Amazon S3 bucket location
that is created.
$sel:httpStatus:CreateLocationS3Response'
, createLocationS3Response_httpStatus
- The response's http status code.
CreateLocationSmb
data CreateLocationSmb Source #
CreateLocationSmbRequest
See: newCreateLocationSmb
smart constructor.
CreateLocationSmb' (Maybe Text) (Maybe SmbMountOptions) (Maybe [TagListEntry]) Text Text Text (Sensitive Text) (NonEmpty Text) |
Instances
Create a value of CreateLocationSmb
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateLocationSmb
, createLocationSmb_domain
- The name of the Windows domain that the SMB server belongs to.
CreateLocationSmb
, createLocationSmb_mountOptions
- The mount options used by DataSync to access the SMB server.
$sel:tags:CreateLocationSmb'
, createLocationSmb_tags
- The key-value pair that represents the tag that you want to add to the
location. The value can be an empty string. We recommend using tags to
name your resources.
$sel:subdirectory:CreateLocationSmb'
, createLocationSmb_subdirectory
- The subdirectory in the SMB file system that is used to read data from
the SMB source location or write data to the SMB destination. The SMB
path should be a path that's exported by the SMB server, or a
subdirectory of that path. The path should be such that it can be
mounted by other SMB clients in your network.
Subdirectory
must be specified with forward slashes. For example,
/path/to/folder
.
To transfer all the data in the folder you specified, DataSync needs to have permissions to mount the SMB share, as well as to access all the data in that share. To ensure this, either ensure that the user/password specified belongs to the user who can mount the share, and who has the appropriate permissions for all of the files and directories that you want DataSync to access, or use credentials of a member of the Backup Operators group to mount the share. Doing either enables the agent to access the data. For the agent to access directories, you must additionally enable all execute access.
$sel:serverHostname:CreateLocationSmb'
, createLocationSmb_serverHostname
- The name of the SMB server. This value is the IP address or Domain Name
Service (DNS) name of the SMB server. An agent that is installed
on-premises uses this hostname to mount the SMB server in a network.
This name must either be DNS-compliant or must be an IP version 4 (IPv4) address.
CreateLocationSmb
, createLocationSmb_user
- The user who can mount the share, has the permissions to access files
and folders in the SMB share.
For information about choosing a user name that ensures sufficient permissions to files, folders, and metadata, see the User setting for SMB locations.
CreateLocationSmb
, createLocationSmb_password
- The password of the user who can mount the share, has the permissions to
access files and folders in the SMB share.
CreateLocationSmb
, createLocationSmb_agentArns
- The Amazon Resource Names (ARNs) of agents to use for a Simple Message
Block (SMB) location.
data CreateLocationSmbResponse Source #
CreateLocationSmbResponse
See: newCreateLocationSmbResponse
smart constructor.
Instances
newCreateLocationSmbResponse Source #
Create a value of CreateLocationSmbResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateLocationSmbResponse
, createLocationSmbResponse_locationArn
- The Amazon Resource Name (ARN) of the source SMB file system location
that is created.
$sel:httpStatus:CreateLocationSmbResponse'
, createLocationSmbResponse_httpStatus
- The response's http status code.
CreateTask
data CreateTask Source #
CreateTaskRequest
See: newCreateTask
smart constructor.
CreateTask' (Maybe Text) (Maybe [FilterRule]) (Maybe [FilterRule]) (Maybe Text) (Maybe Options) (Maybe TaskSchedule) (Maybe [TagListEntry]) Text Text |
Instances
:: Text | |
-> Text | |
-> CreateTask |
Create a value of CreateTask
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:cloudWatchLogGroupArn:CreateTask'
, createTask_cloudWatchLogGroupArn
- The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that
is used to monitor and log events in the task.
$sel:excludes:CreateTask'
, createTask_excludes
- Specifies a list of filter rules that exclude specific data during your
transfer. For more information and examples, see
Filtering data transferred by DataSync.
$sel:includes:CreateTask'
, createTask_includes
- Specifies a list of filter rules that include specific data during your
transfer. For more information and examples, see
Filtering data transferred by DataSync.
CreateTask
, createTask_name
- The name of a task. This value is a text reference that is used to
identify the task in the console.
$sel:options:CreateTask'
, createTask_options
- Specifies the configuration options for a task. Some options include
preserving file or object metadata and verifying data integrity.
You can also override these options before starting an individual run of a task (also known as a task execution). For more information, see StartTaskExecution.
$sel:schedule:CreateTask'
, createTask_schedule
- Specifies a schedule used to periodically transfer files from a source
to a destination location. The schedule should be specified in UTC time.
For more information, see
Scheduling your task.
$sel:tags:CreateTask'
, createTask_tags
- Specifies the tags that you want to apply to the Amazon Resource Name
(ARN) representing the task.
Tags are key-value pairs that help you manage, filter, and search for your DataSync resources.
$sel:sourceLocationArn:CreateTask'
, createTask_sourceLocationArn
- The Amazon Resource Name (ARN) of the source location for the task.
$sel:destinationLocationArn:CreateTask'
, createTask_destinationLocationArn
- The Amazon Resource Name (ARN) of an Amazon Web Services storage
resource's location.
data CreateTaskResponse Source #
CreateTaskResponse
See: newCreateTaskResponse
smart constructor.
Instances
newCreateTaskResponse Source #
Create a value of CreateTaskResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateTaskResponse
, createTaskResponse_taskArn
- The Amazon Resource Name (ARN) of the task.
$sel:httpStatus:CreateTaskResponse'
, createTaskResponse_httpStatus
- The response's http status code.
DeleteAgent
data DeleteAgent Source #
DeleteAgentRequest
See: newDeleteAgent
smart constructor.
Instances
Create a value of DeleteAgent
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteAgent
, deleteAgent_agentArn
- The Amazon Resource Name (ARN) of the agent to delete. Use the
ListAgents
operation to return a list of agents for your account and
Amazon Web Services Region.
data DeleteAgentResponse Source #
See: newDeleteAgentResponse
smart constructor.
Instances
newDeleteAgentResponse Source #
Create a value of DeleteAgentResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteAgentResponse'
, deleteAgentResponse_httpStatus
- The response's http status code.
DeleteLocation
data DeleteLocation Source #
DeleteLocation
See: newDeleteLocation
smart constructor.
Instances
Create a value of DeleteLocation
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteLocation
, deleteLocation_locationArn
- The Amazon Resource Name (ARN) of the location to delete.
data DeleteLocationResponse Source #
See: newDeleteLocationResponse
smart constructor.
Instances
newDeleteLocationResponse Source #
Create a value of DeleteLocationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteLocationResponse'
, deleteLocationResponse_httpStatus
- The response's http status code.
DeleteTask
data DeleteTask Source #
DeleteTask
See: newDeleteTask
smart constructor.
Instances
:: Text | |
-> DeleteTask |
Create a value of DeleteTask
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteTask
, deleteTask_taskArn
- Specifies the Amazon Resource Name (ARN) of the task that you want to
delete.
data DeleteTaskResponse Source #
See: newDeleteTaskResponse
smart constructor.
Instances
newDeleteTaskResponse Source #
Create a value of DeleteTaskResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteTaskResponse'
, deleteTaskResponse_httpStatus
- The response's http status code.
DescribeAgent
data DescribeAgent Source #
DescribeAgent
See: newDescribeAgent
smart constructor.
Instances
Create a value of DescribeAgent
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeAgent
, describeAgent_agentArn
- The Amazon Resource Name (ARN) of the agent to describe.
data DescribeAgentResponse Source #
DescribeAgentResponse
See: newDescribeAgentResponse
smart constructor.
DescribeAgentResponse' (Maybe Text) (Maybe POSIX) (Maybe EndpointType) (Maybe POSIX) (Maybe Text) (Maybe PrivateLinkConfig) (Maybe AgentStatus) Int |
Instances
newDescribeAgentResponse Source #
Create a value of DescribeAgentResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeAgent
, describeAgentResponse_agentArn
- The Amazon Resource Name (ARN) of the agent.
$sel:creationTime:DescribeAgentResponse'
, describeAgentResponse_creationTime
- The time that the agent was activated (that is, created in your
account).
$sel:endpointType:DescribeAgentResponse'
, describeAgentResponse_endpointType
- The type of endpoint that your agent is connected to. If the endpoint is
a VPC endpoint, the agent is not accessible over the public internet.
$sel:lastConnectionTime:DescribeAgentResponse'
, describeAgentResponse_lastConnectionTime
- The time that the agent last connected to DataSync.
DescribeAgentResponse
, describeAgentResponse_name
- The name of the agent.
$sel:privateLinkConfig:DescribeAgentResponse'
, describeAgentResponse_privateLinkConfig
- The subnet and the security group that DataSync used to access a VPC
endpoint.
DescribeAgentResponse
, describeAgentResponse_status
- The status of the agent. If the status is ONLINE, then the agent is
configured properly and is available to use. The Running status is the
normal running status for an agent. If the status is OFFLINE, the
agent's VM is turned off or the agent is in an unhealthy state. When
the issue that caused the unhealthy state is resolved, the agent returns
to ONLINE status.
$sel:httpStatus:DescribeAgentResponse'
, describeAgentResponse_httpStatus
- The response's http status code.
DescribeLocationEfs
data DescribeLocationEfs Source #
DescribeLocationEfsRequest
See: newDescribeLocationEfs
smart constructor.
Instances
newDescribeLocationEfs Source #
Create a value of DescribeLocationEfs
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeLocationEfs
, describeLocationEfs_locationArn
- The Amazon Resource Name (ARN) of the Amazon EFS file system location
that you want information about.
data DescribeLocationEfsResponse Source #
DescribeLocationEfsResponse
See: newDescribeLocationEfsResponse
smart constructor.
DescribeLocationEfsResponse' (Maybe Text) (Maybe POSIX) (Maybe Ec2Config) (Maybe Text) (Maybe EfsInTransitEncryption) (Maybe Text) (Maybe Text) Int |
Instances
newDescribeLocationEfsResponse Source #
Create a value of DescribeLocationEfsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accessPointArn:DescribeLocationEfsResponse'
, describeLocationEfsResponse_accessPointArn
- The ARN of the access point that DataSync uses to access the Amazon EFS
file system.
$sel:creationTime:DescribeLocationEfsResponse'
, describeLocationEfsResponse_creationTime
- The time that the location was created.
$sel:ec2Config:DescribeLocationEfsResponse'
, describeLocationEfsResponse_ec2Config
- Undocumented member.
$sel:fileSystemAccessRoleArn:DescribeLocationEfsResponse'
, describeLocationEfsResponse_fileSystemAccessRoleArn
- The Identity and Access Management (IAM) role that DataSync assumes when
mounting the Amazon EFS file system.
$sel:inTransitEncryption:DescribeLocationEfsResponse'
, describeLocationEfsResponse_inTransitEncryption
- Describes whether DataSync uses Transport Layer Security (TLS)
encryption when copying data to or from the Amazon EFS file system.
DescribeLocationEfs
, describeLocationEfsResponse_locationArn
- The ARN of the Amazon EFS file system location.
DescribeLocationEfsResponse
, describeLocationEfsResponse_locationUri
- The URL of the Amazon EFS file system location.
$sel:httpStatus:DescribeLocationEfsResponse'
, describeLocationEfsResponse_httpStatus
- The response's http status code.
DescribeLocationFsxLustre
data DescribeLocationFsxLustre Source #
See: newDescribeLocationFsxLustre
smart constructor.
Instances
newDescribeLocationFsxLustre Source #
Create a value of DescribeLocationFsxLustre
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeLocationFsxLustre
, describeLocationFsxLustre_locationArn
- The Amazon Resource Name (ARN) of the FSx for Lustre location to
describe.
data DescribeLocationFsxLustreResponse Source #
See: newDescribeLocationFsxLustreResponse
smart constructor.
DescribeLocationFsxLustreResponse' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe (NonEmpty Text)) Int |
Instances
newDescribeLocationFsxLustreResponse Source #
Create a value of DescribeLocationFsxLustreResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:creationTime:DescribeLocationFsxLustreResponse'
, describeLocationFsxLustreResponse_creationTime
- The time that the FSx for Lustre location was created.
DescribeLocationFsxLustre
, describeLocationFsxLustreResponse_locationArn
- The Amazon Resource Name (ARN) of the FSx for Lustre location that was
described.
DescribeLocationFsxLustreResponse
, describeLocationFsxLustreResponse_locationUri
- The URI of the FSx for Lustre location that was described.
DescribeLocationFsxLustreResponse
, describeLocationFsxLustreResponse_securityGroupArns
- The Amazon Resource Names (ARNs) of the security groups that are
configured for the FSx for Lustre file system.
$sel:httpStatus:DescribeLocationFsxLustreResponse'
, describeLocationFsxLustreResponse_httpStatus
- The response's http status code.
DescribeLocationFsxOntap
data DescribeLocationFsxOntap Source #
See: newDescribeLocationFsxOntap
smart constructor.
Instances
newDescribeLocationFsxOntap Source #
Create a value of DescribeLocationFsxOntap
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeLocationFsxOntap
, describeLocationFsxOntap_locationArn
- Specifies the Amazon Resource Name (ARN) of the FSx for ONTAP file
system location that you want information about.
data DescribeLocationFsxOntapResponse Source #
See: newDescribeLocationFsxOntapResponse
smart constructor.
DescribeLocationFsxOntapResponse' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe FsxProtocol) (Maybe (NonEmpty Text)) (Maybe Text) Int |
Instances
newDescribeLocationFsxOntapResponse Source #
Create a value of DescribeLocationFsxOntapResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:creationTime:DescribeLocationFsxOntapResponse'
, describeLocationFsxOntapResponse_creationTime
- The time that the location was created.
$sel:fsxFilesystemArn:DescribeLocationFsxOntapResponse'
, describeLocationFsxOntapResponse_fsxFilesystemArn
- The ARN of the FSx for ONTAP file system.
DescribeLocationFsxOntap
, describeLocationFsxOntapResponse_locationArn
- The ARN of the FSx for ONTAP file system location.
DescribeLocationFsxOntapResponse
, describeLocationFsxOntapResponse_locationUri
- The uniform resource identifier (URI) of the FSx for ONTAP file system
location.
$sel:protocol:DescribeLocationFsxOntapResponse'
, describeLocationFsxOntapResponse_protocol
- Undocumented member.
DescribeLocationFsxOntapResponse
, describeLocationFsxOntapResponse_securityGroupArns
- The security groups that DataSync uses to access your FSx for ONTAP file
system.
$sel:storageVirtualMachineArn:DescribeLocationFsxOntapResponse'
, describeLocationFsxOntapResponse_storageVirtualMachineArn
- The ARN of the storage virtual machine (SVM) on your FSx for ONTAP file
system where you're copying data to or from.
$sel:httpStatus:DescribeLocationFsxOntapResponse'
, describeLocationFsxOntapResponse_httpStatus
- The response's http status code.
DescribeLocationFsxOpenZfs
data DescribeLocationFsxOpenZfs Source #
See: newDescribeLocationFsxOpenZfs
smart constructor.
Instances
newDescribeLocationFsxOpenZfs Source #
Create a value of DescribeLocationFsxOpenZfs
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeLocationFsxOpenZfs
, describeLocationFsxOpenZfs_locationArn
- The Amazon Resource Name (ARN) of the FSx for OpenZFS location to
describe.
data DescribeLocationFsxOpenZfsResponse Source #
See: newDescribeLocationFsxOpenZfsResponse
smart constructor.
DescribeLocationFsxOpenZfsResponse' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe FsxProtocol) (Maybe (NonEmpty Text)) Int |
Instances
newDescribeLocationFsxOpenZfsResponse Source #
Create a value of DescribeLocationFsxOpenZfsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:creationTime:DescribeLocationFsxOpenZfsResponse'
, describeLocationFsxOpenZfsResponse_creationTime
- The time that the FSx for OpenZFS location was created.
DescribeLocationFsxOpenZfs
, describeLocationFsxOpenZfsResponse_locationArn
- The ARN of the FSx for OpenZFS location that was described.
DescribeLocationFsxOpenZfsResponse
, describeLocationFsxOpenZfsResponse_locationUri
- The uniform resource identifier (URI) of the FSx for OpenZFS location
that was described.
Example:
fsxz://us-west-2.fs-1234567890abcdef02/fsx/folderA/folder
$sel:protocol:DescribeLocationFsxOpenZfsResponse'
, describeLocationFsxOpenZfsResponse_protocol
- The type of protocol that DataSync uses to access your file system.
DescribeLocationFsxOpenZfsResponse
, describeLocationFsxOpenZfsResponse_securityGroupArns
- The ARNs of the security groups that are configured for the FSx for
OpenZFS file system.
$sel:httpStatus:DescribeLocationFsxOpenZfsResponse'
, describeLocationFsxOpenZfsResponse_httpStatus
- The response's http status code.
DescribeLocationFsxWindows
data DescribeLocationFsxWindows Source #
See: newDescribeLocationFsxWindows
smart constructor.
Instances
newDescribeLocationFsxWindows Source #
Create a value of DescribeLocationFsxWindows
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeLocationFsxWindows
, describeLocationFsxWindows_locationArn
- The Amazon Resource Name (ARN) of the FSx for Windows File Server
location to describe.
data DescribeLocationFsxWindowsResponse Source #
See: newDescribeLocationFsxWindowsResponse
smart constructor.
DescribeLocationFsxWindowsResponse' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (NonEmpty Text)) (Maybe Text) Int |
Instances
newDescribeLocationFsxWindowsResponse Source #
Create a value of DescribeLocationFsxWindowsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:creationTime:DescribeLocationFsxWindowsResponse'
, describeLocationFsxWindowsResponse_creationTime
- The time that the FSx for Windows File Server location was created.
DescribeLocationFsxWindowsResponse
, describeLocationFsxWindowsResponse_domain
- The name of the Windows domain that the FSx for Windows File Server
belongs to.
DescribeLocationFsxWindows
, describeLocationFsxWindowsResponse_locationArn
- The Amazon Resource Name (ARN) of the FSx for Windows File Server
location that was described.
DescribeLocationFsxWindowsResponse
, describeLocationFsxWindowsResponse_locationUri
- The URL of the FSx for Windows File Server location that was described.
DescribeLocationFsxWindowsResponse
, describeLocationFsxWindowsResponse_securityGroupArns
- The Amazon Resource Names (ARNs) of the security groups that are
configured for the FSx for Windows File Server file system.
DescribeLocationFsxWindowsResponse
, describeLocationFsxWindowsResponse_user
- The user who has the permissions to access files and folders in the FSx
for Windows File Server file system.
$sel:httpStatus:DescribeLocationFsxWindowsResponse'
, describeLocationFsxWindowsResponse_httpStatus
- The response's http status code.
DescribeLocationHdfs
data DescribeLocationHdfs Source #
See: newDescribeLocationHdfs
smart constructor.
Instances
newDescribeLocationHdfs Source #
Create a value of DescribeLocationHdfs
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeLocationHdfs
, describeLocationHdfs_locationArn
- The Amazon Resource Name (ARN) of the HDFS cluster location to describe.
data DescribeLocationHdfsResponse Source #
See: newDescribeLocationHdfsResponse
smart constructor.
DescribeLocationHdfsResponse' (Maybe (NonEmpty Text)) (Maybe HdfsAuthenticationType) (Maybe Natural) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (NonEmpty HdfsNameNode)) (Maybe QopConfiguration) (Maybe Natural) (Maybe Text) Int |
Instances
newDescribeLocationHdfsResponse Source #
Create a value of DescribeLocationHdfsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeLocationHdfsResponse
, describeLocationHdfsResponse_agentArns
- The ARNs of the agents that are used to connect to the HDFS cluster.
$sel:authenticationType:DescribeLocationHdfsResponse'
, describeLocationHdfsResponse_authenticationType
- The type of authentication used to determine the identity of the user.
$sel:blockSize:DescribeLocationHdfsResponse'
, describeLocationHdfsResponse_blockSize
- The size of the data blocks to write into the HDFS cluster.
$sel:creationTime:DescribeLocationHdfsResponse'
, describeLocationHdfsResponse_creationTime
- The time that the HDFS location was created.
$sel:kerberosPrincipal:DescribeLocationHdfsResponse'
, describeLocationHdfsResponse_kerberosPrincipal
- The Kerberos principal with access to the files and folders on the HDFS
cluster. This parameter is used if the AuthenticationType
is defined
as KERBEROS
.
$sel:kmsKeyProviderUri:DescribeLocationHdfsResponse'
, describeLocationHdfsResponse_kmsKeyProviderUri
- The URI of the HDFS cluster's Key Management Server (KMS).
DescribeLocationHdfs
, describeLocationHdfsResponse_locationArn
- The ARN of the HDFS cluster location.
DescribeLocationHdfsResponse
, describeLocationHdfsResponse_locationUri
- The URI of the HDFS cluster location.
$sel:nameNodes:DescribeLocationHdfsResponse'
, describeLocationHdfsResponse_nameNodes
- The NameNode that manage the HDFS namespace.
$sel:qopConfiguration:DescribeLocationHdfsResponse'
, describeLocationHdfsResponse_qopConfiguration
- The Quality of Protection (QOP) configuration specifies the Remote
Procedure Call (RPC) and data transfer protection settings configured on
the Hadoop Distributed File System (HDFS) cluster.
$sel:replicationFactor:DescribeLocationHdfsResponse'
, describeLocationHdfsResponse_replicationFactor
- The number of DataNodes to replicate the data to when writing to the
HDFS cluster.
$sel:simpleUser:DescribeLocationHdfsResponse'
, describeLocationHdfsResponse_simpleUser
- The user name used to identify the client on the host operating system.
This parameter is used if the AuthenticationType
is defined as
SIMPLE
.
$sel:httpStatus:DescribeLocationHdfsResponse'
, describeLocationHdfsResponse_httpStatus
- The response's http status code.
DescribeLocationNfs
data DescribeLocationNfs Source #
DescribeLocationNfsRequest
See: newDescribeLocationNfs
smart constructor.
Instances
newDescribeLocationNfs Source #
Create a value of DescribeLocationNfs
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeLocationNfs
, describeLocationNfs_locationArn
- The Amazon Resource Name (ARN) of the NFS location to describe.
data DescribeLocationNfsResponse Source #
DescribeLocationNfsResponse
See: newDescribeLocationNfsResponse
smart constructor.
DescribeLocationNfsResponse' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe NfsMountOptions) (Maybe OnPremConfig) Int |
Instances
newDescribeLocationNfsResponse Source #
Create a value of DescribeLocationNfsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:creationTime:DescribeLocationNfsResponse'
, describeLocationNfsResponse_creationTime
- The time that the NFS location was created.
DescribeLocationNfs
, describeLocationNfsResponse_locationArn
- The Amazon Resource Name (ARN) of the NFS location that was described.
DescribeLocationNfsResponse
, describeLocationNfsResponse_locationUri
- The URL of the source NFS location that was described.
DescribeLocationNfsResponse
, describeLocationNfsResponse_mountOptions
- The NFS mount options that DataSync used to mount your NFS share.
$sel:onPremConfig:DescribeLocationNfsResponse'
, describeLocationNfsResponse_onPremConfig
- Undocumented member.
$sel:httpStatus:DescribeLocationNfsResponse'
, describeLocationNfsResponse_httpStatus
- The response's http status code.
DescribeLocationObjectStorage
data DescribeLocationObjectStorage Source #
DescribeLocationObjectStorageRequest
See: newDescribeLocationObjectStorage
smart constructor.
Instances
newDescribeLocationObjectStorage Source #
Create a value of DescribeLocationObjectStorage
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeLocationObjectStorage
, describeLocationObjectStorage_locationArn
- The Amazon Resource Name (ARN) of the object storage system location
that you want information about.
data DescribeLocationObjectStorageResponse Source #
DescribeLocationObjectStorageResponse
See: newDescribeLocationObjectStorageResponse
smart constructor.
DescribeLocationObjectStorageResponse' (Maybe Text) (Maybe (NonEmpty Text)) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Base64) (Maybe Natural) (Maybe ObjectStorageServerProtocol) Int |
Instances
newDescribeLocationObjectStorageResponse Source #
Create a value of DescribeLocationObjectStorageResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accessKey:DescribeLocationObjectStorageResponse'
, describeLocationObjectStorageResponse_accessKey
- The access key (for example, a user name) required to authenticate with
the object storage system.
DescribeLocationObjectStorageResponse
, describeLocationObjectStorageResponse_agentArns
- The ARNs of the DataSync agents that can securely connect with your
location.
$sel:creationTime:DescribeLocationObjectStorageResponse'
, describeLocationObjectStorageResponse_creationTime
- The time that the location was created.
DescribeLocationObjectStorage
, describeLocationObjectStorageResponse_locationArn
- The ARN of the object storage system location.
DescribeLocationObjectStorageResponse
, describeLocationObjectStorageResponse_locationUri
- The URL of the object storage system location.
$sel:serverCertificate:DescribeLocationObjectStorageResponse'
, describeLocationObjectStorageResponse_serverCertificate
- The self-signed certificate that DataSync uses to securely authenticate
with your object storage system.--
-- Note: This Lens
automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens
accepts and returns only raw unencoded data.
$sel:serverPort:DescribeLocationObjectStorageResponse'
, describeLocationObjectStorageResponse_serverPort
- The port that your object storage server accepts inbound network traffic
on (for example, port 443).
$sel:serverProtocol:DescribeLocationObjectStorageResponse'
, describeLocationObjectStorageResponse_serverProtocol
- The protocol that your object storage system uses to communicate.
$sel:httpStatus:DescribeLocationObjectStorageResponse'
, describeLocationObjectStorageResponse_httpStatus
- The response's http status code.
DescribeLocationS3
data DescribeLocationS3 Source #
DescribeLocationS3Request
See: newDescribeLocationS3
smart constructor.
Instances
newDescribeLocationS3 Source #
Create a value of DescribeLocationS3
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeLocationS3
, describeLocationS3_locationArn
- The Amazon Resource Name (ARN) of the Amazon S3 bucket location to
describe.
data DescribeLocationS3Response Source #
DescribeLocationS3Response
See: newDescribeLocationS3Response
smart constructor.
DescribeLocationS3Response' (Maybe (NonEmpty Text)) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe S3Config) (Maybe S3StorageClass) Int |
Instances
newDescribeLocationS3Response Source #
Create a value of DescribeLocationS3Response
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeLocationS3Response
, describeLocationS3Response_agentArns
- If you are using DataSync on an Amazon Web Services Outpost, the Amazon
Resource Name (ARNs) of the EC2 agents deployed on your Outpost. For
more information about launching a DataSync agent on an Amazon Web
Services Outpost, see
Deploy your DataSync agent on Outposts.
$sel:creationTime:DescribeLocationS3Response'
, describeLocationS3Response_creationTime
- The time that the Amazon S3 bucket location was created.
DescribeLocationS3
, describeLocationS3Response_locationArn
- The Amazon Resource Name (ARN) of the Amazon S3 bucket or access point.
DescribeLocationS3Response
, describeLocationS3Response_locationUri
- The URL of the Amazon S3 location that was described.
$sel:s3Config:DescribeLocationS3Response'
, describeLocationS3Response_s3Config
- Undocumented member.
$sel:s3StorageClass:DescribeLocationS3Response'
, describeLocationS3Response_s3StorageClass
- The Amazon S3 storage class that you chose to store your files in when
this location is used as a task destination. For more information about
S3 storage classes, see
Amazon S3 Storage Classes.
Some storage classes have behaviors that can affect your S3 storage
cost. For detailed information, see
Considerations when working with S3 storage classes in DataSync.
$sel:httpStatus:DescribeLocationS3Response'
, describeLocationS3Response_httpStatus
- The response's http status code.
DescribeLocationSmb
data DescribeLocationSmb Source #
DescribeLocationSmbRequest
See: newDescribeLocationSmb
smart constructor.
Instances
newDescribeLocationSmb Source #
Create a value of DescribeLocationSmb
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeLocationSmb
, describeLocationSmb_locationArn
- The Amazon Resource Name (ARN) of the SMB location to describe.
data DescribeLocationSmbResponse Source #
DescribeLocationSmbResponse
See: newDescribeLocationSmbResponse
smart constructor.
DescribeLocationSmbResponse' (Maybe (NonEmpty Text)) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe SmbMountOptions) (Maybe Text) Int |
Instances
newDescribeLocationSmbResponse Source #
Create a value of DescribeLocationSmbResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeLocationSmbResponse
, describeLocationSmbResponse_agentArns
- The Amazon Resource Name (ARN) of the source SMB file system location
that is created.
$sel:creationTime:DescribeLocationSmbResponse'
, describeLocationSmbResponse_creationTime
- The time that the SMB location was created.
DescribeLocationSmbResponse
, describeLocationSmbResponse_domain
- The name of the Windows domain that the SMB server belongs to.
DescribeLocationSmb
, describeLocationSmbResponse_locationArn
- The Amazon Resource Name (ARN) of the SMB location that was described.
DescribeLocationSmbResponse
, describeLocationSmbResponse_locationUri
- The URL of the source SMB location that was described.
DescribeLocationSmbResponse
, describeLocationSmbResponse_mountOptions
- The mount options that are available for DataSync to use to access an
SMB location.
DescribeLocationSmbResponse
, describeLocationSmbResponse_user
- The user who can mount the share, has the permissions to access files
and folders in the SMB share.
$sel:httpStatus:DescribeLocationSmbResponse'
, describeLocationSmbResponse_httpStatus
- The response's http status code.
DescribeTask
data DescribeTask Source #
DescribeTaskRequest
See: newDescribeTask
smart constructor.
Instances
Create a value of DescribeTask
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeTask
, describeTask_taskArn
- The Amazon Resource Name (ARN) of the task to describe.
data DescribeTaskResponse Source #
DescribeTaskResponse
See: newDescribeTaskResponse
smart constructor.
DescribeTaskResponse' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe [FilterRule]) (Maybe [FilterRule]) (Maybe Text) (Maybe Options) (Maybe TaskSchedule) (Maybe Text) (Maybe [Text]) (Maybe TaskStatus) (Maybe Text) Int |
Instances
newDescribeTaskResponse Source #
Create a value of DescribeTaskResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:cloudWatchLogGroupArn:DescribeTaskResponse'
, describeTaskResponse_cloudWatchLogGroupArn
- The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that
was used to monitor and log events in the task.
For more information on these groups, see Working with Log Groups and Log Streams in the Amazon CloudWatch User Guide.
$sel:creationTime:DescribeTaskResponse'
, describeTaskResponse_creationTime
- The time that the task was created.
$sel:currentTaskExecutionArn:DescribeTaskResponse'
, describeTaskResponse_currentTaskExecutionArn
- The Amazon Resource Name (ARN) of the task execution that is
transferring files.
$sel:destinationLocationArn:DescribeTaskResponse'
, describeTaskResponse_destinationLocationArn
- The Amazon Resource Name (ARN) of the Amazon Web Services storage
resource's location.
$sel:destinationNetworkInterfaceArns:DescribeTaskResponse'
, describeTaskResponse_destinationNetworkInterfaceArns
- The Amazon Resource Names (ARNs) of the network interfaces created for
your destination location. For more information, see
Network interface requirements.
DescribeTaskResponse
, describeTaskResponse_errorCode
- Errors that DataSync encountered during execution of the task. You can
use this error code to help troubleshoot issues.
DescribeTaskResponse
, describeTaskResponse_errorDetail
- Detailed description of an error that was encountered during the task
execution. You can use this information to help troubleshoot issues.
$sel:excludes:DescribeTaskResponse'
, describeTaskResponse_excludes
- A list of filter rules that exclude specific data during your transfer.
For more information and examples, see
Filtering data transferred by DataSync.
$sel:includes:DescribeTaskResponse'
, describeTaskResponse_includes
- A list of filter rules that include specific data during your transfer.
For more information and examples, see
Filtering data transferred by DataSync.
DescribeTaskResponse
, describeTaskResponse_name
- The name of the task that was described.
$sel:options:DescribeTaskResponse'
, describeTaskResponse_options
- The configuration options that control the behavior of the
StartTaskExecution
operation. Some options include preserving file or
object metadata and verifying data integrity.
You can override these options for each task execution. For more information, see StartTaskExecution.
$sel:schedule:DescribeTaskResponse'
, describeTaskResponse_schedule
- The schedule used to periodically transfer files from a source to a
destination location.
$sel:sourceLocationArn:DescribeTaskResponse'
, describeTaskResponse_sourceLocationArn
- The Amazon Resource Name (ARN) of the source file system's location.
$sel:sourceNetworkInterfaceArns:DescribeTaskResponse'
, describeTaskResponse_sourceNetworkInterfaceArns
- The Amazon Resource Names (ARNs) of the network interfaces created for
your source location. For more information, see
Network interface requirements.
DescribeTaskResponse
, describeTaskResponse_status
- The status of the task that was described.
For detailed information about task execution statuses, see Understanding Task Statuses in the DataSync User Guide.
DescribeTask
, describeTaskResponse_taskArn
- The Amazon Resource Name (ARN) of the task that was described.
$sel:httpStatus:DescribeTaskResponse'
, describeTaskResponse_httpStatus
- The response's http status code.
DescribeTaskExecution
data DescribeTaskExecution Source #
DescribeTaskExecutionRequest
See: newDescribeTaskExecution
smart constructor.
Instances
newDescribeTaskExecution Source #
Create a value of DescribeTaskExecution
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeTaskExecution
, describeTaskExecution_taskExecutionArn
- The Amazon Resource Name (ARN) of the task that is being executed.
data DescribeTaskExecutionResponse Source #
DescribeTaskExecutionResponse
See: newDescribeTaskExecutionResponse
smart constructor.
DescribeTaskExecutionResponse' (Maybe Integer) (Maybe Integer) (Maybe Integer) (Maybe Integer) (Maybe Integer) (Maybe [FilterRule]) (Maybe Integer) (Maybe [FilterRule]) (Maybe Options) (Maybe TaskExecutionResultDetail) (Maybe POSIX) (Maybe TaskExecutionStatus) (Maybe Text) Int |
Instances
newDescribeTaskExecutionResponse Source #
Create a value of DescribeTaskExecutionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:bytesCompressed:DescribeTaskExecutionResponse'
, describeTaskExecutionResponse_bytesCompressed
- The physical number of bytes transferred over the network after
compression was applied. In most cases, this number is less than
BytesTransferred
unless the data isn't compressible.
$sel:bytesTransferred:DescribeTaskExecutionResponse'
, describeTaskExecutionResponse_bytesTransferred
- The total number of bytes that are involved in the transfer. For the
number of bytes sent over the network, see BytesCompressed
.
$sel:bytesWritten:DescribeTaskExecutionResponse'
, describeTaskExecutionResponse_bytesWritten
- The number of logical bytes written to the destination Amazon Web
Services storage resource.
$sel:estimatedBytesToTransfer:DescribeTaskExecutionResponse'
, describeTaskExecutionResponse_estimatedBytesToTransfer
- The estimated physical number of bytes that is to be transferred over
the network.
$sel:estimatedFilesToTransfer:DescribeTaskExecutionResponse'
, describeTaskExecutionResponse_estimatedFilesToTransfer
- The expected number of files that is to be transferred over the network.
This value is calculated during the PREPARING
phase before the
TRANSFERRING
phase of the task execution. This value is the expected
number of files to be transferred. It's calculated based on comparing
the content of the source and destination locations and finding the
delta that needs to be transferred.
$sel:excludes:DescribeTaskExecutionResponse'
, describeTaskExecutionResponse_excludes
- A list of filter rules that exclude specific data during your transfer.
For more information and examples, see
Filtering data transferred by DataSync.
$sel:filesTransferred:DescribeTaskExecutionResponse'
, describeTaskExecutionResponse_filesTransferred
- The actual number of files that was transferred over the network. This
value is calculated and updated on an ongoing basis during the
TRANSFERRING
phase of the task execution. It's updated periodically
when each file is read from the source and sent over the network.
If failures occur during a transfer, this value can be less than
EstimatedFilesToTransfer
. In some cases, this value can also be
greater than EstimatedFilesToTransfer
. This element is
implementation-specific for some location types, so don't use it as an
indicator for a correct file number or to monitor your task execution.
$sel:includes:DescribeTaskExecutionResponse'
, describeTaskExecutionResponse_includes
- A list of filter rules that include specific data during your transfer.
For more information and examples, see
Filtering data transferred by DataSync.
$sel:options:DescribeTaskExecutionResponse'
, describeTaskExecutionResponse_options
- Undocumented member.
$sel:result:DescribeTaskExecutionResponse'
, describeTaskExecutionResponse_result
- The result of the task execution.
$sel:startTime:DescribeTaskExecutionResponse'
, describeTaskExecutionResponse_startTime
- The time that the task execution was started.
DescribeTaskExecutionResponse
, describeTaskExecutionResponse_status
- The status of the task execution.
For detailed information about task execution statuses, see Understanding Task Statuses in the DataSync User Guide.
DescribeTaskExecution
, describeTaskExecutionResponse_taskExecutionArn
- The Amazon Resource Name (ARN) of the task execution that was described.
TaskExecutionArn
is hierarchical and includes TaskArn
for the task
that was executed.
For example, a TaskExecution
value with the ARN
arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2/execution/exec-08ef1e88ec491019b
executed the task with the ARN
arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2
.
$sel:httpStatus:DescribeTaskExecutionResponse'
, describeTaskExecutionResponse_httpStatus
- The response's http status code.
ListAgents (Paginated)
data ListAgents Source #
ListAgentsRequest
See: newListAgents
smart constructor.
ListAgents' (Maybe Natural) (Maybe Text) |
Instances
newListAgents :: ListAgents Source #
Create a value of ListAgents
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListAgents'
, listAgents_maxResults
- The maximum number of agents to list.
ListAgents
, listAgents_nextToken
- An opaque string that indicates the position at which to begin the next
list of agents.
data ListAgentsResponse Source #
ListAgentsResponse
See: newListAgentsResponse
smart constructor.
Instances
newListAgentsResponse Source #
Create a value of ListAgentsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:agents:ListAgentsResponse'
, listAgentsResponse_agents
- A list of agents in your account.
ListAgents
, listAgentsResponse_nextToken
- An opaque string that indicates the position at which to begin returning
the next list of agents.
$sel:httpStatus:ListAgentsResponse'
, listAgentsResponse_httpStatus
- The response's http status code.
ListLocations (Paginated)
data ListLocations Source #
ListLocationsRequest
See: newListLocations
smart constructor.
ListLocations' (Maybe [LocationFilter]) (Maybe Natural) (Maybe Text) |
Instances
newListLocations :: ListLocations Source #
Create a value of ListLocations
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:ListLocations'
, listLocations_filters
- You can use API filters to narrow down the list of resources returned by
ListLocations
. For example, to retrieve all tasks on a specific source
location, you can use ListLocations
with filter name LocationType S3
and Operator Equals
.
$sel:maxResults:ListLocations'
, listLocations_maxResults
- The maximum number of locations to return.
ListLocations
, listLocations_nextToken
- An opaque string that indicates the position at which to begin the next
list of locations.
data ListLocationsResponse Source #
ListLocationsResponse
See: newListLocationsResponse
smart constructor.
Instances
newListLocationsResponse Source #
Create a value of ListLocationsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:locations:ListLocationsResponse'
, listLocationsResponse_locations
- An array that contains a list of locations.
ListLocations
, listLocationsResponse_nextToken
- An opaque string that indicates the position at which to begin returning
the next list of locations.
$sel:httpStatus:ListLocationsResponse'
, listLocationsResponse_httpStatus
- The response's http status code.
ListTagsForResource (Paginated)
data ListTagsForResource Source #
ListTagsForResourceRequest
See: newListTagsForResource
smart constructor.
Instances
newListTagsForResource Source #
Create a value of ListTagsForResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListTagsForResource'
, listTagsForResource_maxResults
- Specifies how many results that you want in the response.
ListTagsForResource
, listTagsForResource_nextToken
- Specifies an opaque string that indicates the position to begin the next
list of results in the response.
$sel:resourceArn:ListTagsForResource'
, listTagsForResource_resourceArn
- Specifies the Amazon Resource Name (ARN) of the resource that you want
tag information on.
data ListTagsForResourceResponse Source #
ListTagsForResourceResponse
See: newListTagsForResourceResponse
smart constructor.
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListTagsForResource
, listTagsForResourceResponse_nextToken
- The opaque string that indicates the position to begin the next list of
results in the response.
$sel:tags:ListTagsForResourceResponse'
, listTagsForResourceResponse_tags
- An array of tags applied to the specified resource.
$sel:httpStatus:ListTagsForResourceResponse'
, listTagsForResourceResponse_httpStatus
- The response's http status code.
ListTaskExecutions (Paginated)
data ListTaskExecutions Source #
ListTaskExecutions
See: newListTaskExecutions
smart constructor.
Instances
newListTaskExecutions :: ListTaskExecutions Source #
Create a value of ListTaskExecutions
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListTaskExecutions'
, listTaskExecutions_maxResults
- The maximum number of executed tasks to list.
ListTaskExecutions
, listTaskExecutions_nextToken
- An opaque string that indicates the position at which to begin the next
list of the executed tasks.
ListTaskExecutions
, listTaskExecutions_taskArn
- The Amazon Resource Name (ARN) of the task whose tasks you want to list.
data ListTaskExecutionsResponse Source #
ListTaskExecutionsResponse
See: newListTaskExecutionsResponse
smart constructor.
Instances
newListTaskExecutionsResponse Source #
Create a value of ListTaskExecutionsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListTaskExecutions
, listTaskExecutionsResponse_nextToken
- An opaque string that indicates the position at which to begin returning
the next list of executed tasks.
$sel:taskExecutions:ListTaskExecutionsResponse'
, listTaskExecutionsResponse_taskExecutions
- A list of executed tasks.
$sel:httpStatus:ListTaskExecutionsResponse'
, listTaskExecutionsResponse_httpStatus
- The response's http status code.
ListTasks (Paginated)
ListTasksRequest
See: newListTasks
smart constructor.
ListTasks' (Maybe [TaskFilter]) (Maybe Natural) (Maybe Text) |
Instances
newListTasks :: ListTasks Source #
Create a value of ListTasks
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:ListTasks'
, listTasks_filters
- You can use API filters to narrow down the list of resources returned by
ListTasks
. For example, to retrieve all tasks on a specific source
location, you can use ListTasks
with filter name LocationId
and
Operator Equals
with the ARN for the location.
$sel:maxResults:ListTasks'
, listTasks_maxResults
- The maximum number of tasks to return.
ListTasks
, listTasks_nextToken
- An opaque string that indicates the position at which to begin the next
list of tasks.
data ListTasksResponse Source #
ListTasksResponse
See: newListTasksResponse
smart constructor.
Instances
Create a value of ListTasksResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListTasks
, listTasksResponse_nextToken
- An opaque string that indicates the position at which to begin returning
the next list of tasks.
$sel:tasks:ListTasksResponse'
, listTasksResponse_tasks
- A list of all the tasks that are returned.
$sel:httpStatus:ListTasksResponse'
, listTasksResponse_httpStatus
- The response's http status code.
StartTaskExecution
data StartTaskExecution Source #
StartTaskExecutionRequest
See: newStartTaskExecution
smart constructor.
StartTaskExecution' (Maybe [FilterRule]) (Maybe [FilterRule]) (Maybe Options) (Maybe [TagListEntry]) Text |
Instances
newStartTaskExecution Source #
Create a value of StartTaskExecution
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:excludes:StartTaskExecution'
, startTaskExecution_excludes
- Specifies a list of filter rules that determines which files to exclude
from a task. The list contains a single filter string that consists of
the patterns to exclude. The patterns are delimited by "|" (that is, a
pipe), for example, "/folder1|/folder2"
.
$sel:includes:StartTaskExecution'
, startTaskExecution_includes
- Specifies a list of filter rules that determines which files to include
when running a task. The pattern should contain a single filter string
that consists of the patterns to include. The patterns are delimited by
"|" (that is, a pipe), for example, "/folder1|/folder2"
.
$sel:overrideOptions:StartTaskExecution'
, startTaskExecution_overrideOptions
- Undocumented member.
$sel:tags:StartTaskExecution'
, startTaskExecution_tags
- Specifies the tags that you want to apply to the Amazon Resource Name
(ARN) representing the task execution.
Tags are key-value pairs that help you manage, filter, and search for your DataSync resources.
StartTaskExecution
, startTaskExecution_taskArn
- Specifies the Amazon Resource Name (ARN) of the task that you want to
start.
data StartTaskExecutionResponse Source #
StartTaskExecutionResponse
See: newStartTaskExecutionResponse
smart constructor.
Instances
newStartTaskExecutionResponse Source #
Create a value of StartTaskExecutionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
StartTaskExecutionResponse
, startTaskExecutionResponse_taskExecutionArn
- The ARN of the running task execution.
$sel:httpStatus:StartTaskExecutionResponse'
, startTaskExecutionResponse_httpStatus
- The response's http status code.
TagResource
data TagResource Source #
TagResourceRequest
See: newTagResource
smart constructor.
Instances
Create a value of TagResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:TagResource'
, tagResource_resourceArn
- Specifies the Amazon Resource Name (ARN) of the resource to apply the
tag to.
$sel:tags:TagResource'
, tagResource_tags
- Specifies the tags that you want to apply to the resource.
data TagResourceResponse Source #
See: newTagResourceResponse
smart constructor.
Instances
newTagResourceResponse Source #
Create a value of TagResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:TagResourceResponse'
, tagResourceResponse_httpStatus
- The response's http status code.
UntagResource
data UntagResource Source #
UntagResourceRequest
See: newUntagResource
smart constructor.
Instances
Create a value of UntagResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:UntagResource'
, untagResource_resourceArn
- Specifies the Amazon Resource Name (ARN) of the resource to remove the
tags from.
$sel:keys:UntagResource'
, untagResource_keys
- Specifies the keys in the tags that you want to remove.
data UntagResourceResponse Source #
See: newUntagResourceResponse
smart constructor.
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UntagResourceResponse'
, untagResourceResponse_httpStatus
- The response's http status code.
UpdateAgent
data UpdateAgent Source #
UpdateAgentRequest
See: newUpdateAgent
smart constructor.
Instances
Create a value of UpdateAgent
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateAgent
, updateAgent_name
- The name that you want to use to configure the agent.
UpdateAgent
, updateAgent_agentArn
- The Amazon Resource Name (ARN) of the agent to update.
data UpdateAgentResponse Source #
See: newUpdateAgentResponse
smart constructor.
Instances
newUpdateAgentResponse Source #
Create a value of UpdateAgentResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateAgentResponse'
, updateAgentResponse_httpStatus
- The response's http status code.
UpdateLocationHdfs
data UpdateLocationHdfs Source #
See: newUpdateLocationHdfs
smart constructor.
UpdateLocationHdfs' (Maybe (NonEmpty Text)) (Maybe HdfsAuthenticationType) (Maybe Natural) (Maybe Base64) (Maybe Base64) (Maybe Text) (Maybe Text) (Maybe (NonEmpty HdfsNameNode)) (Maybe QopConfiguration) (Maybe Natural) (Maybe Text) (Maybe Text) Text |
Instances
newUpdateLocationHdfs Source #
Create a value of UpdateLocationHdfs
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateLocationHdfs
, updateLocationHdfs_agentArns
- The ARNs of the agents that are used to connect to the HDFS cluster.
$sel:authenticationType:UpdateLocationHdfs'
, updateLocationHdfs_authenticationType
- The type of authentication used to determine the identity of the user.
$sel:blockSize:UpdateLocationHdfs'
, updateLocationHdfs_blockSize
- The size of the data blocks to write into the HDFS cluster.
$sel:kerberosKeytab:UpdateLocationHdfs'
, updateLocationHdfs_kerberosKeytab
- The Kerberos key table (keytab) that contains mappings between the
defined Kerberos principal and the encrypted keys. You can load the
keytab from a file by providing the file's address. If you use the CLI,
it performs base64 encoding for you. Otherwise, provide the
base64-encoded text.--
-- Note: This Lens
automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens
accepts and returns only raw unencoded data.
$sel:kerberosKrb5Conf:UpdateLocationHdfs'
, updateLocationHdfs_kerberosKrb5Conf
- The krb5.conf
file that contains the Kerberos configuration
information. You can load the krb5.conf
file by providing the file's
address. If you're using the CLI, it performs the base64 encoding for
you. Otherwise, provide the base64-encoded text.--
-- Note: This Lens
automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens
accepts and returns only raw unencoded data.
$sel:kerberosPrincipal:UpdateLocationHdfs'
, updateLocationHdfs_kerberosPrincipal
- The Kerberos principal with access to the files and folders on the HDFS
cluster.
$sel:kmsKeyProviderUri:UpdateLocationHdfs'
, updateLocationHdfs_kmsKeyProviderUri
- The URI of the HDFS cluster's Key Management Server (KMS).
$sel:nameNodes:UpdateLocationHdfs'
, updateLocationHdfs_nameNodes
- The NameNode that manages the HDFS namespace. The NameNode performs
operations such as opening, closing, and renaming files and directories.
The NameNode contains the information to map blocks of data to the
DataNodes. You can use only one NameNode.
$sel:qopConfiguration:UpdateLocationHdfs'
, updateLocationHdfs_qopConfiguration
- The Quality of Protection (QOP) configuration specifies the Remote
Procedure Call (RPC) and data transfer privacy settings configured on
the Hadoop Distributed File System (HDFS) cluster.
$sel:replicationFactor:UpdateLocationHdfs'
, updateLocationHdfs_replicationFactor
- The number of DataNodes to replicate the data to when writing to the
HDFS cluster.
$sel:simpleUser:UpdateLocationHdfs'
, updateLocationHdfs_simpleUser
- The user name used to identify the client on the host operating system.
$sel:subdirectory:UpdateLocationHdfs'
, updateLocationHdfs_subdirectory
- A subdirectory in the HDFS cluster. This subdirectory is used to read
data from or write data to the HDFS cluster.
UpdateLocationHdfs
, updateLocationHdfs_locationArn
- The Amazon Resource Name (ARN) of the source HDFS cluster location.
data UpdateLocationHdfsResponse Source #
See: newUpdateLocationHdfsResponse
smart constructor.
Instances
newUpdateLocationHdfsResponse Source #
Create a value of UpdateLocationHdfsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateLocationHdfsResponse'
, updateLocationHdfsResponse_httpStatus
- The response's http status code.
UpdateLocationNfs
data UpdateLocationNfs Source #
See: newUpdateLocationNfs
smart constructor.
Instances
Create a value of UpdateLocationNfs
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateLocationNfs
, updateLocationNfs_mountOptions
- Undocumented member.
$sel:onPremConfig:UpdateLocationNfs'
, updateLocationNfs_onPremConfig
- Undocumented member.
$sel:subdirectory:UpdateLocationNfs'
, updateLocationNfs_subdirectory
- The subdirectory in the NFS file system that is used to read data from
the NFS source location or write data to the NFS destination. The NFS
path should be a path that's exported by the NFS server, or a
subdirectory of that path. The path should be such that it can be
mounted by other NFS clients in your network.
To see all the paths exported by your NFS server, run
"showmount -e nfs-server-name
" from an NFS client that has access to
your server. You can specify any directory that appears in the results,
and any subdirectory of that directory. Ensure that the NFS export is
accessible without Kerberos authentication.
To transfer all the data in the folder that you specified, DataSync must
have permissions to read all the data. To ensure this, either configure
the NFS export with no_root_squash
, or ensure that the files you want
DataSync to access have permissions that allow read access for all
users. Doing either option enables the agent to read the files. For the
agent to access directories, you must additionally enable all execute
access.
If you are copying data to or from your Snowcone device, see NFS Server on Snowcone for more information.
For information about NFS export configuration, see 18.7. The /etc/exports Configuration File in the Red Hat Enterprise Linux documentation.
UpdateLocationNfs
, updateLocationNfs_locationArn
- The Amazon Resource Name (ARN) of the NFS location to update.
data UpdateLocationNfsResponse Source #
See: newUpdateLocationNfsResponse
smart constructor.
Instances
newUpdateLocationNfsResponse Source #
Create a value of UpdateLocationNfsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateLocationNfsResponse'
, updateLocationNfsResponse_httpStatus
- The response's http status code.
UpdateLocationObjectStorage
data UpdateLocationObjectStorage Source #
See: newUpdateLocationObjectStorage
smart constructor.
UpdateLocationObjectStorage' (Maybe Text) (Maybe (NonEmpty Text)) (Maybe (Sensitive Text)) (Maybe Base64) (Maybe Natural) (Maybe ObjectStorageServerProtocol) (Maybe Text) Text |
Instances
newUpdateLocationObjectStorage Source #
Create a value of UpdateLocationObjectStorage
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accessKey:UpdateLocationObjectStorage'
, updateLocationObjectStorage_accessKey
- Specifies the access key (for example, a user name) if credentials are
required to authenticate with the object storage server.
UpdateLocationObjectStorage
, updateLocationObjectStorage_agentArns
- Specifies the Amazon Resource Names (ARNs) of the DataSync agents that
can securely connect with your location.
$sel:secretKey:UpdateLocationObjectStorage'
, updateLocationObjectStorage_secretKey
- Specifies the secret key (for example, a password) if credentials are
required to authenticate with the object storage server.
$sel:serverCertificate:UpdateLocationObjectStorage'
, updateLocationObjectStorage_serverCertificate
- Specifies a certificate to authenticate with an object storage system
that uses a private or self-signed certificate authority (CA). You must
specify a Base64-encoded .pem
file (for example,
file:///home/user/.ssh/storage_sys_certificate.pem
). The
certificate can be up to 32768 bytes (before Base64 encoding).
To use this parameter, configure ServerProtocol
to HTTPS
.
Updating the certificate doesn't interfere with tasks that you have in
progress.--
-- Note: This Lens
automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens
accepts and returns only raw unencoded data.
$sel:serverPort:UpdateLocationObjectStorage'
, updateLocationObjectStorage_serverPort
- Specifies the port that your object storage server accepts inbound
network traffic on (for example, port 443).
$sel:serverProtocol:UpdateLocationObjectStorage'
, updateLocationObjectStorage_serverProtocol
- Specifies the protocol that your object storage server uses to
communicate.
$sel:subdirectory:UpdateLocationObjectStorage'
, updateLocationObjectStorage_subdirectory
- Specifies the object prefix for your object storage server. If this is a
source location, DataSync only copies objects with this prefix. If this
is a destination location, DataSync writes all objects with this prefix.
UpdateLocationObjectStorage
, updateLocationObjectStorage_locationArn
- Specifies the ARN of the object storage system location that you're
updating.
data UpdateLocationObjectStorageResponse Source #
See: newUpdateLocationObjectStorageResponse
smart constructor.
Instances
Generic UpdateLocationObjectStorageResponse Source # | |
Read UpdateLocationObjectStorageResponse Source # | |
Show UpdateLocationObjectStorageResponse Source # | |
NFData UpdateLocationObjectStorageResponse Source # | |
Defined in Amazonka.DataSync.UpdateLocationObjectStorage rnf :: UpdateLocationObjectStorageResponse -> () # | |
Eq UpdateLocationObjectStorageResponse Source # | |
type Rep UpdateLocationObjectStorageResponse Source # | |
Defined in Amazonka.DataSync.UpdateLocationObjectStorage type Rep UpdateLocationObjectStorageResponse = D1 ('MetaData "UpdateLocationObjectStorageResponse" "Amazonka.DataSync.UpdateLocationObjectStorage" "amazonka-datasync-2.0-LCcm4ddRe2z4CES4wun76Z" 'False) (C1 ('MetaCons "UpdateLocationObjectStorageResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newUpdateLocationObjectStorageResponse Source #
Create a value of UpdateLocationObjectStorageResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateLocationObjectStorageResponse'
, updateLocationObjectStorageResponse_httpStatus
- The response's http status code.
UpdateLocationSmb
data UpdateLocationSmb Source #
See: newUpdateLocationSmb
smart constructor.
UpdateLocationSmb' (Maybe (NonEmpty Text)) (Maybe Text) (Maybe SmbMountOptions) (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text) Text |
Instances
Create a value of UpdateLocationSmb
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateLocationSmb
, updateLocationSmb_agentArns
- The Amazon Resource Names (ARNs) of agents to use for a Simple Message
Block (SMB) location.
UpdateLocationSmb
, updateLocationSmb_domain
- The name of the Windows domain that the SMB server belongs to.
UpdateLocationSmb
, updateLocationSmb_mountOptions
- Undocumented member.
UpdateLocationSmb
, updateLocationSmb_password
- The password of the user who can mount the share has the permissions to
access files and folders in the SMB share.
$sel:subdirectory:UpdateLocationSmb'
, updateLocationSmb_subdirectory
- The subdirectory in the SMB file system that is used to read data from
the SMB source location or write data to the SMB destination. The SMB
path should be a path that's exported by the SMB server, or a
subdirectory of that path. The path should be such that it can be
mounted by other SMB clients in your network.
Subdirectory
must be specified with forward slashes. For example,
/path/to/folder
.
To transfer all the data in the folder that you specified, DataSync must have permissions to mount the SMB share and to access all the data in that share. To ensure this, do either of the following:
- Ensure that the user/password specified belongs to the user who can mount the share and who has the appropriate permissions for all of the files and directories that you want DataSync to access.
- Use credentials of a member of the Backup Operators group to mount the share.
Doing either of these options enables the agent to access the data. For the agent to access directories, you must also enable all execute access.
UpdateLocationSmb
, updateLocationSmb_user
- The user who can mount the share has the permissions to access files and
folders in the SMB share.
UpdateLocationSmb
, updateLocationSmb_locationArn
- The Amazon Resource Name (ARN) of the SMB location to update.
data UpdateLocationSmbResponse Source #
See: newUpdateLocationSmbResponse
smart constructor.
Instances
newUpdateLocationSmbResponse Source #
Create a value of UpdateLocationSmbResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateLocationSmbResponse'
, updateLocationSmbResponse_httpStatus
- The response's http status code.
UpdateTask
data UpdateTask Source #
UpdateTaskResponse
See: newUpdateTask
smart constructor.
UpdateTask' (Maybe Text) (Maybe [FilterRule]) (Maybe [FilterRule]) (Maybe Text) (Maybe Options) (Maybe TaskSchedule) Text |
Instances
:: Text | |
-> UpdateTask |
Create a value of UpdateTask
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:cloudWatchLogGroupArn:UpdateTask'
, updateTask_cloudWatchLogGroupArn
- The Amazon Resource Name (ARN) of the resource name of the Amazon
CloudWatch log group.
$sel:excludes:UpdateTask'
, updateTask_excludes
- Specifies a list of filter rules that exclude specific data during your
transfer. For more information and examples, see
Filtering data transferred by DataSync.
$sel:includes:UpdateTask'
, updateTask_includes
- Specifies a list of filter rules that include specific data during your
transfer. For more information and examples, see
Filtering data transferred by DataSync.
UpdateTask
, updateTask_name
- The name of the task to update.
$sel:options:UpdateTask'
, updateTask_options
- Undocumented member.
$sel:schedule:UpdateTask'
, updateTask_schedule
- Specifies a schedule used to periodically transfer files from a source
to a destination location. You can configure your task to execute
hourly, daily, weekly or on specific days of the week. You control when
in the day or hour you want the task to execute. The time you specify is
UTC time. For more information, see
Scheduling your task.
UpdateTask
, updateTask_taskArn
- The Amazon Resource Name (ARN) of the resource name of the task to
update.
data UpdateTaskResponse Source #
See: newUpdateTaskResponse
smart constructor.
Instances
newUpdateTaskResponse Source #
Create a value of UpdateTaskResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateTaskResponse'
, updateTaskResponse_httpStatus
- The response's http status code.
UpdateTaskExecution
data UpdateTaskExecution Source #
See: newUpdateTaskExecution
smart constructor.
Instances
newUpdateTaskExecution Source #
Create a value of UpdateTaskExecution
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateTaskExecution
, updateTaskExecution_taskExecutionArn
- The Amazon Resource Name (ARN) of the specific task execution that is
being updated.
$sel:options:UpdateTaskExecution'
, updateTaskExecution_options
- Undocumented member.
data UpdateTaskExecutionResponse Source #
See: newUpdateTaskExecutionResponse
smart constructor.
Instances
newUpdateTaskExecutionResponse Source #
Create a value of UpdateTaskExecutionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateTaskExecutionResponse'
, updateTaskExecutionResponse_httpStatus
- The response's http status code.
Types
AgentStatus
newtype AgentStatus Source #
pattern AgentStatus_OFFLINE :: AgentStatus | |
pattern AgentStatus_ONLINE :: AgentStatus |
Instances
Atime
pattern Atime_BEST_EFFORT :: Atime | |
pattern Atime_NONE :: Atime |
Instances
EfsInTransitEncryption
newtype EfsInTransitEncryption Source #
pattern EfsInTransitEncryption_NONE :: EfsInTransitEncryption | |
pattern EfsInTransitEncryption_TLS1_2 :: EfsInTransitEncryption |
Instances
EndpointType
newtype EndpointType Source #
pattern EndpointType_FIPS :: EndpointType | |
pattern EndpointType_PRIVATE_LINK :: EndpointType | |
pattern EndpointType_PUBLIC :: EndpointType |
Instances
FilterType
newtype FilterType Source #
pattern FilterType_SIMPLE_PATTERN :: FilterType |
Instances
Gid
pattern Gid_BOTH :: Gid | |
pattern Gid_INT_VALUE :: Gid | |
pattern Gid_NAME :: Gid | |
pattern Gid_NONE :: Gid |
Instances
HdfsAuthenticationType
newtype HdfsAuthenticationType Source #
pattern HdfsAuthenticationType_KERBEROS :: HdfsAuthenticationType | |
pattern HdfsAuthenticationType_SIMPLE :: HdfsAuthenticationType |
Instances
HdfsDataTransferProtection
newtype HdfsDataTransferProtection Source #
Instances
HdfsRpcProtection
newtype HdfsRpcProtection Source #
pattern HdfsRpcProtection_AUTHENTICATION :: HdfsRpcProtection | |
pattern HdfsRpcProtection_DISABLED :: HdfsRpcProtection | |
pattern HdfsRpcProtection_INTEGRITY :: HdfsRpcProtection | |
pattern HdfsRpcProtection_PRIVACY :: HdfsRpcProtection |
Instances
LocationFilterName
newtype LocationFilterName Source #
pattern LocationFilterName_CreationTime :: LocationFilterName | |
pattern LocationFilterName_LocationType :: LocationFilterName | |
pattern LocationFilterName_LocationUri :: LocationFilterName |
Instances
LogLevel
pattern LogLevel_BASIC :: LogLevel | |
pattern LogLevel_OFF :: LogLevel | |
pattern LogLevel_TRANSFER :: LogLevel |
Instances
Mtime
pattern Mtime_NONE :: Mtime | |
pattern Mtime_PRESERVE :: Mtime |
Instances
NfsVersion
newtype NfsVersion Source #
pattern NfsVersion_AUTOMATIC :: NfsVersion | |
pattern NfsVersion_NFS3 :: NfsVersion | |
pattern NfsVersion_NFS4_0 :: NfsVersion | |
pattern NfsVersion_NFS4_1 :: NfsVersion |
Instances
ObjectStorageServerProtocol
newtype ObjectStorageServerProtocol Source #
pattern ObjectStorageServerProtocol_HTTP :: ObjectStorageServerProtocol | |
pattern ObjectStorageServerProtocol_HTTPS :: ObjectStorageServerProtocol |
Instances
ObjectTags
newtype ObjectTags Source #
pattern ObjectTags_NONE :: ObjectTags | |
pattern ObjectTags_PRESERVE :: ObjectTags |
Instances
Operator
pattern Operator_BeginsWith :: Operator | |
pattern Operator_Contains :: Operator | |
pattern Operator_Equals :: Operator | |
pattern Operator_GreaterThan :: Operator | |
pattern Operator_GreaterThanOrEqual :: Operator | |
pattern Operator_In :: Operator | |
pattern Operator_LessThan :: Operator | |
pattern Operator_LessThanOrEqual :: Operator | |
pattern Operator_NotContains :: Operator | |
pattern Operator_NotEquals :: Operator |
Instances
OverwriteMode
newtype OverwriteMode Source #
pattern OverwriteMode_ALWAYS :: OverwriteMode | |
pattern OverwriteMode_NEVER :: OverwriteMode |
Instances
PhaseStatus
newtype PhaseStatus Source #
pattern PhaseStatus_ERROR :: PhaseStatus | |
pattern PhaseStatus_PENDING :: PhaseStatus | |
pattern PhaseStatus_SUCCESS :: PhaseStatus |
Instances
PosixPermissions
newtype PosixPermissions Source #
pattern PosixPermissions_NONE :: PosixPermissions | |
pattern PosixPermissions_PRESERVE :: PosixPermissions |
Instances
PreserveDeletedFiles
newtype PreserveDeletedFiles Source #
pattern PreserveDeletedFiles_PRESERVE :: PreserveDeletedFiles | |
pattern PreserveDeletedFiles_REMOVE :: PreserveDeletedFiles |
Instances
PreserveDevices
newtype PreserveDevices Source #
pattern PreserveDevices_NONE :: PreserveDevices | |
pattern PreserveDevices_PRESERVE :: PreserveDevices |
Instances
S3StorageClass
newtype S3StorageClass Source #
pattern S3StorageClass_DEEP_ARCHIVE :: S3StorageClass | |
pattern S3StorageClass_GLACIER :: S3StorageClass | |
pattern S3StorageClass_GLACIER_INSTANT_RETRIEVAL :: S3StorageClass | |
pattern S3StorageClass_INTELLIGENT_TIERING :: S3StorageClass | |
pattern S3StorageClass_ONEZONE_IA :: S3StorageClass | |
pattern S3StorageClass_OUTPOSTS :: S3StorageClass | |
pattern S3StorageClass_STANDARD :: S3StorageClass | |
pattern S3StorageClass_STANDARD_IA :: S3StorageClass |
Instances
SmbSecurityDescriptorCopyFlags
newtype SmbSecurityDescriptorCopyFlags Source #
Instances
SmbVersion
newtype SmbVersion Source #
pattern SmbVersion_AUTOMATIC :: SmbVersion | |
pattern SmbVersion_SMB2 :: SmbVersion | |
pattern SmbVersion_SMB3 :: SmbVersion |
Instances
TaskExecutionStatus
newtype TaskExecutionStatus Source #
pattern TaskExecutionStatus_ERROR :: TaskExecutionStatus | |
pattern TaskExecutionStatus_LAUNCHING :: TaskExecutionStatus | |
pattern TaskExecutionStatus_PREPARING :: TaskExecutionStatus | |
pattern TaskExecutionStatus_QUEUED :: TaskExecutionStatus | |
pattern TaskExecutionStatus_SUCCESS :: TaskExecutionStatus | |
pattern TaskExecutionStatus_TRANSFERRING :: TaskExecutionStatus | |
pattern TaskExecutionStatus_VERIFYING :: TaskExecutionStatus |
Instances
TaskFilterName
newtype TaskFilterName Source #
pattern TaskFilterName_CreationTime :: TaskFilterName | |
pattern TaskFilterName_LocationId :: TaskFilterName |
Instances
TaskQueueing
newtype TaskQueueing Source #
pattern TaskQueueing_DISABLED :: TaskQueueing | |
pattern TaskQueueing_ENABLED :: TaskQueueing |
Instances
TaskStatus
newtype TaskStatus Source #
pattern TaskStatus_AVAILABLE :: TaskStatus | |
pattern TaskStatus_CREATING :: TaskStatus | |
pattern TaskStatus_QUEUED :: TaskStatus | |
pattern TaskStatus_RUNNING :: TaskStatus | |
pattern TaskStatus_UNAVAILABLE :: TaskStatus |
Instances
TransferMode
newtype TransferMode Source #
pattern TransferMode_ALL :: TransferMode | |
pattern TransferMode_CHANGED :: TransferMode |
Instances
Uid
pattern Uid_BOTH :: Uid | |
pattern Uid_INT_VALUE :: Uid | |
pattern Uid_NAME :: Uid | |
pattern Uid_NONE :: Uid |
Instances
VerifyMode
newtype VerifyMode Source #
pattern VerifyMode_NONE :: VerifyMode | |
pattern VerifyMode_ONLY_FILES_TRANSFERRED :: VerifyMode | |
pattern VerifyMode_POINT_IN_TIME_CONSISTENT :: VerifyMode |
Instances
AgentListEntry
data AgentListEntry Source #
Represents a single entry in a list of agents. AgentListEntry
returns
an array that contains a list of agents when the
ListAgents
operation is called.
See: newAgentListEntry
smart constructor.
Instances
newAgentListEntry :: AgentListEntry Source #
Create a value of AgentListEntry
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:agentArn:AgentListEntry'
, agentListEntry_agentArn
- The Amazon Resource Name (ARN) of the agent.
$sel:name:AgentListEntry'
, agentListEntry_name
- The name of the agent.
$sel:status:AgentListEntry'
, agentListEntry_status
- The status of the agent.
Ec2Config
The subnet and security groups that DataSync uses to access your Amazon EFS file system.
See: newEc2Config
smart constructor.
Instances
FromJSON Ec2Config Source # | |
ToJSON Ec2Config Source # | |
Defined in Amazonka.DataSync.Types.Ec2Config | |
Generic Ec2Config Source # | |
Read Ec2Config Source # | |
Show Ec2Config Source # | |
NFData Ec2Config Source # | |
Defined in Amazonka.DataSync.Types.Ec2Config | |
Eq Ec2Config Source # | |
Hashable Ec2Config Source # | |
Defined in Amazonka.DataSync.Types.Ec2Config | |
type Rep Ec2Config Source # | |
Defined in Amazonka.DataSync.Types.Ec2Config type Rep Ec2Config = D1 ('MetaData "Ec2Config" "Amazonka.DataSync.Types.Ec2Config" "amazonka-datasync-2.0-LCcm4ddRe2z4CES4wun76Z" 'False) (C1 ('MetaCons "Ec2Config'" 'PrefixI 'True) (S1 ('MetaSel ('Just "subnetArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "securityGroupArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text)))) |
Create a value of Ec2Config
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:subnetArn:Ec2Config'
, ec2Config_subnetArn
- Specifies the ARN of a subnet where DataSync creates the
network interfaces
for managing traffic during your transfer.
The subnet must be located:
- In the same virtual private cloud (VPC) as the Amazon EFS file system.
- In the same Availability Zone as at least one mount target for the Amazon EFS file system.
You don't need to specify a subnet that includes a file system mount target.
$sel:securityGroupArns:Ec2Config'
, ec2Config_securityGroupArns
- Specifies the Amazon Resource Names (ARNs) of the security groups
associated with an Amazon EFS file system's mount target.
FilterRule
data FilterRule Source #
Specifies which files, folders, and objects to include or exclude when transferring files from source to destination.
See: newFilterRule
smart constructor.
Instances
newFilterRule :: FilterRule Source #
Create a value of FilterRule
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filterType:FilterRule'
, filterRule_filterType
- The type of filter rule to apply. DataSync only supports the
SIMPLE_PATTERN rule type.
$sel:value:FilterRule'
, filterRule_value
- A single filter string that consists of the patterns to include or
exclude. The patterns are delimited by "|" (that is, a pipe), for
example: /folder1|/folder2
FsxProtocol
data FsxProtocol Source #
Specifies the data transfer protocol that DataSync uses to access your Amazon FSx file system.
See: newFsxProtocol
smart constructor.
Instances
newFsxProtocol :: FsxProtocol Source #
Create a value of FsxProtocol
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nfs:FsxProtocol'
, fsxProtocol_nfs
- Specifies the Network File System (NFS) protocol configuration that
DataSync uses to access your FSx for OpenZFS file system or FSx for
ONTAP file system's storage virtual machine (SVM).
$sel:smb:FsxProtocol'
, fsxProtocol_smb
- Specifies the Server Message Block (SMB) protocol configuration that
DataSync uses to access your FSx for ONTAP file system's SVM.
FsxProtocolNfs
data FsxProtocolNfs Source #
Specifies the Network File System (NFS) protocol configuration that DataSync uses to access your Amazon FSx for OpenZFS or Amazon FSx for NetApp ONTAP file system.
See: newFsxProtocolNfs
smart constructor.
Instances
newFsxProtocolNfs :: FsxProtocolNfs Source #
Create a value of FsxProtocolNfs
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:mountOptions:FsxProtocolNfs'
, fsxProtocolNfs_mountOptions
- Undocumented member.
FsxProtocolSmb
data FsxProtocolSmb Source #
Specifies the Server Message Block (SMB) protocol configuration that DataSync uses to access your Amazon FSx for NetApp ONTAP file system. For more information, see Accessing FSx for ONTAP file systems.
See: newFsxProtocolSmb
smart constructor.
Instances
Create a value of FsxProtocolSmb
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:domain:FsxProtocolSmb'
, fsxProtocolSmb_domain
- Specifies the fully qualified domain name (FQDN) of the Microsoft Active
Directory that your storage virtual machine (SVM) belongs to.
$sel:mountOptions:FsxProtocolSmb'
, fsxProtocolSmb_mountOptions
- Undocumented member.
$sel:password:FsxProtocolSmb'
, fsxProtocolSmb_password
- Specifies the password of a user who has permission to access your SVM.
$sel:user:FsxProtocolSmb'
, fsxProtocolSmb_user
- Specifies a user name that can mount the location and access the files,
folders, and metadata that you need in the SVM.
If you provide a user in your Active Directory, note the following:
- If you're using Directory Service for Microsoft Active Directory, the user must be a member of the Amazon Web Services Delegated FSx Administrators group.
- If you're using a self-managed Active Directory, the user must be a member of either the Domain Admins group or a custom group that you specified for file system administration when you created your file system.
Make sure that the user has the permissions it needs to copy the data you want:
SE_TCB_NAME
: Required to set object ownership and file metadata. With this privilege, you also can copy NTFS discretionary access lists (DACLs).SE_SECURITY_NAME
: May be needed to copy NTFS system access control lists (SACLs). This operation specifically requires the Windows privilege, which is granted to members of the Domain Admins group. If you configure your task to copy SACLs, make sure that the user has the required privileges. For information about copying SACLs, see Ownership and permissions-related options.
HdfsNameNode
data HdfsNameNode Source #
The NameNode of the Hadoop Distributed File System (HDFS). The NameNode manages the file system's namespace. The NameNode performs operations such as opening, closing, and renaming files and directories. The NameNode contains the information to map blocks of data to the DataNodes.
See: newHdfsNameNode
smart constructor.
Instances
Create a value of HdfsNameNode
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:hostname:HdfsNameNode'
, hdfsNameNode_hostname
- The hostname of the NameNode in the HDFS cluster. This value is the IP
address or Domain Name Service (DNS) name of the NameNode. An agent
that's installed on-premises uses this hostname to communicate with the
NameNode in the network.
$sel:port:HdfsNameNode'
, hdfsNameNode_port
- The port that the NameNode uses to listen to client requests.
LocationFilter
data LocationFilter Source #
Narrow down the list of resources returned by ListLocations
. For
example, to see all your Amazon S3 locations, create a filter using
"Name": "LocationType"
, "Operator": "Equals"
, and
"Values": "S3"
.
For more information, see filtering resources.
See: newLocationFilter
smart constructor.
Instances
Create a value of LocationFilter
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:LocationFilter'
, locationFilter_name
- The name of the filter being used. Each API call supports a list of
filters that are available for it (for example, LocationType
for
ListLocations
).
$sel:values:LocationFilter'
, locationFilter_values
- The values that you want to filter for. For example, you might want to
display only Amazon S3 locations.
$sel:operator:LocationFilter'
, locationFilter_operator
- The operator that is used to compare filter values (for example,
Equals
or Contains
).
LocationListEntry
data LocationListEntry Source #
Represents a single entry in a list of locations. LocationListEntry
returns an array that contains a list of locations when the
ListLocations
operation is called.
See: newLocationListEntry
smart constructor.
Instances
newLocationListEntry :: LocationListEntry Source #
Create a value of LocationListEntry
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:locationArn:LocationListEntry'
, locationListEntry_locationArn
- The Amazon Resource Name (ARN) of the location. For Network File System
(NFS) or Amazon EFS, the location is the export path. For Amazon S3, the
location is the prefix path that you want to mount and use as the root
of the location.
$sel:locationUri:LocationListEntry'
, locationListEntry_locationUri
- Represents a list of URIs of a location. LocationUri
returns an array
that contains a list of locations when the
ListLocations
operation is called.
Format: TYPE://GLOBAL_ID/SUBDIR
.
TYPE designates the type of location (for example, nfs
or s3
).
GLOBAL_ID is the globally unique identifier of the resource that backs
the location. An example for EFS is us-east-2.fs-abcd1234
. An example
for Amazon S3 is the bucket name, such as myBucket
. An example for NFS
is a valid IPv4 address or a hostname that is compliant with Domain Name
Service (DNS).
SUBDIR is a valid file system path, delimited by forward slashes as is the *nix convention. For NFS and Amazon EFS, it's the export path to mount the location. For Amazon S3, it's the prefix path that you mount to and treat as the root of the location.
NfsMountOptions
data NfsMountOptions Source #
Specifies how DataSync can access a location using the NFS protocol.
See: newNfsMountOptions
smart constructor.
Instances
newNfsMountOptions :: NfsMountOptions Source #
Create a value of NfsMountOptions
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:version:NfsMountOptions'
, nfsMountOptions_version
- Specifies the NFS version that you want DataSync to use when mounting
your NFS share. If the server refuses to use the version specified, the
task fails.
You can specify the following options:
AUTOMATIC
(default): DataSync chooses NFS version 4.1.NFS3
: Stateless protocol version that allows for asynchronous writes on the server.NFSv4_0
: Stateful, firewall-friendly protocol version that supports delegations and pseudo file systems.NFSv4_1
: Stateful protocol version that supports sessions, directory delegations, and parallel data processing. NFS version 4.1 also includes all features available in version 4.0.
DataSync currently only supports NFS version 3 with Amazon FSx for NetApp ONTAP locations.
OnPremConfig
data OnPremConfig Source #
A list of Amazon Resource Names (ARNs) of agents to use for a Network File System (NFS) location.
See: newOnPremConfig
smart constructor.
Instances
Create a value of OnPremConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:agentArns:OnPremConfig'
, onPremConfig_agentArns
- ARNs of the agents to use for an NFS location.
Options
Configures your DataSync task settings. These options include how DataSync handles files, objects, and their associated metadata. You also can specify how DataSync verifies data integrity, set bandwidth limits for your task, among other options.
Each task setting has a default value. Unless you need to, you don't
have to configure any of these Options
before starting your task.
See: newOptions
smart constructor.
Instances
newOptions :: Options Source #
Create a value of Options
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:atime:Options'
, options_atime
- Specifies whether to preserve metadata indicating the last time a file
was read or written to. If you set Atime
to BEST_EFFORT
, DataSync
attempts to preserve the original Atime
attribute on all source files
(that is, the version before the PREPARING
phase of the task
execution).
The behavior of Atime
isn't fully standard across platforms, so
DataSync can only do this on a best-effort basis.
Default value: BEST_EFFORT
BEST_EFFORT
: Attempt to preserve the per-file Atime
value
(recommended).
NONE
: Ignore Atime
.
If Atime
is set to BEST_EFFORT
, Mtime
must be set to PRESERVE
.
If Atime
is set to NONE
, Mtime
must also be NONE
.
$sel:bytesPerSecond:Options'
, options_bytesPerSecond
- Limits the bandwidth used by a DataSync task. For example, if you want
DataSync to use a maximum of 1 MB, set this value to 1048576
(=1024*1024
).
$sel:gid:Options'
, options_gid
- Specifies the POSIX group ID (GID) of the file's owners.
For more information, see Metadata copied by DataSync.
Default value: INT_VALUE
. This preserves the integer value of the ID.
INT_VALUE
: Preserve the integer value of user ID (UID) and GID
(recommended).
NONE
: Ignore UID and GID.
$sel:logLevel:Options'
, options_logLevel
- Specifies the type of logs that DataSync publishes to a Amazon
CloudWatch Logs log group. To specify the log group, see
CloudWatchLogGroupArn.
If you set LogLevel
to OFF
, no logs are published. BASIC
publishes
logs on errors for individual files transferred. TRANSFER
publishes
logs for every file or object that is transferred and integrity checked.
$sel:mtime:Options'
, options_mtime
- Specifies whether to preserve metadata indicating the last time that a
file was written to before the PREPARING
phase of your task execution.
This option is required when you need to run the a task more than once.
Default Value: PRESERVE
PRESERVE
: Preserve original Mtime
(recommended)
NONE
: Ignore Mtime
.
If Mtime
is set to PRESERVE
, Atime
must be set to BEST_EFFORT
.
If Mtime
is set to NONE
, Atime
must also be set to NONE
.
$sel:objectTags:Options'
, options_objectTags
- Specifies whether object tags are preserved when transferring between
object storage systems. If you want your DataSync task to ignore object
tags, specify the NONE
value.
Default Value: PRESERVE
$sel:overwriteMode:Options'
, options_overwriteMode
- Specifies whether data at the destination location should be overwritten
or preserved. If set to NEVER
, a destination file for example will not
be replaced by a source file (even if the destination file differs from
the source file). If you modify files in the destination and you sync
the files, you can use this value to protect against overwriting those
changes.
Some storage classes have specific behaviors that can affect your Amazon S3 storage cost. For detailed information, see Considerations when working with Amazon S3 storage classes in DataSync .
$sel:posixPermissions:Options'
, options_posixPermissions
- Specifies which users or groups can access a file for a specific purpose
such as reading, writing, or execution of the file.
For more information, see Metadata copied by DataSync.
Default value: PRESERVE
PRESERVE
: Preserve POSIX-style permissions (recommended).
NONE
: Ignore permissions.
DataSync can preserve extant permissions of a source location.
$sel:preserveDeletedFiles:Options'
, options_preserveDeletedFiles
- Specifies whether files in the destination location that don't exist in
the source should be preserved. This option can affect your Amazon S3
storage cost. If your task deletes objects, you might incur minimum
storage duration charges for certain storage classes. For detailed
information, see
Considerations when working with Amazon S3 storage classes in DataSync
.
Default value: PRESERVE
PRESERVE
: Ignore such destination files (recommended).
REMOVE
: Delete destination files that aren’t present in the source.
$sel:preserveDevices:Options'
, options_preserveDevices
- Specifies whether DataSync should preserve the metadata of block and
character devices in the source location and recreate the files with
that device name and metadata on the destination. DataSync copies only
the name and metadata of such devices.
DataSync can't copy the actual contents of these devices because they're nonterminal and don't return an end-of-file (EOF) marker.
Default value: NONE
NONE
: Ignore special devices (recommended).
PRESERVE
: Preserve character and block device metadata. This option
currently isn't supported for Amazon EFS.
$sel:securityDescriptorCopyFlags:Options'
, options_securityDescriptorCopyFlags
- Specifies which components of the SMB security descriptor are copied
from source to destination objects.
This value is only used for transfers between SMB and Amazon FSx for Windows File Server locations or between two FSx for Windows File Server locations. For more information, see how DataSync handles metadata.
Default value: OWNER_DACL
OWNER_DACL
: For each copied object, DataSync copies the following
metadata:
- The object owner.
NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object.
DataSync won't copy NTFS system access control lists (SACLs) with this option.
OWNER_DACL_SACL
: For each copied object, DataSync copies the following
metadata:
- The object owner.
- NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object.
SACLs, which are used by administrators to log attempts to access a secured object.
Copying SACLs requires granting additional permissions to the Windows user that DataSync uses to access your SMB location. For information about choosing a user that ensures sufficient permissions to files, folders, and metadata, see user.
NONE
: None of the SMB security descriptor components are copied.
Destination objects are owned by the user that was provided for
accessing the destination location. DACLs and SACLs are set based on the
destination server’s configuration.
$sel:taskQueueing:Options'
, options_taskQueueing
- Specifies whether tasks should be queued before executing the tasks. The
default is ENABLED
, which means the tasks will be queued.
If you use the same agent to run multiple tasks, you can enable the tasks to run in series. For more information, see Queueing task executions.
$sel:transferMode:Options'
, options_transferMode
- Determines whether DataSync transfers only the data and metadata that
differ between the source and the destination location or transfers all
the content from the source (without comparing what's in the
destination).
CHANGED
: DataSync copies only data or metadata that is new or
different content from the source location to the destination location.
ALL
: DataSync copies all source location content to the destination
(without comparing what's in the destination).
$sel:uid:Options'
, options_uid
- Specifies the POSIX user ID (UID) of the file's owner.
For more information, see Metadata copied by DataSync.
Default value: INT_VALUE
. This preserves the integer value of the ID.
INT_VALUE
: Preserve the integer value of UID and group ID (GID)
(recommended).
NONE
: Ignore UID and GID.
$sel:verifyMode:Options'
, options_verifyMode
- Specifies how and when DataSync checks the integrity of your data during
a transfer.
Default value: POINT_IN_TIME_CONSISTENT
ONLY_FILES_TRANSFERRED
(recommended): DataSync calculates the checksum
of transferred files and metadata at the source location. At the end of
the transfer, DataSync then compares this checksum to the checksum
calculated on those files at the destination.
We recommend this option when transferring to S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive storage classes. For more information, see Storage class considerations with Amazon S3 locations.
POINT_IN_TIME_CONSISTENT
: At the end of the transfer, DataSync scans
the entire source and destination to verify that both locations are
fully synchronized.
You can't use this option when transferring to S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive storage classes. For more information, see Storage class considerations with Amazon S3 locations.
NONE
: DataSync doesn't run additional verification at the end of the
transfer. All data transmissions are still integrity-checked with
checksum verification during the transfer.
PrivateLinkConfig
data PrivateLinkConfig Source #
The VPC endpoint, subnet, and security group that an agent uses to access IP addresses in a VPC (Virtual Private Cloud).
See: newPrivateLinkConfig
smart constructor.
Instances
newPrivateLinkConfig :: PrivateLinkConfig Source #
Create a value of PrivateLinkConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:privateLinkEndpoint:PrivateLinkConfig'
, privateLinkConfig_privateLinkEndpoint
- The private endpoint that is configured for an agent that has access to
IP addresses in a
PrivateLink.
An agent that is configured with this endpoint will not be accessible
over the public internet.
$sel:securityGroupArns:PrivateLinkConfig'
, privateLinkConfig_securityGroupArns
- The Amazon Resource Names (ARNs) of the security groups that are
configured for the EC2 resource that hosts an agent activated in a VPC
or an agent that has access to a VPC endpoint.
$sel:subnetArns:PrivateLinkConfig'
, privateLinkConfig_subnetArns
- The Amazon Resource Names (ARNs) of the subnets that are configured for
an agent activated in a VPC or an agent that has access to a VPC
endpoint.
$sel:vpcEndpointId:PrivateLinkConfig'
, privateLinkConfig_vpcEndpointId
- The ID of the VPC endpoint that is configured for an agent. An agent
that is configured with a VPC endpoint will not be accessible over the
public internet.
QopConfiguration
data QopConfiguration Source #
The Quality of Protection (QOP) configuration specifies the Remote Procedure Call (RPC) and data transfer privacy settings configured on the Hadoop Distributed File System (HDFS) cluster.
See: newQopConfiguration
smart constructor.
Instances
newQopConfiguration :: QopConfiguration Source #
Create a value of QopConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dataTransferProtection:QopConfiguration'
, qopConfiguration_dataTransferProtection
- The data transfer protection setting configured on the HDFS cluster.
This setting corresponds to your dfs.data.transfer.protection
setting
in the hdfs-site.xml
file on your Hadoop cluster.
$sel:rpcProtection:QopConfiguration'
, qopConfiguration_rpcProtection
- The RPC protection setting configured on the HDFS cluster. This setting
corresponds to your hadoop.rpc.protection
setting in your
core-site.xml
file on your Hadoop cluster.
S3Config
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role used to access an Amazon S3 bucket.
For detailed information about using such a role, see Creating a Location for Amazon S3 in the DataSync User Guide.
See: newS3Config
smart constructor.
Instances
FromJSON S3Config Source # | |
ToJSON S3Config Source # | |
Defined in Amazonka.DataSync.Types.S3Config | |
Generic S3Config Source # | |
Read S3Config Source # | |
Show S3Config Source # | |
NFData S3Config Source # | |
Defined in Amazonka.DataSync.Types.S3Config | |
Eq S3Config Source # | |
Hashable S3Config Source # | |
Defined in Amazonka.DataSync.Types.S3Config | |
type Rep S3Config Source # | |
Defined in Amazonka.DataSync.Types.S3Config |
Create a value of S3Config
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:bucketAccessRoleArn:S3Config'
, s3Config_bucketAccessRoleArn
- The ARN of the IAM role for accessing the S3 bucket.
SmbMountOptions
data SmbMountOptions Source #
Specifies how DataSync can access a location using the SMB protocol.
See: newSmbMountOptions
smart constructor.
Instances
newSmbMountOptions :: SmbMountOptions Source #
Create a value of SmbMountOptions
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:version:SmbMountOptions'
, smbMountOptions_version
- Specifies the SMB version that you want DataSync to use when mounting
your SMB share. If you don't specify a version, DataSync defaults to
AUTOMATIC
and chooses a version based on negotiation with the SMB
server.
TagListEntry
data TagListEntry Source #
A key-value pair representing a single tag that's been applied to an Amazon Web Services resource.
See: newTagListEntry
smart constructor.
Instances
Create a value of TagListEntry
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:value:TagListEntry'
, tagListEntry_value
- The value for an Amazon Web Services resource tag.
$sel:key:TagListEntry'
, tagListEntry_key
- The key for an Amazon Web Services resource tag.
TaskExecutionListEntry
data TaskExecutionListEntry Source #
Represents a single entry in a list of task executions.
TaskExecutionListEntry
returns an array that contains a list of
specific invocations of a task when the
ListTaskExecutions
operation is called.
See: newTaskExecutionListEntry
smart constructor.
Instances
newTaskExecutionListEntry :: TaskExecutionListEntry Source #
Create a value of TaskExecutionListEntry
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:TaskExecutionListEntry'
, taskExecutionListEntry_status
- The status of a task execution.
$sel:taskExecutionArn:TaskExecutionListEntry'
, taskExecutionListEntry_taskExecutionArn
- The Amazon Resource Name (ARN) of the task that was executed.
TaskExecutionResultDetail
data TaskExecutionResultDetail Source #
Describes the detailed result of a TaskExecution
operation. This
result includes the time in milliseconds spent in each phase, the status
of the task execution, and the errors encountered.
See: newTaskExecutionResultDetail
smart constructor.
TaskExecutionResultDetail' (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe PhaseStatus) (Maybe Natural) (Maybe Natural) (Maybe PhaseStatus) (Maybe Natural) (Maybe PhaseStatus) |
Instances
newTaskExecutionResultDetail :: TaskExecutionResultDetail Source #
Create a value of TaskExecutionResultDetail
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:errorCode:TaskExecutionResultDetail'
, taskExecutionResultDetail_errorCode
- Errors that DataSync encountered during execution of the task. You can
use this error code to help troubleshoot issues.
$sel:errorDetail:TaskExecutionResultDetail'
, taskExecutionResultDetail_errorDetail
- Detailed description of an error that was encountered during the task
execution. You can use this information to help troubleshoot issues.
$sel:prepareDuration:TaskExecutionResultDetail'
, taskExecutionResultDetail_prepareDuration
- The total time in milliseconds that DataSync spent in the PREPARING
phase.
$sel:prepareStatus:TaskExecutionResultDetail'
, taskExecutionResultDetail_prepareStatus
- The status of the PREPARING phase.
$sel:totalDuration:TaskExecutionResultDetail'
, taskExecutionResultDetail_totalDuration
- The total time in milliseconds that DataSync took to transfer the file
from the source to the destination location.
$sel:transferDuration:TaskExecutionResultDetail'
, taskExecutionResultDetail_transferDuration
- The total time in milliseconds that DataSync spent in the TRANSFERRING
phase.
$sel:transferStatus:TaskExecutionResultDetail'
, taskExecutionResultDetail_transferStatus
- The status of the TRANSFERRING phase.
$sel:verifyDuration:TaskExecutionResultDetail'
, taskExecutionResultDetail_verifyDuration
- The total time in milliseconds that DataSync spent in the VERIFYING
phase.
$sel:verifyStatus:TaskExecutionResultDetail'
, taskExecutionResultDetail_verifyStatus
- The status of the VERIFYING phase.
TaskFilter
data TaskFilter Source #
You can use API filters to narrow down the list of resources returned by
ListTasks
. For example, to retrieve all tasks on a source location,
you can use ListTasks
with filter name LocationId
and
Operator Equals
with the ARN for the location.
For more information, see filtering DataSync resources.
See: newTaskFilter
smart constructor.
Instances
Create a value of TaskFilter
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:TaskFilter'
, taskFilter_name
- The name of the filter being used. Each API call supports a list of
filters that are available for it. For example, LocationId
for
ListTasks
.
$sel:values:TaskFilter'
, taskFilter_values
- The values that you want to filter for. For example, you might want to
display only tasks for a specific destination location.
$sel:operator:TaskFilter'
, taskFilter_operator
- The operator that is used to compare filter values (for example,
Equals
or Contains
).
TaskListEntry
data TaskListEntry Source #
Represents a single entry in a list of tasks. TaskListEntry
returns an
array that contains a list of tasks when the
ListTasks
operation is called. A task includes the source and destination file
systems to sync and the options to use for the tasks.
See: newTaskListEntry
smart constructor.
TaskListEntry' (Maybe Text) (Maybe TaskStatus) (Maybe Text) |
Instances
newTaskListEntry :: TaskListEntry Source #
Create a value of TaskListEntry
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:TaskListEntry'
, taskListEntry_name
- The name of the task.
$sel:status:TaskListEntry'
, taskListEntry_status
- The status of the task.
$sel:taskArn:TaskListEntry'
, taskListEntry_taskArn
- The Amazon Resource Name (ARN) of the task.
TaskSchedule
data TaskSchedule Source #
Specifies the schedule you want your task to use for repeated executions. For more information, see Schedule Expressions for Rules.
See: newTaskSchedule
smart constructor.
Instances
Create a value of TaskSchedule
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:scheduleExpression:TaskSchedule'
, taskSchedule_scheduleExpression
- A cron expression that specifies when DataSync initiates a scheduled
transfer from a source to a destination location.