GetModelImportJob
Retrieves the properties associated with import model job, including the status of the job. For more information, see Import a customized model in the Amazon Bedrock User Guide.
Request Syntax
GET /model-import-jobs/jobIdentifier HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- jobIdentifier
-
The identifier of the import job.
Length Constraints: Minimum length of 0. Maximum length of 1011.
Pattern:
^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-import-job/[a-z0-9]{12})|([a-zA-Z0-9](-*[a-zA-Z0-9\+\-\.])*)$Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"creationTime": "string",
"endTime": "string",
"failureMessage": "string",
"importedModelArn": "string",
"importedModelKmsKeyArn": "string",
"importedModelName": "string",
"jobArn": "string",
"jobName": "string",
"lastModifiedTime": "string",
"modelDataSource": { ... },
"roleArn": "string",
"status": "string",
"vpcConfig": {
"securityGroupIds": [ "string" ],
"subnetIds": [ "string" ]
}
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- creationTime
-
The time the resource was created.
Type: Timestamp
- endTime
-
Time that the resource transitioned to terminal state.
Type: Timestamp
- failureMessage
-
Information about why the import job failed.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
- importedModelArn
-
The Amazon Resource Name (ARN) of the imported model.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 1011.
Pattern:
^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:imported-model/[a-z0-9]{12}$ - importedModelKmsKeyArn
-
The imported model is encrypted at rest using this key.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^arn:aws(-[^:]+)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$ - importedModelName
-
The name of the imported model.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
^([0-9a-zA-Z][_-]?)+$ - jobArn
-
The Amazon Resource Name (ARN) of the import job.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1011.
Pattern:
^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-import-job/[a-z0-9]{12}$ - jobName
-
The name of the import job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
^[a-zA-Z0-9](-*[a-zA-Z0-9\+\-\.])*$ - lastModifiedTime
-
Time the resource was last modified.
Type: Timestamp
- modelDataSource
-
The data source for the imported model.
Type: ModelDataSource object
Note: This object is a Union. Only one member of this object can be specified or returned.
- roleArn
-
The Amazon Resource Name (ARN) of the IAM role associated with this job.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern:
^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+$ - status
-
The status of the job. A successful job transitions from in-progress to completed when the imported model is ready to use. If the job failed, the failure message contains information about why the job failed.
Type: String
Valid Values:
InProgress | Completed | Failed - vpcConfig
-
The Virtual Private Cloud (VPC) configuration of the import model job.
Type: VpcConfig object
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
The request is denied because of missing access permissions.
HTTP Status Code: 403
- InternalServerException
-
An internal server error occurred. Retry your request.
HTTP Status Code: 500
- ResourceNotFoundException
-
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
- ThrottlingException
-
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
- ValidationException
-
Input validation failed. Check your request parameters and retry the request.
HTTP Status Code: 400
Examples
Get model import job
Gets the properties of a model import job.
GET /model-import-jobs/{jobIdentifier} HTTP/1.1 Content-type: application/json
Example response
Response for the above request.
HTTP/1.1 200 Content-type: application/json { "jobArn": "arn:aws:bedrock:us-east-1:111122223333:model-import-job/yggb47n4xlml", "jobName": "MyImportedModelJobName", "importedModelName": "ImportedModelName", "roleArn": "arn:aws:iam::111122223333:role/Role_Name", "modelDataSource": { "s3DataSource": { "s3Uri": "S3://amzn-s3-demo-bucket/key-name" } }, "status": "InProgress", "creationTime": "2024-08-13T23:38:42.457Z", "lastModifiedTime": "2024-08-13T23:39:25.158Z" }
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
