Amazonka.Transfer.Types.CopyStepDetails

Documentation

data CopyStepDetails

Each step type has its own StepDetails structure.

See: newCopyStepDetails smart constructor.

Constructors

CopyStepDetails'

Fields

• destinationFileLocation :: Maybe InputFileLocation

  Specifies the location for the file being copied. Only applicable for Copy type workflow steps. Use ${Transfer:username} in this field to parametrize the destination prefix by username.

• name :: Maybe Text

  The name of the step, used as an identifier.

• overwriteExisting :: Maybe OverwriteExisting

  A flag that indicates whether or not to overwrite an existing file of the same name. The default is FALSE.

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

Instances

FromJSON CopyStepDetails

Defined in Amazonka.Transfer.Types.CopyStepDetails

Methods

parseJSON :: Value -> Parser CopyStepDetails

parseJSONList :: Value -> Parser [CopyStepDetails]

ToJSON CopyStepDetails

Defined in Amazonka.Transfer.Types.CopyStepDetails

Methods

toJSON :: CopyStepDetails -> Value

toEncoding :: CopyStepDetails -> Encoding

toJSONList :: [CopyStepDetails] -> Value

toEncodingList :: [CopyStepDetails] -> Encoding

Generic CopyStepDetails

Defined in Amazonka.Transfer.Types.CopyStepDetails

Associated Types

type Rep CopyStepDetails :: Type -> Type

Methods

from :: CopyStepDetails -> Rep CopyStepDetails x

to :: Rep CopyStepDetails x -> CopyStepDetails

Read CopyStepDetails

Defined in Amazonka.Transfer.Types.CopyStepDetails

Methods

readsPrec :: Int -> ReadS CopyStepDetails

readList :: ReadS [CopyStepDetails]

readPrec :: ReadPrec CopyStepDetails

readListPrec :: ReadPrec [CopyStepDetails]

Show CopyStepDetails

Defined in Amazonka.Transfer.Types.CopyStepDetails

Methods

showsPrec :: Int -> CopyStepDetails -> ShowS

show :: CopyStepDetails -> String

showList :: [CopyStepDetails] -> ShowS

NFData CopyStepDetails

Defined in Amazonka.Transfer.Types.CopyStepDetails

Methods

rnf :: CopyStepDetails -> ()

Eq CopyStepDetails

Defined in Amazonka.Transfer.Types.CopyStepDetails

Methods

(==) :: CopyStepDetails -> CopyStepDetails -> Bool

(/=) :: CopyStepDetails -> CopyStepDetails -> Bool

Hashable CopyStepDetails

Defined in Amazonka.Transfer.Types.CopyStepDetails

Methods

hashWithSalt :: Int -> CopyStepDetails -> Int

hash :: CopyStepDetails -> Int

type Rep CopyStepDetails

Defined in Amazonka.Transfer.Types.CopyStepDetails

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

newCopyStepDetails :: CopyStepDetails

Create a value of CopyStepDetails 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:destinationFileLocation:CopyStepDetails', copyStepDetails_destinationFileLocation - Specifies the location for the file being copied. Only applicable for Copy type workflow steps. Use ${Transfer:username} in this field to parametrize the destination prefix by username.

$sel:name:CopyStepDetails', copyStepDetails_name - The name of the step, used as an identifier.

$sel:overwriteExisting:CopyStepDetails', copyStepDetails_overwriteExisting - A flag that indicates whether or not to overwrite an existing file of the same name. The default is FALSE.

$sel:sourceFileLocation:CopyStepDetails', copyStepDetails_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.

copyStepDetails_destinationFileLocation :: Lens' CopyStepDetails (Maybe InputFileLocation)

Specifies the location for the file being copied. Only applicable for Copy type workflow steps. Use ${Transfer:username} in this field to parametrize the destination prefix by username.

copyStepDetails_name :: Lens' CopyStepDetails (Maybe Text)

The name of the step, used as an identifier.

copyStepDetails_overwriteExisting :: Lens' CopyStepDetails (Maybe OverwriteExisting)

A flag that indicates whether or not to overwrite an existing file of the same name. The default is FALSE.

copyStepDetails_sourceFileLocation :: Lens' CopyStepDetails (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.