imported_models

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

Overview

Name	imported_models
Type	Resource
Id	aws.bedrock.imported_models

Fields

The following fields are returned by SELECT queries:

get_imported_model

Name	Datatype	Description
creation_time	string (date-time)	Creation time of the imported model.
custom_model_units	object	Information about the hardware utilization for a single copy of the model.
instruct_supported	boolean	Specifies if the imported model supports converse.
job_arn	string	Job Amazon Resource Name (ARN) associated with the imported model. (pattern: <code>arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-import-job/[a-z0-9]{12}</code>)
job_name	string	Job name associated with the imported model. (pattern: <code>[a-zA-Z0-9](-[a-zA-Z0-9+-.])</code>)
model_architecture	string	The architecture of the imported model.
model_arn	string	The Amazon Resource Name (ARN) associated with this imported model. (pattern: <code>arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:imported-model/[a-z0-9]{12}</code>)
model_data_source	object	The data source of the model to import.
model_kms_key_arn	string	The imported model is encrypted at rest using this key. (pattern: <code>arn:aws(-[^:]+)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}</code>)
model_name	string	The name of the imported model. (pattern: <code>([0-9a-zA-Z][_-]?)+</code>)

list_imported_models

Name	Datatype	Description
creation_time	string (date-time)	Creation time of the imported model.
instruct_supported	boolean	Specifies if the imported model supports converse.
model_architecture	string	The architecture of the imported model.
model_arn	string	The Amazon Resource Name (ARN) of the imported model. (pattern: <code>arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:imported-model/[a-z0-9]{12}</code>)
model_name	string	Name of the imported model. (pattern: <code>([0-9a-zA-Z][_-]?)+</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_imported_model	select	model_identifier, region		Gets properties associated with a customized model you imported.
list_imported_models	select	region	creationTimeBefore, creationTimeAfter, nameContains, maxResults, nextToken, sortBy, sortOrder	Returns a list of models you've imported. You can filter the results to return based on one or more criteria. For more information, see Import a customized model in the Amazon Bedrock User Guide.
delete_imported_model	delete	model_identifier, region		Deletes a custom model that you imported earlier. For more information, see Import a customized model 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
model_identifier	string	Name of the imported model to delete.
region	string	AWS region (default: us-east-1)
creationTimeAfter	string (date-time)	Return imported models that were created after the specified time.
creationTimeBefore	string (date-time)	Return imported models that created before the specified time.
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.
nameContains	string	Return imported models only if the model name contains these characters.
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.
sortBy	string	The field to sort by in the returned list of imported models.
sortOrder	string	Specifies whetehr to sort the results in ascending or descending order.

SELECT examples

get_imported_model

Gets properties associated with a customized model you imported.

SELECT
creation_time,
custom_model_units,
instruct_supported,
job_arn,
job_name,
model_architecture,
model_arn,
model_data_source,
model_kms_key_arn,
model_name
FROM aws.bedrock.imported_models
WHERE model_identifier = '{{ model_identifier }}' -- required
AND region = '{{ region }}' -- required
;

list_imported_models

Returns a list of models you've imported. You can filter the results to return based on one or more criteria. For more information, see Import a customized model in the Amazon Bedrock User Guide.

SELECT
creation_time,
instruct_supported,
model_architecture,
model_arn,
model_name
FROM aws.bedrock.imported_models
WHERE region = '{{ region }}' -- required
AND creationTimeBefore = '{{ creationTimeBefore }}'
AND creationTimeAfter = '{{ creationTimeAfter }}'
AND nameContains = '{{ nameContains }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
AND sortBy = '{{ sortBy }}'
AND sortOrder = '{{ sortOrder }}'
;

DELETE examples

delete_imported_model

Deletes a custom model that you imported earlier. For more information, see Import a customized model in the Amazon Bedrock User Guide.

DELETE FROM aws.bedrock.imported_models
WHERE model_identifier = '{{ model_identifier }}' --required
AND region = '{{ region }}' --required
;