POST

/2012-09-25/pipelines/{Id}/status

http://elastictranscoder.{region}.amazonaws.com/2012-09-25/pipelines/{Id}/status

The UpdatePipelineStatus operation pauses or reactivates a pipeline, so that the pipeline stops or restarts the processing of jobs. Changing the pipeline status is useful if you want to cancel one or more jobs. You can't cancel jobs after Elastic Transcoder has started processing them; if you pause the pipeline to which you submitted the jobs, you have more time to get the job IDs for the jobs that you want to cancel, and to send a <a>CancelJob</a> request.

Access Token Required: API Key

Path Parameters

Idstringrequired

The identifier of the pipeline to update.

Body Params

Statusstringrequired

The desired status of the pipeline: <ul> <li> <code>Active</code>: The pipeline is processing jobs. </li> <li> <code>Paused</code>: The pipeline is not currently processing jobs. </li> </ul>

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://elastictranscoder.{region}.amazonaws.com/2012-09-25/pipelines/{Id}/status' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

1curl --request POST \ 2 --url 'http://elastictranscoder.{region}.amazonaws.com/2012-09-25/pipelines/{Id}/status' \ 3 --header 'accept: application/json' \ 4 --header 'content-type: application/json'