Struct aws_sdk_sfn::client::fluent_builders::GetExecutionHistory

pub struct GetExecutionHistory { /* private fields */ }

Fluent builder constructing a request to GetExecutionHistory.

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.

Implementations

impl GetExecutionHistory

pub async fn send(
    self
) -> Result<GetExecutionHistoryOutput, SdkError<GetExecutionHistoryError>>

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 into_paginator(self) -> GetExecutionHistoryPaginator

Create a paginator for this request

Paginators are used by calling send().await which returns a Stream.

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

The Amazon Resource Name (ARN) of the execution.

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

The Amazon Resource Name (ARN) of the execution.

pub fn max_results(self, input: i32) -> Self

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.

pub fn set_max_results(self, input: Option<i32>) -> Self

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.

pub fn reverse_order(self, input: bool) -> Self

Lists events in descending order of their timeStamp.

pub fn set_reverse_order(self, input: Option<bool>) -> Self

Lists events in descending order of their timeStamp.

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

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.

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

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.

pub fn include_execution_data(self, input: bool) -> Self

You can select whether execution data (input or output of a history event) is returned. The default is true.

pub fn set_include_execution_data(self, input: Option<bool>) -> Self

You can select whether execution data (input or output of a history event) is returned. The default is true.

Trait Implementations

impl Clone for GetExecutionHistory

fn clone(&self) -> GetExecutionHistory

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GetExecutionHistory

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

Formats the value using the given formatter.