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

CreateAutomationRuleV2

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

Request Syntax


POST /automationrulesv2/create HTTP/1.1
Content-type: application/json

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

URI Request Parameters

The request does not use any URI parameters.

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: Yes

ClientToken

A unique identifier used to ensure idempotency.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Pattern: ^[\x21-\x7E]{1,64}$

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: Yes

Description

A description of the V2 automation rule.

Type: String

Pattern: .*\S.*

Required: Yes

RuleName

The name of the V2 automation rule.

Type: String

Pattern: .*\S.*

Required: Yes

RuleOrder

The value for the rule priority.

Type: Float

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

Required: Yes

RuleStatus

The status of the V2 automation rule.

Type: String

Valid Values: ENABLED | DISABLED

Required: No

Tags

A list of key-value pairs associated with the V2 automation rule.

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$

Value Length Constraints: Maximum length of 256.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "RuleArn": "string",
   "RuleId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

RuleArn

The ARN of the V2 automation rule.

Type: String

Pattern: .*\S.*

RuleId

The ID of the V2 automation rule.

Type: String

Pattern: .*\S.*

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

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