Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Starts an DataSync task. For each task, you can only run one task execution at a time.
There are several phases to a task execution. For more information, see Task execution statuses.
Synopsis
- data StartTaskExecution = StartTaskExecution' {
- excludes :: Maybe [FilterRule]
- includes :: Maybe [FilterRule]
- overrideOptions :: Maybe Options
- tags :: Maybe [TagListEntry]
- taskArn :: Text
- newStartTaskExecution :: Text -> StartTaskExecution
- startTaskExecution_excludes :: Lens' StartTaskExecution (Maybe [FilterRule])
- startTaskExecution_includes :: Lens' StartTaskExecution (Maybe [FilterRule])
- startTaskExecution_overrideOptions :: Lens' StartTaskExecution (Maybe Options)
- startTaskExecution_tags :: Lens' StartTaskExecution (Maybe [TagListEntry])
- startTaskExecution_taskArn :: Lens' StartTaskExecution Text
- data StartTaskExecutionResponse = StartTaskExecutionResponse' {}
- newStartTaskExecutionResponse :: Int -> StartTaskExecutionResponse
- startTaskExecutionResponse_taskExecutionArn :: Lens' StartTaskExecutionResponse (Maybe Text)
- startTaskExecutionResponse_httpStatus :: Lens' StartTaskExecutionResponse Int
Creating a Request
data StartTaskExecution Source #
StartTaskExecutionRequest
See: newStartTaskExecution
smart constructor.
StartTaskExecution' | |
|
Instances
newStartTaskExecution Source #
Create a value of StartTaskExecution
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:excludes:StartTaskExecution'
, startTaskExecution_excludes
- Specifies a list of filter rules that determines which files to exclude
from a task. The list contains a single filter string that consists of
the patterns to exclude. The patterns are delimited by "|" (that is, a
pipe), for example, "/folder1|/folder2"
.
$sel:includes:StartTaskExecution'
, startTaskExecution_includes
- Specifies a list of filter rules that determines which files to include
when running a task. The pattern should contain a single filter string
that consists of the patterns to include. The patterns are delimited by
"|" (that is, a pipe), for example, "/folder1|/folder2"
.
$sel:overrideOptions:StartTaskExecution'
, startTaskExecution_overrideOptions
- Undocumented member.
$sel:tags:StartTaskExecution'
, startTaskExecution_tags
- Specifies the tags that you want to apply to the Amazon Resource Name
(ARN) representing the task execution.
Tags are key-value pairs that help you manage, filter, and search for your DataSync resources.
StartTaskExecution
, startTaskExecution_taskArn
- Specifies the Amazon Resource Name (ARN) of the task that you want to
start.
Request Lenses
startTaskExecution_excludes :: Lens' StartTaskExecution (Maybe [FilterRule]) Source #
Specifies a list of filter rules that determines which files to exclude
from a task. The list contains a single filter string that consists of
the patterns to exclude. The patterns are delimited by "|" (that is, a
pipe), for example, "/folder1|/folder2"
.
startTaskExecution_includes :: Lens' StartTaskExecution (Maybe [FilterRule]) Source #
Specifies a list of filter rules that determines which files to include
when running a task. The pattern should contain a single filter string
that consists of the patterns to include. The patterns are delimited by
"|" (that is, a pipe), for example, "/folder1|/folder2"
.
startTaskExecution_overrideOptions :: Lens' StartTaskExecution (Maybe Options) Source #
Undocumented member.
startTaskExecution_tags :: Lens' StartTaskExecution (Maybe [TagListEntry]) Source #
Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing the task execution.
Tags are key-value pairs that help you manage, filter, and search for your DataSync resources.
startTaskExecution_taskArn :: Lens' StartTaskExecution Text Source #
Specifies the Amazon Resource Name (ARN) of the task that you want to start.
Destructuring the Response
data StartTaskExecutionResponse Source #
StartTaskExecutionResponse
See: newStartTaskExecutionResponse
smart constructor.
StartTaskExecutionResponse' | |
|
Instances
newStartTaskExecutionResponse Source #
Create a value of StartTaskExecutionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
StartTaskExecutionResponse
, startTaskExecutionResponse_taskExecutionArn
- The ARN of the running task execution.
$sel:httpStatus:StartTaskExecutionResponse'
, startTaskExecutionResponse_httpStatus
- The response's http status code.
Response Lenses
startTaskExecutionResponse_taskExecutionArn :: Lens' StartTaskExecutionResponse (Maybe Text) Source #
The ARN of the running task execution.
startTaskExecutionResponse_httpStatus :: Lens' StartTaskExecutionResponse Int Source #
The response's http status code.