CreateInferenceProfileCommand

Suggest an Edit

Creates an application inference profile to track metrics and costs when invoking a model. To create an application inference profile for a foundation model in one region, specify the ARN of the model in that region. To create an application inference profile for a foundation model across multiple regions, specify the ARN of the system-defined inference profile that contains the regions that you want to route requests to. For more information, see Increase throughput and resilience with cross-region inference in Amazon Bedrock . 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, CreateInferenceProfileCommand } from "@aws-sdk/client-bedrock"; // ES Modules import
// const { BedrockClient, CreateInferenceProfileCommand } = require("@aws-sdk/client-bedrock"); // CommonJS import
const client = new BedrockClient(config);
const input = { // CreateInferenceProfileRequest
  inferenceProfileName: "STRING_VALUE", // required
  description: "STRING_VALUE",
  clientRequestToken: "STRING_VALUE",
  modelSource: { // InferenceProfileModelSource Union: only one key present
    copyFrom: "STRING_VALUE",
  },
  tags: [ // TagList
    { // Tag
      key: "STRING_VALUE", // required
      value: "STRING_VALUE", // required
    },
  ],
};
const command = new CreateInferenceProfileCommand(input);
const response = await client.send(command);
// { // CreateInferenceProfileResponse
//   inferenceProfileArn: "STRING_VALUE", // required
//   status: "ACTIVE",
// };

CreateInferenceProfileCommand Input

See CreateInferenceProfileCommandInput for more details

Parameter
Type
Description
inferenceProfileName
Required
string | undefined

A name for the inference profile.

modelSource
Required
InferenceProfileModelSource | undefined

The foundation model or system-defined inference profile that the inference profile will track metrics and costs for.

clientRequestToken
string | undefined

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency .

description
string | undefined

A description for the inference profile.

tags
Tag[] | undefined

An array of objects, each of which contains a tag and its value. For more information, see Tagging resources  in the Amazon Bedrock User Guide .

CreateInferenceProfileCommand Output

See CreateInferenceProfileCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
inferenceProfileArn
Required
string | undefined

The ARN of the inference profile that you created.

status
InferenceProfileStatus | undefined

The status of the inference profile. ACTIVE means that the inference profile is ready to be used.

Throws

Name
Fault
Details
AccessDeniedException
client

The request is denied because of missing access permissions.

ConflictException
client

Error occurred because of a conflict while performing an operation.

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.

ServiceQuotaExceededException
client

The number of requests exceeds the service quota. Resubmit your request later.

ThrottlingException
client

The number of requests exceeds the limit. Resubmit your request later.

TooManyTagsException
client

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.

ValidationException
client

Input validation failed. Check your request parameters and retry the request.

BedrockServiceException
Base exception class for all service exceptions from Bedrock service.