Class: Aws::IoTSiteWise::Types::StartPipelineExecutionRequest

Inherits:

Struct

• Object
• Struct
• Aws::IoTSiteWise::Types::StartPipelineExecutionRequest

Defined in:

gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb

Overview

Request structure for StartPipelineExecution operation.

Constant Summary

SENSITIVE =

[:execution_environment_variable_overrides]

Instance Attribute Summary

• #client_token ⇒ String

  A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

• #execution_environment_variable_overrides ⇒ Types::ExecutionEnvironmentVariables

  Runtime environment variable overrides for the execution.

• #execution_mount_overrides ⇒ Types::MountOverrides

  Runtime mount overrides for the execution.

• #execution_priority ⇒ Integer

  Scheduling priority for the execution.

• #pipeline_name ⇒ String

  The name of the pipeline to execute.

• #workspace_name ⇒ String

  The name of the workspace containing the pipeline.

Instance Attribute Details

#client_token ⇒ String

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token, the server returns the cached result from the original successful request without performing the operation again.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

• (String)

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

class StartPipelineExecutionRequest < Struct.new(
  :workspace_name,
  :pipeline_name,
  :execution_environment_variable_overrides,
  :execution_mount_overrides,
  :execution_priority,
  :client_token)
  SENSITIVE = [:execution_environment_variable_overrides]
  include Aws::Structure
end

#execution_environment_variable_overrides ⇒ Types::ExecutionEnvironmentVariables

Runtime environment variable overrides for the execution. Includes global variables that apply to all compute nodes and computeNodes for per-node overrides. These take the highest priority in the environment variable hierarchy.

Returns:

• (Types::ExecutionEnvironmentVariables)

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

class StartPipelineExecutionRequest < Struct.new(
  :workspace_name,
  :pipeline_name,
  :execution_environment_variable_overrides,
  :execution_mount_overrides,
  :execution_priority,
  :client_token)
  SENSITIVE = [:execution_environment_variable_overrides]
  include Aws::Structure
end

#execution_mount_overrides ⇒ Types::MountOverrides

Runtime mount overrides for the execution. Overrides are merged by mount name into each listed compute node's task-defined mounts: a matching name replaces the task-defined mount, a new name adds a mount, and task-defined mounts not referenced remain unchanged. Compute nodes not listed use their task-defined mounts as-is.

Returns:

• (Types::MountOverrides)

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

class StartPipelineExecutionRequest < Struct.new(
  :workspace_name,
  :pipeline_name,
  :execution_environment_variable_overrides,
  :execution_mount_overrides,
  :execution_priority,
  :client_token)
  SENSITIVE = [:execution_environment_variable_overrides]
  include Aws::Structure
end

#execution_priority ⇒ Integer

Scheduling priority for the execution. Lower values indicate higher priority. Defaults to 2 when not specified.

Returns:

• (Integer)

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

class StartPipelineExecutionRequest < Struct.new(
  :workspace_name,
  :pipeline_name,
  :execution_environment_variable_overrides,
  :execution_mount_overrides,
  :execution_priority,
  :client_token)
  SENSITIVE = [:execution_environment_variable_overrides]
  include Aws::Structure
end

#pipeline_name ⇒ String

The name of the pipeline to execute.

Returns:

• (String)

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

class StartPipelineExecutionRequest < Struct.new(
  :workspace_name,
  :pipeline_name,
  :execution_environment_variable_overrides,
  :execution_mount_overrides,
  :execution_priority,
  :client_token)
  SENSITIVE = [:execution_environment_variable_overrides]
  include Aws::Structure
end

#workspace_name ⇒ String

The name of the workspace containing the pipeline.

Returns:

• (String)

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

class StartPipelineExecutionRequest < Struct.new(
  :workspace_name,
  :pipeline_name,
  :execution_environment_variable_overrides,
  :execution_mount_overrides,
  :execution_priority,
  :client_token)
  SENSITIVE = [:execution_environment_variable_overrides]
  include Aws::Structure
end