You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::MachineLearning::Types::GetDataSourceOutput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb

Overview

Represents the output of a GetDataSource operation and describes a DataSource.

Instance Attribute Summary collapse

Instance Attribute Details

#compute_statisticsBoolean

The parameter is true if statistics need to be generated from the observation data.

Returns:

  • (Boolean)


2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 2136

class GetDataSourceOutput < Struct.new(
  :data_source_id,
  :data_location_s3,
  :data_rearrangement,
  :created_by_iam_user,
  :created_at,
  :last_updated_at,
  :data_size_in_bytes,
  :number_of_files,
  :name,
  :status,
  :log_uri,
  :message,
  :redshift_metadata,
  :rds_metadata,
  :role_arn,
  :compute_statistics,
  :compute_time,
  :finished_at,
  :started_at,
  :data_source_schema)
  include Aws::Structure
end

#compute_timeInteger

The approximate CPU time in milliseconds that Amazon Machine Learning spent processing the DataSource, normalized and scaled on computation resources. ComputeTime is only available if the DataSource is in the COMPLETED state and the ComputeStatistics is set to true.

Returns:

  • (Integer)


2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 2136

class GetDataSourceOutput < Struct.new(
  :data_source_id,
  :data_location_s3,
  :data_rearrangement,
  :created_by_iam_user,
  :created_at,
  :last_updated_at,
  :data_size_in_bytes,
  :number_of_files,
  :name,
  :status,
  :log_uri,
  :message,
  :redshift_metadata,
  :rds_metadata,
  :role_arn,
  :compute_statistics,
  :compute_time,
  :finished_at,
  :started_at,
  :data_source_schema)
  include Aws::Structure
end

#created_atTime

The time that the DataSource was created. The time is expressed in epoch time.

Returns:

  • (Time)


2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 2136

class GetDataSourceOutput < Struct.new(
  :data_source_id,
  :data_location_s3,
  :data_rearrangement,
  :created_by_iam_user,
  :created_at,
  :last_updated_at,
  :data_size_in_bytes,
  :number_of_files,
  :name,
  :status,
  :log_uri,
  :message,
  :redshift_metadata,
  :rds_metadata,
  :role_arn,
  :compute_statistics,
  :compute_time,
  :finished_at,
  :started_at,
  :data_source_schema)
  include Aws::Structure
end

#created_by_iam_userString

The AWS user account from which the DataSource was created. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.

Returns:

  • (String)


2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 2136

class GetDataSourceOutput < Struct.new(
  :data_source_id,
  :data_location_s3,
  :data_rearrangement,
  :created_by_iam_user,
  :created_at,
  :last_updated_at,
  :data_size_in_bytes,
  :number_of_files,
  :name,
  :status,
  :log_uri,
  :message,
  :redshift_metadata,
  :rds_metadata,
  :role_arn,
  :compute_statistics,
  :compute_time,
  :finished_at,
  :started_at,
  :data_source_schema)
  include Aws::Structure
end

#data_location_s3String

The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).

Returns:

  • (String)


2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 2136

class GetDataSourceOutput < Struct.new(
  :data_source_id,
  :data_location_s3,
  :data_rearrangement,
  :created_by_iam_user,
  :created_at,
  :last_updated_at,
  :data_size_in_bytes,
  :number_of_files,
  :name,
  :status,
  :log_uri,
  :message,
  :redshift_metadata,
  :rds_metadata,
  :role_arn,
  :compute_statistics,
  :compute_time,
  :finished_at,
  :started_at,
  :data_source_schema)
  include Aws::Structure
end

#data_rearrangementString

A JSON string that represents the splitting and rearrangement requirement used when this DataSource was created.

Returns:

  • (String)


2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 2136

class GetDataSourceOutput < Struct.new(
  :data_source_id,
  :data_location_s3,
  :data_rearrangement,
  :created_by_iam_user,
  :created_at,
  :last_updated_at,
  :data_size_in_bytes,
  :number_of_files,
  :name,
  :status,
  :log_uri,
  :message,
  :redshift_metadata,
  :rds_metadata,
  :role_arn,
  :compute_statistics,
  :compute_time,
  :finished_at,
  :started_at,
  :data_source_schema)
  include Aws::Structure
end

#data_size_in_bytesInteger

The total size of observations in the data files.

Returns:

  • (Integer)


2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 2136

class GetDataSourceOutput < Struct.new(
  :data_source_id,
  :data_location_s3,
  :data_rearrangement,
  :created_by_iam_user,
  :created_at,
  :last_updated_at,
  :data_size_in_bytes,
  :number_of_files,
  :name,
  :status,
  :log_uri,
  :message,
  :redshift_metadata,
  :rds_metadata,
  :role_arn,
  :compute_statistics,
  :compute_time,
  :finished_at,
  :started_at,
  :data_source_schema)
  include Aws::Structure
end

#data_source_idString

The ID assigned to the DataSource at creation. This value should be identical to the value of the DataSourceId in the request.

Returns:

  • (String)


2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 2136

class GetDataSourceOutput < Struct.new(
  :data_source_id,
  :data_location_s3,
  :data_rearrangement,
  :created_by_iam_user,
  :created_at,
  :last_updated_at,
  :data_size_in_bytes,
  :number_of_files,
  :name,
  :status,
  :log_uri,
  :message,
  :redshift_metadata,
  :rds_metadata,
  :role_arn,
  :compute_statistics,
  :compute_time,
  :finished_at,
  :started_at,
  :data_source_schema)
  include Aws::Structure
end

#data_source_schemaString

The schema used by all of the data files of this DataSource.

Note This parameter is provided as part of the verbose format.

Returns:

  • (String)


2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 2136

class GetDataSourceOutput < Struct.new(
  :data_source_id,
  :data_location_s3,
  :data_rearrangement,
  :created_by_iam_user,
  :created_at,
  :last_updated_at,
  :data_size_in_bytes,
  :number_of_files,
  :name,
  :status,
  :log_uri,
  :message,
  :redshift_metadata,
  :rds_metadata,
  :role_arn,
  :compute_statistics,
  :compute_time,
  :finished_at,
  :started_at,
  :data_source_schema)
  include Aws::Structure
end

#finished_atTime

The epoch time when Amazon Machine Learning marked the DataSource as COMPLETED or FAILED. FinishedAt is only available when the DataSource is in the COMPLETED or FAILED state.

Returns:

  • (Time)


2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 2136

class GetDataSourceOutput < Struct.new(
  :data_source_id,
  :data_location_s3,
  :data_rearrangement,
  :created_by_iam_user,
  :created_at,
  :last_updated_at,
  :data_size_in_bytes,
  :number_of_files,
  :name,
  :status,
  :log_uri,
  :message,
  :redshift_metadata,
  :rds_metadata,
  :role_arn,
  :compute_statistics,
  :compute_time,
  :finished_at,
  :started_at,
  :data_source_schema)
  include Aws::Structure
end

#last_updated_atTime

The time of the most recent edit to the DataSource. The time is expressed in epoch time.

Returns:

  • (Time)


2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 2136

class GetDataSourceOutput < Struct.new(
  :data_source_id,
  :data_location_s3,
  :data_rearrangement,
  :created_by_iam_user,
  :created_at,
  :last_updated_at,
  :data_size_in_bytes,
  :number_of_files,
  :name,
  :status,
  :log_uri,
  :message,
  :redshift_metadata,
  :rds_metadata,
  :role_arn,
  :compute_statistics,
  :compute_time,
  :finished_at,
  :started_at,
  :data_source_schema)
  include Aws::Structure
end

#log_uriString

A link to the file containing logs of CreateDataSourceFrom* operations.

Returns:

  • (String)


2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 2136

class GetDataSourceOutput < Struct.new(
  :data_source_id,
  :data_location_s3,
  :data_rearrangement,
  :created_by_iam_user,
  :created_at,
  :last_updated_at,
  :data_size_in_bytes,
  :number_of_files,
  :name,
  :status,
  :log_uri,
  :message,
  :redshift_metadata,
  :rds_metadata,
  :role_arn,
  :compute_statistics,
  :compute_time,
  :finished_at,
  :started_at,
  :data_source_schema)
  include Aws::Structure
end

#messageString

The user-supplied description of the most recent details about creating the DataSource.

Returns:

  • (String)


2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 2136

class GetDataSourceOutput < Struct.new(
  :data_source_id,
  :data_location_s3,
  :data_rearrangement,
  :created_by_iam_user,
  :created_at,
  :last_updated_at,
  :data_size_in_bytes,
  :number_of_files,
  :name,
  :status,
  :log_uri,
  :message,
  :redshift_metadata,
  :rds_metadata,
  :role_arn,
  :compute_statistics,
  :compute_time,
  :finished_at,
  :started_at,
  :data_source_schema)
  include Aws::Structure
end

#nameString

A user-supplied name or description of the DataSource.

Returns:

  • (String)


2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 2136

class GetDataSourceOutput < Struct.new(
  :data_source_id,
  :data_location_s3,
  :data_rearrangement,
  :created_by_iam_user,
  :created_at,
  :last_updated_at,
  :data_size_in_bytes,
  :number_of_files,
  :name,
  :status,
  :log_uri,
  :message,
  :redshift_metadata,
  :rds_metadata,
  :role_arn,
  :compute_statistics,
  :compute_time,
  :finished_at,
  :started_at,
  :data_source_schema)
  include Aws::Structure
end

#number_of_filesInteger

The number of data files referenced by the DataSource.

Returns:

  • (Integer)


2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 2136

class GetDataSourceOutput < Struct.new(
  :data_source_id,
  :data_location_s3,
  :data_rearrangement,
  :created_by_iam_user,
  :created_at,
  :last_updated_at,
  :data_size_in_bytes,
  :number_of_files,
  :name,
  :status,
  :log_uri,
  :message,
  :redshift_metadata,
  :rds_metadata,
  :role_arn,
  :compute_statistics,
  :compute_time,
  :finished_at,
  :started_at,
  :data_source_schema)
  include Aws::Structure
end

#rds_metadataTypes::RDSMetadata

The datasource details that are specific to Amazon RDS.

Returns:



2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 2136

class GetDataSourceOutput < Struct.new(
  :data_source_id,
  :data_location_s3,
  :data_rearrangement,
  :created_by_iam_user,
  :created_at,
  :last_updated_at,
  :data_size_in_bytes,
  :number_of_files,
  :name,
  :status,
  :log_uri,
  :message,
  :redshift_metadata,
  :rds_metadata,
  :role_arn,
  :compute_statistics,
  :compute_time,
  :finished_at,
  :started_at,
  :data_source_schema)
  include Aws::Structure
end

#redshift_metadataTypes::RedshiftMetadata

Describes the DataSource details specific to Amazon Redshift.



2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 2136

class GetDataSourceOutput < Struct.new(
  :data_source_id,
  :data_location_s3,
  :data_rearrangement,
  :created_by_iam_user,
  :created_at,
  :last_updated_at,
  :data_size_in_bytes,
  :number_of_files,
  :name,
  :status,
  :log_uri,
  :message,
  :redshift_metadata,
  :rds_metadata,
  :role_arn,
  :compute_statistics,
  :compute_time,
  :finished_at,
  :started_at,
  :data_source_schema)
  include Aws::Structure
end

#role_arnString

The Amazon Resource Name (ARN) of an AWS IAM Role, such as the following: arn:aws:iam::account:role/rolename.

Returns:

  • (String)


2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 2136

class GetDataSourceOutput < Struct.new(
  :data_source_id,
  :data_location_s3,
  :data_rearrangement,
  :created_by_iam_user,
  :created_at,
  :last_updated_at,
  :data_size_in_bytes,
  :number_of_files,
  :name,
  :status,
  :log_uri,
  :message,
  :redshift_metadata,
  :rds_metadata,
  :role_arn,
  :compute_statistics,
  :compute_time,
  :finished_at,
  :started_at,
  :data_source_schema)
  include Aws::Structure
end

#started_atTime

The epoch time when Amazon Machine Learning marked the DataSource as INPROGRESS. StartedAt isn't available if the DataSource is in the PENDING state.

Returns:

  • (Time)


2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 2136

class GetDataSourceOutput < Struct.new(
  :data_source_id,
  :data_location_s3,
  :data_rearrangement,
  :created_by_iam_user,
  :created_at,
  :last_updated_at,
  :data_size_in_bytes,
  :number_of_files,
  :name,
  :status,
  :log_uri,
  :message,
  :redshift_metadata,
  :rds_metadata,
  :role_arn,
  :compute_statistics,
  :compute_time,
  :finished_at,
  :started_at,
  :data_source_schema)
  include Aws::Structure
end

#statusString

The current status of the DataSource. This element can have one of the following values:

  • PENDING - Amazon ML submitted a request to create a DataSource.
  • INPROGRESS - The creation process is underway.
  • FAILED - The request to create a DataSource did not run to completion. It is not usable.
  • COMPLETED - The creation process completed successfully.
  • DELETED - The DataSource is marked as deleted. It is not usable.

Returns:

  • (String)


2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
# File 'gems/aws-sdk-machinelearning/lib/aws-sdk-machinelearning/types.rb', line 2136

class GetDataSourceOutput < Struct.new(
  :data_source_id,
  :data_location_s3,
  :data_rearrangement,
  :created_by_iam_user,
  :created_at,
  :last_updated_at,
  :data_size_in_bytes,
  :number_of_files,
  :name,
  :status,
  :log_uri,
  :message,
  :redshift_metadata,
  :rds_metadata,
  :role_arn,
  :compute_statistics,
  :compute_time,
  :finished_at,
  :started_at,
  :data_source_schema)
  include Aws::Structure
end