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

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' {
- cloudWatchLogGroupArn :: Maybe Text
- excludes :: Maybe [FilterRule]
- includes :: Maybe [FilterRule]
- name :: Maybe Text
- options :: Maybe Options
- schedule :: Maybe TaskSchedule
- taskArn :: Text
}
newUpdateTask :: Text -> UpdateTask
updateTask_cloudWatchLogGroupArn :: Lens' UpdateTask (Maybe Text)
updateTask_excludes :: Lens' UpdateTask (Maybe [FilterRule])
updateTask_includes :: Lens' UpdateTask (Maybe [FilterRule])
updateTask_name :: Lens' UpdateTask (Maybe Text)
updateTask_options :: Lens' UpdateTask (Maybe Options)
updateTask_schedule :: Lens' UpdateTask (Maybe TaskSchedule)
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

cloudWatchLogGroupArn :: Maybe Text
The Amazon Resource Name (ARN) of the resource name of the Amazon CloudWatch log group.
excludes :: Maybe [FilterRule]
Specifies a list of filter rules that exclude specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.
includes :: Maybe [FilterRule]
Specifies a list of filter rules that include specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.
name :: Maybe Text
The name of the task to update.
options :: Maybe Options
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.
taskArn :: Text
The Amazon Resource Name (ARN) of the resource name of the task to update.

Instances

Instances details

ToJSON UpdateTask Source #
Instance details Defined in Amazonka.DataSync.UpdateTask Methods toJSON :: UpdateTask -> Value # toEncoding :: UpdateTask -> Encoding # toJSONList :: [UpdateTask] -> Value # toEncodingList :: [UpdateTask] -> Encoding #
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 #
AWSRequest UpdateTask Source #
Instance details Defined in Amazonka.DataSync.UpdateTask Associated Types type AWSResponse UpdateTask # Methods request :: (Service -> Service) -> UpdateTask -> Request UpdateTask # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateTask -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateTask))) #
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 #
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 #
NFData UpdateTask Source #
Instance details Defined in Amazonka.DataSync.UpdateTask Methods rnf :: UpdateTask -> () #
Eq UpdateTask Source #
Instance details Defined in Amazonka.DataSync.UpdateTask Methods (==) :: UpdateTask -> UpdateTask -> Bool # (/=) :: UpdateTask -> UpdateTask -> Bool #
Hashable UpdateTask Source #
Instance details Defined in Amazonka.DataSync.UpdateTask Methods hashWithSalt :: Int -> UpdateTask -> Int # hash :: UpdateTask -> Int #
type AWSResponse UpdateTask Source #
Instance details Defined in Amazonka.DataSync.UpdateTask type AWSResponse UpdateTask = UpdateTaskResponse
type Rep UpdateTask Source #
Instance details Defined in Amazonka.DataSync.UpdateTask type Rep UpdateTask = D1 ('MetaData "UpdateTask" "Amazonka.DataSync.UpdateTask" "amazonka-datasync-2.0-LCcm4ddRe2z4CES4wun76Z" 'False) (C1 ('MetaCons "UpdateTask'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "cloudWatchLogGroupArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "excludes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [FilterRule])) :: S1 ('MetaSel ('Just "includes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [FilterRule])))) :: ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "options") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Options))) :: (S1 ('MetaSel ('Just "schedule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TaskSchedule)) :: S1 ('MetaSel ('Just "taskArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newUpdateTask Source #

Arguments

:: Text	`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:cloudWatchLogGroupArn:UpdateTask', updateTask_cloudWatchLogGroupArn - The Amazon Resource Name (ARN) of the resource name of the Amazon CloudWatch log group.

$sel:excludes:UpdateTask', updateTask_excludes - Specifies a list of filter rules that exclude specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.

$sel:includes:UpdateTask', updateTask_includes - Specifies a list of filter rules that include specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.

UpdateTask, updateTask_name - The name of the task to update.

$sel:options:UpdateTask', updateTask_options - Undocumented member.

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

UpdateTask, updateTask_taskArn - The Amazon Resource Name (ARN) of the resource name of the task to update.

Request Lenses

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

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

updateTask_excludes :: Lens' UpdateTask (Maybe [FilterRule]) Source #

Specifies a list of filter rules that exclude specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.

updateTask_includes :: Lens' UpdateTask (Maybe [FilterRule]) Source #

Specifies a list of filter rules that include specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.

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

The name of the task to update.

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

Undocumented member.

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_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

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 #
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 #
NFData UpdateTaskResponse Source #
Instance details Defined in Amazonka.DataSync.UpdateTask Methods rnf :: UpdateTaskResponse -> () #
Eq UpdateTaskResponse Source #
Instance details Defined in Amazonka.DataSync.UpdateTask Methods (==) :: UpdateTaskResponse -> UpdateTaskResponse -> Bool # (/=) :: UpdateTaskResponse -> UpdateTaskResponse -> Bool #
type Rep UpdateTaskResponse Source #
Instance details Defined in Amazonka.DataSync.UpdateTask type Rep UpdateTaskResponse = D1 ('MetaData "UpdateTaskResponse" "Amazonka.DataSync.UpdateTask" "amazonka-datasync-2.0-LCcm4ddRe2z4CES4wun76Z" '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.