Struct rusoto_stepfunctions::StepFunctionsClient
source · [−]pub struct StepFunctionsClient { /* private fields */ }
Expand description
A client for the AWS SFN API.
Implementations
sourceimpl StepFunctionsClient
impl StepFunctionsClient
sourcepub fn new(region: Region) -> StepFunctionsClient
pub fn new(region: Region) -> StepFunctionsClient
Creates a client backed by the default tokio event loop.
The client will use the default credentials provider and tls client.
pub fn new_with<P, D>(
request_dispatcher: D,
credentials_provider: P,
region: Region
) -> StepFunctionsClient where
P: ProvideAwsCredentials + Send + Sync + 'static,
D: DispatchSignedRequest + Send + Sync + 'static,
pub fn new_with_client(client: Client, region: Region) -> StepFunctionsClient
Trait Implementations
sourceimpl Clone for StepFunctionsClient
impl Clone for StepFunctionsClient
sourcefn clone(&self) -> StepFunctionsClient
fn clone(&self) -> StepFunctionsClient
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
sourceimpl StepFunctions for StepFunctionsClient
impl StepFunctions for StepFunctionsClient
sourcefn create_activity<'life0, 'async_trait>(
&'life0 self,
input: CreateActivityInput
) -> Pin<Box<dyn Future<Output = Result<CreateActivityOutput, RusotoError<CreateActivityError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn create_activity<'life0, 'async_trait>(
&'life0 self,
input: CreateActivityInput
) -> Pin<Box<dyn Future<Output = Result<CreateActivityOutput, RusotoError<CreateActivityError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Creates an activity. An activity is a task that you write in any programming language and host on any machine that has access to AWS Step Functions. Activities must poll Step Functions using the GetActivityTask
API action and respond using SendTask*
API actions. This function lets Step Functions know the existence of your activity and returns an identifier for use in a state machine and when polling from the activity.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
CreateActivity
is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. CreateActivity
's idempotency check is based on the activity name
. If a following request has different tags
values, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, tags
will not be updated, even if they are different.
sourcefn create_state_machine<'life0, 'async_trait>(
&'life0 self,
input: CreateStateMachineInput
) -> Pin<Box<dyn Future<Output = Result<CreateStateMachineOutput, RusotoError<CreateStateMachineError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn create_state_machine<'life0, 'async_trait>(
&'life0 self,
input: CreateStateMachineInput
) -> Pin<Box<dyn Future<Output = Result<CreateStateMachineOutput, RusotoError<CreateStateMachineError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Creates a state machine. A state machine consists of a collection of states that can do work (Task
states), determine to which states to transition next (Choice
states), stop an execution with an error (Fail
states), and so on. State machines are specified using a JSON-based, structured language. For more information, see Amazon States Language in the AWS Step Functions User Guide.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
CreateStateMachine
is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. CreateStateMachine
's idempotency check is based on the state machine name
, definition
, type
, LoggingConfiguration
and TracingConfiguration
. If a following request has a different roleArn
or tags
, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, roleArn
and tags
will not be updated, even if they are different.
sourcefn delete_activity<'life0, 'async_trait>(
&'life0 self,
input: DeleteActivityInput
) -> Pin<Box<dyn Future<Output = Result<DeleteActivityOutput, RusotoError<DeleteActivityError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn delete_activity<'life0, 'async_trait>(
&'life0 self,
input: DeleteActivityInput
) -> Pin<Box<dyn Future<Output = Result<DeleteActivityOutput, RusotoError<DeleteActivityError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Deletes an activity.
sourcefn delete_state_machine<'life0, 'async_trait>(
&'life0 self,
input: DeleteStateMachineInput
) -> Pin<Box<dyn Future<Output = Result<DeleteStateMachineOutput, RusotoError<DeleteStateMachineError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn delete_state_machine<'life0, 'async_trait>(
&'life0 self,
input: DeleteStateMachineInput
) -> Pin<Box<dyn Future<Output = Result<DeleteStateMachineOutput, RusotoError<DeleteStateMachineError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Deletes a state machine. This is an asynchronous operation: It sets the state machine's status to DELETING
and begins the deletion process.
For EXPRESS
state machines, the deletion will happen eventually (usually less than a minute). Running executions may emit logs after DeleteStateMachine
API is called.
sourcefn describe_activity<'life0, 'async_trait>(
&'life0 self,
input: DescribeActivityInput
) -> Pin<Box<dyn Future<Output = Result<DescribeActivityOutput, RusotoError<DescribeActivityError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn describe_activity<'life0, 'async_trait>(
&'life0 self,
input: DescribeActivityInput
) -> Pin<Box<dyn Future<Output = Result<DescribeActivityOutput, RusotoError<DescribeActivityError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Describes an activity.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
sourcefn describe_execution<'life0, 'async_trait>(
&'life0 self,
input: DescribeExecutionInput
) -> Pin<Box<dyn Future<Output = Result<DescribeExecutionOutput, RusotoError<DescribeExecutionError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn describe_execution<'life0, 'async_trait>(
&'life0 self,
input: DescribeExecutionInput
) -> Pin<Box<dyn Future<Output = Result<DescribeExecutionOutput, RusotoError<DescribeExecutionError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Describes an execution.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
This API action is not supported by EXPRESS
state machines.
sourcefn describe_state_machine<'life0, 'async_trait>(
&'life0 self,
input: DescribeStateMachineInput
) -> Pin<Box<dyn Future<Output = Result<DescribeStateMachineOutput, RusotoError<DescribeStateMachineError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn describe_state_machine<'life0, 'async_trait>(
&'life0 self,
input: DescribeStateMachineInput
) -> Pin<Box<dyn Future<Output = Result<DescribeStateMachineOutput, RusotoError<DescribeStateMachineError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Describes a state machine.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
sourcefn describe_state_machine_for_execution<'life0, 'async_trait>(
&'life0 self,
input: DescribeStateMachineForExecutionInput
) -> Pin<Box<dyn Future<Output = Result<DescribeStateMachineForExecutionOutput, RusotoError<DescribeStateMachineForExecutionError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn describe_state_machine_for_execution<'life0, 'async_trait>(
&'life0 self,
input: DescribeStateMachineForExecutionInput
) -> Pin<Box<dyn Future<Output = Result<DescribeStateMachineForExecutionOutput, RusotoError<DescribeStateMachineForExecutionError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Describes the state machine associated with a specific execution.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
This API action is not supported by EXPRESS
state machines.
sourcefn get_activity_task<'life0, 'async_trait>(
&'life0 self,
input: GetActivityTaskInput
) -> Pin<Box<dyn Future<Output = Result<GetActivityTaskOutput, RusotoError<GetActivityTaskError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn get_activity_task<'life0, 'async_trait>(
&'life0 self,
input: GetActivityTaskInput
) -> Pin<Box<dyn Future<Output = Result<GetActivityTaskOutput, RusotoError<GetActivityTaskError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Used by workers to retrieve a task (with the specified activity ARN) which has been scheduled for execution by a running state machine. This initiates a long poll, where the service holds the HTTP connection open and responds as soon as a task becomes available (i.e. an execution of a task of this type is needed.) The maximum time the service holds on to the request before responding is 60 seconds. If no task is available within 60 seconds, the poll returns a taskToken
with a null string.
Workers should set their client side socket timeout to at least 65 seconds (5 seconds higher than the maximum time the service may hold the poll request).
Polling with GetActivityTask
can cause latency in some implementations. See Avoid Latency When Polling for Activity Tasks in the Step Functions Developer Guide.
sourcefn get_execution_history<'life0, 'async_trait>(
&'life0 self,
input: GetExecutionHistoryInput
) -> Pin<Box<dyn Future<Output = Result<GetExecutionHistoryOutput, RusotoError<GetExecutionHistoryError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn get_execution_history<'life0, 'async_trait>(
&'life0 self,
input: GetExecutionHistoryInput
) -> Pin<Box<dyn Future<Output = Result<GetExecutionHistoryOutput, RusotoError<GetExecutionHistoryError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Returns the history of the specified execution as a list of events. By default, the results are returned in ascending order of the timeStamp
of the events. Use the reverseOrder
parameter to get the latest events first.
If nextToken
is returned, there are more results available. The value of nextToken
is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
This API action is not supported by EXPRESS
state machines.
sourcefn list_activities<'life0, 'async_trait>(
&'life0 self,
input: ListActivitiesInput
) -> Pin<Box<dyn Future<Output = Result<ListActivitiesOutput, RusotoError<ListActivitiesError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn list_activities<'life0, 'async_trait>(
&'life0 self,
input: ListActivitiesInput
) -> Pin<Box<dyn Future<Output = Result<ListActivitiesOutput, RusotoError<ListActivitiesError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Lists the existing activities.
If nextToken
is returned, there are more results available. The value of nextToken
is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
sourcefn list_executions<'life0, 'async_trait>(
&'life0 self,
input: ListExecutionsInput
) -> Pin<Box<dyn Future<Output = Result<ListExecutionsOutput, RusotoError<ListExecutionsError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn list_executions<'life0, 'async_trait>(
&'life0 self,
input: ListExecutionsInput
) -> Pin<Box<dyn Future<Output = Result<ListExecutionsOutput, RusotoError<ListExecutionsError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Lists the executions of a state machine that meet the filtering criteria. Results are sorted by time, with the most recent execution first.
If nextToken
is returned, there are more results available. The value of nextToken
is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
This API action is not supported by EXPRESS
state machines.
sourcefn list_state_machines<'life0, 'async_trait>(
&'life0 self,
input: ListStateMachinesInput
) -> Pin<Box<dyn Future<Output = Result<ListStateMachinesOutput, RusotoError<ListStateMachinesError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn list_state_machines<'life0, 'async_trait>(
&'life0 self,
input: ListStateMachinesInput
) -> Pin<Box<dyn Future<Output = Result<ListStateMachinesOutput, RusotoError<ListStateMachinesError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Lists the existing state machines.
If nextToken
is returned, there are more results available. The value of nextToken
is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
List tags for a given resource.
Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @
.
sourcefn send_task_failure<'life0, 'async_trait>(
&'life0 self,
input: SendTaskFailureInput
) -> Pin<Box<dyn Future<Output = Result<SendTaskFailureOutput, RusotoError<SendTaskFailureError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn send_task_failure<'life0, 'async_trait>(
&'life0 self,
input: SendTaskFailureInput
) -> Pin<Box<dyn Future<Output = Result<SendTaskFailureOutput, RusotoError<SendTaskFailureError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Used by activity workers and task states using the callback pattern to report that the task identified by the taskToken
failed.
sourcefn send_task_heartbeat<'life0, 'async_trait>(
&'life0 self,
input: SendTaskHeartbeatInput
) -> Pin<Box<dyn Future<Output = Result<SendTaskHeartbeatOutput, RusotoError<SendTaskHeartbeatError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn send_task_heartbeat<'life0, 'async_trait>(
&'life0 self,
input: SendTaskHeartbeatInput
) -> Pin<Box<dyn Future<Output = Result<SendTaskHeartbeatOutput, RusotoError<SendTaskHeartbeatError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Used by activity workers and task states using the callback pattern to report to Step Functions that the task represented by the specified taskToken
is still making progress. This action resets the Heartbeat
clock. The Heartbeat
threshold is specified in the state machine's Amazon States Language definition (HeartbeatSeconds
). This action does not in itself create an event in the execution history. However, if the task times out, the execution history contains an ActivityTimedOut
entry for activities, or a TaskTimedOut
entry for for tasks using the job run or callback pattern.
The Timeout
of a task, defined in the state machine's Amazon States Language definition, is its maximum allowed duration, regardless of the number of SendTaskHeartbeat requests received. Use HeartbeatSeconds
to configure the timeout interval for heartbeats.
sourcefn send_task_success<'life0, 'async_trait>(
&'life0 self,
input: SendTaskSuccessInput
) -> Pin<Box<dyn Future<Output = Result<SendTaskSuccessOutput, RusotoError<SendTaskSuccessError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn send_task_success<'life0, 'async_trait>(
&'life0 self,
input: SendTaskSuccessInput
) -> Pin<Box<dyn Future<Output = Result<SendTaskSuccessOutput, RusotoError<SendTaskSuccessError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Used by activity workers and task states using the callback pattern to report that the task identified by the taskToken
completed successfully.
sourcefn start_execution<'life0, 'async_trait>(
&'life0 self,
input: StartExecutionInput
) -> Pin<Box<dyn Future<Output = Result<StartExecutionOutput, RusotoError<StartExecutionError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn start_execution<'life0, 'async_trait>(
&'life0 self,
input: StartExecutionInput
) -> Pin<Box<dyn Future<Output = Result<StartExecutionOutput, RusotoError<StartExecutionError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Starts a state machine execution.
StartExecution
is idempotent. If StartExecution
is called with the same name and input as a running execution, the call will succeed and return the same response as the original request. If the execution is closed or if the input is different, it will return a 400 ExecutionAlreadyExists
error. Names can be reused after 90 days.
sourcefn start_sync_execution<'life0, 'async_trait>(
&'life0 self,
input: StartSyncExecutionInput
) -> Pin<Box<dyn Future<Output = Result<StartSyncExecutionOutput, RusotoError<StartSyncExecutionError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn start_sync_execution<'life0, 'async_trait>(
&'life0 self,
input: StartSyncExecutionInput
) -> Pin<Box<dyn Future<Output = Result<StartSyncExecutionOutput, RusotoError<StartSyncExecutionError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Starts a Synchronous Express state machine execution.
sourcefn stop_execution<'life0, 'async_trait>(
&'life0 self,
input: StopExecutionInput
) -> Pin<Box<dyn Future<Output = Result<StopExecutionOutput, RusotoError<StopExecutionError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn stop_execution<'life0, 'async_trait>(
&'life0 self,
input: StopExecutionInput
) -> Pin<Box<dyn Future<Output = Result<StopExecutionOutput, RusotoError<StopExecutionError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Stops an execution.
This API action is not supported by EXPRESS
state machines.
sourcefn tag_resource<'life0, 'async_trait>(
&'life0 self,
input: TagResourceInput
) -> Pin<Box<dyn Future<Output = Result<TagResourceOutput, RusotoError<TagResourceError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn tag_resource<'life0, 'async_trait>(
&'life0 self,
input: TagResourceInput
) -> Pin<Box<dyn Future<Output = Result<TagResourceOutput, RusotoError<TagResourceError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Add a tag to a Step Functions resource.
An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.
Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @
.
sourcefn untag_resource<'life0, 'async_trait>(
&'life0 self,
input: UntagResourceInput
) -> Pin<Box<dyn Future<Output = Result<UntagResourceOutput, RusotoError<UntagResourceError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn untag_resource<'life0, 'async_trait>(
&'life0 self,
input: UntagResourceInput
) -> Pin<Box<dyn Future<Output = Result<UntagResourceOutput, RusotoError<UntagResourceError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Remove a tag from a Step Functions resource
sourcefn update_state_machine<'life0, 'async_trait>(
&'life0 self,
input: UpdateStateMachineInput
) -> Pin<Box<dyn Future<Output = Result<UpdateStateMachineOutput, RusotoError<UpdateStateMachineError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn update_state_machine<'life0, 'async_trait>(
&'life0 self,
input: UpdateStateMachineInput
) -> Pin<Box<dyn Future<Output = Result<UpdateStateMachineOutput, RusotoError<UpdateStateMachineError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Updates an existing state machine by modifying its definition
, roleArn
, or loggingConfiguration
. Running executions will continue to use the previous definition
and roleArn
. You must include at least one of definition
or roleArn
or you will receive a MissingRequiredParameter
error.
All StartExecution
calls within a few seconds will use the updated definition
and roleArn
. Executions started immediately after calling UpdateStateMachine
may use the previous state machine definition
and roleArn
.
Auto Trait Implementations
impl !RefUnwindSafe for StepFunctionsClient
impl Send for StepFunctionsClient
impl Sync for StepFunctionsClient
impl Unpin for StepFunctionsClient
impl !UnwindSafe for StepFunctionsClient
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