Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DescribeProfilingGroup

Returns a ProfilingGroupDescription object that contains information about the requested profiling group.

Request Syntax


GET /profilingGroups/profilingGroupName HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

profilingGroupName

The name of the profiling group to get information about.

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

Pattern: ^[\w-]+$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "profilingGroup": { 
      "agentOrchestrationConfig": { 
         "profilingEnabled": boolean
      },
      "arn": "string",
      "computePlatform": "string",
      "createdAt": number,
      "name": "string",
      "profilingStatus": { 
         "latestAgentOrchestratedAt": number,
         "latestAgentProfileReportedAt": number,
         "latestAggregatedProfile": { 
            "period": "string",
            "start": number
         }
      },
      "tags": { 
         "string" : "string" 
      },
      "updatedAt": number
   }
}

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.

profilingGroup

The returned ProfilingGroupDescription object that contains information about the requested profiling group.

Type: ProfilingGroupDescription object

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

ResourceNotFoundException

The resource specified in the request does not exist.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The parameter is not valid.

HTTP Status Code: 400