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.Transfer.Types.DescribedExecution

Description

Synopsis

data DescribedExecution = DescribedExecution' {
- executionId :: Maybe Text
- executionRole :: Maybe Text
- initialFileLocation :: Maybe FileLocation
- loggingConfiguration :: Maybe LoggingConfiguration
- posixProfile :: Maybe PosixProfile
- results :: Maybe ExecutionResults
- serviceMetadata :: Maybe ServiceMetadata
- status :: Maybe ExecutionStatus
}
newDescribedExecution :: DescribedExecution
describedExecution_executionId :: Lens' DescribedExecution (Maybe Text)
describedExecution_executionRole :: Lens' DescribedExecution (Maybe Text)
describedExecution_initialFileLocation :: Lens' DescribedExecution (Maybe FileLocation)
describedExecution_loggingConfiguration :: Lens' DescribedExecution (Maybe LoggingConfiguration)
describedExecution_posixProfile :: Lens' DescribedExecution (Maybe PosixProfile)
describedExecution_results :: Lens' DescribedExecution (Maybe ExecutionResults)
describedExecution_serviceMetadata :: Lens' DescribedExecution (Maybe ServiceMetadata)
describedExecution_status :: Lens' DescribedExecution (Maybe ExecutionStatus)

Documentation

data DescribedExecution Source #

The details for an execution object.

See: newDescribedExecution smart constructor.

Constructors

DescribedExecution'

Fields

executionId :: Maybe Text
A unique identifier for the execution of a workflow.
executionRole :: Maybe Text
The IAM role associated with the execution.
initialFileLocation :: Maybe FileLocation
A structure that describes the Amazon S3 or EFS file location. This is the file location when the execution begins: if the file is being copied, this is the initial (as opposed to destination) file location.
loggingConfiguration :: Maybe LoggingConfiguration
The IAM logging role associated with the execution.
posixProfile :: Maybe PosixProfile
results :: Maybe ExecutionResults
A structure that describes the execution results. This includes a list of the steps along with the details of each step, error type and message (if any), and the OnExceptionSteps structure.
serviceMetadata :: Maybe ServiceMetadata
A container object for the session details that are associated with a workflow.
status :: Maybe ExecutionStatus
The status is one of the execution. Can be in progress, completed, exception encountered, or handling the exception.

Instances

Instances details

FromJSON DescribedExecution Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedExecution Methods parseJSON :: Value -> Parser DescribedExecution # parseJSONList :: Value -> Parser [DescribedExecution] #
Generic DescribedExecution Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedExecution Associated Types type Rep DescribedExecution :: Type -> Type # Methods from :: DescribedExecution -> Rep DescribedExecution x # to :: Rep DescribedExecution x -> DescribedExecution #
Read DescribedExecution Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedExecution Methods readsPrec :: Int -> ReadS DescribedExecution # readList :: ReadS [DescribedExecution] # readPrec :: ReadPrec DescribedExecution # readListPrec :: ReadPrec [DescribedExecution] #
Show DescribedExecution Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedExecution Methods showsPrec :: Int -> DescribedExecution -> ShowS # show :: DescribedExecution -> String # showList :: [DescribedExecution] -> ShowS #
NFData DescribedExecution Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedExecution Methods rnf :: DescribedExecution -> () #
Eq DescribedExecution Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedExecution Methods (==) :: DescribedExecution -> DescribedExecution -> Bool # (/=) :: DescribedExecution -> DescribedExecution -> Bool #
Hashable DescribedExecution Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedExecution Methods hashWithSalt :: Int -> DescribedExecution -> Int # hash :: DescribedExecution -> Int #
type Rep DescribedExecution Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedExecution type Rep DescribedExecution = D1 ('MetaData "DescribedExecution" "Amazonka.Transfer.Types.DescribedExecution" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "DescribedExecution'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "executionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "executionRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "initialFileLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FileLocation)) :: S1 ('MetaSel ('Just "loggingConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LoggingConfiguration)))) :: ((S1 ('MetaSel ('Just "posixProfile") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PosixProfile)) :: S1 ('MetaSel ('Just "results") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExecutionResults))) :: (S1 ('MetaSel ('Just "serviceMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ServiceMetadata)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExecutionStatus))))))

newDescribedExecution :: DescribedExecution Source #

Create a value of DescribedExecution 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:executionId:DescribedExecution', describedExecution_executionId - A unique identifier for the execution of a workflow.

$sel:executionRole:DescribedExecution', describedExecution_executionRole - The IAM role associated with the execution.

$sel:initialFileLocation:DescribedExecution', describedExecution_initialFileLocation - A structure that describes the Amazon S3 or EFS file location. This is the file location when the execution begins: if the file is being copied, this is the initial (as opposed to destination) file location.

$sel:loggingConfiguration:DescribedExecution', describedExecution_loggingConfiguration - The IAM logging role associated with the execution.

$sel:posixProfile:DescribedExecution', describedExecution_posixProfile - Undocumented member.

$sel:results:DescribedExecution', describedExecution_results - A structure that describes the execution results. This includes a list of the steps along with the details of each step, error type and message (if any), and the OnExceptionSteps structure.

$sel:serviceMetadata:DescribedExecution', describedExecution_serviceMetadata - A container object for the session details that are associated with a workflow.

$sel:status:DescribedExecution', describedExecution_status - The status is one of the execution. Can be in progress, completed, exception encountered, or handling the exception.

describedExecution_executionId :: Lens' DescribedExecution (Maybe Text) Source #

A unique identifier for the execution of a workflow.

describedExecution_executionRole :: Lens' DescribedExecution (Maybe Text) Source #

The IAM role associated with the execution.

describedExecution_initialFileLocation :: Lens' DescribedExecution (Maybe FileLocation) Source #

A structure that describes the Amazon S3 or EFS file location. This is the file location when the execution begins: if the file is being copied, this is the initial (as opposed to destination) file location.

describedExecution_loggingConfiguration :: Lens' DescribedExecution (Maybe LoggingConfiguration) Source #

The IAM logging role associated with the execution.

describedExecution_posixProfile :: Lens' DescribedExecution (Maybe PosixProfile) Source #

Undocumented member.

describedExecution_results :: Lens' DescribedExecution (Maybe ExecutionResults) Source #

A structure that describes the execution results. This includes a list of the steps along with the details of each step, error type and message (if any), and the OnExceptionSteps structure.

describedExecution_serviceMetadata :: Lens' DescribedExecution (Maybe ServiceMetadata) Source #

A container object for the session details that are associated with a workflow.

describedExecution_status :: Lens' DescribedExecution (Maybe ExecutionStatus) Source #

The status is one of the execution. Can be in progress, completed, exception encountered, or handling the exception.