Skip to content

Returns a list of all insights checked for against the specified cluster

Description

Returns a list of all insights checked for against the specified cluster. You can filter which insights are returned by category, associated Kubernetes version, and status. The default filter lists all categories and every status.

The following lists the available categories:

  • UPGRADE_READINESS: Amazon EKS identifies issues that could impact your ability to upgrade to new versions of Kubernetes. These are called upgrade insights.
  • MISCONFIGURATION: Amazon EKS identifies misconfiguration in your EKS Hybrid Nodes setup that could impair functionality of your cluster or workloads. These are called configuration insights.

Usage

eks_list_insights(clusterName, filter, maxResults, nextToken)

Arguments

  • clusterName

    [required] The name of the Amazon EKS cluster associated with the insights.

  • filter

    The criteria to filter your list of insights for your cluster. You can filter which insights are returned by category, associated Kubernetes version, and status.

  • maxResults

    The maximum number of identity provider configurations returned by list_insights in paginated output. When you use this parameter, list_insights returns only maxResults results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another list_insights request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, list_insights returns up to 100 results and a nextToken value, if applicable.

  • nextToken

    The nextToken value returned from a previous paginated list_insights request. When the results of a list_insights request exceed maxResults, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

Value

A list with the following syntax:

list(
  insights = list(
    list(
      id = "string",
      name = "string",
      category = "UPGRADE_READINESS"|"MISCONFIGURATION"|"ROLLBACK_READINESS",
      kubernetesVersion = "string",
      lastRefreshTime = as.POSIXct(
        "2015-01-01"
      ),
      lastTransitionTime = as.POSIXct(
        "2015-01-01"
      ),
      description = "string",
      insightStatus = list(
        status = "PASSING"|"WARNING"|"ERROR"|"UNKNOWN",
        reason = "string"
      )
    )
  ),
  nextToken = "string"
)

Request syntax

svc$list_insights(
  clusterName = "string",
  filter = list(
    categories = list(
      "UPGRADE_READINESS"|"MISCONFIGURATION"|"ROLLBACK_READINESS"
    ),
    kubernetesVersions = list(
      "string"
    ),
    statuses = list(
      "PASSING"|"WARNING"|"ERROR"|"UNKNOWN"
    )
  ),
  maxResults = 123,
  nextToken = "string"
)