inference_profiles

Creates, updates, deletes, gets or lists an inference_profiles resource.

Overview

Name	inference_profiles
Type	Resource
Id	aws.bedrock.inference_profiles

Fields

The following fields are returned by SELECT queries:

get_inference_profile

Name	Datatype	Description
created_at	string (date-time)	The time at which the inference profile was created.
description	string	The description of the inference profile. (pattern: <code>([0-9a-zA-Z:.][ _-]?)+</code>)
inference_profile_arn	string	The Amazon Resource Name (ARN) of the inference profile. (pattern: <code>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-:.]+</code>)
inference_profile_id	string	The unique identifier of the inference profile. (pattern: <code>[a-zA-Z0-9-:.]+</code>)
inference_profile_name	string	The name of the inference profile. (pattern: <code>([0-9a-zA-Z][ _-]?)+</code>)
models	array	A list of information about each model in the inference profile.
status	string	The status of the inference profile. ACTIVE means that the inference profile is ready to be used. (ACTIVE)
type_	string	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. (SYSTEM_DEFINED, APPLICATION)
updated_at	string (date-time)	The time at which the inference profile was last updated.

list_inference_profiles

Name	Datatype	Description
created_at	string (date-time)	The time at which the inference profile was created.
description	string	The description of the inference profile. (pattern: <code>([0-9a-zA-Z:.][ _-]?)+</code>)
inference_profile_arn	string	The Amazon Resource Name (ARN) of the inference profile. (pattern: <code>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-:.]+</code>)
inference_profile_id	string	The unique identifier of the inference profile. (pattern: <code>[a-zA-Z0-9-:.]+</code>)
inference_profile_name	string	The name of the inference profile. (pattern: <code>([0-9a-zA-Z][ _-]?)+</code>)
models	array	A list of information about each model in the inference profile.
status	string	The status of the inference profile. ACTIVE means that the inference profile is ready to be used. (ACTIVE)
type_	string	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. (SYSTEM_DEFINED, APPLICATION)
updated_at	string (date-time)	The time at which the inference profile was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_inference_profile	select	inference_profile_identifier, region		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.
list_inference_profiles	select	region	maxResults, nextToken, type	Returns a list of inference profiles that you can use. For more information, see Increase throughput and resilience with cross-region inference in Amazon Bedrock. in the Amazon Bedrock User Guide.
create_inference_profile	insert	region, inferenceProfileName, modelSource		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.
delete_inference_profile	delete	inference_profile_identifier, region		Deletes an application inference profile. For more information, see Increase throughput and resilience with cross-region inference in Amazon Bedrock. in the Amazon Bedrock User Guide.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
inference_profile_identifier	string	The Amazon Resource Name (ARN) or ID of the application inference profile to delete.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
nextToken	string	If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
type	string	Filters for inference profiles that match the type you specify. 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.

SELECT examples

get_inference_profile

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.

SELECT
created_at,
description,
inference_profile_arn,
inference_profile_id,
inference_profile_name,
models,
status,
type_,
updated_at
FROM aws.bedrock.inference_profiles
WHERE inference_profile_identifier = '{{ inference_profile_identifier }}' -- required
AND region = '{{ region }}' -- required
;

list_inference_profiles

Returns a list of inference profiles that you can use. For more information, see Increase throughput and resilience with cross-region inference in Amazon Bedrock. in the Amazon Bedrock User Guide.

SELECT
created_at,
description,
inference_profile_arn,
inference_profile_id,
inference_profile_name,
models,
status,
type_,
updated_at
FROM aws.bedrock.inference_profiles
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
AND type = '{{ type }}'
;

INSERT examples

create_inference_profile

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.

INSERT INTO aws.bedrock.inference_profiles (
inferenceProfileName,
description,
clientRequestToken,
modelSource,
tags,
region
)
SELECT 
'{{ inferenceProfileName }}' /* required */,
'{{ description }}',
'{{ clientRequestToken }}',
'{{ modelSource }}' /* required */,
'{{ tags }}',
'{{ region }}'
RETURNING
inference_profile_arn,
status
;

Manifest

# Description fields are for documentation purposes
- name: inference_profiles
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the inference_profiles resource.
  - name: inferenceProfileName
    value: "{{ inferenceProfileName }}"
  - name: description
    value: "{{ description }}"
  - name: clientRequestToken
    value: "{{ clientRequestToken }}"
  - name: modelSource
    description: |
      Contains information about the model or system-defined inference profile that is the source for an inference profile..
    value:
      copyFrom: "{{ copyFrom }}"
  - name: tags
    value:
      - key: "{{ key }}"
        value: "{{ value }}"

DELETE examples

delete_inference_profile

Deletes an application inference profile. For more information, see Increase throughput and resilience with cross-region inference in Amazon Bedrock. in the Amazon Bedrock User Guide.

DELETE FROM aws.bedrock.inference_profiles
WHERE inference_profile_identifier = '{{ inference_profile_identifier }}' --required
AND region = '{{ region }}' --required
;