Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1410238162.6 KB

Stop an existing pipe.

post/v1/pipes/{Name}/stop

Path parameters

Namestring required

The name of the pipe.

Response

Success

Arnstring

The ARN of the pipe.

Namestring

The name of the pipe.

DesiredState'RUNNING' | 'STOPPED'

The state the pipe should be in.

CurrentState'RUNNING' | 'STOPPED' | 'CREATING' | 'UPDATING' | 'DELETING' | 'STARTING' | 'STOPPING' | 'CREATE_FAILED' | 'UPDATE_FAILED' | 'START_FAILED' | 'STOP_FAILED' | 'DELETE_FAILED' | 'CREATE_ROLLBACK_FAILED' | 'DELETE_ROLLBACK_FAILED' | 'UPDATE_ROLLBACK_FAILED'

The state the pipe is in.

CreationTimestring date-time

The time the pipe was created.

LastModifiedTimestring date-time

When the pipe was last updated, in <a href="https://www.w3.org/TR/NOTE-datetime">ISO-8601 format</a> (YYYY-MM-DDThh:mm:ss.sTZD).