:doc:`RedshiftServerless <../../redshift-serverless>` / Paginator / ListEndpointAccess

******************
ListEndpointAccess
******************



.. py:class:: RedshiftServerless.Paginator.ListEndpointAccess

  ::

    
    paginator = client.get_paginator('list_endpoint_access')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`RedshiftServerless.Client.list_endpoint_access`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/ListEndpointAccess>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          ownerAccount='string',
          vpcId='string',
          workgroupName='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type ownerAccount: string
    :param ownerAccount: 

      The owner Amazon Web Services account for the Amazon Redshift Serverless workgroup.

      

    
    :type vpcId: string
    :param vpcId: 

      The unique identifier of the virtual private cloud with access to Amazon Redshift Serverless.

      

    
    :type workgroupName: string
    :param workgroupName: 

      The name of the workgroup associated with the VPC endpoint to return.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'endpoints': [
                {
                    'address': 'string',
                    'endpointArn': 'string',
                    'endpointCreateTime': datetime(2015, 1, 1),
                    'endpointName': 'string',
                    'endpointStatus': 'string',
                    'port': 123,
                    'subnetIds': [
                        'string',
                    ],
                    'vpcEndpoint': {
                        'networkInterfaces': [
                            {
                                'availabilityZone': 'string',
                                'ipv6Address': 'string',
                                'networkInterfaceId': 'string',
                                'privateIpAddress': 'string',
                                'subnetId': 'string'
                            },
                        ],
                        'vpcEndpointId': 'string',
                        'vpcId': 'string'
                    },
                    'vpcSecurityGroups': [
                        {
                            'status': 'string',
                            'vpcSecurityGroupId': 'string'
                        },
                    ],
                    'workgroupName': 'string'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **endpoints** *(list) --* 

          The returned VPC endpoints.

          
          

          - *(dict) --* 

            Information about an Amazon Redshift Serverless VPC endpoint.

            
            

            - **address** *(string) --* 

              The DNS address of the endpoint.

              
            

            - **endpointArn** *(string) --* 

              The Amazon Resource Name (ARN) of the VPC endpoint.

              
            

            - **endpointCreateTime** *(datetime) --* 

              The time that the endpoint was created.

              
            

            - **endpointName** *(string) --* 

              The name of the VPC endpoint.

              
            

            - **endpointStatus** *(string) --* 

              The status of the VPC endpoint.

              
            

            - **port** *(integer) --* 

              The port number on which Amazon Redshift Serverless accepts incoming connections.

              
            

            - **subnetIds** *(list) --* 

              The unique identifier of subnets where Amazon Redshift Serverless choose to deploy the VPC endpoint.

              
              

              - *(string) --* 
          
            

            - **vpcEndpoint** *(dict) --* 

              The connection endpoint for connecting to Amazon Redshift Serverless.

              
              

              - **networkInterfaces** *(list) --* 

                One or more network interfaces of the endpoint. Also known as an interface endpoint.

                
                

                - *(dict) --* 

                  Contains information about a network interface in an Amazon Redshift Serverless managed VPC endpoint.

                  
                  

                  - **availabilityZone** *(string) --* 

                    The availability Zone.

                    
                  

                  - **ipv6Address** *(string) --* 

                    The IPv6 address of the network interface within the subnet.

                    
                  

                  - **networkInterfaceId** *(string) --* 

                    The unique identifier of the network interface.

                    
                  

                  - **privateIpAddress** *(string) --* 

                    The IPv4 address of the network interface within the subnet.

                    
                  

                  - **subnetId** *(string) --* 

                    The unique identifier of the subnet.

                    
              
            
              

              - **vpcEndpointId** *(string) --* 

                The connection endpoint ID for connecting to Amazon Redshift Serverless.

                
              

              - **vpcId** *(string) --* 

                The VPC identifier that the endpoint is associated with.

                
          
            

            - **vpcSecurityGroups** *(list) --* 

              The security groups associated with the endpoint.

              
              

              - *(dict) --* 

                Describes the members of a VPC security group.

                
                

                - **status** *(string) --* 

                  The status of the VPC security group.

                  
                

                - **vpcSecurityGroupId** *(string) --* 

                  The unique identifier of the VPC security group.

                  
            
          
            

            - **workgroupName** *(string) --* 

              The name of the workgroup associated with the endpoint.

              
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    