com.amazonaws.services.codeguruprofiler.AmazonCodeGuruProfiler Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-codeguruprofiler Show documentation
Show all versions of aws-java-sdk-codeguruprofiler Show documentation
The AWS Java SDK for Amazon CodeGuru Profiler module holds the client classes that are used for communicating with Amazon CodeGuru Profiler Service
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.codeguruprofiler;
import javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.codeguruprofiler.model.*;
/**
* Interface for accessing Amazon CodeGuru Profiler.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.codeguruprofiler.AbstractAmazonCodeGuruProfiler} instead.
*
*
*
* 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.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonCodeGuruProfiler {
/**
* The region metadata service name for computing region endpoints. You can use this value to retrieve metadata
* (such as supported regions) of the service.
*
* @see RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "codeguru-profiler";
/**
*
* Add up to 2 anomaly notifications channels for a profiling group.
*
*
* @param addNotificationChannelsRequest
* The structure representing the AddNotificationChannelsRequest.
* @return Result of the AddNotificationChannels operation returned by the service.
* @throws ServiceQuotaExceededException
* You have exceeded your service quota. To perform the requested action, remove some of the relevant
* resources, or use Service
* Quotas to request a service quota increase.
* @throws InternalServerException
* The server encountered an internal error and is unable to complete the request.
* @throws ConflictException
* The requested operation would cause a conflict with the current state of a service resource associated
* with the request. Resolve the conflict before retrying this request.
* @throws ValidationException
* The parameter is not valid.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ResourceNotFoundException
* The resource specified in the request does not exist.
* @sample AmazonCodeGuruProfiler.AddNotificationChannels
* @see AWS API Documentation
*/
AddNotificationChannelsResult addNotificationChannels(AddNotificationChannelsRequest addNotificationChannelsRequest);
/**
*
* Returns the time series of values for a requested list of frame metrics from a time period.
*
*
* @param batchGetFrameMetricDataRequest
* The structure representing the BatchGetFrameMetricDataRequest.
* @return Result of the BatchGetFrameMetricData operation returned by the service.
* @throws InternalServerException
* The server encountered an internal error and is unable to complete the request.
* @throws ValidationException
* The parameter is not valid.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ResourceNotFoundException
* The resource specified in the request does not exist.
* @sample AmazonCodeGuruProfiler.BatchGetFrameMetricData
* @see AWS API Documentation
*/
BatchGetFrameMetricDataResult batchGetFrameMetricData(BatchGetFrameMetricDataRequest batchGetFrameMetricDataRequest);
/**
*
* Used by profiler agents to report their current state and to receive remote configuration updates. For example,
* ConfigureAgent can be used to tell an agent whether to profile or not and for how long to return
* profiling data.
*
*
* @param configureAgentRequest
* The structure representing the configureAgentRequest.
* @return Result of the ConfigureAgent operation returned by the service.
* @throws InternalServerException
* The server encountered an internal error and is unable to complete the request.
* @throws ValidationException
* The parameter is not valid.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ResourceNotFoundException
* The resource specified in the request does not exist.
* @sample AmazonCodeGuruProfiler.ConfigureAgent
* @see AWS API Documentation
*/
ConfigureAgentResult configureAgent(ConfigureAgentRequest configureAgentRequest);
/**
*
* Creates a profiling group.
*
*
* @param createProfilingGroupRequest
* The structure representing the createProfiliingGroupRequest.
* @return Result of the CreateProfilingGroup operation returned by the service.
* @throws ServiceQuotaExceededException
* You have exceeded your service quota. To perform the requested action, remove some of the relevant
* resources, or use Service
* Quotas to request a service quota increase.
* @throws InternalServerException
* The server encountered an internal error and is unable to complete the request.
* @throws ConflictException
* The requested operation would cause a conflict with the current state of a service resource associated
* with the request. Resolve the conflict before retrying this request.
* @throws ValidationException
* The parameter is not valid.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @sample AmazonCodeGuruProfiler.CreateProfilingGroup
* @see AWS API Documentation
*/
CreateProfilingGroupResult createProfilingGroup(CreateProfilingGroupRequest createProfilingGroupRequest);
/**
*
* Deletes a profiling group.
*
*
* @param deleteProfilingGroupRequest
* The structure representing the deleteProfilingGroupRequest.
* @return Result of the DeleteProfilingGroup operation returned by the service.
* @throws InternalServerException
* The server encountered an internal error and is unable to complete the request.
* @throws ConflictException
* The requested operation would cause a conflict with the current state of a service resource associated
* with the request. Resolve the conflict before retrying this request.
* @throws ValidationException
* The parameter is not valid.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ResourceNotFoundException
* The resource specified in the request does not exist.
* @sample AmazonCodeGuruProfiler.DeleteProfilingGroup
* @see AWS API Documentation
*/
DeleteProfilingGroupResult deleteProfilingGroup(DeleteProfilingGroupRequest deleteProfilingGroupRequest);
/**
*
* Returns a
* ProfilingGroupDescription object that contains information about the requested profiling group.
*
*
* @param describeProfilingGroupRequest
* The structure representing the describeProfilingGroupRequest.
* @return Result of the DescribeProfilingGroup operation returned by the service.
* @throws InternalServerException
* The server encountered an internal error and is unable to complete the request.
* @throws ValidationException
* The parameter is not valid.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ResourceNotFoundException
* The resource specified in the request does not exist.
* @sample AmazonCodeGuruProfiler.DescribeProfilingGroup
* @see AWS API Documentation
*/
DescribeProfilingGroupResult describeProfilingGroup(DescribeProfilingGroupRequest describeProfilingGroupRequest);
/**
*
* Returns a list of
* FindingsReportSummary objects that contain analysis results for all profiling groups in your
* AWS account.
*
*
* @param getFindingsReportAccountSummaryRequest
* The structure representing the GetFindingsReportAccountSummaryRequest.
* @return Result of the GetFindingsReportAccountSummary operation returned by the service.
* @throws InternalServerException
* The server encountered an internal error and is unable to complete the request.
* @throws ValidationException
* The parameter is not valid.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @sample AmazonCodeGuruProfiler.GetFindingsReportAccountSummary
* @see AWS API Documentation
*/
GetFindingsReportAccountSummaryResult getFindingsReportAccountSummary(GetFindingsReportAccountSummaryRequest getFindingsReportAccountSummaryRequest);
/**
*
* Get the current configuration for anomaly notifications for a profiling group.
*
*
* @param getNotificationConfigurationRequest
* The structure representing the GetNotificationConfigurationRequest.
* @return Result of the GetNotificationConfiguration operation returned by the service.
* @throws InternalServerException
* The server encountered an internal error and is unable to complete the request.
* @throws ValidationException
* The parameter is not valid.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ResourceNotFoundException
* The resource specified in the request does not exist.
* @sample AmazonCodeGuruProfiler.GetNotificationConfiguration
* @see AWS API Documentation
*/
GetNotificationConfigurationResult getNotificationConfiguration(GetNotificationConfigurationRequest getNotificationConfigurationRequest);
/**
*
* Returns the JSON-formatted resource-based policy on a profiling group.
*
*
* @param getPolicyRequest
* The structure representing the getPolicyRequest.
* @return Result of the GetPolicy operation returned by the service.
* @throws InternalServerException
* The server encountered an internal error and is unable to complete the request.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ResourceNotFoundException
* The resource specified in the request does not exist.
* @sample AmazonCodeGuruProfiler.GetPolicy
* @see AWS API
* Documentation
*/
GetPolicyResult getPolicy(GetPolicyRequest getPolicyRequest);
/**
*
* 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>
*
*
* @param getProfileRequest
* The structure representing the getProfileRequest.
* @return Result of the GetProfile operation returned by the service.
* @throws InternalServerException
* The server encountered an internal error and is unable to complete the request.
* @throws ValidationException
* The parameter is not valid.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ResourceNotFoundException
* The resource specified in the request does not exist.
* @sample AmazonCodeGuruProfiler.GetProfile
* @see AWS
* API Documentation
*/
GetProfileResult getProfile(GetProfileRequest getProfileRequest);
/**
*
* 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.
*
*
* @param getRecommendationsRequest
* The structure representing the GetRecommendationsRequest.
* @return Result of the GetRecommendations operation returned by the service.
* @throws InternalServerException
* The server encountered an internal error and is unable to complete the request.
* @throws ValidationException
* The parameter is not valid.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ResourceNotFoundException
* The resource specified in the request does not exist.
* @sample AmazonCodeGuruProfiler.GetRecommendations
* @see AWS API Documentation
*/
GetRecommendationsResult getRecommendations(GetRecommendationsRequest getRecommendationsRequest);
/**
*
* List the available reports for a given profiling group and time range.
*
*
* @param listFindingsReportsRequest
* The structure representing the ListFindingsReportsRequest.
* @return Result of the ListFindingsReports operation returned by the service.
* @throws InternalServerException
* The server encountered an internal error and is unable to complete the request.
* @throws ValidationException
* The parameter is not valid.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ResourceNotFoundException
* The resource specified in the request does not exist.
* @sample AmazonCodeGuruProfiler.ListFindingsReports
* @see AWS API Documentation
*/
ListFindingsReportsResult listFindingsReports(ListFindingsReportsRequest listFindingsReportsRequest);
/**
*
* Lists the start times of the available aggregated profiles of a profiling group for an aggregation period within
* the specified time range.
*
*
* @param listProfileTimesRequest
* The structure representing the listProfileTimesRequest.
* @return Result of the ListProfileTimes operation returned by the service.
* @throws InternalServerException
* The server encountered an internal error and is unable to complete the request.
* @throws ValidationException
* The parameter is not valid.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ResourceNotFoundException
* The resource specified in the request does not exist.
* @sample AmazonCodeGuruProfiler.ListProfileTimes
* @see AWS API Documentation
*/
ListProfileTimesResult listProfileTimes(ListProfileTimesRequest listProfileTimesRequest);
/**
*
* Returns a list of profiling groups. The profiling groups are returned as
* ProfilingGroupDescription objects.
*
*
* @param listProfilingGroupsRequest
* The structure representing the listProfilingGroupsRequest.
* @return Result of the ListProfilingGroups operation returned by the service.
* @throws InternalServerException
* The server encountered an internal error and is unable to complete the request.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @sample AmazonCodeGuruProfiler.ListProfilingGroups
* @see AWS API Documentation
*/
ListProfilingGroupsResult listProfilingGroups(ListProfilingGroupsRequest listProfilingGroupsRequest);
/**
*
* Returns a list of the tags that are assigned to a specified resource.
*
*
* @param listTagsForResourceRequest
* @return Result of the ListTagsForResource operation returned by the service.
* @throws InternalServerException
* The server encountered an internal error and is unable to complete the request.
* @throws ValidationException
* The parameter is not valid.
* @throws ResourceNotFoundException
* The resource specified in the request does not exist.
* @sample AmazonCodeGuruProfiler.ListTagsForResource
* @see AWS API Documentation
*/
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* 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
* .
*
*
* @param postAgentProfileRequest
* The structure representing the postAgentProfileRequest.
* @return Result of the PostAgentProfile operation returned by the service.
* @throws InternalServerException
* The server encountered an internal error and is unable to complete the request.
* @throws ValidationException
* The parameter is not valid.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ResourceNotFoundException
* The resource specified in the request does not exist.
* @sample AmazonCodeGuruProfiler.PostAgentProfile
* @see AWS API Documentation
*/
PostAgentProfileResult postAgentProfile(PostAgentProfileRequest postAgentProfileRequest);
/**
*
* 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>
*
*
* @param putPermissionRequest
* The structure representing the putPermissionRequest.
* @return Result of the PutPermission operation returned by the service.
* @throws InternalServerException
* The server encountered an internal error and is unable to complete the request.
* @throws ConflictException
* The requested operation would cause a conflict with the current state of a service resource associated
* with the request. Resolve the conflict before retrying this request.
* @throws ValidationException
* The parameter is not valid.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ResourceNotFoundException
* The resource specified in the request does not exist.
* @sample AmazonCodeGuruProfiler.PutPermission
* @see AWS
* API Documentation
*/
PutPermissionResult putPermission(PutPermissionRequest putPermissionRequest);
/**
*
* Remove one anomaly notifications channel for a profiling group.
*
*
* @param removeNotificationChannelRequest
* The structure representing the RemoveNotificationChannelRequest.
* @return Result of the RemoveNotificationChannel operation returned by the service.
* @throws InternalServerException
* The server encountered an internal error and is unable to complete the request.
* @throws ValidationException
* The parameter is not valid.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ResourceNotFoundException
* The resource specified in the request does not exist.
* @sample AmazonCodeGuruProfiler.RemoveNotificationChannel
* @see AWS API Documentation
*/
RemoveNotificationChannelResult removeNotificationChannel(RemoveNotificationChannelRequest removeNotificationChannelRequest);
/**
*
* 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 .
*
*
* @param removePermissionRequest
*
* The structure representing the <code>removePermissionRequest</code>.</p>
* @return Result of the RemovePermission operation returned by the service.
* @throws InternalServerException The server encountered an internal error and is unable to complete the request.
* @throws ConflictException The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
* @throws ValidationException The parameter is not valid.
* @throws ThrottlingException The request was denied due to request throttling.
* @throws ResourceNotFoundException The resource specified in the request does not exist.
* @sample AmazonCodeGuruProfiler.RemovePermission
* @see AWS API Documentation
*/
RemovePermissionResult removePermission(RemovePermissionRequest removePermissionRequest);
/**
*
* Sends feedback to CodeGuru Profiler about whether the anomaly detected by the analysis is useful or not.
*
*
* @param submitFeedbackRequest
* The structure representing the SubmitFeedbackRequest.
* @return Result of the SubmitFeedback operation returned by the service.
* @throws InternalServerException
* The server encountered an internal error and is unable to complete the request.
* @throws ValidationException
* The parameter is not valid.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ResourceNotFoundException
* The resource specified in the request does not exist.
* @sample AmazonCodeGuruProfiler.SubmitFeedback
* @see AWS API Documentation
*/
SubmitFeedbackResult submitFeedback(SubmitFeedbackRequest submitFeedbackRequest);
/**
*
* Use to assign one or more tags to a resource.
*
*
* @param tagResourceRequest
* @return Result of the TagResource operation returned by the service.
* @throws InternalServerException
* The server encountered an internal error and is unable to complete the request.
* @throws ValidationException
* The parameter is not valid.
* @throws ResourceNotFoundException
* The resource specified in the request does not exist.
* @sample AmazonCodeGuruProfiler.TagResource
* @see AWS
* API Documentation
*/
TagResourceResult tagResource(TagResourceRequest tagResourceRequest);
/**
*
* Use to remove one or more tags from a resource.
*
*
* @param untagResourceRequest
* @return Result of the UntagResource operation returned by the service.
* @throws InternalServerException
* The server encountered an internal error and is unable to complete the request.
* @throws ValidationException
* The parameter is not valid.
* @throws ResourceNotFoundException
* The resource specified in the request does not exist.
* @sample AmazonCodeGuruProfiler.UntagResource
* @see AWS
* API Documentation
*/
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest);
/**
*
* Updates a profiling group.
*
*
* @param updateProfilingGroupRequest
* The structure representing the updateProfilingGroupRequest.
* @return Result of the UpdateProfilingGroup operation returned by the service.
* @throws InternalServerException
* The server encountered an internal error and is unable to complete the request.
* @throws ConflictException
* The requested operation would cause a conflict with the current state of a service resource associated
* with the request. Resolve the conflict before retrying this request.
* @throws ValidationException
* The parameter is not valid.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ResourceNotFoundException
* The resource specified in the request does not exist.
* @sample AmazonCodeGuruProfiler.UpdateProfilingGroup
* @see AWS API Documentation
*/
UpdateProfilingGroupResult updateProfilingGroup(UpdateProfilingGroupRequest updateProfilingGroupRequest);
/**
* Shuts down this client object, releasing any resources that might be held open. This is an optional method, and
* callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client
* has been shutdown, it should not be used to make any more requests.
*/
void shutdown();
/**
* Returns additional metadata for a previously executed successful request, typically used for debugging issues
* where a service isn't acting as expected. This data isn't considered part of the result data returned by an
* operation, so it's available through this separate, diagnostic interface.
*
* Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic
* information for an executed request, you should use this method to retrieve it as soon as possible after
* executing a request.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}