GetDataSourceCommand

Suggest an Edit

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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { MachineLearningClient, GetDataSourceCommand } from "@aws-sdk/client-machine-learning"; // ES Modules import
// const { MachineLearningClient, GetDataSourceCommand } = require("@aws-sdk/client-machine-learning"); // CommonJS import
const client = new MachineLearningClient(config);
const input = { // GetDataSourceInput
  DataSourceId: "STRING_VALUE", // required
  Verbose: true || false,
};
const command = new GetDataSourceCommand(input);
const response = await client.send(command);
// { // GetDataSourceOutput
//   DataSourceId: "STRING_VALUE",
//   DataLocationS3: "STRING_VALUE",
//   DataRearrangement: "STRING_VALUE",
//   CreatedByIamUser: "STRING_VALUE",
//   CreatedAt: new Date("TIMESTAMP"),
//   LastUpdatedAt: new Date("TIMESTAMP"),
//   DataSizeInBytes: Number("long"),
//   NumberOfFiles: Number("long"),
//   Name: "STRING_VALUE",
//   Status: "PENDING" || "INPROGRESS" || "FAILED" || "COMPLETED" || "DELETED",
//   LogUri: "STRING_VALUE",
//   Message: "STRING_VALUE",
//   RedshiftMetadata: { // RedshiftMetadata
//     RedshiftDatabase: { // RedshiftDatabase
//       DatabaseName: "STRING_VALUE", // required
//       ClusterIdentifier: "STRING_VALUE", // required
//     },
//     DatabaseUserName: "STRING_VALUE",
//     SelectSqlQuery: "STRING_VALUE",
//   },
//   RDSMetadata: { // RDSMetadata
//     Database: { // RDSDatabase
//       InstanceIdentifier: "STRING_VALUE", // required
//       DatabaseName: "STRING_VALUE", // required
//     },
//     DatabaseUserName: "STRING_VALUE",
//     SelectSqlQuery: "STRING_VALUE",
//     ResourceRole: "STRING_VALUE",
//     ServiceRole: "STRING_VALUE",
//     DataPipelineId: "STRING_VALUE",
//   },
//   RoleARN: "STRING_VALUE",
//   ComputeStatistics: true || false,
//   ComputeTime: Number("long"),
//   FinishedAt: new Date("TIMESTAMP"),
//   StartedAt: new Date("TIMESTAMP"),
//   DataSourceSchema: "STRING_VALUE",
// };

GetDataSourceCommand Input

See GetDataSourceCommandInput for more details

Parameter
Type
Description
DataSourceId
Required
string | undefined

The ID assigned to the DataSource at creation.

Verbose
boolean | undefined

Specifies whether the GetDataSource operation should return DataSourceSchema.

If true, DataSourceSchema is returned.

If false, DataSourceSchema is not returned.

GetDataSourceCommand Output

See GetDataSourceCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
ComputeStatistics
boolean | undefined

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

ComputeTime
number | undefined

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.

CreatedAt
Date | undefined

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

CreatedByIamUser
string | undefined

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.

DataLocationS3
string | undefined

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

DataRearrangement
string | undefined

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

DataSizeInBytes
number | undefined

The total size of observations in the data files.

DataSourceId
string | undefined

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

DataSourceSchema
string | undefined

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

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

FinishedAt
Date | undefined

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.

LastUpdatedAt
Date | undefined

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

LogUri
string | undefined

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

Message
string | undefined

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

Name
string | undefined

A user-supplied name or description of the DataSource.

NumberOfFiles
number | undefined

The number of data files referenced by the DataSource.

RDSMetadata
RDSMetadata | undefined

The datasource details that are specific to Amazon RDS.

RedshiftMetadata
RedshiftMetadata | undefined

Describes the DataSource details specific to Amazon Redshift.

RoleARN
string | undefined

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

StartedAt
Date | undefined

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

Status
EntityStatus | undefined

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.

Throws

Name
Fault
Details
InternalServerException
server

An error on the server occurred when trying to process a request.

InvalidInputException
client

An error on the client occurred. Typically, the cause is an invalid input value.

ResourceNotFoundException
client

A specified resource cannot be located.

MachineLearningServiceException
Base exception class for all service exceptions from MachineLearning service.