POST

/profilingGroups#clientToken

http://codeguru-profiler.{region}.amazonaws.com/profilingGroups#clientToken

Creates a profiling group.

Access Token Required: API Key

Query Params

clientTokenstringrequired

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

Body Params

tagsobject

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

computePlatformstring

The compute platform of the profiling group. Use <code>AWSLambda</code> if your application runs on AWS Lambda. Use <code>Default</code> 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, <code>Default</code> is used.

profilingGroupNamestringrequired

The name of the profiling group to create.

agentOrchestrationConfigobject

Specifies whether profiling is enabled or disabled for a profiling group. It is used by <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ConfigureAgent.html"> <code>ConfigureAgent</code> </a> to enable or disable profiling for a profiling group.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://codeguru-profiler.{region}.amazonaws.com/profilingGroups#clientToken' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

1curl --request POST \ 2 --url 'http://codeguru-profiler.{region}.amazonaws.com/profilingGroups#clientToken' \ 3 --header 'accept: application/json' \ 4 --header 'content-type: application/json'