/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include This section provides documentation for the Amazon CodeGuru Profiler API
* operations. Add up to 2 anomaly notifications channels for a profiling
* group.
*/
class AWS_CODEGURUPROFILER_API CodeGuruProfilerClient : public Aws::Client::AWSJsonClient
{
public:
typedef Aws::Client::AWSJsonClient BASECLASS;
/**
* Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config
* is not specified, it will be initialized to default values.
*/
CodeGuruProfilerClient(const Aws::Client::ClientConfiguration& clientConfiguration = Aws::Client::ClientConfiguration());
/**
* Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config
* is not specified, it will be initialized to default values.
*/
CodeGuruProfilerClient(const Aws::Auth::AWSCredentials& credentials, const Aws::Client::ClientConfiguration& clientConfiguration = Aws::Client::ClientConfiguration());
/**
* Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied,
* the default http client factory will be used
*/
CodeGuruProfilerClient(const std::shared_ptr <p>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.
* </p> <p>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. </p>
* <note> <p>Amazon CodeGuru Profiler currently supports applications
* written in all Java virtual machine (JVM) languages. 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.</p> </note> <p>
* For more information, see <a
* href="https://docs.aws.amazon.com/codeguru/latest/profiler-ug/what-is-codeguru-profiler.html">What
* is Amazon CodeGuru Profiler</a> in the <i>Amazon CodeGuru Profiler
* User Guide</i>. </p> See Also:
AWS
* API Reference
Add up to 2 anomaly notifications channels for a profiling * group.
Add up to 2 anomaly notifications channels for a profiling * group.
Returns the time series of values for a requested list of frame metrics from * a time period.
Returns the time series of values for a requested list of frame metrics from * a time period.
Returns the time series of values for a requested list of frame metrics from * a time period.
Used by profiler agents to report their current state and to receive remote
* configuration updates. For example, ConfigureAgent can be used to
* tell and agent whether to profile or not and for how long to return profiling
* data.
Used by profiler agents to report their current state and to receive remote
* configuration updates. For example, ConfigureAgent can be used to
* tell and agent whether to profile or not and for how long to return profiling
* data.
Used by profiler agents to report their current state and to receive remote
* configuration updates. For example, ConfigureAgent can be used to
* tell and agent whether to profile or not and for how long to return profiling
* data.
Creates a profiling group.
Creates a profiling group.
Creates a profiling group.
Deletes a profiling group.
Deletes a profiling group.
Deletes a profiling group.
Returns a
* ProfilingGroupDescription object that contains information
* about the requested profiling group.
Returns a
* ProfilingGroupDescription object that contains information
* about the requested profiling group.
Returns a
* ProfilingGroupDescription object that contains information
* about the requested profiling group.
Returns a list of
* FindingsReportSummary objects that contain analysis results
* for all profiling groups in your AWS account.
Returns a list of
* FindingsReportSummary objects that contain analysis results
* for all profiling groups in your AWS account.
Returns a list of
* FindingsReportSummary objects that contain analysis results
* for all profiling groups in your AWS account.
Get the current configuration for anomaly notifications for a profiling * group.
Get the current configuration for anomaly notifications for a profiling * group.
Get the current configuration for anomaly notifications for a profiling * group.
Returns the JSON-formatted resource-based policy on a profiling group. *
Returns the JSON-formatted resource-based policy on a profiling group. *
Returns the JSON-formatted resource-based policy on a profiling group. *
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>
* 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>
* 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>
* Returns a list of
* 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.
Returns a list of
* 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.
Returns a list of
* 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.
List the available reports for a given profiling group and time * range.
List the available reports for a given profiling group and time * range.
List the available reports for a given profiling group and time * range.
Lists the start times of the available aggregated profiles of a profiling * group for an aggregation period within the specified time range.
Lists the start times of the available aggregated profiles of a profiling * group for an aggregation period within the specified time range.
Lists the start times of the available aggregated profiles of a profiling * group for an aggregation period within the specified time range.
Returns a list of profiling groups. The profiling groups are returned as
* ProfilingGroupDescription objects.
Returns a list of profiling groups. The profiling groups are returned as
* ProfilingGroupDescription objects.
Returns a list of profiling groups. The profiling groups are returned as
* ProfilingGroupDescription objects.
Returns a list of the tags that are assigned to a specified resource. *
Returns a list of the tags that are assigned to a specified resource. *
Returns a list of the tags that are assigned to a specified resource. *
Submits profiling data to an aggregated profile of a profiling group. To get
* an aggregated profile that is created with this profiling data, use
* GetProfile .
Submits profiling data to an aggregated profile of a profiling group. To get
* an aggregated profile that is created with this profiling data, use
* GetProfile .
Submits profiling data to an aggregated profile of a profiling group. To get
* an aggregated profile that is created with this profiling data, use
* GetProfile .
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> 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> 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> Remove one anomaly notifications channel for a profiling group.
Remove one anomaly notifications channel for a profiling group.
Remove one anomaly notifications channel for a profiling group.
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 .
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 .
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 .
Sends feedback to CodeGuru Profiler about whether the anomaly detected by the * analysis is useful or not.
Sends feedback to CodeGuru Profiler about whether the anomaly detected by the * analysis is useful or not.
Sends feedback to CodeGuru Profiler about whether the anomaly detected by the * analysis is useful or not.
Use to assign one or more tags to a resource.
Use to assign one or more tags to a resource.
Use to assign one or more tags to a resource.
Use to remove one or more tags from a resource.
Use to remove one or more tags from a resource.
Use to remove one or more tags from a resource.
Updates a profiling group.
Updates a profiling group.
Updates a profiling group.