Struct aws_sdk_sfn::client::Client

pub struct Client<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* fields omitted */ }

Client for AWS Step Functions

Client for invoking operations on AWS Step Functions. Each operation on AWS Step Functions is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Examples

Constructing a client and invoking an operation

    // create a shared configuration. This can be used & shared between multiple service clients.
    let shared_config = aws_config::load_from_env().await;
    let client = aws_sdk_sfn::Client::new(&shared_config);
    // invoke an operation
    /* let rsp = client
        .<operation_name>().
        .<param>("some value")
        .send().await; */

Constructing a client with custom configuration

use aws_config::RetryConfig;
    let shared_config = aws_config::load_from_env().await;
    let config = aws_sdk_sfn::config::Builder::from(&shared_config)
        .retry_config(RetryConfig::disabled())
        .build();
    let client = aws_sdk_sfn::Client::from_conf(config);

Implementations

impl<C, M, R> Client<C, M, R>

pub fn with_config(client: Client<C, M, R>, conf: Config) -> Self

Creates a client with the given service configuration.

pub fn conf(&self) -> &Config

Returns the client’s configuration.

impl<C, M, R> Client<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub fn create_activity(&self) -> CreateActivity<C, M, R>

Constructs a fluent builder for the CreateActivity operation.

See CreateActivity for more information about the operation and its arguments.

pub fn create_state_machine(&self) -> CreateStateMachine<C, M, R>

Constructs a fluent builder for the CreateStateMachine operation.

See CreateStateMachine for more information about the operation and its arguments.

pub fn delete_activity(&self) -> DeleteActivity<C, M, R>

Constructs a fluent builder for the DeleteActivity operation.

See DeleteActivity for more information about the operation and its arguments.

pub fn delete_state_machine(&self) -> DeleteStateMachine<C, M, R>

Constructs a fluent builder for the DeleteStateMachine operation.

See DeleteStateMachine for more information about the operation and its arguments.

pub fn describe_activity(&self) -> DescribeActivity<C, M, R>

Constructs a fluent builder for the DescribeActivity operation.

See DescribeActivity for more information about the operation and its arguments.

pub fn describe_execution(&self) -> DescribeExecution<C, M, R>

Constructs a fluent builder for the DescribeExecution operation.

See DescribeExecution for more information about the operation and its arguments.

pub fn describe_state_machine(&self) -> DescribeStateMachine<C, M, R>

Constructs a fluent builder for the DescribeStateMachine operation.

See DescribeStateMachine for more information about the operation and its arguments.

pub fn describe_state_machine_for_execution(
    &self
) -> DescribeStateMachineForExecution<C, M, R>

Constructs a fluent builder for the DescribeStateMachineForExecution operation.

See DescribeStateMachineForExecution for more information about the operation and its arguments.

pub fn get_activity_task(&self) -> GetActivityTask<C, M, R>

Constructs a fluent builder for the GetActivityTask operation.

See GetActivityTask for more information about the operation and its arguments.

pub fn get_execution_history(&self) -> GetExecutionHistory<C, M, R>

Constructs a fluent builder for the GetExecutionHistory operation.

See GetExecutionHistory for more information about the operation and its arguments. This operation supports pagination. See into_paginator().

pub fn list_activities(&self) -> ListActivities<C, M, R>

Constructs a fluent builder for the ListActivities operation.

See ListActivities for more information about the operation and its arguments. This operation supports pagination. See into_paginator().

pub fn list_executions(&self) -> ListExecutions<C, M, R>

Constructs a fluent builder for the ListExecutions operation.

See ListExecutions for more information about the operation and its arguments. This operation supports pagination. See into_paginator().

pub fn list_state_machines(&self) -> ListStateMachines<C, M, R>

Constructs a fluent builder for the ListStateMachines operation.

See ListStateMachines for more information about the operation and its arguments. This operation supports pagination. See into_paginator().

pub fn list_tags_for_resource(&self) -> ListTagsForResource<C, M, R>

Constructs a fluent builder for the ListTagsForResource operation.

See ListTagsForResource for more information about the operation and its arguments.

pub fn send_task_failure(&self) -> SendTaskFailure<C, M, R>

Constructs a fluent builder for the SendTaskFailure operation.

See SendTaskFailure for more information about the operation and its arguments.

pub fn send_task_heartbeat(&self) -> SendTaskHeartbeat<C, M, R>

Constructs a fluent builder for the SendTaskHeartbeat operation.

See SendTaskHeartbeat for more information about the operation and its arguments.

pub fn send_task_success(&self) -> SendTaskSuccess<C, M, R>

Constructs a fluent builder for the SendTaskSuccess operation.

See SendTaskSuccess for more information about the operation and its arguments.

pub fn start_execution(&self) -> StartExecution<C, M, R>

Constructs a fluent builder for the StartExecution operation.

See StartExecution for more information about the operation and its arguments.

pub fn start_sync_execution(&self) -> StartSyncExecution<C, M, R>

Constructs a fluent builder for the StartSyncExecution operation.

See StartSyncExecution for more information about the operation and its arguments.

pub fn stop_execution(&self) -> StopExecution<C, M, R>

Constructs a fluent builder for the StopExecution operation.

See StopExecution for more information about the operation and its arguments.

pub fn tag_resource(&self) -> TagResource<C, M, R>

Constructs a fluent builder for the TagResource operation.

See TagResource for more information about the operation and its arguments.

pub fn untag_resource(&self) -> UntagResource<C, M, R>

Constructs a fluent builder for the UntagResource operation.

See UntagResource for more information about the operation and its arguments.

pub fn update_state_machine(&self) -> UpdateStateMachine<C, M, R>

Constructs a fluent builder for the UpdateStateMachine operation.

See UpdateStateMachine for more information about the operation and its arguments.

impl<C> Client<C, DefaultMiddleware, Standard>

pub fn from_conf_conn(conf: Config, conn: C) -> Self

Creates a client with the given service config and connector override.

impl Client<DynConnector, DefaultMiddleware, Standard>

pub fn new(config: &Config) -> Self

Creates a new client from a shared config.

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Trait Implementations

impl<C, M, R> Clone for Client<C, M, R>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug, M: Debug, R: Debug> Debug for Client<C, M, R>

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

Formats the value using the given formatter.

impl<C, M, R> From<Client<C, M, R>> for Client<C, M, R>

fn from(client: Client<C, M, R>) -> Self

Performs the conversion.