BatchGetAutomationRules - AWS Security Hub

BatchGetAutomationRules

Retrieves a list of details for automation rules based on rule Amazon Resource Names (ARNs).

Request Syntax

POST /automationrules/get HTTP/1.1 Content-type: application/json { "AutomationRulesArns": [ "string" ] }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

AutomationRulesArns

A list of rule ARNs to get details for.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 100 items.

Pattern: .*\S.*

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "Rules": [ { "Actions": [ { "FindingFieldsUpdate": { "Confidence": number, "Criticality": number, "Note": { "Text": "string", "UpdatedBy": "string" }, "RelatedFindings": [ { "Id": "string", "ProductArn": "string" } ], "Severity": { "Label": "string", "Normalized": number, "Product": number }, "Types": [ "string" ], "UserDefinedFields": { "string" : "string" }, "VerificationState": "string", "Workflow": { "Status": "string" } }, "Type": "string" } ], "CreatedAt": "string", "CreatedBy": "string", "Criteria": { "AwsAccountId": [ { "Comparison": "string", "Value": "string" } ], "AwsAccountName": [ { "Comparison": "string", "Value": "string" } ], "CompanyName": [ { "Comparison": "string", "Value": "string" } ], "ComplianceAssociatedStandardsId": [ { "Comparison": "string", "Value": "string" } ], "ComplianceSecurityControlId": [ { "Comparison": "string", "Value": "string" } ], "ComplianceStatus": [ { "Comparison": "string", "Value": "string" } ], "Confidence": [ { "Eq": number, "Gt": number, "Gte": number, "Lt": number, "Lte": number } ], "CreatedAt": [ { "DateRange": { "Unit": "string", "Value": number }, "End": "string", "Start": "string" } ], "Criticality": [ { "Eq": number, "Gt": number, "Gte": number, "Lt": number, "Lte": number } ], "Description": [ { "Comparison": "string", "Value": "string" } ], "FirstObservedAt": [ { "DateRange": { "Unit": "string", "Value": number }, "End": "string", "Start": "string" } ], "GeneratorId": [ { "Comparison": "string", "Value": "string" } ], "Id": [ { "Comparison": "string", "Value": "string" } ], "LastObservedAt": [ { "DateRange": { "Unit": "string", "Value": number }, "End": "string", "Start": "string" } ], "NoteText": [ { "Comparison": "string", "Value": "string" } ], "NoteUpdatedAt": [ { "DateRange": { "Unit": "string", "Value": number }, "End": "string", "Start": "string" } ], "NoteUpdatedBy": [ { "Comparison": "string", "Value": "string" } ], "ProductArn": [ { "Comparison": "string", "Value": "string" } ], "ProductName": [ { "Comparison": "string", "Value": "string" } ], "RecordState": [ { "Comparison": "string", "Value": "string" } ], "RelatedFindingsId": [ { "Comparison": "string", "Value": "string" } ], "RelatedFindingsProductArn": [ { "Comparison": "string", "Value": "string" } ], "ResourceApplicationArn": [ { "Comparison": "string", "Value": "string" } ], "ResourceApplicationName": [ { "Comparison": "string", "Value": "string" } ], "ResourceDetailsOther": [ { "Comparison": "string", "Key": "string", "Value": "string" } ], "ResourceId": [ { "Comparison": "string", "Value": "string" } ], "ResourcePartition": [ { "Comparison": "string", "Value": "string" } ], "ResourceRegion": [ { "Comparison": "string", "Value": "string" } ], "ResourceTags": [ { "Comparison": "string", "Key": "string", "Value": "string" } ], "ResourceType": [ { "Comparison": "string", "Value": "string" } ], "SeverityLabel": [ { "Comparison": "string", "Value": "string" } ], "SourceUrl": [ { "Comparison": "string", "Value": "string" } ], "Title": [ { "Comparison": "string", "Value": "string" } ], "Type": [ { "Comparison": "string", "Value": "string" } ], "UpdatedAt": [ { "DateRange": { "Unit": "string", "Value": number }, "End": "string", "Start": "string" } ], "UserDefinedFields": [ { "Comparison": "string", "Key": "string", "Value": "string" } ], "VerificationState": [ { "Comparison": "string", "Value": "string" } ], "WorkflowStatus": [ { "Comparison": "string", "Value": "string" } ] }, "Description": "string", "IsTerminal": boolean, "RuleArn": "string", "RuleName": "string", "RuleOrder": number, "RuleStatus": "string", "UpdatedAt": "string" } ], "UnprocessedAutomationRules": [ { "ErrorCode": number, "ErrorMessage": "string", "RuleArn": "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.

Rules

A list of rule details for the provided rule ARNs.

Type: Array of AutomationRulesConfig objects

UnprocessedAutomationRules

A list of objects containing RuleArn, ErrorCode, and ErrorMessage. This parameter tells you which automation rules the request didn't retrieve and why.

Type: Array of UnprocessedAutomationRule objects

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

InternalException

Internal server error.

HTTP Status Code: 500

InvalidAccessException

The account doesn't have permission to perform this action.

HTTP Status Code: 401

InvalidInputException

The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

HTTP Status Code: 400

LimitExceededException

The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.

HTTP Status Code: 429

ResourceNotFoundException

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

HTTP Status Code: 404

See Also

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