Redshift / Paginator / DescribeEndpointAccess


class Redshift.Paginator.DescribeEndpointAccess#
paginator = client.get_paginator('describe_endpoint_access')

Creates an iterator that will paginate through responses from Redshift.Client.describe_endpoint_access().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • ClusterIdentifier (string) – The cluster identifier associated with the described endpoint.

  • ResourceOwner (string) – The Amazon Web Services account ID of the owner of the cluster.

  • EndpointName (string) – The name of the endpoint to be described.

  • VpcId (string) – The virtual private cloud (VPC) identifier with access to the cluster.

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



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

    • NextToken (string) –

      A token to resume pagination.