Class: Aws::IoTSiteWise::Types::ListPipelineExecutionsRequest

Inherits:

Struct

• Object
• Struct
• Aws::IoTSiteWise::Types::ListPipelineExecutionsRequest

Includes:

Structure

Defined in:

lib/aws-sdk-iotsitewise/types.rb

Overview

Request structure for ListPipelineExecutions operation.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #end_time_after ⇒ Time

  Inclusive lower bound on execution end time (ISO-8601).

• #end_time_before ⇒ Time

  Exclusive upper bound on execution end time (ISO-8601).

• #max_results ⇒ Integer

  The maximum number of results to return per request.

• #next_token ⇒ String

  The token to be used for the next set of paginated results.

• #pipeline_name ⇒ String

  The name of the pipeline.

• #start_time_after ⇒ Time

  Inclusive lower bound on execution start time (ISO-8601).

• #start_time_before ⇒ Time

  Exclusive upper bound on execution start time (ISO-8601).

• #state ⇒ String

  Filter by execution state.

• #workspace_name ⇒ String

  The name of the workspace.

Instance Attribute Details

#end_time_after ⇒ Time

Inclusive lower bound on execution end time (ISO-8601). Only executions with endTime >= endTimeAfter are returned. Cannot be combined with startTimeAfter or startTimeBefore. Only matches executions in terminal states.

Returns:

• (Time)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 11699

class ListPipelineExecutionsRequest < Struct.new(
  :workspace_name,
  :pipeline_name,
  :next_token,
  :max_results,
  :state,
  :start_time_after,
  :start_time_before,
  :end_time_after,
  :end_time_before)
  SENSITIVE = []
  include Aws::Structure
end

#end_time_before ⇒ Time

Exclusive upper bound on execution end time (ISO-8601). Only executions with endTime < endTimeBefore are returned. Cannot be combined with startTimeAfter or startTimeBefore. Only matches executions in terminal states.

Returns:

• (Time)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 11699

class ListPipelineExecutionsRequest < Struct.new(
  :workspace_name,
  :pipeline_name,
  :next_token,
  :max_results,
  :state,
  :start_time_after,
  :start_time_before,
  :end_time_after,
  :end_time_before)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of results to return per request. This is an upper bound; the actual number of results may be less. Default: 50.

Returns:

• (Integer)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 11699

class ListPipelineExecutionsRequest < Struct.new(
  :workspace_name,
  :pipeline_name,
  :next_token,
  :max_results,
  :state,
  :start_time_after,
  :start_time_before,
  :end_time_after,
  :end_time_before)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

The token to be used for the next set of paginated results.

Returns:

• (String)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 11699

class ListPipelineExecutionsRequest < Struct.new(
  :workspace_name,
  :pipeline_name,
  :next_token,
  :max_results,
  :state,
  :start_time_after,
  :start_time_before,
  :end_time_after,
  :end_time_before)
  SENSITIVE = []
  include Aws::Structure
end

#pipeline_name ⇒ String

The name of the pipeline.

Returns:

• (String)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 11699

class ListPipelineExecutionsRequest < Struct.new(
  :workspace_name,
  :pipeline_name,
  :next_token,
  :max_results,
  :state,
  :start_time_after,
  :start_time_before,
  :end_time_after,
  :end_time_before)
  SENSITIVE = []
  include Aws::Structure
end

#start_time_after ⇒ Time

Inclusive lower bound on execution start time (ISO-8601). Only executions with startTime >= startTimeAfter are returned. Cannot be combined with endTimeAfter or endTimeBefore.

Returns:

• (Time)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 11699

class ListPipelineExecutionsRequest < Struct.new(
  :workspace_name,
  :pipeline_name,
  :next_token,
  :max_results,
  :state,
  :start_time_after,
  :start_time_before,
  :end_time_after,
  :end_time_before)
  SENSITIVE = []
  include Aws::Structure
end

#start_time_before ⇒ Time

Exclusive upper bound on execution start time (ISO-8601). Only executions with startTime < startTimeBefore are returned. Cannot be combined with endTimeAfter or endTimeBefore.

Returns:

• (Time)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 11699

class ListPipelineExecutionsRequest < Struct.new(
  :workspace_name,
  :pipeline_name,
  :next_token,
  :max_results,
  :state,
  :start_time_after,
  :start_time_before,
  :end_time_after,
  :end_time_before)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ String

Filter by execution state. If not specified, executions in all states are returned.

Returns:

• (String)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 11699

class ListPipelineExecutionsRequest < Struct.new(
  :workspace_name,
  :pipeline_name,
  :next_token,
  :max_results,
  :state,
  :start_time_after,
  :start_time_before,
  :end_time_after,
  :end_time_before)
  SENSITIVE = []
  include Aws::Structure
end

#workspace_name ⇒ String

The name of the workspace.

Returns:

• (String)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 11699

class ListPipelineExecutionsRequest < Struct.new(
  :workspace_name,
  :pipeline_name,
  :next_token,
  :max_results,
  :state,
  :start_time_after,
  :start_time_before,
  :end_time_after,
  :end_time_before)
  SENSITIVE = []
  include Aws::Structure
end