StopAutomationExecution
Stop an Automation that is currently running.
Request Syntax
{
"AutomationExecutionId": "string",
"Type": "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.
- AutomationExecutionId
-
The execution ID of the Automation to stop.
Type: String
Length Constraints: Fixed length of 36.
Required: Yes
- Type
-
The stop request type. Valid types include the following: Cancel and Complete. The default type is Cancel.
Type: String
Valid Values:
Complete | CancelRequired: No
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.
- AutomationExecutionNotFoundException
-
There is no automation execution information for the requested automation execution ID.
HTTP Status Code: 400
- InternalServerError
-
An error occurred on the server side.
HTTP Status Code: 500
- InvalidAutomationStatusUpdateException
-
The specified update status operation isn't valid.
HTTP Status Code: 400
Examples
Example
This example illustrates one usage of StopAutomationExecution.
Sample Request
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.StopAutomationExecution
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12
X-Amz-Date: 20240325T171100Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240325/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 65
{
"AutomationExecutionId": "f7d1f82d-6cde-4f7a-aa53-d485bEXAMPLE"
}Sample Response
{}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
