Describe Standards Controls

securityhub_describe_standards_controls

R Documentation

Returns a list of security standards controls

Description

Returns a list of security standards controls.

For each control, the results include information about whether it is currently enabled, the severity, and a link to remediation information.

Usage

securityhub_describe_standards_controls(StandardsSubscriptionArn,
  NextToken, MaxResults)

Arguments

StandardsSubscriptionArn

[required] The ARN of a resource that represents your subscription to a supported standard. To get the subscription ARNs of the standards you have enabled, use the get_enabled_standards operation.

NextToken

The token that is required for pagination. On your first call to the describe_standards_controls operation, set the value of this parameter to NULL.

For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.

MaxResults

The maximum number of security standard controls to return.

Value

A list with the following syntax:

list(
  Controls = list(
    list(
      StandardsControlArn = "string",
      ControlStatus = "ENABLED"|"DISABLED",
      DisabledReason = "string",
      ControlStatusUpdatedAt = as.POSIXct(
        "2015-01-01"
      ),
      ControlId = "string",
      Title = "string",
      Description = "string",
      RemediationUrl = "string",
      SeverityRating = "LOW"|"MEDIUM"|"HIGH"|"CRITICAL",
      RelatedRequirements = list(
        "string"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_standards_controls(
  StandardsSubscriptionArn = "string",
  NextToken = "string",
  MaxResults = 123
)

Examples

## Not run: 
# The following example returns a list of security controls and control
# details that apply to a specified security standard. The list includes
# controls that are enabled and disabled in the standard.
svc$describe_standards_controls(
  MaxResults = 2L,
  NextToken = "NULL",
  StandardsSubscriptionArn = "arn:aws:securityhub:us-west-1:123456789012:su..."
)

## End(Not run)