Amazonka.AppFlow.Types.FlowDefinition

Documentation

data FlowDefinition

The properties of the flow, such as its source, destination, trigger type, and so on.

See: newFlowDefinition smart constructor.

Constructors

FlowDefinition'

Fields

• createdAt :: Maybe POSIX

  Specifies when the flow was created.

• createdBy :: Maybe Text

  The ARN of the user who created the flow.

• description :: Maybe Text

  A user-entered description of the flow.

• destinationConnectorLabel :: Maybe Text

  The label of the destination connector in the flow.

• destinationConnectorType :: Maybe ConnectorType

  Specifies the destination connector type, such as Salesforce, Amazon S3, Amplitude, and so on.

• flowArn :: Maybe Text

  The flow's Amazon Resource Name (ARN).

• flowName :: Maybe Text

  The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.

• flowStatus :: Maybe FlowStatus

  Indicates the current status of the flow.

• lastRunExecutionDetails :: Maybe ExecutionDetails

  Describes the details of the most recent flow run.

• lastUpdatedAt :: Maybe POSIX

  Specifies when the flow was last updated.

• lastUpdatedBy :: Maybe Text

  Specifies the account user name that most recently updated the flow.

• sourceConnectorLabel :: Maybe Text

  The label of the source connector in the flow.

• sourceConnectorType :: Maybe ConnectorType

  Specifies the source connector type, such as Salesforce, Amazon S3, Amplitude, and so on.

• tags :: Maybe (HashMap Text Text)

  The tags used to organize, track, or control access for your flow.

• triggerType :: Maybe TriggerType

  Specifies the type of flow trigger. This can be OnDemand, Scheduled, or Event.

Instances

FromJSON FlowDefinition

Defined in Amazonka.AppFlow.Types.FlowDefinition

Methods

parseJSON :: Value -> Parser FlowDefinition

parseJSONList :: Value -> Parser [FlowDefinition]

Generic FlowDefinition

Defined in Amazonka.AppFlow.Types.FlowDefinition

Associated Types

type Rep FlowDefinition :: Type -> Type

Methods

from :: FlowDefinition -> Rep FlowDefinition x

to :: Rep FlowDefinition x -> FlowDefinition

Read FlowDefinition

Defined in Amazonka.AppFlow.Types.FlowDefinition

Methods

readsPrec :: Int -> ReadS FlowDefinition

readList :: ReadS [FlowDefinition]

readPrec :: ReadPrec FlowDefinition

readListPrec :: ReadPrec [FlowDefinition]

Show FlowDefinition

Defined in Amazonka.AppFlow.Types.FlowDefinition

Methods

showsPrec :: Int -> FlowDefinition -> ShowS

show :: FlowDefinition -> String

showList :: [FlowDefinition] -> ShowS

NFData FlowDefinition

Defined in Amazonka.AppFlow.Types.FlowDefinition

Methods

rnf :: FlowDefinition -> ()

Eq FlowDefinition

Defined in Amazonka.AppFlow.Types.FlowDefinition

Methods

(==) :: FlowDefinition -> FlowDefinition -> Bool

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

Hashable FlowDefinition

Defined in Amazonka.AppFlow.Types.FlowDefinition

Methods

hashWithSalt :: Int -> FlowDefinition -> Int

hash :: FlowDefinition -> Int

type Rep FlowDefinition

Defined in Amazonka.AppFlow.Types.FlowDefinition

type Rep FlowDefinition = D1 ('MetaData "FlowDefinition" "Amazonka.AppFlow.Types.FlowDefinition" "amazonka-appflow-2.0-3aJWKTszi6ZKDtrkFSqVAB" 'False) (C1 ('MetaCons "FlowDefinition'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "createdBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "destinationConnectorLabel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "destinationConnectorType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConnectorType))) :*: (S1 ('MetaSel ('Just "flowArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "flowName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: (((S1 ('MetaSel ('Just "flowStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FlowStatus)) :*: S1 ('MetaSel ('Just "lastRunExecutionDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExecutionDetails))) :*: (S1 ('MetaSel ('Just "lastUpdatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "lastUpdatedBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "sourceConnectorLabel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "sourceConnectorType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConnectorType))) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "triggerType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TriggerType)))))))

newFlowDefinition :: FlowDefinition

Create a value of FlowDefinition 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:createdAt:FlowDefinition', flowDefinition_createdAt - Specifies when the flow was created.

$sel:createdBy:FlowDefinition', flowDefinition_createdBy - The ARN of the user who created the flow.

$sel:description:FlowDefinition', flowDefinition_description - A user-entered description of the flow.

$sel:destinationConnectorLabel:FlowDefinition', flowDefinition_destinationConnectorLabel - The label of the destination connector in the flow.

$sel:destinationConnectorType:FlowDefinition', flowDefinition_destinationConnectorType - Specifies the destination connector type, such as Salesforce, Amazon S3, Amplitude, and so on.

$sel:flowArn:FlowDefinition', flowDefinition_flowArn - The flow's Amazon Resource Name (ARN).

$sel:flowName:FlowDefinition', flowDefinition_flowName - The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.

$sel:flowStatus:FlowDefinition', flowDefinition_flowStatus - Indicates the current status of the flow.

$sel:lastRunExecutionDetails:FlowDefinition', flowDefinition_lastRunExecutionDetails - Describes the details of the most recent flow run.

$sel:lastUpdatedAt:FlowDefinition', flowDefinition_lastUpdatedAt - Specifies when the flow was last updated.

$sel:lastUpdatedBy:FlowDefinition', flowDefinition_lastUpdatedBy - Specifies the account user name that most recently updated the flow.

$sel:sourceConnectorLabel:FlowDefinition', flowDefinition_sourceConnectorLabel - The label of the source connector in the flow.

$sel:sourceConnectorType:FlowDefinition', flowDefinition_sourceConnectorType - Specifies the source connector type, such as Salesforce, Amazon S3, Amplitude, and so on.

$sel:tags:FlowDefinition', flowDefinition_tags - The tags used to organize, track, or control access for your flow.

$sel:triggerType:FlowDefinition', flowDefinition_triggerType - Specifies the type of flow trigger. This can be OnDemand, Scheduled, or Event.

flowDefinition_createdAt :: Lens' FlowDefinition (Maybe UTCTime)

Specifies when the flow was created.

flowDefinition_createdBy :: Lens' FlowDefinition (Maybe Text)

The ARN of the user who created the flow.

flowDefinition_description :: Lens' FlowDefinition (Maybe Text)

A user-entered description of the flow.

flowDefinition_destinationConnectorLabel :: Lens' FlowDefinition (Maybe Text)

The label of the destination connector in the flow.

flowDefinition_destinationConnectorType :: Lens' FlowDefinition (Maybe ConnectorType)

Specifies the destination connector type, such as Salesforce, Amazon S3, Amplitude, and so on.

flowDefinition_flowArn :: Lens' FlowDefinition (Maybe Text)

The flow's Amazon Resource Name (ARN).

flowDefinition_flowName :: Lens' FlowDefinition (Maybe Text)

The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.

flowDefinition_flowStatus :: Lens' FlowDefinition (Maybe FlowStatus)

Indicates the current status of the flow.

flowDefinition_lastRunExecutionDetails :: Lens' FlowDefinition (Maybe ExecutionDetails)

Describes the details of the most recent flow run.

flowDefinition_lastUpdatedAt :: Lens' FlowDefinition (Maybe UTCTime)

Specifies when the flow was last updated.

flowDefinition_lastUpdatedBy :: Lens' FlowDefinition (Maybe Text)

Specifies the account user name that most recently updated the flow.

flowDefinition_sourceConnectorLabel :: Lens' FlowDefinition (Maybe Text)

The label of the source connector in the flow.

flowDefinition_sourceConnectorType :: Lens' FlowDefinition (Maybe ConnectorType)

Specifies the source connector type, such as Salesforce, Amazon S3, Amplitude, and so on.

flowDefinition_tags :: Lens' FlowDefinition (Maybe (HashMap Text Text))

The tags used to organize, track, or control access for your flow.

flowDefinition_triggerType :: Lens' FlowDefinition (Maybe TriggerType)

Specifies the type of flow trigger. This can be OnDemand, Scheduled, or Event.