GetInferenceProfile - Amazon Bedrock (original) (raw)
Gets information about an inference profile. For more information, see Increase throughput and resilience with cross-region inference in Amazon Bedrock. in the Amazon Bedrock User Guide.
Request Syntax
GET /inference-profiles/inferenceProfileIdentifier HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
The ID or Amazon Resource Name (ARN) of the inference profile.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: (arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:(|[0-9a-z-]{0,20}):(|[0-9]{12}):(inference-profile|application-inference-profile)/)?[a-zA-Z0-9-:.]+
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"createdAt": "string",
"description": "string",
"inferenceProfileArn": "string",
"inferenceProfileId": "string",
"inferenceProfileName": "string",
"models": [
{
"modelArn": "string"
}
],
"status": "string",
"type": "string",
"updatedAt": "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.
The time at which the inference profile was created.
Type: Timestamp
The description of the inference profile.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern: ([0-9a-zA-Z:.][ _-]?)+
The Amazon Resource Name (ARN) of the inference profile.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:(|[0-9a-z-]{0,20}):(|[0-9]{12}):(inference-profile|application-inference-profile)/[a-zA-Z0-9-:.]+
The unique identifier of the inference profile.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: [a-zA-Z0-9-:.]+
The name of the inference profile.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: ([0-9a-zA-Z][ _-]?)+
A list of information about each model in the inference profile.
Type: Array of InferenceProfileModel objects
Array Members: Minimum number of 1 item. Maximum number of 5 items.
The status of the inference profile. ACTIVE means that the inference profile is ready to be used.
Type: String
Valid Values: ACTIVE
The type of the inference profile. The following types are possible:
SYSTEM_DEFINED– The inference profile is defined by Amazon Bedrock. You can route inference requests across regions with these inference profiles.APPLICATION– The inference profile was created by a user. This type of inference profile can track metrics and costs when invoking the model in it. The inference profile may route requests to one or multiple regions.
Type: String
Valid Values: SYSTEM_DEFINED | APPLICATION
The time at which the inference profile was last updated.
Type: Timestamp
Errors
For information about the errors that are common to all actions, see Common Error Types.
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
Get information about an inference profile
Run the following example to get information about the US Anthropic Claude 3 Sonnet inference profile:
Sample Request
GET /inference-profiles/us.anthropic.claude-3-sonnet-20240229-v1:0 HTTP/1.1See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: