Class: Aws::IoTSiteWise::Types::CancelPipelineExecutionRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-iotsitewise/types.rb

Overview

Request structure for CancelPipelineExecution operation.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#pipeline_execution_idString

The unique identifier of the pipeline execution.

Returns:

  • (String)


2738
2739
2740
2741
2742
2743
2744
2745
# File 'lib/aws-sdk-iotsitewise/types.rb', line 2738

class CancelPipelineExecutionRequest < Struct.new(
  :workspace_name,
  :pipeline_name,
  :pipeline_execution_id,
  :reason)
  SENSITIVE = []
  include Aws::Structure
end

#pipeline_nameString

The name of the pipeline.

Returns:

  • (String)


2738
2739
2740
2741
2742
2743
2744
2745
# File 'lib/aws-sdk-iotsitewise/types.rb', line 2738

class CancelPipelineExecutionRequest < Struct.new(
  :workspace_name,
  :pipeline_name,
  :pipeline_execution_id,
  :reason)
  SENSITIVE = []
  include Aws::Structure
end

#reasonString

A message describing why the pipeline execution is being cancelled.

Returns:

  • (String)


2738
2739
2740
2741
2742
2743
2744
2745
# File 'lib/aws-sdk-iotsitewise/types.rb', line 2738

class CancelPipelineExecutionRequest < Struct.new(
  :workspace_name,
  :pipeline_name,
  :pipeline_execution_id,
  :reason)
  SENSITIVE = []
  include Aws::Structure
end

#workspace_nameString

The name of the workspace.

Returns:

  • (String)


2738
2739
2740
2741
2742
2743
2744
2745
# File 'lib/aws-sdk-iotsitewise/types.rb', line 2738

class CancelPipelineExecutionRequest < Struct.new(
  :workspace_name,
  :pipeline_name,
  :pipeline_execution_id,
  :reason)
  SENSITIVE = []
  include Aws::Structure
end