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

Description

Allows you to create a workflow with specified steps and step details the workflow invokes after file transfer completes. After creating a workflow, you can associate the workflow created with any transfer servers by specifying the workflow-details field in CreateServer and UpdateServer operations.

Synopsis

Creating a Request

data CreateWorkflow Source #

See: newCreateWorkflow smart constructor.

Constructors

CreateWorkflow' 

Fields

  • description :: Maybe Text

    A textual description for the workflow.

  • onExceptionSteps :: Maybe [WorkflowStep]

    Specifies the steps (actions) to take if errors are encountered during execution of the workflow.

    For custom steps, the lambda function needs to send FAILURE to the call back API to kick off the exception steps. Additionally, if the lambda does not send SUCCESS before it times out, the exception steps are executed.

  • tags :: Maybe (NonEmpty Tag)

    Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.

  • steps :: [WorkflowStep]

    Specifies the details for the steps that are in the specified workflow.

    The TYPE specifies which of the following actions is being taken for this step.

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

    Currently, copying and tagging are supported only on S3.

    For file location, you specify either the S3 bucket and key, or the EFS file system ID and path.

Instances

Instances details
ToJSON CreateWorkflow Source # 
Instance details

Defined in Amazonka.Transfer.CreateWorkflow

Methods

toJSON :: CreateWorkflow -> Value #

toEncoding :: CreateWorkflow -> Encoding #

toJSONList :: [CreateWorkflow] -> Value #

toEncodingList :: [CreateWorkflow] -> Encoding #

ToHeaders CreateWorkflow Source # 
Instance details

Defined in Amazonka.Transfer.CreateWorkflow

Methods

toHeaders :: CreateWorkflow -> [Header] #

ToPath CreateWorkflow Source # 
Instance details

Defined in Amazonka.Transfer.CreateWorkflow

Methods

toPath :: CreateWorkflow -> ByteString #

ToQuery CreateWorkflow Source # 
Instance details

Defined in Amazonka.Transfer.CreateWorkflow

Methods

toQuery :: CreateWorkflow -> QueryString #

AWSRequest CreateWorkflow Source # 
Instance details

Defined in Amazonka.Transfer.CreateWorkflow

Associated Types

type AWSResponse CreateWorkflow #

Methods

request :: (Service -> Service) -> CreateWorkflow -> Request CreateWorkflow #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateWorkflow -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateWorkflow))) #

Generic CreateWorkflow Source # 
Instance details

Defined in Amazonka.Transfer.CreateWorkflow

Associated Types

type Rep CreateWorkflow :: Type -> Type #

Methods

from :: CreateWorkflow -> Rep CreateWorkflow x #

to :: Rep CreateWorkflow x -> CreateWorkflow #

Read CreateWorkflow Source # 
Instance details

Defined in Amazonka.Transfer.CreateWorkflow

Methods

readsPrec :: Int -> ReadS CreateWorkflow #

readList :: ReadS [CreateWorkflow] #

readPrec :: ReadPrec CreateWorkflow #

readListPrec :: ReadPrec [CreateWorkflow] #

Show CreateWorkflow Source # 
Instance details

Defined in Amazonka.Transfer.CreateWorkflow

Methods

showsPrec :: Int -> CreateWorkflow -> ShowS #

show :: CreateWorkflow -> String #

showList :: [CreateWorkflow] -> ShowS #

NFData CreateWorkflow Source # 
Instance details

Defined in Amazonka.Transfer.CreateWorkflow

Methods

rnf :: CreateWorkflow -> () #

Eq CreateWorkflow Source # 
Instance details

Defined in Amazonka.Transfer.CreateWorkflow

Methods

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

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

Hashable CreateWorkflow Source # 
Instance details

Defined in Amazonka.Transfer.CreateWorkflow

Methods

hashWithSalt :: Int -> CreateWorkflow -> Int #

hash :: CreateWorkflow -> Int #

type AWSResponse CreateWorkflow Source # 
Instance details

Defined in Amazonka.Transfer.CreateWorkflow

type AWSResponse CreateWorkflow = CreateWorkflowResponse
type Rep CreateWorkflow Source # 
Instance details

Defined in Amazonka.Transfer.CreateWorkflow

type Rep CreateWorkflow = D1 ('MetaData "CreateWorkflow" "Amazonka.Transfer.CreateWorkflow" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "CreateWorkflow'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "onExceptionSteps") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [WorkflowStep]))) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag))) :*: S1 ('MetaSel ('Just "steps") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [WorkflowStep]))))

newCreateWorkflow :: CreateWorkflow Source #

Create a value of CreateWorkflow 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:

CreateWorkflow, createWorkflow_description - A textual description for the workflow.

CreateWorkflow, createWorkflow_onExceptionSteps - Specifies the steps (actions) to take if errors are encountered during execution of the workflow.

For custom steps, the lambda function needs to send FAILURE to the call back API to kick off the exception steps. Additionally, if the lambda does not send SUCCESS before it times out, the exception steps are executed.

CreateWorkflow, createWorkflow_tags - Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.

CreateWorkflow, createWorkflow_steps - Specifies the details for the steps that are in the specified workflow.

The TYPE specifies which of the following actions is being taken for this step.

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

Currently, copying and tagging are supported only on S3.

For file location, you specify either the S3 bucket and key, or the EFS file system ID and path.

Request Lenses

createWorkflow_description :: Lens' CreateWorkflow (Maybe Text) Source #

A textual description for the workflow.

createWorkflow_onExceptionSteps :: Lens' CreateWorkflow (Maybe [WorkflowStep]) Source #

Specifies the steps (actions) to take if errors are encountered during execution of the workflow.

For custom steps, the lambda function needs to send FAILURE to the call back API to kick off the exception steps. Additionally, if the lambda does not send SUCCESS before it times out, the exception steps are executed.

createWorkflow_tags :: Lens' CreateWorkflow (Maybe (NonEmpty Tag)) Source #

Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.

createWorkflow_steps :: Lens' CreateWorkflow [WorkflowStep] Source #

Specifies the details for the steps that are in the specified workflow.

The TYPE specifies which of the following actions is being taken for this step.

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

Currently, copying and tagging are supported only on S3.

For file location, you specify either the S3 bucket and key, or the EFS file system ID and path.

Destructuring the Response

data CreateWorkflowResponse Source #

See: newCreateWorkflowResponse smart constructor.

Constructors

CreateWorkflowResponse' 

Fields

Instances

Instances details
Generic CreateWorkflowResponse Source # 
Instance details

Defined in Amazonka.Transfer.CreateWorkflow

Associated Types

type Rep CreateWorkflowResponse :: Type -> Type #

Methods

from :: CreateWorkflowResponse -> Rep CreateWorkflowResponse x #

to :: Rep CreateWorkflowResponse x -> CreateWorkflowResponse #

Read CreateWorkflowResponse Source # 
Instance details

Defined in Amazonka.Transfer.CreateWorkflow

Methods

readsPrec :: Int -> ReadS CreateWorkflowResponse #

readList :: ReadS [CreateWorkflowResponse] #

readPrec :: ReadPrec CreateWorkflowResponse #

readListPrec :: ReadPrec [CreateWorkflowResponse] #

Show CreateWorkflowResponse Source # 
Instance details

Defined in Amazonka.Transfer.CreateWorkflow

Methods

showsPrec :: Int -> CreateWorkflowResponse -> ShowS #

show :: CreateWorkflowResponse -> String #

showList :: [CreateWorkflowResponse] -> ShowS #

NFData CreateWorkflowResponse Source # 
Instance details

Defined in Amazonka.Transfer.CreateWorkflow

Methods

rnf :: CreateWorkflowResponse -> () #

Eq CreateWorkflowResponse Source # 
Instance details

Defined in Amazonka.Transfer.CreateWorkflow

Methods

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

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

type Rep CreateWorkflowResponse Source # 
Instance details

Defined in Amazonka.Transfer.CreateWorkflow

type Rep CreateWorkflowResponse = D1 ('MetaData "CreateWorkflowResponse" "Amazonka.Transfer.CreateWorkflow" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "CreateWorkflowResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "workflowId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newCreateWorkflowResponse Source #

Arguments

:: Int

$sel:httpStatus:CreateWorkflowResponse'

-> Text

CreateWorkflowResponse

-> CreateWorkflowResponse 

Create a value of CreateWorkflowResponse 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:httpStatus:CreateWorkflowResponse', createWorkflowResponse_httpStatus - The response's http status code.

CreateWorkflowResponse, createWorkflowResponse_workflowId - A unique identifier for the workflow.

Response Lenses

createWorkflowResponse_httpStatus :: Lens' CreateWorkflowResponse Int Source #

The response's http status code.

createWorkflowResponse_workflowId :: Lens' CreateWorkflowResponse Text Source #

A unique identifier for the workflow.