Skip to content

List Custom Model Deployments

bedrock_list_custom_model_deployments R Documentation

Lists custom model deployments in your account

Description

Lists custom model deployments in your account. You can filter the results by creation time, name, status, and associated model. Use this operation to manage and monitor your custom model deployments.

We recommend using pagination to ensure that the operation returns quickly and successfully.

The following actions are related to the list_custom_model_deployments operation:

  • create_custom_model_deployment

  • get_custom_model_deployment

  • delete_custom_model_deployment

Usage

bedrock_list_custom_model_deployments(createdBefore, createdAfter,
  nameContains, maxResults, nextToken, sortBy, sortOrder, statusEquals,
  modelArnEquals)

Arguments

createdBefore

Filters deployments created before the specified date and time.

createdAfter

Filters deployments created after the specified date and time.

nameContains

Filters deployments whose names contain the specified string.

maxResults

The maximum number of results to return in a single call.

nextToken

The token for the next set of results. Use this token to retrieve additional results when the response is truncated.

sortBy

The field to sort the results by. The only supported value is CreationTime.

sortOrder

The sort order for the results. Valid values are Ascending and Descending. Default is Descending.

statusEquals

Filters deployments by status. Valid values are CREATING, ACTIVE, and FAILED.

modelArnEquals

Filters deployments by the Amazon Resource Name (ARN) of the associated custom model.

Value

A list with the following syntax:

list(
  nextToken = "string",
  modelDeploymentSummaries = list(
    list(
      customModelDeploymentArn = "string",
      customModelDeploymentName = "string",
      modelArn = "string",
      createdAt = as.POSIXct(
        "2015-01-01"
      ),
      status = "Creating"|"Active"|"Failed",
      lastUpdatedAt = as.POSIXct(
        "2015-01-01"
      ),
      failureMessage = "string"
    )
  )
)

Request syntax

svc$list_custom_model_deployments(
  createdBefore = as.POSIXct(
    "2015-01-01"
  ),
  createdAfter = as.POSIXct(
    "2015-01-01"
  ),
  nameContains = "string",
  maxResults = 123,
  nextToken = "string",
  sortBy = "CreationTime",
  sortOrder = "Ascending"|"Descending",
  statusEquals = "Creating"|"Active"|"Failed",
  modelArnEquals = "string"
)