list_vpc_configurations¶
Operation¶
list_vpc_configurations
¶
list_vpc_configurations(request: ListVpcConfigurationsInput | ListVpcConfigurationsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListVpcConfigurationsInputDict]) -> 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 |
|---|---|---|---|
request
|
ListVpcConfigurationsInput | ListVpcConfigurationsInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[ListVpcConfigurationsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListVpcConfigurationsOutput
|
An instance of |
list_vpc_configurations
async
¶
list_vpc_configurations(request: ListVpcConfigurationsInput | ListVpcConfigurationsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListVpcConfigurationsInputDict]) -> 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 |
|---|---|---|---|
request
|
ListVpcConfigurationsInput | ListVpcConfigurationsInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[ListVpcConfigurationsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListVpcConfigurationsOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
ListVpcConfigurationsInputDict
¶
Bases: TypedDict
Dictionary form of ListVpcConfigurationsInput.
Attributes¶
knowledge_base_id
instance-attribute
¶
The unique identifier of the knowledge base whose VPC configurations you want to list.
max_results
instance-attribute
¶
max_results: int | None
The maximum number of results to return in the response. If more results
are available, the response returns a nextToken.
ListVpcConfigurationsInput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListVpcConfigurationsInput structure.
Attributes¶
knowledge_base_id
class-attribute
instance-attribute
¶
knowledge_base_id: str | 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 = ...
The maximum number of results to return in the response. If more results
are available, the response returns a nextToken.
Output¶
ListVpcConfigurationsOutput
dataclass
¶
Bases: _SerdeShape
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 = ...
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
¶
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.