AgentsforBedrock / Client / list_vpc_configurations

list_vpc_configurations

AgentsforBedrock.Client.list_vpc_configurations(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.list_vpc_configurations(
    knowledgeBaseId='string',
    statusFilter='CREATING'|'CREATED'|'DELETING'|'CREATE_FAILED'|'DELETE_FAILED',
    maxResults=123,
    nextToken='string'
)
Parameters:

  • knowledgeBaseId (string) –

    [REQUIRED]

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

  • statusFilter (string) – The status to filter the results by. Only VPC configurations with the specified status are returned.

  • maxResults (integer) – The maximum number of results to return in the response. If more results are available, the response returns a nextToken.

  • nextToken (string) – A pagination token to retrieve the next page of results, returned in a previous response when more results are available.

Return type:

dict

Returns:

Response Syntax

{
    'items': [
        {
            'vpcConfigurationId': 'string',
            'status': 'CREATING'|'CREATED'|'DELETING'|'CREATE_FAILED'|'DELETE_FAILED',
            'statusMessage': 'string',
            'vpcId': '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)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • items (list) –

      A list of VPC configuration summaries.

      • (dict) –

        A summary of a VPC configuration returned by ListVpcConfigurations.

        • 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 failure.

        • vpcId (string) –

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

        • 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.

    • nextToken (string) –

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

Exceptions