AgentsforBedrock / Client / get_vpc_configuration

get_vpc_configuration

AgentsforBedrock.Client.get_vpc_configuration(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.get_vpc_configuration(
    knowledgeBaseId='string',
    vpcConfigurationId='string'
)
Parameters:

  • knowledgeBaseId (string) –

    [REQUIRED]

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

  • vpcConfigurationId (string) –

    [REQUIRED]

    The unique identifier of the VPC configuration to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'vpcConfiguration': {
        'vpcConfigurationId': 'string',
        'status': 'CREATING'|'CREATED'|'DELETING'|'CREATE_FAILED'|'DELETE_FAILED',
        'statusMessage': 'string',
        'vpcId': 'string',
        'subnetIds': [
            'string',
        ],
        'resourceTarget': 'string',
        'port': 123,
        'protocol': 'HTTP'|'HTTPS',
        'resolutionMode': 'PUBLIC'|'IN_VPC',
        'hostHeader': 'string',
        'tlsServerName': 'string',
        'name': 'string',
        'description': 'string',
        'createdAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) –

    • vpcConfiguration (dict) –

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

      • vpcConfigurationId (string) –

        The unique identifier of the VPC configuration.

      • status (string) –

        The current lifecycle status of the VPC configuration.

      • statusMessage (string) –

        Additional detail about the current status, such as the cause of a CREATE_FAILED or DELETE_FAILED status.

      • vpcId (string) –

        The identifier of the VPC that the knowledge base connects through to reach the resource.

      • subnetIds (list) –

        The subnets that the knowledge base uses to connect to the resource.

        • (string) –

      • resourceTarget (string) –

        The private IPv4 address or DNS name of the resource.

      • port (integer) –

        The port on which the resource is reached.

      • protocol (string) –

        The protocol used to connect to the resource.

      • resolutionMode (string) –

        Specifies how the resource target is resolved.

      • hostHeader (string) –

        The HTTP Host header value sent when invoking the resource, if configured.

      • tlsServerName (string) –

        The expected TLS server name that the service matches against the Subject Alternative Names on the resource’s TLS certificate. Present when protocol is HTTPS.

      • name (string) –

        The human-readable name of the VPC configuration, if provided.

      • description (string) –

        The description of the VPC configuration, if provided.

      • createdAt (datetime) –

        The time at which the VPC configuration was created.

      • updatedAt (datetime) –

        The time at which the VPC configuration was last updated.

Exceptions