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:
-
knowledge_base_id
(Id)
–
The unique identifier of the knowledge base whose VPC configurations you want to list.
-
status_filter
(Optional[VpcConfigurationStatus], default:
None
)
–
The status to filter the results by. Only VPC configurations with the specified status are returned.
-
max_results
(Optional[MaxResults], default:
None
)
–
The maximum number of results to return in the response. If more results are available, the response returns a nextToken.
-
next_token
(Optional[NextToken], default:
None
)
–
A pagination token to retrieve the next page of results, returned in a previous response when more results are available.
Raises:
Source code in docs_src/capo_bedrock_agent/_services/bedrock_agent.py
| def list_vpc_configurations(
self,
knowledge_base_id: "capo_bedrock_agent.types.id.Id",
*,
config_overrides: Optional[BedrockAgentClientConfig] = None,
status_filter: Optional[
"capo_bedrock_agent.types.vpc_configuration_status.VpcConfigurationStatus"
] = None,
max_results: Optional["capo_bedrock_agent.types.max_results.MaxResults"] = None,
next_token: Optional["capo_bedrock_agent.types.next_token.NextToken"] = None,
) -> "capo_bedrock_agent.types.list_vpc_configurations_response.ListVpcConfigurationsResponse":
"""<p>Returns a paginated list of the VPC configurations for a knowledge base. You can optionally filter by status. Use the <code>nextToken</code> parameter to retrieve additional results.</p>
Args:
knowledge_base_id: <p>The unique identifier of the knowledge base whose VPC configurations you want to list.</p>
status_filter: <p>The status to filter the results by. Only VPC configurations with the specified status are returned.</p>
max_results: <p>The maximum number of results to return in the response. If more results are available, the response returns a <code>nextToken</code>.</p>
next_token: <p>A pagination token to retrieve the next page of results, returned in a previous response when more results are available.</p>
Raises:
capo_bedrock_agent.errors.access_denied_exception.AccessDeniedException: <p>The request is denied because of missing access permissions.</p>
capo_bedrock_agent.errors.internal_server_exception.InternalServerException: <p>An internal server error occurred. Retry your request.</p>
capo_bedrock_agent.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
capo_bedrock_agent.errors.throttling_exception.ThrottlingException: <p>The number of requests exceeds the limit. Resubmit your request later.</p>
capo_bedrock_agent.errors.validation_exception.ValidationException: <p>Input validation failed. Check your request parameters and retry the request.</p>
capo_bedrock_agent.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_bedrock_agent.types.list_vpc_configurations_request.ListVpcConfigurationsRequest]",
) -> OperationResponse[
"capo_bedrock_agent.types.list_vpc_configurations_response.ListVpcConfigurationsResponse"
]:
import capo_bedrock_agent._operations.amazon_bedrock_agent_build_time_lambda.list_vpc_configurations
output, http_response = (
capo_bedrock_agent._operations.amazon_bedrock_agent_build_time_lambda.list_vpc_configurations.list_vpc_configurations(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListVpcConfigurations")
)
input_: capo_bedrock_agent.types.list_vpc_configurations_request.ListVpcConfigurationsRequest = {
"knowledge_base_id": knowledge_base_id
}
if status_filter is not None:
input_["status_filter"] = status_filter
if max_results is not None:
input_["max_results"] = max_results
if next_token is not None:
input_["next_token"] = next_token
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|