Class ListProfilingGroupsCommandProtected

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

Example

Use a bare-bones client and the command you need to make an API call.

import { CodeGuruProfilerClient, ListProfilingGroupsCommand } from "@aws-sdk/client-codeguruprofiler"; // ES Modules import
// const { CodeGuruProfilerClient, ListProfilingGroupsCommand } = require("@aws-sdk/client-codeguruprofiler"); // CommonJS import
const client = new CodeGuruProfilerClient(config);
const input = { // ListProfilingGroupsRequest
  nextToken: "STRING_VALUE",
  maxResults: Number("int"),
  includeDescription: true || false,
};
const command = new ListProfilingGroupsCommand(input);
const response = await client.send(command);
// { // ListProfilingGroupsResponse
//   profilingGroupNames: [ // ProfilingGroupNames // required
//     "STRING_VALUE",
//   ],
//   profilingGroups: [ // ProfilingGroupDescriptions
//     { // ProfilingGroupDescription
//       name: "STRING_VALUE",
//       agentOrchestrationConfig: { // AgentOrchestrationConfig
//         profilingEnabled: true || false, // required
//       },
//       arn: "STRING_VALUE",
//       createdAt: new Date("TIMESTAMP"),
//       updatedAt: new Date("TIMESTAMP"),
//       profilingStatus: { // ProfilingStatus
//         latestAgentProfileReportedAt: new Date("TIMESTAMP"),
//         latestAggregatedProfile: { // AggregatedProfileTime
//           start: new Date("TIMESTAMP"),
//           period: "STRING_VALUE",
//         },
//         latestAgentOrchestratedAt: new Date("TIMESTAMP"),
//       },
//       computePlatform: "STRING_VALUE",
//       tags: { // TagsMap
//         "<keys>": "STRING_VALUE",
//       },
//     },
//   ],
//   nextToken: "STRING_VALUE",
// };

Param

ListProfilingGroupsCommandInput

Returns

ListProfilingGroupsCommandOutput

See

• ListProfilingGroupsCommandInput for command's input shape.
• ListProfilingGroupsCommandOutput for command's response shape.
• config for CodeGuruProfilerClient's config shape.

Throws

InternalServerException (server fault)

The server encountered an internal error and is unable to complete the request.

Throws

ThrottlingException (client fault)

The request was denied due to request throttling.

Throws

CodeGuruProfilerServiceException

Base exception class for all service exceptions from CodeGuruProfiler service.