Amazon CodeGuru Profiler · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Amazon CodeGuru Profiler Internal API

5 actions 5 updates phrasing extends openapi/amazon-codeguru-profiler-internal-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Amazon CodeGuru Profiler's API. It is a proposal applied on top of the contract, not a document Amazon CodeGuru Profiler publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/internal/findingsReports'].get
$.paths['/internal/profilingGroups/{profilingGroupName}/recommendations#endTime&startTime'].get
$.paths['/internal/profilingGroups/{profilingGroupName}/findingsReports#endTime&startTime'].get
$.paths['/internal/profilingGroups/{profilingGroupName}/anomalies/{anomalyInstanceId}/feedback'].post

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Amazon CodeGuru Profiler Internal API
  version: 1.0.0
extends: openapi/amazon-codeguru-profiler-internal-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/internal/findingsReports'].get
  update:
    x-apievangelist-phrasing:
      intent: Summarize findings reports across the account
      effect: read
      questions:
      - Which of my profiling groups have findings reports across my whole AWS account?
      - Can I see a CodeGuru Profiler findings summary for every profiling group at once?
      - Is there a way to limit the account-wide findings summary to daily profiles only?
      instructions:
      - text: Summarize the findings reports for all profiling groups in my account.
      - text: 'Show the account-wide findings summary, daily reports only: {dailyReportsOnly}.'
        slots:
          dailyReportsOnly: query.dailyReportsOnly
      - text: Get the next page of the account findings summary using token {nextToken}.
        slots:
          nextToken: query.nextToken
      method: generated
      generated: '2026-09-26'
- target: $.paths['/internal/profilingGroups/{profilingGroupName}/recommendations#endTime&startTime'].get
  update:
    x-apievangelist-phrasing:
      intent: Get performance recommendations for a profiling group
      effect: read
      questions:
      - What code performance recommendations does the profiler have for my application?
      - Can I get recommendations for a profiling group over a specific time window?
      - Which languages can profiler recommendations be returned in?
      instructions:
      - text: Get recommendations for profiling group {profilingGroupName} between {startTime} and {endTime}.
        slots:
          profilingGroupName: path.profilingGroupName
          startTime: query.startTime
          endTime: query.endTime
      - text: Show {profilingGroupName}'s performance recommendations from {startTime} to {endTime} in locale {locale}.
        slots:
          profilingGroupName: path.profilingGroupName
          startTime: query.startTime
          endTime: query.endTime
          locale: query.locale
      method: generated
      generated: '2026-09-26'
- target: $.paths['/internal/profilingGroups/{profilingGroupName}/findingsReports#endTime&startTime'].get
  update:
    x-apievangelist-phrasing:
      intent: List findings reports for a profiling group
      effect: read
      questions:
      - What findings reports are available for one profiling group in a given time range?
      - How do I list the analysis reports generated for a single profiling group?
      - Can I restrict a profiling group's report list to daily profiles?
      instructions:
      - text: List findings reports for profiling group {profilingGroupName} from {startTime} to {endTime}.
        slots:
          profilingGroupName: path.profilingGroupName
          startTime: query.startTime
          endTime: query.endTime
      - text: List up to {maxResults} daily findings reports for {profilingGroupName} between {startTime} and {endTime}.
        slots:
          maxResults: query.maxResults
          profilingGroupName: path.profilingGroupName
          startTime: query.startTime
          endTime: query.endTime
      method: generated
      generated: '2026-09-26'
- target: $.paths['/internal/profilingGroups/{profilingGroupName}/anomalies/{anomalyInstanceId}/feedback'].post
  update:
    x-apievangelist-phrasing:
      intent: Give feedback on a detected anomaly
      effect: write
      questions:
      - How do I tell the profiler whether a detected anomaly was useful?
      - Can I mark an anomaly as a false alarm and add a comment?
      instructions:
      - text: Mark anomaly {anomalyInstanceId} in profiling group {profilingGroupName} as {type} feedback.
        slots:
          anomalyInstanceId: path.anomalyInstanceId
          profilingGroupName: path.profilingGroupName
          type: requestBody.type
      - text: Send {type} feedback on anomaly {anomalyInstanceId} for {profilingGroupName} with the comment {comment}.
        slots:
          type: requestBody.type
          anomalyInstanceId: path.anomalyInstanceId
          profilingGroupName: path.profilingGroupName
          comment: requestBody.comment
      method: generated
      generated: '2026-09-26'