AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

RDSDataSpec

import "github.com/aws/aws-sdk-go/service/machinelearning"

type RDSDataSpec struct { DataRearrangement *string `type:"string"` DataSchema *string `type:"string"` DataSchemaUri *string `type:"string"` DatabaseCredentials *RDSDatabaseCredentials `type:"structure" required:"true"` DatabaseInformation *RDSDatabase `type:"structure" required:"true"` ResourceRole *string `min:"1" type:"string" required:"true"` S3StagingLocation *string `type:"string" required:"true"` SecurityGroupIds []*string `type:"list" required:"true"` SelectSqlQuery *string `min:"1" type:"string" required:"true"` ServiceRole *string `min:"1" type:"string" required:"true"` SubnetId *string `min:"1" type:"string" required:"true"` }

The data specification of an Amazon Relational Database Service (Amazon RDS) DataSource.

DataRearrangement

Type: *string

A JSON string that represents the splitting and rearrangement processing to be applied to a DataSource. If the DataRearrangement parameter is not provided, all of the input data is used to create the Datasource.

There are multiple parameters that control what data is used to create a datasource:

  • percentBegin

Use percentBegin to indicate the beginning of the range of the data used

to create the Datasource. If you do not include percentBegin and percentEnd, Amazon ML includes all of the data when creating the datasource.
  • percentEnd

Use percentEnd to indicate the end of the range of the data used to create

the Datasource. If you do not include percentBegin and percentEnd, Amazon ML includes all of the data when creating the datasource.
  • complement

The complement parameter instructs Amazon ML to use the data that is not

included in the range of percentBegin to percentEnd to create a datasource. The complement parameter is useful if you need to create complementary datasources for training and evaluation. To create a complementary datasource, use the same values for percentBegin and percentEnd, along with the complement parameter.

For example, the following two datasources do not share any data, and can

be used to train and evaluate a model. The first datasource has 25 percent of the data, and the second one has 75 percent of the data.

Datasource for evaluation: {"splitting":{"percentBegin":0, "percentEnd":25}}

Datasource for training: {"splitting":{"percentBegin":0, "percentEnd":25,

"complement":"true"}}
  • strategy

To change how Amazon ML splits the data for a datasource, use the strategy

parameter.

The default value for the strategy parameter is sequential, meaning that

Amazon ML takes all of the data records between the percentBegin and percentEnd parameters for the datasource, in the order that the records appear in the input data.

The following two DataRearrangement lines are examples of sequentially ordered

training and evaluation datasources:

Datasource for evaluation: {"splitting":{"percentBegin":70, "percentEnd":100,

"strategy":"sequential"}}

Datasource for training: {"splitting":{"percentBegin":70, "percentEnd":100,

"strategy":"sequential", "complement":"true"}}

To randomly split the input data into the proportions indicated by the percentBegin

and percentEnd parameters, set the strategy parameter to random and provide a string that is used as the seed value for the random data splitting (for example, you can use the S3 path to your data as the random seed string). If you choose the random split strategy, Amazon ML assigns each row of data a pseudo-random number between 0 and 100, and then selects the rows that have an assigned number between percentBegin and percentEnd. Pseudo-random numbers are assigned using both the input seed string value and the byte offset as a seed, so changing the data results in a different split. Any existing ordering is preserved. The random splitting strategy ensures that variables in the training and evaluation data are distributed similarly. It is useful in the cases where the input data may have an implicit sort order, which would otherwise result in training and evaluation datasources containing non-similar data records.

The following two DataRearrangement lines are examples of non-sequentially

ordered training and evaluation datasources:

Datasource for evaluation: {"splitting":{"percentBegin":70, "percentEnd":100,

"strategy":"random", "randomSeed"="s3://my_s3_path/bucket/file.csv"}}

Datasource for training: {"splitting":{"percentBegin":70, "percentEnd":100,

"strategy":"random", "randomSeed"="s3://my_s3_path/bucket/file.csv", "complement":"true"}}
DataSchema

Type: *string

A JSON string that represents the schema for an Amazon RDS DataSource. The DataSchema defines the structure of the observation data in the data file(s) referenced in the DataSource.

A DataSchema is not required if you specify a DataSchemaUri

Define your DataSchema as a series of key-value pairs. attributes and excludedVariableNames have an array of key-value pairs for their value. Use the following format to define your DataSchema.

{ "version": "1.0",

"recordAnnotationFieldName": "F1",

"recordWeightFieldName": "F2",

"targetFieldName": "F3",

"dataFormat": "CSV",

"dataFileContainsHeader": true,

"attributes": [

{ "fieldName": "F1", "fieldType": "TEXT" }, { "fieldName": "F2", "fieldType": "NUMERIC" }, { "fieldName": "F3", "fieldType": "CATEGORICAL" }, { "fieldName": "F4", "fieldType": "NUMERIC" }, { "fieldName": "F5", "fieldType": "CATEGORICAL" }, { "fieldName": "F6", "fieldType": "TEXT" }, { "fieldName": "F7", "fieldType": "WEIGHTED_INT_SEQUENCE" }, { "fieldName": "F8", "fieldType": "WEIGHTED_STRING_SEQUENCE" } ],

"excludedVariableNames": [ "F6" ] }

DataSchemaUri

Type: *string

The Amazon S3 location of the DataSchema.

DatabaseCredentials

The database credentials to connect to a database on an RDS DB instance.

DatabaseInformation

The database details of an Amazon RDS database.

ResourceRole

Type: *string

The role (DataPipelineDefaultResourceRole) assumed by an Amazon Elastic Compute Cloud (Amazon EC2) instance to carry out the copy operation from Amazon RDS to an Amazon S3 task. For more information, see Role templates (https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-iam-roles.html) for data pipelines.

ResourceRole is a required field

S3StagingLocation

Type: *string

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

S3StagingLocation is a required field

SecurityGroupIds

Type: []*string

The security group IDs to be used to access a VPC-based RDS DB instance. Ensure that there are appropriate ingress rules set up to allow access to the RDS DB instance. This attribute is used by Data Pipeline to carry out the copy operation from Amazon RDS to an Amazon S3 task.

SecurityGroupIds is a required field

SelectSqlQuery

Type: *string

The query that is used to retrieve the observation data for the DataSource.

SelectSqlQuery is a required field

ServiceRole

Type: *string

The role (DataPipelineDefaultRole) assumed by AWS Data Pipeline service to monitor the progress of the copy task from Amazon RDS to Amazon S3. For more information, see Role templates (https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-iam-roles.html) for data pipelines.

ServiceRole is a required field

SubnetId

Type: *string

The subnet ID to be used to access a VPC-based RDS DB instance. This attribute is used by Data Pipeline to carry out the copy task from Amazon RDS to Amazon S3.

SubnetId is a required field

Method

GoString

func (s RDSDataSpec) GoString() string

GoString returns the string representation

SetDataRearrangement

func (s *RDSDataSpec) SetDataRearrangement(v string) *RDSDataSpec

SetDataRearrangement sets the DataRearrangement field's value.

SetDataSchema

func (s *RDSDataSpec) SetDataSchema(v string) *RDSDataSpec

SetDataSchema sets the DataSchema field's value.

SetDataSchemaUri

func (s *RDSDataSpec) SetDataSchemaUri(v string) *RDSDataSpec

SetDataSchemaUri sets the DataSchemaUri field's value.

SetDatabaseCredentials

func (s *RDSDataSpec) SetDatabaseCredentials(v *RDSDatabaseCredentials) *RDSDataSpec

SetDatabaseCredentials sets the DatabaseCredentials field's value.

SetDatabaseInformation

func (s *RDSDataSpec) SetDatabaseInformation(v *RDSDatabase) *RDSDataSpec

SetDatabaseInformation sets the DatabaseInformation field's value.

SetResourceRole

func (s *RDSDataSpec) SetResourceRole(v string) *RDSDataSpec

SetResourceRole sets the ResourceRole field's value.

SetS3StagingLocation

func (s *RDSDataSpec) SetS3StagingLocation(v string) *RDSDataSpec

SetS3StagingLocation sets the S3StagingLocation field's value.

SetSecurityGroupIds

func (s *RDSDataSpec) SetSecurityGroupIds(v []*string) *RDSDataSpec

SetSecurityGroupIds sets the SecurityGroupIds field's value.

SetSelectSqlQuery

func (s *RDSDataSpec) SetSelectSqlQuery(v string) *RDSDataSpec

SetSelectSqlQuery sets the SelectSqlQuery field's value.

SetServiceRole

func (s *RDSDataSpec) SetServiceRole(v string) *RDSDataSpec

SetServiceRole sets the ServiceRole field's value.

SetSubnetId

func (s *RDSDataSpec) SetSubnetId(v string) *RDSDataSpec

SetSubnetId sets the SubnetId field's value.

String

func (s RDSDataSpec) String() string

String returns the string representation

Validate

func (s *RDSDataSpec) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: