codeguruprofiler/aws.sdk.kotlin.services.codeguruprofiler/CodeGuruProfilerClient

CodeGuruProfilerClient

interface CodeGuruProfilerClient : SdkClient

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.

Types

Builder

class Builder : AbstractSdkClientBuilder<CodeGuruProfilerClient.Config, CodeGuruProfilerClient.Config.Builder, CodeGuruProfilerClient>

Companion

object Companion : AbstractAwsSdkClientFactory<CodeGuruProfilerClient.Config, CodeGuruProfilerClient.Config.Builder, CodeGuruProfilerClient, CodeGuruProfilerClient.Builder>

Config

class Config : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig, IdempotencyTokenConfig, RetryClientConfig, RetryStrategyClientConfig, SdkClientConfig, TelemetryConfig

Properties

config

abstract override val config: CodeGuruProfilerClient.Config

CodeGuruProfilerClient's configuration

Functions

addNotificationChannels

abstract suspend fun addNotificationChannels(input: AddNotificationChannelsRequest): AddNotificationChannelsResponse

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

batchGetFrameMetricData

abstract suspend fun batchGetFrameMetricData(input: BatchGetFrameMetricDataRequest): BatchGetFrameMetricDataResponse

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

configureAgent

abstract suspend fun configureAgent(input: ConfigureAgentRequest): ConfigureAgentResponse

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.

createProfilingGroup

abstract suspend fun createProfilingGroup(input: CreateProfilingGroupRequest): CreateProfilingGroupResponse

Creates a profiling group.

deleteProfilingGroup

abstract suspend fun deleteProfilingGroup(input: DeleteProfilingGroupRequest): DeleteProfilingGroupResponse

Deletes a profiling group.

describeProfilingGroup

abstract suspend fun describeProfilingGroup(input: DescribeProfilingGroupRequest): DescribeProfilingGroupResponse

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

getFindingsReportAccountSummary

abstract suspend fun getFindingsReportAccountSummary(input: GetFindingsReportAccountSummaryRequest = GetFindingsReportAccountSummaryRequest { }): GetFindingsReportAccountSummaryResponse

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

getNotificationConfiguration

abstract suspend fun getNotificationConfiguration(input: GetNotificationConfigurationRequest): GetNotificationConfigurationResponse

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

getPolicy

abstract suspend fun getPolicy(input: GetPolicyRequest): GetPolicyResponse

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

getProfile

abstract suspend fun getProfile(input: GetProfileRequest): 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

abstract suspend fun getRecommendations(input: GetRecommendationsRequest): 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

abstract suspend fun listFindingsReports(input: ListFindingsReportsRequest): ListFindingsReportsResponse

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

listProfileTimes

abstract suspend fun listProfileTimes(input: ListProfileTimesRequest): ListProfileTimesResponse

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

listProfilingGroups

abstract suspend fun listProfilingGroups(input: ListProfilingGroupsRequest = ListProfilingGroupsRequest { }): ListProfilingGroupsResponse

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

listTagsForResource

abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

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

postAgentProfile

abstract suspend fun postAgentProfile(input: PostAgentProfileRequest): PostAgentProfileResponse

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

abstract suspend fun putPermission(input: PutPermissionRequest): 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

abstract suspend fun removeNotificationChannel(input: RemoveNotificationChannelRequest): RemoveNotificationChannelResponse

Remove one anomaly notifications channel for a profiling group.

removePermission

abstract suspend fun removePermission(input: RemovePermissionRequest): 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

abstract suspend fun submitFeedback(input: SubmitFeedbackRequest): SubmitFeedbackResponse

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

tagResource

abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Use to assign one or more tags to a resource.

untagResource

abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

Use to remove one or more tags from a resource.

updateProfilingGroup

abstract suspend fun updateProfilingGroup(input: UpdateProfilingGroupRequest): UpdateProfilingGroupResponse

Updates a profiling group.

Inherited functions

addNotificationChannels

inline suspend fun CodeGuruProfilerClient.addNotificationChannels(crossinline block: AddNotificationChannelsRequest.Builder.() -> Unit): AddNotificationChannelsResponse

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

batchGetFrameMetricData

inline suspend fun CodeGuruProfilerClient.batchGetFrameMetricData(crossinline block: BatchGetFrameMetricDataRequest.Builder.() -> Unit): BatchGetFrameMetricDataResponse

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

expect abstract fun close()

configureAgent

inline suspend fun CodeGuruProfilerClient.configureAgent(crossinline block: ConfigureAgentRequest.Builder.() -> Unit): ConfigureAgentResponse

createProfilingGroup

inline suspend fun CodeGuruProfilerClient.createProfilingGroup(crossinline block: CreateProfilingGroupRequest.Builder.() -> Unit): CreateProfilingGroupResponse

Creates a profiling group.

deleteProfilingGroup

inline suspend fun CodeGuruProfilerClient.deleteProfilingGroup(crossinline block: DeleteProfilingGroupRequest.Builder.() -> Unit): DeleteProfilingGroupResponse

Deletes a profiling group.

describeProfilingGroup

inline suspend fun CodeGuruProfilerClient.describeProfilingGroup(crossinline block: DescribeProfilingGroupRequest.Builder.() -> Unit): DescribeProfilingGroupResponse

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

getFindingsReportAccountSummary

inline suspend fun CodeGuruProfilerClient.getFindingsReportAccountSummary(crossinline block: GetFindingsReportAccountSummaryRequest.Builder.() -> Unit): GetFindingsReportAccountSummaryResponse

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

getFindingsReportAccountSummaryPaginated

fun CodeGuruProfilerClient.getFindingsReportAccountSummaryPaginated(initialRequest: GetFindingsReportAccountSummaryRequest = GetFindingsReportAccountSummaryRequest { }): Flow<GetFindingsReportAccountSummaryResponse>

fun CodeGuruProfilerClient.getFindingsReportAccountSummaryPaginated(block: GetFindingsReportAccountSummaryRequest.Builder.() -> Unit): Flow<GetFindingsReportAccountSummaryResponse>

Paginate over GetFindingsReportAccountSummaryResponse results.

getNotificationConfiguration

inline suspend fun CodeGuruProfilerClient.getNotificationConfiguration(crossinline block: GetNotificationConfigurationRequest.Builder.() -> Unit): GetNotificationConfigurationResponse

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

getPolicy

inline suspend fun CodeGuruProfilerClient.getPolicy(crossinline block: GetPolicyRequest.Builder.() -> Unit): GetPolicyResponse

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

getProfile

inline suspend fun CodeGuruProfilerClient.getProfile(crossinline block: GetProfileRequest.Builder.() -> Unit): 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

inline suspend fun CodeGuruProfilerClient.getRecommendations(crossinline block: GetRecommendationsRequest.Builder.() -> Unit): GetRecommendationsResponse

listFindingsReports

inline suspend fun CodeGuruProfilerClient.listFindingsReports(crossinline block: ListFindingsReportsRequest.Builder.() -> Unit): ListFindingsReportsResponse

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

listFindingsReportsPaginated

fun CodeGuruProfilerClient.listFindingsReportsPaginated(initialRequest: ListFindingsReportsRequest): Flow<ListFindingsReportsResponse>

fun CodeGuruProfilerClient.listFindingsReportsPaginated(block: ListFindingsReportsRequest.Builder.() -> Unit): Flow<ListFindingsReportsResponse>

Paginate over ListFindingsReportsResponse results.

listProfileTimes

inline suspend fun CodeGuruProfilerClient.listProfileTimes(crossinline block: ListProfileTimesRequest.Builder.() -> Unit): ListProfileTimesResponse

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

listProfileTimesPaginated

fun CodeGuruProfilerClient.listProfileTimesPaginated(initialRequest: ListProfileTimesRequest): Flow<ListProfileTimesResponse>

fun CodeGuruProfilerClient.listProfileTimesPaginated(block: ListProfileTimesRequest.Builder.() -> Unit): Flow<ListProfileTimesResponse>

Paginate over ListProfileTimesResponse results.

listProfilingGroups

inline suspend fun CodeGuruProfilerClient.listProfilingGroups(crossinline block: ListProfilingGroupsRequest.Builder.() -> Unit): ListProfilingGroupsResponse

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

listProfilingGroupsPaginated

fun CodeGuruProfilerClient.listProfilingGroupsPaginated(initialRequest: ListProfilingGroupsRequest = ListProfilingGroupsRequest { }): Flow<ListProfilingGroupsResponse>

fun CodeGuruProfilerClient.listProfilingGroupsPaginated(block: ListProfilingGroupsRequest.Builder.() -> Unit): Flow<ListProfilingGroupsResponse>

Paginate over ListProfilingGroupsResponse results.

listTagsForResource

inline suspend fun CodeGuruProfilerClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

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

postAgentProfile

inline suspend fun CodeGuruProfilerClient.postAgentProfile(crossinline block: PostAgentProfileRequest.Builder.() -> Unit): PostAgentProfileResponse

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

inline suspend fun CodeGuruProfilerClient.putPermission(crossinline block: PutPermissionRequest.Builder.() -> Unit): PutPermissionResponse

removeNotificationChannel

inline suspend fun CodeGuruProfilerClient.removeNotificationChannel(crossinline block: RemoveNotificationChannelRequest.Builder.() -> Unit): RemoveNotificationChannelResponse

Remove one anomaly notifications channel for a profiling group.

removePermission

inline suspend fun CodeGuruProfilerClient.removePermission(crossinline block: RemovePermissionRequest.Builder.() -> Unit): RemovePermissionResponse

submitFeedback

inline suspend fun CodeGuruProfilerClient.submitFeedback(crossinline block: SubmitFeedbackRequest.Builder.() -> Unit): SubmitFeedbackResponse

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

tagResource

inline suspend fun CodeGuruProfilerClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Use to assign one or more tags to a resource.

untagResource

inline suspend fun CodeGuruProfilerClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Use to remove one or more tags from a resource.

updateProfilingGroup

inline suspend fun CodeGuruProfilerClient.updateProfilingGroup(crossinline block: UpdateProfilingGroupRequest.Builder.() -> Unit): UpdateProfilingGroupResponse

Updates a profiling group.

withConfig

fun CodeGuruProfilerClient.withConfig(block: CodeGuruProfilerClient.Config.Builder.() -> Unit): CodeGuruProfilerClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.