|
| 1 | +// smithy-typescript generated code |
| 2 | +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; |
| 3 | +import { getSerdePlugin } from "@smithy/middleware-serde"; |
| 4 | +import { Command as $Command } from "@smithy/smithy-client"; |
| 5 | +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; |
| 6 | + |
| 7 | +import { BedrockClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockClient"; |
| 8 | +import { commonParams } from "../endpoint/EndpointParameters"; |
| 9 | +import { CreateCustomModelRequest, CreateCustomModelResponse } from "../models/models_0"; |
| 10 | +import { de_CreateCustomModelCommand, se_CreateCustomModelCommand } from "../protocols/Aws_restJson1"; |
| 11 | + |
| 12 | +/** |
| 13 | + * @public |
| 14 | + */ |
| 15 | +export type { __MetadataBearer }; |
| 16 | +export { $Command }; |
| 17 | +/** |
| 18 | + * @public |
| 19 | + * |
| 20 | + * The input for {@link CreateCustomModelCommand}. |
| 21 | + */ |
| 22 | +export interface CreateCustomModelCommandInput extends CreateCustomModelRequest {} |
| 23 | +/** |
| 24 | + * @public |
| 25 | + * |
| 26 | + * The output of {@link CreateCustomModelCommand}. |
| 27 | + */ |
| 28 | +export interface CreateCustomModelCommandOutput extends CreateCustomModelResponse, __MetadataBearer {} |
| 29 | + |
| 30 | +/** |
| 31 | + * <p>Creates a new custom model in Amazon Bedrock from an existing SageMaker AI-trained Amazon Nova model stored in an Amazon-managed Amazon S3 bucket. After the model is active, you can use it for inference.</p> <p>To use the model for inference, you must purchase Provisioned Throughput for it. You can't use On-demand inference with these custom models. For more information about Provisioned Throughput, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prov-throughput.html">Provisioned Throughput</a>.</p> <p>The model appears in <code>ListCustomModels</code> with a <code>customizationType</code> of <code>imported</code>. To track the status of the new model, you use the <code>GetCustomModel</code> API operation. The model can be in the following states:</p> <ul> <li> <p> <code>Creating</code> - Initial state during validation and registration</p> </li> <li> <p> <code>Active</code> - Model is ready for use in inference</p> </li> <li> <p> <code>Failed</code> - Creation process encountered an error</p> </li> </ul> <p>For more information about creating custom models, including specific model requirements, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/create-custom-model-from-existing.html">Import a SageMaker AI-trained Amazon Nova model</a> in the Amazon Bedrock User Guide. </p> <note> <p>You use the <code>CreateCustomModel</code> API to import only SageMaker AI-trained Amazon Nova models. To import open-source models, you use the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateModelImportJob.html">CreateModelImportJob</a>. </p> </note> <p> <b>Related APIs</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetCustomModel.html">GetCustomModel</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_ListCustomModels.html">ListCustomModels</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_DeleteCustomModel.html">DeleteCustomModel</a> </p> </li> </ul> |
| 32 | + * @example |
| 33 | + * Use a bare-bones client and the command you need to make an API call. |
| 34 | + * ```javascript |
| 35 | + * import { BedrockClient, CreateCustomModelCommand } from "@aws-sdk/client-bedrock"; // ES Modules import |
| 36 | + * // const { BedrockClient, CreateCustomModelCommand } = require("@aws-sdk/client-bedrock"); // CommonJS import |
| 37 | + * const client = new BedrockClient(config); |
| 38 | + * const input = { // CreateCustomModelRequest |
| 39 | + * modelName: "STRING_VALUE", // required |
| 40 | + * modelSourceConfig: { // ModelDataSource Union: only one key present |
| 41 | + * s3DataSource: { // S3DataSource |
| 42 | + * s3Uri: "STRING_VALUE", // required |
| 43 | + * }, |
| 44 | + * }, |
| 45 | + * modelKmsKeyArn: "STRING_VALUE", |
| 46 | + * roleArn: "STRING_VALUE", |
| 47 | + * modelTags: [ // TagList |
| 48 | + * { // Tag |
| 49 | + * key: "STRING_VALUE", // required |
| 50 | + * value: "STRING_VALUE", // required |
| 51 | + * }, |
| 52 | + * ], |
| 53 | + * clientRequestToken: "STRING_VALUE", |
| 54 | + * }; |
| 55 | + * const command = new CreateCustomModelCommand(input); |
| 56 | + * const response = await client.send(command); |
| 57 | + * // { // CreateCustomModelResponse |
| 58 | + * // modelArn: "STRING_VALUE", // required |
| 59 | + * // }; |
| 60 | + * |
| 61 | + * ``` |
| 62 | + * |
| 63 | + * @param CreateCustomModelCommandInput - {@link CreateCustomModelCommandInput} |
| 64 | + * @returns {@link CreateCustomModelCommandOutput} |
| 65 | + * @see {@link CreateCustomModelCommandInput} for command's `input` shape. |
| 66 | + * @see {@link CreateCustomModelCommandOutput} for command's `response` shape. |
| 67 | + * @see {@link BedrockClientResolvedConfig | config} for BedrockClient's `config` shape. |
| 68 | + * |
| 69 | + * @throws {@link AccessDeniedException} (client fault) |
| 70 | + * <p>The request is denied because of missing access permissions.</p> |
| 71 | + * |
| 72 | + * @throws {@link ConflictException} (client fault) |
| 73 | + * <p>Error occurred because of a conflict while performing an operation.</p> |
| 74 | + * |
| 75 | + * @throws {@link InternalServerException} (server fault) |
| 76 | + * <p>An internal server error occurred. Retry your request.</p> |
| 77 | + * |
| 78 | + * @throws {@link ResourceNotFoundException} (client fault) |
| 79 | + * <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p> |
| 80 | + * |
| 81 | + * @throws {@link ServiceQuotaExceededException} (client fault) |
| 82 | + * <p>The number of requests exceeds the service quota. Resubmit your request later.</p> |
| 83 | + * |
| 84 | + * @throws {@link ThrottlingException} (client fault) |
| 85 | + * <p>The number of requests exceeds the limit. Resubmit your request later.</p> |
| 86 | + * |
| 87 | + * @throws {@link TooManyTagsException} (client fault) |
| 88 | + * <p>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. </p> |
| 89 | + * |
| 90 | + * @throws {@link ValidationException} (client fault) |
| 91 | + * <p>Input validation failed. Check your request parameters and retry the request.</p> |
| 92 | + * |
| 93 | + * @throws {@link BedrockServiceException} |
| 94 | + * <p>Base exception class for all service exceptions from Bedrock service.</p> |
| 95 | + * |
| 96 | + * |
| 97 | + * @example Successful CreateCustomModel API call |
| 98 | + * ```javascript |
| 99 | + * // |
| 100 | + * const input = { |
| 101 | + * clientRequestToken: "foo", |
| 102 | + * modelKmsKeyArn: "arn:aws:kms:us-east-1:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab", |
| 103 | + * modelName: "SampleModel", |
| 104 | + * modelSourceConfig: { |
| 105 | + * s3DataSource: { |
| 106 | + * s3Uri: "s3://my-bucket/folder" |
| 107 | + * } |
| 108 | + * }, |
| 109 | + * modelTags: [ |
| 110 | + * { |
| 111 | + * key: "foo", |
| 112 | + * value: "foo" |
| 113 | + * }, |
| 114 | + * { |
| 115 | + * key: "foo", |
| 116 | + * value: "foo" |
| 117 | + * } |
| 118 | + * ], |
| 119 | + * roleArn: "arn:aws:iam::123456789012:role/SampleRole" |
| 120 | + * }; |
| 121 | + * const command = new CreateCustomModelCommand(input); |
| 122 | + * const response = await client.send(command); |
| 123 | + * /* response is |
| 124 | + * { |
| 125 | + * modelArn: "arn:aws:bedrock:us-east-1:123456789012:custom-model/imported/abcdef123456" |
| 126 | + * } |
| 127 | + * *\/ |
| 128 | + * ``` |
| 129 | + * |
| 130 | + * @public |
| 131 | + */ |
| 132 | +export class CreateCustomModelCommand extends $Command |
| 133 | + .classBuilder< |
| 134 | + CreateCustomModelCommandInput, |
| 135 | + CreateCustomModelCommandOutput, |
| 136 | + BedrockClientResolvedConfig, |
| 137 | + ServiceInputTypes, |
| 138 | + ServiceOutputTypes |
| 139 | + >() |
| 140 | + .ep(commonParams) |
| 141 | + .m(function (this: any, Command: any, cs: any, config: BedrockClientResolvedConfig, o: any) { |
| 142 | + return [ |
| 143 | + getSerdePlugin(config, this.serialize, this.deserialize), |
| 144 | + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), |
| 145 | + ]; |
| 146 | + }) |
| 147 | + .s("AmazonBedrockControlPlaneService", "CreateCustomModel", {}) |
| 148 | + .n("BedrockClient", "CreateCustomModelCommand") |
| 149 | + .f(void 0, void 0) |
| 150 | + .ser(se_CreateCustomModelCommand) |
| 151 | + .de(de_CreateCustomModelCommand) |
| 152 | + .build() { |
| 153 | + /** @internal type navigation helper, not in runtime. */ |
| 154 | + protected declare static __types: { |
| 155 | + api: { |
| 156 | + input: CreateCustomModelRequest; |
| 157 | + output: CreateCustomModelResponse; |
| 158 | + }; |
| 159 | + sdk: { |
| 160 | + input: CreateCustomModelCommandInput; |
| 161 | + output: CreateCustomModelCommandOutput; |
| 162 | + }; |
| 163 | + }; |
| 164 | +} |
0 commit comments