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

Description

 
Synopsis

Documentation

data WorkflowStep Source #

The basic building block of a workflow.

See: newWorkflowStep smart constructor.

Constructors

WorkflowStep' 

Fields

Instances

Instances details
FromJSON WorkflowStep Source # 
Instance details

Defined in Amazonka.Transfer.Types.WorkflowStep

Methods

parseJSON :: Value -> Parser WorkflowStep #

parseJSONList :: Value -> Parser [WorkflowStep] #

ToJSON WorkflowStep Source # 
Instance details

Defined in Amazonka.Transfer.Types.WorkflowStep

Methods

toJSON :: WorkflowStep -> Value #

toEncoding :: WorkflowStep -> Encoding #

toJSONList :: [WorkflowStep] -> Value #

toEncodingList :: [WorkflowStep] -> Encoding #

Generic WorkflowStep Source # 
Instance details

Defined in Amazonka.Transfer.Types.WorkflowStep

Associated Types

type Rep WorkflowStep :: Type -> Type #

Methods

from :: WorkflowStep -> Rep WorkflowStep x #

to :: Rep WorkflowStep x -> WorkflowStep #

Read WorkflowStep Source # 
Instance details

Defined in Amazonka.Transfer.Types.WorkflowStep

Methods

readsPrec :: Int -> ReadS WorkflowStep #

readList :: ReadS [WorkflowStep] #

readPrec :: ReadPrec WorkflowStep #

readListPrec :: ReadPrec [WorkflowStep] #

Show WorkflowStep Source # 
Instance details

Defined in Amazonka.Transfer.Types.WorkflowStep

Methods

showsPrec :: Int -> WorkflowStep -> ShowS #

show :: WorkflowStep -> String #

showList :: [WorkflowStep] -> ShowS #

NFData WorkflowStep Source # 
Instance details

Defined in Amazonka.Transfer.Types.WorkflowStep

Methods

rnf :: WorkflowStep -> () #

Eq WorkflowStep Source # 
Instance details

Defined in Amazonka.Transfer.Types.WorkflowStep

Methods

(==) :: WorkflowStep -> WorkflowStep -> Bool #

(/=) :: WorkflowStep -> WorkflowStep -> Bool #

Hashable WorkflowStep Source # 
Instance details

Defined in Amazonka.Transfer.Types.WorkflowStep

Methods

hashWithSalt :: Int -> WorkflowStep -> Int #

hash :: WorkflowStep -> Int #

type Rep WorkflowStep Source # 
Instance details

Defined in Amazonka.Transfer.Types.WorkflowStep

type Rep WorkflowStep = D1 ('MetaData "WorkflowStep" "Amazonka.Transfer.Types.WorkflowStep" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "WorkflowStep'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "copyStepDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CopyStepDetails)) :*: (S1 ('MetaSel ('Just "customStepDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CustomStepDetails)) :*: S1 ('MetaSel ('Just "decryptStepDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DecryptStepDetails)))) :*: (S1 ('MetaSel ('Just "deleteStepDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeleteStepDetails)) :*: (S1 ('MetaSel ('Just "tagStepDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TagStepDetails)) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WorkflowStepType))))))

newWorkflowStep :: WorkflowStep Source #

Create a value of WorkflowStep 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:copyStepDetails:WorkflowStep', workflowStep_copyStepDetails - Details for a step that performs a file copy.

Consists of the following values:

  • A description
  • An S3 location for the destination of the file copy.
  • A flag that indicates whether or not to overwrite an existing file of the same name. The default is FALSE.

$sel:customStepDetails:WorkflowStep', workflowStep_customStepDetails - Details for a step that invokes a lambda function.

Consists of the lambda function name, target, and timeout (in seconds).

$sel:decryptStepDetails:WorkflowStep', workflowStep_decryptStepDetails - Undocumented member.

$sel:deleteStepDetails:WorkflowStep', workflowStep_deleteStepDetails - Details for a step that deletes the file.

$sel:tagStepDetails:WorkflowStep', workflowStep_tagStepDetails - Details for a step that creates one or more tags.

You specify one or more tags: each tag contains a key/value pair.

WorkflowStep, workflowStep_type - Currently, the following step types are supported.

  • COPY: Copy the file to another location.
  • CUSTOM: Perform a custom step with an Lambda function target.
  • DELETE: Delete the file.
  • TAG: Add a tag to the file.

workflowStep_copyStepDetails :: Lens' WorkflowStep (Maybe CopyStepDetails) Source #

Details for a step that performs a file copy.

Consists of the following values:

  • A description
  • An S3 location for the destination of the file copy.
  • A flag that indicates whether or not to overwrite an existing file of the same name. The default is FALSE.

workflowStep_customStepDetails :: Lens' WorkflowStep (Maybe CustomStepDetails) Source #

Details for a step that invokes a lambda function.

Consists of the lambda function name, target, and timeout (in seconds).

workflowStep_decryptStepDetails :: Lens' WorkflowStep (Maybe DecryptStepDetails) Source #

Undocumented member.

workflowStep_deleteStepDetails :: Lens' WorkflowStep (Maybe DeleteStepDetails) Source #

Details for a step that deletes the file.

workflowStep_tagStepDetails :: Lens' WorkflowStep (Maybe TagStepDetails) Source #

Details for a step that creates one or more tags.

You specify one or more tags: each tag contains a key/value pair.

workflowStep_type :: Lens' WorkflowStep (Maybe WorkflowStepType) Source #

Currently, the following step types are supported.

  • COPY: Copy the file to another location.
  • CUSTOM: Perform a custom step with an Lambda function target.
  • DELETE: Delete the file.
  • TAG: Add a tag to the file.