Class: Aws::IoTSiteWise::Types::DescribeDatasetResponse

Inherits:

Struct

• Object
• Struct
• Aws::IoTSiteWise::Types::DescribeDatasetResponse

Includes:

Structure

Defined in:

lib/aws-sdk-iotsitewise/types.rb

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #dataset_arn ⇒ String

  The [ARN][1] of the dataset.

• #dataset_config ⇒ Types::DatasetConfig

  The configuration for the dataset.

• #dataset_creation_date ⇒ Time

  The dataset creation date, in Unix epoch time.

• #dataset_description ⇒ String

  A description about the dataset, and its functionality.

• #dataset_id ⇒ String

  The ID of the dataset.

• #dataset_last_update_date ⇒ Time

  The date the dataset was last updated, in Unix epoch time.

• #dataset_name ⇒ String

  The name of the dataset.

• #dataset_source ⇒ Types::DatasetSource

  The data source for the dataset.

• #dataset_status ⇒ Types::DatasetStatus

  The status of the dataset.

• #dataset_type ⇒ String

  The type of dataset: a session dataset, a curated dataset, or a connection to an external datasource.

• #dataset_version ⇒ String

  The version of the dataset.

• #enrichment_status ⇒ Types::DatasetEnrichment

  The enrichment status of the dataset.

• #metadata ⇒ Hash<String,String>

  The metadata for the dataset.

• #workspace_name ⇒ String

  The name of the workspace that contains the dataset.

Instance Attribute Details

#dataset_arn ⇒ String

The ARN of the dataset. The format is arn:${Partition}:iotsitewise:${Region}:${Account}:dataset/${DatasetId}.

Returns:

• (String)

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

class DescribeDatasetResponse < Struct.new(
  :dataset_id,
  :dataset_arn,
  :dataset_name,
  :dataset_description,
  :dataset_type,
  :dataset_config,
  :workspace_name,
  :metadata,
  :dataset_source,
  :dataset_status,
  :dataset_creation_date,
  :dataset_last_update_date,
  :dataset_version,
  :enrichment_status)
  SENSITIVE = []
  include Aws::Structure
end

#dataset_config ⇒ Types::DatasetConfig

The configuration for the dataset.

Returns:

• (Types::DatasetConfig)

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

class DescribeDatasetResponse < Struct.new(
  :dataset_id,
  :dataset_arn,
  :dataset_name,
  :dataset_description,
  :dataset_type,
  :dataset_config,
  :workspace_name,
  :metadata,
  :dataset_source,
  :dataset_status,
  :dataset_creation_date,
  :dataset_last_update_date,
  :dataset_version,
  :enrichment_status)
  SENSITIVE = []
  include Aws::Structure
end

#dataset_creation_date ⇒ Time

The dataset creation date, in Unix epoch time.

Returns:

• (Time)

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

class DescribeDatasetResponse < Struct.new(
  :dataset_id,
  :dataset_arn,
  :dataset_name,
  :dataset_description,
  :dataset_type,
  :dataset_config,
  :workspace_name,
  :metadata,
  :dataset_source,
  :dataset_status,
  :dataset_creation_date,
  :dataset_last_update_date,
  :dataset_version,
  :enrichment_status)
  SENSITIVE = []
  include Aws::Structure
end

#dataset_description ⇒ String

A description about the dataset, and its functionality.

Returns:

• (String)

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

class DescribeDatasetResponse < Struct.new(
  :dataset_id,
  :dataset_arn,
  :dataset_name,
  :dataset_description,
  :dataset_type,
  :dataset_config,
  :workspace_name,
  :metadata,
  :dataset_source,
  :dataset_status,
  :dataset_creation_date,
  :dataset_last_update_date,
  :dataset_version,
  :enrichment_status)
  SENSITIVE = []
  include Aws::Structure
end

#dataset_id ⇒ String

The ID of the dataset.

Returns:

• (String)

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

class DescribeDatasetResponse < Struct.new(
  :dataset_id,
  :dataset_arn,
  :dataset_name,
  :dataset_description,
  :dataset_type,
  :dataset_config,
  :workspace_name,
  :metadata,
  :dataset_source,
  :dataset_status,
  :dataset_creation_date,
  :dataset_last_update_date,
  :dataset_version,
  :enrichment_status)
  SENSITIVE = []
  include Aws::Structure
end

#dataset_last_update_date ⇒ Time

The date the dataset was last updated, in Unix epoch time.

Returns:

• (Time)

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

class DescribeDatasetResponse < Struct.new(
  :dataset_id,
  :dataset_arn,
  :dataset_name,
  :dataset_description,
  :dataset_type,
  :dataset_config,
  :workspace_name,
  :metadata,
  :dataset_source,
  :dataset_status,
  :dataset_creation_date,
  :dataset_last_update_date,
  :dataset_version,
  :enrichment_status)
  SENSITIVE = []
  include Aws::Structure
end

#dataset_name ⇒ String

The name of the dataset.

Returns:

• (String)

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

class DescribeDatasetResponse < Struct.new(
  :dataset_id,
  :dataset_arn,
  :dataset_name,
  :dataset_description,
  :dataset_type,
  :dataset_config,
  :workspace_name,
  :metadata,
  :dataset_source,
  :dataset_status,
  :dataset_creation_date,
  :dataset_last_update_date,
  :dataset_version,
  :enrichment_status)
  SENSITIVE = []
  include Aws::Structure
end

#dataset_source ⇒ Types::DatasetSource

The data source for the dataset.

Returns:

• (Types::DatasetSource)

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

class DescribeDatasetResponse < Struct.new(
  :dataset_id,
  :dataset_arn,
  :dataset_name,
  :dataset_description,
  :dataset_type,
  :dataset_config,
  :workspace_name,
  :metadata,
  :dataset_source,
  :dataset_status,
  :dataset_creation_date,
  :dataset_last_update_date,
  :dataset_version,
  :enrichment_status)
  SENSITIVE = []
  include Aws::Structure
end

#dataset_status ⇒ Types::DatasetStatus

The status of the dataset. This contains the state and any error messages. State is CREATING after a successfull call to this API, and any associated error message. The state is ACTIVE when ready to use.

Returns:

• (Types::DatasetStatus)

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

class DescribeDatasetResponse < Struct.new(
  :dataset_id,
  :dataset_arn,
  :dataset_name,
  :dataset_description,
  :dataset_type,
  :dataset_config,
  :workspace_name,
  :metadata,
  :dataset_source,
  :dataset_status,
  :dataset_creation_date,
  :dataset_last_update_date,
  :dataset_version,
  :enrichment_status)
  SENSITIVE = []
  include Aws::Structure
end

#dataset_type ⇒ String

The type of dataset: a session dataset, a curated dataset, or a connection to an external datasource.

Returns:

• (String)

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

class DescribeDatasetResponse < Struct.new(
  :dataset_id,
  :dataset_arn,
  :dataset_name,
  :dataset_description,
  :dataset_type,
  :dataset_config,
  :workspace_name,
  :metadata,
  :dataset_source,
  :dataset_status,
  :dataset_creation_date,
  :dataset_last_update_date,
  :dataset_version,
  :enrichment_status)
  SENSITIVE = []
  include Aws::Structure
end

#dataset_version ⇒ String

The version of the dataset.

Returns:

• (String)

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

class DescribeDatasetResponse < Struct.new(
  :dataset_id,
  :dataset_arn,
  :dataset_name,
  :dataset_description,
  :dataset_type,
  :dataset_config,
  :workspace_name,
  :metadata,
  :dataset_source,
  :dataset_status,
  :dataset_creation_date,
  :dataset_last_update_date,
  :dataset_version,
  :enrichment_status)
  SENSITIVE = []
  include Aws::Structure
end

#enrichment_status ⇒ Types::DatasetEnrichment

The enrichment status of the dataset.

Returns:

• (Types::DatasetEnrichment)

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

class DescribeDatasetResponse < Struct.new(
  :dataset_id,
  :dataset_arn,
  :dataset_name,
  :dataset_description,
  :dataset_type,
  :dataset_config,
  :workspace_name,
  :metadata,
  :dataset_source,
  :dataset_status,
  :dataset_creation_date,
  :dataset_last_update_date,
  :dataset_version,
  :enrichment_status)
  SENSITIVE = []
  include Aws::Structure
end

#metadata ⇒ Hash<String,String>

The metadata for the dataset.

Returns:

• (Hash<String,String>)

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

class DescribeDatasetResponse < Struct.new(
  :dataset_id,
  :dataset_arn,
  :dataset_name,
  :dataset_description,
  :dataset_type,
  :dataset_config,
  :workspace_name,
  :metadata,
  :dataset_source,
  :dataset_status,
  :dataset_creation_date,
  :dataset_last_update_date,
  :dataset_version,
  :enrichment_status)
  SENSITIVE = []
  include Aws::Structure
end

#workspace_name ⇒ String

The name of the workspace that contains the dataset.

Returns:

• (String)

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

class DescribeDatasetResponse < Struct.new(
  :dataset_id,
  :dataset_arn,
  :dataset_name,
  :dataset_description,
  :dataset_type,
  :dataset_config,
  :workspace_name,
  :metadata,
  :dataset_source,
  :dataset_status,
  :dataset_creation_date,
  :dataset_last_update_date,
  :dataset_version,
  :enrichment_status)
  SENSITIVE = []
  include Aws::Structure
end