libZSservicesZSamazonka-appflowZSamazonka-appflow
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.AppFlow.CreateFlow

Description

Enables your application to create a new flow using Amazon AppFlow. You must create a connector profile before calling this API. Please note that the Request Syntax below shows syntax for multiple destinations, however, you can only transfer data to one item in this list at a time. Amazon AppFlow does not currently support flows to multiple destinations at once.

Synopsis

Creating a Request

data CreateFlow Source #

See: newCreateFlow smart constructor.

Constructors

CreateFlow' 

Fields

  • kmsArn :: Maybe Text

    The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. This is required if you do not want to use the Amazon AppFlow-managed KMS key. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key.

  • description :: Maybe Text

    A description of the flow you want to create.

  • tags :: Maybe (HashMap Text Text)

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

  • flowName :: Text

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

  • triggerConfig :: TriggerConfig

    The trigger settings that determine how and when the flow runs.

  • sourceFlowConfig :: SourceFlowConfig

    The configuration that controls how Amazon AppFlow retrieves data from the source connector.

  • destinationFlowConfigList :: [DestinationFlowConfig]

    The configuration that controls how Amazon AppFlow places data in the destination connector.

  • tasks :: [Task]

    A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.

Instances

Instances details
Eq CreateFlow Source # 
Instance details

Defined in Amazonka.AppFlow.CreateFlow

Read CreateFlow Source # 
Instance details

Defined in Amazonka.AppFlow.CreateFlow

Show CreateFlow Source # 
Instance details

Defined in Amazonka.AppFlow.CreateFlow

Generic CreateFlow Source # 
Instance details

Defined in Amazonka.AppFlow.CreateFlow

Associated Types

type Rep CreateFlow :: Type -> Type #

NFData CreateFlow Source # 
Instance details

Defined in Amazonka.AppFlow.CreateFlow

Methods

rnf :: CreateFlow -> () #

Hashable CreateFlow Source # 
Instance details

Defined in Amazonka.AppFlow.CreateFlow

ToJSON CreateFlow Source # 
Instance details

Defined in Amazonka.AppFlow.CreateFlow

AWSRequest CreateFlow Source # 
Instance details

Defined in Amazonka.AppFlow.CreateFlow

Associated Types

type AWSResponse CreateFlow #

ToHeaders CreateFlow Source # 
Instance details

Defined in Amazonka.AppFlow.CreateFlow

Methods

toHeaders :: CreateFlow -> [Header] #

ToPath CreateFlow Source # 
Instance details

Defined in Amazonka.AppFlow.CreateFlow

ToQuery CreateFlow Source # 
Instance details

Defined in Amazonka.AppFlow.CreateFlow

type Rep CreateFlow Source # 
Instance details

Defined in Amazonka.AppFlow.CreateFlow

type AWSResponse CreateFlow Source # 
Instance details

Defined in Amazonka.AppFlow.CreateFlow

newCreateFlow Source #

Create a value of CreateFlow 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:kmsArn:CreateFlow', createFlow_kmsArn - The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. This is required if you do not want to use the Amazon AppFlow-managed KMS key. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key.

$sel:description:CreateFlow', createFlow_description - A description of the flow you want to create.

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

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

$sel:triggerConfig:CreateFlow', createFlow_triggerConfig - The trigger settings that determine how and when the flow runs.

$sel:sourceFlowConfig:CreateFlow', createFlow_sourceFlowConfig - The configuration that controls how Amazon AppFlow retrieves data from the source connector.

$sel:destinationFlowConfigList:CreateFlow', createFlow_destinationFlowConfigList - The configuration that controls how Amazon AppFlow places data in the destination connector.

$sel:tasks:CreateFlow', createFlow_tasks - A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.

Request Lenses

createFlow_kmsArn :: Lens' CreateFlow (Maybe Text) Source #

The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. This is required if you do not want to use the Amazon AppFlow-managed KMS key. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key.

createFlow_description :: Lens' CreateFlow (Maybe Text) Source #

A description of the flow you want to create.

createFlow_tags :: Lens' CreateFlow (Maybe (HashMap Text Text)) Source #

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

createFlow_flowName :: Lens' CreateFlow Text Source #

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

createFlow_triggerConfig :: Lens' CreateFlow TriggerConfig Source #

The trigger settings that determine how and when the flow runs.

createFlow_sourceFlowConfig :: Lens' CreateFlow SourceFlowConfig Source #

The configuration that controls how Amazon AppFlow retrieves data from the source connector.

createFlow_destinationFlowConfigList :: Lens' CreateFlow [DestinationFlowConfig] Source #

The configuration that controls how Amazon AppFlow places data in the destination connector.

createFlow_tasks :: Lens' CreateFlow [Task] Source #

A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.

Destructuring the Response

data CreateFlowResponse Source #

See: newCreateFlowResponse smart constructor.

Constructors

CreateFlowResponse' 

Fields

Instances

Instances details
Eq CreateFlowResponse Source # 
Instance details

Defined in Amazonka.AppFlow.CreateFlow

Read CreateFlowResponse Source # 
Instance details

Defined in Amazonka.AppFlow.CreateFlow

Show CreateFlowResponse Source # 
Instance details

Defined in Amazonka.AppFlow.CreateFlow

Generic CreateFlowResponse Source # 
Instance details

Defined in Amazonka.AppFlow.CreateFlow

Associated Types

type Rep CreateFlowResponse :: Type -> Type #

NFData CreateFlowResponse Source # 
Instance details

Defined in Amazonka.AppFlow.CreateFlow

Methods

rnf :: CreateFlowResponse -> () #

type Rep CreateFlowResponse Source # 
Instance details

Defined in Amazonka.AppFlow.CreateFlow

type Rep CreateFlowResponse = D1 ('MetaData "CreateFlowResponse" "Amazonka.AppFlow.CreateFlow" "libZSservicesZSamazonka-appflowZSamazonka-appflow" 'False) (C1 ('MetaCons "CreateFlowResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "flowArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "flowStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FlowStatus)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateFlowResponse Source #

Create a value of CreateFlowResponse 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:flowArn:CreateFlowResponse', createFlowResponse_flowArn - The flow's Amazon Resource Name (ARN).

$sel:flowStatus:CreateFlowResponse', createFlowResponse_flowStatus - Indicates the current status of the flow.

$sel:httpStatus:CreateFlowResponse', createFlowResponse_httpStatus - The response's http status code.

Response Lenses

createFlowResponse_flowArn :: Lens' CreateFlowResponse (Maybe Text) Source #

The flow's Amazon Resource Name (ARN).

createFlowResponse_flowStatus :: Lens' CreateFlowResponse (Maybe FlowStatus) Source #

Indicates the current status of the flow.