How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Amazon CodeGuru Profiler ProfilingGroups API

The ProfilingGroups API from Amazon CodeGuru Profiler — 12 operation(s) for profilinggroups.

Amazon CodeGuru Profiler ProfilingGroups API is one of 4 APIs that Amazon CodeGuru Profiler publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include ProfilingGroups. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 15 operations across 12 paths, and defines 61 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 4 base URLs: http://codeguru-profiler.{region}.amazonaws.com, https://codeguru-profiler.{region}.amazonaws.com, http://codeguru-profiler.{region}.amazonaws.com.cn, https://codeguru-profiler.{region}.amazonaws.com.cn.

15 operations 12 paths 61 schemas 3 DELETE6 GET4 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://codeguru-profiler.us-east-1.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Amazon CodeGuru Profiler ProfilingGroups API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 15

Across 12 paths, the API surfaces 15 operations — 3 DELETE, 6 GET, 4 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

ProfilingGroups 15
POST
/profilingGroups/{profilingGroupName}/notificationConfiguration
Amazon CodeGuru Profiler Add Notification Channels
AddNotificationChannels 8 params body → 200480481482483484485
GET
/profilingGroups/{profilingGroupName}/notificationConfiguration
Amazon CodeGuru Profiler Get Notification Configuration
GetNotificationConfiguration 8 params → 200480481482483
POST
/profilingGroups/{profilingGroupName}/frames/-/metrics
Amazon CodeGuru Profiler Batch Get Frame Metric Data
BatchGetFrameMetricData 12 params body → 200480481482483
POST
/profilingGroups/{profilingGroupName}/configureAgent
Amazon CodeGuru Profiler Configure Agent
ConfigureAgent 8 params body → 200480481482483
DELETE
/profilingGroups/{profilingGroupName}
Amazon CodeGuru Profiler Delete Profiling Group
DeleteProfilingGroup 8 params → 204480481482483484
GET
/profilingGroups/{profilingGroupName}
Amazon CodeGuru Profiler Describe Profiling Group
DescribeProfilingGroup 8 params → 200480481482483
PUT
/profilingGroups/{profilingGroupName}
Amazon CodeGuru Profiler Update Profiling Group
UpdateProfilingGroup 8 params body → 200480481482483484
GET
/profilingGroups/{profilingGroupName}/policy
Amazon CodeGuru Profiler Get Policy
GetPolicy 8 params → 200480481482
GET
/profilingGroups/{profilingGroupName}/profile
Amazon CodeGuru Profiler Get Profile
GetProfile 13 params → 200480481482483
GET
/profilingGroups/{profilingGroupName}/profileTimes#endTime&period&startTime
Amazon CodeGuru Profiler List Profile Times
ListProfileTimes 14 params → 200480481482483
GET
/profilingGroups
Amazon CodeGuru Profiler List Profiling Groups
ListProfilingGroups 10 params → 200480481
POST
/profilingGroups/{profilingGroupName}/agentProfile#Content-Type
Amazon CodeGuru Profiler Post Agent Profile
PostAgentProfile 10 params body → 204480481482483
PUT
/profilingGroups/{profilingGroupName}/policy/{actionGroup}
Amazon CodeGuru Profiler Put Permission
PutPermission 9 params body → 200480481482483484
DELETE
/profilingGroups/{profilingGroupName}/notificationConfiguration/{channelId}
Amazon CodeGuru Profiler Remove Notification Channel
RemoveNotificationChannel 9 params → 200480481482483
DELETE
/profilingGroups/{profilingGroupName}/policy/{actionGroup}#revisionId
Amazon CodeGuru Profiler Remove Permission
RemovePermission 10 params → 200480481482483484

Schemas 61

The contract defines 61 schemas that model the data the API accepts and returns. The most detailed are ProfilingGroupDescription (8 properties), BatchGetFrameMetricDataResponse (6 properties), AgentConfiguration (3 properties), FrameMetric (3 properties). Each schema is shown below with its type and property counts.

ComputePlatform
string
EventPublisher
string
ProfileTimes
array
FrameMetric
object
The frame name, metric type, and thread states. These are used to derive the value of the metric for the frame.
3 properties 3 required
ChannelId
string
ValidationException
AggregationPeriod
string
Boolean
boolean
RemoveNotificationChannelResponse
object
The structure representing the RemoveNotificationChannelResponse.
1 property
PutPermissionResponse
object
The structure representing the putPermissionResponse .
2 properties 2 required
ListProfileTimesResponse
object
The structure representing the listProfileTimesResponse.
2 properties 1 required
PaginationToken
string
ServiceQuotaExceededException
AgentConfiguration
object
The response of ConfigureAgent that specifies if an agent profiles or not and for how long to return profiling data.
3 properties 2 required
AddNotificationChannelsResponse
object
The structure representing the AddNotificationChannelsResponse.
1 property
AggregatedProfileTime
object
Specifies the aggregation period and aggregation start time for an aggregated profile. An aggregated profile is used to collect posted agent profiles during an…
2 properties
ListOfTimestamps
array
Principal
string
DescribeProfilingGroupResponse
object
The structure representing the describeProfilingGroupResponse.
1 property 1 required
Channels
array
ProfilingStatus
object
Profiling status includes information about the last time a profile agent pinged back, the last time a profile was received, and the aggregation period and sta…
3 properties
GetProfileResponse
object
The structure representing the getProfileResponse.
1 property 1 required
Channel
object
Notification medium for users to get alerted for events that occur in application profile. We support SNS topic as a notification channel.
3 properties 2 required
ListProfilingGroupsResponse
object
The structure representing the listProfilingGroupsResponse.
3 properties 1 required
AgentOrchestrationConfig
object
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.
1 property 1 required
GetPolicyResponse
object
The structure representing the getPolicyResponse .
2 properties 2 required
DeleteProfilingGroupResponse
object
The structure representing the deleteProfilingGroupResponse.
String
string
ConflictException
InternalServerException
MetricType
string
ProfilingGroupName
string
GetNotificationConfigurationResponse
object
The structure representing the GetNotificationConfigurationResponse.
1 property 1 required
Integer
integer
ChannelUri
string
Channel URI uniquely identifies a Notification Channel. TopicArn is the uri for an SNS channel, emailId is uri for an email channel etc. Currently we only supp…
ConfigureAgentResponse
object
The structure representing the configureAgentResponse.
1 property 1 required
RemovePermissionResponse
object
The structure representing the removePermissionResponse .
2 properties 2 required
ProfilingGroupNames
array
ProfilingGroupDescription
object
Contains information about a profiling group.
8 properties
AggregatedProfile
string
ThrottlingException
ThreadStates
array
UpdateProfilingGroupResponse
object
The structure representing the updateProfilingGroupResponse.
1 property 1 required
ProfileTime
object
Contains the start time of a profile.
1 property
AgentParameters
object
UnprocessedEndTimeMap
object
TagsMap
object
RevisionId
string
EventPublishers
array
NotificationConfiguration
object
The configuration for notifications stored for each profiling group. This includes up to to two channels and a list of event publishers associated with each ch…
1 property
ProfilingGroupDescriptions
array
BatchGetFrameMetricDataResponse
object
The structure representing the BatchGetFrameMetricDataResponse.
6 properties 6 required
FrameMetricData
array
ResourceNotFoundException
FrameMetricDatum
object
Information about a frame metric and its values.
2 properties 2 required
FrameMetricValues
array
PostAgentProfileResponse
object
The structure representing the postAgentProfileResponse.
ProfilingGroupArn
string
Timestamp
string
FrameMetricValue
number
TimestampStructure
object
A data type that contains a Timestamp object. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past…
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amazon-codeguru-profiler-profilinggroups-api-openapi.yml Raw ↑

Other APIs Amazon CodeGuru Profiler publishes across the network.

Amazon CodeGuru Profiler Internal API
Amazon CodeGuru Profiler ProfilingGroups#clientToken API
Amazon CodeGuru Profiler Tags API
Where this information came from

This is an independent, third-party profile of Amazon CodeGuru Profiler ProfilingGroups API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.