list_custom_models¶
Operation¶
async
¶
list_custom_models(input: ListCustomModelsInput, plugins: list[Plugin] | None = None) -> ListCustomModelsOutput
Returns a list of the custom models that you have created with the
CreateModelCustomizationJob operation.
For more information, see Custom models in the Amazon Bedrock User Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ListCustomModelsInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
ListCustomModelsOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for ListCustomModelsInput structure.
Attributes¶
class-attribute
instance-attribute
¶
base_model_arn_equals: str | None = None
Return custom models only if the base model Amazon Resource Name (ARN) matches this parameter.
class-attribute
instance-attribute
¶
creation_time_after: datetime | None = None
Return custom models created after the specified time.
class-attribute
instance-attribute
¶
creation_time_before: datetime | None = None
Return custom models created before the specified time.
class-attribute
instance-attribute
¶
foundation_model_arn_equals: str | None = None
Return custom models only if the foundation model Amazon Resource Name (ARN) matches this parameter.
class-attribute
instance-attribute
¶
is_owned: bool | None = None
Return custom models depending on if the current account owns them
(true) or if they were shared with the current account (false).
class-attribute
instance-attribute
¶
max_results: int | None = None
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.
class-attribute
instance-attribute
¶
model_status: ModelStatus | None = None
The status of them model to filter results by. Possible values include:
-
Creating- Include only models that are currently being created and validated. -
Active- Include only models that have been successfully created and are ready for use. -
Failed- Include only models where the creation process failed.
If you don't specify a status, the API returns models in all states.
class-attribute
instance-attribute
¶
name_contains: str | None = None
Return custom models only if the job name contains these characters.
class-attribute
instance-attribute
¶
next_token: str | None = None
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.
class-attribute
instance-attribute
¶
sort_by: SortModelsBy | None = None
The field to sort by in the returned list of models.
Output¶
dataclass
¶
Dataclass for ListCustomModelsOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
model_summaries: list[CustomModelSummary] | None = None
Model summaries.
class-attribute
instance-attribute
¶
next_token: str | None = None
If the total number of results is greater than the maxResults value
provided in the request, use this token when making another request in
the nextToken field to return the next batch of results.