@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonCodeGuruProfiler extends Object implements AmazonCodeGuruProfiler
AmazonCodeGuruProfiler
. Convenient method forms pass through to the corresponding
overload that takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
AddNotificationChannelsResult |
addNotificationChannels(AddNotificationChannelsRequest request)
Add up to 2 anomaly notifications channels for a profiling group.
|
BatchGetFrameMetricDataResult |
batchGetFrameMetricData(BatchGetFrameMetricDataRequest request)
Returns the time series of values for a requested list of frame metrics from a time period.
|
ConfigureAgentResult |
configureAgent(ConfigureAgentRequest request)
Used by profiler agents to report their current state and to receive remote configuration updates.
|
CreateProfilingGroupResult |
createProfilingGroup(CreateProfilingGroupRequest request)
Creates a profiling group.
|
DeleteProfilingGroupResult |
deleteProfilingGroup(DeleteProfilingGroupRequest request)
Deletes a profiling group.
|
DescribeProfilingGroupResult |
describeProfilingGroup(DescribeProfilingGroupRequest request)
Returns a
ProfilingGroupDescription object that contains information about the requested profiling group. |
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetFindingsReportAccountSummaryResult |
getFindingsReportAccountSummary(GetFindingsReportAccountSummaryRequest request)
Returns a list of
FindingsReportSummary objects that contain analysis results for all profiling groups in your
AWS account. |
GetNotificationConfigurationResult |
getNotificationConfiguration(GetNotificationConfigurationRequest request)
Get the current configuration for anomaly notifications for a profiling group.
|
GetPolicyResult |
getPolicy(GetPolicyRequest request)
Returns the JSON-formatted resource-based policy on a profiling group.
|
GetProfileResult |
getProfile(GetProfileRequest request)
Gets the aggregated profile of a profiling group for a specified time range.
|
GetRecommendationsResult |
getRecommendations(GetRecommendationsRequest request)
Returns a list of
Recommendation objects that contain recommendations for a profiling group for a given time
period. |
ListFindingsReportsResult |
listFindingsReports(ListFindingsReportsRequest request)
List the available reports for a given profiling group and time range.
|
ListProfileTimesResult |
listProfileTimes(ListProfileTimesRequest request)
Lists the start times of the available aggregated profiles of a profiling group for an aggregation period within
the specified time range.
|
ListProfilingGroupsResult |
listProfilingGroups(ListProfilingGroupsRequest request)
Returns a list of profiling groups.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Returns a list of the tags that are assigned to a specified resource.
|
PostAgentProfileResult |
postAgentProfile(PostAgentProfileRequest request)
Submits profiling data to an aggregated profile of a profiling group.
|
PutPermissionResult |
putPermission(PutPermissionRequest request)
Adds permissions to a profiling group's resource-based policy that are provided using an action group.
|
RemoveNotificationChannelResult |
removeNotificationChannel(RemoveNotificationChannelRequest request)
Remove one anomaly notifications channel for a profiling group.
|
RemovePermissionResult |
removePermission(RemovePermissionRequest request)
Removes permissions from a profiling group's resource-based policy that are provided using an action group.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
SubmitFeedbackResult |
submitFeedback(SubmitFeedbackRequest request)
Sends feedback to CodeGuru Profiler about whether the anomaly detected by the analysis is useful or not.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Use to assign one or more tags to a resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Use to remove one or more tags from a resource.
|
UpdateProfilingGroupResult |
updateProfilingGroup(UpdateProfilingGroupRequest request)
Updates a profiling group.
|
public AddNotificationChannelsResult addNotificationChannels(AddNotificationChannelsRequest request)
AmazonCodeGuruProfiler
Add up to 2 anomaly notifications channels for a profiling group.
addNotificationChannels
in interface AmazonCodeGuruProfiler
request
- The structure representing the AddNotificationChannelsRequest.public BatchGetFrameMetricDataResult batchGetFrameMetricData(BatchGetFrameMetricDataRequest request)
AmazonCodeGuruProfiler
Returns the time series of values for a requested list of frame metrics from a time period.
batchGetFrameMetricData
in interface AmazonCodeGuruProfiler
request
- The structure representing the BatchGetFrameMetricDataRequest.public ConfigureAgentResult configureAgent(ConfigureAgentRequest request)
AmazonCodeGuruProfiler
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.
configureAgent
in interface AmazonCodeGuruProfiler
request
- The structure representing the configureAgentRequest.public CreateProfilingGroupResult createProfilingGroup(CreateProfilingGroupRequest request)
AmazonCodeGuruProfiler
Creates a profiling group.
createProfilingGroup
in interface AmazonCodeGuruProfiler
request
- The structure representing the createProfiliingGroupRequest.public DeleteProfilingGroupResult deleteProfilingGroup(DeleteProfilingGroupRequest request)
AmazonCodeGuruProfiler
Deletes a profiling group.
deleteProfilingGroup
in interface AmazonCodeGuruProfiler
request
- The structure representing the deleteProfilingGroupRequest.public DescribeProfilingGroupResult describeProfilingGroup(DescribeProfilingGroupRequest request)
AmazonCodeGuruProfiler
Returns a
ProfilingGroupDescription
object that contains information about the requested profiling group.
describeProfilingGroup
in interface AmazonCodeGuruProfiler
request
- The structure representing the describeProfilingGroupRequest.public GetFindingsReportAccountSummaryResult getFindingsReportAccountSummary(GetFindingsReportAccountSummaryRequest request)
AmazonCodeGuruProfiler
Returns a list of
FindingsReportSummary
objects that contain analysis results for all profiling groups in your
AWS account.
getFindingsReportAccountSummary
in interface AmazonCodeGuruProfiler
request
- The structure representing the GetFindingsReportAccountSummaryRequest.public GetNotificationConfigurationResult getNotificationConfiguration(GetNotificationConfigurationRequest request)
AmazonCodeGuruProfiler
Get the current configuration for anomaly notifications for a profiling group.
getNotificationConfiguration
in interface AmazonCodeGuruProfiler
request
- The structure representing the GetNotificationConfigurationRequest.public GetPolicyResult getPolicy(GetPolicyRequest request)
AmazonCodeGuruProfiler
Returns the JSON-formatted resource-based policy on a profiling group.
getPolicy
in interface AmazonCodeGuruProfiler
request
- The structure representing the getPolicyRequest
.public GetProfileResult getProfile(GetProfileRequest request)
AmazonCodeGuruProfiler
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>
getProfile
in interface AmazonCodeGuruProfiler
request
- The structure representing the getProfileRequest.public GetRecommendationsResult getRecommendations(GetRecommendationsRequest request)
AmazonCodeGuruProfiler
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.
getRecommendations
in interface AmazonCodeGuruProfiler
request
- The structure representing the GetRecommendationsRequest.public ListFindingsReportsResult listFindingsReports(ListFindingsReportsRequest request)
AmazonCodeGuruProfiler
List the available reports for a given profiling group and time range.
listFindingsReports
in interface AmazonCodeGuruProfiler
request
- The structure representing the ListFindingsReportsRequest.public ListProfileTimesResult listProfileTimes(ListProfileTimesRequest request)
AmazonCodeGuruProfiler
Lists the start times of the available aggregated profiles of a profiling group for an aggregation period within the specified time range.
listProfileTimes
in interface AmazonCodeGuruProfiler
request
- The structure representing the listProfileTimesRequest.public ListProfilingGroupsResult listProfilingGroups(ListProfilingGroupsRequest request)
AmazonCodeGuruProfiler
Returns a list of profiling groups. The profiling groups are returned as
ProfilingGroupDescription
objects.
listProfilingGroups
in interface AmazonCodeGuruProfiler
request
- The structure representing the listProfilingGroupsRequest.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AmazonCodeGuruProfiler
Returns a list of the tags that are assigned to a specified resource.
listTagsForResource
in interface AmazonCodeGuruProfiler
public PostAgentProfileResult postAgentProfile(PostAgentProfileRequest request)
AmazonCodeGuruProfiler
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
.
postAgentProfile
in interface AmazonCodeGuruProfiler
request
- The structure representing the postAgentProfileRequest.public PutPermissionResult putPermission(PutPermissionRequest request)
AmazonCodeGuruProfiler
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>
putPermission
in interface AmazonCodeGuruProfiler
request
- The structure representing the putPermissionRequest
.public RemoveNotificationChannelResult removeNotificationChannel(RemoveNotificationChannelRequest request)
AmazonCodeGuruProfiler
Remove one anomaly notifications channel for a profiling group.
removeNotificationChannel
in interface AmazonCodeGuruProfiler
request
- The structure representing the RemoveNotificationChannelRequest.public RemovePermissionResult removePermission(RemovePermissionRequest request)
AmazonCodeGuruProfiler
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
.
removePermission
in interface AmazonCodeGuruProfiler
request
-
The structure representing the <code>removePermissionRequest</code>.</p>
public SubmitFeedbackResult submitFeedback(SubmitFeedbackRequest request)
AmazonCodeGuruProfiler
Sends feedback to CodeGuru Profiler about whether the anomaly detected by the analysis is useful or not.
submitFeedback
in interface AmazonCodeGuruProfiler
request
- The structure representing the SubmitFeedbackRequest.public TagResourceResult tagResource(TagResourceRequest request)
AmazonCodeGuruProfiler
Use to assign one or more tags to a resource.
tagResource
in interface AmazonCodeGuruProfiler
public UntagResourceResult untagResource(UntagResourceRequest request)
AmazonCodeGuruProfiler
Use to remove one or more tags from a resource.
untagResource
in interface AmazonCodeGuruProfiler
public UpdateProfilingGroupResult updateProfilingGroup(UpdateProfilingGroupRequest request)
AmazonCodeGuruProfiler
Updates a profiling group.
updateProfilingGroup
in interface AmazonCodeGuruProfiler
request
- The structure representing the updateProfilingGroupRequest.public void shutdown()
AmazonCodeGuruProfiler
shutdown
in interface AmazonCodeGuruProfiler
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonCodeGuruProfiler
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.
getCachedResponseMetadata
in interface AmazonCodeGuruProfiler
request
- The originally executed request.