Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
- Service Configuration
- Errors
- Waiters
- Operations
- UpdateTask
- DescribeAgent
- DeleteTask
- DescribeLocationSmb
- ListLocations (Paginated)
- CreateLocationNfs
- ListTagsForResource (Paginated)
- DescribeLocationFsxWindows
- CreateLocationObjectStorage
- DescribeTask
- DescribeLocationS3
- ListAgents (Paginated)
- UpdateLocationSmb
- DeleteAgent
- UpdateAgent
- CreateLocationFsxWindows
- ListTaskExecutions (Paginated)
- UpdateTaskExecution
- CreateLocationS3
- CreateTask
- CreateLocationEfs
- DescribeLocationObjectStorage
- DeleteLocation
- ListTasks (Paginated)
- StartTaskExecution
- UpdateLocationNfs
- DescribeTaskExecution
- CreateLocationSmb
- CreateAgent
- UpdateLocationObjectStorage
- DescribeLocationEfs
- TagResource
- UntagResource
- DescribeLocationNfs
- CancelTaskExecution
- Types
- AgentStatus
- Atime
- EndpointType
- FilterType
- Gid
- LocationFilterName
- LogLevel
- Mtime
- NfsVersion
- ObjectStorageServerProtocol
- Operator
- OverwriteMode
- PhaseStatus
- PosixPermissions
- PreserveDeletedFiles
- PreserveDevices
- S3StorageClass
- SmbSecurityDescriptorCopyFlags
- SmbVersion
- TaskExecutionStatus
- TaskFilterName
- TaskQueueing
- TaskStatus
- TransferMode
- Uid
- VerifyMode
- AgentListEntry
- Ec2Config
- FilterRule
- LocationFilter
- LocationListEntry
- NfsMountOptions
- OnPremConfig
- Options
- PrivateLinkConfig
- 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 Simple Storage Service (Amazon S3) or Amazon Elastic File System (Amazon EFS).
This API interface reference for DataSync contains documentation for a programming interface that you can use to manage DataSync.
Synopsis
- defaultService :: Service
- _InvalidRequestException :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalException :: AsError a => Getting (First ServiceError) a ServiceError
- data UpdateTask = UpdateTask' (Maybe TaskSchedule) (Maybe [FilterRule]) (Maybe Text) (Maybe [FilterRule]) (Maybe Options) (Maybe Text) Text
- newUpdateTask :: Text -> UpdateTask
- data UpdateTaskResponse = UpdateTaskResponse' Int
- newUpdateTaskResponse :: Int -> UpdateTaskResponse
- data DescribeAgent = DescribeAgent' Text
- newDescribeAgent :: Text -> DescribeAgent
- data DescribeAgentResponse = DescribeAgentResponse' (Maybe POSIX) (Maybe AgentStatus) (Maybe PrivateLinkConfig) (Maybe EndpointType) (Maybe POSIX) (Maybe Text) (Maybe Text) Int
- newDescribeAgentResponse :: Int -> DescribeAgentResponse
- data DeleteTask = DeleteTask' Text
- newDeleteTask :: Text -> DeleteTask
- data DeleteTaskResponse = DeleteTaskResponse' Int
- newDeleteTaskResponse :: Int -> DeleteTaskResponse
- data DescribeLocationSmb = DescribeLocationSmb' Text
- newDescribeLocationSmb :: Text -> DescribeLocationSmb
- data DescribeLocationSmbResponse = DescribeLocationSmbResponse' (Maybe POSIX) (Maybe (NonEmpty Text)) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe SmbMountOptions) (Maybe Text) Int
- newDescribeLocationSmbResponse :: Int -> DescribeLocationSmbResponse
- data ListLocations = ListLocations' (Maybe [LocationFilter]) (Maybe Text) (Maybe Natural)
- newListLocations :: ListLocations
- data ListLocationsResponse = ListLocationsResponse' (Maybe Text) (Maybe [LocationListEntry]) Int
- newListLocationsResponse :: Int -> ListLocationsResponse
- 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 ListTagsForResource = ListTagsForResource' (Maybe Text) (Maybe Natural) Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe Text) (Maybe [TagListEntry]) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data DescribeLocationFsxWindows = DescribeLocationFsxWindows' Text
- newDescribeLocationFsxWindows :: Text -> DescribeLocationFsxWindows
- data DescribeLocationFsxWindowsResponse = DescribeLocationFsxWindowsResponse' (Maybe POSIX) (Maybe (NonEmpty Text)) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int
- newDescribeLocationFsxWindowsResponse :: Int -> DescribeLocationFsxWindowsResponse
- data CreateLocationObjectStorage = CreateLocationObjectStorage' (Maybe Natural) (Maybe ObjectStorageServerProtocol) (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text) (Maybe [TagListEntry]) Text Text (NonEmpty Text)
- newCreateLocationObjectStorage :: Text -> Text -> NonEmpty Text -> CreateLocationObjectStorage
- data CreateLocationObjectStorageResponse = CreateLocationObjectStorageResponse' (Maybe Text) Int
- newCreateLocationObjectStorageResponse :: Int -> CreateLocationObjectStorageResponse
- data DescribeTask = DescribeTask' Text
- newDescribeTask :: Text -> DescribeTask
- data DescribeTaskResponse = DescribeTaskResponse' (Maybe POSIX) (Maybe TaskStatus) (Maybe TaskSchedule) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe [FilterRule]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [FilterRule]) (Maybe [Text]) (Maybe Options) (Maybe Text) (Maybe Text) Int
- newDescribeTaskResponse :: Int -> DescribeTaskResponse
- data DescribeLocationS3 = DescribeLocationS3' Text
- newDescribeLocationS3 :: Text -> DescribeLocationS3
- data DescribeLocationS3Response = DescribeLocationS3Response' (Maybe POSIX) (Maybe (NonEmpty Text)) (Maybe S3StorageClass) (Maybe Text) (Maybe S3Config) (Maybe Text) Int
- newDescribeLocationS3Response :: Int -> DescribeLocationS3Response
- data ListAgents = ListAgents' (Maybe Text) (Maybe Natural)
- newListAgents :: ListAgents
- data ListAgentsResponse = ListAgentsResponse' (Maybe [AgentListEntry]) (Maybe Text) Int
- newListAgentsResponse :: Int -> ListAgentsResponse
- data UpdateLocationSmb = UpdateLocationSmb' (Maybe (NonEmpty Text)) (Maybe Text) (Maybe Text) (Maybe (Sensitive Text)) (Maybe Text) (Maybe SmbMountOptions) Text
- newUpdateLocationSmb :: Text -> UpdateLocationSmb
- data UpdateLocationSmbResponse = UpdateLocationSmbResponse' Int
- newUpdateLocationSmbResponse :: Int -> UpdateLocationSmbResponse
- data DeleteAgent = DeleteAgent' Text
- newDeleteAgent :: Text -> DeleteAgent
- data DeleteAgentResponse = DeleteAgentResponse' Int
- newDeleteAgentResponse :: Int -> DeleteAgentResponse
- data UpdateAgent = UpdateAgent' (Maybe Text) Text
- newUpdateAgent :: Text -> UpdateAgent
- data UpdateAgentResponse = UpdateAgentResponse' Int
- newUpdateAgentResponse :: Int -> UpdateAgentResponse
- 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 ListTaskExecutions = ListTaskExecutions' (Maybe Text) (Maybe Text) (Maybe Natural)
- newListTaskExecutions :: ListTaskExecutions
- data ListTaskExecutionsResponse = ListTaskExecutionsResponse' (Maybe Text) (Maybe [TaskExecutionListEntry]) Int
- newListTaskExecutionsResponse :: Int -> ListTaskExecutionsResponse
- data UpdateTaskExecution = UpdateTaskExecution' Text Options
- newUpdateTaskExecution :: Text -> Options -> UpdateTaskExecution
- data UpdateTaskExecutionResponse = UpdateTaskExecutionResponse' Int
- newUpdateTaskExecutionResponse :: Int -> UpdateTaskExecutionResponse
- 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 CreateTask = CreateTask' (Maybe TaskSchedule) (Maybe [FilterRule]) (Maybe Text) (Maybe [FilterRule]) (Maybe Options) (Maybe Text) (Maybe [TagListEntry]) Text Text
- newCreateTask :: Text -> Text -> CreateTask
- data CreateTaskResponse = CreateTaskResponse' (Maybe Text) Int
- newCreateTaskResponse :: Int -> CreateTaskResponse
- data CreateLocationEfs = CreateLocationEfs' (Maybe Text) (Maybe [TagListEntry]) Text Ec2Config
- newCreateLocationEfs :: Text -> Ec2Config -> CreateLocationEfs
- data CreateLocationEfsResponse = CreateLocationEfsResponse' (Maybe Text) Int
- newCreateLocationEfsResponse :: Int -> CreateLocationEfsResponse
- data DescribeLocationObjectStorage = DescribeLocationObjectStorage' Text
- newDescribeLocationObjectStorage :: Text -> DescribeLocationObjectStorage
- data DescribeLocationObjectStorageResponse = DescribeLocationObjectStorageResponse' (Maybe Natural) (Maybe POSIX) (Maybe (NonEmpty Text)) (Maybe Text) (Maybe ObjectStorageServerProtocol) (Maybe Text) (Maybe Text) Int
- newDescribeLocationObjectStorageResponse :: Int -> DescribeLocationObjectStorageResponse
- data DeleteLocation = DeleteLocation' Text
- newDeleteLocation :: Text -> DeleteLocation
- data DeleteLocationResponse = DeleteLocationResponse' Int
- newDeleteLocationResponse :: Int -> DeleteLocationResponse
- data ListTasks = ListTasks' (Maybe [TaskFilter]) (Maybe Text) (Maybe Natural)
- newListTasks :: ListTasks
- data ListTasksResponse = ListTasksResponse' (Maybe [TaskListEntry]) (Maybe Text) Int
- newListTasksResponse :: Int -> ListTasksResponse
- data StartTaskExecution = StartTaskExecution' (Maybe Options) (Maybe [FilterRule]) (Maybe [FilterRule]) Text
- newStartTaskExecution :: Text -> StartTaskExecution
- data StartTaskExecutionResponse = StartTaskExecutionResponse' (Maybe Text) Int
- newStartTaskExecutionResponse :: Int -> StartTaskExecutionResponse
- data UpdateLocationNfs = UpdateLocationNfs' (Maybe OnPremConfig) (Maybe Text) (Maybe NfsMountOptions) Text
- newUpdateLocationNfs :: Text -> UpdateLocationNfs
- data UpdateLocationNfsResponse = UpdateLocationNfsResponse' Int
- newUpdateLocationNfsResponse :: Int -> UpdateLocationNfsResponse
- data DescribeTaskExecution = DescribeTaskExecution' Text
- newDescribeTaskExecution :: Text -> DescribeTaskExecution
- data DescribeTaskExecutionResponse = DescribeTaskExecutionResponse' (Maybe TaskExecutionStatus) (Maybe Text) (Maybe POSIX) (Maybe Integer) (Maybe Integer) (Maybe Integer) (Maybe TaskExecutionResultDetail) (Maybe [FilterRule]) (Maybe Integer) (Maybe [FilterRule]) (Maybe Options) (Maybe Integer) Int
- newDescribeTaskExecutionResponse :: Int -> DescribeTaskExecutionResponse
- 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 CreateAgent = CreateAgent' (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe Text) (Maybe Text) (Maybe [TagListEntry]) Text
- newCreateAgent :: Text -> CreateAgent
- data CreateAgentResponse = CreateAgentResponse' (Maybe Text) Int
- newCreateAgentResponse :: Int -> CreateAgentResponse
- data UpdateLocationObjectStorage = UpdateLocationObjectStorage' (Maybe Natural) (Maybe (NonEmpty Text)) (Maybe ObjectStorageServerProtocol) (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text) Text
- newUpdateLocationObjectStorage :: Text -> UpdateLocationObjectStorage
- data UpdateLocationObjectStorageResponse = UpdateLocationObjectStorageResponse' Int
- newUpdateLocationObjectStorageResponse :: Int -> UpdateLocationObjectStorageResponse
- data DescribeLocationEfs = DescribeLocationEfs' Text
- newDescribeLocationEfs :: Text -> DescribeLocationEfs
- data DescribeLocationEfsResponse = DescribeLocationEfsResponse' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Ec2Config) Int
- newDescribeLocationEfsResponse :: Int -> DescribeLocationEfsResponse
- 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 DescribeLocationNfs = DescribeLocationNfs' Text
- newDescribeLocationNfs :: Text -> DescribeLocationNfs
- data DescribeLocationNfsResponse = DescribeLocationNfsResponse' (Maybe POSIX) (Maybe Text) (Maybe OnPremConfig) (Maybe NfsMountOptions) (Maybe Text) Int
- newDescribeLocationNfsResponse :: Int -> DescribeLocationNfsResponse
- data CancelTaskExecution = CancelTaskExecution' Text
- newCancelTaskExecution :: Text -> CancelTaskExecution
- data CancelTaskExecutionResponse = CancelTaskExecutionResponse' Int
- newCancelTaskExecutionResponse :: Int -> CancelTaskExecutionResponse
- 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 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 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 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_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 AgentStatus) (Maybe Text) (Maybe Text)
- newAgentListEntry :: AgentListEntry
- data Ec2Config = Ec2Config' Text (NonEmpty Text)
- newEc2Config :: Text -> NonEmpty Text -> Ec2Config
- data FilterRule = FilterRule' (Maybe FilterType) (Maybe Text)
- newFilterRule :: FilterRule
- 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 VerifyMode) (Maybe TaskQueueing) (Maybe LogLevel) (Maybe PosixPermissions) (Maybe Mtime) (Maybe Uid) (Maybe Integer) (Maybe SmbSecurityDescriptorCopyFlags) (Maybe Gid) (Maybe OverwriteMode) (Maybe TransferMode) (Maybe PreserveDeletedFiles) (Maybe PreserveDevices)
- newOptions :: Options
- data PrivateLinkConfig = PrivateLinkConfig' (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe Text) (Maybe Text)
- newPrivateLinkConfig :: PrivateLinkConfig
- 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 Natural) (Maybe PhaseStatus) (Maybe PhaseStatus) (Maybe Natural) (Maybe Natural) (Maybe PhaseStatus) (Maybe Text) (Maybe Natural) (Maybe Text)
- newTaskExecutionResultDetail :: TaskExecutionResultDetail
- data TaskFilter = TaskFilter' TaskFilterName [Text] Operator
- newTaskFilter :: TaskFilterName -> Operator -> TaskFilter
- data TaskListEntry = TaskListEntry' (Maybe TaskStatus) (Maybe Text) (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
.
InvalidRequestException
_InvalidRequestException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when the client submits a malformed request.
InternalException
_InternalException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when an error occurs in the DataSync service.
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.
UpdateTask
data UpdateTask Source #
UpdateTaskResponse
See: newUpdateTask
smart constructor.
UpdateTask' (Maybe TaskSchedule) (Maybe [FilterRule]) (Maybe Text) (Maybe [FilterRule]) (Maybe Options) (Maybe Text) Text |
Instances
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: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.
$sel:includes:UpdateTask'
, updateTask_includes
- 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:name:UpdateTask'
, updateTask_name
- The name of the task to update.
$sel:excludes:UpdateTask'
, updateTask_excludes
- A list of filter rules that determines which files to exclude from a
task. The list should contain 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:options:UpdateTask'
, updateTask_options
- Undocumented member.
$sel:cloudWatchLogGroupArn:UpdateTask'
, updateTask_cloudWatchLogGroupArn
- The Amazon Resource Name (ARN) of the resource name of the CloudWatch
LogGroup.
$sel:taskArn: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.
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:
$sel:agentArn:DescribeAgent'
, describeAgent_agentArn
- The Amazon Resource Name (ARN) of the agent to describe.
data DescribeAgentResponse Source #
DescribeAgentResponse
See: newDescribeAgentResponse
smart constructor.
DescribeAgentResponse' (Maybe POSIX) (Maybe AgentStatus) (Maybe PrivateLinkConfig) (Maybe EndpointType) (Maybe POSIX) (Maybe Text) (Maybe Text) 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:
$sel:creationTime:DescribeAgentResponse'
, describeAgentResponse_creationTime
- The time that the agent was activated (that is, created in your
account).
$sel:status: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:privateLinkConfig:DescribeAgentResponse'
, describeAgentResponse_privateLinkConfig
- The subnet and the security group that DataSync used to access a VPC
endpoint.
$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.
$sel:agentArn:DescribeAgent'
, describeAgentResponse_agentArn
- The Amazon Resource Name (ARN) of the agent.
$sel:name:DescribeAgentResponse'
, describeAgentResponse_name
- The name of the agent.
$sel:httpStatus:DescribeAgentResponse'
, describeAgentResponse_httpStatus
- The response's http status code.
DeleteTask
data DeleteTask Source #
DeleteTask
See: newDeleteTask
smart constructor.
Instances
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:
$sel:taskArn:DeleteTask'
, deleteTask_taskArn
- The Amazon Resource Name (ARN) of the task 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.
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:
$sel:locationArn:DescribeLocationSmb'
, describeLocationSmb_locationArn
- The Amazon Resource Name (ARN) of the SMB location to describe.
data DescribeLocationSmbResponse Source #
DescribeLocationSmbResponse
See: newDescribeLocationSmbResponse
smart constructor.
DescribeLocationSmbResponse' (Maybe POSIX) (Maybe (NonEmpty Text)) (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:
$sel:creationTime:DescribeLocationSmbResponse'
, describeLocationSmbResponse_creationTime
- The time that the SMB location was created.
$sel:agentArns:DescribeLocationSmbResponse'
, describeLocationSmbResponse_agentArns
- The Amazon Resource Name (ARN) of the source SMB file system location
that is created.
$sel:domain:DescribeLocationSmbResponse'
, describeLocationSmbResponse_domain
- The name of the Windows domain that the SMB server belongs to.
$sel:locationUri:DescribeLocationSmbResponse'
, describeLocationSmbResponse_locationUri
- The URL of the source SMB location that was described.
$sel:user:DescribeLocationSmbResponse'
, describeLocationSmbResponse_user
- The user who can mount the share, has the permissions to access files
and folders in the SMB share.
$sel:mountOptions:DescribeLocationSmbResponse'
, describeLocationSmbResponse_mountOptions
- The mount options that are available for DataSync to use to access an
SMB location.
$sel:locationArn:DescribeLocationSmb'
, describeLocationSmbResponse_locationArn
- The Amazon Resource Name (ARN) of the SMB location that was described.
$sel:httpStatus:DescribeLocationSmbResponse'
, describeLocationSmbResponse_httpStatus
- The response's http status code.
ListLocations (Paginated)
data ListLocations Source #
ListLocationsRequest
See: newListLocations
smart constructor.
ListLocations' (Maybe [LocationFilter]) (Maybe Text) (Maybe Natural) |
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:nextToken:ListLocations'
, listLocations_nextToken
- An opaque string that indicates the position at which to begin the next
list of locations.
$sel:maxResults:ListLocations'
, listLocations_maxResults
- The maximum number of locations to return.
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:nextToken:ListLocations'
, listLocationsResponse_nextToken
- An opaque string that indicates the position at which to begin returning
the next list of locations.
$sel:locations:ListLocationsResponse'
, listLocationsResponse_locations
- An array that contains a list of locations.
$sel:httpStatus:ListLocationsResponse'
, listLocationsResponse_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:
$sel:mountOptions: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 host name 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:
$sel:locationArn: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.
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:nextToken:ListTagsForResource'
, listTagsForResource_nextToken
- An opaque string that indicates the position at which to begin the next
list of locations.
$sel:maxResults:ListTagsForResource'
, listTagsForResource_maxResults
- The maximum number of locations to return.
$sel:resourceArn:ListTagsForResource'
, listTagsForResource_resourceArn
- The Amazon Resource Name (ARN) of the resource whose tags to list.
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:
$sel:nextToken:ListTagsForResource'
, listTagsForResourceResponse_nextToken
- An opaque string that indicates the position at which to begin returning
the next list of resource tags.
$sel:tags:ListTagsForResourceResponse'
, listTagsForResourceResponse_tags
- Array of resource tags.
$sel:httpStatus:ListTagsForResourceResponse'
, listTagsForResourceResponse_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:
$sel:locationArn: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 (NonEmpty Text)) (Maybe Text) (Maybe Text) (Maybe 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.
$sel:securityGroupArns:DescribeLocationFsxWindowsResponse'
, describeLocationFsxWindowsResponse_securityGroupArns
- The Amazon Resource Names (ARNs) of the security groups that are
configured for the FSx for Windows File Server file system.
$sel:domain:DescribeLocationFsxWindowsResponse'
, describeLocationFsxWindowsResponse_domain
- The name of the Windows domain that the FSx for Windows File Server
belongs to.
$sel:locationUri:DescribeLocationFsxWindowsResponse'
, describeLocationFsxWindowsResponse_locationUri
- The URL of the FSx for Windows File Server location that was described.
$sel:user:DescribeLocationFsxWindowsResponse'
, describeLocationFsxWindowsResponse_user
- The user who has the permissions to access files and folders in the FSx
for Windows File Server file system.
$sel:locationArn:DescribeLocationFsxWindows'
, describeLocationFsxWindowsResponse_locationArn
- The Amazon Resource Name (ARN) of the FSx for Windows File Server
location that was described.
$sel:httpStatus:DescribeLocationFsxWindowsResponse'
, describeLocationFsxWindowsResponse_httpStatus
- The response's http status code.
CreateLocationObjectStorage
data CreateLocationObjectStorage Source #
CreateLocationObjectStorageRequest
See: newCreateLocationObjectStorage
smart constructor.
CreateLocationObjectStorage' (Maybe Natural) (Maybe ObjectStorageServerProtocol) (Maybe (Sensitive Text)) (Maybe Text) (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:serverPort:CreateLocationObjectStorage'
, createLocationObjectStorage_serverPort
- The port that your self-managed object storage server accepts inbound
network traffic on. The server port is set by default to TCP 80 (HTTP)
or TCP 443 (HTTPS). You can specify a custom port if your self-managed
object storage server requires one.
$sel:serverProtocol:CreateLocationObjectStorage'
, createLocationObjectStorage_serverProtocol
- The protocol that the object storage server uses to communicate. Valid
values are HTTP or HTTPS.
$sel:secretKey:CreateLocationObjectStorage'
, createLocationObjectStorage_secretKey
- Optional. The secret key is used if credentials are required to access
the self-managed object storage server. If your object storage requires
a user name and password to authenticate, use AccessKey
and
SecretKey
to provide the user name and password, respectively.
$sel:subdirectory:CreateLocationObjectStorage'
, createLocationObjectStorage_subdirectory
- The subdirectory in the self-managed object storage server that is used
to read data from.
$sel:accessKey:CreateLocationObjectStorage'
, createLocationObjectStorage_accessKey
- Optional. The access key is used if credentials are required to access
the self-managed object storage server. If your object storage requires
a user name and password to authenticate, use AccessKey
and
SecretKey
to provide the user name and password, respectively.
$sel:tags:CreateLocationObjectStorage'
, createLocationObjectStorage_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:serverHostname:CreateLocationObjectStorage'
, createLocationObjectStorage_serverHostname
- The name of the self-managed object storage server. This value is the IP
address or Domain Name Service (DNS) name of the object storage server.
An agent uses this host name to mount the object storage server in a
network.
$sel:bucketName:CreateLocationObjectStorage'
, createLocationObjectStorage_bucketName
- The bucket on the self-managed object storage server that is used to
read data from.
$sel:agentArns:CreateLocationObjectStorage'
, createLocationObjectStorage_agentArns
- The Amazon Resource Name (ARN) of the agents associated with the
self-managed object storage server location.
data CreateLocationObjectStorageResponse Source #
CreateLocationObjectStorageResponse
See: newCreateLocationObjectStorageResponse
smart constructor.
Instances
Eq CreateLocationObjectStorageResponse Source # | |
Read CreateLocationObjectStorageResponse Source # | |
Show CreateLocationObjectStorageResponse Source # | |
Generic CreateLocationObjectStorageResponse Source # | |
NFData CreateLocationObjectStorageResponse Source # | |
Defined in Amazonka.DataSync.CreateLocationObjectStorage rnf :: CreateLocationObjectStorageResponse -> () # | |
type Rep CreateLocationObjectStorageResponse Source # | |
Defined in Amazonka.DataSync.CreateLocationObjectStorage type Rep CreateLocationObjectStorageResponse = D1 ('MetaData "CreateLocationObjectStorageResponse" "Amazonka.DataSync.CreateLocationObjectStorage" "libZSservicesZSamazonka-datasyncZSamazonka-datasync" '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:
$sel:locationArn:CreateLocationObjectStorageResponse'
, createLocationObjectStorageResponse_locationArn
- The Amazon Resource Name (ARN) of the agents associated with the
self-managed object storage server location.
$sel:httpStatus:CreateLocationObjectStorageResponse'
, createLocationObjectStorageResponse_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:
$sel:taskArn:DescribeTask'
, describeTask_taskArn
- The Amazon Resource Name (ARN) of the task to describe.
data DescribeTaskResponse Source #
DescribeTaskResponse
See: newDescribeTaskResponse
smart constructor.
DescribeTaskResponse' (Maybe POSIX) (Maybe TaskStatus) (Maybe TaskSchedule) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe [FilterRule]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [FilterRule]) (Maybe [Text]) (Maybe Options) (Maybe Text) (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:creationTime:DescribeTaskResponse'
, describeTaskResponse_creationTime
- The time that the task was created.
$sel:status: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.
$sel:schedule:DescribeTaskResponse'
, describeTaskResponse_schedule
- The schedule used to periodically transfer files from a source to a
destination location.
$sel:taskArn:DescribeTask'
, describeTaskResponse_taskArn
- The Amazon Resource Name (ARN) of the task that was described.
$sel:currentTaskExecutionArn:DescribeTaskResponse'
, describeTaskResponse_currentTaskExecutionArn
- The Amazon Resource Name (ARN) of the task execution that is syncing
files.
$sel:destinationNetworkInterfaceArns:DescribeTaskResponse'
, describeTaskResponse_destinationNetworkInterfaceArns
- The Amazon Resource Name (ARN) of the destination ENIs (Elastic Network
Interface) that was created for your subnet.
$sel:destinationLocationArn:DescribeTaskResponse'
, describeTaskResponse_destinationLocationArn
- The Amazon Resource Name (ARN) of the Amazon Web Services storage
resource's location.
$sel:includes:DescribeTaskResponse'
, describeTaskResponse_includes
- 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:name:DescribeTaskResponse'
, describeTaskResponse_name
- The name of the task that was described.
$sel:errorCode:DescribeTaskResponse'
, describeTaskResponse_errorCode
- Errors that DataSync encountered during execution of the task. You can
use this error code to help troubleshoot issues.
$sel:sourceLocationArn:DescribeTaskResponse'
, describeTaskResponse_sourceLocationArn
- The Amazon Resource Name (ARN) of the source file system's location.
$sel:excludes:DescribeTaskResponse'
, describeTaskResponse_excludes
- A list of filter rules that determines which files to exclude from a
task. The list should contain 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:sourceNetworkInterfaceArns:DescribeTaskResponse'
, describeTaskResponse_sourceNetworkInterfaceArns
- The Amazon Resource Name (ARN) of the source ENIs (Elastic Network
Interface) that was created for your subnet.
$sel:options:DescribeTaskResponse'
, describeTaskResponse_options
- The set of configuration options that control the behavior of a single
execution of the task that occurs when you call StartTaskExecution
.
You can configure these options to preserve metadata such as user ID
(UID) and group (GID), file permissions, data integrity verification,
and so on.
For each individual task execution, you can override these options by
specifying the overriding OverrideOptions
value to
StartTaskExecution
operation.
$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:errorDetail: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:httpStatus:DescribeTaskResponse'
, describeTaskResponse_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:
$sel:locationArn: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 POSIX) (Maybe (NonEmpty Text)) (Maybe S3StorageClass) (Maybe Text) (Maybe S3Config) (Maybe Text) 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:
$sel:creationTime:DescribeLocationS3Response'
, describeLocationS3Response_creationTime
- The time that the Amazon S3 bucket location was created.
$sel:agentArns: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: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:locationUri:DescribeLocationS3Response'
, describeLocationS3Response_locationUri
- The URL of the Amazon S3 location that was described.
$sel:s3Config:DescribeLocationS3Response'
, describeLocationS3Response_s3Config
- Undocumented member.
$sel:locationArn:DescribeLocationS3'
, describeLocationS3Response_locationArn
- The Amazon Resource Name (ARN) of the Amazon S3 bucket or access point.
$sel:httpStatus:DescribeLocationS3Response'
, describeLocationS3Response_httpStatus
- The response's http status code.
ListAgents (Paginated)
data ListAgents Source #
ListAgentsRequest
See: newListAgents
smart constructor.
ListAgents' (Maybe Text) (Maybe Natural) |
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:nextToken:ListAgents'
, listAgents_nextToken
- An opaque string that indicates the position at which to begin the next
list of agents.
$sel:maxResults:ListAgents'
, listAgents_maxResults
- The maximum number of agents to list.
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.
$sel:nextToken: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.
UpdateLocationSmb
data UpdateLocationSmb Source #
See: newUpdateLocationSmb
smart constructor.
UpdateLocationSmb' (Maybe (NonEmpty Text)) (Maybe Text) (Maybe Text) (Maybe (Sensitive Text)) (Maybe Text) (Maybe SmbMountOptions) 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:
$sel:agentArns:UpdateLocationSmb'
, updateLocationSmb_agentArns
- The Amazon Resource Names (ARNs) of agents to use for a Simple Message
Block (SMB) location.
$sel:domain:UpdateLocationSmb'
, updateLocationSmb_domain
- The name of the Windows domain that the SMB server belongs to.
$sel:user:UpdateLocationSmb'
, updateLocationSmb_user
- The user who can mount the share has the permissions to access files and
folders in the SMB share.
$sel:password: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.
$sel:mountOptions:UpdateLocationSmb'
, updateLocationSmb_mountOptions
- Undocumented member.
$sel:locationArn: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.
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:
$sel:agentArn: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.
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:
$sel:name:UpdateAgent'
, updateAgent_name
- The name that you want to use to configure the agent.
$sel:agentArn: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.
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:
$sel:domain:CreateLocationFsxWindows'
, createLocationFsxWindows_domain
- The name of the Windows domain that the FSx for Windows File Server
belongs to.
$sel:subdirectory:CreateLocationFsxWindows'
, createLocationFsxWindows_subdirectory
- A subdirectory in the location’s path. This subdirectory in the Amazon
FSx for Windows File Server file system is used to read data from the
Amazon FSx for Windows File Server source location or write data to the
FSx for Windows File Server destination.
$sel:tags:CreateLocationFsxWindows'
, createLocationFsxWindows_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:CreateLocationFsxWindows'
, createLocationFsxWindows_fsxFilesystemArn
- The Amazon Resource Name (ARN) for the FSx for Windows File Server file
system.
$sel:securityGroupArns:CreateLocationFsxWindows'
, createLocationFsxWindows_securityGroupArns
- The Amazon Resource Names (ARNs) of the security groups that are to use
to configure the FSx for Windows File Server file system.
$sel:user:CreateLocationFsxWindows'
, createLocationFsxWindows_user
- The user who has the permissions to access files and folders in the FSx
for Windows File Server file system.
For information about choosing a user name that ensures sufficient permissions to files, folders, and metadata, see user.
$sel:password:CreateLocationFsxWindows'
, createLocationFsxWindows_password
- The password of the user who has the permissions to access files and
folders in the FSx for Windows File Server file system.
data CreateLocationFsxWindowsResponse Source #
See: newCreateLocationFsxWindowsResponse
smart constructor.
Instances
Eq CreateLocationFsxWindowsResponse Source # | |
Read CreateLocationFsxWindowsResponse Source # | |
Show CreateLocationFsxWindowsResponse Source # | |
Generic CreateLocationFsxWindowsResponse Source # | |
NFData CreateLocationFsxWindowsResponse Source # | |
Defined in Amazonka.DataSync.CreateLocationFsxWindows rnf :: CreateLocationFsxWindowsResponse -> () # | |
type Rep CreateLocationFsxWindowsResponse Source # | |
Defined in Amazonka.DataSync.CreateLocationFsxWindows type Rep CreateLocationFsxWindowsResponse = D1 ('MetaData "CreateLocationFsxWindowsResponse" "Amazonka.DataSync.CreateLocationFsxWindows" "libZSservicesZSamazonka-datasyncZSamazonka-datasync" '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:
$sel:locationArn:CreateLocationFsxWindowsResponse'
, createLocationFsxWindowsResponse_locationArn
- The Amazon Resource Name (ARN) of the FSx for Windows File Server file
system location that is created.
$sel:httpStatus:CreateLocationFsxWindowsResponse'
, createLocationFsxWindowsResponse_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:taskArn:ListTaskExecutions'
, listTaskExecutions_taskArn
- The Amazon Resource Name (ARN) of the task whose tasks you want to list.
$sel:nextToken:ListTaskExecutions'
, listTaskExecutions_nextToken
- An opaque string that indicates the position at which to begin the next
list of the executed tasks.
$sel:maxResults:ListTaskExecutions'
, listTaskExecutions_maxResults
- The maximum number of executed tasks 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:
$sel:nextToken: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.
UpdateTaskExecution
data UpdateTaskExecution Source #
See: newUpdateTaskExecution
smart constructor.
Instances
newUpdateTaskExecution Source #
:: Text | |
-> Options | |
-> UpdateTaskExecution |
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:
$sel:taskExecutionArn: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.
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:
$sel:agentArns:CreateLocationS3'
, createLocationS3_agentArns
- If you are 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:
$sel:locationArn: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.
CreateTask
data CreateTask Source #
CreateTaskRequest
See: newCreateTask
smart constructor.
CreateTask' (Maybe TaskSchedule) (Maybe [FilterRule]) (Maybe Text) (Maybe [FilterRule]) (Maybe Options) (Maybe Text) (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: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:includes:CreateTask'
, createTask_includes
- 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:name: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:excludes:CreateTask'
, createTask_excludes
- A list of filter rules that determines which files to exclude from a
task. The list should contain 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:options:CreateTask'
, createTask_options
- The set of configuration options that control the behavior of a single
execution of the task that occurs when you call StartTaskExecution
.
You can configure these options to preserve metadata such as user ID
(UID) and group ID (GID), file permissions, data integrity verification,
and so on.
For each individual task execution, you can override these options by
specifying the OverrideOptions
before starting the task execution. For
more information, see the
StartTaskExecution
operation.
$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:tags:CreateTask'
, createTask_tags
- The key-value pair that represents the tag that you want to add to the
resource. The value can be an empty string.
$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:
$sel:taskArn:CreateTaskResponse'
, createTaskResponse_taskArn
- The Amazon Resource Name (ARN) of the task.
$sel:httpStatus:CreateTaskResponse'
, createTaskResponse_httpStatus
- The response's http status code.
CreateLocationEfs
data CreateLocationEfs Source #
CreateLocationEfsRequest
See: newCreateLocationEfs
smart constructor.
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:subdirectory:CreateLocationEfs'
, createLocationEfs_subdirectory
- A subdirectory in the location’s path. This subdirectory in the EFS file
system is used to read data from the EFS source location or write data
to the EFS destination. By default, DataSync uses the root directory.
Subdirectory
must be specified with forward slashes. For example,
/path/to/folder
.
$sel:tags:CreateLocationEfs'
, createLocationEfs_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:efsFilesystemArn:CreateLocationEfs'
, createLocationEfs_efsFilesystemArn
- The Amazon Resource Name (ARN) for the Amazon EFS file system.
$sel:ec2Config:CreateLocationEfs'
, createLocationEfs_ec2Config
- The subnet and security group that the Amazon EFS file system uses. The
security group that you provide needs to be able to communicate with the
security group on the mount target in the subnet specified.
The exact relationship between security group M (of the mount target) and security group S (which you provide for DataSync to use at this stage) is as follows:
- Security group M (which you associate with the mount target) must allow inbound access for the Transmission Control Protocol (TCP) on the NFS port (2049) from security group S. You can enable inbound connections either by IP address (CIDR range) or security group.
Security group S (provided to DataSync to access EFS) should have a rule that enables outbound connections to the NFS port on one of the file system’s mount targets. You can enable outbound connections either by IP address (CIDR range) or security group.
For information about security groups and mount targets, see Security Groups for Amazon EC2 Instances and Mount Targets in the Amazon EFS User Guide.
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:
$sel:locationArn:CreateLocationEfsResponse'
, createLocationEfsResponse_locationArn
- The Amazon Resource Name (ARN) of the Amazon EFS file system location
that is created.
$sel:httpStatus:CreateLocationEfsResponse'
, createLocationEfsResponse_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:
$sel:locationArn:DescribeLocationObjectStorage'
, describeLocationObjectStorage_locationArn
- The Amazon Resource Name (ARN) of the self-managed object storage server
location that was described.
data DescribeLocationObjectStorageResponse Source #
DescribeLocationObjectStorageResponse
See: newDescribeLocationObjectStorageResponse
smart constructor.
DescribeLocationObjectStorageResponse' (Maybe Natural) (Maybe POSIX) (Maybe (NonEmpty Text)) (Maybe Text) (Maybe ObjectStorageServerProtocol) (Maybe Text) (Maybe Text) 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:serverPort:DescribeLocationObjectStorageResponse'
, describeLocationObjectStorageResponse_serverPort
- The port that your self-managed object storage server accepts inbound
network traffic on. The server port is set by default to TCP 80 (HTTP)
or TCP 443 (HTTPS).
$sel:creationTime:DescribeLocationObjectStorageResponse'
, describeLocationObjectStorageResponse_creationTime
- The time that the self-managed object storage server agent was created.
$sel:agentArns:DescribeLocationObjectStorageResponse'
, describeLocationObjectStorageResponse_agentArns
- The Amazon Resource Name (ARN) of the agents associated with the
self-managed object storage server location.
$sel:locationUri:DescribeLocationObjectStorageResponse'
, describeLocationObjectStorageResponse_locationUri
- The URL of the source self-managed object storage server location that
was described.
$sel:serverProtocol:DescribeLocationObjectStorageResponse'
, describeLocationObjectStorageResponse_serverProtocol
- The protocol that the object storage server uses to communicate. Valid
values are HTTP or HTTPS.
$sel:locationArn:DescribeLocationObjectStorage'
, describeLocationObjectStorageResponse_locationArn
- The Amazon Resource Name (ARN) of the self-managed object storage server
location to describe.
$sel:accessKey:DescribeLocationObjectStorageResponse'
, describeLocationObjectStorageResponse_accessKey
- Optional. The access key is used if credentials are required to access
the self-managed object storage server. If your object storage requires
a user name and password to authenticate, use AccessKey
and
SecretKey
to provide the user name and password, respectively.
$sel:httpStatus:DescribeLocationObjectStorageResponse'
, describeLocationObjectStorageResponse_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:
$sel:locationArn: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.
ListTasks (Paginated)
ListTasksRequest
See: newListTasks
smart constructor.
ListTasks' (Maybe [TaskFilter]) (Maybe Text) (Maybe Natural) |
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:nextToken:ListTasks'
, listTasks_nextToken
- An opaque string that indicates the position at which to begin the next
list of tasks.
$sel:maxResults:ListTasks'
, listTasks_maxResults
- The maximum number of tasks to return.
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:
$sel:tasks:ListTasksResponse'
, listTasksResponse_tasks
- A list of all the tasks that are returned.
$sel:nextToken:ListTasks'
, listTasksResponse_nextToken
- An opaque string that indicates the position at which to begin returning
the next list of tasks.
$sel:httpStatus:ListTasksResponse'
, listTasksResponse_httpStatus
- The response's http status code.
StartTaskExecution
data StartTaskExecution Source #
StartTaskExecutionRequest
See: newStartTaskExecution
smart constructor.
StartTaskExecution' (Maybe Options) (Maybe [FilterRule]) (Maybe [FilterRule]) 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:overrideOptions:StartTaskExecution'
, startTaskExecution_overrideOptions
- Undocumented member.
$sel:includes:StartTaskExecution'
, startTaskExecution_includes
- 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:excludes:StartTaskExecution'
, startTaskExecution_excludes
- A list of filter rules that determines which files to exclude from a
task. The list should contain 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:taskArn:StartTaskExecution'
, startTaskExecution_taskArn
- The Amazon Resource Name (ARN) of the task 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:
$sel:taskExecutionArn:StartTaskExecutionResponse'
, startTaskExecutionResponse_taskExecutionArn
- The Amazon Resource Name (ARN) of the specific task execution that was
started.
$sel:httpStatus:StartTaskExecutionResponse'
, startTaskExecutionResponse_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:
$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.
$sel:mountOptions:UpdateLocationNfs'
, updateLocationNfs_mountOptions
- Undocumented member.
$sel:locationArn: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.
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:
$sel:taskExecutionArn: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 TaskExecutionStatus) (Maybe Text) (Maybe POSIX) (Maybe Integer) (Maybe Integer) (Maybe Integer) (Maybe TaskExecutionResultDetail) (Maybe [FilterRule]) (Maybe Integer) (Maybe [FilterRule]) (Maybe Options) (Maybe Integer) 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:status: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.
$sel:taskExecutionArn: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:startTime:DescribeTaskExecutionResponse'
, describeTaskExecutionResponse_startTime
- The time that the task execution was started.
$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. 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
. This value can also be greater than
EstimatedFilesTransferred
in some cases. 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:bytesWritten:DescribeTaskExecutionResponse'
, describeTaskExecutionResponse_bytesWritten
- The number of logical bytes written to the destination Amazon Web
Services storage resource.
$sel:bytesTransferred:DescribeTaskExecutionResponse'
, describeTaskExecutionResponse_bytesTransferred
- The physical number of bytes transferred over the network.
$sel:result:DescribeTaskExecutionResponse'
, describeTaskExecutionResponse_result
- The result of the task execution.
$sel:includes:DescribeTaskExecutionResponse'
, describeTaskExecutionResponse_includes
- A list of filter rules that determines which files to include when
running a task. The list 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: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. 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 determines which files to exclude from a
task. The list should contain 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:options:DescribeTaskExecutionResponse'
, describeTaskExecutionResponse_options
- Undocumented member.
$sel:estimatedBytesToTransfer:DescribeTaskExecutionResponse'
, describeTaskExecutionResponse_estimatedBytesToTransfer
- The estimated physical number of bytes that is to be transferred over
the network.
$sel:httpStatus:DescribeTaskExecutionResponse'
, describeTaskExecutionResponse_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:
$sel:domain:CreateLocationSmb'
, createLocationSmb_domain
- The name of the Windows domain that the SMB server belongs to.
$sel:mountOptions: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.
$sel:user: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 user.
$sel:password: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.
$sel:agentArns: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:
$sel:locationArn: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.
CreateAgent
data CreateAgent Source #
CreateAgentRequest
See: newCreateAgent
smart constructor.
CreateAgent' (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe Text) (Maybe Text) (Maybe [TagListEntry]) 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:securityGroupArns:CreateAgent'
, createAgent_securityGroupArns
- The ARNs of the security groups used to protect your data transfer task
subnets. See
SecurityGroupArns.
$sel:subnetArns: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: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.
$sel:vpcEndpointId: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: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: + - = . _ : / @.
$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:
$sel:agentArn: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.
UpdateLocationObjectStorage
data UpdateLocationObjectStorage Source #
See: newUpdateLocationObjectStorage
smart constructor.
UpdateLocationObjectStorage' (Maybe Natural) (Maybe (NonEmpty Text)) (Maybe ObjectStorageServerProtocol) (Maybe (Sensitive Text)) (Maybe Text) (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:serverPort:UpdateLocationObjectStorage'
, updateLocationObjectStorage_serverPort
- The port that your self-managed object storage server accepts inbound
network traffic on. The server port is set by default to TCP 80 (HTTP)
or TCP 443 (HTTPS). You can specify a custom port if your self-managed
object storage server requires one.
$sel:agentArns:UpdateLocationObjectStorage'
, updateLocationObjectStorage_agentArns
- The Amazon Resource Name (ARN) of the agents associated with the
self-managed object storage server location.
$sel:serverProtocol:UpdateLocationObjectStorage'
, updateLocationObjectStorage_serverProtocol
- The protocol that the object storage server uses to communicate. Valid
values are HTTP
or HTTPS
.
$sel:secretKey:UpdateLocationObjectStorage'
, updateLocationObjectStorage_secretKey
- Optional. The secret key is used if credentials are required to access
the self-managed object storage server. If your object storage requires
a user name and password to authenticate, use AccessKey
and
SecretKey
to provide the user name and password, respectively.
$sel:subdirectory:UpdateLocationObjectStorage'
, updateLocationObjectStorage_subdirectory
- The subdirectory in the self-managed object storage server that is used
to read data from.
$sel:accessKey:UpdateLocationObjectStorage'
, updateLocationObjectStorage_accessKey
- Optional. The access key is used if credentials are required to access
the self-managed object storage server. If your object storage requires
a user name and password to authenticate, use AccessKey
and
SecretKey
to provide the user name and password, respectively.
$sel:locationArn:UpdateLocationObjectStorage'
, updateLocationObjectStorage_locationArn
- The Amazon Resource Name (ARN) of the self-managed object storage server
location to be updated.
data UpdateLocationObjectStorageResponse Source #
See: newUpdateLocationObjectStorageResponse
smart constructor.
Instances
Eq UpdateLocationObjectStorageResponse Source # | |
Read UpdateLocationObjectStorageResponse Source # | |
Show UpdateLocationObjectStorageResponse Source # | |
Generic UpdateLocationObjectStorageResponse Source # | |
NFData UpdateLocationObjectStorageResponse Source # | |
Defined in Amazonka.DataSync.UpdateLocationObjectStorage rnf :: UpdateLocationObjectStorageResponse -> () # | |
type Rep UpdateLocationObjectStorageResponse Source # | |
Defined in Amazonka.DataSync.UpdateLocationObjectStorage type Rep UpdateLocationObjectStorageResponse = D1 ('MetaData "UpdateLocationObjectStorageResponse" "Amazonka.DataSync.UpdateLocationObjectStorage" "libZSservicesZSamazonka-datasyncZSamazonka-datasync" '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.
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:
$sel:locationArn:DescribeLocationEfs'
, describeLocationEfs_locationArn
- The Amazon Resource Name (ARN) of the EFS location to describe.
data DescribeLocationEfsResponse Source #
DescribeLocationEfsResponse
See: newDescribeLocationEfsResponse
smart constructor.
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:creationTime:DescribeLocationEfsResponse'
, describeLocationEfsResponse_creationTime
- The time that the EFS location was created.
$sel:locationUri:DescribeLocationEfsResponse'
, describeLocationEfsResponse_locationUri
- The URL of the EFS location that was described.
$sel:locationArn:DescribeLocationEfs'
, describeLocationEfsResponse_locationArn
- The Amazon Resource Name (ARN) of the EFS location that was described.
$sel:ec2Config:DescribeLocationEfsResponse'
, describeLocationEfsResponse_ec2Config
- Undocumented member.
$sel:httpStatus:DescribeLocationEfsResponse'
, describeLocationEfsResponse_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
- The Amazon Resource Name (ARN) of the resource to apply the tag to.
$sel:tags:TagResource'
, tagResource_tags
- The tags to apply.
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
- The Amazon Resource Name (ARN) of the resource to remove the tag from.
$sel:keys:UntagResource'
, untagResource_keys
- The keys in the key-value pair in the tag 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.
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:
$sel:locationArn: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 OnPremConfig) (Maybe NfsMountOptions) (Maybe Text) 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.
$sel:locationUri:DescribeLocationNfsResponse'
, describeLocationNfsResponse_locationUri
- The URL of the source NFS location that was described.
$sel:onPremConfig:DescribeLocationNfsResponse'
, describeLocationNfsResponse_onPremConfig
- Undocumented member.
$sel:mountOptions:DescribeLocationNfsResponse'
, describeLocationNfsResponse_mountOptions
- The NFS mount options that DataSync used to mount your NFS share.
$sel:locationArn:DescribeLocationNfs'
, describeLocationNfsResponse_locationArn
- The Amazon Resource Name (ARN) of the NFS location that was described.
$sel:httpStatus:DescribeLocationNfsResponse'
, describeLocationNfsResponse_httpStatus
- The response's http status code.
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:
$sel:taskExecutionArn:CancelTaskExecution'
, cancelTaskExecution_taskExecutionArn
- The Amazon Resource Name (ARN) of the task execution to cancel.
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.
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
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
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
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_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:status:AgentListEntry'
, agentListEntry_status
- The status of the agent.
$sel:agentArn:AgentListEntry'
, agentListEntry_agentArn
- The Amazon Resource Name (ARN) of the agent.
$sel:name:AgentListEntry'
, agentListEntry_name
- The name of the agent.
Ec2Config
The subnet and the security group that DataSync uses to access target EFS file system. The subnet must have at least one mount target for that file system. The security group that you provide needs to be able to communicate with the security group on the mount target in the subnet specified.
See: newEc2Config
smart constructor.
Instances
Eq Ec2Config Source # | |
Read Ec2Config Source # | |
Show Ec2Config Source # | |
Generic Ec2Config Source # | |
NFData Ec2Config Source # | |
Defined in Amazonka.DataSync.Types.Ec2Config | |
Hashable Ec2Config Source # | |
Defined in Amazonka.DataSync.Types.Ec2Config | |
ToJSON Ec2Config Source # | |
Defined in Amazonka.DataSync.Types.Ec2Config | |
FromJSON Ec2Config Source # | |
type Rep Ec2Config Source # | |
Defined in Amazonka.DataSync.Types.Ec2Config type Rep Ec2Config = D1 ('MetaData "Ec2Config" "Amazonka.DataSync.Types.Ec2Config" "libZSservicesZSamazonka-datasyncZSamazonka-datasync" '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
- The ARN of the subnet and the security group that DataSync uses to
access the target EFS file system.
$sel:securityGroupArns:Ec2Config'
, ec2Config_securityGroupArns
- The Amazon Resource Names (ARNs) of the security groups that are
configured for the Amazon EC2 resource.
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
LocationFilter
data LocationFilter Source #
You can use API filters to narrow down the list of resources returned by
ListLocations
. For example, to retrieve all your Amazon S3 locations,
you can use ListLocations
with filter name LocationType S3
and
Operator Equals
.
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
). For more about API filtering operators, see
API filters for ListTasks and ListLocations.
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:locationUri:LocationListEntry'
, locationListEntry_locationUri
- Represents a list of URLs 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. Valid values: NFS | EFS | 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 host name 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.
$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.
NfsMountOptions
data NfsMountOptions Source #
Represents the mount options that are available for DataSync to access an NFS location.
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
- The specific NFS version that you want DataSync to use to mount your NFS
share. If the server refuses to use the version specified, the sync will
fail. If you don't specify a version, DataSync defaults to AUTOMATIC
.
That is, DataSync automatically selects a version based on negotiation
with the NFS server.
You can specify the following NFS versions:
- NFSv3 - stateless protocol version that allows for asynchronous writes on the server.
- NFSv4.0 - stateful, firewall-friendly protocol version that supports delegations and pseudo filesystems.
- NFSv4.1 - stateful protocol version that supports sessions, directory delegations, and parallel data processing. Version 4.1 also includes all features available in version 4.0.
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
Represents the options that are available to control the behavior of a StartTaskExecution operation. Behavior includes preserving metadata such as user ID (UID), group ID (GID), and file permissions, and also overwriting files in the destination, data integrity verification, and so on.
A task has a set of default options associated with it. If you don't
specify an option in
StartTaskExecution,
the default value is used. You can override the defaults options on each
task execution by specifying an overriding Options
value to
StartTaskExecution.
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
- A file metadata value that shows the last time a file was accessed (that
is, when the 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). However, Atime
's behavior is not 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:verifyMode:Options'
, options_verifyMode
- A value that determines whether a data integrity verification should be
performed at the end of a task execution after all data and metadata
have been transferred. For more information, see
Configure task settings.
Default value: POINT_IN_TIME_CONSISTENT.
ONLY_FILES_TRANSFERRED (recommended): Perform verification only on files that were transferred.
POINT_IN_TIME_CONSISTENT: Scan the entire source and entire destination at the end of the transfer to verify that source and destination are fully synchronized. This option isn't supported when transferring to S3 Glacier or S3 Glacier Deep Archive storage classes.
NONE: No additional verification is done at the end of the transfer, but all data transmissions are integrity-checked with checksum verification during the transfer.
$sel:taskQueueing:Options'
, options_taskQueueing
- A value that determines whether tasks should be queued before executing
the tasks. If set to ENABLED
, the tasks will be queued. The default is
ENABLED
.
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:logLevel:Options'
, options_logLevel
- A value that determines the type of logs that DataSync publishes to a
log stream in the Amazon CloudWatch log group that you provide. For more
information about providing a log group for DataSync, see
CloudWatchLogGroupArn.
If set to OFF
, no logs are published. BASIC
publishes logs on errors
for individual files transferred, and TRANSFER
publishes logs for
every file or object that is transferred and integrity checked.
$sel:posixPermissions:Options'
, options_posixPermissions
- A value that determines which users or groups can access a file for a
specific purpose such as reading, writing, or execution of the file.
This option should only be set for NFS, EFS, and S3 locations. For more
information about what metadata is copied by DataSync, 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:mtime:Options'
, options_mtime
- A value that indicates the last time that a file was modified (that is,
a file was written to) before the PREPARING phase. This option is
required for cases when you need to run the same task more than one
time.
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:uid:Options'
, options_uid
- The POSIX user ID (UID) of the file's owner. This option should only be
set for NFS, EFS, and S3 locations. To learn more about what metadata is
copied by DataSync, 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:bytesPerSecond:Options'
, options_bytesPerSecond
- A value that limits the bandwidth used by DataSync. For example, if you
want DataSync to use a maximum of 1 MB, set this value to 1048576
(=1024*1024
).
$sel:securityDescriptorCopyFlags:Options'
, options_securityDescriptorCopyFlags
- A value that determines 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 Amazon FSx for Windows File Server locations. For more information about how DataSync handles metadata, see How DataSync Handles Metadata and Special Files.
Default value: OWNER_DACL.
OWNER_DACL: For each copied object, DataSync copies the following metadata:
- Object owner.
- NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object.
When choosing this option, DataSync does NOT copy the NTFS system access control lists (SACLs), which are used by administrators to log attempts to access a secured object.
OWNER_DACL_SACL: For each copied object, DataSync copies the following metadata:
- Object owner.
- NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object.
- NTFS system access control lists (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:gid:Options'
, options_gid
- The POSIX group ID (GID) of the file's owners. This option should only
be set for NFS, EFS, and S3 locations. For more information about what
metadata is copied by DataSync, 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:overwriteMode:Options'
, options_overwriteMode
- A value that determines whether files at the destination should be
overwritten or preserved when copying files. If set to NEVER
a
destination file 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 S3 storage cost. For detailed information, see Considerations when working with Amazon S3 storage classes in DataSync in the DataSync User Guide.
$sel:transferMode:Options'
, options_transferMode
- A value that determines whether DataSync transfers only the data and
metadata that differ between the source and the destination location, or
whether DataSync transfers all the content from the source, without
comparing to the destination location.
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 to existing content on the destination.
$sel:preserveDeletedFiles:Options'
, options_preserveDeletedFiles
- A value that specifies whether files in the destination that don't
exist in the source file system should be preserved. This option can
affect your 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
in the DataSync User Guide.
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
- A value that determines whether DataSync should preserve the metadata of
block and character devices in the source file system, and re-create the
files with that device name and metadata on the destination. DataSync
does not copy the contents of such devices, only the name and metadata.
DataSync can't sync the actual contents of such devices, because they are 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 isn't currently supported for Amazon EFS.
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: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: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: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.
S3Config
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that is 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
Eq S3Config Source # | |
Read S3Config Source # | |
Show S3Config Source # | |
Generic S3Config Source # | |
NFData S3Config Source # | |
Defined in Amazonka.DataSync.Types.S3Config | |
Hashable S3Config Source # | |
Defined in Amazonka.DataSync.Types.S3Config | |
ToJSON S3Config Source # | |
Defined in Amazonka.DataSync.Types.S3Config | |
FromJSON S3Config Source # | |
type Rep S3Config Source # | |
Defined in Amazonka.DataSync.Types.S3Config type Rep S3Config = D1 ('MetaData "S3Config" "Amazonka.DataSync.Types.S3Config" "libZSservicesZSamazonka-datasyncZSamazonka-datasync" 'False) (C1 ('MetaCons "S3Config'" 'PrefixI 'True) (S1 ('MetaSel ('Just "bucketAccessRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) |
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 Amazon S3 bucket to access. This bucket is used as a parameter in
the
CreateLocationS3
operation.
SmbMountOptions
data SmbMountOptions Source #
Represents the mount options that are available for DataSync to access an SMB location.
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
- The specific SMB version that you want DataSync to use to mount your SMB
share. If you don't specify a version, DataSync defaults to
AUTOMATIC
. That is, DataSync automatically selects a version based on
negotiation with the SMB server.
TagListEntry
data TagListEntry Source #
Represents a single entry in a list of AWS resource tags. TagListEntry
returns an array that contains a list of tasks when the
ListTagsForResource
operation is called.
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 Natural) (Maybe PhaseStatus) (Maybe PhaseStatus) (Maybe Natural) (Maybe Natural) (Maybe PhaseStatus) (Maybe Text) (Maybe Natural) (Maybe Text) |
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: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:verifyStatus:TaskExecutionResultDetail'
, taskExecutionResultDetail_verifyStatus
- The status of the VERIFYING phase.
$sel:verifyDuration:TaskExecutionResultDetail'
, taskExecutionResultDetail_verifyDuration
- The total time in milliseconds that DataSync spent in the VERIFYING
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:transferStatus:TaskExecutionResultDetail'
, taskExecutionResultDetail_transferStatus
- The status of the TRANSFERRING phase.
$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:transferDuration:TaskExecutionResultDetail'
, taskExecutionResultDetail_transferDuration
- The total time in milliseconds that DataSync spent in the TRANSFERRING
phase.
$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.
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.
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
). For more about API filtering operators, see
API filters for ListTasks and ListLocations.
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 TaskStatus) (Maybe Text) (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:status:TaskListEntry'
, taskListEntry_status
- The status of the task.
$sel:taskArn:TaskListEntry'
, taskListEntry_taskArn
- The Amazon Resource Name (ARN) of the task.
$sel:name:TaskListEntry'
, taskListEntry_name
- The name 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.