Skip to content

Bedrock Agent  >  Operations  >  list_vpc_configurations

list_vpc_configurations

Operation

list_vpc_configurations async 

list_vpc_configurations(input: ListVpcConfigurationsInput, plugins: list[Plugin] | None = None) -> ListVpcConfigurationsOutput

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.

Parameters:

Name Type Description Default
input ListVpcConfigurationsInput

An instance of ListVpcConfigurationsInput.

 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
ListVpcConfigurationsOutput

An instance of ListVpcConfigurationsOutput.

Input

ListVpcConfigurationsInput dataclass

Dataclass for ListVpcConfigurationsInput structure.

Attributes

knowledge_base_id class-attribute instance-attribute 
knowledge_base_id: str | None = None

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

max_results class-attribute instance-attribute 
max_results: int | None = None

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

next_token class-attribute instance-attribute 
next_token: str | None = None

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

status_filter class-attribute instance-attribute 
status_filter: str | None = None

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

Output

ListVpcConfigurationsOutput dataclass

Dataclass for ListVpcConfigurationsOutput structure.

Attributes

items instance-attribute 
items: list[VpcConfigurationSummary]

A list of VPC configuration summaries.

next_token class-attribute instance-attribute 
next_token: str | None = None

A pagination token to retrieve the next page of results, present when the total number of results exceeds the maximum number of results.

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = field(default=EMPTY_RESPONSE_METADATA, repr=False, compare=False)

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.