RedshiftServerless / Client / get_endpoint_access

get_endpoint_access

RedshiftServerless.Client.get_endpoint_access(**kwargs)

Returns information, such as the name, about a VPC endpoint.

See also: AWS API Documentation

Request Syntax

response = client.get_endpoint_access(
    endpointName='string'
)

Parameters:

endpointName (string) –

[REQUIRED]

The name of the VPC endpoint to return information for.

Return type:

dict

Returns:

Response Syntax

{
    'endpoint': {
        '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'
    }
}

Response Structure

• (dict) –

  • endpoint (dict) –

    The returned 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.

Exceptions

• RedshiftServerless.Client.exceptions.InternalServerException

• RedshiftServerless.Client.exceptions.ResourceNotFoundException

• RedshiftServerless.Client.exceptions.ConflictException

• RedshiftServerless.Client.exceptions.ValidationException