Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors Examples See Also

ListModelCopyJobs

Returns a list of model copy jobs that you have submitted. You can filter the jobs to return based on one or more criteria. For more information, see Copy models to be used in other regions in the Amazon Bedrock User Guide.

Request Syntax


GET /model-copy-jobs?creationTimeAfter=creationTimeAfter&creationTimeBefore=creationTimeBefore&maxResults=maxResults&nextToken=nextToken&outputModelNameContains=targetModelNameContains&sortBy=sortBy&sortOrder=sortOrder&sourceAccountEquals=sourceAccountEquals&sourceModelArnEquals=sourceModelArnEquals&statusEquals=statusEquals HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

creationTimeAfter

Filters for model copy jobs created after the specified time.

creationTimeBefore

Filters for model copy jobs created before the specified time.

maxResults

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

Valid Range: Minimum value of 1. Maximum value of 1000.

nextToken

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: ^\S*$

sortBy

The field to sort by in the returned list of model copy jobs.

Valid Values: CreationTime

sortOrder

Specifies whether to sort the results in ascending or descending order.

Valid Values: Ascending | Descending

sourceAccountEquals

Filters for model copy jobs in which the account that the source model belongs to is equal to the value that you specify.

Pattern: ^[0-9]{12}$

sourceModelArnEquals

Filters for model copy jobs in which the Amazon Resource Name (ARN) of the source model to is equal to the value that you specify.

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}))$

statusEquals

Filters for model copy jobs whose status matches the value that you specify.

Valid Values: InProgress | Completed | Failed

targetModelNameContains

Filters for model copy jobs in which the name of the copied model contains the string that you specify.

Length Constraints: Minimum length of 1. Maximum length of 63.

Pattern: ^([0-9a-zA-Z][_-]?){1,63}$

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "modelCopyJobSummaries": [ 
      { 
         "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"
            }
         ]
      }
   ],
   "nextToken": "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.

modelCopyJobSummaries

A list of information about each model copy job.

Type: Array of ModelCopyJobSummary objects

nextToken

If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: ^\S*$

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

List model copy jobs (CLI)

The following example shows how to return information about ten model copy jobs in an account, using the AWS CLI.


aws bedrock list-model-copy-jobs --max-results 10