Creates a model import job to import model that you have customized in other environments, such as Amazon SageMaker. For more information, see Import a customized model
Request SyntaxPOST /model-import-jobs HTTP/1.1
Content-type: application/json
{
"clientRequestToken": "string
",
"importedModelKmsKeyId": "string
",
"importedModelName": "string
",
"importedModelTags": [
{
"key": "string
",
"value": "string
"
}
],
"jobName": "string
",
"jobTags": [
{
"key": "string
",
"value": "string
"
}
],
"modelDataSource": { ... },
"roleArn": "string
",
"vpcConfig": {
"securityGroupIds": [ "string
" ],
"subnetIds": [ "string
" ]
}
}
URI Request Parameters
The request does not use any URI parameters.
Request BodyThe request accepts the following data in JSON format.
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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [a-zA-Z0-9](-*[a-zA-Z0-9])*
Required: No
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})|(alias/[a-zA-Z0-9-_/]+)))|([a-zA-Z0-9-]{36})|(alias/[a-zA-Z0-9-_/]+)
Required: No
The name of the imported model.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: ([0-9a-zA-Z][_-]?)+
Required: Yes
Tags to attach to the imported model.
Type: Array of Tag objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No
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\+\-\.])*
Required: Yes
Tags to attach to this import job.
Type: Array of Tag objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No
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.
Required: Yes
The Amazon Resource Name (ARN) of the service role with the proper custom model import permissions. You can use the console to automatically create a service role with the proper permissions or create a custom service role. For more information about creating a custom service role, see Create a service role for model import.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+
Required: Yes
VPC configuration parameters for the private Virtual Private Cloud (VPC) that contains the resources you are using for the import job.
Type: VpcConfig object
Required: No
HTTP/1.1 201
Content-type: application/json
{
"jobArn": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 201 response.
The following data is returned in JSON format by the service.
The Amazon Resource Name (ARN) of the model 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}
For information about the errors that are common to all actions, see Common Errors.
The request is denied because of missing access permissions.
HTTP Status Code: 403
Error occurred because of a conflict while performing an operation.
HTTP Status Code: 400
An internal server error occurred. Retry your request.
HTTP Status Code: 500
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
The number of requests exceeds the service quota. Resubmit your request later.
HTTP Status Code: 400
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
HTTP Status Code: 400
Input validation failed. Check your request parameters and retry the request.
HTTP Status Code: 400
Creates a model import job.
POST /model-import-jobs/ HTTP/1.1
Content-type: application/json
{
"importedModelName": "ImportedModelName",
"jobName": "MyImportedModelJobName",
"modelDataSource": {
"s3DataSource": {
"s3Uri": "S3://amzn-s3-demo-bucket/key-name"
}
},
"roleArn": "arn:aws:iam::111122223333:role/Role_Name"
}
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"
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4