GetModelCopyJob
Retrieves information about a model copy job. For more information, see Copy models to be used in other regions in the Amazon Bedrock User Guide.
Request Syntax
GET /model-copy-jobs/jobArn HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- jobArn
-
The Amazon Resource Name (ARN) of the model copy job.
Length Constraints: Minimum length of 0. Maximum length of 1011.
Pattern:
^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-copy-job/[a-z0-9]{12}$Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"creationTime": "string",
"failureMessage": "string",
"jobArn": "string",
"sourceAccountId": "string",
"sourceModelArn": "string",
"sourceModelName": "string",
"status": "string",
"targetModelArn": "string",
"targetModelKmsKeyArn": "string",
"targetModelName": "string",
"targetModelTags": [
{
"key": "string",
"value": "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 at which the model copy job was created.
Type: Timestamp
- failureMessage
-
An error message for why the model copy job failed.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
- jobArn
-
The Amazon Resource Name (ARN) of the model copy 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-copy-job/[a-z0-9]{12}$ - sourceAccountId
-
The unique identifier of the account that the model being copied originated from.
Type: String
Pattern:
^[0-9]{12}$ - sourceModelArn
-
The Amazon Resource Name (ARN) of the original model being copied.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 1011.
Pattern:
^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}))$ - sourceModelName
-
The name of the original model being copied.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
^([0-9a-zA-Z][_-]?){1,63}$ - status
-
The status of the model copy job.
Type: String
Valid Values:
InProgress | Completed | Failed - targetModelArn
-
The Amazon Resource Name (ARN) of the copied 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}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}/[a-z0-9]{12}$ - targetModelKmsKeyArn
-
The Amazon Resource Name (ARN) of the KMS key encrypting the copied model.
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}$ - targetModelName
-
The name of the copied model.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
^([0-9a-zA-Z][_-]?){1,63}$ - targetModelTags
-
The tags associated with the copied model.
Type: Array of Tag objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
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 a model copy job (CLI)
The following example shows how to get information about a model copy job using the AWS CLI.
aws bedrock get-model-copy-job --job-arn arn:aws:bedrock:us-east-1:123456789012:model-copy-job/amazon.titan-text-lite-v1:0:4k/abcdef123456
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
