com.amazonaws.services.codeguruprofiler

Class AbstractAmazonCodeGuruProfiler

java.lang.Object

com.amazonaws.services.codeguruprofiler.AbstractAmazonCodeGuruProfiler

All Implemented Interfaces:

AmazonCodeGuruProfiler

Direct Known Subclasses:

AbstractAmazonCodeGuruProfilerAsync

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAmazonCodeGuruProfiler
extends Object
implements AmazonCodeGuruProfiler

Abstract implementation of AmazonCodeGuruProfiler. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary

Fields inherited from interface com.amazonaws.services.codeguruprofiler.AmazonCodeGuruProfiler

ENDPOINT_PREFIX

Method Summary

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.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

addNotificationChannels

public AddNotificationChannelsResult addNotificationChannels(AddNotificationChannelsRequest request)

Description copied from interface: AmazonCodeGuruProfiler

Add up to 2 anomaly notifications channels for a profiling group.

Specified by:

addNotificationChannels in interface AmazonCodeGuruProfiler

Parameters:

request - The structure representing the AddNotificationChannelsRequest.

Returns:

Result of the AddNotificationChannels operation returned by the service.

See Also:

AWS API Documentation

batchGetFrameMetricData

public BatchGetFrameMetricDataResult batchGetFrameMetricData(BatchGetFrameMetricDataRequest request)

Description copied from interface: AmazonCodeGuruProfiler

Returns the time series of values for a requested list of frame metrics from a time period.

Specified by:

batchGetFrameMetricData in interface AmazonCodeGuruProfiler

Parameters:

request - The structure representing the BatchGetFrameMetricDataRequest.

Returns:

Result of the BatchGetFrameMetricData operation returned by the service.

See Also:

AWS API Documentation

configureAgent

public ConfigureAgentResult configureAgent(ConfigureAgentRequest request)

Description copied from interface: 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.

Specified by:

configureAgent in interface AmazonCodeGuruProfiler

Parameters:

request - The structure representing the configureAgentRequest.

Returns:

Result of the ConfigureAgent operation returned by the service.

See Also:

AWS API Documentation

createProfilingGroup

public CreateProfilingGroupResult createProfilingGroup(CreateProfilingGroupRequest request)

Description copied from interface: AmazonCodeGuruProfiler

Creates a profiling group.

Specified by:

createProfilingGroup in interface AmazonCodeGuruProfiler

Parameters:

request - The structure representing the createProfiliingGroupRequest.

Returns:

Result of the CreateProfilingGroup operation returned by the service.

See Also:

AWS API Documentation

deleteProfilingGroup

public DeleteProfilingGroupResult deleteProfilingGroup(DeleteProfilingGroupRequest request)

Description copied from interface: AmazonCodeGuruProfiler

Deletes a profiling group.

Specified by:

deleteProfilingGroup in interface AmazonCodeGuruProfiler

Parameters:

request - The structure representing the deleteProfilingGroupRequest.

Returns:

Result of the DeleteProfilingGroup operation returned by the service.

See Also:

AWS API Documentation

describeProfilingGroup

public DescribeProfilingGroupResult describeProfilingGroup(DescribeProfilingGroupRequest request)

Description copied from interface: AmazonCodeGuruProfiler

Returns a ProfilingGroupDescription object that contains information about the requested profiling group.

Specified by:

describeProfilingGroup in interface AmazonCodeGuruProfiler

Parameters:

request - The structure representing the describeProfilingGroupRequest.

Returns:

Result of the DescribeProfilingGroup operation returned by the service.

See Also:

AWS API Documentation

getFindingsReportAccountSummary

public GetFindingsReportAccountSummaryResult getFindingsReportAccountSummary(GetFindingsReportAccountSummaryRequest request)

Description copied from interface: AmazonCodeGuruProfiler

Returns a list of FindingsReportSummary objects that contain analysis results for all profiling groups in your AWS account.

Specified by:

getFindingsReportAccountSummary in interface AmazonCodeGuruProfiler

Parameters:

request - The structure representing the GetFindingsReportAccountSummaryRequest.

Returns:

Result of the GetFindingsReportAccountSummary operation returned by the service.

See Also:

AWS API Documentation

getNotificationConfiguration

public GetNotificationConfigurationResult getNotificationConfiguration(GetNotificationConfigurationRequest request)

Description copied from interface: AmazonCodeGuruProfiler

Get the current configuration for anomaly notifications for a profiling group.

Specified by:

getNotificationConfiguration in interface AmazonCodeGuruProfiler

Parameters:

request - The structure representing the GetNotificationConfigurationRequest.

Returns:

Result of the GetNotificationConfiguration operation returned by the service.

See Also:

AWS API Documentation

getPolicy

public GetPolicyResult getPolicy(GetPolicyRequest request)

Description copied from interface: AmazonCodeGuruProfiler

Returns the JSON-formatted resource-based policy on a profiling group.

Specified by:

getPolicy in interface AmazonCodeGuruProfiler

Parameters:

request - The structure representing the getPolicyRequest.

Returns:

Result of the GetPolicy operation returned by the service.

See Also:

AWS API Documentation

getProfile

public GetProfileResult getProfile(GetProfileRequest request)

Description copied from interface: 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> 
 

Specified by:

getProfile in interface AmazonCodeGuruProfiler

Parameters:

request - The structure representing the getProfileRequest.

Returns:

Result of the GetProfile operation returned by the service.

See Also:

AWS API Documentation

getRecommendations

public GetRecommendationsResult getRecommendations(GetRecommendationsRequest request)

Description copied from interface: 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.

Specified by:

getRecommendations in interface AmazonCodeGuruProfiler

Parameters:

request - The structure representing the GetRecommendationsRequest.

Returns:

Result of the GetRecommendations operation returned by the service.

See Also:

AWS API Documentation

listFindingsReports

public ListFindingsReportsResult listFindingsReports(ListFindingsReportsRequest request)

Description copied from interface: AmazonCodeGuruProfiler

List the available reports for a given profiling group and time range.

Specified by:

listFindingsReports in interface AmazonCodeGuruProfiler

Parameters:

request - The structure representing the ListFindingsReportsRequest.

Returns:

Result of the ListFindingsReports operation returned by the service.

See Also:

AWS API Documentation

listProfileTimes

public ListProfileTimesResult listProfileTimes(ListProfileTimesRequest request)

Description copied from interface: AmazonCodeGuruProfiler

Lists the start times of the available aggregated profiles of a profiling group for an aggregation period within the specified time range.

Specified by:

listProfileTimes in interface AmazonCodeGuruProfiler

Parameters:

request - The structure representing the listProfileTimesRequest.

Returns:

Result of the ListProfileTimes operation returned by the service.

See Also:

AWS API Documentation

listProfilingGroups

public ListProfilingGroupsResult listProfilingGroups(ListProfilingGroupsRequest request)

Description copied from interface: AmazonCodeGuruProfiler

Returns a list of profiling groups. The profiling groups are returned as ProfilingGroupDescription objects.

Specified by:

listProfilingGroups in interface AmazonCodeGuruProfiler

Parameters:

request - The structure representing the listProfilingGroupsRequest.

Returns:

Result of the ListProfilingGroups operation returned by the service.

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Description copied from interface: AmazonCodeGuruProfiler

Returns a list of the tags that are assigned to a specified resource.

Specified by:

listTagsForResource in interface AmazonCodeGuruProfiler

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

AWS API Documentation

postAgentProfile

public PostAgentProfileResult postAgentProfile(PostAgentProfileRequest request)

Description copied from interface: 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 .

Specified by:

postAgentProfile in interface AmazonCodeGuruProfiler

Parameters:

request - The structure representing the postAgentProfileRequest.

Returns:

Result of the PostAgentProfile operation returned by the service.

See Also:

AWS API Documentation

putPermission

public PutPermissionResult putPermission(PutPermissionRequest request)

Description copied from interface: 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> 
 

Specified by:

putPermission in interface AmazonCodeGuruProfiler

Parameters:

request - The structure representing the putPermissionRequest.

Returns:

Result of the PutPermission operation returned by the service.

See Also:

AWS API Documentation

removeNotificationChannel

public RemoveNotificationChannelResult removeNotificationChannel(RemoveNotificationChannelRequest request)

Description copied from interface: AmazonCodeGuruProfiler

Remove one anomaly notifications channel for a profiling group.

Specified by:

removeNotificationChannel in interface AmazonCodeGuruProfiler

Parameters:

request - The structure representing the RemoveNotificationChannelRequest.

Returns:

Result of the RemoveNotificationChannel operation returned by the service.

See Also:

AWS API Documentation

removePermission

public RemovePermissionResult removePermission(RemovePermissionRequest request)

Description copied from interface: 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 .

Specified by:

removePermission in interface AmazonCodeGuruProfiler

Parameters:

request -

  The structure representing the <code>removePermissionRequest</code>.</p> 

Returns:

Result of the RemovePermission operation returned by the service.

See Also:

AWS API Documentation

submitFeedback

public SubmitFeedbackResult submitFeedback(SubmitFeedbackRequest request)

Description copied from interface: AmazonCodeGuruProfiler

Sends feedback to CodeGuru Profiler about whether the anomaly detected by the analysis is useful or not.

Specified by:

submitFeedback in interface AmazonCodeGuruProfiler

Parameters:

request - The structure representing the SubmitFeedbackRequest.

Returns:

Result of the SubmitFeedback operation returned by the service.

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

Description copied from interface: AmazonCodeGuruProfiler

Use to assign one or more tags to a resource.

Specified by:

tagResource in interface AmazonCodeGuruProfiler

Returns:

Result of the TagResource operation returned by the service.

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Description copied from interface: AmazonCodeGuruProfiler

Use to remove one or more tags from a resource.

Specified by:

untagResource in interface AmazonCodeGuruProfiler

Returns:

Result of the UntagResource operation returned by the service.

See Also:

AWS API Documentation

updateProfilingGroup

public UpdateProfilingGroupResult updateProfilingGroup(UpdateProfilingGroupRequest request)

Description copied from interface: AmazonCodeGuruProfiler

Updates a profiling group.

Specified by:

updateProfilingGroup in interface AmazonCodeGuruProfiler

Parameters:

request - The structure representing the updateProfilingGroupRequest.

Returns:

Result of the UpdateProfilingGroup operation returned by the service.

See Also:

AWS API Documentation

shutdown

public void shutdown()

Description copied from interface: AmazonCodeGuruProfiler

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.

Specified by:

shutdown in interface AmazonCodeGuruProfiler

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Description copied from interface: AmazonCodeGuruProfiler

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.

Specified by:

getCachedResponseMetadata in interface AmazonCodeGuruProfiler

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.