Skip to content

Create Data Source from Rds

machinelearning_create_data_source_from_rds R Documentation

Creates a DataSource object from an Amazon Relational Database Service (Amazon RDS)

Description

Creates a DataSource object from an Amazon Relational Database Service (Amazon RDS). A DataSource references data that can be used to perform create_ml_model, create_evaluation, or create_batch_prediction operations.

create_data_source_from_rds is an asynchronous operation. In response to create_data_source_from_rds, Amazon Machine Learning (Amazon ML) immediately returns and sets the DataSource status to PENDING. After the DataSource is created and ready for use, Amazon ML sets the Status parameter to COMPLETED. DataSource in the COMPLETED or PENDING state can be used only to perform ⁠>CreateMLModel⁠\, create_evaluation, or create_batch_prediction operations.

If Amazon ML cannot accept the input source, it sets the Status parameter to FAILED and includes an error message in the Message attribute of the get_data_source operation response.

Usage

machinelearning_create_data_source_from_rds(DataSourceId,
  DataSourceName, RDSData, RoleARN, ComputeStatistics)

Arguments

DataSourceId

[required] A user-supplied ID that uniquely identifies the DataSource. Typically, an Amazon Resource Number (ARN) becomes the ID for a DataSource.

DataSourceName

A user-supplied name or description of the DataSource.

RDSData

[required] The data specification of an Amazon RDS DataSource:

  • DatabaseInformation -

    • DatabaseName - The name of the Amazon RDS database.

    • InstanceIdentifier - A unique identifier for the Amazon RDS database instance.

  • DatabaseCredentials - AWS Identity and Access Management (IAM) credentials that are used to connect to the Amazon RDS database.

  • ResourceRole - A role (DataPipelineDefaultResourceRole) assumed by an EC2 instance to carry out the copy task from Amazon RDS to Amazon Simple Storage Service (Amazon S3). For more information, see Role templates for data pipelines.

  • ServiceRole - A role (DataPipelineDefaultRole) assumed by the AWS Data Pipeline service to monitor the progress of the copy task from Amazon RDS to Amazon S3. For more information, see Role templates for data pipelines.

  • SecurityInfo - The security information to use to access an RDS DB instance. You need to set up appropriate ingress rules for the security entity IDs provided to allow access to the Amazon RDS instance. Specify a [SubnetId, SecurityGroupIds] pair for a VPC-based RDS DB instance.

  • SelectSqlQuery - A query that is used to retrieve the observation data for the Datasource.

  • S3StagingLocation - The Amazon S3 location for staging Amazon RDS data. The data retrieved from Amazon RDS using SelectSqlQuery is stored in this location.

  • DataSchemaUri - The Amazon S3 location of the DataSchema.

  • DataSchema - A JSON string representing the schema. This is not required if DataSchemaUri is specified.

  • DataRearrangement - A JSON string that represents the splitting and rearrangement requirements for the Datasource.

    Sample - ⁠ "{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"⁠

RoleARN

[required] The role that Amazon ML assumes on behalf of the user to create and activate a data pipeline in the user's account and copy data using the SelectSqlQuery query from Amazon RDS to Amazon S3.

ComputeStatistics

The compute statistics for a DataSource. The statistics are generated from the observation data referenced by a DataSource. Amazon ML uses the statistics internally during MLModel training. This parameter must be set to true if the DataSource needs to be used for MLModel training.

Value

A list with the following syntax: 

list(
  DataSourceId = "string"
)

Request syntax

svc$create_data_source_from_rds(
  DataSourceId = "string",
  DataSourceName = "string",
  RDSData = list(
    DatabaseInformation = list(
      InstanceIdentifier = "string",
      DatabaseName = "string"
    ),
    SelectSqlQuery = "string",
    DatabaseCredentials = list(
      Username = "string",
      Password = "string"
    ),
    S3StagingLocation = "string",
    DataRearrangement = "string",
    DataSchema = "string",
    DataSchemaUri = "string",
    ResourceRole = "string",
    ServiceRole = "string",
    SubnetId = "string",
    SecurityGroupIds = list(
      "string"
    )
  ),
  RoleARN = "string",
  ComputeStatistics = TRUE|FALSE
)