StopPipeline - Amazon OpenSearch Service


Stops an OpenSearch Ingestion pipeline. For more information, see Stopping an OpenSearch Ingestion pipeline.

Request Syntax

PUT /2022-01-01/osis/stopPipeline/PipelineName HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.


The name of the pipeline to stop.

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

Pattern: [a-z][a-z0-9\-]+

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "Pipeline": { "BufferOptions": { "PersistentBufferEnabled": boolean }, "CreatedAt": number, "Destinations": [ { "Endpoint": "string", "ServiceName": "string" } ], "EncryptionAtRestOptions": { "KmsKeyArn": "string" }, "IngestEndpointUrls": [ "string" ], "LastUpdatedAt": number, "LogPublishingOptions": { "CloudWatchLogDestination": { "LogGroup": "string" }, "IsLoggingEnabled": boolean }, "MaxUnits": number, "MinUnits": number, "PipelineArn": "string", "PipelineConfigurationBody": "string", "PipelineName": "string", "ServiceVpcEndpoints": [ { "ServiceName": "string", "VpcEndpointId": "string" } ], "Status": "string", "StatusReason": { "Description": "string" }, "Tags": [ { "Key": "string", "Value": "string" } ], "VpcEndpoints": [ { "VpcEndpointId": "string", "VpcId": "string", "VpcOptions": { "SecurityGroupIds": [ "string" ], "SubnetIds": [ "string" ], "VpcAttachmentOptions": { "AttachToVpc": boolean, "CidrBlock": "string" }, "VpcEndpointManagement": "string" } } ], "VpcEndpointService": "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.


Information about an existing OpenSearch Ingestion pipeline.

Type: Pipeline object


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


You don't have permissions to access the resource.

HTTP Status Code: 403


The client attempted to remove a resource that is currently in use.

HTTP Status Code: 409


Exception is thrown when an operation has been disabled.

HTTP Status Code: 409


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

HTTP Status Code: 500


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

HTTP Status Code: 404


An exception for missing or invalid input fields.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: