Struct aws_sdk_transfer::client::fluent_builders::CreateWorkflow

pub struct CreateWorkflow { /* private fields */ }

Fluent builder constructing a request to CreateWorkflow.

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.

Implementations

impl CreateWorkflow

pub async fn customize(
    self
) -> Result<CustomizableOperation<CreateWorkflow, AwsResponseRetryClassifier>, SdkError<CreateWorkflowError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(
    self
) -> Result<CreateWorkflowOutput, SdkError<CreateWorkflowError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn description(self, input: impl Into<String>) -> Self

A textual description for the workflow.

pub fn set_description(self, input: Option<String>) -> Self

A textual description for the workflow.

pub fn steps(self, input: WorkflowStep) -> Self

Appends an item to Steps.

To override the contents of this collection use set_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.

pub fn set_steps(self, input: Option<Vec<WorkflowStep>>) -> Self

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.

pub fn on_exception_steps(self, input: WorkflowStep) -> Self

Appends an item to OnExceptionSteps.

To override the contents of this collection use set_on_exception_steps.

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.

pub fn set_on_exception_steps(self, input: Option<Vec<WorkflowStep>>) -> Self

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.

pub fn tags(self, input: Tag) -> Self

Appends an item to Tags.

To override the contents of this collection use set_tags.

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

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

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

Trait Implementations

impl Clone for CreateWorkflow

fn clone(&self) -> CreateWorkflow

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateWorkflow

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.