get_batch_prediction

MachineLearning.Client.get_batch_prediction(**kwargs)

Returns a BatchPrediction that includes detailed metadata, status, and data file information for a Batch Prediction request.

See also: AWS API Documentation

Request Syntax

response = client.get_batch_prediction(
    BatchPredictionId='string'
)
Parameters
BatchPredictionId (string) --

[REQUIRED]

An ID assigned to the BatchPrediction at creation.

Return type
dict
Returns
Response Syntax
{
    'BatchPredictionId': 'string',
    'MLModelId': 'string',
    'BatchPredictionDataSourceId': 'string',
    'InputDataLocationS3': 'string',
    'CreatedByIamUser': 'string',
    'CreatedAt': datetime(2015, 1, 1),
    'LastUpdatedAt': datetime(2015, 1, 1),
    'Name': 'string',
    'Status': 'PENDING'|'INPROGRESS'|'FAILED'|'COMPLETED'|'DELETED',
    'OutputUri': 'string',
    'LogUri': 'string',
    'Message': 'string',
    'ComputeTime': 123,
    'FinishedAt': datetime(2015, 1, 1),
    'StartedAt': datetime(2015, 1, 1),
    'TotalRecordCount': 123,
    'InvalidRecordCount': 123
}

Response Structure

  • (dict) --

    Represents the output of a GetBatchPrediction operation and describes a BatchPrediction .

    • BatchPredictionId (string) --

      An ID assigned to the BatchPrediction at creation. This value should be identical to the value of the BatchPredictionID in the request.

    • MLModelId (string) --

      The ID of the MLModel that generated predictions for the BatchPrediction request.

    • BatchPredictionDataSourceId (string) --

      The ID of the DataSource that was used to create the BatchPrediction .

    • InputDataLocationS3 (string) --

      The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).

    • CreatedByIamUser (string) --

      The AWS user account that invoked the BatchPrediction . The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.

    • CreatedAt (datetime) --

      The time when the BatchPrediction was created. The time is expressed in epoch time.

    • LastUpdatedAt (datetime) --

      The time of the most recent edit to BatchPrediction . The time is expressed in epoch time.

    • Name (string) --

      A user-supplied name or description of the BatchPrediction .

    • Status (string) --

      The status of the BatchPrediction , which can be one of the following values:

      • PENDING - Amazon Machine Learning (Amazon ML) submitted a request to generate batch predictions.
      • INPROGRESS - The batch predictions are in progress.
      • FAILED - The request to perform a batch prediction did not run to completion. It is not usable.
      • COMPLETED - The batch prediction process completed successfully.
      • DELETED - The BatchPrediction is marked as deleted. It is not usable.
    • OutputUri (string) --

      The location of an Amazon S3 bucket or directory to receive the operation results.

    • LogUri (string) --

      A link to the file that contains logs of the CreateBatchPrediction operation.

    • Message (string) --

      A description of the most recent details about processing the batch prediction request.

    • ComputeTime (integer) --

      The approximate CPU time in milliseconds that Amazon Machine Learning spent processing the BatchPrediction , normalized and scaled on computation resources. ComputeTime is only available if the BatchPrediction is in the COMPLETED state.

    • FinishedAt (datetime) --

      The epoch time when Amazon Machine Learning marked the BatchPrediction as COMPLETED or FAILED . FinishedAt is only available when the BatchPrediction is in the COMPLETED or FAILED state.

    • StartedAt (datetime) --

      The epoch time when Amazon Machine Learning marked the BatchPrediction as INPROGRESS . StartedAt isn't available if the BatchPrediction is in the PENDING state.

    • TotalRecordCount (integer) --

      The number of total records that Amazon Machine Learning saw while processing the BatchPrediction .

    • InvalidRecordCount (integer) --

      The number of invalid records that Amazon Machine Learning saw while processing the BatchPrediction .

Exceptions

  • MachineLearning.Client.exceptions.InvalidInputException
  • MachineLearning.Client.exceptions.ResourceNotFoundException
  • MachineLearning.Client.exceptions.InternalServerException