Returns a list of the custom models that you have created with the CreateModelCustomizationJob operation¶

Description¶

Returns a list of the custom models that you have created with the create_model_customization_job operation.

For more information, see Custom models in the Amazon Bedrock User Guide.

Usage¶

bedrock_list_custom_models(creationTimeBefore, creationTimeAfter,
  nameContains, baseModelArnEquals, foundationModelArnEquals, maxResults,
  nextToken, sortBy, sortOrder, isOwned, modelStatus)

Arguments¶

• creationTimeBefore

  Return custom models created before the specified time.

• creationTimeAfter

  Return custom models created after the specified time.

• nameContains

  Return custom models only if the job name contains these characters.

• baseModelArnEquals

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

• foundationModelArnEquals

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

• maxResults

  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

  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

  The field to sort by in the returned list of models.

• sortOrder

  The sort order of the results.

• isOwned

  Return custom models depending on if the current account owns them (true) or if they were shared with the current account (false).

• modelStatus

  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.

Value¶

A list with the following syntax:

list(
  nextToken = "string",
  modelSummaries = list(
    list(
      modelArn = "string",
      modelName = "string",
      creationTime = as.POSIXct(
        "2015-01-01"
      ),
      baseModelArn = "string",
      baseModelName = "string",
      customizationType = "FINE_TUNING"|"CONTINUED_PRE_TRAINING"|"DISTILLATION"|"REINFORCEMENT_FINE_TUNING"|"IMPORTED",
      ownerAccountId = "string",
      modelStatus = "Active"|"Creating"|"Failed"
    )
  )
)

Request syntax¶

svc$list_custom_models(
  creationTimeBefore = as.POSIXct(
    "2015-01-01"
  ),
  creationTimeAfter = as.POSIXct(
    "2015-01-01"
  ),
  nameContains = "string",
  baseModelArnEquals = "string",
  foundationModelArnEquals = "string",
  maxResults = 123,
  nextToken = "string",
  sortBy = "CreationTime",
  sortOrder = "Ascending"|"Descending",
  isOwned = TRUE|FALSE,
  modelStatus = "Active"|"Creating"|"Failed"
)