Amazonka.MachineLearning.CreateBatchPrediction

Generates predictions for a group of observations. The observations to process exist in one or more data files referenced by a DataSource. This operation creates a new BatchPrediction, and uses an MLModel and the data files referenced by the DataSource as information sources.

CreateBatchPrediction is an asynchronous operation. In response to CreateBatchPrediction, Amazon Machine Learning (Amazon ML) immediately returns and sets the BatchPrediction status to PENDING. After the BatchPrediction completes, Amazon ML sets the status to COMPLETED.

You can poll for status updates by using the GetBatchPrediction operation and checking the Status parameter of the result. After the COMPLETED status appears, the results are available in the location specified by the OutputUri parameter.

Creating a Request

data CreateBatchPrediction

See: newCreateBatchPrediction smart constructor.

Constructors

CreateBatchPrediction'

Fields

• batchPredictionName :: Maybe Text

  A user-supplied name or description of the BatchPrediction. BatchPredictionName can only use the UTF-8 character set.

• batchPredictionId :: Text

  A user-supplied ID that uniquely identifies the BatchPrediction.

• mLModelId :: Text

  The ID of the MLModel that will generate predictions for the group of observations.

• batchPredictionDataSourceId :: Text

  The ID of the DataSource that points to the group of observations to predict.

• outputUri :: Text

  The location of an Amazon Simple Storage Service (Amazon S3) bucket or directory to store the batch prediction results. The following substrings are not allowed in the s3 key portion of the outputURI field: ':', '//', '/./', '/../'.

  Amazon ML needs permissions to store and retrieve the logs on your behalf. For information about how to set permissions, see the Amazon Machine Learning Developer Guide.

Instances

ToJSON CreateBatchPrediction

Defined in Amazonka.MachineLearning.CreateBatchPrediction

Methods

toJSON :: CreateBatchPrediction -> Value

toEncoding :: CreateBatchPrediction -> Encoding

toJSONList :: [CreateBatchPrediction] -> Value

toEncodingList :: [CreateBatchPrediction] -> Encoding

ToHeaders CreateBatchPrediction

Defined in Amazonka.MachineLearning.CreateBatchPrediction

Methods

toHeaders :: CreateBatchPrediction -> [Header]

ToPath CreateBatchPrediction

Defined in Amazonka.MachineLearning.CreateBatchPrediction

Methods

toPath :: CreateBatchPrediction -> ByteString

ToQuery CreateBatchPrediction

Defined in Amazonka.MachineLearning.CreateBatchPrediction

Methods

toQuery :: CreateBatchPrediction -> QueryString

AWSRequest CreateBatchPrediction

Defined in Amazonka.MachineLearning.CreateBatchPrediction

Associated Types

type AWSResponse CreateBatchPrediction

Methods

request :: (Service -> Service) -> CreateBatchPrediction -> Request CreateBatchPrediction

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateBatchPrediction -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateBatchPrediction)))

Generic CreateBatchPrediction

Defined in Amazonka.MachineLearning.CreateBatchPrediction

Associated Types

type Rep CreateBatchPrediction :: Type -> Type

Methods

from :: CreateBatchPrediction -> Rep CreateBatchPrediction x

to :: Rep CreateBatchPrediction x -> CreateBatchPrediction

Read CreateBatchPrediction

Defined in Amazonka.MachineLearning.CreateBatchPrediction

Methods

readsPrec :: Int -> ReadS CreateBatchPrediction

readList :: ReadS [CreateBatchPrediction]

readPrec :: ReadPrec CreateBatchPrediction

readListPrec :: ReadPrec [CreateBatchPrediction]

Show CreateBatchPrediction

Defined in Amazonka.MachineLearning.CreateBatchPrediction

Methods

showsPrec :: Int -> CreateBatchPrediction -> ShowS

show :: CreateBatchPrediction -> String

showList :: [CreateBatchPrediction] -> ShowS

NFData CreateBatchPrediction

Defined in Amazonka.MachineLearning.CreateBatchPrediction

Methods

rnf :: CreateBatchPrediction -> ()

Eq CreateBatchPrediction

Defined in Amazonka.MachineLearning.CreateBatchPrediction

Methods

(==) :: CreateBatchPrediction -> CreateBatchPrediction -> Bool

(/=) :: CreateBatchPrediction -> CreateBatchPrediction -> Bool

Hashable CreateBatchPrediction

Defined in Amazonka.MachineLearning.CreateBatchPrediction

Methods

hashWithSalt :: Int -> CreateBatchPrediction -> Int

hash :: CreateBatchPrediction -> Int

type AWSResponse CreateBatchPrediction

Defined in Amazonka.MachineLearning.CreateBatchPrediction

type AWSResponse CreateBatchPrediction = CreateBatchPredictionResponse

type Rep CreateBatchPrediction

Defined in Amazonka.MachineLearning.CreateBatchPrediction

type Rep CreateBatchPrediction = D1 ('MetaData "CreateBatchPrediction" "Amazonka.MachineLearning.CreateBatchPrediction" "amazonka-ml-2.0-A3JLJ63WvmfHxGBBIqhdRA" 'False) (C1 ('MetaCons "CreateBatchPrediction'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "batchPredictionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "batchPredictionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "mLModelId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "batchPredictionDataSourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "outputUri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateBatchPrediction

Arguments

:: Text

CreateBatchPrediction

-> Text

CreateBatchPrediction

-> Text

CreateBatchPrediction

-> Text

CreateBatchPrediction

-> CreateBatchPrediction

Create a value of CreateBatchPrediction 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:batchPredictionName:CreateBatchPrediction', createBatchPrediction_batchPredictionName - A user-supplied name or description of the BatchPrediction. BatchPredictionName can only use the UTF-8 character set.

CreateBatchPrediction, createBatchPrediction_batchPredictionId - A user-supplied ID that uniquely identifies the BatchPrediction.

CreateBatchPrediction, createBatchPrediction_mLModelId - The ID of the MLModel that will generate predictions for the group of observations.

CreateBatchPrediction, createBatchPrediction_batchPredictionDataSourceId - The ID of the DataSource that points to the group of observations to predict.

CreateBatchPrediction, createBatchPrediction_outputUri - The location of an Amazon Simple Storage Service (Amazon S3) bucket or directory to store the batch prediction results. The following substrings are not allowed in the s3 key portion of the outputURI field: ':', '//', '/./', '/../'.

Amazon ML needs permissions to store and retrieve the logs on your behalf. For information about how to set permissions, see the Amazon Machine Learning Developer Guide.

Request Lenses

createBatchPrediction_batchPredictionName :: Lens' CreateBatchPrediction (Maybe Text)

A user-supplied name or description of the BatchPrediction. BatchPredictionName can only use the UTF-8 character set.

createBatchPrediction_batchPredictionId :: Lens' CreateBatchPrediction Text

A user-supplied ID that uniquely identifies the BatchPrediction.

createBatchPrediction_mLModelId :: Lens' CreateBatchPrediction Text

The ID of the MLModel that will generate predictions for the group of observations.

createBatchPrediction_batchPredictionDataSourceId :: Lens' CreateBatchPrediction Text

The ID of the DataSource that points to the group of observations to predict.

createBatchPrediction_outputUri :: Lens' CreateBatchPrediction Text

The location of an Amazon Simple Storage Service (Amazon S3) bucket or directory to store the batch prediction results. The following substrings are not allowed in the s3 key portion of the outputURI field: ':', '//', '/./', '/../'.

Amazon ML needs permissions to store and retrieve the logs on your behalf. For information about how to set permissions, see the Amazon Machine Learning Developer Guide.

Destructuring the Response

data CreateBatchPredictionResponse

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

The CreateBatchPrediction operation is asynchronous. You can poll for status updates by using the >GetBatchPrediction operation and checking the Status parameter of the result.

See: newCreateBatchPredictionResponse smart constructor.

Constructors

CreateBatchPredictionResponse'

Fields

• batchPredictionId :: Maybe Text

  A user-supplied ID that uniquely identifies the BatchPrediction. This value is identical to the value of the BatchPredictionId in the request.

• httpStatus :: Int

  The response's http status code.

Instances

Generic CreateBatchPredictionResponse

Defined in Amazonka.MachineLearning.CreateBatchPrediction

Associated Types

type Rep CreateBatchPredictionResponse :: Type -> Type

Methods

from :: CreateBatchPredictionResponse -> Rep CreateBatchPredictionResponse x

to :: Rep CreateBatchPredictionResponse x -> CreateBatchPredictionResponse

Read CreateBatchPredictionResponse

Defined in Amazonka.MachineLearning.CreateBatchPrediction

Methods

readsPrec :: Int -> ReadS CreateBatchPredictionResponse

readList :: ReadS [CreateBatchPredictionResponse]

readPrec :: ReadPrec CreateBatchPredictionResponse

readListPrec :: ReadPrec [CreateBatchPredictionResponse]

Show CreateBatchPredictionResponse

Defined in Amazonka.MachineLearning.CreateBatchPrediction

Methods

showsPrec :: Int -> CreateBatchPredictionResponse -> ShowS

show :: CreateBatchPredictionResponse -> String

showList :: [CreateBatchPredictionResponse] -> ShowS

NFData CreateBatchPredictionResponse

Defined in Amazonka.MachineLearning.CreateBatchPrediction

Methods

rnf :: CreateBatchPredictionResponse -> ()

Eq CreateBatchPredictionResponse

Defined in Amazonka.MachineLearning.CreateBatchPrediction

Methods

(==) :: CreateBatchPredictionResponse -> CreateBatchPredictionResponse -> Bool

(/=) :: CreateBatchPredictionResponse -> CreateBatchPredictionResponse -> Bool

type Rep CreateBatchPredictionResponse

Defined in Amazonka.MachineLearning.CreateBatchPrediction

type Rep CreateBatchPredictionResponse = D1 ('MetaData "CreateBatchPredictionResponse" "Amazonka.MachineLearning.CreateBatchPrediction" "amazonka-ml-2.0-A3JLJ63WvmfHxGBBIqhdRA" 'False) (C1 ('MetaCons "CreateBatchPredictionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "batchPredictionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateBatchPredictionResponse

Arguments

:: Int

$sel:httpStatus:CreateBatchPredictionResponse'

-> CreateBatchPredictionResponse

Create a value of CreateBatchPredictionResponse 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:

CreateBatchPrediction, createBatchPredictionResponse_batchPredictionId - A user-supplied ID that uniquely identifies the BatchPrediction. This value is identical to the value of the BatchPredictionId in the request.

$sel:httpStatus:CreateBatchPredictionResponse', createBatchPredictionResponse_httpStatus - The response's http status code.

Response Lenses

createBatchPredictionResponse_batchPredictionId :: Lens' CreateBatchPredictionResponse (Maybe Text)

A user-supplied ID that uniquely identifies the BatchPrediction. This value is identical to the value of the BatchPredictionId in the request.

createBatchPredictionResponse_httpStatus :: Lens' CreateBatchPredictionResponse Int

The response's http status code.