Get Recommended Policy V2

securityhub_get_recommended_policy_v2

R Documentation

Retrieves the recommended policy to remediate a Security Hub finding¶

Description¶

Retrieves the recommended policy to remediate a Security Hub finding. get_recommended_policy_v2 only supports findings for unused permissions.

Usage¶

securityhub_get_recommended_policy_v2(MetadataUid, NextToken,
  MaxResults)

Arguments¶

MetadataUid

[required] The unique identifier (ID) of Security Hub OCSF findings found under the metadata.uid field of the finding.

NextToken

The token used to paginate the RecommendationSteps list returned. On your first call to get_recommended_policy_v2, omit this parameter or set it to NULL. For subsequent calls, use the NextToken value returned in the previous response to retrieve the next page of results.

MaxResults

The maximum number of recommendation steps to return.

Value¶

A list with the following syntax:

list(
  NextToken = "string",
  RecommendationType = "UNUSED_PERMISSION_RECOMMENDATION",
  RecommendationSteps = list(
    list(
      UnusedPermissions = list(
        RecommendedAction = "string",
        ExistingPolicy = "string",
        ExistingPolicyId = "string",
        PolicyUpdatedAt = as.POSIXct(
          "2015-01-01"
        ),
        RecommendedPolicy = "string"
      )
    )
  ),
  Error = list(
    Code = "string",
    Message = "string"
  ),
  Status = "IN_PROGRESS"|"SUCCEEDED"|"FAILED",
  ResourceArn = "string"
)

Request syntax¶

svc$get_recommended_policy_v2(
  MetadataUid = "string",
  NextToken = "string",
  MaxResults = 123
)