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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Configures a task, which defines where and how DataSync transfers your data.

A task includes a source location, a destination location, and the preferences for how and when you want to transfer your data (such as bandwidth limits, scheduling, among other options).

Synopsis

data CreateTask = CreateTask' {
- cloudWatchLogGroupArn :: Maybe Text
- excludes :: Maybe [FilterRule]
- includes :: Maybe [FilterRule]
- name :: Maybe Text
- options :: Maybe Options
- schedule :: Maybe TaskSchedule
- tags :: Maybe [TagListEntry]
- sourceLocationArn :: Text
- destinationLocationArn :: Text
}
newCreateTask :: Text -> Text -> CreateTask
createTask_cloudWatchLogGroupArn :: Lens' CreateTask (Maybe Text)
createTask_excludes :: Lens' CreateTask (Maybe [FilterRule])
createTask_includes :: Lens' CreateTask (Maybe [FilterRule])
createTask_name :: Lens' CreateTask (Maybe Text)
createTask_options :: Lens' CreateTask (Maybe Options)
createTask_schedule :: Lens' CreateTask (Maybe TaskSchedule)
createTask_tags :: Lens' CreateTask (Maybe [TagListEntry])
createTask_sourceLocationArn :: Lens' CreateTask Text
createTask_destinationLocationArn :: Lens' CreateTask Text
data CreateTaskResponse = CreateTaskResponse' {
- taskArn :: Maybe Text
- httpStatus :: Int
}
newCreateTaskResponse :: Int -> CreateTaskResponse
createTaskResponse_taskArn :: Lens' CreateTaskResponse (Maybe Text)
createTaskResponse_httpStatus :: Lens' CreateTaskResponse Int

Creating a Request

data CreateTask Source #

CreateTaskRequest

See: newCreateTask smart constructor.

Constructors

CreateTask'

Fields

cloudWatchLogGroupArn :: Maybe Text
The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor and log events in the task.
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 a task. This value is a text reference that is used to identify the task in the console.
options :: Maybe Options
Specifies the configuration options for a task. Some options include preserving file or object metadata and verifying data integrity.
You can also override these options before starting an individual run of a task (also known as a task execution). For more information, see StartTaskExecution.
schedule :: Maybe TaskSchedule
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.
tags :: Maybe [TagListEntry]
Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing the task.
Tags are key-value pairs that help you manage, filter, and search for your DataSync resources.
sourceLocationArn :: Text
The Amazon Resource Name (ARN) of the source location for the task.
destinationLocationArn :: Text
The Amazon Resource Name (ARN) of an Amazon Web Services storage resource's location.

Instances

Instances details

ToJSON CreateTask Source #
Instance details Defined in Amazonka.DataSync.CreateTask Methods toJSON :: CreateTask -> Value # toEncoding :: CreateTask -> Encoding # toJSONList :: [CreateTask] -> Value # toEncodingList :: [CreateTask] -> Encoding #
ToHeaders CreateTask Source #
Instance details Defined in Amazonka.DataSync.CreateTask Methods toHeaders :: CreateTask -> [Header] #
ToPath CreateTask Source #
Instance details Defined in Amazonka.DataSync.CreateTask Methods toPath :: CreateTask -> ByteString #
ToQuery CreateTask Source #
Instance details Defined in Amazonka.DataSync.CreateTask Methods toQuery :: CreateTask -> QueryString #
AWSRequest CreateTask Source #
Instance details Defined in Amazonka.DataSync.CreateTask Associated Types type AWSResponse CreateTask # Methods request :: (Service -> Service) -> CreateTask -> Request CreateTask # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateTask -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateTask))) #
Generic CreateTask Source #
Instance details Defined in Amazonka.DataSync.CreateTask Associated Types type Rep CreateTask :: Type -> Type # Methods from :: CreateTask -> Rep CreateTask x # to :: Rep CreateTask x -> CreateTask #
Read CreateTask Source #
Instance details Defined in Amazonka.DataSync.CreateTask Methods readsPrec :: Int -> ReadS CreateTask # readList :: ReadS [CreateTask] # readPrec :: ReadPrec CreateTask # readListPrec :: ReadPrec [CreateTask] #
Show CreateTask Source #
Instance details Defined in Amazonka.DataSync.CreateTask Methods showsPrec :: Int -> CreateTask -> ShowS # show :: CreateTask -> String # showList :: [CreateTask] -> ShowS #
NFData CreateTask Source #
Instance details Defined in Amazonka.DataSync.CreateTask Methods rnf :: CreateTask -> () #
Eq CreateTask Source #
Instance details Defined in Amazonka.DataSync.CreateTask Methods (==) :: CreateTask -> CreateTask -> Bool # (/=) :: CreateTask -> CreateTask -> Bool #
Hashable CreateTask Source #
Instance details Defined in Amazonka.DataSync.CreateTask Methods hashWithSalt :: Int -> CreateTask -> Int # hash :: CreateTask -> Int #
type AWSResponse CreateTask Source #
Instance details Defined in Amazonka.DataSync.CreateTask type AWSResponse CreateTask = CreateTaskResponse
type Rep CreateTask Source #
Instance details Defined in Amazonka.DataSync.CreateTask type Rep CreateTask = D1 ('MetaData "CreateTask" "Amazonka.DataSync.CreateTask" "amazonka-datasync-2.0-LCcm4ddRe2z4CES4wun76Z" 'False) (C1 ('MetaCons "CreateTask'" '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 "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TagListEntry])) :: (S1 ('MetaSel ('Just "sourceLocationArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "destinationLocationArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newCreateTask Source #

Arguments

:: Text	`$sel:sourceLocationArn:CreateTask'`
-> Text	`$sel:destinationLocationArn:CreateTask'`
-> 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: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:excludes:CreateTask', createTask_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:CreateTask', createTask_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.

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:options:CreateTask', createTask_options - Specifies the configuration options for a task. Some options include preserving file or object metadata and verifying data integrity.

You can also override these options before starting an individual run of a task (also known as a task execution). For more information, see StartTaskExecution.

$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:tags:CreateTask', createTask_tags - Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing the task.

Tags are key-value pairs that help you manage, filter, and search for your DataSync resources.

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

Request Lenses

createTask_cloudWatchLogGroupArn :: Lens' CreateTask (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor and log events in the task.

createTask_excludes :: Lens' CreateTask (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.

createTask_includes :: Lens' CreateTask (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.

createTask_name :: Lens' CreateTask (Maybe Text) Source #

The name of a task. This value is a text reference that is used to identify the task in the console.

createTask_options :: Lens' CreateTask (Maybe Options) Source #

Specifies the configuration options for a task. Some options include preserving file or object metadata and verifying data integrity.

You can also override these options before starting an individual run of a task (also known as a task execution). For more information, see StartTaskExecution.

createTask_schedule :: Lens' CreateTask (Maybe TaskSchedule) Source #

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.

createTask_tags :: Lens' CreateTask (Maybe [TagListEntry]) Source #

Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing the task.

Tags are key-value pairs that help you manage, filter, and search for your DataSync resources.

createTask_sourceLocationArn :: Lens' CreateTask Text Source #

The Amazon Resource Name (ARN) of the source location for the task.

createTask_destinationLocationArn :: Lens' CreateTask Text Source #

The Amazon Resource Name (ARN) of an Amazon Web Services storage resource's location.

Destructuring the Response

data CreateTaskResponse Source #

CreateTaskResponse

See: newCreateTaskResponse smart constructor.

Constructors

CreateTaskResponse'
Fields taskArn :: Maybe Text The Amazon Resource Name (ARN) of the task. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newCreateTaskResponse Source #

Arguments

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

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:

CreateTaskResponse, createTaskResponse_taskArn - The Amazon Resource Name (ARN) of the task.

$sel:httpStatus:CreateTaskResponse', createTaskResponse_httpStatus - The response's http status code.

Response Lenses

createTaskResponse_taskArn :: Lens' CreateTaskResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the task.

createTaskResponse_httpStatus :: Lens' CreateTaskResponse Int Source #

The response's http status code.