ModelInvocationJobSummary ¶

class ModelInvocationJobSummary(TypedDict, closed=True):
    job_arn: "capo_bedrock.types.model_invocation_job_arn.ModelInvocationJobArn"
    """<p>The Amazon Resource Name (ARN) of the batch inference job.</p>"""
    job_name: "capo_bedrock.types.model_invocation_job_name.ModelInvocationJobName"
    """<p>The name of the batch inference job.</p>"""
    model_id: "capo_bedrock.types.model_id.ModelId"
    """<p>The unique identifier of the foundation model used for model inference.</p>"""
    client_request_token: NotRequired[
        "capo_bedrock.types.model_invocation_idempotency_token.ModelInvocationIdempotencyToken"
    ]
    """<p>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>"""
    role_arn: "capo_bedrock.types.role_arn.RoleArn"
    """<p>The Amazon Resource Name (ARN) of the service role with permissions to carry out and manage batch inference. You can use the console to create a default service role or follow the steps at <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/batch-iam-sr.html">Create a service role for batch inference</a>.</p>"""
    status: NotRequired[
        "capo_bedrock.types.model_invocation_job_status.ModelInvocationJobStatus"
    ]
    """<p>The status of the batch inference job.</p> <p>The following statuses are possible:</p> <ul> <li> <p>Submitted – This job has been submitted to a queue for validation.</p> </li> <li> <p>Validating – This job is being validated for the requirements described in <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/batch-inference-data.html">Format and upload your batch inference data</a>. The criteria include the following:</p> <ul> <li> <p>Your IAM service role has access to the Amazon S3 buckets containing your files.</p> </li> <li> <p>Your files are .jsonl files and each individual record is a JSON object in the correct format. Note that validation doesn't check if the <code>modelInput</code> value matches the request body for the model.</p> </li> <li> <p>Your files fulfill the requirements for file size and number of records. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/quotas.html">Quotas for Amazon Bedrock</a>.</p> </li> </ul> </li> <li> <p>Scheduled – This job has been validated and is now in a queue. The job will automatically start when it reaches its turn.</p> </li> <li> <p>Expired – This job timed out because it was scheduled but didn't begin before the set timeout duration. Submit a new job request.</p> </li> <li> <p>InProgress – This job has begun. You can start viewing the results in the output S3 location.</p> </li> <li> <p>Completed – This job has successfully completed. View the output files in the output S3 location.</p> </li> <li> <p>PartiallyCompleted – This job has partially completed. Not all of your records could be processed in time. View the output files in the output S3 location.</p> </li> <li> <p>Failed – This job has failed. Check the failure message for any further details. For further assistance, reach out to the <a href="https://console.aws.amazon.com/support/home/">Amazon Web Services Support Center</a>.</p> </li> <li> <p>Stopped – This job was stopped by a user.</p> </li> <li> <p>Stopping – This job is being stopped by a user.</p> </li> </ul>"""
    message: NotRequired["capo_bedrock.types.message.Message"]
    """<p>If the batch inference job failed, this field contains a message describing why the job failed.</p>"""
    submit_time: "capo_bedrock.types.timestamp.Timestamp"
    """<p>The time at which the batch inference job was submitted.</p>"""
    last_modified_time: NotRequired["capo_bedrock.types.timestamp.Timestamp"]
    """<p>The time at which the batch inference job was last modified.</p>"""
    end_time: NotRequired["capo_bedrock.types.timestamp.Timestamp"]
    """<p>The time at which the batch inference job ended.</p>"""
    input_data_config: "capo_bedrock.types.model_invocation_job_input_data_config.ModelInvocationJobInputDataConfig"
    """<p>Details about the location of the input to the batch inference job.</p>"""
    output_data_config: "capo_bedrock.types.model_invocation_job_output_data_config.ModelInvocationJobOutputDataConfig"
    """<p>Details about the location of the output of the batch inference job.</p>"""
    vpc_config: NotRequired["capo_bedrock.types.vpc_config.VpcConfig"]
    """<p>The configuration of the Virtual Private Cloud (VPC) for the data in the batch inference job. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/batch-vpc">Protect batch inference jobs using a VPC</a>.</p>"""
    timeout_duration_in_hours: NotRequired[
        "capo_bedrock.types.model_invocation_job_timeout_duration_in_hours.ModelInvocationJobTimeoutDurationInHours"
    ]
    """<p>The number of hours after which the batch inference job was set to time out.</p>"""
    job_expiration_time: NotRequired["capo_bedrock.types.timestamp.Timestamp"]
    """<p>The time at which the batch inference job times or timed out.</p>"""
    model_invocation_type: NotRequired[
        "capo_bedrock.types.model_invocation_type.ModelInvocationType"
    ]
    """<p>The invocation endpoint for ModelInvocationJob</p>"""
    total_record_count: NotRequired[
        "capo_bedrock.types.non_negative_long.NonNegativeLong"
    ]
    """<p>The total number of records in the batch inference job.</p>"""
    processed_record_count: NotRequired[
        "capo_bedrock.types.non_negative_long.NonNegativeLong"
    ]
    """<p>The number of records that have been processed in the batch inference job.</p>"""
    success_record_count: NotRequired[
        "capo_bedrock.types.non_negative_long.NonNegativeLong"
    ]
    """<p>The number of records that were successfully processed in the batch inference job.</p>"""
    error_record_count: NotRequired[
        "capo_bedrock.types.non_negative_long.NonNegativeLong"
    ]
    """<p>The number of records that failed to process in the batch inference job.</p>"""