describe_endpoint_access

Redshift.Client.describe_endpoint_access(**kwargs)

Describes a Redshift-managed VPC endpoint.

See also: AWS API Documentation

Request Syntax

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

Parameters

• 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.
• MaxRecords (integer) -- 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.
• 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.

Return type

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'
                    },
                ]
            }
        },
    ],
    '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.

  • 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

• Redshift.Client.exceptions.ClusterNotFoundFault
• Redshift.Client.exceptions.InvalidClusterStateFault
• Redshift.Client.exceptions.EndpointNotFoundFault