Batch Get Configuration Policy Associations

securityhub_batch_get_configuration_policy_associations

R Documentation

Returns associations between an Security Hub configuration and a batch of target accounts, organizational units, or the root

Description

Returns associations between an Security Hub configuration and a batch of target accounts, organizational units, or the root. Only the Security Hub delegated administrator can invoke this operation from the home Region. A configuration can refer to a configuration policy or to a self-managed configuration.

Usage

securityhub_batch_get_configuration_policy_associations(
  ConfigurationPolicyAssociationIdentifiers)

Arguments

ConfigurationPolicyAssociationIdentifiers

[required] Specifies one or more target account IDs, organizational unit (OU) IDs, or the root ID to retrieve associations for.

Value

A list with the following syntax:

list(
  ConfigurationPolicyAssociations = 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"
    )
  ),
  UnprocessedConfigurationPolicyAssociations = list(
    list(
      ConfigurationPolicyAssociationIdentifiers = list(
        Target = list(
          AccountId = "string",
          OrganizationalUnitId = "string",
          RootId = "string"
        )
      ),
      ErrorCode = "string",
      ErrorReason = "string"
    )
  )
)

Request syntax

svc$batch_get_configuration_policy_associations(
  ConfigurationPolicyAssociationIdentifiers = list(
    list(
      Target = list(
        AccountId = "string",
        OrganizationalUnitId = "string",
        RootId = "string"
      )
    )
  )
)

Examples

## Not run: 
# This operation provides details about configuration associations for a
# batch of target accounts, organizational units, or the root.
svc$batch_get_configuration_policy_associations(
  ConfigurationPolicyAssociationIdentifiers = list(
    list(
      Target = list(
        AccountId = "111122223333"
      )
    ),
    list(
      Target = list(
        RootId = "r-f6g7h8i9j0example"
      )
    )
  )
)

## End(Not run)