Skip to content

List Profiling Groups

codeguruprofiler_list_profiling_groups R Documentation

Returns a list of profiling groups

Description

Returns a list of profiling groups. The profiling groups are returned as ProfilingGroupDescription objects.

Usage

codeguruprofiler_list_profiling_groups(includeDescription, maxResults,
  nextToken)

Arguments

includeDescription

A Boolean value indicating whether to include a description. If true, then a list of ProfilingGroupDescription objects that contain detailed information about profiling groups is returned. If false, then a list of profiling group names is returned.

maxResults

The maximum number of profiling groups results returned by list_profiling_groups in paginated output. When this parameter is used, list_profiling_groups only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another list_profiling_groups request with the returned nextToken value.

nextToken

The nextToken value returned from a previous paginated list_profiling_groups request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

Value

A list with the following syntax: 

list(
  nextToken = "string",
  profilingGroupNames = list(
    "string"
  ),
  profilingGroups = list(
    list(
      agentOrchestrationConfig = list(
        profilingEnabled = TRUE|FALSE
      ),
      arn = "string",
      computePlatform = "Default"|"AWSLambda",
      createdAt = as.POSIXct(
        "2015-01-01"
      ),
      name = "string",
      profilingStatus = list(
        latestAgentOrchestratedAt = as.POSIXct(
          "2015-01-01"
        ),
        latestAgentProfileReportedAt = as.POSIXct(
          "2015-01-01"
        ),
        latestAggregatedProfile = list(
          period = "PT5M"|"PT1H"|"P1D",
          start = as.POSIXct(
            "2015-01-01"
          )
        )
      ),
      tags = list(
        "string"
      ),
      updatedAt = as.POSIXct(
        "2015-01-01"
      )
    )
  )
)

Request syntax

svc$list_profiling_groups(
  includeDescription = TRUE|FALSE,
  maxResults = 123,
  nextToken = "string"
)