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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates the metadata associated with a task.

Synopsis

data UpdateTask = UpdateTask' {
- schedule :: Maybe TaskSchedule
- includes :: Maybe [FilterRule]
- name :: Maybe Text
- excludes :: Maybe [FilterRule]
- options :: Maybe Options
- cloudWatchLogGroupArn :: Maybe Text
- taskArn :: Text
}
newUpdateTask :: Text -> UpdateTask
updateTask_schedule :: Lens' UpdateTask (Maybe TaskSchedule)
updateTask_includes :: Lens' UpdateTask (Maybe [FilterRule])
updateTask_name :: Lens' UpdateTask (Maybe Text)
updateTask_excludes :: Lens' UpdateTask (Maybe [FilterRule])
updateTask_options :: Lens' UpdateTask (Maybe Options)
updateTask_cloudWatchLogGroupArn :: Lens' UpdateTask (Maybe Text)
updateTask_taskArn :: Lens' UpdateTask Text
data UpdateTaskResponse = UpdateTaskResponse' {
- httpStatus :: Int
}
newUpdateTaskResponse :: Int -> UpdateTaskResponse
updateTaskResponse_httpStatus :: Lens' UpdateTaskResponse Int

Creating a Request

data UpdateTask Source #

UpdateTaskResponse

See: newUpdateTask smart constructor.

Constructors

UpdateTask'

Fields

schedule :: Maybe TaskSchedule
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.
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"
name :: Maybe Text
The name of the task to update.
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"
options :: Maybe Options
cloudWatchLogGroupArn :: Maybe Text
The Amazon Resource Name (ARN) of the resource name of the CloudWatch LogGroup.
taskArn :: Text
The Amazon Resource Name (ARN) of the resource name of the task to update.

Instances

Instances details

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

newUpdateTask Source #

Arguments

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

Create a value of UpdateTask with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel: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.

Request Lenses

updateTask_schedule :: Lens' UpdateTask (Maybe TaskSchedule) Source #

Specifies a schedule used to periodically transfer files from a source to a destination location. You can configure your task to execute hourly, daily, weekly or on specific days of the week. You control when in the day or hour you want the task to execute. The time you specify is UTC time. For more information, see Scheduling your task.

updateTask_includes :: Lens' UpdateTask (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"

updateTask_name :: Lens' UpdateTask (Maybe Text) Source #

The name of the task to update.

updateTask_excludes :: Lens' UpdateTask (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"

updateTask_options :: Lens' UpdateTask (Maybe Options) Source #

Undocumented member.

updateTask_cloudWatchLogGroupArn :: Lens' UpdateTask (Maybe Text) Source #

The Amazon Resource Name (ARN) of the resource name of the CloudWatch LogGroup.

updateTask_taskArn :: Lens' UpdateTask Text Source #

The Amazon Resource Name (ARN) of the resource name of the task to update.

Destructuring the Response

data UpdateTaskResponse Source #

See: newUpdateTaskResponse smart constructor.

Constructors

UpdateTaskResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

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

newUpdateTaskResponse Source #

Arguments

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

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.

Response Lenses

updateTaskResponse_httpStatus :: Lens' UpdateTaskResponse Int Source #

The response's http status code.