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

Description

 
Synopsis

Documentation

data CustomStepDetails Source #

Each step type has its own StepDetails structure.

See: newCustomStepDetails smart constructor.

Constructors

CustomStepDetails' 

Fields

  • name :: Maybe Text

    The name of the step, used as an identifier.

  • sourceFileLocation :: Maybe Text

    Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.

    • Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.
    • Enter ${original.file} to use the originally-uploaded file location as input for this step.
  • target :: Maybe Text

    The ARN for the lambda function that is being called.

  • timeoutSeconds :: Maybe Natural

    Timeout, in seconds, for the step.

Instances

Instances details
FromJSON CustomStepDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.CustomStepDetails

ToJSON CustomStepDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.CustomStepDetails

Generic CustomStepDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.CustomStepDetails

Associated Types

type Rep CustomStepDetails :: Type -> Type #

Read CustomStepDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.CustomStepDetails

Show CustomStepDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.CustomStepDetails

NFData CustomStepDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.CustomStepDetails

Methods

rnf :: CustomStepDetails -> () #

Eq CustomStepDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.CustomStepDetails

Hashable CustomStepDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.CustomStepDetails

type Rep CustomStepDetails Source # 
Instance details

Defined in Amazonka.Transfer.Types.CustomStepDetails

type Rep CustomStepDetails = D1 ('MetaData "CustomStepDetails" "Amazonka.Transfer.Types.CustomStepDetails" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "CustomStepDetails'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "sourceFileLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "target") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "timeoutSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))

newCustomStepDetails :: CustomStepDetails Source #

Create a value of CustomStepDetails 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:name:CustomStepDetails', customStepDetails_name - The name of the step, used as an identifier.

$sel:sourceFileLocation:CustomStepDetails', customStepDetails_sourceFileLocation - Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.

  • Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.
  • Enter ${original.file} to use the originally-uploaded file location as input for this step.

$sel:target:CustomStepDetails', customStepDetails_target - The ARN for the lambda function that is being called.

$sel:timeoutSeconds:CustomStepDetails', customStepDetails_timeoutSeconds - Timeout, in seconds, for the step.

customStepDetails_name :: Lens' CustomStepDetails (Maybe Text) Source #

The name of the step, used as an identifier.

customStepDetails_sourceFileLocation :: Lens' CustomStepDetails (Maybe Text) Source #

Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.

  • Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.
  • Enter ${original.file} to use the originally-uploaded file location as input for this step.

customStepDetails_target :: Lens' CustomStepDetails (Maybe Text) Source #

The ARN for the lambda function that is being called.