Struct aws_sdk_swf::operation::request_cancel_workflow_execution::builders::RequestCancelWorkflowExecutionFluentBuilder
source · pub struct RequestCancelWorkflowExecutionFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to RequestCancelWorkflowExecution
.
Records a WorkflowExecutionCancelRequested
event in the currently running workflow execution identified by the given domain, workflowId, and runId. This logically requests the cancellation of the workflow execution as a whole. It is up to the decider to take appropriate actions when it receives an execution history with this event.
If the runId isn't specified, the WorkflowExecutionCancelRequested
event is recorded in the history of the current open workflow execution with the specified workflowId in the domain.
Because this action allows the workflow to properly clean up and gracefully close, it should be used instead of TerminateWorkflowExecution
when possible.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
-
Use a
Resource
element with the domain name to limit the action to only specified domains. -
Use an
Action
element to allow or deny permission to call this action. -
You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause
parameter is set to OPERATION_NOT_PERMITTED
. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
Implementations§
source§impl RequestCancelWorkflowExecutionFluentBuilder
impl RequestCancelWorkflowExecutionFluentBuilder
sourcepub fn as_input(&self) -> &RequestCancelWorkflowExecutionInputBuilder
pub fn as_input(&self) -> &RequestCancelWorkflowExecutionInputBuilder
Access the RequestCancelWorkflowExecution as a reference.
sourcepub async fn send(
self
) -> Result<RequestCancelWorkflowExecutionOutput, SdkError<RequestCancelWorkflowExecutionError, HttpResponse>>
pub async fn send( self ) -> Result<RequestCancelWorkflowExecutionOutput, SdkError<RequestCancelWorkflowExecutionError, 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.
sourcepub fn customize(
self
) -> CustomizableOperation<RequestCancelWorkflowExecutionOutput, RequestCancelWorkflowExecutionError, Self>
pub fn customize( self ) -> CustomizableOperation<RequestCancelWorkflowExecutionOutput, RequestCancelWorkflowExecutionError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn domain(self, input: impl Into<String>) -> Self
pub fn domain(self, input: impl Into<String>) -> Self
The name of the domain containing the workflow execution to cancel.
sourcepub fn set_domain(self, input: Option<String>) -> Self
pub fn set_domain(self, input: Option<String>) -> Self
The name of the domain containing the workflow execution to cancel.
sourcepub fn get_domain(&self) -> &Option<String>
pub fn get_domain(&self) -> &Option<String>
The name of the domain containing the workflow execution to cancel.
sourcepub fn workflow_id(self, input: impl Into<String>) -> Self
pub fn workflow_id(self, input: impl Into<String>) -> Self
The workflowId of the workflow execution to cancel.
sourcepub fn set_workflow_id(self, input: Option<String>) -> Self
pub fn set_workflow_id(self, input: Option<String>) -> Self
The workflowId of the workflow execution to cancel.
sourcepub fn get_workflow_id(&self) -> &Option<String>
pub fn get_workflow_id(&self) -> &Option<String>
The workflowId of the workflow execution to cancel.
sourcepub fn run_id(self, input: impl Into<String>) -> Self
pub fn run_id(self, input: impl Into<String>) -> Self
The runId of the workflow execution to cancel.
sourcepub fn set_run_id(self, input: Option<String>) -> Self
pub fn set_run_id(self, input: Option<String>) -> Self
The runId of the workflow execution to cancel.
sourcepub fn get_run_id(&self) -> &Option<String>
pub fn get_run_id(&self) -> &Option<String>
The runId of the workflow execution to cancel.
Trait Implementations§
source§impl Clone for RequestCancelWorkflowExecutionFluentBuilder
impl Clone for RequestCancelWorkflowExecutionFluentBuilder
source§fn clone(&self) -> RequestCancelWorkflowExecutionFluentBuilder
fn clone(&self) -> RequestCancelWorkflowExecutionFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for RequestCancelWorkflowExecutionFluentBuilder
impl !RefUnwindSafe for RequestCancelWorkflowExecutionFluentBuilder
impl Send for RequestCancelWorkflowExecutionFluentBuilder
impl Sync for RequestCancelWorkflowExecutionFluentBuilder
impl Unpin for RequestCancelWorkflowExecutionFluentBuilder
impl !UnwindSafe for RequestCancelWorkflowExecutionFluentBuilder
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more