Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreatePipelineEndpoint

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


POST /2022-01-01/osis/createPipelineEndpoint HTTP/1.1
Content-type: application/json

{
   "PipelineArn": "string",
   "VpcOptions": { 
      "SecurityGroupIds": [ "string" ],
      "SubnetIds": [ "string" ]
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

PipelineArn

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

Type: String

Length Constraints: Minimum length of 46. Maximum length of 76.

Pattern: ^arn:(aws|aws\-cn|aws\-us\-gov|aws\-iso|aws\-iso\-b):osis:.+:pipeline\/.+$

Required: Yes

VpcOptions

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

Type: PipelineEndpointVpcOptions object

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "EndpointId": "string",
   "PipelineArn": "string",
   "Status": "string",
   "VpcId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

EndpointId

The unique identifier of the pipeline endpoint.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 512.

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_]+$

PipelineArn

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

Type: String

Length Constraints: Minimum length of 46. Maximum length of 76.

Pattern: ^arn:(aws|aws\-cn|aws\-us\-gov|aws\-iso|aws\-iso\-b):osis:.+:pipeline\/.+$

Status

The current status of the pipeline endpoint.

Type: String

VpcId

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

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have permissions to access the resource.

HTTP Status Code: 403

DisabledOperationException

Exception is thrown when an operation has been disabled.

HTTP Status Code: 409

InternalException

The request failed because of an unknown error, exception, or failure (the failure is internal to the service).

HTTP Status Code: 500

LimitExceededException

You attempted to create more than the allowed number of tags.

HTTP Status Code: 409

ResourceNotFoundException

You attempted to access or delete a resource that does not exist.

HTTP Status Code: 404

ValidationException

An exception for missing or invalid input fields.

HTTP Status Code: 400