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

Class: Aws::SFN::Types::GetExecutionHistoryInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-sfn/lib/aws-sdk-sfn/types.rb

Overview

Note:

When making an API call, you may pass GetExecutionHistoryInput data as a hash:

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

Instance Attribute Summary collapse

Instance Attribute Details

#execution_arnString

The Amazon Resource Name (ARN) of the execution.

Returns:

  • (String)


613
614
615
616
617
618
619
# File 'gems/aws-sdk-sfn/lib/aws-sdk-sfn/types.rb', line 613

class GetExecutionHistoryInput < Struct.new(
  :execution_arn,
  :max_results,
  :reverse_order,
  :next_token)
  include Aws::Structure
end

#max_resultsInteger

The maximum number of results that will be returned per call. nextToken can be used to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000.

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

Returns:

  • (Integer)


613
614
615
616
617
618
619
# File 'gems/aws-sdk-sfn/lib/aws-sdk-sfn/types.rb', line 613

class GetExecutionHistoryInput < Struct.new(
  :execution_arn,
  :max_results,
  :reverse_order,
  :next_token)
  include Aws::Structure
end

#next_tokenString

If a nextToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextToken. Keep all other arguments unchanged.

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

Returns:

  • (String)


613
614
615
616
617
618
619
# File 'gems/aws-sdk-sfn/lib/aws-sdk-sfn/types.rb', line 613

class GetExecutionHistoryInput < Struct.new(
  :execution_arn,
  :max_results,
  :reverse_order,
  :next_token)
  include Aws::Structure
end

#reverse_orderBoolean

Lists events in descending order of their timeStamp.

Returns:

  • (Boolean)


613
614
615
616
617
618
619
# File 'gems/aws-sdk-sfn/lib/aws-sdk-sfn/types.rb', line 613

class GetExecutionHistoryInput < Struct.new(
  :execution_arn,
  :max_results,
  :reverse_order,
  :next_token)
  include Aws::Structure
end