libZSservicesZSamazonka-mlZSamazonka-ml
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.MachineLearning.CreateDataSourceFromRedshift

Description

Creates a DataSource from a database hosted on an Amazon Redshift cluster. A DataSource references data that can be used to perform either CreateMLModel, CreateEvaluation, or CreateBatchPrediction operations.

CreateDataSourceFromRedshift is an asynchronous operation. In response to CreateDataSourceFromRedshift, 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 COMPLETED or PENDING states can be used to perform only CreateMLModel, CreateEvaluation, or CreateBatchPrediction operations.

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

The observations should be contained in the database hosted on an Amazon Redshift cluster and should be specified by a SelectSqlQuery query. Amazon ML executes an Unload command in Amazon Redshift to transfer the result set of the SelectSqlQuery query to S3StagingLocation.

After the DataSource has been created, it's ready for use in evaluations and batch predictions. If you plan to use the DataSource to train an MLModel, the DataSource also requires a recipe. A recipe describes how each input variable will be used in training an MLModel. Will the variable be included or excluded from training? Will the variable be manipulated; for example, will it be combined with another variable or will it be split apart into word combinations? The recipe provides answers to these questions.

You can't change an existing datasource, but you can copy and modify the settings from an existing Amazon Redshift datasource to create a new datasource. To do so, call GetDataSource for an existing datasource and copy the values to a CreateDataSource call. Change the settings that you want to change and make sure that all required fields have the appropriate values.

Synopsis

Creating a Request

data CreateDataSourceFromRedshift Source #

See: newCreateDataSourceFromRedshift smart constructor.

Constructors

CreateDataSourceFromRedshift' 

Fields

  • dataSourceName :: Maybe Text

    A user-supplied name or description of the DataSource.

  • computeStatistics :: Maybe Bool

    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.

  • dataSourceId :: Text

    A user-supplied ID that uniquely identifies the DataSource.

  • dataSpec :: RedshiftDataSpec

    The data specification of an Amazon Redshift DataSource:

    • DatabaseInformation -

      • DatabaseName - The name of the Amazon Redshift database.
      • ClusterIdentifier - The unique ID for the Amazon Redshift cluster.
    • DatabaseCredentials - The AWS Identity and Access Management (IAM) credentials that are used to connect to the Amazon Redshift database.
    • SelectSqlQuery - The query that is used to retrieve the observation data for the Datasource.
    • S3StagingLocation - The Amazon Simple Storage Service (Amazon S3) location for staging Amazon Redshift data. The data retrieved from Amazon Redshift using the SelectSqlQuery query 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 :: Text

    A fully specified role Amazon Resource Name (ARN). Amazon ML assumes the role on behalf of the user to create the following:

    • A security group to allow Amazon ML to execute the SelectSqlQuery query on an Amazon Redshift cluster
    • An Amazon S3 bucket policy to grant Amazon ML read/write permissions on the S3StagingLocation

Instances

Instances details
Eq CreateDataSourceFromRedshift Source # 
Instance details

Defined in Amazonka.MachineLearning.CreateDataSourceFromRedshift

Methods

(==) :: CreateDataSourceFromRedshift -> CreateDataSourceFromRedshift -> Bool #

(/=) :: CreateDataSourceFromRedshift -> CreateDataSourceFromRedshift -> Bool #

Read CreateDataSourceFromRedshift Source # 
Instance details

Defined in Amazonka.MachineLearning.CreateDataSourceFromRedshift

Methods

readsPrec :: Int -> ReadS CreateDataSourceFromRedshift #

readList :: ReadS [CreateDataSourceFromRedshift] #

readPrec :: ReadPrec CreateDataSourceFromRedshift #

readListPrec :: ReadPrec [CreateDataSourceFromRedshift] #

Show CreateDataSourceFromRedshift Source # 
Instance details

Defined in Amazonka.MachineLearning.CreateDataSourceFromRedshift

Methods

showsPrec :: Int -> CreateDataSourceFromRedshift -> ShowS #

show :: CreateDataSourceFromRedshift -> String #

showList :: [CreateDataSourceFromRedshift] -> ShowS #

Generic CreateDataSourceFromRedshift Source # 
Instance details

Defined in Amazonka.MachineLearning.CreateDataSourceFromRedshift

Associated Types

type Rep CreateDataSourceFromRedshift :: Type -> Type #

Methods

from :: CreateDataSourceFromRedshift -> Rep CreateDataSourceFromRedshift x #

to :: Rep CreateDataSourceFromRedshift x -> CreateDataSourceFromRedshift #

NFData CreateDataSourceFromRedshift Source # 
Instance details

Defined in Amazonka.MachineLearning.CreateDataSourceFromRedshift

Methods

rnf :: CreateDataSourceFromRedshift -> () #

Hashable CreateDataSourceFromRedshift Source # 
Instance details

Defined in Amazonka.MachineLearning.CreateDataSourceFromRedshift

Methods

hashWithSalt :: Int -> CreateDataSourceFromRedshift -> Int #

hash :: CreateDataSourceFromRedshift -> Int #

ToJSON CreateDataSourceFromRedshift Source # 
Instance details

Defined in Amazonka.MachineLearning.CreateDataSourceFromRedshift

Methods

toJSON :: CreateDataSourceFromRedshift -> Value #

toEncoding :: CreateDataSourceFromRedshift -> Encoding #

toJSONList :: [CreateDataSourceFromRedshift] -> Value #

toEncodingList :: [CreateDataSourceFromRedshift] -> Encoding #

AWSRequest CreateDataSourceFromRedshift Source # 
Instance details

Defined in Amazonka.MachineLearning.CreateDataSourceFromRedshift

Associated Types

type AWSResponse CreateDataSourceFromRedshift #

Methods

request :: CreateDataSourceFromRedshift -> Request CreateDataSourceFromRedshift #

response :: MonadResource m => Logger -> Service -> Proxy CreateDataSourceFromRedshift -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateDataSourceFromRedshift))) #

ToHeaders CreateDataSourceFromRedshift Source # 
Instance details

Defined in Amazonka.MachineLearning.CreateDataSourceFromRedshift

Methods

toHeaders :: CreateDataSourceFromRedshift -> [Header] #

ToPath CreateDataSourceFromRedshift Source # 
Instance details

Defined in Amazonka.MachineLearning.CreateDataSourceFromRedshift

Methods

toPath :: CreateDataSourceFromRedshift -> ByteString #

ToQuery CreateDataSourceFromRedshift Source # 
Instance details

Defined in Amazonka.MachineLearning.CreateDataSourceFromRedshift

Methods

toQuery :: CreateDataSourceFromRedshift -> QueryString #

type Rep CreateDataSourceFromRedshift Source # 
Instance details

Defined in Amazonka.MachineLearning.CreateDataSourceFromRedshift

type Rep CreateDataSourceFromRedshift = D1 ('MetaData "CreateDataSourceFromRedshift" "Amazonka.MachineLearning.CreateDataSourceFromRedshift" "libZSservicesZSamazonka-mlZSamazonka-ml" 'False) (C1 ('MetaCons "CreateDataSourceFromRedshift'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dataSourceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "computeStatistics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "dataSourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "dataSpec") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RedshiftDataSpec) :*: S1 ('MetaSel ('Just "roleARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse CreateDataSourceFromRedshift Source # 
Instance details

Defined in Amazonka.MachineLearning.CreateDataSourceFromRedshift

type AWSResponse CreateDataSourceFromRedshift = CreateDataSourceFromRedshiftResponse

newCreateDataSourceFromRedshift Source #

Arguments

:: Text

$sel:dataSourceId:CreateDataSourceFromRedshift'

-> RedshiftDataSpec

$sel:dataSpec:CreateDataSourceFromRedshift'

-> Text

$sel:roleARN:CreateDataSourceFromRedshift'

-> CreateDataSourceFromRedshift 

Create a value of CreateDataSourceFromRedshift with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dataSourceName:CreateDataSourceFromRedshift', createDataSourceFromRedshift_dataSourceName - A user-supplied name or description of the DataSource.

$sel:computeStatistics:CreateDataSourceFromRedshift', createDataSourceFromRedshift_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.

$sel:dataSourceId:CreateDataSourceFromRedshift', createDataSourceFromRedshift_dataSourceId - A user-supplied ID that uniquely identifies the DataSource.

$sel:dataSpec:CreateDataSourceFromRedshift', createDataSourceFromRedshift_dataSpec - The data specification of an Amazon Redshift DataSource:

  • DatabaseInformation -

    • DatabaseName - The name of the Amazon Redshift database.
    • ClusterIdentifier - The unique ID for the Amazon Redshift cluster.
  • DatabaseCredentials - The AWS Identity and Access Management (IAM) credentials that are used to connect to the Amazon Redshift database.
  • SelectSqlQuery - The query that is used to retrieve the observation data for the Datasource.
  • S3StagingLocation - The Amazon Simple Storage Service (Amazon S3) location for staging Amazon Redshift data. The data retrieved from Amazon Redshift using the SelectSqlQuery query 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}}"

$sel:roleARN:CreateDataSourceFromRedshift', createDataSourceFromRedshift_roleARN - A fully specified role Amazon Resource Name (ARN). Amazon ML assumes the role on behalf of the user to create the following:

  • A security group to allow Amazon ML to execute the SelectSqlQuery query on an Amazon Redshift cluster
  • An Amazon S3 bucket policy to grant Amazon ML read/write permissions on the S3StagingLocation

Request Lenses

createDataSourceFromRedshift_dataSourceName :: Lens' CreateDataSourceFromRedshift (Maybe Text) Source #

A user-supplied name or description of the DataSource.

createDataSourceFromRedshift_computeStatistics :: Lens' CreateDataSourceFromRedshift (Maybe Bool) Source #

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.

createDataSourceFromRedshift_dataSourceId :: Lens' CreateDataSourceFromRedshift Text Source #

A user-supplied ID that uniquely identifies the DataSource.

createDataSourceFromRedshift_dataSpec :: Lens' CreateDataSourceFromRedshift RedshiftDataSpec Source #

The data specification of an Amazon Redshift DataSource:

  • DatabaseInformation -

    • DatabaseName - The name of the Amazon Redshift database.
    • ClusterIdentifier - The unique ID for the Amazon Redshift cluster.
  • DatabaseCredentials - The AWS Identity and Access Management (IAM) credentials that are used to connect to the Amazon Redshift database.
  • SelectSqlQuery - The query that is used to retrieve the observation data for the Datasource.
  • S3StagingLocation - The Amazon Simple Storage Service (Amazon S3) location for staging Amazon Redshift data. The data retrieved from Amazon Redshift using the SelectSqlQuery query 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}}"

createDataSourceFromRedshift_roleARN :: Lens' CreateDataSourceFromRedshift Text Source #

A fully specified role Amazon Resource Name (ARN). Amazon ML assumes the role on behalf of the user to create the following:

  • A security group to allow Amazon ML to execute the SelectSqlQuery query on an Amazon Redshift cluster
  • An Amazon S3 bucket policy to grant Amazon ML read/write permissions on the S3StagingLocation

Destructuring the Response

data CreateDataSourceFromRedshiftResponse Source #

Represents the output of a CreateDataSourceFromRedshift operation, and is an acknowledgement that Amazon ML received the request.

The CreateDataSourceFromRedshift operation is asynchronous. You can poll for updates by using the GetBatchPrediction operation and checking the Status parameter.

See: newCreateDataSourceFromRedshiftResponse smart constructor.

Constructors

CreateDataSourceFromRedshiftResponse' 

Fields

  • dataSourceId :: Maybe Text

    A user-supplied ID that uniquely identifies the datasource. This value should be identical to the value of the DataSourceID in the request.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq CreateDataSourceFromRedshiftResponse Source # 
Instance details

Defined in Amazonka.MachineLearning.CreateDataSourceFromRedshift

Methods

(==) :: CreateDataSourceFromRedshiftResponse -> CreateDataSourceFromRedshiftResponse -> Bool #

(/=) :: CreateDataSourceFromRedshiftResponse -> CreateDataSourceFromRedshiftResponse -> Bool #

Read CreateDataSourceFromRedshiftResponse Source # 
Instance details

Defined in Amazonka.MachineLearning.CreateDataSourceFromRedshift

Methods

readsPrec :: Int -> ReadS CreateDataSourceFromRedshiftResponse #

readList :: ReadS [CreateDataSourceFromRedshiftResponse] #

readPrec :: ReadPrec CreateDataSourceFromRedshiftResponse #

readListPrec :: ReadPrec [CreateDataSourceFromRedshiftResponse] #

Show CreateDataSourceFromRedshiftResponse Source # 
Instance details

Defined in Amazonka.MachineLearning.CreateDataSourceFromRedshift

Methods

showsPrec :: Int -> CreateDataSourceFromRedshiftResponse -> ShowS #

show :: CreateDataSourceFromRedshiftResponse -> String #

showList :: [CreateDataSourceFromRedshiftResponse] -> ShowS #

Generic CreateDataSourceFromRedshiftResponse Source # 
Instance details

Defined in Amazonka.MachineLearning.CreateDataSourceFromRedshift

Associated Types

type Rep CreateDataSourceFromRedshiftResponse :: Type -> Type #

Methods

from :: CreateDataSourceFromRedshiftResponse -> Rep CreateDataSourceFromRedshiftResponse x #

to :: Rep CreateDataSourceFromRedshiftResponse x -> CreateDataSourceFromRedshiftResponse #

NFData CreateDataSourceFromRedshiftResponse Source # 
Instance details

Defined in Amazonka.MachineLearning.CreateDataSourceFromRedshift

Methods

rnf :: CreateDataSourceFromRedshiftResponse -> () #

type Rep CreateDataSourceFromRedshiftResponse Source # 
Instance details

Defined in Amazonka.MachineLearning.CreateDataSourceFromRedshift

type Rep CreateDataSourceFromRedshiftResponse = D1 ('MetaData "CreateDataSourceFromRedshiftResponse" "Amazonka.MachineLearning.CreateDataSourceFromRedshift" "libZSservicesZSamazonka-mlZSamazonka-ml" 'False) (C1 ('MetaCons "CreateDataSourceFromRedshiftResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dataSourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateDataSourceFromRedshiftResponse Source #

Arguments

:: Int

$sel:httpStatus:CreateDataSourceFromRedshiftResponse'

-> CreateDataSourceFromRedshiftResponse 

Create a value of CreateDataSourceFromRedshiftResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dataSourceId:CreateDataSourceFromRedshift', createDataSourceFromRedshiftResponse_dataSourceId - A user-supplied ID that uniquely identifies the datasource. This value should be identical to the value of the DataSourceID in the request.

$sel:httpStatus:CreateDataSourceFromRedshiftResponse', createDataSourceFromRedshiftResponse_httpStatus - The response's http status code.

Response Lenses

createDataSourceFromRedshiftResponse_dataSourceId :: Lens' CreateDataSourceFromRedshiftResponse (Maybe Text) Source #

A user-supplied ID that uniquely identifies the datasource. This value should be identical to the value of the DataSourceID in the request.

createDataSourceFromRedshiftResponse_httpStatus :: Lens' CreateDataSourceFromRedshiftResponse Int Source #

The response's http status code.