Skip to content

Batch Get Standards Control Associations

securityhub_batch_get_standards_control_associations R Documentation

For a batch of security controls and standards, identifies whether each control is currently enabled or disabled in a standard

Description

For a batch of security controls and standards, identifies whether each control is currently enabled or disabled in a standard.

Usage

securityhub_batch_get_standards_control_associations(
  StandardsControlAssociationIds)

Arguments

StandardsControlAssociationIds

[required] An array with one or more objects that includes a security control (identified with SecurityControlId, SecurityControlArn, or a mix of both parameters) and the Amazon Resource Name (ARN) of a standard. This field is used to query the enablement status of a control in a specified standard. The security control ID or ARN is the same across standards.

Value

A list with the following syntax:

list(
  StandardsControlAssociationDetails = list(
    list(
      StandardsArn = "string",
      SecurityControlId = "string",
      SecurityControlArn = "string",
      AssociationStatus = "ENABLED"|"DISABLED",
      RelatedRequirements = list(
        "string"
      ),
      UpdatedAt = as.POSIXct(
        "2015-01-01"
      ),
      UpdatedReason = "string",
      StandardsControlTitle = "string",
      StandardsControlDescription = "string",
      StandardsControlArns = list(
        "string"
      )
    )
  ),
  UnprocessedAssociations = list(
    list(
      StandardsControlAssociationId = list(
        SecurityControlId = "string",
        StandardsArn = "string"
      ),
      ErrorCode = "INVALID_INPUT"|"ACCESS_DENIED"|"NOT_FOUND"|"LIMIT_EXCEEDED",
      ErrorReason = "string"
    )
  )
)

Request syntax

svc$batch_get_standards_control_associations(
  StandardsControlAssociationIds = list(
    list(
      SecurityControlId = "string",
      StandardsArn = "string"
    )
  )
)

Examples

## Not run: 
# The following example retrieves the enablement status of the specified
# controls in the specified standards.
svc$batch_get_standards_control_associations(
  StandardsControlAssociationIds = list(
    list(
      SecurityControlId = "CloudTrail.1",
      StandardsArn = "arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0"
    ),
    list(
      SecurityControlId = "CloudWatch.12",
      StandardsArn = "arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0"
    )
  )
)

## End(Not run)