Class: Aws::IoTSiteWise::Types::CreateTaskRequest

Inherits:

Struct

• Object
• Struct
• Aws::IoTSiteWise::Types::CreateTaskRequest

Defined in:

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

Overview

Request structure for CreateTask operation.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #client_token ⇒ String

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

• #description ⇒ String

  A description of the task.

• #tags ⇒ Hash<String,String>

  A list of key-value pairs that contain metadata for the task.

• #task_configuration ⇒ Types::TaskConfiguration

  The task execution configuration.

• #task_name ⇒ String

  The name of the task to create.

• #workspace_name ⇒ String

  The name of the workspace.

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 4805

class CreateTaskRequest < Struct.new(
  :workspace_name,
  :task_name,
  :description,
  :task_configuration,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A description of the task.

Returns:

• (String)

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

class CreateTaskRequest < Struct.new(
  :workspace_name,
  :task_name,
  :description,
  :task_configuration,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

A list of key-value pairs that contain metadata for the task. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.

Returns:

• (Hash<String,String>)

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

class CreateTaskRequest < Struct.new(
  :workspace_name,
  :task_name,
  :description,
  :task_configuration,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#task_configuration ⇒ Types::TaskConfiguration

The task execution configuration. Specify a containerTaskConfiguration for custom container workloads.

Returns:

• (Types::TaskConfiguration)

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

class CreateTaskRequest < Struct.new(
  :workspace_name,
  :task_name,
  :description,
  :task_configuration,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#task_name ⇒ String

The name of the task to create. Must be unique within the workspace.

Returns:

• (String)

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

class CreateTaskRequest < Struct.new(
  :workspace_name,
  :task_name,
  :description,
  :task_configuration,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#workspace_name ⇒ String

The name of the workspace.

Returns:

• (String)

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

class CreateTaskRequest < Struct.new(
  :workspace_name,
  :task_name,
  :description,
  :task_configuration,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end