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

CreateProfilingGroup

Creates a profiling group.

Request Syntax


POST /profilingGroups?clientToken=clientToken HTTP/1.1
Content-type: application/json

{
   "agentOrchestrationConfig": { 
      "profilingEnabled": boolean
   },
   "computePlatform": "string",
   "profilingGroupName": "string",
   "tags": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request uses the following URI parameters.

clientToken

Amazon CodeGuru Profiler uses this universally unique identifier (UUID) to prevent the accidental creation of duplicate profiling groups if there are failures and retries.

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

Pattern: ^[\w-]+$

Required: Yes

Request Body

The request accepts the following data in JSON format.

agentOrchestrationConfig

Specifies whether profiling is enabled or disabled for the created profiling group.

Type: AgentOrchestrationConfig object

Required: No

computePlatform

The compute platform of the profiling group. Use AWSLambda if your application runs on AWS Lambda. Use Default if your application runs on a compute platform that is not AWS Lambda, such an Amazon EC2 instance, an on-premises server, or a different platform. If not specified, Default is used.

Type: String

Valid Values: Default | AWSLambda

Required: No

profilingGroupName

The name of the profiling group to create.

Type: String

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

Pattern: ^[\w-]+$

Required: Yes

tags

A list of tags to add to the created profiling group.

Type: String to string map

Required: No

Response Syntax


HTTP/1.1 201
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 201 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.

ConflictException

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

HTTP Status Code: 409

InternalServerException

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

HTTP Status Code: 500

ServiceQuotaExceededException

You have exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use Service Quotas to request a service quota increase.

HTTP Status Code: 402

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The parameter is not valid.

HTTP Status Code: 400