com.amazonaws.services.codeguruprofiler

Class AmazonCodeGuruProfilerClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.codeguruprofiler.AmazonCodeGuruProfilerClient

All Implemented Interfaces:

AmazonCodeGuruProfiler

Direct Known Subclasses:

AmazonCodeGuruProfilerAsyncClient

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

Client for accessing Amazon CodeGuru Profiler. All service calls made using this client are blocking, and will not return until the service call completes.

This section provides documentation for the Amazon CodeGuru Profiler API operations.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

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

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AmazonCodeGuruProfilerClientBuilder	builder()
ConfigureAgentResult	configureAgent(ConfigureAgentRequest request)
CreateProfilingGroupResult	createProfilingGroup(CreateProfilingGroupRequest request) Creates a profiling group.
DeleteProfilingGroupResult	deleteProfilingGroup(DeleteProfilingGroupRequest request) Deletes a profiling group.
DescribeProfilingGroupResult	describeProfilingGroup(DescribeProfilingGroupRequest request) Describes a profiling group.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
GetPolicyResult	getPolicy(GetPolicyRequest request) Gets the profiling group policy.
GetProfileResult	getProfile(GetProfileRequest request) Gets the aggregated profile of a profiling group for the specified time range.
ListProfileTimesResult	listProfileTimes(ListProfileTimesRequest request) List the start times of the available aggregated profiles of a profiling group for an aggregation period within the specified time range.
ListProfilingGroupsResult	listProfilingGroups(ListProfilingGroupsRequest request) Lists profiling groups.
PostAgentProfileResult	postAgentProfile(PostAgentProfileRequest request)
PutPermissionResult	putPermission(PutPermissionRequest request) Provides permission to the principals.
RemovePermissionResult	removePermission(RemovePermissionRequest request) Removes statement for the provided action group from the policy.
UpdateProfilingGroupResult	updateProfilingGroup(UpdateProfilingGroupRequest request) Updates a profiling group.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

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

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

shutdown

Method Detail

builder

public static AmazonCodeGuruProfilerClientBuilder builder()

configureAgent

public ConfigureAgentResult configureAgent(ConfigureAgentRequest request)

Specified by:

configureAgent in interface AmazonCodeGuruProfiler

Parameters:

configureAgentRequest - The structure representing the configureAgentRequest.

Returns:

Result of the ConfigureAgent operation returned by the service.

Throws:

InternalServerException - The server encountered an internal error and is unable to complete the request.

ValidationException - The parameter is not valid.

ThrottlingException - The request was denied due to request throttling.

ResourceNotFoundException - The resource specified in the request does not exist.

See Also:

AWS API Documentation

createProfilingGroup

public CreateProfilingGroupResult createProfilingGroup(CreateProfilingGroupRequest request)

Creates a profiling group.

Specified by:

createProfilingGroup in interface AmazonCodeGuruProfiler

Parameters:

createProfilingGroupRequest - The structure representing the createProfiliingGroupRequest.

Returns:

Result of the CreateProfilingGroup operation returned by the service.

Throws:

ServiceQuotaExceededException - You have exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use Service Quotas to request a service quota increase.

InternalServerException - The server encountered an internal error and is unable to complete the request.

ConflictException - The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

ValidationException - The parameter is not valid.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

deleteProfilingGroup

public DeleteProfilingGroupResult deleteProfilingGroup(DeleteProfilingGroupRequest request)

Deletes a profiling group.

Specified by:

deleteProfilingGroup in interface AmazonCodeGuruProfiler

Parameters:

deleteProfilingGroupRequest - The structure representing the deleteProfilingGroupRequest.

Returns:

Result of the DeleteProfilingGroup operation returned by the service.

Throws:

InternalServerException - The server encountered an internal error and is unable to complete the request.

ValidationException - The parameter is not valid.

ThrottlingException - The request was denied due to request throttling.

ResourceNotFoundException - The resource specified in the request does not exist.

See Also:

AWS API Documentation

describeProfilingGroup

public DescribeProfilingGroupResult describeProfilingGroup(DescribeProfilingGroupRequest request)

Describes a profiling group.

Specified by:

describeProfilingGroup in interface AmazonCodeGuruProfiler

Parameters:

describeProfilingGroupRequest - The structure representing the describeProfilingGroupRequest.

Returns:

Result of the DescribeProfilingGroup operation returned by the service.

Throws:

InternalServerException - The server encountered an internal error and is unable to complete the request.

ValidationException - The parameter is not valid.

ThrottlingException - The request was denied due to request throttling.

ResourceNotFoundException - The resource specified in the request does not exist.

See Also:

AWS API Documentation

getPolicy

public GetPolicyResult getPolicy(GetPolicyRequest request)

Gets the profiling group policy.

Specified by:

getPolicy in interface AmazonCodeGuruProfiler

Parameters:

getPolicyRequest - The structure representing the getPolicyRequest.

Returns:

Result of the GetPolicy operation returned by the service.

Throws:

InternalServerException - The server encountered an internal error and is unable to complete the request.

ThrottlingException - The request was denied due to request throttling.

ResourceNotFoundException - The resource specified in the request does not exist.

See Also:

AWS API Documentation

getProfile

public GetProfileResult getProfile(GetProfileRequest request)

Gets the aggregated profile of a profiling group for the specified time range. If the requested time range does not align with the available aggregated profiles, it is expanded to attain alignment. If aggregated profiles are available only for part of the period requested, the profile is returned from the earliest available to the latest within the requested time range.

For example, if the requested time range is from 00:00 to 00:20 and the available profiles are from 00:15 to 00:25, the returned profile will be from 00:15 to 00:20.

You must specify exactly two of the following parameters: startTime, period, and endTime.

Specified by:

getProfile in interface AmazonCodeGuruProfiler

Parameters:

getProfileRequest - The structure representing the getProfileRequest.

Returns:

Result of the GetProfile operation returned by the service.

Throws:

InternalServerException - The server encountered an internal error and is unable to complete the request.

ValidationException - The parameter is not valid.

ThrottlingException - The request was denied due to request throttling.

ResourceNotFoundException - The resource specified in the request does not exist.

See Also:

AWS API Documentation

listProfileTimes

public ListProfileTimesResult listProfileTimes(ListProfileTimesRequest request)

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

Specified by:

listProfileTimes in interface AmazonCodeGuruProfiler

Parameters:

listProfileTimesRequest - The structure representing the listProfileTimesRequest.

Returns:

Result of the ListProfileTimes operation returned by the service.

Throws:

InternalServerException - The server encountered an internal error and is unable to complete the request.

ValidationException - The parameter is not valid.

ThrottlingException - The request was denied due to request throttling.

ResourceNotFoundException - The resource specified in the request does not exist.

See Also:

AWS API Documentation

listProfilingGroups

public ListProfilingGroupsResult listProfilingGroups(ListProfilingGroupsRequest request)

Lists profiling groups.

Specified by:

listProfilingGroups in interface AmazonCodeGuruProfiler

Parameters:

listProfilingGroupsRequest - The structure representing the listProfilingGroupsRequest.

Returns:

Result of the ListProfilingGroups operation returned by the service.

Throws:

InternalServerException - The server encountered an internal error and is unable to complete the request.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

postAgentProfile

public PostAgentProfileResult postAgentProfile(PostAgentProfileRequest request)

Specified by:

postAgentProfile in interface AmazonCodeGuruProfiler

Parameters:

postAgentProfileRequest - The structure representing the postAgentProfileRequest.

Returns:

Result of the PostAgentProfile operation returned by the service.

Throws:

InternalServerException - The server encountered an internal error and is unable to complete the request.

ValidationException - The parameter is not valid.

ThrottlingException - The request was denied due to request throttling.

ResourceNotFoundException - The resource specified in the request does not exist.

See Also:

AWS API Documentation

putPermission

public PutPermissionResult putPermission(PutPermissionRequest request)

Provides permission to the principals. This overwrites the existing permissions, and is not additive.

Specified by:

putPermission in interface AmazonCodeGuruProfiler

Parameters:

putPermissionRequest - The structure representing the putPermissionRequest.

Returns:

Result of the PutPermission operation returned by the service.

Throws:

InternalServerException - The server encountered an internal error and is unable to complete the request.

ConflictException - The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

ValidationException - The parameter is not valid.

ThrottlingException - The request was denied due to request throttling.

ResourceNotFoundException - The resource specified in the request does not exist.

See Also:

AWS API Documentation

removePermission

public RemovePermissionResult removePermission(RemovePermissionRequest request)

Removes statement for the provided action group from the policy.

Specified by:

removePermission in interface AmazonCodeGuruProfiler

Parameters:

removePermissionRequest - The structure representing the removePermissionRequest.

Returns:

Result of the RemovePermission operation returned by the service.

Throws:

InternalServerException - The server encountered an internal error and is unable to complete the request.

ConflictException - The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

ValidationException - The parameter is not valid.

ThrottlingException - The request was denied due to request throttling.

ResourceNotFoundException - The resource specified in the request does not exist.

See Also:

AWS API Documentation

updateProfilingGroup

public UpdateProfilingGroupResult updateProfilingGroup(UpdateProfilingGroupRequest request)

Updates a profiling group.

Specified by:

updateProfilingGroup in interface AmazonCodeGuruProfiler

Parameters:

updateProfilingGroupRequest - The structure representing the updateProfilingGroupRequest.

Returns:

Result of the UpdateProfilingGroup operation returned by the service.

Throws:

InternalServerException - The server encountered an internal error and is unable to complete the request.

ConflictException - The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

ValidationException - The parameter is not valid.

ThrottlingException - The request was denied due to request throttling.

ResourceNotFoundException - The resource specified in the request does not exist.

See Also:

AWS API Documentation

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface AmazonCodeGuruProfiler

Parameters:

request - The originally executed request

Returns:

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