GetAutomationRuleV2 - Amazon Security Hub
Request SyntaxURI Request ParametersRequest BodyResponse SyntaxResponse ElementsErrorsSee Also
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

GetAutomationRuleV2

Returns an automation rule for the V2 service. This API is in private preview and subject to change.

Request Syntax

GET /automationrulesv2/Identifier HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

Identifier

The ARN of the V2 automation rule.

Pattern: .*\S.*

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
   "Actions": [ 
      { 
         "ExternalIntegrationConfiguration": { 
            "ConnectorArn": "string"
         },
         "FindingFieldsUpdate": { 
            "Comment": "string",
            "SeverityId": number,
            "StatusId": number
         },
         "Type": "string"
      }
   ],
   "CreatedAt": "string",
   "Criteria": { ... },
   "Description": "string",
   "RuleArn": "string",
   "RuleId": "string",
   "RuleName": "string",
   "RuleOrder": number,
   "RuleStatus": "string",
   "UpdatedAt": "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.

Actions

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

Type: Array of AutomationRulesActionV2 objects

Array Members: Fixed number of 1 item.

CreatedAt

The timestamp when the V2 automation rule was created.

Type: Timestamp

Criteria

The filtering type and configuration of the V2 automation rule.

Type: Criteria object

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

Description

A description of the automation rule.

Type: String

Pattern: .*\S.*

RuleArn

The ARN of the V2 automation rule.

Type: String

Pattern: .*\S.*

RuleId

The ID of the V2 automation rule.

Type: String

Pattern: .*\S.*

RuleName

The name of the V2 automation rule.

Type: String

Pattern: .*\S.*

RuleOrder

The value for the rule priority.

Type: Float

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

RuleStatus

The status of the V2 automation automation rule.

Type: String

Valid Values: ENABLED | DISABLED

UpdatedAt

The timestamp when the V2 automation rule was updated.

Type: Timestamp

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

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: