Bedrock / Client / list_custom_models

list_custom_models#

Bedrock.Client.list_custom_models(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.list_custom_models(
    creationTimeBefore=datetime(2015, 1, 1),
    creationTimeAfter=datetime(2015, 1, 1),
    nameContains='string',
    baseModelArnEquals='string',
    foundationModelArnEquals='string',
    maxResults=123,
    nextToken='string',
    sortBy='CreationTime',
    sortOrder='Ascending'|'Descending'
)
Parameters:

  • creationTimeBefore (datetime) – Return custom models created before the specified time.

  • creationTimeAfter (datetime) – Return custom models created after the specified time.

  • nameContains (string) – Return custom models only if the job name contains these characters.

  • baseModelArnEquals (string) – Return custom models only if the base model Amazon Resource Name (ARN) matches this parameter.

  • foundationModelArnEquals (string) – Return custom models only if the foundation model Amazon Resource Name (ARN) matches this parameter.

  • maxResults (integer) – Maximum number of results to return in the response.

  • nextToken (string) – Continuation token from the previous response, for Amazon Bedrock to list the next set of results.

  • sortBy (string) – The field to sort by in the returned list of models.

  • sortOrder (string) – The sort order of the results.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'modelSummaries': [
        {
            'modelArn': 'string',
            'modelName': 'string',
            'creationTime': datetime(2015, 1, 1),
            'baseModelArn': 'string',
            'baseModelName': 'string',
            'customizationType': 'FINE_TUNING'|'CONTINUED_PRE_TRAINING'
        },
    ]
}

Response Structure

  • (dict) –

    • nextToken (string) –

      Continuation token for the next request to list the next set of results.

    • modelSummaries (list) –

      Model summaries.

      • (dict) –

        Summary information for a custom model.

        • modelArn (string) –

          The Amazon Resource Name (ARN) of the custom model.

        • modelName (string) –

          The name of the custom model.

        • creationTime (datetime) –

          Creation time of the model.

        • baseModelArn (string) –

          The base model Amazon Resource Name (ARN).

        • baseModelName (string) –

          The base model name.

        • customizationType (string) –

          Specifies whether to carry out continued pre-training of a model or whether to fine-tune it. For more information, see Custom models.

Exceptions