:doc:`RedshiftServerless <../../redshift-serverless>` / Client / list_endpoint_access

********************
list_endpoint_access
********************



.. py:method:: RedshiftServerless.Client.list_endpoint_access(**kwargs)

  

  Returns an array of ``EndpointAccess`` objects and relevant information.

  

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


  **Request Syntax**
  ::

    response = client.list_endpoint_access(
        maxResults=123,
        nextToken='string',
        ownerAccount='string',
        vpcId='string',
        workgroupName='string'
    )
    
  :type maxResults: integer
  :param maxResults: 

    An optional parameter that specifies the maximum number of results to return. You can use ``nextToken`` to display the next page of results.

    

  
  :type nextToken: string
  :param nextToken: 

    If your initial ``ListEndpointAccess`` operation returns a ``nextToken``, you can include the returned ``nextToken`` in following ``ListEndpointAccess`` operations, which returns results in the next page.

    

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

    

  
  
  :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) --* 

        When ``nextToken`` is returned, there are more results available. The value of ``nextToken`` is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

        
  
  **Exceptions**
  
  *   :py:class:`RedshiftServerless.Client.exceptions.InternalServerException`

  
  *   :py:class:`RedshiftServerless.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`RedshiftServerless.Client.exceptions.ConflictException`

  
  *   :py:class:`RedshiftServerless.Client.exceptions.ValidationException`

  