List Compliance Status

fms_list_compliance_status

R Documentation

Returns an array of PolicyComplianceStatus objects

Description

Returns an array of PolicyComplianceStatus objects. Use PolicyComplianceStatus to get a summary of which member accounts are protected by the specified policy.

Usage

fms_list_compliance_status(PolicyId, NextToken, MaxResults)

Arguments

PolicyId

[required] The ID of the Firewall Manager policy that you want the details for.

NextToken

If you specify a value for MaxResults and you have more PolicyComplianceStatus objects than the number that you specify for MaxResults, Firewall Manager returns a NextToken value in the response that allows you to list another group of PolicyComplianceStatus objects. For the second and subsequent list_compliance_status requests, specify the value of NextToken from the previous response to get information about another batch of PolicyComplianceStatus objects.

MaxResults

Specifies the number of PolicyComplianceStatus objects that you want Firewall Manager to return for this request. If you have more PolicyComplianceStatus objects than the number that you specify for MaxResults, the response includes a NextToken value that you can use to get another batch of PolicyComplianceStatus objects.

Value

A list with the following syntax:

list(
  PolicyComplianceStatusList = list(
    list(
      PolicyOwner = "string",
      PolicyId = "string",
      PolicyName = "string",
      MemberAccount = "string",
      EvaluationResults = list(
        list(
          ComplianceStatus = "COMPLIANT"|"NON_COMPLIANT",
          ViolatorCount = 123,
          EvaluationLimitExceeded = TRUE|FALSE
        )
      ),
      LastUpdated = as.POSIXct(
        "2015-01-01"
      ),
      IssueInfoMap = list(
        "string"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_compliance_status(
  PolicyId = "string",
  NextToken = "string",
  MaxResults = 123
)