software.amazon.awssdk.services.machinelearning.model

Interface RedshiftDataSpec.Builder

All Superinterfaces:

CopyableBuilder<RedshiftDataSpec.Builder,RedshiftDataSpec>, SdkBuilder<RedshiftDataSpec.Builder,RedshiftDataSpec>

Enclosing class:

RedshiftDataSpec

public static interface RedshiftDataSpec.Builder
extends CopyableBuilder<RedshiftDataSpec.Builder,RedshiftDataSpec>

Method Summary

Modifier and Type	Method and Description
default RedshiftDataSpec.Builder	databaseCredentials(Consumer<RedshiftDatabaseCredentials.Builder> databaseCredentials) Describes AWS Identity and Access Management (IAM) credentials that are used connect to the Amazon Redshift database.
RedshiftDataSpec.Builder	databaseCredentials(RedshiftDatabaseCredentials databaseCredentials) Describes AWS Identity and Access Management (IAM) credentials that are used connect to the Amazon Redshift database.
default RedshiftDataSpec.Builder	databaseInformation(Consumer<RedshiftDatabase.Builder> databaseInformation) Describes the DatabaseName and ClusterIdentifier for an Amazon Redshift DataSource.
RedshiftDataSpec.Builder	databaseInformation(RedshiftDatabase databaseInformation) Describes the DatabaseName and ClusterIdentifier for an Amazon Redshift DataSource.
RedshiftDataSpec.Builder	dataRearrangement(String dataRearrangement) A JSON string that represents the splitting and rearrangement processing to be applied to a DataSource.
RedshiftDataSpec.Builder	dataSchema(String dataSchema) A JSON string that represents the schema for an Amazon Redshift DataSource.
RedshiftDataSpec.Builder	dataSchemaUri(String dataSchemaUri) Describes the schema location for an Amazon Redshift DataSource.
RedshiftDataSpec.Builder	s3StagingLocation(String s3StagingLocation) Describes an Amazon S3 location to store the result set of the SelectSqlQuery query.
RedshiftDataSpec.Builder	selectSqlQuery(String selectSqlQuery) Describes the SQL Query to execute on an Amazon Redshift database for an Amazon Redshift DataSource.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

apply, build

Method Detail

databaseInformation

RedshiftDataSpec.Builder databaseInformation(RedshiftDatabase databaseInformation)

Describes the DatabaseName and ClusterIdentifier for an Amazon Redshift DataSource.

Parameters:

databaseInformation - Describes the DatabaseName and ClusterIdentifier for an Amazon Redshift DataSource.

Returns:

Returns a reference to this object so that method calls can be chained together.

databaseInformation

default RedshiftDataSpec.Builder databaseInformation(Consumer<RedshiftDatabase.Builder> databaseInformation)

Describes the DatabaseName and ClusterIdentifier for an Amazon Redshift DataSource.

This is a convenience that creates an instance of the RedshiftDatabase.Builder avoiding the need to create one manually via RedshiftDatabase.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to databaseInformation(RedshiftDatabase).

Parameters:

databaseInformation - a consumer that will call methods on RedshiftDatabase.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

databaseInformation(RedshiftDatabase)

selectSqlQuery

RedshiftDataSpec.Builder selectSqlQuery(String selectSqlQuery)

Describes the SQL Query to execute on an Amazon Redshift database for an Amazon Redshift DataSource.

Parameters:

selectSqlQuery - Describes the SQL Query to execute on an Amazon Redshift database for an Amazon Redshift DataSource.

Returns:

Returns a reference to this object so that method calls can be chained together.

databaseCredentials

RedshiftDataSpec.Builder databaseCredentials(RedshiftDatabaseCredentials databaseCredentials)

Describes AWS Identity and Access Management (IAM) credentials that are used connect to the Amazon Redshift database.

Parameters:

databaseCredentials - Describes AWS Identity and Access Management (IAM) credentials that are used connect to the Amazon Redshift database.

Returns:

Returns a reference to this object so that method calls can be chained together.

databaseCredentials

default RedshiftDataSpec.Builder databaseCredentials(Consumer<RedshiftDatabaseCredentials.Builder> databaseCredentials)

Describes AWS Identity and Access Management (IAM) credentials that are used connect to the Amazon Redshift database.

This is a convenience that creates an instance of the RedshiftDatabaseCredentials.Builder avoiding the need to create one manually via RedshiftDatabaseCredentials.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to databaseCredentials(RedshiftDatabaseCredentials).

Parameters:

databaseCredentials - a consumer that will call methods on RedshiftDatabaseCredentials.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

databaseCredentials(RedshiftDatabaseCredentials)

s3StagingLocation

RedshiftDataSpec.Builder s3StagingLocation(String s3StagingLocation)

Describes an Amazon S3 location to store the result set of the SelectSqlQuery query.

Parameters:

s3StagingLocation - Describes an Amazon S3 location to store the result set of the SelectSqlQuery query.

Returns:

Returns a reference to this object so that method calls can be chained together.

dataRearrangement

RedshiftDataSpec.Builder dataRearrangement(String dataRearrangement)

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"}}

Parameters:

dataRearrangement - 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"}}

Returns:

Returns a reference to this object so that method calls can be chained together.

dataSchema

RedshiftDataSpec.Builder dataSchema(String dataSchema)

A JSON string that represents the schema for an Amazon Redshift 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" ] }

Parameters:

dataSchema - A JSON string that represents the schema for an Amazon Redshift 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" ] }

Returns:

Returns a reference to this object so that method calls can be chained together.

dataSchemaUri

RedshiftDataSpec.Builder dataSchemaUri(String dataSchemaUri)

Describes the schema location for an Amazon Redshift DataSource.

Parameters:

dataSchemaUri - Describes the schema location for an Amazon Redshift DataSource.

Returns:

Returns a reference to this object so that method calls can be chained together.