:doc:`OpenSearchIngestion <../../osis>` / Client / create_pipeline_endpoint

************************
create_pipeline_endpoint
************************



.. py:method:: OpenSearchIngestion.Client.create_pipeline_endpoint(**kwargs)

  

  Creates a VPC endpoint for an OpenSearch Ingestion pipeline. Pipeline endpoints allow you to ingest data from your VPC into pipelines that you have access to.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/CreatePipelineEndpoint>`_  


  **Request Syntax**
  ::

    response = client.create_pipeline_endpoint(
        PipelineArn='string',
        VpcOptions={
            'SubnetIds': [
                'string',
            ],
            'SecurityGroupIds': [
                'string',
            ]
        }
    )
    
  :type PipelineArn: string
  :param PipelineArn: **[REQUIRED]** 

    The Amazon Resource Name (ARN) of the pipeline to create the endpoint for.

    

  
  :type VpcOptions: dict
  :param VpcOptions: **[REQUIRED]** 

    Container for the VPC configuration for the pipeline endpoint, including subnet IDs and security group IDs.

    

  
    - **SubnetIds** *(list) --* 

      A list of subnet IDs where the pipeline endpoint network interfaces are created.

      

    
      - *(string) --* 

      
  
    - **SecurityGroupIds** *(list) --* 

      A list of security group IDs that control network access to the pipeline endpoint.

      

    
      - *(string) --* 

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

    
    ::

      {
          'PipelineArn': 'string',
          'EndpointId': 'string',
          'Status': 'CREATING'|'ACTIVE'|'CREATE_FAILED'|'DELETING'|'REVOKING'|'REVOKED',
          'VpcId': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **PipelineArn** *(string) --* 

        The Amazon Resource Name (ARN) of the pipeline associated with the endpoint.

        
      

      - **EndpointId** *(string) --* 

        The unique identifier of the pipeline endpoint.

        
      

      - **Status** *(string) --* 

        The current status of the pipeline endpoint.

        
      

      - **VpcId** *(string) --* 

        The ID of the VPC where the pipeline endpoint was created.

        
  
  **Exceptions**
  
  *   :py:class:`OpenSearchIngestion.Client.exceptions.DisabledOperationException`

  
  *   :py:class:`OpenSearchIngestion.Client.exceptions.LimitExceededException`

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

  
  *   :py:class:`OpenSearchIngestion.Client.exceptions.InternalException`

  
  *   :py:class:`OpenSearchIngestion.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`OpenSearchIngestion.Client.exceptions.ResourceNotFoundException`

  