CodeGuruProfiler class

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>

Constructors

CodeGuruProfiler({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

addNotificationChannels({required List<Channel> channels, required String profilingGroupName}) → Future<AddNotificationChannelsResponse>
Add up to 2 anomaly notifications channels for a profiling group.
batchGetFrameMetricData({required String profilingGroupName, DateTime? endTime, List<FrameMetric>? frameMetrics, String? period, DateTime? startTime, AggregationPeriod? targetResolution}) → Future<BatchGetFrameMetricDataResponse>
Returns the time series of values for a requested list of frame metrics from a time period.
close() → void
Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.
configureAgent({required String profilingGroupName, String? fleetInstanceId, Map<MetadataField, String>? metadata}) → Future<ConfigureAgentResponse>
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.
createProfilingGroup({required String profilingGroupName, AgentOrchestrationConfig? agentOrchestrationConfig, String? clientToken, ComputePlatform? computePlatform, Map<String, String>? tags}) → Future<CreateProfilingGroupResponse>
Creates a profiling group.
deleteProfilingGroup({required String profilingGroupName}) → Future<void>
Deletes a profiling group.
describeProfilingGroup({required String profilingGroupName}) → Future<DescribeProfilingGroupResponse>
Returns a ProfilingGroupDescription object that contains information about the requested profiling group.
getFindingsReportAccountSummary({bool? dailyReportsOnly, int? maxResults, String? nextToken}) → Future<GetFindingsReportAccountSummaryResponse>
Returns a list of FindingsReportSummary objects that contain analysis results for all profiling groups in your AWS account.
getNotificationConfiguration({required String profilingGroupName}) → Future<GetNotificationConfigurationResponse>
Get the current configuration for anomaly notifications for a profiling group.
getPolicy({required String profilingGroupName}) → Future<GetPolicyResponse>
Returns the JSON-formatted resource-based policy on a profiling group.
getProfile({required String profilingGroupName, String? accept, DateTime? endTime, int? maxDepth, String? period, DateTime? startTime}) → Future<GetProfileResponse>
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.
getRecommendations({required DateTime endTime, required String profilingGroupName, required DateTime startTime, String? locale}) → Future<GetRecommendationsResponse>
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.
listFindingsReports({required DateTime endTime, required String profilingGroupName, required DateTime startTime, bool? dailyReportsOnly, int? maxResults, String? nextToken}) → Future<ListFindingsReportsResponse>
List the available reports for a given profiling group and time range.
listProfileTimes({required DateTime endTime, required AggregationPeriod period, required String profilingGroupName, required DateTime startTime, int? maxResults, String? nextToken, OrderBy? orderBy}) → Future<ListProfileTimesResponse>
Lists the start times of the available aggregated profiles of a profiling group for an aggregation period within the specified time range.
listProfilingGroups({bool? includeDescription, int? maxResults, String? nextToken}) → Future<ListProfilingGroupsResponse>
Returns a list of profiling groups. The profiling groups are returned as ProfilingGroupDescription objects.
listTagsForResource({required String resourceArn}) → Future<ListTagsForResourceResponse>
Returns a list of the tags that are assigned to a specified resource.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
postAgentProfile({required Uint8List agentProfile, required String contentType, required String profilingGroupName, String? profileToken}) → Future<void>
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 .
putPermission({required ActionGroup actionGroup, required List<String> principals, required String profilingGroupName, String? revisionId}) → Future<PutPermissionResponse>
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.
removeNotificationChannel({required String channelId, required String profilingGroupName}) → Future<RemoveNotificationChannelResponse>
Remove one anomaly notifications channel for a profiling group.
removePermission({required ActionGroup actionGroup, required String profilingGroupName, required String revisionId}) → Future<RemovePermissionResponse>
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 .
submitFeedback({required String anomalyInstanceId, required String profilingGroupName, required FeedbackType type, String? comment}) → Future<void>
Sends feedback to CodeGuru Profiler about whether the anomaly detected by the analysis is useful or not.
tagResource({required String resourceArn, required Map<String, String> tags}) → Future<void>
Use to assign one or more tags to a resource.
toString() → String
A string representation of this object.
inherited
untagResource({required String resourceArn, required List<String> tagKeys}) → Future<void>
Use to remove one or more tags from a resource.
updateProfilingGroup({required AgentOrchestrationConfig agentOrchestrationConfig, required String profilingGroupName}) → Future<UpdateProfilingGroupResponse>
Updates a profiling group.

Operators

operator ==(Object other) → bool
The equality operator.
inherited