List Coverage

guardduty_list_coverage

R Documentation

Lists coverage details for your GuardDuty account

Description

Lists coverage details for your GuardDuty account. If you're a GuardDuty administrator, you can retrieve all resources associated with the active member accounts in your organization.

Make sure the accounts have Runtime Monitoring enabled and GuardDuty agent running on their resources.

Usage

guardduty_list_coverage(DetectorId, NextToken, MaxResults,
  FilterCriteria, SortCriteria)

Arguments

DetectorId

[required] The unique ID of the detector whose coverage details you want to retrieve.

NextToken

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

MaxResults

The maximum number of results to return in the response.

FilterCriteria

Represents the criteria used to filter the coverage details.

SortCriteria

Represents the criteria used to sort the coverage details.

Value

A list with the following syntax:

list(
  Resources = list(
    list(
      ResourceId = "string",
      DetectorId = "string",
      AccountId = "string",
      ResourceDetails = list(
        EksClusterDetails = list(
          ClusterName = "string",
          CoveredNodes = 123,
          CompatibleNodes = 123,
          AddonDetails = list(
            AddonVersion = "string",
            AddonStatus = "string"
          ),
          ManagementType = "AUTO_MANAGED"|"MANUAL"|"DISABLED"
        ),
        ResourceType = "EKS"|"ECS"|"EC2",
        EcsClusterDetails = list(
          ClusterName = "string",
          FargateDetails = list(
            Issues = list(
              "string"
            ),
            ManagementType = "AUTO_MANAGED"|"MANUAL"|"DISABLED"
          ),
          ContainerInstanceDetails = list(
            CoveredContainerInstances = 123,
            CompatibleContainerInstances = 123
          )
        ),
        Ec2InstanceDetails = list(
          InstanceId = "string",
          InstanceType = "string",
          ClusterArn = "string",
          AgentDetails = list(
            Version = "string"
          ),
          ManagementType = "AUTO_MANAGED"|"MANUAL"|"DISABLED"
        )
      ),
      CoverageStatus = "HEALTHY"|"UNHEALTHY",
      Issue = "string",
      UpdatedAt = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_coverage(
  DetectorId = "string",
  NextToken = "string",
  MaxResults = 123,
  FilterCriteria = list(
    FilterCriterion = list(
      list(
        CriterionKey = "ACCOUNT_ID"|"CLUSTER_NAME"|"RESOURCE_TYPE"|"COVERAGE_STATUS"|"ADDON_VERSION"|"MANAGEMENT_TYPE"|"EKS_CLUSTER_NAME"|"ECS_CLUSTER_NAME"|"AGENT_VERSION"|"INSTANCE_ID"|"CLUSTER_ARN",
        FilterCondition = list(
          Equals = list(
            "string"
          ),
          NotEquals = list(
            "string"
          )
        )
      )
    )
  ),
  SortCriteria = list(
    AttributeName = "ACCOUNT_ID"|"CLUSTER_NAME"|"COVERAGE_STATUS"|"ISSUE"|"ADDON_VERSION"|"UPDATED_AT"|"EKS_CLUSTER_NAME"|"ECS_CLUSTER_NAME"|"INSTANCE_ID",
    OrderBy = "ASC"|"DESC"
  )
)