v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1428150188.6 KB

Returns a DataSource that includes metadata and data file information, as well as the current status of the DataSource.

GetDataSource provides results in normal or verbose format. The verbose format adds the schema description and the list of files pointed to by the DataSource to the normal format.

post/#X-Amz-Target=AmazonML_20141212.GetDataSource

Headers

X-Amz-Target'AmazonML_20141212.GetDataSource' required

Request body

DataSourceIdstring required

The ID assigned to the <code>DataSource</code> at creation.

Verboseboolean
<p>Specifies whether the <code>GetDataSource</code> operation should return <code>DataSourceSchema</code>.</p> <p>If true, <code>DataSourceSchema</code> is returned.</p> <p>If false, <code>DataSourceSchema</code> is not returned.</p>

Response

Success

DataSourceIdstring

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

DataLocationS3string

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

DataRearrangementstring

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

CreatedByIamUserstring

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

CreatedAtstring date-time

The time that the <code>DataSource</code> was created. The time is expressed in epoch time.

LastUpdatedAtstring date-time

The time of the most recent edit to the <code>DataSource</code>. The time is expressed in epoch time.

DataSizeInBytesinteger

The total size of observations in the data files.

NumberOfFilesinteger

The number of data files referenced by the <code>DataSource</code>.

Namestring

A user-supplied name or description of the <code>DataSource</code>.

Status'PENDING' | 'INPROGRESS' | 'FAILED' | 'COMPLETED' | 'DELETED'
<p>The current status of the <code>DataSource</code>. This element can have one of the following values:</p> <ul> <li> <p> <code>PENDING</code> - Amazon ML submitted a request to create a <code>DataSource</code>.</p> </li> <li> <p> <code>INPROGRESS</code> - The creation process is underway.</p> </li> <li> <p> <code>FAILED</code> - The request to create a <code>DataSource</code> did not run to completion. It is not usable.</p> </li> <li> <p> <code>COMPLETED</code> - The creation process completed successfully.</p> </li> <li> <p> <code>DELETED</code> - The <code>DataSource</code> is marked as deleted. It is not usable.</p> </li> </ul>
LogUristring

A link to the file containing logs of <code>CreateDataSourceFrom*</code> operations.

Messagestring

The user-supplied description of the most recent details about creating the <code>DataSource</code>.

RoleARNstring

The Amazon Resource Name (ARN) of an <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html#roles-about-termsandconcepts">AWS IAM Role</a>, such as the following: arn:aws:iam::account:role/rolename.

ComputeStatisticsboolean

The parameter is <code>true</code> if statistics need to be generated from the observation data.

ComputeTimeinteger

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

FinishedAtstring date-time

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

StartedAtstring date-time

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

DataSourceSchemastring
<p>The schema used by all of the data files of this <code>DataSource</code>.</p> <p> <b>Note:</b> This parameter is provided as part of the verbose format.</p>