Struct aws_sdk_transfer::operation::create_workflow::CreateWorkflowInput

#[non_exhaustive]
pub struct CreateWorkflowInput {
    pub description: Option<String>,
    pub steps: Option<Vec<WorkflowStep>>,
    pub on_exception_steps: Option<Vec<WorkflowStep>>,
    pub tags: Option<Vec<Tag>>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

description: Option<String>

A textual description for the workflow.

steps: Option<Vec<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.

• DECRYPT - Decrypt a file that was encrypted before it was uploaded.

• 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 Amazon S3 bucket and key, or the Amazon EFS file system ID and path.

on_exception_steps: Option<Vec<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: Option<Vec<Tag>>

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

Implementations

impl CreateWorkflowInput

pub fn description(&self) -> Option<&str>

A textual description for the workflow.

pub fn steps(&self) -> &[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.

• DECRYPT - Decrypt a file that was encrypted before it was uploaded.

• 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 Amazon S3 bucket and key, or the Amazon EFS file system ID and path.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .steps.is_none().

pub fn on_exception_steps(&self) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .on_exception_steps.is_none().

pub fn tags(&self) -> &[Tag]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none().

impl CreateWorkflowInput

pub fn builder() -> CreateWorkflowInputBuilder

Creates a new builder-style object to manufacture CreateWorkflowInput.

Trait Implementations

impl Clone for CreateWorkflowInput

fn clone(&self) -> CreateWorkflowInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateWorkflowInput

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

Formats the value using the given formatter.

impl PartialEq for CreateWorkflowInput

fn eq(&self, other: &CreateWorkflowInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreateWorkflowInput