Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateAutomationRuleV2

Updates a V2 automation rule. This API is in private preview and subject to change.

Request Syntax


PATCH /automationrulesv2/Identifier HTTP/1.1
Content-type: application/json

{
   "Actions": [ 
      { 
         "ExternalIntegrationConfiguration": { 
            "ConnectorArn": "string"
         },
         "FindingFieldsUpdate": { 
            "Comment": "string",
            "SeverityId": number,
            "StatusId": number
         },
         "Type": "string"
      }
   ],
   "Criteria": { ... },
   "Description": "string",
   "RuleName": "string",
   "RuleOrder": number,
   "RuleStatus": "string"
}

URI Request Parameters

The request uses the following URI parameters.

Identifier

The ARN of the automation rule.

Pattern: .*\S.*

Required: Yes

Request Body

The request accepts the following data in JSON format.

Actions

A list of actions to be performed when the rule criteria is met.

Type: Array of AutomationRulesActionV2 objects

Array Members: Fixed number of 1 item.

Required: No

Criteria

The filtering type and configuration of the automation rule.

Type: Criteria object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: No

Description

A description of the automation rule.

Type: String

Pattern: .*\S.*

Required: No

RuleName

The name of the automation rule.

Type: String

Pattern: .*\S.*

Required: No

RuleOrder

Represents a value for the rule priority.

Type: Float

Valid Range: Minimum value of 1.0. Maximum value of 1000.0.

Required: No

RuleStatus

The status of the automation rule.

Type: String

Valid Values: ENABLED | DISABLED

Required: No

Response Syntax


HTTP/1.1 200

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.

AccessDeniedException

You don't have permission to perform the action specified in the request.

HTTP Status Code: 403

ConflictException

The request causes conflict with the current state of the service resource.

HTTP Status Code: 409

InternalServerException

The request has failed due to an internal failure of the service.

HTTP Status Code: 500

ResourceNotFoundException

The request was rejected because we can't find the specified resource.

HTTP Status Code: 404

ThrottlingException

The limit on the number of requests per second was exceeded.

HTTP Status Code: 429

ValidationException

The request has failed validation because it's missing required fields or has invalid inputs.

HTTP Status Code: 400