Struct aws_sdk_transfer::client::fluent_builders::CreateWorkflow
source · [−]pub struct CreateWorkflow { /* private fields */ }
Expand description
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
sourceimpl CreateWorkflow
impl CreateWorkflow
sourcepub async fn send(
self
) -> Result<CreateWorkflowOutput, SdkError<CreateWorkflowError>>
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.
sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
A textual description for the workflow.
sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
A textual description for the workflow.
sourcepub fn steps(self, input: WorkflowStep) -> Self
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: custom step with a lambda 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 filesystem ID and path.
sourcepub fn set_steps(self, input: Option<Vec<WorkflowStep>>) -> Self
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: custom step with a lambda 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 filesystem ID and path.
sourcepub fn on_exception_steps(self, input: WorkflowStep) -> Self
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.
sourcepub fn set_on_exception_steps(self, input: Option<Vec<WorkflowStep>>) -> Self
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.
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.
Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.
Trait Implementations
sourceimpl Clone for CreateWorkflow
impl Clone for CreateWorkflow
sourcefn clone(&self) -> CreateWorkflow
fn clone(&self) -> CreateWorkflow
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
Auto Trait Implementations
impl !RefUnwindSafe for CreateWorkflow
impl Send for CreateWorkflow
impl Sync for CreateWorkflow
impl Unpin for CreateWorkflow
impl !UnwindSafe for CreateWorkflow
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more