:doc:`OpenSearchServiceServerless <../../opensearchserverless>` / Client / update_vpc_endpoint

*******************
update_vpc_endpoint
*******************



.. py:method:: OpenSearchServiceServerless.Client.update_vpc_endpoint(**kwargs)

  

  Updates an OpenSearch Serverless-managed interface endpoint. For more information, see `Access Amazon OpenSearch Serverless using an interface endpoint <https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-vpc.html>`__.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/opensearchserverless-2021-11-01/UpdateVpcEndpoint>`_  


  **Request Syntax**
  ::

    response = client.update_vpc_endpoint(
        id='string',
        addSubnetIds=[
            'string',
        ],
        removeSubnetIds=[
            'string',
        ],
        addSecurityGroupIds=[
            'string',
        ],
        removeSecurityGroupIds=[
            'string',
        ],
        clientToken='string'
    )
    
  :type id: string
  :param id: **[REQUIRED]** 

    The unique identifier of the interface endpoint to update.

    

  
  :type addSubnetIds: list
  :param addSubnetIds: 

    The ID of one or more subnets to add to the endpoint.

    

  
    - *(string) --* 

    

  :type removeSubnetIds: list
  :param removeSubnetIds: 

    The unique identifiers of the subnets to remove from the endpoint.

    

  
    - *(string) --* 

    

  :type addSecurityGroupIds: list
  :param addSecurityGroupIds: 

    The unique identifiers of the security groups to add to the endpoint. Security groups define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.

    

  
    - *(string) --* 

    

  :type removeSecurityGroupIds: list
  :param removeSecurityGroupIds: 

    The unique identifiers of the security groups to remove from the endpoint.

    

  
    - *(string) --* 

    

  :type clientToken: string
  :param clientToken: 

    Unique, case-sensitive identifier to ensure idempotency of the request.

    This field is autopopulated if not provided.

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'UpdateVpcEndpointDetail': {
              'id': 'string',
              'name': 'string',
              'status': 'PENDING'|'DELETING'|'ACTIVE'|'FAILED',
              'subnetIds': [
                  'string',
              ],
              'securityGroupIds': [
                  'string',
              ],
              'lastModifiedDate': 123
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **UpdateVpcEndpointDetail** *(dict) --* 

        Details about the updated VPC endpoint.

        
        

        - **id** *(string) --* 

          The unique identifier of the endpoint.

          
        

        - **name** *(string) --* 

          The name of the endpoint.

          
        

        - **status** *(string) --* 

          The current status of the endpoint update process.

          
        

        - **subnetIds** *(list) --* 

          The ID of the subnets from which you access OpenSearch Serverless.

          
          

          - *(string) --* 
      
        

        - **securityGroupIds** *(list) --* 

          The unique identifiers of the security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.

          
          

          - *(string) --* 
      
        

        - **lastModifiedDate** *(integer) --* 

          The timestamp of when the endpoint was last modified.

          
    
  
  **Exceptions**
  
  *   :py:class:`OpenSearchServiceServerless.Client.exceptions.InternalServerException`

  
  *   :py:class:`OpenSearchServiceServerless.Client.exceptions.ConflictException`

  
  *   :py:class:`OpenSearchServiceServerless.Client.exceptions.ValidationException`

  