AgentsforBedrock / Paginator / ListVpcConfigurations

ListVpcConfigurations¶

class AgentsforBedrock.Paginator.ListVpcConfigurations¶

paginator = client.get_paginator('list_vpc_configurations')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from AgentsforBedrock.Client.list_vpc_configurations().

Request Syntax

response_iterator = paginator.paginate(
    knowledgeBaseId='string',
    statusFilter='CREATING'|'CREATED'|'DELETING'|'CREATE_FAILED'|'DELETE_FAILED',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': '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.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
- MaxItems (integer) –
  
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) –
  
  The size of each page.
- StartingToken (string) –
  
  A token to specify where to start paginating. This is the NextToken from a previous response.

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 token to resume pagination.