@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonCodeGuruProfilerAsync extends AmazonCodeGuruProfiler
AsyncHandler
can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonCodeGuruProfilerAsync
instead.
This section provides documentation for the Amazon CodeGuru Profiler API operations.
<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>
ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
Future<AddNotificationChannelsResult> |
addNotificationChannelsAsync(AddNotificationChannelsRequest addNotificationChannelsRequest)
Add up to 2 anomaly notifications channels for a profiling group.
|
Future<AddNotificationChannelsResult> |
addNotificationChannelsAsync(AddNotificationChannelsRequest addNotificationChannelsRequest,
AsyncHandler<AddNotificationChannelsRequest,AddNotificationChannelsResult> asyncHandler)
Add up to 2 anomaly notifications channels for a profiling group.
|
Future<BatchGetFrameMetricDataResult> |
batchGetFrameMetricDataAsync(BatchGetFrameMetricDataRequest batchGetFrameMetricDataRequest)
Returns the time series of values for a requested list of frame metrics from a time period.
|
Future<BatchGetFrameMetricDataResult> |
batchGetFrameMetricDataAsync(BatchGetFrameMetricDataRequest batchGetFrameMetricDataRequest,
AsyncHandler<BatchGetFrameMetricDataRequest,BatchGetFrameMetricDataResult> asyncHandler)
Returns the time series of values for a requested list of frame metrics from a time period.
|
Future<ConfigureAgentResult> |
configureAgentAsync(ConfigureAgentRequest configureAgentRequest)
Used by profiler agents to report their current state and to receive remote configuration updates.
|
Future<ConfigureAgentResult> |
configureAgentAsync(ConfigureAgentRequest configureAgentRequest,
AsyncHandler<ConfigureAgentRequest,ConfigureAgentResult> asyncHandler)
Used by profiler agents to report their current state and to receive remote configuration updates.
|
Future<CreateProfilingGroupResult> |
createProfilingGroupAsync(CreateProfilingGroupRequest createProfilingGroupRequest)
Creates a profiling group.
|
Future<CreateProfilingGroupResult> |
createProfilingGroupAsync(CreateProfilingGroupRequest createProfilingGroupRequest,
AsyncHandler<CreateProfilingGroupRequest,CreateProfilingGroupResult> asyncHandler)
Creates a profiling group.
|
Future<DeleteProfilingGroupResult> |
deleteProfilingGroupAsync(DeleteProfilingGroupRequest deleteProfilingGroupRequest)
Deletes a profiling group.
|
Future<DeleteProfilingGroupResult> |
deleteProfilingGroupAsync(DeleteProfilingGroupRequest deleteProfilingGroupRequest,
AsyncHandler<DeleteProfilingGroupRequest,DeleteProfilingGroupResult> asyncHandler)
Deletes a profiling group.
|
Future<DescribeProfilingGroupResult> |
describeProfilingGroupAsync(DescribeProfilingGroupRequest describeProfilingGroupRequest)
Returns a
ProfilingGroupDescription object that contains information about the requested profiling group. |
Future<DescribeProfilingGroupResult> |
describeProfilingGroupAsync(DescribeProfilingGroupRequest describeProfilingGroupRequest,
AsyncHandler<DescribeProfilingGroupRequest,DescribeProfilingGroupResult> asyncHandler)
Returns a
ProfilingGroupDescription object that contains information about the requested profiling group. |
Future<GetFindingsReportAccountSummaryResult> |
getFindingsReportAccountSummaryAsync(GetFindingsReportAccountSummaryRequest getFindingsReportAccountSummaryRequest)
Returns a list of
FindingsReportSummary objects that contain analysis results for all profiling groups in your
AWS account. |
Future<GetFindingsReportAccountSummaryResult> |
getFindingsReportAccountSummaryAsync(GetFindingsReportAccountSummaryRequest getFindingsReportAccountSummaryRequest,
AsyncHandler<GetFindingsReportAccountSummaryRequest,GetFindingsReportAccountSummaryResult> asyncHandler)
Returns a list of
FindingsReportSummary objects that contain analysis results for all profiling groups in your
AWS account. |
Future<GetNotificationConfigurationResult> |
getNotificationConfigurationAsync(GetNotificationConfigurationRequest getNotificationConfigurationRequest)
Get the current configuration for anomaly notifications for a profiling group.
|
Future<GetNotificationConfigurationResult> |
getNotificationConfigurationAsync(GetNotificationConfigurationRequest getNotificationConfigurationRequest,
AsyncHandler<GetNotificationConfigurationRequest,GetNotificationConfigurationResult> asyncHandler)
Get the current configuration for anomaly notifications for a profiling group.
|
Future<GetPolicyResult> |
getPolicyAsync(GetPolicyRequest getPolicyRequest)
Returns the JSON-formatted resource-based policy on a profiling group.
|
Future<GetPolicyResult> |
getPolicyAsync(GetPolicyRequest getPolicyRequest,
AsyncHandler<GetPolicyRequest,GetPolicyResult> asyncHandler)
Returns the JSON-formatted resource-based policy on a profiling group.
|
Future<GetProfileResult> |
getProfileAsync(GetProfileRequest getProfileRequest)
Gets the aggregated profile of a profiling group for a specified time range.
|
Future<GetProfileResult> |
getProfileAsync(GetProfileRequest getProfileRequest,
AsyncHandler<GetProfileRequest,GetProfileResult> asyncHandler)
Gets the aggregated profile of a profiling group for a specified time range.
|
Future<GetRecommendationsResult> |
getRecommendationsAsync(GetRecommendationsRequest getRecommendationsRequest)
Returns a list of
Recommendation objects that contain recommendations for a profiling group for a given time
period. |
Future<GetRecommendationsResult> |
getRecommendationsAsync(GetRecommendationsRequest getRecommendationsRequest,
AsyncHandler<GetRecommendationsRequest,GetRecommendationsResult> asyncHandler)
Returns a list of
Recommendation objects that contain recommendations for a profiling group for a given time
period. |
Future<ListFindingsReportsResult> |
listFindingsReportsAsync(ListFindingsReportsRequest listFindingsReportsRequest)
List the available reports for a given profiling group and time range.
|
Future<ListFindingsReportsResult> |
listFindingsReportsAsync(ListFindingsReportsRequest listFindingsReportsRequest,
AsyncHandler<ListFindingsReportsRequest,ListFindingsReportsResult> asyncHandler)
List the available reports for a given profiling group and time range.
|
Future<ListProfileTimesResult> |
listProfileTimesAsync(ListProfileTimesRequest listProfileTimesRequest)
Lists the start times of the available aggregated profiles of a profiling group for an aggregation period within
the specified time range.
|
Future<ListProfileTimesResult> |
listProfileTimesAsync(ListProfileTimesRequest listProfileTimesRequest,
AsyncHandler<ListProfileTimesRequest,ListProfileTimesResult> asyncHandler)
Lists the start times of the available aggregated profiles of a profiling group for an aggregation period within
the specified time range.
|
Future<ListProfilingGroupsResult> |
listProfilingGroupsAsync(ListProfilingGroupsRequest listProfilingGroupsRequest)
Returns a list of profiling groups.
|
Future<ListProfilingGroupsResult> |
listProfilingGroupsAsync(ListProfilingGroupsRequest listProfilingGroupsRequest,
AsyncHandler<ListProfilingGroupsRequest,ListProfilingGroupsResult> asyncHandler)
Returns a list of profiling groups.
|
Future<ListTagsForResourceResult> |
listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)
Returns a list of the tags that are assigned to a specified resource.
|
Future<ListTagsForResourceResult> |
listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest,
AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
Returns a list of the tags that are assigned to a specified resource.
|
Future<PostAgentProfileResult> |
postAgentProfileAsync(PostAgentProfileRequest postAgentProfileRequest)
Submits profiling data to an aggregated profile of a profiling group.
|
Future<PostAgentProfileResult> |
postAgentProfileAsync(PostAgentProfileRequest postAgentProfileRequest,
AsyncHandler<PostAgentProfileRequest,PostAgentProfileResult> asyncHandler)
Submits profiling data to an aggregated profile of a profiling group.
|
Future<PutPermissionResult> |
putPermissionAsync(PutPermissionRequest putPermissionRequest)
Adds permissions to a profiling group's resource-based policy that are provided using an action group.
|
Future<PutPermissionResult> |
putPermissionAsync(PutPermissionRequest putPermissionRequest,
AsyncHandler<PutPermissionRequest,PutPermissionResult> asyncHandler)
Adds permissions to a profiling group's resource-based policy that are provided using an action group.
|
Future<RemoveNotificationChannelResult> |
removeNotificationChannelAsync(RemoveNotificationChannelRequest removeNotificationChannelRequest)
Remove one anomaly notifications channel for a profiling group.
|
Future<RemoveNotificationChannelResult> |
removeNotificationChannelAsync(RemoveNotificationChannelRequest removeNotificationChannelRequest,
AsyncHandler<RemoveNotificationChannelRequest,RemoveNotificationChannelResult> asyncHandler)
Remove one anomaly notifications channel for a profiling group.
|
Future<RemovePermissionResult> |
removePermissionAsync(RemovePermissionRequest removePermissionRequest)
Removes permissions from a profiling group's resource-based policy that are provided using an action group.
|
Future<RemovePermissionResult> |
removePermissionAsync(RemovePermissionRequest removePermissionRequest,
AsyncHandler<RemovePermissionRequest,RemovePermissionResult> asyncHandler)
Removes permissions from a profiling group's resource-based policy that are provided using an action group.
|
Future<SubmitFeedbackResult> |
submitFeedbackAsync(SubmitFeedbackRequest submitFeedbackRequest)
Sends feedback to CodeGuru Profiler about whether the anomaly detected by the analysis is useful or not.
|
Future<SubmitFeedbackResult> |
submitFeedbackAsync(SubmitFeedbackRequest submitFeedbackRequest,
AsyncHandler<SubmitFeedbackRequest,SubmitFeedbackResult> asyncHandler)
Sends feedback to CodeGuru Profiler about whether the anomaly detected by the analysis is useful or not.
|
Future<TagResourceResult> |
tagResourceAsync(TagResourceRequest tagResourceRequest)
Use to assign one or more tags to a resource.
|
Future<TagResourceResult> |
tagResourceAsync(TagResourceRequest tagResourceRequest,
AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
Use to assign one or more tags to a resource.
|
Future<UntagResourceResult> |
untagResourceAsync(UntagResourceRequest untagResourceRequest)
Use to remove one or more tags from a resource.
|
Future<UntagResourceResult> |
untagResourceAsync(UntagResourceRequest untagResourceRequest,
AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
Use to remove one or more tags from a resource.
|
Future<UpdateProfilingGroupResult> |
updateProfilingGroupAsync(UpdateProfilingGroupRequest updateProfilingGroupRequest)
Updates a profiling group.
|
Future<UpdateProfilingGroupResult> |
updateProfilingGroupAsync(UpdateProfilingGroupRequest updateProfilingGroupRequest,
AsyncHandler<UpdateProfilingGroupRequest,UpdateProfilingGroupResult> asyncHandler)
Updates a profiling group.
|
addNotificationChannels, batchGetFrameMetricData, configureAgent, createProfilingGroup, deleteProfilingGroup, describeProfilingGroup, getCachedResponseMetadata, getFindingsReportAccountSummary, getNotificationConfiguration, getPolicy, getProfile, getRecommendations, listFindingsReports, listProfileTimes, listProfilingGroups, listTagsForResource, postAgentProfile, putPermission, removeNotificationChannel, removePermission, shutdown, submitFeedback, tagResource, untagResource, updateProfilingGroup
Future<AddNotificationChannelsResult> addNotificationChannelsAsync(AddNotificationChannelsRequest addNotificationChannelsRequest)
Add up to 2 anomaly notifications channels for a profiling group.
addNotificationChannelsRequest
- The structure representing the AddNotificationChannelsRequest.Future<AddNotificationChannelsResult> addNotificationChannelsAsync(AddNotificationChannelsRequest addNotificationChannelsRequest, AsyncHandler<AddNotificationChannelsRequest,AddNotificationChannelsResult> asyncHandler)
Add up to 2 anomaly notifications channels for a profiling group.
addNotificationChannelsRequest
- The structure representing the AddNotificationChannelsRequest.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<BatchGetFrameMetricDataResult> batchGetFrameMetricDataAsync(BatchGetFrameMetricDataRequest batchGetFrameMetricDataRequest)
Returns the time series of values for a requested list of frame metrics from a time period.
batchGetFrameMetricDataRequest
- The structure representing the BatchGetFrameMetricDataRequest.Future<BatchGetFrameMetricDataResult> batchGetFrameMetricDataAsync(BatchGetFrameMetricDataRequest batchGetFrameMetricDataRequest, AsyncHandler<BatchGetFrameMetricDataRequest,BatchGetFrameMetricDataResult> asyncHandler)
Returns the time series of values for a requested list of frame metrics from a time period.
batchGetFrameMetricDataRequest
- The structure representing the BatchGetFrameMetricDataRequest.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ConfigureAgentResult> configureAgentAsync(ConfigureAgentRequest configureAgentRequest)
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.
configureAgentRequest
- The structure representing the configureAgentRequest.Future<ConfigureAgentResult> configureAgentAsync(ConfigureAgentRequest configureAgentRequest, AsyncHandler<ConfigureAgentRequest,ConfigureAgentResult> asyncHandler)
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.
configureAgentRequest
- The structure representing the configureAgentRequest.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateProfilingGroupResult> createProfilingGroupAsync(CreateProfilingGroupRequest createProfilingGroupRequest)
Creates a profiling group.
createProfilingGroupRequest
- The structure representing the createProfiliingGroupRequest.Future<CreateProfilingGroupResult> createProfilingGroupAsync(CreateProfilingGroupRequest createProfilingGroupRequest, AsyncHandler<CreateProfilingGroupRequest,CreateProfilingGroupResult> asyncHandler)
Creates a profiling group.
createProfilingGroupRequest
- The structure representing the createProfiliingGroupRequest.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteProfilingGroupResult> deleteProfilingGroupAsync(DeleteProfilingGroupRequest deleteProfilingGroupRequest)
Deletes a profiling group.
deleteProfilingGroupRequest
- The structure representing the deleteProfilingGroupRequest.Future<DeleteProfilingGroupResult> deleteProfilingGroupAsync(DeleteProfilingGroupRequest deleteProfilingGroupRequest, AsyncHandler<DeleteProfilingGroupRequest,DeleteProfilingGroupResult> asyncHandler)
Deletes a profiling group.
deleteProfilingGroupRequest
- The structure representing the deleteProfilingGroupRequest.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeProfilingGroupResult> describeProfilingGroupAsync(DescribeProfilingGroupRequest describeProfilingGroupRequest)
Returns a
ProfilingGroupDescription
object that contains information about the requested profiling group.
describeProfilingGroupRequest
- The structure representing the describeProfilingGroupRequest.Future<DescribeProfilingGroupResult> describeProfilingGroupAsync(DescribeProfilingGroupRequest describeProfilingGroupRequest, AsyncHandler<DescribeProfilingGroupRequest,DescribeProfilingGroupResult> asyncHandler)
Returns a
ProfilingGroupDescription
object that contains information about the requested profiling group.
describeProfilingGroupRequest
- The structure representing the describeProfilingGroupRequest.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetFindingsReportAccountSummaryResult> getFindingsReportAccountSummaryAsync(GetFindingsReportAccountSummaryRequest getFindingsReportAccountSummaryRequest)
Returns a list of
FindingsReportSummary
objects that contain analysis results for all profiling groups in your
AWS account.
getFindingsReportAccountSummaryRequest
- The structure representing the GetFindingsReportAccountSummaryRequest.Future<GetFindingsReportAccountSummaryResult> getFindingsReportAccountSummaryAsync(GetFindingsReportAccountSummaryRequest getFindingsReportAccountSummaryRequest, AsyncHandler<GetFindingsReportAccountSummaryRequest,GetFindingsReportAccountSummaryResult> asyncHandler)
Returns a list of
FindingsReportSummary
objects that contain analysis results for all profiling groups in your
AWS account.
getFindingsReportAccountSummaryRequest
- The structure representing the GetFindingsReportAccountSummaryRequest.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetNotificationConfigurationResult> getNotificationConfigurationAsync(GetNotificationConfigurationRequest getNotificationConfigurationRequest)
Get the current configuration for anomaly notifications for a profiling group.
getNotificationConfigurationRequest
- The structure representing the GetNotificationConfigurationRequest.Future<GetNotificationConfigurationResult> getNotificationConfigurationAsync(GetNotificationConfigurationRequest getNotificationConfigurationRequest, AsyncHandler<GetNotificationConfigurationRequest,GetNotificationConfigurationResult> asyncHandler)
Get the current configuration for anomaly notifications for a profiling group.
getNotificationConfigurationRequest
- The structure representing the GetNotificationConfigurationRequest.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetPolicyResult> getPolicyAsync(GetPolicyRequest getPolicyRequest)
Returns the JSON-formatted resource-based policy on a profiling group.
getPolicyRequest
- The structure representing the getPolicyRequest
.Future<GetPolicyResult> getPolicyAsync(GetPolicyRequest getPolicyRequest, AsyncHandler<GetPolicyRequest,GetPolicyResult> asyncHandler)
Returns the JSON-formatted resource-based policy on a profiling group.
getPolicyRequest
- The structure representing the getPolicyRequest
.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetProfileResult> getProfileAsync(GetProfileRequest getProfileRequest)
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>
getProfileRequest
- The structure representing the getProfileRequest.Future<GetProfileResult> getProfileAsync(GetProfileRequest getProfileRequest, AsyncHandler<GetProfileRequest,GetProfileResult> asyncHandler)
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>
getProfileRequest
- The structure representing the getProfileRequest.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetRecommendationsResult> getRecommendationsAsync(GetRecommendationsRequest getRecommendationsRequest)
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.
getRecommendationsRequest
- The structure representing the GetRecommendationsRequest.Future<GetRecommendationsResult> getRecommendationsAsync(GetRecommendationsRequest getRecommendationsRequest, AsyncHandler<GetRecommendationsRequest,GetRecommendationsResult> asyncHandler)
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.
getRecommendationsRequest
- The structure representing the GetRecommendationsRequest.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListFindingsReportsResult> listFindingsReportsAsync(ListFindingsReportsRequest listFindingsReportsRequest)
List the available reports for a given profiling group and time range.
listFindingsReportsRequest
- The structure representing the ListFindingsReportsRequest.Future<ListFindingsReportsResult> listFindingsReportsAsync(ListFindingsReportsRequest listFindingsReportsRequest, AsyncHandler<ListFindingsReportsRequest,ListFindingsReportsResult> asyncHandler)
List the available reports for a given profiling group and time range.
listFindingsReportsRequest
- The structure representing the ListFindingsReportsRequest.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListProfileTimesResult> listProfileTimesAsync(ListProfileTimesRequest listProfileTimesRequest)
Lists the start times of the available aggregated profiles of a profiling group for an aggregation period within the specified time range.
listProfileTimesRequest
- The structure representing the listProfileTimesRequest.Future<ListProfileTimesResult> listProfileTimesAsync(ListProfileTimesRequest listProfileTimesRequest, AsyncHandler<ListProfileTimesRequest,ListProfileTimesResult> asyncHandler)
Lists the start times of the available aggregated profiles of a profiling group for an aggregation period within the specified time range.
listProfileTimesRequest
- The structure representing the listProfileTimesRequest.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListProfilingGroupsResult> listProfilingGroupsAsync(ListProfilingGroupsRequest listProfilingGroupsRequest)
Returns a list of profiling groups. The profiling groups are returned as
ProfilingGroupDescription
objects.
listProfilingGroupsRequest
- The structure representing the listProfilingGroupsRequest.Future<ListProfilingGroupsResult> listProfilingGroupsAsync(ListProfilingGroupsRequest listProfilingGroupsRequest, AsyncHandler<ListProfilingGroupsRequest,ListProfilingGroupsResult> asyncHandler)
Returns a list of profiling groups. The profiling groups are returned as
ProfilingGroupDescription
objects.
listProfilingGroupsRequest
- The structure representing the listProfilingGroupsRequest.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)
Returns a list of the tags that are assigned to a specified resource.
listTagsForResourceRequest
- Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
Returns a list of the tags that are assigned to a specified resource.
listTagsForResourceRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PostAgentProfileResult> postAgentProfileAsync(PostAgentProfileRequest postAgentProfileRequest)
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
.
postAgentProfileRequest
- The structure representing the postAgentProfileRequest.Future<PostAgentProfileResult> postAgentProfileAsync(PostAgentProfileRequest postAgentProfileRequest, AsyncHandler<PostAgentProfileRequest,PostAgentProfileResult> asyncHandler)
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
.
postAgentProfileRequest
- The structure representing the postAgentProfileRequest.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PutPermissionResult> putPermissionAsync(PutPermissionRequest putPermissionRequest)
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>
putPermissionRequest
- The structure representing the putPermissionRequest
.Future<PutPermissionResult> putPermissionAsync(PutPermissionRequest putPermissionRequest, AsyncHandler<PutPermissionRequest,PutPermissionResult> asyncHandler)
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>
putPermissionRequest
- The structure representing the putPermissionRequest
.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<RemoveNotificationChannelResult> removeNotificationChannelAsync(RemoveNotificationChannelRequest removeNotificationChannelRequest)
Remove one anomaly notifications channel for a profiling group.
removeNotificationChannelRequest
- The structure representing the RemoveNotificationChannelRequest.Future<RemoveNotificationChannelResult> removeNotificationChannelAsync(RemoveNotificationChannelRequest removeNotificationChannelRequest, AsyncHandler<RemoveNotificationChannelRequest,RemoveNotificationChannelResult> asyncHandler)
Remove one anomaly notifications channel for a profiling group.
removeNotificationChannelRequest
- The structure representing the RemoveNotificationChannelRequest.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<RemovePermissionResult> removePermissionAsync(RemovePermissionRequest removePermissionRequest)
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
.
removePermissionRequest
-
The structure representing the <code>removePermissionRequest</code>.</p>
Future<RemovePermissionResult> removePermissionAsync(RemovePermissionRequest removePermissionRequest, AsyncHandler<RemovePermissionRequest,RemovePermissionResult> asyncHandler)
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
.
removePermissionRequest
-
The structure representing the <code>removePermissionRequest</code>.</p>
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.Future<SubmitFeedbackResult> submitFeedbackAsync(SubmitFeedbackRequest submitFeedbackRequest)
Sends feedback to CodeGuru Profiler about whether the anomaly detected by the analysis is useful or not.
submitFeedbackRequest
- The structure representing the SubmitFeedbackRequest.Future<SubmitFeedbackResult> submitFeedbackAsync(SubmitFeedbackRequest submitFeedbackRequest, AsyncHandler<SubmitFeedbackRequest,SubmitFeedbackResult> asyncHandler)
Sends feedback to CodeGuru Profiler about whether the anomaly detected by the analysis is useful or not.
submitFeedbackRequest
- The structure representing the SubmitFeedbackRequest.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest)
Use to assign one or more tags to a resource.
tagResourceRequest
- Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
Use to assign one or more tags to a resource.
tagResourceRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest)
Use to remove one or more tags from a resource.
untagResourceRequest
- Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
Use to remove one or more tags from a resource.
untagResourceRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateProfilingGroupResult> updateProfilingGroupAsync(UpdateProfilingGroupRequest updateProfilingGroupRequest)
Updates a profiling group.
updateProfilingGroupRequest
- The structure representing the updateProfilingGroupRequest.Future<UpdateProfilingGroupResult> updateProfilingGroupAsync(UpdateProfilingGroupRequest updateProfilingGroupRequest, AsyncHandler<UpdateProfilingGroupRequest,UpdateProfilingGroupResult> asyncHandler)
Updates a profiling group.
updateProfilingGroupRequest
- The structure representing the updateProfilingGroupRequest.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.