Skip to content

get_vpc_configuration

Operation

get_vpc_configuration

get_vpc_configuration(request: GetVpcConfigurationInput | GetVpcConfigurationInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetVpcConfigurationInputDict]) -> GetVpcConfigurationOutput

Returns the details and current status of a single VPC configuration. Use this operation to poll for the outcome of an asynchronous create or delete.

Parameters:

Name Type Description Default
request GetVpcConfigurationInput | GetVpcConfigurationInputDict | 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[GetVpcConfigurationInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetVpcConfigurationOutput

An instance of GetVpcConfigurationOutput.

get_vpc_configuration async

get_vpc_configuration(request: GetVpcConfigurationInput | GetVpcConfigurationInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetVpcConfigurationInputDict]) -> GetVpcConfigurationOutput

Returns the details and current status of a single VPC configuration. Use this operation to poll for the outcome of an asynchronous create or delete.

Parameters:

Name Type Description Default
request GetVpcConfigurationInput | GetVpcConfigurationInputDict | 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[GetVpcConfigurationInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetVpcConfigurationOutput

An instance of GetVpcConfigurationOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

GetVpcConfigurationInputDict

Bases: TypedDict

Dictionary form of GetVpcConfigurationInput.

Attributes

knowledge_base_id instance-attribute
knowledge_base_id: Required[str]

The unique identifier of the knowledge base that owns the VPC configuration.

vpc_configuration_id instance-attribute
vpc_configuration_id: Required[str]

The unique identifier of the VPC configuration to retrieve.

GetVpcConfigurationInput dataclass

Bases: _SerdeShape

Dataclass for GetVpcConfigurationInput structure.

Attributes

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

The unique identifier of the knowledge base that owns the VPC configuration.

vpc_configuration_id class-attribute instance-attribute
vpc_configuration_id: str | None = ...

The unique identifier of the VPC configuration to retrieve.

Output

GetVpcConfigurationOutput dataclass

Bases: _SerdeShape

Dataclass for GetVpcConfigurationOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

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.

vpc_configuration instance-attribute
vpc_configuration: VpcConfiguration

The VPC configuration, including its connection settings, resolution mode, and current lifecycle status.