Package software.amazon.awssdk.services.codeguruprofiler

Interface CodeGuruProfilerClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface CodeGuruProfilerClient
extends AwsClient

Service client for accessing Amazon CodeGuru Profiler. This can be created using the static builder() method.

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.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
default AddNotificationChannelsResponse	addNotificationChannels(Consumer<AddNotificationChannelsRequest.Builder> addNotificationChannelsRequest)	Add up to 2 anomaly notifications channels for a profiling group.
default AddNotificationChannelsResponse	addNotificationChannels(AddNotificationChannelsRequest addNotificationChannelsRequest)	Add up to 2 anomaly notifications channels for a profiling group.
default BatchGetFrameMetricDataResponse	batchGetFrameMetricData(Consumer<BatchGetFrameMetricDataRequest.Builder> batchGetFrameMetricDataRequest)	Returns the time series of values for a requested list of frame metrics from a time period.
default BatchGetFrameMetricDataResponse	batchGetFrameMetricData(BatchGetFrameMetricDataRequest batchGetFrameMetricDataRequest)	Returns the time series of values for a requested list of frame metrics from a time period.
static CodeGuruProfilerClientBuilder	builder()	Create a builder that can be used to configure and create a CodeGuruProfilerClient.
default ConfigureAgentResponse	configureAgent(Consumer<ConfigureAgentRequest.Builder> configureAgentRequest)	Used by profiler agents to report their current state and to receive remote configuration updates.
default ConfigureAgentResponse	configureAgent(ConfigureAgentRequest configureAgentRequest)	Used by profiler agents to report their current state and to receive remote configuration updates.
static CodeGuruProfilerClient	create()	Create a CodeGuruProfilerClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateProfilingGroupResponse	createProfilingGroup(Consumer<CreateProfilingGroupRequest.Builder> createProfilingGroupRequest)	Creates a profiling group.
default CreateProfilingGroupResponse	createProfilingGroup(CreateProfilingGroupRequest createProfilingGroupRequest)	Creates a profiling group.
default DeleteProfilingGroupResponse	deleteProfilingGroup(Consumer<DeleteProfilingGroupRequest.Builder> deleteProfilingGroupRequest)	Deletes a profiling group.
default DeleteProfilingGroupResponse	deleteProfilingGroup(DeleteProfilingGroupRequest deleteProfilingGroupRequest)	Deletes a profiling group.
default DescribeProfilingGroupResponse	describeProfilingGroup(Consumer<DescribeProfilingGroupRequest.Builder> describeProfilingGroupRequest)	Returns a ProfilingGroupDescription object that contains information about the requested profiling group.
default DescribeProfilingGroupResponse	describeProfilingGroup(DescribeProfilingGroupRequest describeProfilingGroupRequest)	Returns a ProfilingGroupDescription object that contains information about the requested profiling group.
default GetFindingsReportAccountSummaryResponse	getFindingsReportAccountSummary(Consumer<GetFindingsReportAccountSummaryRequest.Builder> getFindingsReportAccountSummaryRequest)	Returns a list of FindingsReportSummary objects that contain analysis results for all profiling groups in your AWS account.
default GetFindingsReportAccountSummaryResponse	getFindingsReportAccountSummary(GetFindingsReportAccountSummaryRequest getFindingsReportAccountSummaryRequest)	Returns a list of FindingsReportSummary objects that contain analysis results for all profiling groups in your AWS account.
default GetFindingsReportAccountSummaryIterable	getFindingsReportAccountSummaryPaginator(Consumer<GetFindingsReportAccountSummaryRequest.Builder> getFindingsReportAccountSummaryRequest)	This is a variant of getFindingsReportAccountSummary(software.amazon.awssdk.services.codeguruprofiler.model.GetFindingsReportAccountSummaryRequest) operation.
default GetFindingsReportAccountSummaryIterable	getFindingsReportAccountSummaryPaginator(GetFindingsReportAccountSummaryRequest getFindingsReportAccountSummaryRequest)	This is a variant of getFindingsReportAccountSummary(software.amazon.awssdk.services.codeguruprofiler.model.GetFindingsReportAccountSummaryRequest) operation.
default GetNotificationConfigurationResponse	getNotificationConfiguration(Consumer<GetNotificationConfigurationRequest.Builder> getNotificationConfigurationRequest)	Get the current configuration for anomaly notifications for a profiling group.
default GetNotificationConfigurationResponse	getNotificationConfiguration(GetNotificationConfigurationRequest getNotificationConfigurationRequest)	Get the current configuration for anomaly notifications for a profiling group.
default GetPolicyResponse	getPolicy(Consumer<GetPolicyRequest.Builder> getPolicyRequest)	Returns the JSON-formatted resource-based policy on a profiling group.
default GetPolicyResponse	getPolicy(GetPolicyRequest getPolicyRequest)	Returns the JSON-formatted resource-based policy on a profiling group.
default GetProfileResponse	getProfile(Consumer<GetProfileRequest.Builder> getProfileRequest)	Gets the aggregated profile of a profiling group for a specified time range.
default GetProfileResponse	getProfile(GetProfileRequest getProfileRequest)	Gets the aggregated profile of a profiling group for a specified time range.
default GetRecommendationsResponse	getRecommendations(Consumer<GetRecommendationsRequest.Builder> getRecommendationsRequest)	Returns a list of Recommendation objects that contain recommendations for a profiling group for a given time period.
default GetRecommendationsResponse	getRecommendations(GetRecommendationsRequest getRecommendationsRequest)	Returns a list of Recommendation objects that contain recommendations for a profiling group for a given time period.
default ListFindingsReportsResponse	listFindingsReports(Consumer<ListFindingsReportsRequest.Builder> listFindingsReportsRequest)	List the available reports for a given profiling group and time range.
default ListFindingsReportsResponse	listFindingsReports(ListFindingsReportsRequest listFindingsReportsRequest)	List the available reports for a given profiling group and time range.
default ListFindingsReportsIterable	listFindingsReportsPaginator(Consumer<ListFindingsReportsRequest.Builder> listFindingsReportsRequest)	This is a variant of listFindingsReports(software.amazon.awssdk.services.codeguruprofiler.model.ListFindingsReportsRequest) operation.
default ListFindingsReportsIterable	listFindingsReportsPaginator(ListFindingsReportsRequest listFindingsReportsRequest)	This is a variant of listFindingsReports(software.amazon.awssdk.services.codeguruprofiler.model.ListFindingsReportsRequest) operation.
default ListProfileTimesResponse	listProfileTimes(Consumer<ListProfileTimesRequest.Builder> listProfileTimesRequest)	Lists the start times of the available aggregated profiles of a profiling group for an aggregation period within the specified time range.
default ListProfileTimesResponse	listProfileTimes(ListProfileTimesRequest listProfileTimesRequest)	Lists the start times of the available aggregated profiles of a profiling group for an aggregation period within the specified time range.
default ListProfileTimesIterable	listProfileTimesPaginator(Consumer<ListProfileTimesRequest.Builder> listProfileTimesRequest)	This is a variant of listProfileTimes(software.amazon.awssdk.services.codeguruprofiler.model.ListProfileTimesRequest) operation.
default ListProfileTimesIterable	listProfileTimesPaginator(ListProfileTimesRequest listProfileTimesRequest)	This is a variant of listProfileTimes(software.amazon.awssdk.services.codeguruprofiler.model.ListProfileTimesRequest) operation.
default ListProfilingGroupsResponse	listProfilingGroups(Consumer<ListProfilingGroupsRequest.Builder> listProfilingGroupsRequest)	Returns a list of profiling groups.
default ListProfilingGroupsResponse	listProfilingGroups(ListProfilingGroupsRequest listProfilingGroupsRequest)	Returns a list of profiling groups.
default ListProfilingGroupsIterable	listProfilingGroupsPaginator(Consumer<ListProfilingGroupsRequest.Builder> listProfilingGroupsRequest)	This is a variant of listProfilingGroups(software.amazon.awssdk.services.codeguruprofiler.model.ListProfilingGroupsRequest) operation.
default ListProfilingGroupsIterable	listProfilingGroupsPaginator(ListProfilingGroupsRequest listProfilingGroupsRequest)	This is a variant of listProfilingGroups(software.amazon.awssdk.services.codeguruprofiler.model.ListProfilingGroupsRequest) operation.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	Returns a list of the tags that are assigned to a specified resource.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	Returns a list of the tags that are assigned to a specified resource.
default PostAgentProfileResponse	postAgentProfile(Consumer<PostAgentProfileRequest.Builder> postAgentProfileRequest)	Submits profiling data to an aggregated profile of a profiling group.
default PostAgentProfileResponse	postAgentProfile(PostAgentProfileRequest postAgentProfileRequest)	Submits profiling data to an aggregated profile of a profiling group.
default PutPermissionResponse	putPermission(Consumer<PutPermissionRequest.Builder> putPermissionRequest)	Adds permissions to a profiling group's resource-based policy that are provided using an action group.
default PutPermissionResponse	putPermission(PutPermissionRequest putPermissionRequest)	Adds permissions to a profiling group's resource-based policy that are provided using an action group.
default RemoveNotificationChannelResponse	removeNotificationChannel(Consumer<RemoveNotificationChannelRequest.Builder> removeNotificationChannelRequest)	Remove one anomaly notifications channel for a profiling group.
default RemoveNotificationChannelResponse	removeNotificationChannel(RemoveNotificationChannelRequest removeNotificationChannelRequest)	Remove one anomaly notifications channel for a profiling group.
default RemovePermissionResponse	removePermission(Consumer<RemovePermissionRequest.Builder> removePermissionRequest)	Removes permissions from a profiling group's resource-based policy that are provided using an action group.
default RemovePermissionResponse	removePermission(RemovePermissionRequest removePermissionRequest)	Removes permissions from a profiling group's resource-based policy that are provided using an action group.
default CodeGuruProfilerServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default SubmitFeedbackResponse	submitFeedback(Consumer<SubmitFeedbackRequest.Builder> submitFeedbackRequest)	Sends feedback to CodeGuru Profiler about whether the anomaly detected by the analysis is useful or not.
default SubmitFeedbackResponse	submitFeedback(SubmitFeedbackRequest submitFeedbackRequest)	Sends feedback to CodeGuru Profiler about whether the anomaly detected by the analysis is useful or not.
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)	Use to assign one or more tags to a resource.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	Use to assign one or more tags to a resource.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	Use to remove one or more tags from a resource.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest)	Use to remove one or more tags from a resource.
default UpdateProfilingGroupResponse	updateProfilingGroup(Consumer<UpdateProfilingGroupRequest.Builder> updateProfilingGroupRequest)	Updates a profiling group.
default UpdateProfilingGroupResponse	updateProfilingGroup(UpdateProfilingGroupRequest updateProfilingGroupRequest)	Updates a profiling group.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

addNotificationChannels

default AddNotificationChannelsResponse addNotificationChannels(AddNotificationChannelsRequest addNotificationChannelsRequest)
                                                         throws ServiceQuotaExceededException,
InternalServerException,
ConflictException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CodeGuruProfilerException

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

Parameters:

addNotificationChannelsRequest - The structure representing the AddNotificationChannelsRequest.

Returns:

Result of the AddNotificationChannels operation returned by the service.

See Also:

• AWS API Documentation

addNotificationChannels

default AddNotificationChannelsResponse addNotificationChannels(Consumer<AddNotificationChannelsRequest.Builder> addNotificationChannelsRequest)
                                                         throws ServiceQuotaExceededException,
InternalServerException,
ConflictException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CodeGuruProfilerException

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

This is a convenience which creates an instance of the AddNotificationChannelsRequest.Builder avoiding the need to create one manually via AddNotificationChannelsRequest.builder()

Parameters:

addNotificationChannelsRequest - A Consumer that will call methods on AddNotificationChannelsRequest.Builder to create a request. The structure representing the AddNotificationChannelsRequest.

Returns:

Result of the AddNotificationChannels operation returned by the service.

See Also:

• AWS API Documentation

batchGetFrameMetricData

default BatchGetFrameMetricDataResponse batchGetFrameMetricData(BatchGetFrameMetricDataRequest batchGetFrameMetricDataRequest)
                                                         throws InternalServerException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CodeGuruProfilerException

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

Parameters:

batchGetFrameMetricDataRequest - The structure representing the BatchGetFrameMetricDataRequest.

Returns:

Result of the BatchGetFrameMetricData operation returned by the service.

See Also:

• AWS API Documentation

batchGetFrameMetricData

default BatchGetFrameMetricDataResponse batchGetFrameMetricData(Consumer<BatchGetFrameMetricDataRequest.Builder> batchGetFrameMetricDataRequest)
                                                         throws InternalServerException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CodeGuruProfilerException

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

This is a convenience which creates an instance of the BatchGetFrameMetricDataRequest.Builder avoiding the need to create one manually via BatchGetFrameMetricDataRequest.builder()

Parameters:

batchGetFrameMetricDataRequest - A Consumer that will call methods on BatchGetFrameMetricDataRequest.Builder to create a request. The structure representing the BatchGetFrameMetricDataRequest.

Returns:

Result of the BatchGetFrameMetricData operation returned by the service.

See Also:

• AWS API Documentation

configureAgent

default ConfigureAgentResponse configureAgent(ConfigureAgentRequest configureAgentRequest)
                                       throws InternalServerException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CodeGuruProfilerException

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.

Parameters:

configureAgentRequest - The structure representing the configureAgentRequest.

Returns:

Result of the ConfigureAgent operation returned by the service.

See Also:

• AWS API Documentation

configureAgent

default ConfigureAgentResponse configureAgent(Consumer<ConfigureAgentRequest.Builder> configureAgentRequest)
                                       throws InternalServerException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CodeGuruProfilerException

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.

This is a convenience which creates an instance of the ConfigureAgentRequest.Builder avoiding the need to create one manually via ConfigureAgentRequest.builder()

Parameters:

configureAgentRequest - A Consumer that will call methods on ConfigureAgentRequest.Builder to create a request. The structure representing the configureAgentRequest.

Returns:

Result of the ConfigureAgent operation returned by the service.

See Also:

• AWS API Documentation

createProfilingGroup

default CreateProfilingGroupResponse createProfilingGroup(CreateProfilingGroupRequest createProfilingGroupRequest)
                                                   throws ServiceQuotaExceededException,
InternalServerException,
ConflictException,
ValidationException,
ThrottlingException,
AwsServiceException,
SdkClientException,
CodeGuruProfilerException

Creates a profiling group.

Parameters:

createProfilingGroupRequest - The structure representing the createProfiliingGroupRequest.

Returns:

Result of the CreateProfilingGroup operation returned by the service.

See Also:

• AWS API Documentation

createProfilingGroup

default CreateProfilingGroupResponse createProfilingGroup(Consumer<CreateProfilingGroupRequest.Builder> createProfilingGroupRequest)
                                                   throws ServiceQuotaExceededException,
InternalServerException,
ConflictException,
ValidationException,
ThrottlingException,
AwsServiceException,
SdkClientException,
CodeGuruProfilerException

Creates a profiling group.

This is a convenience which creates an instance of the CreateProfilingGroupRequest.Builder avoiding the need to create one manually via CreateProfilingGroupRequest.builder()

Parameters:

createProfilingGroupRequest - A Consumer that will call methods on CreateProfilingGroupRequest.Builder to create a request. The structure representing the createProfiliingGroupRequest.

Returns:

Result of the CreateProfilingGroup operation returned by the service.

See Also:

• AWS API Documentation

deleteProfilingGroup

default DeleteProfilingGroupResponse deleteProfilingGroup(DeleteProfilingGroupRequest deleteProfilingGroupRequest)
                                                   throws InternalServerException,
ConflictException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CodeGuruProfilerException

Deletes a profiling group.

Parameters:

deleteProfilingGroupRequest - The structure representing the deleteProfilingGroupRequest.

Returns:

Result of the DeleteProfilingGroup operation returned by the service.

See Also:

• AWS API Documentation

deleteProfilingGroup

default DeleteProfilingGroupResponse deleteProfilingGroup(Consumer<DeleteProfilingGroupRequest.Builder> deleteProfilingGroupRequest)
                                                   throws InternalServerException,
ConflictException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CodeGuruProfilerException

Deletes a profiling group.

This is a convenience which creates an instance of the DeleteProfilingGroupRequest.Builder avoiding the need to create one manually via DeleteProfilingGroupRequest.builder()

Parameters:

deleteProfilingGroupRequest - A Consumer that will call methods on DeleteProfilingGroupRequest.Builder to create a request. The structure representing the deleteProfilingGroupRequest.

Returns:

Result of the DeleteProfilingGroup operation returned by the service.

See Also:

• AWS API Documentation

describeProfilingGroup

default DescribeProfilingGroupResponse describeProfilingGroup(DescribeProfilingGroupRequest describeProfilingGroupRequest)
                                                       throws InternalServerException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CodeGuruProfilerException

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

Parameters:

describeProfilingGroupRequest - The structure representing the describeProfilingGroupRequest.

Returns:

Result of the DescribeProfilingGroup operation returned by the service.

See Also:

• AWS API Documentation

describeProfilingGroup

default DescribeProfilingGroupResponse describeProfilingGroup(Consumer<DescribeProfilingGroupRequest.Builder> describeProfilingGroupRequest)
                                                       throws InternalServerException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CodeGuruProfilerException

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

This is a convenience which creates an instance of the DescribeProfilingGroupRequest.Builder avoiding the need to create one manually via DescribeProfilingGroupRequest.builder()

Parameters:

describeProfilingGroupRequest - A Consumer that will call methods on DescribeProfilingGroupRequest.Builder to create a request. The structure representing the describeProfilingGroupRequest.

Returns:

Result of the DescribeProfilingGroup operation returned by the service.

See Also:

• AWS API Documentation

getFindingsReportAccountSummary

default GetFindingsReportAccountSummaryResponse getFindingsReportAccountSummary(GetFindingsReportAccountSummaryRequest getFindingsReportAccountSummaryRequest)
                                                                         throws InternalServerException,
ValidationException,
ThrottlingException,
AwsServiceException,
SdkClientException,
CodeGuruProfilerException

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

Parameters:

getFindingsReportAccountSummaryRequest - The structure representing the GetFindingsReportAccountSummaryRequest.

Returns:

Result of the GetFindingsReportAccountSummary operation returned by the service.

See Also:

• AWS API Documentation

getFindingsReportAccountSummary

default GetFindingsReportAccountSummaryResponse getFindingsReportAccountSummary(Consumer<GetFindingsReportAccountSummaryRequest.Builder> getFindingsReportAccountSummaryRequest)
                                                                         throws InternalServerException,
ValidationException,
ThrottlingException,
AwsServiceException,
SdkClientException,
CodeGuruProfilerException

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

This is a convenience which creates an instance of the GetFindingsReportAccountSummaryRequest.Builder avoiding the need to create one manually via GetFindingsReportAccountSummaryRequest.builder()

Parameters:

getFindingsReportAccountSummaryRequest - A Consumer that will call methods on GetFindingsReportAccountSummaryRequest.Builder to create a request. The structure representing the GetFindingsReportAccountSummaryRequest.

Returns:

Result of the GetFindingsReportAccountSummary operation returned by the service.

See Also:

• AWS API Documentation

getFindingsReportAccountSummaryPaginator

default GetFindingsReportAccountSummaryIterable getFindingsReportAccountSummaryPaginator(GetFindingsReportAccountSummaryRequest getFindingsReportAccountSummaryRequest)
                                                                                  throws InternalServerException,
ValidationException,
ThrottlingException,
AwsServiceException,
SdkClientException,
CodeGuruProfilerException

This is a variant of getFindingsReportAccountSummary(software.amazon.awssdk.services.codeguruprofiler.model.GetFindingsReportAccountSummaryRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.codeguruprofiler.paginators.GetFindingsReportAccountSummaryIterable responses = client.getFindingsReportAccountSummaryPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.codeguruprofiler.paginators.GetFindingsReportAccountSummaryIterable responses = client
             .getFindingsReportAccountSummaryPaginator(request);
     for (software.amazon.awssdk.services.codeguruprofiler.model.GetFindingsReportAccountSummaryResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.codeguruprofiler.paginators.GetFindingsReportAccountSummaryIterable responses = client.getFindingsReportAccountSummaryPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the getFindingsReportAccountSummary(software.amazon.awssdk.services.codeguruprofiler.model.GetFindingsReportAccountSummaryRequest) operation.

Parameters:

getFindingsReportAccountSummaryRequest - The structure representing the GetFindingsReportAccountSummaryRequest.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

getFindingsReportAccountSummaryPaginator

default GetFindingsReportAccountSummaryIterable getFindingsReportAccountSummaryPaginator(Consumer<GetFindingsReportAccountSummaryRequest.Builder> getFindingsReportAccountSummaryRequest)
                                                                                  throws InternalServerException,
ValidationException,
ThrottlingException,
AwsServiceException,
SdkClientException,
CodeGuruProfilerException

This is a variant of getFindingsReportAccountSummary(software.amazon.awssdk.services.codeguruprofiler.model.GetFindingsReportAccountSummaryRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.codeguruprofiler.paginators.GetFindingsReportAccountSummaryIterable responses = client.getFindingsReportAccountSummaryPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.codeguruprofiler.paginators.GetFindingsReportAccountSummaryIterable responses = client
             .getFindingsReportAccountSummaryPaginator(request);
     for (software.amazon.awssdk.services.codeguruprofiler.model.GetFindingsReportAccountSummaryResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.codeguruprofiler.paginators.GetFindingsReportAccountSummaryIterable responses = client.getFindingsReportAccountSummaryPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the getFindingsReportAccountSummary(software.amazon.awssdk.services.codeguruprofiler.model.GetFindingsReportAccountSummaryRequest) operation.

This is a convenience which creates an instance of the GetFindingsReportAccountSummaryRequest.Builder avoiding the need to create one manually via GetFindingsReportAccountSummaryRequest.builder()

Parameters:

getFindingsReportAccountSummaryRequest - A Consumer that will call methods on GetFindingsReportAccountSummaryRequest.Builder to create a request. The structure representing the GetFindingsReportAccountSummaryRequest.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

getNotificationConfiguration

default GetNotificationConfigurationResponse getNotificationConfiguration(GetNotificationConfigurationRequest getNotificationConfigurationRequest)
                                                                   throws InternalServerException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CodeGuruProfilerException

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

Parameters:

getNotificationConfigurationRequest - The structure representing the GetNotificationConfigurationRequest.

Returns:

Result of the GetNotificationConfiguration operation returned by the service.

See Also:

• AWS API Documentation

getNotificationConfiguration

default GetNotificationConfigurationResponse getNotificationConfiguration(Consumer<GetNotificationConfigurationRequest.Builder> getNotificationConfigurationRequest)
                                                                   throws InternalServerException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CodeGuruProfilerException

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

This is a convenience which creates an instance of the GetNotificationConfigurationRequest.Builder avoiding the need to create one manually via GetNotificationConfigurationRequest.builder()

Parameters:

getNotificationConfigurationRequest - A Consumer that will call methods on GetNotificationConfigurationRequest.Builder to create a request. The structure representing the GetNotificationConfigurationRequest.

Returns:

Result of the GetNotificationConfiguration operation returned by the service.

See Also:

• AWS API Documentation

getPolicy

default GetPolicyResponse getPolicy(GetPolicyRequest getPolicyRequest)
                             throws InternalServerException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CodeGuruProfilerException

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

Parameters:

getPolicyRequest - The structure representing the getPolicyRequest.

Returns:

Result of the GetPolicy operation returned by the service.

See Also:

• AWS API Documentation

getPolicy

default GetPolicyResponse getPolicy(Consumer<GetPolicyRequest.Builder> getPolicyRequest)
                             throws InternalServerException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CodeGuruProfilerException

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

This is a convenience which creates an instance of the GetPolicyRequest.Builder avoiding the need to create one manually via GetPolicyRequest.builder()

Parameters:

getPolicyRequest - A Consumer that will call methods on GetPolicyRequest.Builder to create a request. The structure representing the getPolicyRequest.

Returns:

Result of the GetPolicy operation returned by the service.

See Also:

• AWS API Documentation

getProfile

default GetProfileResponse getProfile(GetProfileRequest getProfileRequest)
                               throws InternalServerException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CodeGuruProfilerException

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> 
 

Parameters:

getProfileRequest - The structure representing the getProfileRequest.

Returns:

Result of the GetProfile operation returned by the service.

See Also:

• AWS API Documentation

getProfile

default GetProfileResponse getProfile(Consumer<GetProfileRequest.Builder> getProfileRequest)
                               throws InternalServerException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CodeGuruProfilerException

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> 
 

This is a convenience which creates an instance of the GetProfileRequest.Builder avoiding the need to create one manually via GetProfileRequest.builder()

Parameters:

getProfileRequest - A Consumer that will call methods on GetProfileRequest.Builder to create a request. The structure representing the getProfileRequest.

Returns:

Result of the GetProfile operation returned by the service.

See Also:

• AWS API Documentation

getRecommendations

default GetRecommendationsResponse getRecommendations(GetRecommendationsRequest getRecommendationsRequest)
                                               throws InternalServerException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CodeGuruProfilerException

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.

Parameters:

getRecommendationsRequest - The structure representing the GetRecommendationsRequest.

Returns:

Result of the GetRecommendations operation returned by the service.

See Also:

• AWS API Documentation

getRecommendations

default GetRecommendationsResponse getRecommendations(Consumer<GetRecommendationsRequest.Builder> getRecommendationsRequest)
                                               throws InternalServerException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CodeGuruProfilerException

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.

This is a convenience which creates an instance of the GetRecommendationsRequest.Builder avoiding the need to create one manually via GetRecommendationsRequest.builder()

Parameters:

getRecommendationsRequest - A Consumer that will call methods on GetRecommendationsRequest.Builder to create a request. The structure representing the GetRecommendationsRequest.

Returns:

Result of the GetRecommendations operation returned by the service.

See Also:

• AWS API Documentation

listFindingsReports

default ListFindingsReportsResponse listFindingsReports(ListFindingsReportsRequest listFindingsReportsRequest)
                                                 throws InternalServerException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CodeGuruProfilerException

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

Parameters:

listFindingsReportsRequest - The structure representing the ListFindingsReportsRequest.

Returns:

Result of the ListFindingsReports operation returned by the service.

See Also:

• AWS API Documentation

listFindingsReports

default ListFindingsReportsResponse listFindingsReports(Consumer<ListFindingsReportsRequest.Builder> listFindingsReportsRequest)
                                                 throws InternalServerException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CodeGuruProfilerException

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

This is a convenience which creates an instance of the ListFindingsReportsRequest.Builder avoiding the need to create one manually via ListFindingsReportsRequest.builder()

Parameters:

listFindingsReportsRequest - A Consumer that will call methods on ListFindingsReportsRequest.Builder to create a request. The structure representing the ListFindingsReportsRequest.

Returns:

Result of the ListFindingsReports operation returned by the service.

See Also:

• AWS API Documentation

listFindingsReportsPaginator

default ListFindingsReportsIterable listFindingsReportsPaginator(ListFindingsReportsRequest listFindingsReportsRequest)
                                                          throws InternalServerException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CodeGuruProfilerException

This is a variant of listFindingsReports(software.amazon.awssdk.services.codeguruprofiler.model.ListFindingsReportsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.codeguruprofiler.paginators.ListFindingsReportsIterable responses = client.listFindingsReportsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.codeguruprofiler.paginators.ListFindingsReportsIterable responses = client
             .listFindingsReportsPaginator(request);
     for (software.amazon.awssdk.services.codeguruprofiler.model.ListFindingsReportsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.codeguruprofiler.paginators.ListFindingsReportsIterable responses = client.listFindingsReportsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listFindingsReports(software.amazon.awssdk.services.codeguruprofiler.model.ListFindingsReportsRequest) operation.

Parameters:

listFindingsReportsRequest - The structure representing the ListFindingsReportsRequest.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listFindingsReportsPaginator

default ListFindingsReportsIterable listFindingsReportsPaginator(Consumer<ListFindingsReportsRequest.Builder> listFindingsReportsRequest)
                                                          throws InternalServerException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CodeGuruProfilerException

This is a variant of listFindingsReports(software.amazon.awssdk.services.codeguruprofiler.model.ListFindingsReportsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.codeguruprofiler.paginators.ListFindingsReportsIterable responses = client.listFindingsReportsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.codeguruprofiler.paginators.ListFindingsReportsIterable responses = client
             .listFindingsReportsPaginator(request);
     for (software.amazon.awssdk.services.codeguruprofiler.model.ListFindingsReportsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.codeguruprofiler.paginators.ListFindingsReportsIterable responses = client.listFindingsReportsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listFindingsReports(software.amazon.awssdk.services.codeguruprofiler.model.ListFindingsReportsRequest) operation.

This is a convenience which creates an instance of the ListFindingsReportsRequest.Builder avoiding the need to create one manually via ListFindingsReportsRequest.builder()

Parameters:

listFindingsReportsRequest - A Consumer that will call methods on ListFindingsReportsRequest.Builder to create a request. The structure representing the ListFindingsReportsRequest.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listProfileTimes

default ListProfileTimesResponse listProfileTimes(ListProfileTimesRequest listProfileTimesRequest)
                                           throws InternalServerException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CodeGuruProfilerException

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

Parameters:

listProfileTimesRequest - The structure representing the listProfileTimesRequest.

Returns:

Result of the ListProfileTimes operation returned by the service.

See Also:

• AWS API Documentation

listProfileTimes

default ListProfileTimesResponse listProfileTimes(Consumer<ListProfileTimesRequest.Builder> listProfileTimesRequest)
                                           throws InternalServerException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CodeGuruProfilerException

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

This is a convenience which creates an instance of the ListProfileTimesRequest.Builder avoiding the need to create one manually via ListProfileTimesRequest.builder()

Parameters:

listProfileTimesRequest - A Consumer that will call methods on ListProfileTimesRequest.Builder to create a request. The structure representing the listProfileTimesRequest.

Returns:

Result of the ListProfileTimes operation returned by the service.

See Also:

• AWS API Documentation

listProfileTimesPaginator

default ListProfileTimesIterable listProfileTimesPaginator(ListProfileTimesRequest listProfileTimesRequest)
                                                    throws InternalServerException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CodeGuruProfilerException

This is a variant of listProfileTimes(software.amazon.awssdk.services.codeguruprofiler.model.ListProfileTimesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.codeguruprofiler.paginators.ListProfileTimesIterable responses = client.listProfileTimesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.codeguruprofiler.paginators.ListProfileTimesIterable responses = client
             .listProfileTimesPaginator(request);
     for (software.amazon.awssdk.services.codeguruprofiler.model.ListProfileTimesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.codeguruprofiler.paginators.ListProfileTimesIterable responses = client.listProfileTimesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listProfileTimes(software.amazon.awssdk.services.codeguruprofiler.model.ListProfileTimesRequest) operation.

Parameters:

listProfileTimesRequest - The structure representing the listProfileTimesRequest.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listProfileTimesPaginator

default ListProfileTimesIterable listProfileTimesPaginator(Consumer<ListProfileTimesRequest.Builder> listProfileTimesRequest)
                                                    throws InternalServerException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CodeGuruProfilerException

This is a variant of listProfileTimes(software.amazon.awssdk.services.codeguruprofiler.model.ListProfileTimesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.codeguruprofiler.paginators.ListProfileTimesIterable responses = client.listProfileTimesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.codeguruprofiler.paginators.ListProfileTimesIterable responses = client
             .listProfileTimesPaginator(request);
     for (software.amazon.awssdk.services.codeguruprofiler.model.ListProfileTimesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.codeguruprofiler.paginators.ListProfileTimesIterable responses = client.listProfileTimesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listProfileTimes(software.amazon.awssdk.services.codeguruprofiler.model.ListProfileTimesRequest) operation.

This is a convenience which creates an instance of the ListProfileTimesRequest.Builder avoiding the need to create one manually via ListProfileTimesRequest.builder()

Parameters:

listProfileTimesRequest - A Consumer that will call methods on ListProfileTimesRequest.Builder to create a request. The structure representing the listProfileTimesRequest.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listProfilingGroups

default ListProfilingGroupsResponse listProfilingGroups(ListProfilingGroupsRequest listProfilingGroupsRequest)
                                                 throws InternalServerException,
ThrottlingException,
AwsServiceException,
SdkClientException,
CodeGuruProfilerException

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

Parameters:

listProfilingGroupsRequest - The structure representing the listProfilingGroupsRequest.

Returns:

Result of the ListProfilingGroups operation returned by the service.

See Also:

• AWS API Documentation

listProfilingGroups

default ListProfilingGroupsResponse listProfilingGroups(Consumer<ListProfilingGroupsRequest.Builder> listProfilingGroupsRequest)
                                                 throws InternalServerException,
ThrottlingException,
AwsServiceException,
SdkClientException,
CodeGuruProfilerException

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

This is a convenience which creates an instance of the ListProfilingGroupsRequest.Builder avoiding the need to create one manually via ListProfilingGroupsRequest.builder()

Parameters:

listProfilingGroupsRequest - A Consumer that will call methods on ListProfilingGroupsRequest.Builder to create a request. The structure representing the listProfilingGroupsRequest.

Returns:

Result of the ListProfilingGroups operation returned by the service.

See Also:

• AWS API Documentation

listProfilingGroupsPaginator

default ListProfilingGroupsIterable listProfilingGroupsPaginator(ListProfilingGroupsRequest listProfilingGroupsRequest)
                                                          throws InternalServerException,
ThrottlingException,
AwsServiceException,
SdkClientException,
CodeGuruProfilerException

This is a variant of listProfilingGroups(software.amazon.awssdk.services.codeguruprofiler.model.ListProfilingGroupsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.codeguruprofiler.paginators.ListProfilingGroupsIterable responses = client.listProfilingGroupsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.codeguruprofiler.paginators.ListProfilingGroupsIterable responses = client
             .listProfilingGroupsPaginator(request);
     for (software.amazon.awssdk.services.codeguruprofiler.model.ListProfilingGroupsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.codeguruprofiler.paginators.ListProfilingGroupsIterable responses = client.listProfilingGroupsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listProfilingGroups(software.amazon.awssdk.services.codeguruprofiler.model.ListProfilingGroupsRequest) operation.

Parameters:

listProfilingGroupsRequest - The structure representing the listProfilingGroupsRequest.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listProfilingGroupsPaginator

default ListProfilingGroupsIterable listProfilingGroupsPaginator(Consumer<ListProfilingGroupsRequest.Builder> listProfilingGroupsRequest)
                                                          throws InternalServerException,
ThrottlingException,
AwsServiceException,
SdkClientException,
CodeGuruProfilerException

This is a variant of listProfilingGroups(software.amazon.awssdk.services.codeguruprofiler.model.ListProfilingGroupsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.codeguruprofiler.paginators.ListProfilingGroupsIterable responses = client.listProfilingGroupsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.codeguruprofiler.paginators.ListProfilingGroupsIterable responses = client
             .listProfilingGroupsPaginator(request);
     for (software.amazon.awssdk.services.codeguruprofiler.model.ListProfilingGroupsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.codeguruprofiler.paginators.ListProfilingGroupsIterable responses = client.listProfilingGroupsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listProfilingGroups(software.amazon.awssdk.services.codeguruprofiler.model.ListProfilingGroupsRequest) operation.

This is a convenience which creates an instance of the ListProfilingGroupsRequest.Builder avoiding the need to create one manually via ListProfilingGroupsRequest.builder()

Parameters:

listProfilingGroupsRequest - A Consumer that will call methods on ListProfilingGroupsRequest.Builder to create a request. The structure representing the listProfilingGroupsRequest.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws InternalServerException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CodeGuruProfilerException

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

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws InternalServerException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CodeGuruProfilerException

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

This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

postAgentProfile

default PostAgentProfileResponse postAgentProfile(PostAgentProfileRequest postAgentProfileRequest)
                                           throws InternalServerException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CodeGuruProfilerException

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 .

Parameters:

postAgentProfileRequest - The structure representing the postAgentProfileRequest.

Returns:

Result of the PostAgentProfile operation returned by the service.

See Also:

• AWS API Documentation

postAgentProfile

default PostAgentProfileResponse postAgentProfile(Consumer<PostAgentProfileRequest.Builder> postAgentProfileRequest)
                                           throws InternalServerException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CodeGuruProfilerException

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 .

This is a convenience which creates an instance of the PostAgentProfileRequest.Builder avoiding the need to create one manually via PostAgentProfileRequest.builder()

Parameters:

postAgentProfileRequest - A Consumer that will call methods on PostAgentProfileRequest.Builder to create a request. The structure representing the postAgentProfileRequest.

Returns:

Result of the PostAgentProfile operation returned by the service.

See Also:

• AWS API Documentation

putPermission

default PutPermissionResponse putPermission(PutPermissionRequest putPermissionRequest)
                                     throws InternalServerException,
ConflictException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CodeGuruProfilerException

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> 
 

Parameters:

putPermissionRequest - The structure representing the putPermissionRequest.

Returns:

Result of the PutPermission operation returned by the service.

See Also:

• AWS API Documentation

putPermission

default PutPermissionResponse putPermission(Consumer<PutPermissionRequest.Builder> putPermissionRequest)
                                     throws InternalServerException,
ConflictException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CodeGuruProfilerException

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> 
 

This is a convenience which creates an instance of the PutPermissionRequest.Builder avoiding the need to create one manually via PutPermissionRequest.builder()

Parameters:

putPermissionRequest - A Consumer that will call methods on PutPermissionRequest.Builder to create a request. The structure representing the putPermissionRequest.

Returns:

Result of the PutPermission operation returned by the service.

See Also:

• AWS API Documentation

removeNotificationChannel

default RemoveNotificationChannelResponse removeNotificationChannel(RemoveNotificationChannelRequest removeNotificationChannelRequest)
                                                             throws InternalServerException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CodeGuruProfilerException

Remove one anomaly notifications channel for a profiling group.

Parameters:

removeNotificationChannelRequest - The structure representing the RemoveNotificationChannelRequest.

Returns:

Result of the RemoveNotificationChannel operation returned by the service.

See Also:

• AWS API Documentation

removeNotificationChannel

default RemoveNotificationChannelResponse removeNotificationChannel(Consumer<RemoveNotificationChannelRequest.Builder> removeNotificationChannelRequest)
                                                             throws InternalServerException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CodeGuruProfilerException

Remove one anomaly notifications channel for a profiling group.

This is a convenience which creates an instance of the RemoveNotificationChannelRequest.Builder avoiding the need to create one manually via RemoveNotificationChannelRequest.builder()

Parameters:

removeNotificationChannelRequest - A Consumer that will call methods on RemoveNotificationChannelRequest.Builder to create a request. The structure representing the RemoveNotificationChannelRequest.

Returns:

Result of the RemoveNotificationChannel operation returned by the service.

See Also:

• AWS API Documentation

removePermission

default RemovePermissionResponse removePermission(RemovePermissionRequest removePermissionRequest)
                                           throws InternalServerException,
ConflictException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CodeGuruProfilerException

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 .

Parameters:

removePermissionRequest -

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

Returns:

Result of the RemovePermission operation returned by the service.

See Also:

• AWS API Documentation

removePermission

default RemovePermissionResponse removePermission(Consumer<RemovePermissionRequest.Builder> removePermissionRequest)
                                           throws InternalServerException,
ConflictException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CodeGuruProfilerException

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 .

This is a convenience which creates an instance of the RemovePermissionRequest.Builder avoiding the need to create one manually via RemovePermissionRequest.builder()

Parameters:

removePermissionRequest - A Consumer that will call methods on RemovePermissionRequest.Builder to create a 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

default SubmitFeedbackResponse submitFeedback(SubmitFeedbackRequest submitFeedbackRequest)
                                       throws InternalServerException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CodeGuruProfilerException

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

Parameters:

submitFeedbackRequest - The structure representing the SubmitFeedbackRequest.

Returns:

Result of the SubmitFeedback operation returned by the service.

See Also:

• AWS API Documentation

submitFeedback

default SubmitFeedbackResponse submitFeedback(Consumer<SubmitFeedbackRequest.Builder> submitFeedbackRequest)
                                       throws InternalServerException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CodeGuruProfilerException

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

This is a convenience which creates an instance of the SubmitFeedbackRequest.Builder avoiding the need to create one manually via SubmitFeedbackRequest.builder()

Parameters:

submitFeedbackRequest - A Consumer that will call methods on SubmitFeedbackRequest.Builder to create a request. The structure representing the SubmitFeedbackRequest.

Returns:

Result of the SubmitFeedback operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws InternalServerException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CodeGuruProfilerException

Use to assign one or more tags to a resource.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws InternalServerException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CodeGuruProfilerException

Use to assign one or more tags to a resource.

This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws InternalServerException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CodeGuruProfilerException

Use to remove one or more tags from a resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws InternalServerException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CodeGuruProfilerException

Use to remove one or more tags from a resource.

This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

updateProfilingGroup

default UpdateProfilingGroupResponse updateProfilingGroup(UpdateProfilingGroupRequest updateProfilingGroupRequest)
                                                   throws InternalServerException,
ConflictException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CodeGuruProfilerException

Updates a profiling group.

Parameters:

updateProfilingGroupRequest - The structure representing the updateProfilingGroupRequest.

Returns:

Result of the UpdateProfilingGroup operation returned by the service.

See Also:

• AWS API Documentation

updateProfilingGroup

default UpdateProfilingGroupResponse updateProfilingGroup(Consumer<UpdateProfilingGroupRequest.Builder> updateProfilingGroupRequest)
                                                   throws InternalServerException,
ConflictException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CodeGuruProfilerException

Updates a profiling group.

This is a convenience which creates an instance of the UpdateProfilingGroupRequest.Builder avoiding the need to create one manually via UpdateProfilingGroupRequest.builder()

Parameters:

updateProfilingGroupRequest - A Consumer that will call methods on UpdateProfilingGroupRequest.Builder to create a request. The structure representing the updateProfilingGroupRequest.

Returns:

Result of the UpdateProfilingGroup operation returned by the service.

See Also:

• AWS API Documentation

create

static CodeGuruProfilerClient create()

Create a CodeGuruProfilerClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static CodeGuruProfilerClientBuilder builder()

Create a builder that can be used to configure and create a CodeGuruProfilerClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default CodeGuruProfilerServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration