Batch Get Automation Rules

securityhub_batch_get_automation_rules

R Documentation

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

Description

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

Usage

securityhub_batch_get_automation_rules(AutomationRulesArns)

Arguments

AutomationRulesArns

[required] A list of rule ARNs to get details for.

Value

A list with the following syntax:

list(
  Rules = list(
    list(
      RuleArn = "string",
      RuleStatus = "ENABLED"|"DISABLED",
      RuleOrder = 123,
      RuleName = "string",
      Description = "string",
      IsTerminal = TRUE|FALSE,
      Criteria = list(
        ProductArn = list(
          list(
            Value = "string",
            Comparison = "EQUALS"|"PREFIX"|"NOT_EQUALS"|"PREFIX_NOT_EQUALS"|"CONTAINS"|"NOT_CONTAINS"
          )
        ),
        AwsAccountId = list(
          list(
            Value = "string",
            Comparison = "EQUALS"|"PREFIX"|"NOT_EQUALS"|"PREFIX_NOT_EQUALS"|"CONTAINS"|"NOT_CONTAINS"
          )
        ),
        Id = list(
          list(
            Value = "string",
            Comparison = "EQUALS"|"PREFIX"|"NOT_EQUALS"|"PREFIX_NOT_EQUALS"|"CONTAINS"|"NOT_CONTAINS"
          )
        ),
        GeneratorId = list(
          list(
            Value = "string",
            Comparison = "EQUALS"|"PREFIX"|"NOT_EQUALS"|"PREFIX_NOT_EQUALS"|"CONTAINS"|"NOT_CONTAINS"
          )
        ),
        Type = list(
          list(
            Value = "string",
            Comparison = "EQUALS"|"PREFIX"|"NOT_EQUALS"|"PREFIX_NOT_EQUALS"|"CONTAINS"|"NOT_CONTAINS"
          )
        ),
        FirstObservedAt = list(
          list(
            Start = "string",
            End = "string",
            DateRange = list(
              Value = 123,
              Unit = "DAYS"
            )
          )
        ),
        LastObservedAt = list(
          list(
            Start = "string",
            End = "string",
            DateRange = list(
              Value = 123,
              Unit = "DAYS"
            )
          )
        ),
        CreatedAt = list(
          list(
            Start = "string",
            End = "string",
            DateRange = list(
              Value = 123,
              Unit = "DAYS"
            )
          )
        ),
        UpdatedAt = list(
          list(
            Start = "string",
            End = "string",
            DateRange = list(
              Value = 123,
              Unit = "DAYS"
            )
          )
        ),
        Confidence = list(
          list(
            Gte = 123.0,
            Lte = 123.0,
            Eq = 123.0,
            Gt = 123.0,
            Lt = 123.0
          )
        ),
        Criticality = list(
          list(
            Gte = 123.0,
            Lte = 123.0,
            Eq = 123.0,
            Gt = 123.0,
            Lt = 123.0
          )
        ),
        Title = list(
          list(
            Value = "string",
            Comparison = "EQUALS"|"PREFIX"|"NOT_EQUALS"|"PREFIX_NOT_EQUALS"|"CONTAINS"|"NOT_CONTAINS"
          )
        ),
        Description = list(
          list(
            Value = "string",
            Comparison = "EQUALS"|"PREFIX"|"NOT_EQUALS"|"PREFIX_NOT_EQUALS"|"CONTAINS"|"NOT_CONTAINS"
          )
        ),
        SourceUrl = list(
          list(
            Value = "string",
            Comparison = "EQUALS"|"PREFIX"|"NOT_EQUALS"|"PREFIX_NOT_EQUALS"|"CONTAINS"|"NOT_CONTAINS"
          )
        ),
        ProductName = list(
          list(
            Value = "string",
            Comparison = "EQUALS"|"PREFIX"|"NOT_EQUALS"|"PREFIX_NOT_EQUALS"|"CONTAINS"|"NOT_CONTAINS"
          )
        ),
        CompanyName = list(
          list(
            Value = "string",
            Comparison = "EQUALS"|"PREFIX"|"NOT_EQUALS"|"PREFIX_NOT_EQUALS"|"CONTAINS"|"NOT_CONTAINS"
          )
        ),
        SeverityLabel = list(
          list(
            Value = "string",
            Comparison = "EQUALS"|"PREFIX"|"NOT_EQUALS"|"PREFIX_NOT_EQUALS"|"CONTAINS"|"NOT_CONTAINS"
          )
        ),
        ResourceType = list(
          list(
            Value = "string",
            Comparison = "EQUALS"|"PREFIX"|"NOT_EQUALS"|"PREFIX_NOT_EQUALS"|"CONTAINS"|"NOT_CONTAINS"
          )
        ),
        ResourceId = list(
          list(
            Value = "string",
            Comparison = "EQUALS"|"PREFIX"|"NOT_EQUALS"|"PREFIX_NOT_EQUALS"|"CONTAINS"|"NOT_CONTAINS"
          )
        ),
        ResourcePartition = list(
          list(
            Value = "string",
            Comparison = "EQUALS"|"PREFIX"|"NOT_EQUALS"|"PREFIX_NOT_EQUALS"|"CONTAINS"|"NOT_CONTAINS"
          )
        ),
        ResourceRegion = list(
          list(
            Value = "string",
            Comparison = "EQUALS"|"PREFIX"|"NOT_EQUALS"|"PREFIX_NOT_EQUALS"|"CONTAINS"|"NOT_CONTAINS"
          )
        ),
        ResourceTags = list(
          list(
            Key = "string",
            Value = "string",
            Comparison = "EQUALS"|"NOT_EQUALS"|"CONTAINS"|"NOT_CONTAINS"
          )
        ),
        ResourceDetailsOther = list(
          list(
            Key = "string",
            Value = "string",
            Comparison = "EQUALS"|"NOT_EQUALS"|"CONTAINS"|"NOT_CONTAINS"
          )
        ),
        ComplianceStatus = list(
          list(
            Value = "string",
            Comparison = "EQUALS"|"PREFIX"|"NOT_EQUALS"|"PREFIX_NOT_EQUALS"|"CONTAINS"|"NOT_CONTAINS"
          )
        ),
        ComplianceSecurityControlId = list(
          list(
            Value = "string",
            Comparison = "EQUALS"|"PREFIX"|"NOT_EQUALS"|"PREFIX_NOT_EQUALS"|"CONTAINS"|"NOT_CONTAINS"
          )
        ),
        ComplianceAssociatedStandardsId = list(
          list(
            Value = "string",
            Comparison = "EQUALS"|"PREFIX"|"NOT_EQUALS"|"PREFIX_NOT_EQUALS"|"CONTAINS"|"NOT_CONTAINS"
          )
        ),
        VerificationState = list(
          list(
            Value = "string",
            Comparison = "EQUALS"|"PREFIX"|"NOT_EQUALS"|"PREFIX_NOT_EQUALS"|"CONTAINS"|"NOT_CONTAINS"
          )
        ),
        WorkflowStatus = list(
          list(
            Value = "string",
            Comparison = "EQUALS"|"PREFIX"|"NOT_EQUALS"|"PREFIX_NOT_EQUALS"|"CONTAINS"|"NOT_CONTAINS"
          )
        ),
        RecordState = list(
          list(
            Value = "string",
            Comparison = "EQUALS"|"PREFIX"|"NOT_EQUALS"|"PREFIX_NOT_EQUALS"|"CONTAINS"|"NOT_CONTAINS"
          )
        ),
        RelatedFindingsProductArn = list(
          list(
            Value = "string",
            Comparison = "EQUALS"|"PREFIX"|"NOT_EQUALS"|"PREFIX_NOT_EQUALS"|"CONTAINS"|"NOT_CONTAINS"
          )
        ),
        RelatedFindingsId = list(
          list(
            Value = "string",
            Comparison = "EQUALS"|"PREFIX"|"NOT_EQUALS"|"PREFIX_NOT_EQUALS"|"CONTAINS"|"NOT_CONTAINS"
          )
        ),
        NoteText = list(
          list(
            Value = "string",
            Comparison = "EQUALS"|"PREFIX"|"NOT_EQUALS"|"PREFIX_NOT_EQUALS"|"CONTAINS"|"NOT_CONTAINS"
          )
        ),
        NoteUpdatedAt = list(
          list(
            Start = "string",
            End = "string",
            DateRange = list(
              Value = 123,
              Unit = "DAYS"
            )
          )
        ),
        NoteUpdatedBy = list(
          list(
            Value = "string",
            Comparison = "EQUALS"|"PREFIX"|"NOT_EQUALS"|"PREFIX_NOT_EQUALS"|"CONTAINS"|"NOT_CONTAINS"
          )
        ),
        UserDefinedFields = list(
          list(
            Key = "string",
            Value = "string",
            Comparison = "EQUALS"|"NOT_EQUALS"|"CONTAINS"|"NOT_CONTAINS"
          )
        ),
        ResourceApplicationArn = list(
          list(
            Value = "string",
            Comparison = "EQUALS"|"PREFIX"|"NOT_EQUALS"|"PREFIX_NOT_EQUALS"|"CONTAINS"|"NOT_CONTAINS"
          )
        ),
        ResourceApplicationName = list(
          list(
            Value = "string",
            Comparison = "EQUALS"|"PREFIX"|"NOT_EQUALS"|"PREFIX_NOT_EQUALS"|"CONTAINS"|"NOT_CONTAINS"
          )
        ),
        AwsAccountName = list(
          list(
            Value = "string",
            Comparison = "EQUALS"|"PREFIX"|"NOT_EQUALS"|"PREFIX_NOT_EQUALS"|"CONTAINS"|"NOT_CONTAINS"
          )
        )
      ),
      Actions = list(
        list(
          Type = "FINDING_FIELDS_UPDATE",
          FindingFieldsUpdate = list(
            Note = list(
              Text = "string",
              UpdatedBy = "string"
            ),
            Severity = list(
              Normalized = 123,
              Product = 123.0,
              Label = "INFORMATIONAL"|"LOW"|"MEDIUM"|"HIGH"|"CRITICAL"
            ),
            VerificationState = "UNKNOWN"|"TRUE_POSITIVE"|"FALSE_POSITIVE"|"BENIGN_POSITIVE",
            Confidence = 123,
            Criticality = 123,
            Types = list(
              "string"
            ),
            UserDefinedFields = list(
              "string"
            ),
            Workflow = list(
              Status = "NEW"|"NOTIFIED"|"RESOLVED"|"SUPPRESSED"
            ),
            RelatedFindings = list(
              list(
                ProductArn = "string",
                Id = "string"
              )
            )
          )
        )
      ),
      CreatedAt = as.POSIXct(
        "2015-01-01"
      ),
      UpdatedAt = as.POSIXct(
        "2015-01-01"
      ),
      CreatedBy = "string"
    )
  ),
  UnprocessedAutomationRules = list(
    list(
      RuleArn = "string",
      ErrorCode = 123,
      ErrorMessage = "string"
    )
  )
)

Request syntax

svc$batch_get_automation_rules(
  AutomationRulesArns = list(
    "string"
  )
)

Examples

## Not run: 
# The following example updates the specified automation rules.
svc$batch_get_automation_rules(
  AutomationRulesArns = list(
    "arn:aws:securityhub:us-east-1:123456789012:automation-rule/a1b2c3d4-56...",
    "arn:aws:securityhub:us-east-1:123456789012:automation-rule/a1b2c3d4-56..."
  )
)

## End(Not run)