get_model_invocation_job¶
Operation¶
async
¶
get_model_invocation_job(input: GetModelInvocationJobInput, plugins: list[Plugin] | None = None) -> GetModelInvocationJobOutput
Gets details about a batch inference job. For more information, see Monitor batch inference jobs
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
GetModelInvocationJobInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
GetModelInvocationJobOutput
|
An instance of |
Input¶
dataclass
¶
Output¶
dataclass
¶
Dataclass for GetModelInvocationJobOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
client_request_token: str | None = None
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 Ensuring idempotency.
class-attribute
instance-attribute
¶
end_time: datetime | None = None
The time at which the batch inference job ended.
class-attribute
instance-attribute
¶
error_record_count: int | None = None
The number of records that failed to process in the batch inference job.
instance-attribute
¶
input_data_config: ModelInvocationJobInputDataConfig
Details about the location of the input to the batch inference job.
instance-attribute
¶
job_arn: str
The Amazon Resource Name (ARN) of the batch inference job.
class-attribute
instance-attribute
¶
job_expiration_time: datetime | None = None
The time at which the batch inference job times or timed out.
class-attribute
instance-attribute
¶
job_name: str | None = None
The name of the batch inference job.
class-attribute
instance-attribute
¶
last_modified_time: datetime | None = None
The time at which the batch inference job was last modified.
class-attribute
instance-attribute
¶
message: str | None = field(repr=False, default=None)
If the batch inference job failed, this field contains a message describing why the job failed.
instance-attribute
¶
model_id: str
The unique identifier of the foundation model used for model inference.
class-attribute
instance-attribute
¶
model_invocation_type: ModelInvocationType | None = None
The invocation endpoint for ModelInvocationJob
instance-attribute
¶
output_data_config: ModelInvocationJobOutputDataConfig
Details about the location of the output of the batch inference job.
class-attribute
instance-attribute
¶
processed_record_count: int | None = None
The number of records that have been processed in the batch inference job.
instance-attribute
¶
role_arn: str
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 Create a service role for batch inference.
class-attribute
instance-attribute
¶
status: ModelInvocationJobStatus | None = None
The status of the batch inference job.
The following statuses are possible:
-
Submitted -- This job has been submitted to a queue for validation.
-
Validating -- This job is being validated for the requirements described in Format and upload your batch inference data. The criteria include the following:
-
Your IAM service role has access to the Amazon S3 buckets containing your files.
-
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
modelInputvalue matches the request body for the model. -
Your files fulfill the requirements for file size and number of records. For more information, see Quotas for Amazon Bedrock.
-
Scheduled -- This job has been validated and is now in a queue. The job will automatically start when it reaches its turn.
-
Expired -- This job timed out because it was scheduled but didn't begin before the set timeout duration. Submit a new job request.
-
InProgress -- This job has begun. You can start viewing the results in the output S3 location.
-
Completed -- This job has successfully completed. View the output files in the output S3 location.
-
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.
-
Failed -- This job has failed. Check the failure message for any further details. For further assistance, reach out to the Amazon Web Services Support Center.
-
Stopped -- This job was stopped by a user.
-
Stopping -- This job is being stopped by a user.
instance-attribute
¶
submit_time: datetime
The time at which the batch inference job was submitted.
class-attribute
instance-attribute
¶
success_record_count: int | None = None
The number of records that were successfully processed in the batch inference job.
class-attribute
instance-attribute
¶
timeout_duration_in_hours: int | None = None
The number of hours after which batch inference job was set to time out.
class-attribute
instance-attribute
¶
total_record_count: int | None = None
The total number of records in the batch inference job.
class-attribute
instance-attribute
¶
vpc_config: VpcConfig | None = None
The configuration of the Virtual Private Cloud (VPC) for the data in the batch inference job. For more information, see Protect batch inference jobs using a VPC.