pub struct Client { /* private fields */ }
Expand description

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

Creates a client with the given service configuration.

Returns the client’s configuration.

Constructs a fluent builder for the CreateActivity operation.

Constructs a fluent builder for the CreateStateMachine operation.

Constructs a fluent builder for the DeleteActivity operation.

Constructs a fluent builder for the DeleteStateMachine operation.

Constructs a fluent builder for the DescribeActivity operation.

Constructs a fluent builder for the DescribeExecution operation.

Constructs a fluent builder for the DescribeStateMachine operation.

Constructs a fluent builder for the DescribeStateMachineForExecution operation.

Constructs a fluent builder for the GetActivityTask operation.

Constructs a fluent builder for the GetExecutionHistory operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListActivities operation. This operation supports pagination; See into_paginator().

  • The fluent builder is configurable:
    • max_results(i32) / set_max_results(i32):

      The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.

      This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

    • next_token(impl Into<String>) / set_next_token(Option<String>):

      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.

  • On success, responds with ListActivitiesOutput with field(s):
    • activities(Option<Vec<ActivityListItem>>):

      The list of activities.

    • next_token(Option<String>):

      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.

  • On failure, responds with SdkError<ListActivitiesError>

Constructs a fluent builder for the ListExecutions operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListStateMachines operation. This operation supports pagination; See into_paginator().

  • The fluent builder is configurable:
    • max_results(i32) / set_max_results(i32):

      The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.

      This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

    • next_token(impl Into<String>) / set_next_token(Option<String>):

      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.

  • On success, responds with ListStateMachinesOutput with field(s):
    • state_machines(Option<Vec<StateMachineListItem>>): (undocumented)
    • next_token(Option<String>):

      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.

  • On failure, responds with SdkError<ListStateMachinesError>

Constructs a fluent builder for the ListTagsForResource operation.

Constructs a fluent builder for the SendTaskFailure operation.

Constructs a fluent builder for the SendTaskHeartbeat operation.

Constructs a fluent builder for the SendTaskSuccess operation.

Constructs a fluent builder for the StartExecution operation.

Constructs a fluent builder for the StartSyncExecution operation.

Constructs a fluent builder for the StopExecution operation.

Constructs a fluent builder for the TagResource operation.

Constructs a fluent builder for the UntagResource operation.

Constructs a fluent builder for the UpdateStateMachine operation.

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

Creates a new client from a shared config.

Creates a new client from the service Config.

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Converts to this type from the input type.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more