Class: Aws::LookoutEquipment::Types::DescribeDatasetResponse

Inherits:

Struct

• Object
• Struct
• Aws::LookoutEquipment::Types::DescribeDatasetResponse

Includes:

Structure

Defined in:

lib/aws-sdk-lookoutequipment/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #created_at ⇒ Time

  Specifies the time the dataset was created in Lookout for Equipment.

• #data_end_time ⇒ Time

  Indicates the latest timestamp corresponding to data that was successfully ingested during the most recent ingestion of this particular dataset.

• #data_quality_summary ⇒ Types::DataQualitySummary

  Gives statistics associated with the given dataset for the latest successful associated ingestion job id.

• #data_start_time ⇒ Time

  Indicates the earliest timestamp corresponding to data that was successfully ingested during the most recent ingestion of this particular dataset.

• #dataset_arn ⇒ String

  The Amazon Resource Name (ARN) of the dataset being described.

• #dataset_name ⇒ String

  The name of the dataset being described.

• #ingested_files_summary ⇒ Types::IngestedFilesSummary

  IngestedFilesSummary associated with the given dataset for the latest successful associated ingestion job id.

• #ingestion_input_configuration ⇒ Types::IngestionInputConfiguration

  Specifies the S3 location configuration for the data input for the data ingestion job.

• #last_updated_at ⇒ Time

  Specifies the time the dataset was last updated, if it was.

• #role_arn ⇒ String

  The Amazon Resource Name (ARN) of the IAM role that you are using for this the data ingestion job.

• #schema ⇒ String

  A JSON description of the data that is in each time series dataset, including names, column names, and data types.

• #server_side_kms_key_id ⇒ String

  Provides the identifier of the KMS key used to encrypt dataset data by Amazon Lookout for Equipment.

• #source_dataset_arn ⇒ String

  The Amazon Resource Name (ARN) of the source dataset from which the current data being described was imported from.

• #status ⇒ String

  Indicates the status of the dataset.

Instance Attribute Details

#created_at ⇒ Time

Specifies the time the dataset was created in Lookout for Equipment.

Returns:

• (Time)

# File 'lib/aws-sdk-lookoutequipment/types.rb', line 1067

class DescribeDatasetResponse < Struct.new(
  :dataset_name,
  :dataset_arn,
  :created_at,
  :last_updated_at,
  :status,
  :schema,
  :server_side_kms_key_id,
  :ingestion_input_configuration,
  :data_quality_summary,
  :ingested_files_summary,
  :role_arn,
  :data_start_time,
  :data_end_time,
  :source_dataset_arn)
  SENSITIVE = []
  include Aws::Structure
end

#data_end_time ⇒ Time

Indicates the latest timestamp corresponding to data that was successfully ingested during the most recent ingestion of this particular dataset.

Returns:

• (Time)

# File 'lib/aws-sdk-lookoutequipment/types.rb', line 1067

class DescribeDatasetResponse < Struct.new(
  :dataset_name,
  :dataset_arn,
  :created_at,
  :last_updated_at,
  :status,
  :schema,
  :server_side_kms_key_id,
  :ingestion_input_configuration,
  :data_quality_summary,
  :ingested_files_summary,
  :role_arn,
  :data_start_time,
  :data_end_time,
  :source_dataset_arn)
  SENSITIVE = []
  include Aws::Structure
end

#data_quality_summary ⇒ Types::DataQualitySummary

Gives statistics associated with the given dataset for the latest successful associated ingestion job id. These statistics primarily relate to quantifying incorrect data such as MissingCompleteSensorData, MissingSensorData, UnsupportedDateFormats, InsufficientSensorData, and DuplicateTimeStamps.

Returns:

• (Types::DataQualitySummary)

# File 'lib/aws-sdk-lookoutequipment/types.rb', line 1067

class DescribeDatasetResponse < Struct.new(
  :dataset_name,
  :dataset_arn,
  :created_at,
  :last_updated_at,
  :status,
  :schema,
  :server_side_kms_key_id,
  :ingestion_input_configuration,
  :data_quality_summary,
  :ingested_files_summary,
  :role_arn,
  :data_start_time,
  :data_end_time,
  :source_dataset_arn)
  SENSITIVE = []
  include Aws::Structure
end

#data_start_time ⇒ Time

Indicates the earliest timestamp corresponding to data that was successfully ingested during the most recent ingestion of this particular dataset.

Returns:

• (Time)

# File 'lib/aws-sdk-lookoutequipment/types.rb', line 1067

class DescribeDatasetResponse < Struct.new(
  :dataset_name,
  :dataset_arn,
  :created_at,
  :last_updated_at,
  :status,
  :schema,
  :server_side_kms_key_id,
  :ingestion_input_configuration,
  :data_quality_summary,
  :ingested_files_summary,
  :role_arn,
  :data_start_time,
  :data_end_time,
  :source_dataset_arn)
  SENSITIVE = []
  include Aws::Structure
end

#dataset_arn ⇒ String

The Amazon Resource Name (ARN) of the dataset being described.

Returns:

• (String)

# File 'lib/aws-sdk-lookoutequipment/types.rb', line 1067

class DescribeDatasetResponse < Struct.new(
  :dataset_name,
  :dataset_arn,
  :created_at,
  :last_updated_at,
  :status,
  :schema,
  :server_side_kms_key_id,
  :ingestion_input_configuration,
  :data_quality_summary,
  :ingested_files_summary,
  :role_arn,
  :data_start_time,
  :data_end_time,
  :source_dataset_arn)
  SENSITIVE = []
  include Aws::Structure
end

#dataset_name ⇒ String

The name of the dataset being described.

Returns:

• (String)

# File 'lib/aws-sdk-lookoutequipment/types.rb', line 1067

class DescribeDatasetResponse < Struct.new(
  :dataset_name,
  :dataset_arn,
  :created_at,
  :last_updated_at,
  :status,
  :schema,
  :server_side_kms_key_id,
  :ingestion_input_configuration,
  :data_quality_summary,
  :ingested_files_summary,
  :role_arn,
  :data_start_time,
  :data_end_time,
  :source_dataset_arn)
  SENSITIVE = []
  include Aws::Structure
end

#ingested_files_summary ⇒ Types::IngestedFilesSummary

IngestedFilesSummary associated with the given dataset for the latest successful associated ingestion job id.

Returns:

• (Types::IngestedFilesSummary)

# File 'lib/aws-sdk-lookoutequipment/types.rb', line 1067

class DescribeDatasetResponse < Struct.new(
  :dataset_name,
  :dataset_arn,
  :created_at,
  :last_updated_at,
  :status,
  :schema,
  :server_side_kms_key_id,
  :ingestion_input_configuration,
  :data_quality_summary,
  :ingested_files_summary,
  :role_arn,
  :data_start_time,
  :data_end_time,
  :source_dataset_arn)
  SENSITIVE = []
  include Aws::Structure
end

#ingestion_input_configuration ⇒ Types::IngestionInputConfiguration

Specifies the S3 location configuration for the data input for the data ingestion job.

Returns:

• (Types::IngestionInputConfiguration)

# File 'lib/aws-sdk-lookoutequipment/types.rb', line 1067

class DescribeDatasetResponse < Struct.new(
  :dataset_name,
  :dataset_arn,
  :created_at,
  :last_updated_at,
  :status,
  :schema,
  :server_side_kms_key_id,
  :ingestion_input_configuration,
  :data_quality_summary,
  :ingested_files_summary,
  :role_arn,
  :data_start_time,
  :data_end_time,
  :source_dataset_arn)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_at ⇒ Time

Specifies the time the dataset was last updated, if it was.

Returns:

• (Time)

# File 'lib/aws-sdk-lookoutequipment/types.rb', line 1067

class DescribeDatasetResponse < Struct.new(
  :dataset_name,
  :dataset_arn,
  :created_at,
  :last_updated_at,
  :status,
  :schema,
  :server_side_kms_key_id,
  :ingestion_input_configuration,
  :data_quality_summary,
  :ingested_files_summary,
  :role_arn,
  :data_start_time,
  :data_end_time,
  :source_dataset_arn)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

The Amazon Resource Name (ARN) of the IAM role that you are using for this the data ingestion job.

Returns:

• (String)

# File 'lib/aws-sdk-lookoutequipment/types.rb', line 1067

class DescribeDatasetResponse < Struct.new(
  :dataset_name,
  :dataset_arn,
  :created_at,
  :last_updated_at,
  :status,
  :schema,
  :server_side_kms_key_id,
  :ingestion_input_configuration,
  :data_quality_summary,
  :ingested_files_summary,
  :role_arn,
  :data_start_time,
  :data_end_time,
  :source_dataset_arn)
  SENSITIVE = []
  include Aws::Structure
end

#schema ⇒ String

A JSON description of the data that is in each time series dataset, including names, column names, and data types.

Returns:

• (String)

# File 'lib/aws-sdk-lookoutequipment/types.rb', line 1067

class DescribeDatasetResponse < Struct.new(
  :dataset_name,
  :dataset_arn,
  :created_at,
  :last_updated_at,
  :status,
  :schema,
  :server_side_kms_key_id,
  :ingestion_input_configuration,
  :data_quality_summary,
  :ingested_files_summary,
  :role_arn,
  :data_start_time,
  :data_end_time,
  :source_dataset_arn)
  SENSITIVE = []
  include Aws::Structure
end

#server_side_kms_key_id ⇒ String

Provides the identifier of the KMS key used to encrypt dataset data by Amazon Lookout for Equipment.

Returns:

• (String)

# File 'lib/aws-sdk-lookoutequipment/types.rb', line 1067

class DescribeDatasetResponse < Struct.new(
  :dataset_name,
  :dataset_arn,
  :created_at,
  :last_updated_at,
  :status,
  :schema,
  :server_side_kms_key_id,
  :ingestion_input_configuration,
  :data_quality_summary,
  :ingested_files_summary,
  :role_arn,
  :data_start_time,
  :data_end_time,
  :source_dataset_arn)
  SENSITIVE = []
  include Aws::Structure
end

#source_dataset_arn ⇒ String

The Amazon Resource Name (ARN) of the source dataset from which the current data being described was imported from.

Returns:

• (String)

# File 'lib/aws-sdk-lookoutequipment/types.rb', line 1067

class DescribeDatasetResponse < Struct.new(
  :dataset_name,
  :dataset_arn,
  :created_at,
  :last_updated_at,
  :status,
  :schema,
  :server_side_kms_key_id,
  :ingestion_input_configuration,
  :data_quality_summary,
  :ingested_files_summary,
  :role_arn,
  :data_start_time,
  :data_end_time,
  :source_dataset_arn)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

Indicates the status of the dataset.

Returns:

• (String)

# File 'lib/aws-sdk-lookoutequipment/types.rb', line 1067

class DescribeDatasetResponse < Struct.new(
  :dataset_name,
  :dataset_arn,
  :created_at,
  :last_updated_at,
  :status,
  :schema,
  :server_side_kms_key_id,
  :ingestion_input_configuration,
  :data_quality_summary,
  :ingested_files_summary,
  :role_arn,
  :data_start_time,
  :data_end_time,
  :source_dataset_arn)
  SENSITIVE = []
  include Aws::Structure
end