Amazon CodeGuru Profiler · JSON Structure

Amazon Codeguru Profiler Agent Orchestration Config Structure

Specifies whether profiling is enabled or disabled for a profiling group. It is used by ConfigureAgent to enable or disable profiling for a profiling group.

Type: object Properties: 1 Required: 1
AmazonApplication PerformanceProfilingDevOpsMachine Learning

AgentOrchestrationConfig is a JSON Structure definition published by Amazon CodeGuru Profiler, describing 1 property, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

profilingEnabled

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-codeguru-profiler/refs/heads/main/json-structure/amazon-codeguru-profiler-agent-orchestration-config-structure.json",
  "name": "AgentOrchestrationConfig",
  "description": " 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. ",
  "type": "object",
  "properties": {
    "profilingEnabled": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Boolean"
        },
        {
          "description": " A <code>Boolean</code> that specifies whether the profiling agent collects profiling data or not. Set to <code>true</code> to enable profiling. "
        }
      ]
    }
  },
  "required": [
    "profilingEnabled"
  ]
}