CreateProfilingGroup - Amazon CodeGuru Profiler

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: AWSLambda | Default

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

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

profilingGroup

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

Type: ProfilingGroupDescription object

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

See Also

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