:doc:`RDS <../../rds>` / Client / disable_http_endpoint

*********************
disable_http_endpoint
*********************



.. py:method:: RDS.Client.disable_http_endpoint(**kwargs)

  

  Disables the HTTP endpoint for the specified DB cluster. Disabling this endpoint disables RDS Data API.

   

  For more information, see `Using RDS Data API <https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html>`__ in the *Amazon Aurora User Guide*.

   

  .. note::

    

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

    

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DisableHttpEndpoint>`_  


  **Request Syntax**
  ::

    response = client.disable_http_endpoint(
        ResourceArn='string'
    )
    
  :type ResourceArn: string
  :param ResourceArn: **[REQUIRED]** 

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

    

  
  
  :rtype: 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**
  
  *   :py:class:`RDS.Client.exceptions.ResourceNotFoundFault`

  
  *   :py:class:`RDS.Client.exceptions.InvalidResourceStateFault`

  