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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns metadata about a task.

Synopsis

data DescribeTask = DescribeTask' {
- taskArn :: Text
}
newDescribeTask :: Text -> DescribeTask
describeTask_taskArn :: Lens' DescribeTask Text
data DescribeTaskResponse = DescribeTaskResponse' {
- cloudWatchLogGroupArn :: Maybe Text
- creationTime :: Maybe POSIX
- currentTaskExecutionArn :: Maybe Text
- destinationLocationArn :: Maybe Text
- destinationNetworkInterfaceArns :: Maybe [Text]
- errorCode :: Maybe Text
- errorDetail :: Maybe Text
- excludes :: Maybe [FilterRule]
- includes :: Maybe [FilterRule]
- name :: Maybe Text
- options :: Maybe Options
- schedule :: Maybe TaskSchedule
- sourceLocationArn :: Maybe Text
- sourceNetworkInterfaceArns :: Maybe [Text]
- status :: Maybe TaskStatus
- taskArn :: Maybe Text
- httpStatus :: Int
}
newDescribeTaskResponse :: Int -> DescribeTaskResponse
describeTaskResponse_cloudWatchLogGroupArn :: Lens' DescribeTaskResponse (Maybe Text)
describeTaskResponse_creationTime :: Lens' DescribeTaskResponse (Maybe UTCTime)
describeTaskResponse_currentTaskExecutionArn :: Lens' DescribeTaskResponse (Maybe Text)
describeTaskResponse_destinationLocationArn :: Lens' DescribeTaskResponse (Maybe Text)
describeTaskResponse_destinationNetworkInterfaceArns :: Lens' DescribeTaskResponse (Maybe [Text])
describeTaskResponse_errorCode :: Lens' DescribeTaskResponse (Maybe Text)
describeTaskResponse_errorDetail :: Lens' DescribeTaskResponse (Maybe Text)
describeTaskResponse_excludes :: Lens' DescribeTaskResponse (Maybe [FilterRule])
describeTaskResponse_includes :: Lens' DescribeTaskResponse (Maybe [FilterRule])
describeTaskResponse_name :: Lens' DescribeTaskResponse (Maybe Text)
describeTaskResponse_options :: Lens' DescribeTaskResponse (Maybe Options)
describeTaskResponse_schedule :: Lens' DescribeTaskResponse (Maybe TaskSchedule)
describeTaskResponse_sourceLocationArn :: Lens' DescribeTaskResponse (Maybe Text)
describeTaskResponse_sourceNetworkInterfaceArns :: Lens' DescribeTaskResponse (Maybe [Text])
describeTaskResponse_status :: Lens' DescribeTaskResponse (Maybe TaskStatus)
describeTaskResponse_taskArn :: Lens' DescribeTaskResponse (Maybe Text)
describeTaskResponse_httpStatus :: Lens' DescribeTaskResponse Int

Creating a Request

data DescribeTask Source #

DescribeTaskRequest

See: newDescribeTask smart constructor.

Constructors

DescribeTask'
Fields taskArn :: Text The Amazon Resource Name (ARN) of the task to describe.

Instances

Instances details

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

newDescribeTask Source #

Arguments

:: Text	`DescribeTask`
-> DescribeTask

Create a value of DescribeTask 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:

DescribeTask, describeTask_taskArn - The Amazon Resource Name (ARN) of the task to describe.

Request Lenses

describeTask_taskArn :: Lens' DescribeTask Text Source #

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

Destructuring the Response

data DescribeTaskResponse Source #

DescribeTaskResponse

See: newDescribeTaskResponse smart constructor.

Constructors

DescribeTaskResponse'

Fields

cloudWatchLogGroupArn :: Maybe Text
The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that was used to monitor and log events in the task.
For more information on these groups, see Working with Log Groups and Log Streams in the Amazon CloudWatch User Guide.
creationTime :: Maybe POSIX
The time that the task was created.
currentTaskExecutionArn :: Maybe Text
The Amazon Resource Name (ARN) of the task execution that is transferring files.
destinationLocationArn :: Maybe Text
The Amazon Resource Name (ARN) of the Amazon Web Services storage resource's location.
destinationNetworkInterfaceArns :: Maybe [Text]
The Amazon Resource Names (ARNs) of the network interfaces created for your destination location. For more information, see Network interface requirements.
errorCode :: Maybe Text
Errors that DataSync encountered during execution of the task. You can use this error code to help troubleshoot issues.
errorDetail :: Maybe Text
Detailed description of an error that was encountered during the task execution. You can use this information to help troubleshoot issues.
excludes :: Maybe [FilterRule]
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]
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 that was described.
options :: Maybe Options
The configuration options that control the behavior of the StartTaskExecution operation. Some options include preserving file or object metadata and verifying data integrity.
You can override these options for each task execution. For more information, see StartTaskExecution.
schedule :: Maybe TaskSchedule
The schedule used to periodically transfer files from a source to a destination location.
sourceLocationArn :: Maybe Text
The Amazon Resource Name (ARN) of the source file system's location.
sourceNetworkInterfaceArns :: Maybe [Text]
The Amazon Resource Names (ARNs) of the network interfaces created for your source location. For more information, see Network interface requirements.
status :: Maybe TaskStatus
The status of the task that was described.
For detailed information about task execution statuses, see Understanding Task Statuses in the DataSync User Guide.
taskArn :: Maybe Text
The Amazon Resource Name (ARN) of the task that was described.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeTaskResponse Source #
Instance details Defined in Amazonka.DataSync.DescribeTask Associated Types type Rep DescribeTaskResponse :: Type -> Type # Methods from :: DescribeTaskResponse -> Rep DescribeTaskResponse x # to :: Rep DescribeTaskResponse x -> DescribeTaskResponse #
Read DescribeTaskResponse Source #
Instance details Defined in Amazonka.DataSync.DescribeTask Methods readsPrec :: Int -> ReadS DescribeTaskResponse # readList :: ReadS [DescribeTaskResponse] # readPrec :: ReadPrec DescribeTaskResponse # readListPrec :: ReadPrec [DescribeTaskResponse] #
Show DescribeTaskResponse Source #
Instance details Defined in Amazonka.DataSync.DescribeTask Methods showsPrec :: Int -> DescribeTaskResponse -> ShowS # show :: DescribeTaskResponse -> String # showList :: [DescribeTaskResponse] -> ShowS #
NFData DescribeTaskResponse Source #
Instance details Defined in Amazonka.DataSync.DescribeTask Methods rnf :: DescribeTaskResponse -> () #
Eq DescribeTaskResponse Source #
Instance details Defined in Amazonka.DataSync.DescribeTask Methods (==) :: DescribeTaskResponse -> DescribeTaskResponse -> Bool # (/=) :: DescribeTaskResponse -> DescribeTaskResponse -> Bool #
type Rep DescribeTaskResponse Source #
Instance details Defined in Amazonka.DataSync.DescribeTask type Rep DescribeTaskResponse = D1 ('MetaData "DescribeTaskResponse" "Amazonka.DataSync.DescribeTask" "amazonka-datasync-2.0-LCcm4ddRe2z4CES4wun76Z" 'False) (C1 ('MetaCons "DescribeTaskResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "cloudWatchLogGroupArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "currentTaskExecutionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "destinationLocationArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "destinationNetworkInterfaceArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "errorCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "errorDetail") '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 "sourceLocationArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "sourceNetworkInterfaceArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TaskStatus)) :: (S1 ('MetaSel ('Just "taskArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))))

newDescribeTaskResponse Source #

Arguments

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

Create a value of DescribeTaskResponse 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:DescribeTaskResponse', describeTaskResponse_cloudWatchLogGroupArn - The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that was used to monitor and log events in the task.

For more information on these groups, see Working with Log Groups and Log Streams in the Amazon CloudWatch User Guide.

$sel:creationTime:DescribeTaskResponse', describeTaskResponse_creationTime - The time that the task was created.

$sel:currentTaskExecutionArn:DescribeTaskResponse', describeTaskResponse_currentTaskExecutionArn - The Amazon Resource Name (ARN) of the task execution that is transferring files.

$sel:destinationLocationArn:DescribeTaskResponse', describeTaskResponse_destinationLocationArn - The Amazon Resource Name (ARN) of the Amazon Web Services storage resource's location.

$sel:destinationNetworkInterfaceArns:DescribeTaskResponse', describeTaskResponse_destinationNetworkInterfaceArns - The Amazon Resource Names (ARNs) of the network interfaces created for your destination location. For more information, see Network interface requirements.

DescribeTaskResponse, describeTaskResponse_errorCode - Errors that DataSync encountered during execution of the task. You can use this error code to help troubleshoot issues.

DescribeTaskResponse, describeTaskResponse_errorDetail - Detailed description of an error that was encountered during the task execution. You can use this information to help troubleshoot issues.

$sel:excludes:DescribeTaskResponse', describeTaskResponse_excludes - 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:DescribeTaskResponse', describeTaskResponse_includes - A list of filter rules that include specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.

DescribeTaskResponse, describeTaskResponse_name - The name of the task that was described.

$sel:options:DescribeTaskResponse', describeTaskResponse_options - The configuration options that control the behavior of the StartTaskExecution operation. Some options include preserving file or object metadata and verifying data integrity.

You can override these options for each task execution. For more information, see StartTaskExecution.

$sel:schedule:DescribeTaskResponse', describeTaskResponse_schedule - The schedule used to periodically transfer files from a source to a destination location.

$sel:sourceLocationArn:DescribeTaskResponse', describeTaskResponse_sourceLocationArn - The Amazon Resource Name (ARN) of the source file system's location.

$sel:sourceNetworkInterfaceArns:DescribeTaskResponse', describeTaskResponse_sourceNetworkInterfaceArns - The Amazon Resource Names (ARNs) of the network interfaces created for your source location. For more information, see Network interface requirements.

DescribeTaskResponse, describeTaskResponse_status - The status of the task that was described.

For detailed information about task execution statuses, see Understanding Task Statuses in the DataSync User Guide.

DescribeTask, describeTaskResponse_taskArn - The Amazon Resource Name (ARN) of the task that was described.

$sel:httpStatus:DescribeTaskResponse', describeTaskResponse_httpStatus - The response's http status code.

Response Lenses

describeTaskResponse_cloudWatchLogGroupArn :: Lens' DescribeTaskResponse (Maybe Text) Source #

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

For more information on these groups, see Working with Log Groups and Log Streams in the Amazon CloudWatch User Guide.

describeTaskResponse_creationTime :: Lens' DescribeTaskResponse (Maybe UTCTime) Source #

The time that the task was created.

describeTaskResponse_currentTaskExecutionArn :: Lens' DescribeTaskResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the task execution that is transferring files.

describeTaskResponse_destinationLocationArn :: Lens' DescribeTaskResponse (Maybe Text) Source #

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

describeTaskResponse_destinationNetworkInterfaceArns :: Lens' DescribeTaskResponse (Maybe [Text]) Source #

The Amazon Resource Names (ARNs) of the network interfaces created for your destination location. For more information, see Network interface requirements.

describeTaskResponse_errorCode :: Lens' DescribeTaskResponse (Maybe Text) Source #

Errors that DataSync encountered during execution of the task. You can use this error code to help troubleshoot issues.

describeTaskResponse_errorDetail :: Lens' DescribeTaskResponse (Maybe Text) Source #

Detailed description of an error that was encountered during the task execution. You can use this information to help troubleshoot issues.

describeTaskResponse_excludes :: Lens' DescribeTaskResponse (Maybe [FilterRule]) Source #

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

describeTaskResponse_includes :: Lens' DescribeTaskResponse (Maybe [FilterRule]) Source #

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

describeTaskResponse_name :: Lens' DescribeTaskResponse (Maybe Text) Source #

The name of the task that was described.

describeTaskResponse_options :: Lens' DescribeTaskResponse (Maybe Options) Source #

The configuration options that control the behavior of the StartTaskExecution operation. Some options include preserving file or object metadata and verifying data integrity.

You can override these options for each task execution. For more information, see StartTaskExecution.

describeTaskResponse_schedule :: Lens' DescribeTaskResponse (Maybe TaskSchedule) Source #

The schedule used to periodically transfer files from a source to a destination location.

describeTaskResponse_sourceLocationArn :: Lens' DescribeTaskResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the source file system's location.

describeTaskResponse_sourceNetworkInterfaceArns :: Lens' DescribeTaskResponse (Maybe [Text]) Source #

The Amazon Resource Names (ARNs) of the network interfaces created for your source location. For more information, see Network interface requirements.

describeTaskResponse_status :: Lens' DescribeTaskResponse (Maybe TaskStatus) Source #

The status of the task that was described.

For detailed information about task execution statuses, see Understanding Task Statuses in the DataSync User Guide.

describeTaskResponse_taskArn :: Lens' DescribeTaskResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the task that was described.

describeTaskResponse_httpStatus :: Lens' DescribeTaskResponse Int Source #

The response's http status code.