Skip to content

Returns a paginated list of the VPC configurations for a knowledge base

Description

Returns a paginated list of the VPC configurations for a knowledge base. You can optionally filter by status. Use the nextToken parameter to retrieve additional results.

Usage

bedrockagent_list_vpc_configurations(knowledgeBaseId, statusFilter,
  maxResults, nextToken)

Arguments

  • knowledgeBaseId

[required] The unique identifier of the knowledge base whose VPC configurations you want to list.

  • statusFilter

The status to filter the results by. Only VPC configurations with the specified status are returned.

  • maxResults

The maximum number of results to return in the response. If more results are available, the response returns a nextToken.

  • nextToken

A pagination token to retrieve the next page of results, returned in a previous response when more results are available.

Value

A list with the following syntax:

list(
  items = list(
    list(
      vpcConfigurationId = "string",
      status = "CREATING"|"CREATED"|"DELETING"|"CREATE_FAILED"|"DELETE_FAILED",
      statusMessage = "string",
      vpcId = "string",
      resourceTarget = "string",
      port = 123,
      protocol = "HTTP"|"HTTPS",
      resolutionMode = "PUBLIC"|"IN_VPC",
      hostHeader = "string",
      tlsServerName = "string",
      name = "string",
      description = "string",
      createdAt = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  nextToken = "string"
)

Request syntax

svc$list_vpc_configurations(
  knowledgeBaseId = "string",
  statusFilter = "CREATING"|"CREATED"|"DELETING"|"CREATE_FAILED"|"DELETE_FAILED",
  maxResults = 123,
  nextToken = "string"
)