Struct aws_sdk_appflow::operation::start_flow::builders::StartFlowFluentBuilder

pub struct StartFlowFluentBuilder { /* private fields */ }

Fluent builder constructing a request to StartFlow.

Activates an existing flow. For on-demand flows, this operation runs the flow immediately. For schedule and event-triggered flows, this operation activates the flow.

Implementations

impl StartFlowFluentBuilder

pub fn as_input(&self) -> &StartFlowInputBuilder

Access the StartFlow as a reference.

pub async fn send( self, ) -> Result<StartFlowOutput, SdkError<StartFlowError, HttpResponse>>

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 customize( self, ) -> CustomizableOperation<StartFlowOutput, StartFlowError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

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

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

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

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

pub fn get_flow_name(&self) -> &Option<String>

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

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

The clientToken parameter is an idempotency token. It ensures that your StartFlow request completes only once. You choose the value to pass. For example, if you don't receive a response from your request, you can safely retry the request with the same clientToken parameter value.

If you omit a clientToken value, the Amazon Web Services SDK that you are using inserts a value for you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own value for other use cases.

If you specify input parameters that differ from your first request, an error occurs for flows that run on a schedule or based on an event. However, the error doesn't occur for flows that run on demand. You set the conditions that initiate your flow for the triggerConfig parameter.

If you use a different value for clientToken, Amazon AppFlow considers it a new call to StartFlow. The token is active for 8 hours.

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

The clientToken parameter is an idempotency token. It ensures that your StartFlow request completes only once. You choose the value to pass. For example, if you don't receive a response from your request, you can safely retry the request with the same clientToken parameter value.

If you omit a clientToken value, the Amazon Web Services SDK that you are using inserts a value for you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own value for other use cases.

If you specify input parameters that differ from your first request, an error occurs for flows that run on a schedule or based on an event. However, the error doesn't occur for flows that run on demand. You set the conditions that initiate your flow for the triggerConfig parameter.

If you use a different value for clientToken, Amazon AppFlow considers it a new call to StartFlow. The token is active for 8 hours.

pub fn get_client_token(&self) -> &Option<String>

The clientToken parameter is an idempotency token. It ensures that your StartFlow request completes only once. You choose the value to pass. For example, if you don't receive a response from your request, you can safely retry the request with the same clientToken parameter value.

If you omit a clientToken value, the Amazon Web Services SDK that you are using inserts a value for you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own value for other use cases.

If you specify input parameters that differ from your first request, an error occurs for flows that run on a schedule or based on an event. However, the error doesn't occur for flows that run on demand. You set the conditions that initiate your flow for the triggerConfig parameter.

If you use a different value for clientToken, Amazon AppFlow considers it a new call to StartFlow. The token is active for 8 hours.

Trait Implementations

impl Clone for StartFlowFluentBuilder

fn clone(&self) -> StartFlowFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StartFlowFluentBuilder

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

Formats the value using the given formatter.