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

Description

Synopsis

Documentation

data WorkflowDetails Source #

Container for the WorkflowDetail data type. It is used by actions that trigger a workflow to begin execution.

See: newWorkflowDetails smart constructor.

Constructors

WorkflowDetails'

Fields

onPartialUpload :: Maybe [WorkflowDetail]
A trigger that starts a workflow if a file is only partially uploaded. You can attach a workflow to a server that executes whenever there is a partial upload.
A partial upload occurs when a file is open when the session disconnects.
onUpload :: Maybe [WorkflowDetail]
A trigger that starts a workflow: the workflow begins to execute after a file is uploaded.
To remove an associated workflow from a server, you can provide an empty OnUpload object, as in the following example.
```
aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{"OnUpload":[]}'
```

Instances

Instances details

FromJSON WorkflowDetails Source #
Instance details Defined in Amazonka.Transfer.Types.WorkflowDetails Methods parseJSON :: Value -> Parser WorkflowDetails # parseJSONList :: Value -> Parser [WorkflowDetails] #
ToJSON WorkflowDetails Source #
Instance details Defined in Amazonka.Transfer.Types.WorkflowDetails Methods toJSON :: WorkflowDetails -> Value # toEncoding :: WorkflowDetails -> Encoding # toJSONList :: [WorkflowDetails] -> Value # toEncodingList :: [WorkflowDetails] -> Encoding #
Generic WorkflowDetails Source #
Instance details Defined in Amazonka.Transfer.Types.WorkflowDetails Associated Types type Rep WorkflowDetails :: Type -> Type # Methods from :: WorkflowDetails -> Rep WorkflowDetails x # to :: Rep WorkflowDetails x -> WorkflowDetails #
Read WorkflowDetails Source #
Instance details Defined in Amazonka.Transfer.Types.WorkflowDetails Methods readsPrec :: Int -> ReadS WorkflowDetails # readList :: ReadS [WorkflowDetails] # readPrec :: ReadPrec WorkflowDetails # readListPrec :: ReadPrec [WorkflowDetails] #
Show WorkflowDetails Source #
Instance details Defined in Amazonka.Transfer.Types.WorkflowDetails Methods showsPrec :: Int -> WorkflowDetails -> ShowS # show :: WorkflowDetails -> String # showList :: [WorkflowDetails] -> ShowS #
NFData WorkflowDetails Source #
Instance details Defined in Amazonka.Transfer.Types.WorkflowDetails Methods rnf :: WorkflowDetails -> () #
Eq WorkflowDetails Source #
Instance details Defined in Amazonka.Transfer.Types.WorkflowDetails Methods (==) :: WorkflowDetails -> WorkflowDetails -> Bool # (/=) :: WorkflowDetails -> WorkflowDetails -> Bool #
Hashable WorkflowDetails Source #
Instance details Defined in Amazonka.Transfer.Types.WorkflowDetails Methods hashWithSalt :: Int -> WorkflowDetails -> Int # hash :: WorkflowDetails -> Int #
type Rep WorkflowDetails Source #
Instance details Defined in Amazonka.Transfer.Types.WorkflowDetails type Rep WorkflowDetails = D1 ('MetaData "WorkflowDetails" "Amazonka.Transfer.Types.WorkflowDetails" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "WorkflowDetails'" 'PrefixI 'True) (S1 ('MetaSel ('Just "onPartialUpload") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [WorkflowDetail])) :*: S1 ('MetaSel ('Just "onUpload") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [WorkflowDetail]))))

newWorkflowDetails :: WorkflowDetails Source #

Create a value of WorkflowDetails 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:onPartialUpload:WorkflowDetails', workflowDetails_onPartialUpload - A trigger that starts a workflow if a file is only partially uploaded. You can attach a workflow to a server that executes whenever there is a partial upload.

A partial upload occurs when a file is open when the session disconnects.

$sel:onUpload:WorkflowDetails', workflowDetails_onUpload - A trigger that starts a workflow: the workflow begins to execute after a file is uploaded.

To remove an associated workflow from a server, you can provide an empty OnUpload object, as in the following example.

aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{"OnUpload":[]}'

workflowDetails_onPartialUpload :: Lens' WorkflowDetails (Maybe [WorkflowDetail]) Source #

A trigger that starts a workflow if a file is only partially uploaded. You can attach a workflow to a server that executes whenever there is a partial upload.

A partial upload occurs when a file is open when the session disconnects.

workflowDetails_onUpload :: Lens' WorkflowDetails (Maybe [WorkflowDetail]) Source #

A trigger that starts a workflow: the workflow begins to execute after a file is uploaded.

To remove an associated workflow from a server, you can provide an empty OnUpload object, as in the following example.

aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{"OnUpload":[]}'