You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::States::Types::GetExecutionHistoryInput

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing GetExecutionHistoryInput as input to an Aws::Client method, you can use a vanilla Hash:

{
  execution_arn: "Arn", # required
  max_results: 1,
  reverse_order: false,
  next_token: "PageToken",
  include_execution_data: false,
}

Instance Attribute Summary collapse

Instance Attribute Details

#execution_arnString

The Amazon Resource Name (ARN) of the execution.

Returns:

  • (String)

    The Amazon Resource Name (ARN) of the execution.

#include_execution_dataBoolean

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

Returns:

  • (Boolean)

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

#max_resultsInteger

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.

Returns:

  • (Integer)

    The maximum number of results that are returned per call.

#next_tokenString

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.

Returns:

  • (String)

    If nextToken is returned, there are more results available.

#reverse_orderBoolean

Lists events in descending order of their timeStamp.

Returns:

  • (Boolean)

    Lists events in descending order of their timeStamp.