- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
DeactivatePipelineCommand
Deactivates the specified running pipeline. The pipeline is set to the DEACTIVATING state until the deactivation process completes.
To resume a deactivated pipeline, use ActivatePipeline. By default, the pipeline resumes from the last completed execution. Optionally, you can specify the date and time to resume the pipeline.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { DataPipelineClient, DeactivatePipelineCommand } from "@aws-sdk/client-data-pipeline"; // ES Modules import
// const { DataPipelineClient, DeactivatePipelineCommand } = require("@aws-sdk/client-data-pipeline"); // CommonJS import
const client = new DataPipelineClient(config);
const input = { // DeactivatePipelineInput
pipelineId: "STRING_VALUE", // required
cancelActive: true || false,
};
const command = new DeactivatePipelineCommand(input);
const response = await client.send(command);
// {};
DeactivatePipelineCommand Input
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
pipelineIdRequired | string | undefined | The ID of the pipeline. |
cancelActive | boolean | undefined | Indicates whether to cancel any running objects. The default is true, which sets the state of any running objects to |
DeactivatePipelineCommand Output
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| InternalServiceError | server | An internal service error occurred. |
| InvalidRequestException | client | The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. |
| PipelineDeletedException | client | The specified pipeline has been deleted. |
| PipelineNotFoundException | client | The specified pipeline was not found. Verify that you used the correct user and account identifiers. |
| DataPipelineServiceException | Base exception class for all service exceptions from DataPipeline service. |