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

Amazonka.DataSync.StartTaskExecution

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Starts a specific invocation of a task. A TaskExecution value represents an individual run of a task. Each task can have at most one TaskExecution at a time.

TaskExecution has the following transition phases: INITIALIZING | PREPARING | TRANSFERRING | VERIFYING | SUCCESS/FAILURE.

For detailed information, see the Task Execution section in the Components and Terminology topic in the DataSync User Guide.

Synopsis

data StartTaskExecution = StartTaskExecution' {
- overrideOptions :: Maybe Options
- includes :: Maybe [FilterRule]
- excludes :: Maybe [FilterRule]
- taskArn :: Text
}
newStartTaskExecution :: Text -> StartTaskExecution
startTaskExecution_overrideOptions :: Lens' StartTaskExecution (Maybe Options)
startTaskExecution_includes :: Lens' StartTaskExecution (Maybe [FilterRule])
startTaskExecution_excludes :: Lens' StartTaskExecution (Maybe [FilterRule])
startTaskExecution_taskArn :: Lens' StartTaskExecution Text
data StartTaskExecutionResponse = StartTaskExecutionResponse' {
- taskExecutionArn :: Maybe Text
- httpStatus :: Int
}
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.

Constructors

StartTaskExecution'

Fields

overrideOptions :: Maybe Options
includes :: Maybe [FilterRule]
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"
excludes :: Maybe [FilterRule]
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".
taskArn :: Text
The Amazon Resource Name (ARN) of the task to start.

Instances

Instances details

Eq StartTaskExecution Source #
Instance details Defined in Amazonka.DataSync.StartTaskExecution Methods (==) :: StartTaskExecution -> StartTaskExecution -> Bool # (/=) :: StartTaskExecution -> StartTaskExecution -> Bool #
Read StartTaskExecution Source #
Instance details Defined in Amazonka.DataSync.StartTaskExecution Methods readsPrec :: Int -> ReadS StartTaskExecution # readList :: ReadS [StartTaskExecution] # readPrec :: ReadPrec StartTaskExecution # readListPrec :: ReadPrec [StartTaskExecution] #
Show StartTaskExecution Source #
Instance details Defined in Amazonka.DataSync.StartTaskExecution Methods showsPrec :: Int -> StartTaskExecution -> ShowS # show :: StartTaskExecution -> String # showList :: [StartTaskExecution] -> ShowS #
Generic StartTaskExecution Source #
Instance details Defined in Amazonka.DataSync.StartTaskExecution Associated Types type Rep StartTaskExecution :: Type -> Type # Methods from :: StartTaskExecution -> Rep StartTaskExecution x # to :: Rep StartTaskExecution x -> StartTaskExecution #
NFData StartTaskExecution Source #
Instance details Defined in Amazonka.DataSync.StartTaskExecution Methods rnf :: StartTaskExecution -> () #
Hashable StartTaskExecution Source #
Instance details Defined in Amazonka.DataSync.StartTaskExecution Methods hashWithSalt :: Int -> StartTaskExecution -> Int # hash :: StartTaskExecution -> Int #
ToJSON StartTaskExecution Source #
Instance details Defined in Amazonka.DataSync.StartTaskExecution Methods toJSON :: StartTaskExecution -> Value # toEncoding :: StartTaskExecution -> Encoding # toJSONList :: [StartTaskExecution] -> Value # toEncodingList :: [StartTaskExecution] -> Encoding #
AWSRequest StartTaskExecution Source #
Instance details Defined in Amazonka.DataSync.StartTaskExecution Associated Types type AWSResponse StartTaskExecution # Methods request :: StartTaskExecution -> Request StartTaskExecution # response :: MonadResource m => Logger -> Service -> Proxy StartTaskExecution -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartTaskExecution))) #
ToHeaders StartTaskExecution Source #
Instance details Defined in Amazonka.DataSync.StartTaskExecution Methods toHeaders :: StartTaskExecution -> [Header] #
ToPath StartTaskExecution Source #
Instance details Defined in Amazonka.DataSync.StartTaskExecution Methods toPath :: StartTaskExecution -> ByteString #
ToQuery StartTaskExecution Source #
Instance details Defined in Amazonka.DataSync.StartTaskExecution Methods toQuery :: StartTaskExecution -> QueryString #
type Rep StartTaskExecution Source #
Instance details Defined in Amazonka.DataSync.StartTaskExecution type Rep StartTaskExecution = D1 ('MetaData "StartTaskExecution" "Amazonka.DataSync.StartTaskExecution" "libZSservicesZSamazonka-datasyncZSamazonka-datasync" 'False) (C1 ('MetaCons "StartTaskExecution'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "overrideOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Options)) :: S1 ('MetaSel ('Just "includes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [FilterRule]))) :: (S1 ('MetaSel ('Just "excludes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [FilterRule])) :*: S1 ('MetaSel ('Just "taskArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse StartTaskExecution Source #
Instance details Defined in Amazonka.DataSync.StartTaskExecution type AWSResponse StartTaskExecution = StartTaskExecutionResponse

newStartTaskExecution Source #

Arguments

:: Text	`$sel:taskArn:StartTaskExecution'`
-> StartTaskExecution

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.

Request Lenses

startTaskExecution_overrideOptions :: Lens' StartTaskExecution (Maybe Options) Source #

Undocumented member.

startTaskExecution_includes :: Lens' StartTaskExecution (Maybe [FilterRule]) Source #

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_excludes :: Lens' StartTaskExecution (Maybe [FilterRule]) Source #

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".

startTaskExecution_taskArn :: Lens' StartTaskExecution Text Source #

The Amazon Resource Name (ARN) of the task to start.

Destructuring the Response

data StartTaskExecutionResponse Source #

StartTaskExecutionResponse

See: newStartTaskExecutionResponse smart constructor.

Constructors

StartTaskExecutionResponse'
Fields taskExecutionArn :: Maybe Text The Amazon Resource Name (ARN) of the specific task execution that was started. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq StartTaskExecutionResponse Source #
Instance details Defined in Amazonka.DataSync.StartTaskExecution Methods (==) :: StartTaskExecutionResponse -> StartTaskExecutionResponse -> Bool # (/=) :: StartTaskExecutionResponse -> StartTaskExecutionResponse -> Bool #
Read StartTaskExecutionResponse Source #
Instance details Defined in Amazonka.DataSync.StartTaskExecution Methods readsPrec :: Int -> ReadS StartTaskExecutionResponse # readList :: ReadS [StartTaskExecutionResponse] # readPrec :: ReadPrec StartTaskExecutionResponse # readListPrec :: ReadPrec [StartTaskExecutionResponse] #
Show StartTaskExecutionResponse Source #
Instance details Defined in Amazonka.DataSync.StartTaskExecution Methods showsPrec :: Int -> StartTaskExecutionResponse -> ShowS # show :: StartTaskExecutionResponse -> String # showList :: [StartTaskExecutionResponse] -> ShowS #
Generic StartTaskExecutionResponse Source #
Instance details Defined in Amazonka.DataSync.StartTaskExecution Associated Types type Rep StartTaskExecutionResponse :: Type -> Type # Methods from :: StartTaskExecutionResponse -> Rep StartTaskExecutionResponse x # to :: Rep StartTaskExecutionResponse x -> StartTaskExecutionResponse #
NFData StartTaskExecutionResponse Source #
Instance details Defined in Amazonka.DataSync.StartTaskExecution Methods rnf :: StartTaskExecutionResponse -> () #
type Rep StartTaskExecutionResponse Source #
Instance details Defined in Amazonka.DataSync.StartTaskExecution type Rep StartTaskExecutionResponse = D1 ('MetaData "StartTaskExecutionResponse" "Amazonka.DataSync.StartTaskExecution" "libZSservicesZSamazonka-datasyncZSamazonka-datasync" 'False) (C1 ('MetaCons "StartTaskExecutionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "taskExecutionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStartTaskExecutionResponse Source #

Arguments

:: Int	`$sel:httpStatus:StartTaskExecutionResponse'`
-> StartTaskExecutionResponse

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.

Response Lenses

startTaskExecutionResponse_taskExecutionArn :: Lens' StartTaskExecutionResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the specific task execution that was started.

startTaskExecutionResponse_httpStatus :: Lens' StartTaskExecutionResponse Int Source #

The response's http status code.