- 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.
CreateConfiguredModelAlgorithmCommand
Creates a configured model algorithm using a container image stored in an ECR repository.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { CleanRoomsMLClient, CreateConfiguredModelAlgorithmCommand } from "@aws-sdk/client-cleanroomsml"; // ES Modules import
// const { CleanRoomsMLClient, CreateConfiguredModelAlgorithmCommand } = require("@aws-sdk/client-cleanroomsml"); // CommonJS import
const client = new CleanRoomsMLClient(config);
const input = { // CreateConfiguredModelAlgorithmRequest
name: "STRING_VALUE", // required
description: "STRING_VALUE",
roleArn: "STRING_VALUE", // required
trainingContainerConfig: { // ContainerConfig
imageUri: "STRING_VALUE", // required
entrypoint: [ // ContainerEntrypoint
"STRING_VALUE",
],
arguments: [ // ContainerArguments
"STRING_VALUE",
],
metricDefinitions: [ // MetricDefinitionList
{ // MetricDefinition
name: "STRING_VALUE", // required
regex: "STRING_VALUE", // required
},
],
},
inferenceContainerConfig: { // InferenceContainerConfig
imageUri: "STRING_VALUE", // required
},
tags: { // TagMap
"<keys>": "STRING_VALUE",
},
kmsKeyArn: "STRING_VALUE",
};
const command = new CreateConfiguredModelAlgorithmCommand(input);
const response = await client.send(command);
// { // CreateConfiguredModelAlgorithmResponse
// configuredModelAlgorithmArn: "STRING_VALUE", // required
// };
CreateConfiguredModelAlgorithmCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
name Required | string | undefined | The name of the configured model algorithm. |
roleArn Required | string | undefined | The Amazon Resource Name (ARN) of the role that is used to access the repository. |
description | string | undefined | The description of the configured model algorithm. |
inferenceContainerConfig | InferenceContainerConfig | undefined | Configuration information for the inference container that is used when you run an inference job on a configured model algorithm. |
kmsKeyArn | string | undefined | The Amazon Resource Name (ARN) of the KMS key. This key is used to encrypt and decrypt customer-owned data in the configured ML model algorithm and associated data. |
tags | Record<string, string> | undefined | The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. The following basic restrictions apply to tags:
|
trainingContainerConfig | ContainerConfig | undefined | Configuration information for the training container, including entrypoints and arguments. |
CreateConfiguredModelAlgorithmCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
configuredModelAlgorithmArn Required | string | undefined | The Amazon Resource Name (ARN) of the configured model algorithm. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
AccessDeniedException | client | You do not have sufficient access to perform this action. |
ConflictException | client | You can't complete this action because another resource depends on this resource. |
ServiceQuotaExceededException | client | You have exceeded your service quota. |
ValidationException | client | The request parameters for this request are incorrect. |
CleanRoomsMLServiceException | Base exception class for all service exceptions from CleanRoomsML service. |