Stop Pipe

eventbridgepipes_stop_pipe

R Documentation

Stop an existing pipe¶

Description¶

Stop an existing pipe.

Usage¶

eventbridgepipes_stop_pipe(Name)

Arguments¶

Name: [required] The name of the pipe.

Value¶

A list with the following syntax:

list(
  Arn = "string",
  Name = "string",
  DesiredState = "RUNNING"|"STOPPED",
  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",
  CreationTime = as.POSIXct(
    "2015-01-01"
  ),
  LastModifiedTime = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax¶

svc$stop_pipe(
  Name = "string"
)