Skip to content

List Configuration Policy Associations

securityhub_list_configuration_policy_associations R Documentation

Provides information about the associations for your configuration policies and self-managed behavior

Description

Provides information about the associations for your configuration policies and self-managed behavior. Only the Security Hub delegated administrator can invoke this operation from the home Region.

Usage

securityhub_list_configuration_policy_associations(NextToken,
  MaxResults, Filters)

Arguments

NextToken

The NextToken value that's returned from a previous paginated list_configuration_policy_associations request where MaxResults was used but the results exceeded the value of that parameter. Pagination continues from the end of the previous response that returned the NextToken value. This value is null when there are no more results to return.

MaxResults

The maximum number of results that's returned by list_configuration_policies in each page of the response. When this parameter is used, list_configuration_policy_associations returns the specified number of results in a single page and a NextToken response element. You can see the remaining results of the initial request by sending another list_configuration_policy_associations request with the returned NextToken value. A valid range for MaxResults is between 1 and 100.

Filters

Options for filtering the list_configuration_policy_associations response. You can filter by the Amazon Resource Name (ARN) or universally unique identifier (UUID) of a configuration, AssociationType, or AssociationStatus.

Value

A list with the following syntax:

list(
  ConfigurationPolicyAssociationSummaries = list(
    list(
      ConfigurationPolicyId = "string",
      TargetId = "string",
      TargetType = "ACCOUNT"|"ORGANIZATIONAL_UNIT"|"ROOT",
      AssociationType = "INHERITED"|"APPLIED",
      UpdatedAt = as.POSIXct(
        "2015-01-01"
      ),
      AssociationStatus = "PENDING"|"SUCCESS"|"FAILED",
      AssociationStatusMessage = "string"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_configuration_policy_associations(
  NextToken = "string",
  MaxResults = 123,
  Filters = list(
    ConfigurationPolicyId = "string",
    AssociationType = "INHERITED"|"APPLIED",
    AssociationStatus = "PENDING"|"SUCCESS"|"FAILED"
  )
)

Examples

## Not run: 
# This operation lists all of the associations between targets and
# configuration policies or self-managed behavior. Targets can include
# accounts, organizational units, or the root.
svc$list_configuration_policy_associations(
  Filters = list(
    AssociationType = "APPLIED"
  ),
  MaxResults = 1L,
  NextToken = "U1FsdGVkX19nBV2zoh+Gou9NgnulLJHWpn9xnG4hqSOhvw3o2JqjI86QDxdf"
)

## End(Not run)