RDS / Client / enable_http_endpoint

enable_http_endpoint#

RDS.Client.enable_http_endpoint(**kwargs)#

Enables the HTTP endpoint for the DB cluster. By default, the HTTP endpoint isn’t enabled.

When enabled, this endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the Aurora DB cluster. You can also query your database from inside the RDS console with the RDS query editor.

For more information, see Using RDS Data API in the Amazon Aurora User Guide.

Note

This operation applies only to Aurora PostgreSQL Serverless v2 and provisioned DB clusters. To enable the HTTP endpoint for Aurora Serverless v1 DB clusters, use the EnableHttpEndpoint parameter of the ModifyDBCluster operation.

See also: AWS API Documentation

Request Syntax

response = client.enable_http_endpoint(
    ResourceArn='string'
)
Parameters:

ResourceArn (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the DB cluster.

Return type:

dict

Returns:

Response Syntax

{
    'ResourceArn': 'string',
    'HttpEndpointEnabled': True|False
}

Response Structure

  • (dict) –

    • ResourceArn (string) –

      The ARN of the DB cluster.

    • HttpEndpointEnabled (boolean) –

      Indicates whether the HTTP endpoint is enabled or disabled for the DB cluster.

Exceptions