Skip to content

List Automation Rules

securityhub_list_automation_rules R Documentation

A list of automation rules and their metadata for the calling account

Description

A list of automation rules and their metadata for the calling account.

Usage

securityhub_list_automation_rules(NextToken, MaxResults)

Arguments

NextToken

A token to specify where to start paginating the response. This is the NextToken from a previously truncated response. On your first call to the list_automation_rules API, set the value of this parameter to NULL.

MaxResults

The maximum number of rules to return in the response. This currently ranges from 1 to 100.

Value

A list with the following syntax:

list(
  AutomationRulesMetadata = list(
    list(
      RuleArn = "string",
      RuleStatus = "ENABLED"|"DISABLED",
      RuleOrder = 123,
      RuleName = "string",
      Description = "string",
      IsTerminal = TRUE|FALSE,
      CreatedAt = as.POSIXct(
        "2015-01-01"
      ),
      UpdatedAt = as.POSIXct(
        "2015-01-01"
      ),
      CreatedBy = "string"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_automation_rules(
  NextToken = "string",
  MaxResults = 123
)

Examples

## Not run: 
# The following example lists automation rules and rule metadata in the
# calling account.
svc$list_automation_rules(
  MaxResults = 2L,
  NextToken = "example-token"
)

## End(Not run)