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

Description

Documentation

data DescribedWorkflow Source #

Describes the properties of the specified workflow

See: newDescribedWorkflow smart constructor.

Constructors

DescribedWorkflow'

Fields

description :: Maybe Text
Specifies the text description for the workflow.
onExceptionSteps :: Maybe [WorkflowStep]
Specifies the steps (actions) to take if errors are encountered during execution of the workflow.
steps :: Maybe [WorkflowStep]
Specifies the details for the steps that are in the specified workflow.
tags :: Maybe (NonEmpty Tag)
Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.
workflowId :: Maybe Text
A unique identifier for the workflow.
arn :: Text
Specifies the unique Amazon Resource Name (ARN) for the workflow.

Instances

Instances details

FromJSON DescribedWorkflow Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedWorkflow Methods parseJSON :: Value -> Parser DescribedWorkflow # parseJSONList :: Value -> Parser [DescribedWorkflow] #
Generic DescribedWorkflow Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedWorkflow Associated Types type Rep DescribedWorkflow :: Type -> Type # Methods from :: DescribedWorkflow -> Rep DescribedWorkflow x # to :: Rep DescribedWorkflow x -> DescribedWorkflow #
Read DescribedWorkflow Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedWorkflow Methods readsPrec :: Int -> ReadS DescribedWorkflow # readList :: ReadS [DescribedWorkflow] # readPrec :: ReadPrec DescribedWorkflow # readListPrec :: ReadPrec [DescribedWorkflow] #
Show DescribedWorkflow Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedWorkflow Methods showsPrec :: Int -> DescribedWorkflow -> ShowS # show :: DescribedWorkflow -> String # showList :: [DescribedWorkflow] -> ShowS #
NFData DescribedWorkflow Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedWorkflow Methods rnf :: DescribedWorkflow -> () #
Eq DescribedWorkflow Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedWorkflow Methods (==) :: DescribedWorkflow -> DescribedWorkflow -> Bool # (/=) :: DescribedWorkflow -> DescribedWorkflow -> Bool #
Hashable DescribedWorkflow Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedWorkflow Methods hashWithSalt :: Int -> DescribedWorkflow -> Int # hash :: DescribedWorkflow -> Int #
type Rep DescribedWorkflow Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedWorkflow type Rep DescribedWorkflow = D1 ('MetaData "DescribedWorkflow" "Amazonka.Transfer.Types.DescribedWorkflow" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "DescribedWorkflow'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "onExceptionSteps") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [WorkflowStep])) :: S1 ('MetaSel ('Just "steps") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [WorkflowStep])))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag))) :: (S1 ('MetaSel ('Just "workflowId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newDescribedWorkflow Source #

Arguments

:: Text	`$sel:arn:DescribedWorkflow'`
-> DescribedWorkflow

Create a value of DescribedWorkflow 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:description:DescribedWorkflow', describedWorkflow_description - Specifies the text description for the workflow.

$sel:onExceptionSteps:DescribedWorkflow', describedWorkflow_onExceptionSteps - Specifies the steps (actions) to take if errors are encountered during execution of the workflow.

$sel:steps:DescribedWorkflow', describedWorkflow_steps - Specifies the details for the steps that are in the specified workflow.

$sel:tags:DescribedWorkflow', describedWorkflow_tags - Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.

$sel:workflowId:DescribedWorkflow', describedWorkflow_workflowId - A unique identifier for the workflow.

$sel:arn:DescribedWorkflow', describedWorkflow_arn - Specifies the unique Amazon Resource Name (ARN) for the workflow.

describedWorkflow_description :: Lens' DescribedWorkflow (Maybe Text) Source #

Specifies the text description for the workflow.

describedWorkflow_onExceptionSteps :: Lens' DescribedWorkflow (Maybe [WorkflowStep]) Source #

Specifies the steps (actions) to take if errors are encountered during execution of the workflow.

describedWorkflow_steps :: Lens' DescribedWorkflow (Maybe [WorkflowStep]) Source #

Specifies the details for the steps that are in the specified workflow.

describedWorkflow_tags :: Lens' DescribedWorkflow (Maybe (NonEmpty Tag)) Source #

Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.

describedWorkflow_workflowId :: Lens' DescribedWorkflow (Maybe Text) Source #

A unique identifier for the workflow.

describedWorkflow_arn :: Lens' DescribedWorkflow Text Source #

Specifies the unique Amazon Resource Name (ARN) for the workflow.