- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
GetModelCopyJobCommand
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 .
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { BedrockClient, GetModelCopyJobCommand } from "@aws-sdk/client-bedrock"; // ES Modules import
// const { BedrockClient, GetModelCopyJobCommand } = require("@aws-sdk/client-bedrock"); // CommonJS import
const client = new BedrockClient(config);
const input = { // GetModelCopyJobRequest
jobArn: "STRING_VALUE", // required
};
const command = new GetModelCopyJobCommand(input);
const response = await client.send(command);
// { // GetModelCopyJobResponse
// jobArn: "STRING_VALUE", // required
// status: "InProgress" || "Completed" || "Failed", // required
// creationTime: new Date("TIMESTAMP"), // required
// targetModelArn: "STRING_VALUE", // required
// targetModelName: "STRING_VALUE",
// sourceAccountId: "STRING_VALUE", // required
// sourceModelArn: "STRING_VALUE", // required
// targetModelKmsKeyArn: "STRING_VALUE",
// targetModelTags: [ // TagList
// { // Tag
// key: "STRING_VALUE", // required
// value: "STRING_VALUE", // required
// },
// ],
// failureMessage: "STRING_VALUE",
// sourceModelName: "STRING_VALUE",
// };
GetModelCopyJobCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
jobArn Required | string | undefined | The Amazon Resource Name (ARN) of the model copy job. |
GetModelCopyJobCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
creationTime Required | Date | undefined | The time at which the model copy job was created. |
jobArn Required | string | undefined | The Amazon Resource Name (ARN) of the model copy job. |
sourceAccountId Required | string | undefined | The unique identifier of the account that the model being copied originated from. |
sourceModelArn Required | string | undefined | The Amazon Resource Name (ARN) of the original model being copied. |
status Required | ModelCopyJobStatus | undefined | The status of the model copy job. |
targetModelArn Required | string | undefined | The Amazon Resource Name (ARN) of the copied model. |
failureMessage | string | undefined | An error message for why the model copy job failed. |
sourceModelName | string | undefined | The name of the original model being copied. |
targetModelKmsKeyArn | string | undefined | The Amazon Resource Name (ARN) of the KMS key encrypting the copied model. |
targetModelName | string | undefined | The name of the copied model. |
targetModelTags | Tag[] | undefined | The tags associated with the copied model. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
AccessDeniedException | client | The request is denied because of missing access permissions. |
InternalServerException | server | An internal server error occurred. Retry your request. |
ResourceNotFoundException | client | The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. |
ThrottlingException | client | The number of requests exceeds the limit. Resubmit your request later. |
ValidationException | client | Input validation failed. Check your request parameters and retry the request. |
BedrockServiceException | Base exception class for all service exceptions from Bedrock service. |