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

{
   "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.

agentOrchestrationConfig

An AgentOrchestrationConfig object that indicates if the profiling group is enabled for profiled or not.

Type: AgentOrchestrationConfig object

arn

The Amazon Resource Name (ARN) identifying the profiling group resource.

Type: String

computePlatform

The compute platform of the profiling group. If it is set to AWSLambda, then the profiled application runs on AWS Lambda. If it is set to Default, then the profiled application runs on a compute platform that is not AWS Lambda, such an Amazon EC2 instance, an on-premises server, or a different platform. The default is Default.

Type: String

Valid Values: Default | AWSLambda

createdAt

The time when the profiling group was created. Specify using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

Type: Timestamp

name

The name of the profiling group.

Type: String

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

Pattern: ^[\w-]+$

profilingStatus

A ProfilingStatus object that includes information about the last time a profile agent pinged back, the last time a profile was received, and the aggregation period and start time for the most recent aggregated profile.

Type: ProfilingStatus object

tags

A list of the tags that belong to this profiling group.

Type: String to string map

updatedAt

The date and time when the profiling group was last updated. Specify using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

Type: Timestamp

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