Struct aws_sdk_swf::client::fluent_builders::GetWorkflowExecutionHistory

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

Fluent builder constructing a request to GetWorkflowExecutionHistory.

Returns the history of the specified workflow execution. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.

This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

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

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

pub async fn send(
    self
) -> Result<GetWorkflowExecutionHistoryOutput, SdkError<GetWorkflowExecutionHistoryError>> where
    R::Policy: SmithyRetryPolicy<GetWorkflowExecutionHistoryInputOperationOutputAlias, GetWorkflowExecutionHistoryOutput, GetWorkflowExecutionHistoryError, GetWorkflowExecutionHistoryInputOperationRetryAlias>, 

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 domain(self, inp: impl Into<String>) -> Self

The name of the domain containing the workflow execution.

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

The name of the domain containing the workflow execution.

pub fn execution(self, inp: WorkflowExecution) -> Self

Specifies the workflow execution for which to return the history.

pub fn set_execution(self, input: Option<WorkflowExecution>) -> Self

Specifies the workflow execution for which to return the history.

pub fn next_page_token(self, inp: impl Into<String>) -> Self

If NextPageToken is returned there are more results available. The value of NextPageToken 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 60 seconds. Using an expired pagination token will return a 400 error: "Specified token has exceeded its maximum lifetime".

The configured maximumPageSize determines how many results can be returned in a single call.

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

If NextPageToken is returned there are more results available. The value of NextPageToken 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 60 seconds. Using an expired pagination token will return a 400 error: "Specified token has exceeded its maximum lifetime".

The configured maximumPageSize determines how many results can be returned in a single call.

pub fn maximum_page_size(self, inp: i32) -> Self

The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

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

The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

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

When set to true, returns the events in reverse order. By default the results are returned in ascending order of the eventTimeStamp of the events.

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

When set to true, returns the events in reverse order. By default the results are returned in ascending order of the eventTimeStamp of the events.

Trait Implementations

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

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

Formats the value using the given formatter.