Class: Aws::AuditManager::Types::ListControlsRequest

Inherits:

Struct

• Object
• Struct
• Aws::AuditManager::Types::ListControlsRequest

Includes:

Structure

Defined in:

lib/aws-sdk-auditmanager/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #control_catalog_id ⇒ String

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

• #control_type ⇒ String

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

• #max_results ⇒ Integer

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

• #next_token ⇒ String

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

Instance Attribute Details

#control_catalog_id ⇒ String

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` ][1], [ `ListObjectives` ][2], and [ `ListCommonControls` ][3].

<note markdown=“1”> 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 ‘ListControls` operation separately for each ARN.

</note>

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.

[1]: docs.aws.amazon.com/controlcatalog/latest/APIReference/API_ListDomains.html [2]: docs.aws.amazon.com/controlcatalog/latest/APIReference/API_ListObjectives.html [3]: docs.aws.amazon.com/controlcatalog/latest/APIReference/API_ListCommonControls.html

Returns:

• (String)

# File 'lib/aws-sdk-auditmanager/types.rb', line 3737

class ListControlsRequest < Struct.new(
  :control_type,
  :next_token,
  :max_results,
  :control_catalog_id)
  SENSITIVE = []
  include Aws::Structure
end

#control_type ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-auditmanager/types.rb', line 3737

class ListControlsRequest < Struct.new(
  :control_type,
  :next_token,
  :max_results,
  :control_catalog_id)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

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

Returns:

• (Integer)

# File 'lib/aws-sdk-auditmanager/types.rb', line 3737

class ListControlsRequest < Struct.new(
  :control_type,
  :next_token,
  :max_results,
  :control_catalog_id)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-auditmanager/types.rb', line 3737

class ListControlsRequest < Struct.new(
  :control_type,
  :next_token,
  :max_results,
  :control_catalog_id)
  SENSITIVE = []
  include Aws::Structure
end