amazonka-transfer-2.0: Amazon Transfer Family SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Transfer.Types.WorkflowDetail

Description

 
Synopsis

Documentation

data WorkflowDetail Source #

Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.

In additon to a workflow to execute when a file is uploaded completely, WorkflowDeatails can also contain a workflow ID (and execution role) for a workflow to execute on partial upload. A partial upload occurs when a file is open when the session disconnects.

See: newWorkflowDetail smart constructor.

Constructors

WorkflowDetail' 

Fields

  • workflowId :: Text

    A unique identifier for the workflow.

  • executionRole :: Text

    Includes the necessary permissions for S3, EFS, and Lambda operations that Transfer can assume, so that all workflow steps can operate on the required resources

Instances

Instances details
FromJSON WorkflowDetail Source # 
Instance details

Defined in Amazonka.Transfer.Types.WorkflowDetail

ToJSON WorkflowDetail Source # 
Instance details

Defined in Amazonka.Transfer.Types.WorkflowDetail

Generic WorkflowDetail Source # 
Instance details

Defined in Amazonka.Transfer.Types.WorkflowDetail

Associated Types

type Rep WorkflowDetail :: Type -> Type #

Read WorkflowDetail Source # 
Instance details

Defined in Amazonka.Transfer.Types.WorkflowDetail

Show WorkflowDetail Source # 
Instance details

Defined in Amazonka.Transfer.Types.WorkflowDetail

NFData WorkflowDetail Source # 
Instance details

Defined in Amazonka.Transfer.Types.WorkflowDetail

Methods

rnf :: WorkflowDetail -> () #

Eq WorkflowDetail Source # 
Instance details

Defined in Amazonka.Transfer.Types.WorkflowDetail

Hashable WorkflowDetail Source # 
Instance details

Defined in Amazonka.Transfer.Types.WorkflowDetail

type Rep WorkflowDetail Source # 
Instance details

Defined in Amazonka.Transfer.Types.WorkflowDetail

type Rep WorkflowDetail = D1 ('MetaData "WorkflowDetail" "Amazonka.Transfer.Types.WorkflowDetail" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "WorkflowDetail'" 'PrefixI 'True) (S1 ('MetaSel ('Just "workflowId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "executionRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newWorkflowDetail Source #

Create a value of WorkflowDetail 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:workflowId:WorkflowDetail', workflowDetail_workflowId - A unique identifier for the workflow.

$sel:executionRole:WorkflowDetail', workflowDetail_executionRole - Includes the necessary permissions for S3, EFS, and Lambda operations that Transfer can assume, so that all workflow steps can operate on the required resources

workflowDetail_workflowId :: Lens' WorkflowDetail Text Source #

A unique identifier for the workflow.

workflowDetail_executionRole :: Lens' WorkflowDetail Text Source #

Includes the necessary permissions for S3, EFS, and Lambda operations that Transfer can assume, so that all workflow steps can operate on the required resources