Skip to content

List Security Control Definitions

securityhub_list_security_control_definitions R Documentation

Lists all of the security controls that apply to a specified standard

Description

Lists all of the security controls that apply to a specified standard.

Usage

securityhub_list_security_control_definitions(StandardsArn, NextToken,
  MaxResults)

Arguments

StandardsArn

The Amazon Resource Name (ARN) of the standard that you want to view controls for.

NextToken

Optional pagination parameter.

MaxResults

An optional parameter that limits the total results of the API response to the specified number. If this parameter isn't provided in the request, the results include the first 25 security controls that apply to the specified standard. The results also include a NextToken parameter that you can use in a subsequent API call to get the next 25 controls. This repeats until all controls for the standard are returned.

Value

A list with the following syntax:

list(
  SecurityControlDefinitions = list(
    list(
      SecurityControlId = "string",
      Title = "string",
      Description = "string",
      RemediationUrl = "string",
      SeverityRating = "LOW"|"MEDIUM"|"HIGH"|"CRITICAL",
      CurrentRegionAvailability = "AVAILABLE"|"UNAVAILABLE",
      CustomizableProperties = list(
        "Parameters"
      ),
      ParameterDefinitions = list(
        list(
          Description = "string",
          ConfigurationOptions = list(
            Integer = list(
              DefaultValue = 123,
              Min = 123,
              Max = 123
            ),
            IntegerList = list(
              DefaultValue = list(
                123
              ),
              Min = 123,
              Max = 123,
              MaxItems = 123
            ),
            Double = list(
              DefaultValue = 123.0,
              Min = 123.0,
              Max = 123.0
            ),
            String = list(
              DefaultValue = "string",
              Re2Expression = "string",
              ExpressionDescription = "string"
            ),
            StringList = list(
              DefaultValue = list(
                "string"
              ),
              Re2Expression = "string",
              MaxItems = 123,
              ExpressionDescription = "string"
            ),
            Boolean = list(
              DefaultValue = TRUE|FALSE
            ),
            Enum = list(
              DefaultValue = "string",
              AllowedValues = list(
                "string"
              )
            ),
            EnumList = list(
              DefaultValue = list(
                "string"
              ),
              MaxItems = 123,
              AllowedValues = list(
                "string"
              )
            )
          )
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_security_control_definitions(
  StandardsArn = "string",
  NextToken = "string",
  MaxResults = 123
)

Examples

## Not run: 
# The following example lists security controls that apply to a specified
# Security Hub standard.
svc$list_security_control_definitions(
  MaxResults = 3L,
  NextToken = "NULL",
  StandardsArn = "arn:aws:securityhub:::standards/aws-foundational-security..."
)

## End(Not run)