SetStatus
Requests that the status of the specified physical or logical pipeline objects be updated in the specified pipeline.
This update might not occur immediately, but is eventually consistent. The status that can be set depends on the type of object (for example, DataNode or Activity).
You cannot perform this operation on FINISHED
pipelines and attempting to do so returns InvalidRequestException
.
Request Syntax
{
"objectIds": [ "string
" ],
"pipelineId": "string
",
"status": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- objectIds
-
The IDs of the objects. The corresponding objects can be either physical or components, but not a mix of both types.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\n\t]*
Required: Yes
- pipelineId
-
The ID of the pipeline that contains the objects.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\n\t]*
Required: Yes
- status
-
The status to be set on all the objects specified in
objectIds
. For components, usePAUSE
orRESUME
. For instances, useTRY_CANCEL
,RERUN
, orMARK_FINISHED
.Type: String
Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServiceError
-
An internal service error occurred.
HTTP Status Code: 500
- InvalidRequestException
-
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.
HTTP Status Code: 400
- PipelineDeletedException
-
The specified pipeline has been deleted.
HTTP Status Code: 400
- PipelineNotFoundException
-
The specified pipeline was not found. Verify that you used the correct user and account identifiers.
HTTP Status Code: 400
Examples
Example
This example illustrates one usage of SetStatus.
Sample Request
POST / HTTP/1.1
Content-Type: application/x-amz-json-1.1
X-Amz-Target: DataPipeline.SetStatus
Content-Length: 100
Host: datapipeline.us-east-1.amazonaws.com
X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT
Authorization: AuthParams
{"pipelineId": "df-0634701J7KEXAMPLE",
"objectIds":
["o-08600941GHJWMBR9E2"],
"status": "pause"}
Sample Response
x-amzn-RequestId: e83b8ab7-076a-11e2-af6f-6bc7a6be60d9
Content-Type: application/x-amz-json-1.1
Content-Length: 0
Date: Mon, 12 Nov 2012 17:50:53 GMT
Unexpected response: 200, OK, undefined
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: