Class: Aws::Comprehend::Types::DatasetProperties

Inherits:

Struct

• Object
• Struct
• Aws::Comprehend::Types::DatasetProperties

Includes:

Structure

Defined in:

lib/aws-sdk-comprehend/types.rb

Overview

Properties associated with the dataset.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #creation_time ⇒ Time

  Creation time of the dataset.

• #dataset_arn ⇒ String

  The ARN of the dataset.

• #dataset_name ⇒ String

  The name of the dataset.

• #dataset_s3_uri ⇒ String

  The S3 URI where the dataset is stored.

• #dataset_type ⇒ String

  The dataset type (training data or test data).

• #description ⇒ String

  Description of the dataset.

• #end_time ⇒ Time

  Time when the data from the dataset becomes available in the data lake.

• #message ⇒ String

  A description of the status of the dataset.

• #number_of_documents ⇒ Integer

  The number of documents in the dataset.

• #status ⇒ String

  The dataset status.

Instance Attribute Details

#creation_time ⇒ Time

Creation time of the dataset.

Returns:

• (Time)

# File 'lib/aws-sdk-comprehend/types.rb', line 1793

class DatasetProperties < Struct.new(
  :dataset_arn,
  :dataset_name,
  :dataset_type,
  :dataset_s3_uri,
  :description,
  :status,
  :message,
  :number_of_documents,
  :creation_time,
  :end_time)
  SENSITIVE = []
  include Aws::Structure
end

#dataset_arn ⇒ String

The ARN of the dataset.

Returns:

• (String)

# File 'lib/aws-sdk-comprehend/types.rb', line 1793

class DatasetProperties < Struct.new(
  :dataset_arn,
  :dataset_name,
  :dataset_type,
  :dataset_s3_uri,
  :description,
  :status,
  :message,
  :number_of_documents,
  :creation_time,
  :end_time)
  SENSITIVE = []
  include Aws::Structure
end

#dataset_name ⇒ String

The name of the dataset.

Returns:

• (String)

# File 'lib/aws-sdk-comprehend/types.rb', line 1793

class DatasetProperties < Struct.new(
  :dataset_arn,
  :dataset_name,
  :dataset_type,
  :dataset_s3_uri,
  :description,
  :status,
  :message,
  :number_of_documents,
  :creation_time,
  :end_time)
  SENSITIVE = []
  include Aws::Structure
end

#dataset_s3_uri ⇒ String

The S3 URI where the dataset is stored.

Returns:

• (String)

# File 'lib/aws-sdk-comprehend/types.rb', line 1793

class DatasetProperties < Struct.new(
  :dataset_arn,
  :dataset_name,
  :dataset_type,
  :dataset_s3_uri,
  :description,
  :status,
  :message,
  :number_of_documents,
  :creation_time,
  :end_time)
  SENSITIVE = []
  include Aws::Structure
end

#dataset_type ⇒ String

The dataset type (training data or test data).

Returns:

• (String)

# File 'lib/aws-sdk-comprehend/types.rb', line 1793

class DatasetProperties < Struct.new(
  :dataset_arn,
  :dataset_name,
  :dataset_type,
  :dataset_s3_uri,
  :description,
  :status,
  :message,
  :number_of_documents,
  :creation_time,
  :end_time)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

Description of the dataset.

Returns:

• (String)

# File 'lib/aws-sdk-comprehend/types.rb', line 1793

class DatasetProperties < Struct.new(
  :dataset_arn,
  :dataset_name,
  :dataset_type,
  :dataset_s3_uri,
  :description,
  :status,
  :message,
  :number_of_documents,
  :creation_time,
  :end_time)
  SENSITIVE = []
  include Aws::Structure
end

#end_time ⇒ Time

Time when the data from the dataset becomes available in the data lake.

Returns:

• (Time)

# File 'lib/aws-sdk-comprehend/types.rb', line 1793

class DatasetProperties < Struct.new(
  :dataset_arn,
  :dataset_name,
  :dataset_type,
  :dataset_s3_uri,
  :description,
  :status,
  :message,
  :number_of_documents,
  :creation_time,
  :end_time)
  SENSITIVE = []
  include Aws::Structure
end

#message ⇒ String

A description of the status of the dataset.

Returns:

• (String)

# File 'lib/aws-sdk-comprehend/types.rb', line 1793

class DatasetProperties < Struct.new(
  :dataset_arn,
  :dataset_name,
  :dataset_type,
  :dataset_s3_uri,
  :description,
  :status,
  :message,
  :number_of_documents,
  :creation_time,
  :end_time)
  SENSITIVE = []
  include Aws::Structure
end

#number_of_documents ⇒ Integer

The number of documents in the dataset.

Returns:

• (Integer)

# File 'lib/aws-sdk-comprehend/types.rb', line 1793

class DatasetProperties < Struct.new(
  :dataset_arn,
  :dataset_name,
  :dataset_type,
  :dataset_s3_uri,
  :description,
  :status,
  :message,
  :number_of_documents,
  :creation_time,
  :end_time)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The dataset status. While the system creates the dataset, the status is ‘CREATING`. When the dataset is ready to use, the status changes to `COMPLETED`.

Returns:

• (String)

# File 'lib/aws-sdk-comprehend/types.rb', line 1793

class DatasetProperties < Struct.new(
  :dataset_arn,
  :dataset_name,
  :dataset_type,
  :dataset_s3_uri,
  :description,
  :status,
  :message,
  :number_of_documents,
  :creation_time,
  :end_time)
  SENSITIVE = []
  include Aws::Structure
end