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

Description

Synopsis

Documentation

data TagStepDetails Source #

Each step type has its own StepDetails structure.

The key/value pairs used to tag a file during the execution of a workflow step.

See: newTagStepDetails smart constructor.

Constructors

TagStepDetails'

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.
tags :: Maybe (NonEmpty S3Tag)
Array that contains from 1 to 10 key/value pairs.

Instances

Instances details

FromJSON TagStepDetails Source #
Instance details Defined in Amazonka.Transfer.Types.TagStepDetails Methods parseJSON :: Value -> Parser TagStepDetails # parseJSONList :: Value -> Parser [TagStepDetails] #
ToJSON TagStepDetails Source #
Instance details Defined in Amazonka.Transfer.Types.TagStepDetails Methods toJSON :: TagStepDetails -> Value # toEncoding :: TagStepDetails -> Encoding # toJSONList :: [TagStepDetails] -> Value # toEncodingList :: [TagStepDetails] -> Encoding #
Generic TagStepDetails Source #
Instance details Defined in Amazonka.Transfer.Types.TagStepDetails Associated Types type Rep TagStepDetails :: Type -> Type # Methods from :: TagStepDetails -> Rep TagStepDetails x # to :: Rep TagStepDetails x -> TagStepDetails #
Read TagStepDetails Source #
Instance details Defined in Amazonka.Transfer.Types.TagStepDetails Methods readsPrec :: Int -> ReadS TagStepDetails # readList :: ReadS [TagStepDetails] # readPrec :: ReadPrec TagStepDetails # readListPrec :: ReadPrec [TagStepDetails] #
Show TagStepDetails Source #
Instance details Defined in Amazonka.Transfer.Types.TagStepDetails Methods showsPrec :: Int -> TagStepDetails -> ShowS # show :: TagStepDetails -> String # showList :: [TagStepDetails] -> ShowS #
NFData TagStepDetails Source #
Instance details Defined in Amazonka.Transfer.Types.TagStepDetails Methods rnf :: TagStepDetails -> () #
Eq TagStepDetails Source #
Instance details Defined in Amazonka.Transfer.Types.TagStepDetails Methods (==) :: TagStepDetails -> TagStepDetails -> Bool # (/=) :: TagStepDetails -> TagStepDetails -> Bool #
Hashable TagStepDetails Source #
Instance details Defined in Amazonka.Transfer.Types.TagStepDetails Methods hashWithSalt :: Int -> TagStepDetails -> Int # hash :: TagStepDetails -> Int #
type Rep TagStepDetails Source #
Instance details Defined in Amazonka.Transfer.Types.TagStepDetails type Rep TagStepDetails = D1 ('MetaData "TagStepDetails" "Amazonka.Transfer.Types.TagStepDetails" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "TagStepDetails'" '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 "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty S3Tag))))))

newTagStepDetails :: TagStepDetails Source #

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

$sel:sourceFileLocation:TagStepDetails', tagStepDetails_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:tags:TagStepDetails', tagStepDetails_tags - Array that contains from 1 to 10 key/value pairs.

tagStepDetails_name :: Lens' TagStepDetails (Maybe Text) Source #

The name of the step, used as an identifier.

tagStepDetails_sourceFileLocation :: Lens' TagStepDetails (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.

tagStepDetails_tags :: Lens' TagStepDetails (Maybe (NonEmpty S3Tag)) Source #

Array that contains from 1 to 10 key/value pairs.