:doc:`Redshift <../../redshift>` / Client / describe_endpoint_access

************************
describe_endpoint_access
************************



.. py:method:: Redshift.Client.describe_endpoint_access(**kwargs)

  

  Describes a Redshift-managed VPC endpoint.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DescribeEndpointAccess>`_  


  **Request Syntax**
  ::

    response = client.describe_endpoint_access(
        ClusterIdentifier='string',
        ResourceOwner='string',
        EndpointName='string',
        VpcId='string',
        MaxRecords=123,
        Marker='string'
    )
    
  :type ClusterIdentifier: string
  :param ClusterIdentifier: 

    The cluster identifier associated with the described endpoint.

    

  
  :type ResourceOwner: string
  :param ResourceOwner: 

    The Amazon Web Services account ID of the owner of the cluster.

    

  
  :type EndpointName: string
  :param EndpointName: 

    The name of the endpoint to be described.

    

  
  :type VpcId: string
  :param VpcId: 

    The virtual private cloud (VPC) identifier with access to the cluster.

    

  
  :type MaxRecords: integer
  :param MaxRecords: 

    The maximum number of records to include in the response. If more records exist than the specified ``MaxRecords`` value, a pagination token called a ``Marker`` is included in the response so that the remaining results can be retrieved.

    

  
  :type Marker: string
  :param Marker: 

    An optional pagination token provided by a previous ``DescribeEndpointAccess`` request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by the ``MaxRecords`` parameter.

    

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

    
    ::

      {
          'EndpointAccessList': [
              {
                  'ClusterIdentifier': 'string',
                  'ResourceOwner': 'string',
                  'SubnetGroupName': 'string',
                  'EndpointStatus': 'string',
                  'EndpointName': 'string',
                  'EndpointCreateTime': datetime(2015, 1, 1),
                  'Port': 123,
                  'Address': 'string',
                  'VpcSecurityGroups': [
                      {
                          'VpcSecurityGroupId': 'string',
                          'Status': 'string'
                      },
                  ],
                  'VpcEndpoint': {
                      'VpcEndpointId': 'string',
                      'VpcId': 'string',
                      'NetworkInterfaces': [
                          {
                              'NetworkInterfaceId': 'string',
                              'SubnetId': 'string',
                              'PrivateIpAddress': 'string',
                              'AvailabilityZone': 'string',
                              'Ipv6Address': 'string'
                          },
                      ]
                  }
              },
          ],
          'Marker': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **EndpointAccessList** *(list) --* 

        The list of endpoints with access to the cluster.

        
        

        - *(dict) --* 

          Describes a Redshift-managed VPC endpoint.

          
          

          - **ClusterIdentifier** *(string) --* 

            The cluster identifier of the cluster associated with the endpoint.

            
          

          - **ResourceOwner** *(string) --* 

            The Amazon Web Services account ID of the owner of the cluster.

            
          

          - **SubnetGroupName** *(string) --* 

            The subnet group name where Amazon Redshift chooses to deploy the endpoint.

            
          

          - **EndpointStatus** *(string) --* 

            The status of the endpoint.

            
          

          - **EndpointName** *(string) --* 

            The name of the endpoint.

            
          

          - **EndpointCreateTime** *(datetime) --* 

            The time (UTC) that the endpoint was created.

            
          

          - **Port** *(integer) --* 

            The port number on which the cluster accepts incoming connections.

            
          

          - **Address** *(string) --* 

            The DNS address of the endpoint.

            
          

          - **VpcSecurityGroups** *(list) --* 

            The security groups associated with the endpoint.

            
            

            - *(dict) --* 

              Describes the members of a VPC security group.

              
              

              - **VpcSecurityGroupId** *(string) --* 

                The identifier of the VPC security group.

                
              

              - **Status** *(string) --* 

                The status of the VPC security group.

                
          
        
          

          - **VpcEndpoint** *(dict) --* 

            The connection endpoint for connecting to an Amazon Redshift cluster through the proxy.

            
            

            - **VpcEndpointId** *(string) --* 

              The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy.

              
            

            - **VpcId** *(string) --* 

              The VPC identifier that the endpoint is associated.

              
            

            - **NetworkInterfaces** *(list) --* 

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

              
              

              - *(dict) --* 

                Describes a network interface.

                
                

                - **NetworkInterfaceId** *(string) --* 

                  The network interface identifier.

                  
                

                - **SubnetId** *(string) --* 

                  The subnet identifier.

                  
                

                - **PrivateIpAddress** *(string) --* 

                  The IPv4 address of the network interface within the subnet.

                  
                

                - **AvailabilityZone** *(string) --* 

                  The Availability Zone.

                  
                

                - **Ipv6Address** *(string) --* 

                  The IPv6 address of the network interface within the subnet.

                  
            
          
        
      
    
      

      - **Marker** *(string) --* 

        An optional pagination token provided by a previous ``DescribeEndpointAccess`` request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by the ``MaxRecords`` parameter.

        
  
  **Exceptions**
  
  *   :py:class:`Redshift.Client.exceptions.ClusterNotFoundFault`

  
  *   :py:class:`Redshift.Client.exceptions.InvalidClusterStateFault`

  
  *   :py:class:`Redshift.Client.exceptions.EndpointNotFoundFault`

  