OpenSearchIngestion / Client / create_pipeline_endpoint

create_pipeline_endpoint¶

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.

Request Syntax

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

Parameters:

PipelineArn (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of the pipeline to create the endpoint for.
VpcOptions (dict) –
[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) –

Return type:

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

OpenSearchIngestion.Client.exceptions.DisabledOperationException
OpenSearchIngestion.Client.exceptions.LimitExceededException
OpenSearchIngestion.Client.exceptions.ValidationException
OpenSearchIngestion.Client.exceptions.InternalException
OpenSearchIngestion.Client.exceptions.AccessDeniedException
OpenSearchIngestion.Client.exceptions.ResourceNotFoundException