Skip to content

GetBatchPredictionOutput

Source code in docs_src/capo_machine_learning/types/get_batch_prediction_output.py
class GetBatchPredictionOutput(TypedDict, closed=True):
    batch_prediction_id: NotRequired["capo_machine_learning.types.entity_id.EntityId"]
    """<p>An ID assigned to the <code>BatchPrediction</code> at creation. This value should be identical to the value of the <code>BatchPredictionID</code> in the request.</p>"""
    ml_model_id: NotRequired["capo_machine_learning.types.entity_id.EntityId"]
    """<p>The ID of the <code>MLModel</code> that generated predictions for the <code>BatchPrediction</code> request.</p>"""
    batch_prediction_data_source_id: NotRequired[
        "capo_machine_learning.types.entity_id.EntityId"
    ]
    """<p>The ID of the <code>DataSource</code> that was used to create the <code>BatchPrediction</code>. </p>"""
    input_data_location_s3: NotRequired["capo_machine_learning.types.s3_url.S3Url"]
    """<p>The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).</p>"""
    created_by_iam_user: NotRequired[
        "capo_machine_learning.types.aws_user_arn.AwsUserArn"
    ]
    """<p>The AWS user account that invoked the <code>BatchPrediction</code>. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.</p>"""
    created_at: NotRequired["capo_machine_learning.types.epoch_time.EpochTime"]
    """<p>The time when the <code>BatchPrediction</code> was created. The time is expressed in epoch time.</p>"""
    last_updated_at: NotRequired["capo_machine_learning.types.epoch_time.EpochTime"]
    """<p>The time of the most recent edit to <code>BatchPrediction</code>. The time is expressed in epoch time.</p>"""
    name: NotRequired["capo_machine_learning.types.entity_name.EntityName"]
    """<p>A user-supplied name or description of the <code>BatchPrediction</code>.</p>"""
    status: NotRequired["capo_machine_learning.types.entity_status.EntityStatus"]
    """<p>The status of the <code>BatchPrediction</code>, which can be one of the following values:</p> <ul> <li> <p> <code>PENDING</code> - Amazon Machine Learning (Amazon ML) submitted a request to generate batch predictions.</p> </li> <li> <p> <code>INPROGRESS</code> - The batch predictions are in progress.</p> </li> <li> <p> <code>FAILED</code> - The request to perform a batch prediction did not run to completion. It is not usable.</p> </li> <li> <p> <code>COMPLETED</code> - The batch prediction process completed successfully.</p> </li> <li> <p> <code>DELETED</code> - The <code>BatchPrediction</code> is marked as deleted. It is not usable.</p> </li> </ul>"""
    output_uri: NotRequired["capo_machine_learning.types.s3_url.S3Url"]
    """<p>The location of an Amazon S3 bucket or directory to receive the operation results.</p>"""
    log_uri: NotRequired["capo_machine_learning.types.presigned_s3_url.PresignedS3Url"]
    """<p>A link to the file that contains logs of the <code>CreateBatchPrediction</code> operation.</p>"""
    message: NotRequired["capo_machine_learning.types.message.Message"]
    """<p>A description of the most recent details about processing the batch prediction request.</p>"""
    compute_time: NotRequired["capo_machine_learning.types.long_type.LongType"]
    """<p>The approximate CPU time in milliseconds that Amazon Machine Learning spent processing the <code>BatchPrediction</code>, normalized and scaled on computation resources. <code>ComputeTime</code> is only available if the <code>BatchPrediction</code> is in the <code>COMPLETED</code> state.</p>"""
    finished_at: NotRequired["capo_machine_learning.types.epoch_time.EpochTime"]
    """<p>The epoch time when Amazon Machine Learning marked the <code>BatchPrediction</code> as <code>COMPLETED</code> or <code>FAILED</code>. <code>FinishedAt</code> is only available when the <code>BatchPrediction</code> is in the <code>COMPLETED</code> or <code>FAILED</code> state.</p>"""
    started_at: NotRequired["capo_machine_learning.types.epoch_time.EpochTime"]
    """<p>The epoch time when Amazon Machine Learning marked the <code>BatchPrediction</code> as <code>INPROGRESS</code>. <code>StartedAt</code> isn't available if the <code>BatchPrediction</code> is in the <code>PENDING</code> state.</p>"""
    total_record_count: NotRequired["capo_machine_learning.types.long_type.LongType"]
    """<p>The number of total records that Amazon Machine Learning saw while processing the <code>BatchPrediction</code>.</p>"""
    invalid_record_count: NotRequired["capo_machine_learning.types.long_type.LongType"]
    """<p>The number of invalid records that Amazon Machine Learning saw while processing the <code>BatchPrediction</code>.</p>"""

batch_prediction_data_source_id instance-attribute

batch_prediction_data_source_id: NotRequired[EntityId]

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

batch_prediction_id instance-attribute

batch_prediction_id: NotRequired[EntityId]

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

compute_time instance-attribute

compute_time: NotRequired[LongType]

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.

created_at instance-attribute

created_at: NotRequired[EpochTime]

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

created_by_iam_user instance-attribute

created_by_iam_user: NotRequired[AwsUserArn]

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.

finished_at instance-attribute

finished_at: NotRequired[EpochTime]

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.

input_data_location_s3 instance-attribute

input_data_location_s3: NotRequired[S3Url]

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

invalid_record_count instance-attribute

invalid_record_count: NotRequired[LongType]

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

last_updated_at instance-attribute

last_updated_at: NotRequired[EpochTime]

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

log_uri instance-attribute

log_uri: NotRequired[PresignedS3Url]

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

message instance-attribute

message: NotRequired[Message]

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

ml_model_id instance-attribute

ml_model_id: NotRequired[EntityId]

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

name instance-attribute

name: NotRequired[EntityName]

A user-supplied name or description of the BatchPrediction.

output_uri instance-attribute

output_uri: NotRequired[S3Url]

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

started_at instance-attribute

started_at: NotRequired[EpochTime]

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

status instance-attribute

status: NotRequired[EntityStatus]

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.

total_record_count instance-attribute

total_record_count: NotRequired[LongType]

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