Skip to content

List Controls

auditmanager_list_controls R Documentation

Returns a list of controls from Audit Manager

Description

Returns a list of controls from Audit Manager.

Usage

auditmanager_list_controls(controlType, nextToken, maxResults,
  controlCatalogId)

Arguments

controlType

[required] A filter that narrows the list of controls to a specific type.

nextToken

The pagination token that's used to fetch the next set of results.

maxResults

The maximum number of results on a page or for an API request call.

controlCatalogId

A filter that narrows the list of controls to a specific resource from the Amazon Web Services Control Catalog.

To use this parameter, specify the ARN of the Control Catalog resource. You can specify either a control domain, a control objective, or a common control. For information about how to find the ARNs for these resources, see ListDomains , ListObjectives , and ListCommonControls .

You can only filter by one Control Catalog resource at a time. Specifying multiple resource ARNs isn’t currently supported. If you want to filter by more than one ARN, we recommend that you run the list_controls operation separately for each ARN.

Alternatively, specify UNCATEGORIZED to list controls that aren't mapped to a Control Catalog resource. For example, this operation might return a list of custom controls that don't belong to any control domain or control objective.

Value

A list with the following syntax: 

list(
  controlMetadataList = list(
    list(
      arn = "string",
      id = "string",
      name = "string",
      controlSources = "string",
      createdAt = as.POSIXct(
        "2015-01-01"
      ),
      lastUpdatedAt = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  nextToken = "string"
)

Request syntax

svc$list_controls(
  controlType = "Standard"|"Custom"|"Core",
  nextToken = "string",
  maxResults = 123,
  controlCatalogId = "string"
)