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

*******************
create_vpc_endpoint
*******************



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

  

  Creates an OpenSearch Serverless-managed interface VPC 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/CreateVpcEndpoint>`_  


  **Request Syntax**
  ::

    response = client.create_vpc_endpoint(
        name='string',
        vpcId='string',
        subnetIds=[
            'string',
        ],
        securityGroupIds=[
            'string',
        ],
        clientToken='string'
    )
    
  :type name: string
  :param name: **[REQUIRED]** 

    The name of the interface endpoint.

    

  
  :type vpcId: string
  :param vpcId: **[REQUIRED]** 

    The ID of the VPC from which you'll access OpenSearch Serverless.

    

  
  :type subnetIds: list
  :param subnetIds: **[REQUIRED]** 

    The ID of one or more subnets from which you'll access OpenSearch Serverless.

    

  
    - *(string) --* 

    

  :type securityGroupIds: list
  :param securityGroupIds: 

    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) --* 

    

  :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**

    
    ::

      {
          'createVpcEndpointDetail': {
              'id': 'string',
              'name': 'string',
              'status': 'PENDING'|'DELETING'|'ACTIVE'|'FAILED'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **createVpcEndpointDetail** *(dict) --* 

        Details about the created interface VPC endpoint.

        
        

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

          The unique identifier of the endpoint.

          
        

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

          The name of the endpoint.

          
        

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

          The current status in the endpoint creation process.

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

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

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

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

  