Struct CancelFlowExecutionsFluentBuilder

pub struct CancelFlowExecutionsFluentBuilder { /* private fields */ }

Fluent builder constructing a request to CancelFlowExecutions.

Cancels active runs for a flow.

You can cancel all of the active runs for a flow, or you can cancel specific runs by providing their IDs.

You can cancel a flow run only when the run is in progress. You can't cancel a run that has already completed or failed. You also can't cancel a run that's scheduled to occur but hasn't started yet. To prevent a scheduled run, you can deactivate the flow with the StopFlow action.

You cannot resume a run after you cancel it.

When you send your request, the status for each run becomes CancelStarted. When the cancellation completes, the status becomes Canceled.

When you cancel a run, you still incur charges for any data that the run already processed before the cancellation. If the run had already written some data to the flow destination, then that data remains in the destination. If you configured the flow to use a batch API (such as the Salesforce Bulk API 2.0), then the run will finish reading or writing its entire batch of data after the cancellation. For these operations, the data processing charges for Amazon AppFlow apply. For the pricing information, see Amazon AppFlow pricing.

Implementations

impl CancelFlowExecutionsFluentBuilder

pub fn as_input(&self) -> &CancelFlowExecutionsInputBuilder

Access the CancelFlowExecutions as a reference.

pub async fn send( self, ) -> Result<CancelFlowExecutionsOutput, SdkError<CancelFlowExecutionsError, 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<CancelFlowExecutionsOutput, CancelFlowExecutionsError, 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 name of a flow with active runs that you want to cancel.

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

The name of a flow with active runs that you want to cancel.

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

The name of a flow with active runs that you want to cancel.

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

Appends an item to executionIds.

To override the contents of this collection use set_execution_ids.

The ID of each active run to cancel. These runs must belong to the flow you specify in your request.

If you omit this parameter, your request ends all active runs that belong to the flow.

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

The ID of each active run to cancel. These runs must belong to the flow you specify in your request.

If you omit this parameter, your request ends all active runs that belong to the flow.

pub fn get_execution_ids(&self) -> &Option<Vec<String>>

The ID of each active run to cancel. These runs must belong to the flow you specify in your request.

If you omit this parameter, your request ends all active runs that belong to the flow.

Trait Implementations

impl Clone for CancelFlowExecutionsFluentBuilder

fn clone(&self) -> CancelFlowExecutionsFluentBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CancelFlowExecutionsFluentBuilder

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

Formats the value using the given formatter.