Class: Aws::Athena::Types::ListCalculationExecutionsRequest

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#max_resultsInteger

The maximum number of calculation executions to return.

Returns:

  • (Integer)


2111
2112
2113
2114
2115
2116
2117
2118
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 2111

class ListCalculationExecutionsRequest < Struct.new(
  :session_id,
  :state_filter,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

Returns:

  • (String)


2111
2112
2113
2114
2115
2116
2117
2118
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 2111

class ListCalculationExecutionsRequest < Struct.new(
  :session_id,
  :state_filter,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#session_idString

The session ID.

Returns:

  • (String)


2111
2112
2113
2114
2115
2116
2117
2118
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 2111

class ListCalculationExecutionsRequest < Struct.new(
  :session_id,
  :state_filter,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#state_filterString

A filter for a specific calculation execution state. A description of each state follows.

CREATING - The calculation is in the process of being created.

CREATED - The calculation has been created and is ready to run.

QUEUED - The calculation has been queued for processing.

RUNNING - The calculation is running.

CANCELING - A request to cancel the calculation has been received and the system is working to stop it.

CANCELED - The calculation is no longer running as the result of a cancel request.

COMPLETED - The calculation has completed without error.

FAILED - The calculation failed and is no longer running.

Returns:

  • (String)


2111
2112
2113
2114
2115
2116
2117
2118
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 2111

class ListCalculationExecutionsRequest < Struct.new(
  :session_id,
  :state_filter,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end