ListProfilingGroups - Amazon CodeGuru Profiler (original) (raw)

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

Request Syntax

GET /profilingGroups?includeDescription=includeDescription&maxResults=maxResults&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

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 ListProfilingGroups in paginated output. When this parameter is used, ListProfilingGroups 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 ListProfilingGroups request with the returned nextToken value.

Valid Range: Minimum value of 1. Maximum value of 1000.

nextToken

The nextToken value returned from a previous paginated ListProfilingGroups 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.

Note

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.

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[\w-]+$

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "profilingGroupNames": [ "string" ],
   "profilingGroups": [ 
      { 
         "agentOrchestrationConfig": { 
            "profilingEnabled": boolean
         },
         "arn": "string",
         "computePlatform": "string",
         "createdAt": "string",
         "name": "string",
         "profilingStatus": { 
            "latestAgentOrchestratedAt": "string",
            "latestAgentProfileReportedAt": "string",
            "latestAggregatedProfile": { 
               "period": "string",
               "start": "string"
            }
         },
         "tags": { 
            "string" : "string" 
         },
         "updatedAt": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

nextToken

The nextToken value to include in a future ListProfilingGroups request. When the results of a ListProfilingGroups request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[\w-]+$

profilingGroupNames

A returned list of profiling group names. A list of the names is returned only if includeDescription is false, otherwise a list of ProfilingGroupDescription objects is returned.

Type: Array of strings

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^[\w-]+$

profilingGroups

A returned list ProfilingGroupDescription objects. A list of ProfilingGroupDescription objects is returned only if includeDescription is true, otherwise a list of profiling group names is returned.

Type: Array of ProfilingGroupDescription objects

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerException

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

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: