This section provides documentation for the Amazon CodeGuru Profiler API operations.
Amazon CodeGuru Profiler collects runtime performance data from your live applications, and provides recommendations that can help you fine-tune your application performance. Using machine learning algorithms, CodeGuru Profiler can help you find your most expensive lines of code and suggest ways you can improve efficiency and remove CPU bottlenecks.
Amazon CodeGuru Profiler provides different visualizations of profiling data to help you identify what code is running on the CPU, see how much time is consumed, and suggest ways to reduce CPU utilization.
Amazon CodeGuru Profiler currently supports applications written in all Java virtual machine (JVM) languages and Python. While CodeGuru Profiler supports both visualizations and recommendations for applications written in Java, it can also generate visualizations and a subset of recommendations for applications written in other JVM languages and Python.
For more information, see What is Amazon CodeGuru Profiler in the Amazon CodeGuru Profiler User Guide.
","x-logo":{"url":"https://twitter.com/awscloud/profile_image?size=original","backgroundColor":"#FFFFFF"},"termsOfService":"https://aws.amazon.com/service-terms/","contact":{"name":"Mike Ralphson","email":"mike.ralphson@gmail.com","url":"https://github.com/mermade/aws2openapi","x-twitter":"PermittedSoc"},"license":{"name":"Apache 2.0 License","url":"http://www.apache.org/licenses/"},"x-providerName":"amazonaws.com","x-serviceName":"codeguruprofiler","x-aws-signingName":"codeguru-profiler","x-origin":[{"contentType":"application/json","url":"https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/codeguruprofiler-2019-07-18.normal.json","converter":{"url":"https://github.com/mermade/aws2openapi","version":"1.0.0"},"x-apisguru-driver":"external"}],"x-apiClientRegistration":{"url":"https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct"},"x-apisguru-categories":["cloud"],"x-preferred":true},"externalDocs":{"description":"Amazon Web Services documentation","url":"https://docs.aws.amazon.com/codeguru-profiler/"},"servers":[{"url":"http://codeguru-profiler.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The Amazon CodeGuru Profiler multi-region endpoint"},{"url":"https://codeguru-profiler.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The Amazon CodeGuru Profiler multi-region endpoint"},{"url":"http://codeguru-profiler.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The Amazon CodeGuru Profiler endpoint for China (Beijing) and China (Ningxia)"},{"url":"https://codeguru-profiler.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The Amazon CodeGuru Profiler endpoint for China (Beijing) and China (Ningxia)"}],"x-hasEquivalentPaths":true,"paths":{"/profilingGroups/{profilingGroupName}/notificationConfiguration":{"post":{"operationId":"AddNotificationChannels","description":"Add up to 2 anomaly notifications channels for a profiling group.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddNotificationChannelsResponse"}}}},"480":{"description":"ServiceQuotaExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceQuotaExceededException"}}}},"481":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"482":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"483":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"484":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"485":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}}},"parameters":[{"name":"profilingGroupName","in":"path","required":true,"description":"The name of the profiling group that we are setting up notifications for.","schema":{"type":"string","pattern":"^[\\w-]+$","minLength":1,"maxLength":255}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["channels"],"properties":{"channels":{"description":"One or 2 channels to report to when anomalies are detected.","type":"array","items":{"$ref":"#/components/schemas/Channel"},"minItems":1,"maxItems":2}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetNotificationConfiguration","description":"Get the current configuration for anomaly notifications for a profiling group.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetNotificationConfigurationResponse"}}}},"480":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"481":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"482":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"483":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}}},"parameters":[{"name":"profilingGroupName","in":"path","required":true,"description":"The name of the profiling group we want to get the notification configuration for.","schema":{"type":"string","pattern":"^[\\w-]+$","minLength":1,"maxLength":255}}]}},"/profilingGroups/{profilingGroupName}/frames/-/metrics":{"post":{"operationId":"BatchGetFrameMetricData","description":" Returns the time series of values for a requested list of frame metrics from a time period.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchGetFrameMetricDataResponse"}}}},"480":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"481":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"482":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"483":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}}},"parameters":[{"name":"endTime","in":"query","required":false,"description":" The end time of the time period for the returned time series values. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC. ","schema":{"type":"string","format":"date-time"}},{"name":"period","in":"query","required":false,"description":" The duration of the frame metrics used to return the time series values. Specify using the ISO 8601 format. The maximum period duration is one day (PT24H or P1D). ","schema":{"type":"string","minLength":1,"maxLength":64}},{"name":"profilingGroupName","in":"path","required":true,"description":" The name of the profiling group associated with the the frame metrics used to return the time series values. ","schema":{"type":"string","pattern":"^[\\w-]+$","minLength":1,"maxLength":255}},{"name":"startTime","in":"query","required":false,"description":" The start time of the time period for the frame metrics used to return the time series values. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC. ","schema":{"type":"string","format":"date-time"}},{"name":"targetResolution","in":"query","required":false,"description":"The requested resolution of time steps for the returned time series of values. If the requested target resolution is not available due to data not being retained we provide a best effort result by falling back to the most granular available resolution after the target resolution. There are 3 valid values.
P1D — 1 day
PT1H — 1 hour
PT5M — 5 minutes
ConfigureAgent can be used to tell an agent whether to profile or not and for how long to return profiling data. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigureAgentResponse"}}}},"480":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"481":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"482":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"483":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}}},"parameters":[{"name":"profilingGroupName","in":"path","required":true,"description":" The name of the profiling group for which the configured agent is collecting profiling data. ","schema":{"type":"string","pattern":"^[\\w-]+$","minLength":1,"maxLength":255}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"fleetInstanceId":{"description":" A universally unique identifier (UUID) for a profiling instance. For example, if the profiling instance is an Amazon EC2 instance, it is the instance ID. If it is an AWS Fargate container, it is the container's task ID. ","type":"string","minLength":1,"maxLength":255},"metadata":{"description":"Metadata captured about the compute platform the agent is running on. It includes information about sampling and reporting. The valid fields are:
COMPUTE_PLATFORM - The compute platform on which the agent is running
AGENT_ID - The ID for an agent instance.
AWS_REQUEST_ID - The AWS request ID of a Lambda invocation.
EXECUTION_ENVIRONMENT - The execution environment a Lambda function is running on.
LAMBDA_FUNCTION_ARN - The Amazon Resource Name (ARN) that is used to invoke a Lambda function.
LAMBDA_MEMORY_LIMIT_IN_MB - The memory allocated to a Lambda function.
LAMBDA_REMAINING_TIME_IN_MILLISECONDS - The time in milliseconds before execution of a Lambda function times out.
LAMBDA_TIME_GAP_BETWEEN_INVOKES_IN_MILLISECONDS - The time in milliseconds between two invocations of a Lambda function.
LAMBDA_PREVIOUS_EXECUTION_TIME_IN_MILLISECONDS - The time in milliseconds for the previous Lambda invocation.
ConfigureAgent to enable or disable profiling for a profiling group. ","type":"object","properties":{"profilingEnabled":{"allOf":[{"$ref":"#/components/schemas/Boolean"},{"description":" A Boolean that specifies whether the profiling agent collects profiling data or not. Set to true to enable profiling. "}]}}},"computePlatform":{"description":" 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","enum":["Default","AWSLambda"]},"profilingGroupName":{"description":"The name of the profiling group to create.","type":"string","pattern":"^[\\w-]+$","minLength":1,"maxLength":255},"tags":{"description":" A list of tags to add to the created profiling group. ","type":"object","additionalProperties":{"$ref":"#/components/schemas/String"}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/profilingGroups/{profilingGroupName}":{"delete":{"operationId":"DeleteProfilingGroup","description":"Deletes a profiling group.","responses":{"204":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteProfilingGroupResponse"}}}},"480":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"483":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"484":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}}},"parameters":[{"name":"profilingGroupName","in":"path","required":true,"description":"The name of the profiling group to delete.","schema":{"type":"string","pattern":"^[\\w-]+$","minLength":1,"maxLength":255}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"DescribeProfilingGroup","description":" Returns a ProfilingGroupDescription object that contains information about the requested profiling group. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DescribeProfilingGroupResponse"}}}},"480":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"481":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"482":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"483":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}}},"parameters":[{"name":"profilingGroupName","in":"path","required":true,"description":" The name of the profiling group to get information about. ","schema":{"type":"string","pattern":"^[\\w-]+$","minLength":1,"maxLength":255}}]},"put":{"operationId":"UpdateProfilingGroup","description":"Updates a profiling group.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateProfilingGroupResponse"}}}},"480":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"483":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"484":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}}},"parameters":[{"name":"profilingGroupName","in":"path","required":true,"description":"The name of the profiling group to update.","schema":{"type":"string","pattern":"^[\\w-]+$","minLength":1,"maxLength":255}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["agentOrchestrationConfig"],"properties":{"agentOrchestrationConfig":{"description":" 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":{"profilingEnabled":{"allOf":[{"$ref":"#/components/schemas/Boolean"},{"description":" A Boolean that specifies whether the profiling agent collects profiling data or not. Set to true to enable profiling. "}]}}}}}}}}}},"/internal/findingsReports":{"get":{"operationId":"GetFindingsReportAccountSummary","description":" Returns a list of FindingsReportSummary objects that contain analysis results for all profiling groups in your AWS account. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetFindingsReportAccountSummaryResponse"}}}},"480":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"481":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"482":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}}},"parameters":[{"name":"dailyReportsOnly","in":"query","required":false,"description":"A Boolean value indicating whether to only return reports from daily profiles. If set to True, only analysis data from daily profiles is returned. If set to False, analysis data is returned from smaller time windows (for example, one hour).","schema":{"type":"boolean"}},{"name":"maxResults","in":"query","required":false,"description":"The maximum number of results returned by GetFindingsReportAccountSummary in paginated output. When this parameter is used, GetFindingsReportAccountSummary only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another GetFindingsReportAccountSummary request with the returned nextToken value.","schema":{"type":"integer","minimum":1,"maximum":1000}},{"name":"nextToken","in":"query","required":false,"description":"The nextToken value returned from a previous paginated GetFindingsReportAccountSummary request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
Gets the aggregated profile of a profiling group for a specified time range. Amazon CodeGuru Profiler collects posted agent profiles for a profiling group into aggregated profiles.
<note> <p> Because aggregated profiles expire over time <code>GetProfile</code> is not idempotent. </p> </note> <p> Specify the time range for the requested aggregated profile using 1 or 2 of the following parameters: <code>startTime</code>, <code>endTime</code>, <code>period</code>. The maximum time range allowed is 7 days. If you specify all 3 parameters, an exception is thrown. If you specify only <code>period</code>, the latest aggregated profile is returned. </p> <p> Aggregated profiles are available with aggregation periods of 5 minutes, 1 hour, and 1 day, aligned to UTC. The aggregation period of an aggregated profile determines how long it is retained. For more information, see <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_AggregatedProfileTime.html"> <code>AggregatedProfileTime</code> </a>. The aggregated profile's aggregation period determines how long it is retained by CodeGuru Profiler. </p> <ul> <li> <p> If the aggregation period is 5 minutes, the aggregated profile is retained for 15 days. </p> </li> <li> <p> If the aggregation period is 1 hour, the aggregated profile is retained for 60 days. </p> </li> <li> <p> If the aggregation period is 1 day, the aggregated profile is retained for 3 years. </p> </li> </ul> <p>There are two use cases for calling <code>GetProfile</code>.</p> <ol> <li> <p> If you want to return an aggregated profile that already exists, use <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ListProfileTimes.html"> <code>ListProfileTimes</code> </a> to view the time ranges of existing aggregated profiles. Use them in a <code>GetProfile</code> request to return a specific, existing aggregated profile. </p> </li> <li> <p> If you want to return an aggregated profile for a time range that doesn't align with an existing aggregated profile, then CodeGuru Profiler makes a best effort to combine existing aggregated profiles from the requested time range and return them as one aggregated profile. </p> <p> If aggregated profiles do not exist for the full time range requested, then aggregated profiles for a smaller time range are returned. For example, if the requested time range is from 00:00 to 00:20, and the existing aggregated profiles are from 00:15 and 00:25, then the aggregated profiles from 00:15 to 00:20 are returned. </p> </li> </ol> The format of the returned profiling data. The format maps to the Accept and Content-Type headers of the HTTP request. You can specify one of the following: or the default .
<ul> <li> <p> <code>application/json</code> — standard JSON format </p> </li> <li> <p> <code>application/x-amzn-ion</code> — the Amazon Ion data format. For more information, see <a href="http://amzn.github.io/ion-docs/">Amazon Ion</a>. </p> </li> </ul> The end time of the requested profile. Specify using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.
If you specify endTime, then you must also specify period or startTime, but not both.
A, which calls method B, which calls method C, which calls method D, then the depth is 4. If the maxDepth is set to 2, then the aggregated profile contains representations of methods A and B. ","schema":{"type":"integer","minimum":1,"maximum":10000}},{"name":"period","in":"query","required":false,"description":" Used with startTime or endTime to specify the time range for the returned aggregated profile. Specify using the ISO 8601 format. For example, P1DT1H1M1S.
<p> To get the latest aggregated profile, specify only <code>period</code>. </p> The start time of the profile to get. Specify using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.
<p> If you specify <code>startTime</code>, then you must also specify <code>period</code> or <code>endTime</code>, but not both. </p> Recommendation objects that contain recommendations for a profiling group for a given time period. A list of Anomaly objects that contains details about anomalies detected in the profiling group for the same time period is also returned. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRecommendationsResponse"}}}},"480":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"481":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"482":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"483":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}}},"parameters":[{"name":"endTime","in":"query","required":true,"description":" The start time of the profile to get analysis data about. You must specify startTime and endTime. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC. ","schema":{"type":"string","format":"date-time"}},{"name":"locale","in":"query","required":false,"description":" The language used to provide analysis. Specify using a string that is one of the following BCP 47 language codes.
de-DE - German, Germany
en-GB - English, United Kingdom
en-US - English, United States
es-ES - Spanish, Spain
fr-FR - French, France
it-IT - Italian, Italy
ja-JP - Japanese, Japan
ko-KR - Korean, Republic of Korea
pt-BR - Portugese, Brazil
zh-CN - Chinese, China
zh-TW - Chinese, Taiwan
startTime and endTime. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC. ","schema":{"type":"string","format":"date-time"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/internal/profilingGroups/{profilingGroupName}/findingsReports#endTime&startTime":{"get":{"operationId":"ListFindingsReports","description":"List the available reports for a given profiling group and time range.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListFindingsReportsResponse"}}}},"480":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"481":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"482":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"483":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}}},"parameters":[{"name":"dailyReportsOnly","in":"query","required":false,"description":"A Boolean value indicating whether to only return reports from daily profiles. If set to True, only analysis data from daily profiles is returned. If set to False, analysis data is returned from smaller time windows (for example, one hour).","schema":{"type":"boolean"}},{"name":"endTime","in":"query","required":true,"description":" The end time of the profile to get analysis data about. You must specify startTime and endTime. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC. ","schema":{"type":"string","format":"date-time"}},{"name":"maxResults","in":"query","required":false,"description":"The maximum number of report results returned by ListFindingsReports in paginated output. When this parameter is used, ListFindingsReports only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListFindingsReports request with the returned nextToken value.","schema":{"type":"integer","minimum":1,"maximum":1000}},{"name":"nextToken","in":"query","required":false,"description":"The nextToken value returned from a previous paginated ListFindingsReportsRequest request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
startTime and endTime. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC. ","schema":{"type":"string","format":"date-time"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/profilingGroups/{profilingGroupName}/profileTimes#endTime&period&startTime":{"get":{"operationId":"ListProfileTimes","description":"Lists the start times of the available aggregated profiles of a profiling group for an aggregation period within the specified time range.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListProfileTimesResponse"}}}},"480":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"481":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"482":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"483":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}}},"parameters":[{"name":"endTime","in":"query","required":true,"description":"The end time of the time range from which to list the profiles.","schema":{"type":"string","format":"date-time"}},{"name":"maxResults","in":"query","required":false,"description":"The maximum number of profile time results returned by ListProfileTimes in paginated output. When this parameter is used, ListProfileTimes only returns maxResults results in a single page with a nextToken response element. The remaining results of the initial request can be seen by sending another ListProfileTimes request with the returned nextToken value. ","schema":{"type":"integer","minimum":1,"maximum":1000}},{"name":"nextToken","in":"query","required":false,"description":"The nextToken value returned from a previous paginated ListProfileTimes request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
TIMESTAMP_DESCENDING. ","schema":{"type":"string","enum":["TimestampDescending","TimestampAscending"]}},{"name":"period","in":"query","required":true,"description":"The aggregation period. This specifies the period during which an aggregation profile collects posted agent profiles for a profiling group. There are 3 valid values.
P1D — 1 day
PT1H — 1 hour
PT5M — 5 minutes
ProfilingGroupDescription objects. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListProfilingGroupsResponse"}}}},"480":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"481":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}}},"parameters":[{"name":"includeDescription","in":"query","required":false,"description":"A Boolean value indicating whether to include a description. If true, then a list of ProfilingGroupDescription objects that contain detailed information about profiling groups is returned. If false, then a list of profiling group names is returned.","schema":{"type":"boolean"}},{"name":"maxResults","in":"query","required":false,"description":"The maximum number of profiling groups results returned by ListProfilingGroups in paginated output. When this parameter is used, ListProfilingGroups only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListProfilingGroups request with the returned nextToken value. ","schema":{"type":"integer","minimum":1,"maximum":1000}},{"name":"nextToken","in":"query","required":false,"description":"The nextToken value returned from a previous paginated ListProfilingGroups request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
GetProfile . ","responses":{"204":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostAgentProfileResponse"}}}},"480":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"481":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"482":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"483":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}}},"parameters":[{"name":"Content-Type","in":"header","required":true,"description":" The format of the submitted profiling data. The format maps to the Accept and Content-Type headers of the HTTP request. You can specify one of the following: or the default .
<ul> <li> <p> <code>application/json</code> — standard JSON format </p> </li> <li> <p> <code>application/x-amzn-ion</code> — the Amazon Ion data format. For more information, see <a href="http://amzn.github.io/ion-docs/">Amazon Ion</a>. </p> </li> </ul> Adds permissions to a profiling group's resource-based policy that are provided using an action group. If a profiling group doesn't have a resource-based policy, one is created for it using the permissions in the action group and the roles and users in the principals parameter.
<p> The one supported action group that can be added is <code>agentPermission</code> which grants <code>ConfigureAgent</code> and <code>PostAgent</code> permissions. For more information, see <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-ug/resource-based-policies.html">Resource-based policies in CodeGuru Profiler</a> in the <i>Amazon CodeGuru Profiler User Guide</i>, <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ConfigureAgent.html"> <code>ConfigureAgent</code> </a>, and <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_PostAgentProfile.html"> <code>PostAgentProfile</code> </a>. </p> <p> The first time you call <code>PutPermission</code> on a profiling group, do not specify a <code>revisionId</code> because it doesn't have a resource-based policy. Subsequent calls must provide a <code>revisionId</code> to specify which revision of the resource-based policy to add the permissions to. </p> <p> The response contains the profiling group's JSON-formatted resource policy. </p> agentPermissions, which grants permission to perform actions required by the profiling agent, ConfigureAgent and PostAgentProfile permissions. ","schema":{"type":"string","enum":["agentPermissions"]}},{"name":"profilingGroupName","in":"path","required":true,"description":"The name of the profiling group to grant access to.","schema":{"type":"string","pattern":"^[\\w-]+$","minLength":1,"maxLength":255}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["principals"],"properties":{"principals":{"description":" A list ARNs for the roles and users you want to grant access to the profiling group. Wildcards are not are supported in the ARNs. ","type":"array","items":{"$ref":"#/components/schemas/Principal"},"minItems":1,"maxItems":50},"revisionId":{"description":" A universally unique identifier (UUID) for the revision of the policy you are adding to the profiling group. Do not specify this when you add permissions to a profiling group for the first time. If a policy already exists on the profiling group, you must specify the revisionId. ","type":"string","pattern":"[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/profilingGroups/{profilingGroupName}/notificationConfiguration/{channelId}":{"delete":{"operationId":"RemoveNotificationChannel","description":"Remove one anomaly notifications channel for a profiling group.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoveNotificationChannelResponse"}}}},"480":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"481":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"482":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"483":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}}},"parameters":[{"name":"channelId","in":"path","required":true,"description":"The id of the channel that we want to stop receiving notifications.","schema":{"type":"string","pattern":"[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"}},{"name":"profilingGroupName","in":"path","required":true,"description":"The name of the profiling group we want to change notification configuration for.","schema":{"type":"string","pattern":"^[\\w-]+$","minLength":1,"maxLength":255}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/profilingGroups/{profilingGroupName}/policy/{actionGroup}#revisionId":{"delete":{"operationId":"RemovePermission","description":" Removes permissions from a profiling group's resource-based policy that are provided using an action group. The one supported action group that can be removed is agentPermission which grants ConfigureAgent and PostAgent permissions. For more information, see Resource-based policies in CodeGuru Profiler in the Amazon CodeGuru Profiler User Guide, ConfigureAgent , and PostAgentProfile . ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemovePermissionResponse"}}}},"480":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"483":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"484":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}}},"parameters":[{"name":"actionGroup","in":"path","required":true,"description":" Specifies an action group that contains the permissions to remove from a profiling group's resource-based policy. One action group is supported, agentPermissions, which grants ConfigureAgent and PostAgentProfile permissions. ","schema":{"type":"string","enum":["agentPermissions"]}},{"name":"profilingGroupName","in":"path","required":true,"description":"The name of the profiling group.","schema":{"type":"string","pattern":"^[\\w-]+$","minLength":1,"maxLength":255}},{"name":"revisionId","in":"query","required":true,"description":" A universally unique identifier (UUID) for the revision of the resource-based policy from which you want to remove permissions. ","schema":{"type":"string","pattern":"[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/internal/profilingGroups/{profilingGroupName}/anomalies/{anomalyInstanceId}/feedback":{"post":{"operationId":"SubmitFeedback","description":"Sends feedback to CodeGuru Profiler about whether the anomaly detected by the analysis is useful or not.","responses":{"204":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitFeedbackResponse"}}}},"480":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"481":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"482":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"483":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}}},"parameters":[{"name":"anomalyInstanceId","in":"path","required":true,"description":"The universally unique identifier (UUID) of the AnomalyInstance object that is included in the analysis data.","schema":{"type":"string","pattern":"[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"}},{"name":"profilingGroupName","in":"path","required":true,"description":"The name of the profiling group that is associated with the analysis data.","schema":{"type":"string","pattern":"^[\\w-]+$","minLength":1,"maxLength":255}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["type"],"properties":{"comment":{"description":"Optional feedback about this anomaly.","type":"string"},"type":{"description":" The feedback tpye. Thee are two valid values, Positive and Negative. ","type":"string","enum":["Positive","Negative"]}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/tags/{resourceArn}#tagKeys":{"delete":{"operationId":"UntagResource","description":" Use to remove one or more tags from a resource. ","responses":{"204":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UntagResourceResponse"}}}},"480":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"481":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"482":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}}},"parameters":[{"name":"resourceArn","in":"path","required":true,"description":" The Amazon Resource Name (ARN) of the resource that contains the tags to remove. ","schema":{"type":"string"}},{"name":"tagKeys","in":"query","required":true,"description":" A list of tag keys. Existing tags of resources with keys in this list are removed from the specified resource. ","schema":{"type":"array","items":{"$ref":"#/components/schemas/String"}}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]}},"components":{"parameters":{"X-Amz-Content-Sha256":{"name":"X-Amz-Content-Sha256","in":"header","schema":{"type":"string"},"required":false},"X-Amz-Date":{"name":"X-Amz-Date","in":"header","schema":{"type":"string"},"required":false},"X-Amz-Algorithm":{"name":"X-Amz-Algorithm","in":"header","schema":{"type":"string"},"required":false},"X-Amz-Credential":{"name":"X-Amz-Credential","in":"header","schema":{"type":"string"},"required":false},"X-Amz-Security-Token":{"name":"X-Amz-Security-Token","in":"header","schema":{"type":"string"},"required":false},"X-Amz-Signature":{"name":"X-Amz-Signature","in":"header","schema":{"type":"string"},"required":false},"X-Amz-SignedHeaders":{"name":"X-Amz-SignedHeaders","in":"header","schema":{"type":"string"},"required":false}},"securitySchemes":{"hmac":{"type":"apiKey","name":"Authorization","in":"header","description":"Amazon Signature authorization v4","x-amazon-apigateway-authtype":"awsSigv4"}},"schemas":{"AddNotificationChannelsResponse":{"type":"object","properties":{"notificationConfiguration":{"allOf":[{"$ref":"#/components/schemas/NotificationConfiguration"},{"description":"The new notification configuration for this profiling group."}]}},"description":"The structure representing the AddNotificationChannelsResponse."},"Channel":{"type":"object","required":["eventPublishers","uri"],"properties":{"eventPublishers":{"allOf":[{"$ref":"#/components/schemas/EventPublishers"},{"description":"List of publishers for different type of events that may be detected in an application from the profile. Anomaly detection is the only event publisher in Profiler."}]},"id":{"allOf":[{"$ref":"#/components/schemas/ChannelId"},{"description":"Unique identifier for each Channel in the notification configuration of a Profiling Group. A random UUID for channelId is used when adding a channel to the notification configuration if not specified in the request."}]},"uri":{"allOf":[{"$ref":"#/components/schemas/ChannelUri"},{"description":"Unique arn of the resource to be used for notifications. We support a valid SNS topic arn as a channel uri."}]}},"description":"Notification medium for users to get alerted for events that occur in application profile. We support SNS topic as a notification channel."},"ServiceQuotaExceededException":{},"InternalServerException":{},"ConflictException":{},"ValidationException":{},"ThrottlingException":{},"ResourceNotFoundException":{},"BatchGetFrameMetricDataResponse":{"type":"object","required":["endTime","endTimes","frameMetricData","resolution","startTime","unprocessedEndTimes"],"properties":{"endTime":{"allOf":[{"$ref":"#/components/schemas/Timestamp"},{"description":" The end time of the time period for the returned time series values. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC. "}]},"endTimes":{"allOf":[{"$ref":"#/components/schemas/ListOfTimestamps"},{"description":" List of instances, or time steps, in the time series. For example, if the period is one day (PT24H)), and the resolution is five minutes (PT5M), then there are 288 endTimes in the list that are each five minutes appart. "}]},"frameMetricData":{"allOf":[{"$ref":"#/components/schemas/FrameMetricData"},{"description":"Details of the metrics to request a time series of values. The metric includes the name of the frame, the aggregation type to calculate the metric value for the frame, and the thread states to use to get the count for the metric value of the frame."}]},"resolution":{"allOf":[{"$ref":"#/components/schemas/AggregationPeriod"},{"description":"Resolution or granularity of the profile data used to generate the time series. This is the value used to jump through time steps in a time series. There are 3 valid values.
P1D — 1 day
PT1H — 1 hour
PT5M — 5 minutes
AggregatedRelativeTotalTime is an aggregation of the metric value for one frame that is calculated across the occurrences of all frames in a profile. "}]}},"description":" The frame name, metric type, and thread states. These are used to derive the value of the metric for the frame."},"ConfigureAgentResponse":{"type":"object","required":["configuration"],"properties":{"configuration":{"allOf":[{"$ref":"#/components/schemas/AgentConfiguration"},{"description":" An AgentConfiguration object that specifies if an agent profiles or not and for how long to return profiling data. "}]}},"description":"The structure representing the configureAgentResponse."},"String":{"type":"string"},"CreateProfilingGroupResponse":{"type":"object","required":["profilingGroup"],"properties":{"profilingGroup":{"allOf":[{"$ref":"#/components/schemas/ProfilingGroupDescription"},{"description":" The returned ProfilingGroupDescription object that contains information about the created profiling group. "}]}},"description":"The structure representing the createProfilingGroupResponse."},"Boolean":{"type":"boolean"},"DeleteProfilingGroupResponse":{"type":"object","properties":{},"description":"The structure representing the deleteProfilingGroupResponse."},"DescribeProfilingGroupResponse":{"type":"object","required":["profilingGroup"],"properties":{"profilingGroup":{"allOf":[{"$ref":"#/components/schemas/ProfilingGroupDescription"},{"description":" The returned ProfilingGroupDescription object that contains information about the requested profiling group. "}]}},"description":"The structure representing the describeProfilingGroupResponse."},"GetFindingsReportAccountSummaryResponse":{"type":"object","required":["reportSummaries"],"properties":{"nextToken":{"allOf":[{"$ref":"#/components/schemas/PaginationToken"},{"description":"The nextToken value to include in a future GetFindingsReportAccountSummary request. When the results of a GetFindingsReportAccountSummary request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return."}]},"reportSummaries":{"allOf":[{"$ref":"#/components/schemas/FindingsReportSummaries"},{"description":"The return list of FindingsReportSummary objects taht contain summaries of analysis results for all profiling groups in your AWS account."}]}},"description":"The structure representing the GetFindingsReportAccountSummaryResponse."},"GetNotificationConfigurationResponse":{"type":"object","required":["notificationConfiguration"],"properties":{"notificationConfiguration":{"allOf":[{"$ref":"#/components/schemas/NotificationConfiguration"},{"description":"The current notification configuration for this profiling group."}]}},"description":"The structure representing the GetNotificationConfigurationResponse."},"GetPolicyResponse":{"type":"object","required":["policy","revisionId"],"properties":{"policy":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The JSON-formatted resource-based policy attached to the ProfilingGroup."}]},"revisionId":{"allOf":[{"$ref":"#/components/schemas/RevisionId"},{"description":"A unique identifier for the current revision of the returned policy."}]}},"description":"The structure representing the getPolicyResponse."},"GetProfileResponse":{"type":"object","required":["profile"],"properties":{"profile":{"allOf":[{"$ref":"#/components/schemas/AggregatedProfile"},{"description":"Information about the profile."}]}},"description":"The structure representing the getProfileResponse."},"GetRecommendationsResponse":{"type":"object","required":["anomalies","profileEndTime","profileStartTime","profilingGroupName","recommendations"],"properties":{"anomalies":{"allOf":[{"$ref":"#/components/schemas/Anomalies"},{"description":" The list of anomalies that the analysis has found for this profile. "}]},"profileEndTime":{"allOf":[{"$ref":"#/components/schemas/Timestamp"},{"description":" The end time of the profile the analysis data is about. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC. "}]},"profileStartTime":{"allOf":[{"$ref":"#/components/schemas/Timestamp"},{"description":" The start time of the profile the analysis data is about. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC. "}]},"profilingGroupName":{"allOf":[{"$ref":"#/components/schemas/ProfilingGroupName"},{"description":"The name of the profiling group the analysis data is about."}]},"recommendations":{"allOf":[{"$ref":"#/components/schemas/Recommendations"},{"description":"The list of recommendations that the analysis found for this profile."}]}},"description":"The structure representing the GetRecommendationsResponse."},"ListFindingsReportsResponse":{"type":"object","required":["findingsReportSummaries"],"properties":{"findingsReportSummaries":{"allOf":[{"$ref":"#/components/schemas/FindingsReportSummaries"},{"description":"The list of analysis results summaries."}]},"nextToken":{"allOf":[{"$ref":"#/components/schemas/PaginationToken"},{"description":"The nextToken value to include in a future ListFindingsReports request. When the results of a ListFindingsReports request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return."}]}},"description":"The structure representing the ListFindingsReportsResponse."},"ListProfileTimesResponse":{"type":"object","required":["profileTimes"],"properties":{"nextToken":{"allOf":[{"$ref":"#/components/schemas/PaginationToken"},{"description":"The nextToken value to include in a future ListProfileTimes request. When the results of a ListProfileTimes request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return. "}]},"profileTimes":{"allOf":[{"$ref":"#/components/schemas/ProfileTimes"},{"description":"The list of start times of the available profiles for the aggregation period in the specified time range. "}]}},"description":"The structure representing the listProfileTimesResponse."},"ListProfilingGroupsResponse":{"type":"object","required":["profilingGroupNames"],"properties":{"nextToken":{"allOf":[{"$ref":"#/components/schemas/PaginationToken"},{"description":"The nextToken value to include in a future ListProfilingGroups request. When the results of a ListProfilingGroups request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return. "}]},"profilingGroupNames":{"allOf":[{"$ref":"#/components/schemas/ProfilingGroupNames"},{"description":" A returned list of profiling group names. A list of the names is returned only if includeDescription is false, otherwise a list of ProfilingGroupDescription objects is returned. "}]},"profilingGroups":{"allOf":[{"$ref":"#/components/schemas/ProfilingGroupDescriptions"},{"description":" A returned list ProfilingGroupDescription objects. A list of ProfilingGroupDescription objects is returned only if includeDescription is true, otherwise a list of profiling group names is returned. "}]}},"description":"The structure representing the listProfilingGroupsResponse."},"ListTagsForResourceResponse":{"type":"object","properties":{"tags":{"allOf":[{"$ref":"#/components/schemas/TagsMap"},{"description":" The list of tags assigned to the specified resource. This is the list of tags returned in the response. "}]}}},"PostAgentProfileResponse":{"type":"object","properties":{},"description":"The structure representing the postAgentProfileResponse."},"PutPermissionResponse":{"type":"object","required":["policy","revisionId"],"properties":{"policy":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":" The JSON-formatted resource-based policy on the profiling group that includes the added permissions. "}]},"revisionId":{"allOf":[{"$ref":"#/components/schemas/RevisionId"},{"description":" A universally unique identifier (UUID) for the revision of the resource-based policy that includes the added permissions. The JSON-formatted policy is in the policy element of the response. "}]}},"description":"The structure representing the putPermissionResponse."},"Principal":{"type":"string"},"RemoveNotificationChannelResponse":{"type":"object","properties":{"notificationConfiguration":{"allOf":[{"$ref":"#/components/schemas/NotificationConfiguration"},{"description":"The new notification configuration for this profiling group."}]}},"description":"The structure representing the RemoveNotificationChannelResponse."},"RemovePermissionResponse":{"type":"object","required":["policy","revisionId"],"properties":{"policy":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":" The JSON-formatted resource-based policy on the profiling group after the specified permissions were removed. "}]},"revisionId":{"allOf":[{"$ref":"#/components/schemas/RevisionId"},{"description":" A universally unique identifier (UUID) for the revision of the resource-based policy after the specified permissions were removed. The updated JSON-formatted policy is in the policy element of the response. "}]}},"description":"The structure representing the removePermissionResponse."},"SubmitFeedbackResponse":{"type":"object","properties":{},"description":"The structure representing the SubmitFeedbackResponse."},"TagResourceResponse":{"type":"object","properties":{}},"UntagResourceResponse":{"type":"object","properties":{}},"UpdateProfilingGroupResponse":{"type":"object","required":["profilingGroup"],"properties":{"profilingGroup":{"allOf":[{"$ref":"#/components/schemas/ProfilingGroupDescription"},{"description":" A ProfilingGroupDescription that contains information about the returned updated profiling group. "}]}},"description":"The structure representing the updateProfilingGroupResponse."},"ActionGroup":{"type":"string","enum":["agentPermissions"]},"Channels":{"type":"array","items":{"$ref":"#/components/schemas/Channel"},"minItems":1,"maxItems":2},"ProfilingGroupName":{"type":"string","pattern":"^[\\w-]+$","minLength":1,"maxLength":255},"AddNotificationChannelsRequest":{"type":"object","required":["channels"],"title":"AddNotificationChannelsRequest","properties":{"channels":{"allOf":[{"$ref":"#/components/schemas/Channels"},{"description":"One or 2 channels to report to when anomalies are detected."}]}},"description":"The structure representing the AddNotificationChannelsRequest."},"NotificationConfiguration":{"type":"object","properties":{"channels":{"allOf":[{"$ref":"#/components/schemas/Channels"},{"description":"List of up to two channels to be used for sending notifications for events detected from the application profile."}]}},"description":"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 channel."},"AgentParameters":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/String"}},"Integer":{"type":"integer"},"AgentConfiguration":{"type":"object","required":["periodInSeconds","shouldProfile"],"properties":{"agentParameters":{"allOf":[{"$ref":"#/components/schemas/AgentParameters"},{"description":"Parameters used by the profiler. The valid parameters are:
MaxStackDepth - The maximum depth of the stacks in the code that is represented in the profile. For example, if CodeGuru Profiler finds a method A, which calls method B, which calls method C, which calls method D, then the depth is 4. If the maxDepth is set to 2, then the profiler evaluates A and B.
MemoryUsageLimitPercent - The percentage of memory that is used by the profiler.
MinimumTimeForReportingInMilliseconds - The minimum time in milliseconds between sending reports.
ReportingIntervalInMilliseconds - The reporting interval in milliseconds used to report profiles.
SamplingIntervalInMilliseconds - The sampling interval in milliseconds that is used to profile samples.
ConfigureAgent . For example, if this is set to 300, the profiling agent calls ConfigureAgent every 5 minutes to submit the profiled data collected during that period. "}]},"shouldProfile":{"allOf":[{"$ref":"#/components/schemas/Boolean"},{"description":" A Boolean that specifies whether the profiling agent collects profiling data or not. Set to true to enable profiling. "}]}},"description":" The response of ConfigureAgent that specifies if an agent profiles or not and for how long to return profiling data. "},"AgentOrchestrationConfig":{"type":"object","required":["profilingEnabled"],"properties":{"profilingEnabled":{"allOf":[{"$ref":"#/components/schemas/Boolean"},{"description":" A Boolean that specifies whether the profiling agent collects profiling data or not. Set to true to enable profiling. "}]}},"description":" 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. "},"AgentParameterField":{"type":"string","enum":["SamplingIntervalInMilliseconds","ReportingIntervalInMilliseconds","MinimumTimeForReportingInMilliseconds","MemoryUsageLimitPercent","MaxStackDepth"]},"AgentProfile":{"type":"string"},"AggregatedProfile":{"type":"string"},"AggregationPeriod":{"type":"string","enum":["PT5M","PT1H","P1D"]},"Timestamp":{"type":"string","format":"date-time"},"AggregatedProfileTime":{"type":"object","properties":{"period":{"allOf":[{"$ref":"#/components/schemas/AggregationPeriod"},{"description":"The aggregation period. This indicates the period during which an aggregation profile collects posted agent profiles for a profiling group. Use one of three valid durations that are specified using the ISO 8601 format.
P1D — 1 day
PT1H — 1 hour
PT5M — 5 minutes
The time that aggregation of posted agent profiles for a profiling group starts. The aggregation profile contains profiles posted by the agent starting at this time for an aggregation period specified by the period property of the AggregatedProfileTime object.
Specify start using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.
AggregatedRelativeTotalTime is an aggregation of the metric value for one frame that is calculated across the occurences of all frames in a profile."}]}},"description":" Details about the metric that the analysis used when it detected the anomaly. The metric what is analyzed to create recommendations. It includes the name of the frame that was analyzed and the type and thread states used to derive the metric value for that frame. "},"UserFeedback":{"type":"object","required":["type"],"properties":{"type":{"allOf":[{"$ref":"#/components/schemas/FeedbackType"},{"description":"Optional Positive or Negative feedback submitted by the user about whether the recommendation is useful or not."}]}},"description":"Feedback that can be submitted for each instance of an anomaly by the user. Feedback is be used for improvements in generating recommendations for the application."},"AnomalyInstance":{"type":"object","required":["id","startTime"],"properties":{"endTime":{"allOf":[{"$ref":"#/components/schemas/Timestamp"},{"description":" The end time of the period during which the metric is flagged as anomalous. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC. "}]},"id":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":" The universally unique identifier (UUID) of an instance of an anomaly in a metric. "}]},"startTime":{"allOf":[{"$ref":"#/components/schemas/Timestamp"},{"description":" The start time of the period during which the metric is flagged as anomalous. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC. "}]},"userFeedback":{"allOf":[{"$ref":"#/components/schemas/UserFeedback"},{"description":"Feedback type on a specific instance of anomaly submitted by the user."}]}},"description":"The specific duration in which the metric is flagged as anomalous."},"AnomalyInstanceId":{"type":"string","pattern":"[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"},"FrameMetrics":{"type":"array","items":{"$ref":"#/components/schemas/FrameMetric"}},"Period":{"type":"string","minLength":1,"maxLength":64},"BatchGetFrameMetricDataRequest":{"type":"object","title":"BatchGetFrameMetricDataRequest","properties":{"frameMetrics":{"allOf":[{"$ref":"#/components/schemas/FrameMetrics"},{"description":" The details of the metrics that are used to request a time series of values. The metric includes the name of the frame, the aggregation type to calculate the metric value for the frame, and the thread states to use to get the count for the metric value of the frame."}]}},"description":"The structure representing the BatchGetFrameMetricDataRequest."},"ListOfTimestamps":{"type":"array","items":{"$ref":"#/components/schemas/TimestampStructure"}},"FrameMetricData":{"type":"array","items":{"$ref":"#/components/schemas/FrameMetricDatum"}},"UnprocessedEndTimeMap":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ListOfTimestamps"}},"EventPublishers":{"type":"array","items":{"$ref":"#/components/schemas/EventPublisher"},"minItems":1,"maxItems":1},"ChannelId":{"type":"string","pattern":"[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"},"ChannelUri":{"type":"string","description":"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 support SNS channels and thus required to be an ARN"},"ClientToken":{"type":"string","pattern":"^[\\w-]+$","minLength":1,"maxLength":64},"ComputePlatform":{"type":"string","enum":["Default","AWSLambda"]},"FleetInstanceId":{"type":"string","minLength":1,"maxLength":255},"Metadata":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/String"}},"ConfigureAgentRequest":{"type":"object","title":"ConfigureAgentRequest","properties":{"fleetInstanceId":{"allOf":[{"$ref":"#/components/schemas/FleetInstanceId"},{"description":" A universally unique identifier (UUID) for a profiling instance. For example, if the profiling instance is an Amazon EC2 instance, it is the instance ID. If it is an AWS Fargate container, it is the container's task ID. "}]},"metadata":{"allOf":[{"$ref":"#/components/schemas/Metadata"},{"description":"Metadata captured about the compute platform the agent is running on. It includes information about sampling and reporting. The valid fields are:
COMPUTE_PLATFORM - The compute platform on which the agent is running
AGENT_ID - The ID for an agent instance.
AWS_REQUEST_ID - The AWS request ID of a Lambda invocation.
EXECUTION_ENVIRONMENT - The execution environment a Lambda function is running on.
LAMBDA_FUNCTION_ARN - The Amazon Resource Name (ARN) that is used to invoke a Lambda function.
LAMBDA_MEMORY_LIMIT_IN_MB - The memory allocated to a Lambda function.
LAMBDA_REMAINING_TIME_IN_MILLISECONDS - The time in milliseconds before execution of a Lambda function times out.
LAMBDA_TIME_GAP_BETWEEN_INVOKES_IN_MILLISECONDS - The time in milliseconds between two invocations of a Lambda function.
LAMBDA_PREVIOUS_EXECUTION_TIME_IN_MILLISECONDS - The time in milliseconds for the previous Lambda invocation.
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. "}]},"profilingGroupName":{"allOf":[{"$ref":"#/components/schemas/ProfilingGroupName"},{"description":"The name of the profiling group to create."}]},"tags":{"allOf":[{"$ref":"#/components/schemas/TagsMap"},{"description":" A list of tags to add to the created profiling group. "}]}},"description":"The structure representing the createProfiliingGroupRequest."},"ProfilingGroupDescription":{"type":"object","properties":{"agentOrchestrationConfig":{"allOf":[{"$ref":"#/components/schemas/AgentOrchestrationConfig"},{"description":" An AgentOrchestrationConfig object that indicates if the profiling group is enabled for profiled or not. "}]},"arn":{"allOf":[{"$ref":"#/components/schemas/ProfilingGroupArn"},{"description":"The Amazon Resource Name (ARN) identifying the profiling group resource."}]},"computePlatform":{"allOf":[{"$ref":"#/components/schemas/ComputePlatform"},{"description":" The compute platform of the profiling group. If it is set to AWSLambda, then the profiled application runs on AWS Lambda. If it is set to Default, then the profiled application runs on a compute platform that is not AWS Lambda, such an Amazon EC2 instance, an on-premises server, or a different platform. The default is Default. "}]},"createdAt":{"allOf":[{"$ref":"#/components/schemas/Timestamp"},{"description":"The time when the profiling group was created. Specify using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC. "}]},"name":{"allOf":[{"$ref":"#/components/schemas/ProfilingGroupName"},{"description":"The name of the profiling group."}]},"profilingStatus":{"allOf":[{"$ref":"#/components/schemas/ProfilingStatus"},{"description":" A ProfilingStatus object that includes information about the last time a profile agent pinged back, the last time a profile was received, and the aggregation period and start time for the most recent aggregated profile. "}]},"tags":{"allOf":[{"$ref":"#/components/schemas/TagsMap"},{"description":" A list of the tags that belong to this profiling group. "}]},"updatedAt":{"allOf":[{"$ref":"#/components/schemas/Timestamp"},{"description":" The date and time when the profiling group was last updated. Specify using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC. "}]}},"description":" Contains information about a profiling group. "},"DeleteProfilingGroupRequest":{"type":"object","title":"DeleteProfilingGroupRequest","properties":{},"description":"The structure representing the deleteProfilingGroupRequest."},"DescribeProfilingGroupRequest":{"type":"object","title":"DescribeProfilingGroupRequest","properties":{},"description":"The structure representing the describeProfilingGroupRequest."},"Double":{"type":"number","format":"double"},"EventPublisher":{"type":"string","enum":["AnomalyDetection"]},"FeedbackType":{"type":"string","enum":["Positive","Negative"]},"FindingsReportId":{"type":"string","pattern":"[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"},"FindingsReportSummary":{"type":"object","properties":{"id":{"allOf":[{"$ref":"#/components/schemas/FindingsReportId"},{"description":"The universally unique identifier (UUID) of the recommendation report."}]},"profileEndTime":{"allOf":[{"$ref":"#/components/schemas/Timestamp"},{"description":" The end time of the period during which the metric is flagged as anomalous. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC. "}]},"profileStartTime":{"allOf":[{"$ref":"#/components/schemas/Timestamp"},{"description":"The start time of the profile the analysis data is about. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC."}]},"profilingGroupName":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The name of the profiling group that is associated with the analysis data."}]},"totalNumberOfFindings":{"allOf":[{"$ref":"#/components/schemas/Integer"},{"description":"The total number of different recommendations that were found by the analysis."}]}},"description":" Information about potential recommendations that might be created from the analysis of profiling data. "},"FindingsReportSummaries":{"type":"array","items":{"$ref":"#/components/schemas/FindingsReportSummary"}},"ThreadStates":{"type":"array","items":{"$ref":"#/components/schemas/String"}},"MetricType":{"type":"string","enum":["AggregatedRelativeTotalTime"]},"FrameMetricDatum":{"type":"object","required":["frameMetric","values"],"properties":{"frameMetric":{"$ref":"#/components/schemas/FrameMetric"},"values":{"allOf":[{"$ref":"#/components/schemas/FrameMetricValues"},{"description":" A list of values that are associated with a frame metric. "}]}},"description":" Information about a frame metric and its values. "},"FrameMetricValues":{"type":"array","items":{"$ref":"#/components/schemas/FrameMetricValue"}},"FrameMetricValue":{"type":"number","format":"double"},"MaxResults":{"type":"integer","minimum":1,"maximum":1000},"PaginationToken":{"type":"string","pattern":"^[\\w-]+$","minLength":1,"maxLength":64},"GetFindingsReportAccountSummaryRequest":{"type":"object","title":"GetFindingsReportAccountSummaryRequest","properties":{},"description":"The structure representing the GetFindingsReportAccountSummaryRequest."},"GetNotificationConfigurationRequest":{"type":"object","title":"GetNotificationConfigurationRequest","properties":{},"description":"The structure representing the GetNotificationConfigurationRequest."},"GetPolicyRequest":{"type":"object","title":"GetPolicyRequest","properties":{},"description":" The structure representing the getPolicyRequest. "},"RevisionId":{"type":"string","pattern":"[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"},"MaxDepth":{"type":"integer","minimum":1,"maximum":10000},"GetProfileRequest":{"type":"object","title":"GetProfileRequest","properties":{},"description":"The structure representing the getProfileRequest."},"Locale":{"type":"string","description":"BCP47 language code. Supported locales: de-DE, en-GB, en-US, es-ES, fr-FR, it-IT, ja-JP, ko-KR, pt-BR, zh-CN, zh-TW"},"GetRecommendationsRequest":{"type":"object","title":"GetRecommendationsRequest","properties":{},"description":"The structure representing the GetRecommendationsRequest."},"Recommendations":{"type":"array","items":{"$ref":"#/components/schemas/Recommendation"}},"ListFindingsReportsRequest":{"type":"object","title":"ListFindingsReportsRequest","properties":{},"description":"The structure representing the ListFindingsReportsRequest."},"TimestampStructure":{"type":"object","required":["value"],"properties":{"value":{"allOf":[{"$ref":"#/components/schemas/Timestamp"},{"description":" A Timestamp. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC. "}]}},"description":" 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 June 1, 2020 1:15:02 PM UTC. "},"OrderBy":{"type":"string","enum":["TimestampDescending","TimestampAscending"]},"ListProfileTimesRequest":{"type":"object","title":"ListProfileTimesRequest","properties":{},"description":"The structure representing the listProfileTimesRequest."},"ProfileTimes":{"type":"array","items":{"$ref":"#/components/schemas/ProfileTime"}},"ListProfilingGroupsRequest":{"type":"object","title":"ListProfilingGroupsRequest","properties":{},"description":"The structure representing the listProfilingGroupsRequest."},"ProfilingGroupNames":{"type":"array","items":{"$ref":"#/components/schemas/ProfilingGroupName"}},"ProfilingGroupDescriptions":{"type":"array","items":{"$ref":"#/components/schemas/ProfilingGroupDescription"}},"ProfilingGroupArn":{"type":"string"},"ListTagsForResourceRequest":{"type":"object","title":"ListTagsForResourceRequest","properties":{}},"Match":{"type":"object","properties":{"frameAddress":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The location in the profiling graph that contains a recommendation found during analysis."}]},"targetFramesIndex":{"allOf":[{"$ref":"#/components/schemas/Integer"},{"description":"The target frame that triggered a match."}]},"thresholdBreachValue":{"allOf":[{"$ref":"#/components/schemas/Double"},{"description":"The value in the profile data that exceeded the recommendation threshold."}]}},"description":"The part of a profile that contains a recommendation found during analysis."},"Matches":{"type":"array","items":{"$ref":"#/components/schemas/Match"}},"MetadataField":{"type":"string","enum":["ComputePlatform","AgentId","AwsRequestId","ExecutionEnvironment","LambdaFunctionArn","LambdaMemoryLimitInMB","LambdaRemainingTimeInMilliseconds","LambdaTimeGapBetweenInvokesInMilliseconds","LambdaPreviousExecutionTimeInMilliseconds"]},"Strings":{"type":"array","items":{"$ref":"#/components/schemas/String"}},"TargetFrames":{"type":"array","items":{"$ref":"#/components/schemas/TargetFrame"}},"Percentage":{"type":"number","format":"double","minimum":0,"maximum":100},"Pattern":{"type":"object","properties":{"countersToAggregate":{"allOf":[{"$ref":"#/components/schemas/Strings"},{"description":" A list of the different counters used to determine if there is a match. "}]},"description":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The description of the recommendation. This explains a potential inefficiency in a profiled application."}]},"id":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The universally unique identifier (UUID) of this pattern."}]},"name":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The name for this pattern."}]},"resolutionSteps":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":" A string that contains the steps recommended to address the potential inefficiency. "}]},"targetFrames":{"allOf":[{"$ref":"#/components/schemas/TargetFrames"},{"description":"A list of frame names that were searched during the analysis that generated a recommendation."}]},"thresholdPercent":{"allOf":[{"$ref":"#/components/schemas/Percentage"},{"description":" The percentage of time an application spends in one method that triggers a recommendation. The percentage of time is the same as the percentage of the total gathered sample counts during analysis. "}]}},"description":" A set of rules used to make a recommendation during an analysis. "},"PostAgentProfileRequest":{"type":"object","required":["agentProfile"],"title":"PostAgentProfileRequest","properties":{"agentProfile":{"allOf":[{"$ref":"#/components/schemas/AgentProfile"},{"description":" The submitted profiling data. "}]}},"description":"The structure representing the postAgentProfileRequest."},"Principals":{"type":"array","items":{"$ref":"#/components/schemas/Principal"},"minItems":1,"maxItems":50},"ProfileTime":{"type":"object","properties":{"start":{"allOf":[{"$ref":"#/components/schemas/Timestamp"},{"description":"The start time of a profile. It is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC."}]}},"description":" Contains the start time of a profile. "},"ProfilingStatus":{"type":"object","properties":{"latestAgentOrchestratedAt":{"allOf":[{"$ref":"#/components/schemas/Timestamp"},{"description":"The date and time when the profiling agent most recently pinged back. Specify using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC."}]},"latestAgentProfileReportedAt":{"allOf":[{"$ref":"#/components/schemas/Timestamp"},{"description":"The date and time when the most recent profile was received. Specify using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC."}]},"latestAggregatedProfile":{"allOf":[{"$ref":"#/components/schemas/AggregatedProfileTime"},{"description":" An AggregatedProfileTime object that contains the aggregation period and start time for an aggregated profile. "}]}},"description":" 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 start time for the most recent aggregated profile. "},"PutPermissionRequest":{"type":"object","required":["principals"],"title":"PutPermissionRequest","properties":{"principals":{"allOf":[{"$ref":"#/components/schemas/Principals"},{"description":" A list ARNs for the roles and users you want to grant access to the profiling group. Wildcards are not are supported in the ARNs. "}]},"revisionId":{"allOf":[{"$ref":"#/components/schemas/RevisionId"},{"description":" A universally unique identifier (UUID) for the revision of the policy you are adding to the profiling group. Do not specify this when you add permissions to a profiling group for the first time. If a policy already exists on the profiling group, you must specify the revisionId. "}]}},"description":"The structure representing the putPermissionRequest."},"Recommendation":{"type":"object","required":["allMatchesCount","allMatchesSum","endTime","pattern","startTime","topMatches"],"properties":{"allMatchesCount":{"allOf":[{"$ref":"#/components/schemas/Integer"},{"description":"How many different places in the profile graph triggered a match."}]},"allMatchesSum":{"allOf":[{"$ref":"#/components/schemas/Double"},{"description":"How much of the total sample count is potentially affected."}]},"endTime":{"allOf":[{"$ref":"#/components/schemas/Timestamp"},{"description":"End time of the profile that was used by this analysis. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC."}]},"pattern":{"allOf":[{"$ref":"#/components/schemas/Pattern"},{"description":"The pattern that analysis recognized in the profile to make this recommendation."}]},"startTime":{"allOf":[{"$ref":"#/components/schemas/Timestamp"},{"description":"The start time of the profile that was used by this analysis. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC."}]},"topMatches":{"allOf":[{"$ref":"#/components/schemas/Matches"},{"description":"List of the matches with most impact. "}]}},"description":"A potential improvement that was found from analyzing the profiling data."},"RemoveNotificationChannelRequest":{"type":"object","title":"RemoveNotificationChannelRequest","properties":{},"description":"The structure representing the RemoveNotificationChannelRequest."},"RemovePermissionRequest":{"type":"object","title":"RemovePermissionRequest","properties":{},"description":" The structure representing the <code>removePermissionRequest</code>.</p> Positive and Negative. "}]}},"description":"The structure representing the SubmitFeedbackRequest."},"TagKeys":{"type":"array","items":{"$ref":"#/components/schemas/String"}},"TagResourceRequest":{"type":"object","required":["tags"],"title":"TagResourceRequest","properties":{"tags":{"allOf":[{"$ref":"#/components/schemas/TagsMap"},{"description":" The list of tags that are added to the specified resource. "}]}}},"TargetFrame":{"type":"array","items":{"$ref":"#/components/schemas/String"}},"UntagResourceRequest":{"type":"object","title":"UntagResourceRequest","properties":{}},"UpdateProfilingGroupRequest":{"type":"object","required":["agentOrchestrationConfig"],"title":"UpdateProfilingGroupRequest","properties":{"agentOrchestrationConfig":{"allOf":[{"$ref":"#/components/schemas/AgentOrchestrationConfig"},{"description":" Specifies whether profiling is enabled or disabled for a profiling group. "}]}},"description":"The structure representing the updateProfilingGroupRequest."}}},"security":[{"hmac":[]}]}